Class TextObject

Document text object

Inheritance
System.Object
TextObject
LineTextObject
Implements
IronSoftware.Abstractions.Pdf.IPdfDocumentObject
IronSoftware.Abstractions.IDocumentObject
IronSoftware.Abstractions.Pdf.IDocumentTextObject
IronSoftware.Abstractions.Pdf.IBoundedPdfDocumentObject
IronSoftware.Abstractions.IBounded
IronSoftware.ITransformable
IronSoftware.Abstractions.IColored
System.ICloneable
IronSoftware.Abstractions.IJsonSerializable
Namespace: IronSoftware
Assembly: IronPdf.dll
Syntax
public class TextObject : Object, IPdfTextObject, IPdfDocumentObject

Iron Software API in IronPDF is handled through TextObject. It represents document text object.

TextObject matters when an application needs to configure or invoke Iron Software API from C# code. The class encapsulates the related options and behavior in a single object that is set up once and reused across render or processing calls. Typical scenarios include batch generation pipelines, templated document workflows, and integration with existing C# document services.

To use TextObject, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include BoundingBox, Client, Contents, ContentStart. Assign options or invoke methods on the instance to configure or perform the operation. The draw text and bitmap covers typical usage in C# end to end.

using IronPdf;

// Obtain TextObject from the relevant entry point in the IronPDF API
void Configure(TextObject instance)
{
    var current = instance.BoundingBox;
    instance.Clone();
}

For the broader workflow, see the extract text and images guide in the IronPDF C# documentation. For broader context, the Iron Software API portion of the IronPDF C# API contains related types that work with TextObject directly. TextObject exposes additional members beyond those highlighted above; the reference tables on this page list the full set. In application code, treat TextObject as a configured object that is constructed once and reused across operations rather than instantiated per call. Configuration is generally idempotent: assigning the same property value twice has the same effect as assigning it once. For diagnostic purposes, inspect the relevant TextObject property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of TextObject. Application code typically obtains or instantiates a single TextObject and shares it across multiple IronPDF operations rather than recreating it per call.

Fields

_Contents

Declaration
protected string _Contents
Field Value
Type Description
System.String

_FillColor

Declaration
protected Color _FillColor
Field Value
Type Description
System.Drawing.Color

_Rotation

Declaration
protected double _Rotation
Field Value
Type Description
System.Double

_Scale

Declaration
protected PointF _Scale
Field Value
Type Description
System.Drawing.PointF

_StrokeColor

Declaration
protected Color _StrokeColor
Field Value
Type Description
System.Drawing.Color

_Translate

Declaration
protected PointF _Translate
Field Value
Type Description
System.Drawing.PointF

Properties

BoundingBox

Declaration
public RectangleF BoundingBox { get; set; }
Property Value
Type Description
System.Drawing.RectangleF

Client

Pdf client

Declaration
public IPdfClient Client { get; set; }
Property Value
Type Description
IronSoftware.Pdfium.IPdfClient

Contents

Declaration
public string Contents { get; set; }
Property Value
Type Description
System.String

ContentStart

Declaration
public int ContentStart { get; set; }
Property Value
Type Description
System.Int32

DocumentId

Declaration
public IDocumentId DocumentId { get; set; }
Property Value
Type Description
IronSoftware.Abstractions.Pdf.IDocumentId

FillColor

Declaration
public Color FillColor { get; set; }
Property Value
Type Description
System.Drawing.Color

Font

Declaration
public IDocumentFontObject Font { get; }
Property Value
Type Description
IronSoftware.Abstractions.Pdf.IDocumentFontObject

FontObject

Declaration
public FontObject FontObject { get; set; }
Property Value
Type Description
FontObject

FontSize

Declaration
public float FontSize { get; set; }
Property Value
Type Description
System.Single

IsBold

Declaration
public bool IsBold { get; set; }
Property Value
Type Description
System.Boolean

IsItalic

Declaration
public bool IsItalic { get; set; }
Property Value
Type Description
System.Boolean

Matrix

Declaration
public MatrixStruct Matrix { get; }
Property Value
Type Description
IronSoftware.MatrixStruct

ObjNum

Declaration
public uint ObjNum { get; set; }
Property Value
Type Description
System.UInt32

OcgId

Identifier of the Optional Content Group (PDF layer) that this text object belongs to. -1 means the object is not in any layer and will always render. Resolve to a PdfLayer via PdfClient.GetOcgs(DocumentId) or the convenience GetLayer() method below.

Declaration
public int OcgId { get; }
Property Value
Type Description
System.Int32

PageIndex

Declaration
public uint PageIndex { get; set; }
Property Value
Type Description
System.UInt32

RenderMode

Declaration
public TextRenderModes RenderMode { get; set; }
Property Value
Type Description
IronSoftware.Abstractions.Pdf.TextRenderModes

Rotation

Declaration
public double Rotation { get; set; }
Property Value
Type Description
System.Double

Scale

Declaration
public PointF Scale { get; set; }
Property Value
Type Description
System.Drawing.PointF

StrokeColor

Declaration
public Color StrokeColor { get; set; }
Property Value
Type Description
System.Drawing.Color

Translate

Declaration
public PointF Translate { get; set; }
Property Value
Type Description
System.Drawing.PointF

X

X coordinate for simple positioning When set along with Y, Matrix will be auto-calculated from X, Y, Scale, and Rotation

Declaration
public Nullable<double> X { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

Y

Y coordinate for simple positioning When set along with X, Matrix will be auto-calculated from X, Y, Scale, and Rotation

Declaration
public Nullable<double> Y { get; set; }
Property Value
Type Description
System.Nullable<System.Double>

ZOrder

Declaration
public RelativeZOrder ZOrder { get; set; }
Property Value
Type Description
IronSoftware.Abstractions.RelativeZOrder

ZPosition

Declaration
public long ZPosition { get; set; }
Property Value
Type Description
System.Int64

Methods

Clone()

Declaration
public object Clone()
Returns
Type Description
System.Object

GetGlyphInfo()

Retrieve glyph/character information for all characters in this text object

Declaration
public IDocumentCharCollection GetGlyphInfo()
Returns
Type Description
IronSoftware.Abstractions.Pdf.IDocumentCharCollection

Collection of glyph/character information

GetLayer()

Resolve OcgId against the owning document's layer list and return the matching PdfLayer. Returns null when the object is not in any layer (OcgId == -1) or when the document has no /OCProperties.

Declaration
public PdfLayer GetLayer()
Returns
Type Description
PdfLayer

ToJson()

Declaration
public string ToJson()
Returns
Type Description
System.String

Implements

IronSoftware.Abstractions.Pdf.IPdfDocumentObject
IronSoftware.Abstractions.IDocumentObject
IronSoftware.Abstractions.Pdf.IDocumentTextObject
IronSoftware.Abstractions.Pdf.IBoundedPdfDocumentObject
IronSoftware.Abstractions.IBounded
IronSoftware.ITransformable
IronSoftware.Abstractions.IColored
System.ICloneable
IronSoftware.Abstractions.IJsonSerializable