# Text Class > A container that represents a series of text elements and characters. - Product: Adobe PDF Library 21 - Language: .NET Framework - Version: APDFL21.0.0PlusP1e - HTML page: https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Text - Version index: https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/llms.txt ```csharp class Text : Element ``` **Namespace:** `Datalogics::PDFL` **Inherits from:** [`Element`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Element.md) ## Description A container that represents a series of text elements and characters. A Text object is container that represents both a series of TextRun elements and a series of text characters. Operations can be performed on individual TextRuns within a Text or on individual characters within a Text by specifying the index of the individual TextRun or character. All indices start at 0. **Referenced by:** [`Text`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Text.md) **Uses types:** [`Clip`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Clip.md), [`ColorProfile`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/enum/ColorProfile.md), [`Document`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Document.md), [`ElementCloneFlags`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/enum/ElementCloneFlags.md), [`Font`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Font.md), [`GraphicState`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/GraphicState.md), [`Matrix`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Matrix.md), [`Point`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Point.md), [`Rect`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Rect.md), [`RenderIntent`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/enum/RenderIntent.md), [`Text`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Text.md), [`TextFlags`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/enum/TextFlags.md), [`TextRun`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/TextRun.md), [`TextState`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/TextState.md) ## Constructors ### Text ```csharp Datalogics.PDFL.Text.Text() ``` *constructor* Create a new, empty Text object. ## Properties ### BoundingBox ```csharp Rect Datalogics.PDFL.Element.BoundingBox { get; } ``` The bounding box for this element. The bounding box is a rectangle that is guaranteed to encompass the element, but it is not guaranteed to be the smallest box that could contain the element. For example, if the element is a Path that contains an arc, the bounding box encompasses the bezier control points, and not just the curve itself. ### Clip ```csharp Clip Datalogics.PDFL.Element.Clip { get; set; } ``` Gets the current Clip for an Element. ### Matrix ```csharp Matrix Datalogics.PDFL.Element.Matrix { get; set; } ``` The transformation matrix for the element. ### NumberOfCharacters ```csharp int Datalogics.PDFL.Text.NumberOfCharacters { get; } ``` The number of characters in this text element. ### NumberOfRuns ```csharp int Datalogics.PDFL.Text.NumberOfRuns { get; } ``` The number of text runs in this text element. ## Methods ### AddGlyphs ```csharp void Datalogics.PDFL.Text.AddGlyphs(System.Collections.Generic.List< System.Char > glyphIDs, System.Collections.Generic.List< System.Char > uniText, Font font, GraphicState gState, TextState state, Matrix matrix, TextFlags flags) ``` **Parameters** - `glyphIDs` (`System.Collections.Generic.List< System.Char >`): Glyphs IDs in the specified font for adding to the page's content - `uniText` (`System.Collections.Generic.List< System.Char >`): Unicode codes for the specified glyph IDs - `font` ([`Font`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Font.md)): Font for wich GlyphIDs were specified - `gState` ([`GraphicState`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/GraphicState.md)): The GraphicsState for Text element - `state` ([`TextState`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/TextState.md)): TextState flags - `matrix` ([`Matrix`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Matrix.md)): matrix for the Text element - `flags` ([`TextFlags`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/enum/TextFlags.md)): TextFlags that specifies what kind of text to add **Returns:** `void` Adds Unicode text to a Text object ### AddGlyphs ```csharp void Datalogics.PDFL.Text.AddGlyphs(System.Collections.Generic.List< System.Char > glyphIDs, System.Collections.Generic.List< System.Char > uniText, Font font, GraphicState gState, TextState state, Matrix matrix, TextFlags flags, int index) ``` **Parameters** - `glyphIDs` (`System.Collections.Generic.List< System.Char >`): Glyphs IDs in the specified font to add to the page's content - `uniText` (`System.Collections.Generic.List< System.Char >`): Unicode codes for the specified glyph IDs - `font` ([`Font`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Font.md)): Font for wich GlyphIDs were specified - `gState` ([`GraphicState`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/GraphicState.md)): The GraphicsState for Text element - `state` ([`TextState`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/TextState.md)): TextState flags - `matrix` ([`Matrix`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Matrix.md)): matrix for the Text element - `flags` ([`TextFlags`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/enum/TextFlags.md)): TextFlags that specifies what kind of text to add - `index` (`int`): The index after which to add the character or text run. **Returns:** `void` Adds Unicode text to a Text object ### AddRun ```csharp void Datalogics.PDFL.Text.AddRun(TextRun run) ``` **Parameters** - `run` ([`TextRun`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/TextRun.md)): The TextRun to append. **Returns:** `void` Adds a TextRun to the end of this text element. ### AddRun ```csharp void Datalogics.PDFL.Text.AddRun(TextRun run, int index) ``` **Parameters** - `run` ([`TextRun`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/TextRun.md)): TextRun to be added - `index` (`int`): Index, where TextRun should be placed **Returns:** `void` Adds a TextRun at the specified index. ### ChangeMatrixForTextRun ```csharp void Datalogics.PDFL.Text.ChangeMatrixForTextRun(Matrix newMatrix, int textRunIndex) ``` **Parameters** - `newMatrix` ([`Matrix`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Matrix.md)): The new transformation matrix to use for the TextRun. - `textRunIndex` (`int`): The index of a TextRun, relative to the Text object (the first TextRun in the Text object is at index 0). **Returns:** `void` Changes the transformation matrix from user space to the current text space for the specified TextRun. Unlike ChangeTextMatrixForTextRun(), this function does not change fontSize, hScale, and textRise in the textState of PDEText. The H and V values of the matrix indicate the origin of the first character. ### ChangeTextMatrixForTextRun ```csharp void Datalogics.PDFL.Text.ChangeTextMatrixForTextRun(Matrix newMatrix, int textRunIndex) ``` **Parameters** - `newMatrix` ([`Matrix`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Matrix.md)): The new transformation matrix to use for the TextRun. - `textRunIndex` (`int`): The index of a TextRun, relative to the Text object (the first TextRun in the Text object is at index 0). **Returns:** `void` Changes the transformation matrix from user space to the current text space for the specified TextRun. The H and V values of the matrix indicate the origin of the first character. ### Clone ```csharp new Text Datalogics.PDFL.Text.Clone() ``` **Returns:** `new Text` The copied text. Makes a copy of the text. Make a copy of an text to obtain a new text that has a distinct set of attributes. ### Clone ```csharp new Text Datalogics.PDFL.Text.Clone(ElementCloneFlags cloneFlags) ``` **Parameters** - `cloneFlags` ([`ElementCloneFlags`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/enum/ElementCloneFlags.md)): Flags that modify the cloning operation. **Returns:** `new Text` The copied text. Makes a copy of the text. Make a copy of an text to obtain a new text that has a distinct set of attributes. ### ColorConvert ```csharp Text Datalogics.PDFL.Text.ColorConvert(Document document, ColorProfile prof, RenderIntent intent, bool embed) ``` **Parameters** - `document` ([`Document`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Document.md)): The document the element belongs to. - `prof` ([`ColorProfile`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/enum/ColorProfile.md)): The ICC ColorProfile to be applied. - `intent` ([`RenderIntent`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/enum/RenderIntent.md)): The ICC Rendering Intent for the ColorProfile - `embed` (`bool`): If true, embed the color space and make the object calibrated. If it is false and the target profile is CMYK, RGB, or Gray, the colors space of the resulting object, after conversion, will be DeviceCMYK, DeviceRGB, or DeviceGray, respectively. **Returns:** [`Text`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Text.md) A new Text object with the applied ICC ColorProfile. Applies the specified ICC ColorProfile to the Text object ### Dispose ```csharp void Datalogics.PDFL.Element.Dispose() ``` **Returns:** `void` ### FindTextRunIndexForCharacter ```csharp int Datalogics.PDFL.Text.FindTextRunIndexForCharacter(int characterIndex) ``` **Parameters** - `characterIndex` (`int`): The index of a character, relative to the Text object (the first character in the Text object is at index 0). **Returns:** `int` The index of the TextRun that contains the character specified by characterIndex. Finds the index of the TextRun that contains the nth character in a Text object. ### GetAdvanceForCharacter ```csharp Point Datalogics.PDFL.Text.GetAdvanceForCharacter(int characterIndex) ``` **Parameters** - `characterIndex` (`int`): The index of a character, relative to the Text object (the first character in the Text object is at index 0). **Returns:** [`Point`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Point.md) A value specifying both the horizontal and vertical components of the advance width of a character in user space. Gets the advance width of a character, in user space. The advance width is the amount by which the current point advances when the character is drawn. Advance width may be horizontal or vertical, depending on the writing style. Thus, the return value has both a horizontal and a vertical component. ### GetAdvanceForTextRun ```csharp Point Datalogics.PDFL.Text.GetAdvanceForTextRun(int textRunIndex) ``` **Parameters** - `textRunIndex` (`int`): The index of a TextRun, relative to the Text object (the first TextRun in the Text object is at index 0). **Returns:** [`Point`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Point.md) A value specifying both the horizontal and vertical components of the advance width of a TextRun in user space. Gets the advance width of a TextRun, in user space. The advance width is the amount by which the current point advances when the TextRun is drawn. Advance width may be horizontal or vertical, depending on the writing style. Thus, the return value has both a horizontal and a vertical component. ### GetBoundingBoxForCharacter ```csharp Rect Datalogics.PDFL.Text.GetBoundingBoxForCharacter(int characterIndex) ``` **Parameters** - `characterIndex` (`int`): The index of a character, relative to the Text object (the first character in the Text object is at index 0) **Returns:** [`Rect`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Rect.md) A Rect specifying the bounding box for the character. The bounding box for a character in this text element. ### GetRun ```csharp TextRun Datalogics.PDFL.Text.GetRun(int index) ``` **Parameters** - `index` (`int`): The zero-based index of the TextRun to retrieve. **Returns:** [`TextRun`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/TextRun.md) The TextRun at the specified index. Obtains the TextRun at the specified index. ### GetTextMatrixForCharacter ```csharp Matrix Datalogics.PDFL.Text.GetTextMatrixForCharacter(int characterIndex) ``` **Parameters** - `characterIndex` (`int`): The index of a character, relative to the Text object (the first character in the Text object is at index 0). **Returns:** [`Matrix`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Matrix.md) The transformation matrix for the character specified by characterIndex. Gets the transformation matrix from user space to the current text space for the specified character. The H and V values of the matrix indicate the origin of the first character. ### GetTextMatrixForTextRun ```csharp Matrix Datalogics.PDFL.Text.GetTextMatrixForTextRun(int textRunIndex) ``` **Parameters** - `textRunIndex` (`int`): The index of a TextRun, relative to the Text object (the first TextRun in the Text object is at index 0). **Returns:** [`Matrix`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Matrix.md) The transformation matrix for the TextRun specified by TextRunIndex. Gets the transformation matrix from user space to the current text space for the specified TextRun. The H and V values of the matrix indicate the origin of the first character. ### PointIntersectsCharacter ```csharp bool Datalogics.PDFL.Text.PointIntersectsCharacter(Point p, int index) ``` **Parameters** - `p` ([`Point`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Point.md)): The point to test, in user space coordinates. - `index` (`int`): The index of the character. The first character in the Text has an index of 0. **Returns:** `bool` true if the point is on the character, false if the point is not on the character. Tests whether a point is on a specified character within this Text object. ### PointIntersectsTextRun ```csharp bool Datalogics.PDFL.Text.PointIntersectsTextRun(Point p, int index) ``` **Parameters** - `p` ([`Point`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Point.md)): The point to test, in user space coordinates. - `index` (`int`): The index of the TextRun. The first TextRun in the Text has an index of 0. **Returns:** `bool` true if the point is on the TextRun, false if the point is not on the TextRun. Tests whether a point is on a specified TextRun within this Text object. ### RectIntersectsCharacter ```csharp bool Datalogics.PDFL.Text.RectIntersectsCharacter(Rect r, int index) ``` **Parameters** - `r` ([`Rect`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Rect.md)): The rect to test, in user space coordinates. - `index` (`int`): The index of the character. The first character in the Text has an index of 0. **Returns:** `bool` true if any part of the rectangle is on the character, false if no part of the rectangle is on the character. Tests whether any part of a rectangle is on a specified character within this Text object. ### RectIntersectsTextRun ```csharp bool Datalogics.PDFL.Text.RectIntersectsTextRun(Rect r, int index) ``` **Parameters** - `r` ([`Rect`](https://docs.datalogics.com/apdfl21/DotNetFramework/APDFL21.0.0PlusP1e/class/Rect.md)): The rect to test, in user space coordinates. - `index` (`int`): The index of the TextRun. The first TextRun in the Text has an index of 0. **Returns:** `bool` true if any part of the rectangle is on the TextRun, false if no part of the rectangle is on the TextRun. Tests whether any part of a rectangle is on a specified TextRun within this Text object. ### RemoveRuns ```csharp void Datalogics.PDFL.Text.RemoveRuns(int index, int count) ``` **Parameters** - `index` (`int`): Start position of range to delete - `count` (`int`): Count of TextRuns to delete **Returns:** `void` Removes a count of TextRuns, starting from index ### Rotate ```csharp void Datalogics.PDFL.Element.Rotate(double theta) ``` **Parameters** - `theta` (`double`): The rotation angle in degrees. **Returns:** `void` Rotate an element by theta degrees counterclockwise using the matrix [ cos T sin T -sin T cos T 0 0 ]. ### Scale ```csharp void Datalogics.PDFL.Element.Scale(double sx, double sy) ``` **Parameters** - `sx` (`double`): The horizontal scale factor. - `sy` (`double`): The vertical scale factor. **Returns:** `void` Scale an element by (sx,sy) units using the matrix [ sx 0 0 sy 0 0 ]. ### SplitTextRunAtCharacter ```csharp void Datalogics.PDFL.Text.SplitTextRunAtCharacter(int splitLocation) ``` **Parameters** - `splitLocation` (`int`): The split location, relative to the Text object. **Returns:** `void` Splits the TextRun containing the character at the specified location into two contiguous TextRuns. The character at the specified index will be part of the first TextRun. ### Translate ```csharp void Datalogics.PDFL.Element.Translate(double tx, double ty) ``` **Parameters** - `tx` (`double`): The horizontal translation distance in user space units. - `ty` (`double`): The vertical translation distance in user space units. **Returns:** `void` Translate an element by (tx,ty) units using the matrix [ 1 0 0 1 tx ty ].