TextState
Overview
TextState is a class in Aspose.PDF FOSS for .NET.
Text formatting state.
This class declares 11 methods for TextState objects in .NET programs.
Available methods include: ApplyChangesFrom, MeasureHeight, MeasureString, TextState.
Public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package.
Properties: BackgroundColor, CharacterSpacing, CoordinateOrigin, Font, FontData, FontName, and 29 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
FontName | string? | Read/Write | Gets or sets the name of the font family used for the text; null when not set. |
TextXIndent | float | Read | On-page start X (points) of the text this state belongs to. |
TextHeight | float | Read | Text height in points: (Ascent + |
FontSize | float | Read/Write | Gets or sets the font size, in points; the default is 10. |
ForegroundColor | Color? | Read/Write | Gets or sets the text fill colour; null when not set. |
StrokingColor | Color? | Read/Write | Stroking (outline) color of the text. |
CoordinateOrigin | CoordinateOrigin | Read/Write | Whether text positioning treats Y as the baseline or the descender. |
BackgroundColor | Color? | Read/Write | Gets or sets the colour of a rectangle painted behind the text; null (the default) paints none. |
IsBold | bool | Read/Write | Whether the font is bold. |
IsItalic | bool | Read/Write | Whether the font is italic. |
FontStyle | FontStyles | Read/Write | Font style flags (Bold, Italic, etc.). |
Underline | bool | Read/Write | Whether the text is underlined (alias for IsUnderline). |
IsUnderline | bool | Read/Write | Whether the text is underlined. |
IsStrikeOut | bool | Read/Write | Whether the text has strikethrough. |
StrikeOut | bool | Read/Write | Alias for IsStrikeOut. |
IsSuperscript | bool | Read/Write | Whether the text is superscript. |
Superscript | bool | Read/Write | Alias for IsSuperscript. |
IsSubscript | bool | Read/Write | Whether the text is subscript. |
Subscript | bool | Read/Write | Alias for IsSubscript. |
CharacterSpacing | float | Read/Write | Character spacing in text space units. |
WordSpacing | float | Read/Write | Word spacing in text space units. |
HorizontalScaling | float | Read/Write | Horizontal scaling percentage (default 100). |
LineBoxAscentEm | double? | Read/Write | Line spacing (leading) in text space units. |
LineBoxDescentEm | double? | Read/Write | The line-box descent this caller declares, in em, as a POSITIVE distance below the baseline. |
LineSpacing | float | Read/Write | Gets or sets the extra space, in points, added above each line of the text; the default is 0. |
TabTag | string | Read | String token inserted into the rendered text in place of a tab character. |
HorizontalAlignment | HorizontalAlignment | Read/Write | Horizontal alignment of the text. |
RenderingMode | TextRenderingMode | Read/Write | Text rendering mode (Tr operator). |
LineWidth | double | Read/Write | Stroke line width (the w operator) in effect for the run: the pen a stroking RenderingMode outlines the glyphs with. |
Invisible | bool | Read/Write | Whether this text fragment is invisible: rendering mode 3, or text that a LATER opaque filled rectangle fully covers (hidden-by-occlusion: redaction-style covered text reports Invisible while its RenderingMode stays FillText). |
TextRise | double | Read/Write | Text rise (superscript/subscript offset). |
Rotation | double | Read/Write | Text rotation angle in degrees. |
Font | Font? | Read/Write | Gets or sets the font used for the text; the default is Helvetica. |
FontData | FontData? | Read/Write | External font data for embedding (set via FontRepository.OpenFont). |
FormattingOptions | TextFormattingOptions | Read/Write | Text formatting options (WordWrapMode, LineSpacingMode, etc.). |
Methods
| Signature | Description |
|---|---|
TextState() | Creates a text state with the default settings: Helvetica at 10 points. |
TextState(fontSize: double) | Creates a text state with the given font size, in points. |
TextState(fontFamily: string) | Creates a text state that uses the named font family. |
TextState(fontFamily: string, fontSize: double) | Creates a text state that uses the named font family at the given size, in points. |
TextState(fontFamily: string, bold: bool, italic: bool) | Creates a text state that uses the named font family with the given bold and italic flags; the styled face (e.g. |
TextState(foregroundColor: System.Drawing.Color) | Creates a text state with the given text (foreground) colour. |
TextState(foregroundColor: System.Drawing.Color, fontSize: double) | Creates a text state with the given text (foreground) colour and font size, in points. |
TextState(foregroundColor: System.Drawing.Color, backgroundColor: System.Drawing.Color, fontStyle: FontStyles, font: Font, fontSize: double) | Colours, style, face and size in one call. |
MeasureString(str: string) | Rough text-width estimate at the current font/size. |
MeasureHeight(character: char) | Height of character at the current font / size, in points — the glyph’s own bounding-box height (yMax − yMin) mapped to text space as height × FontSize / 1000. |
ApplyChangesFrom(textState: TextState) | Copy every public formatting property from other into this state (leaving owner linkage intact). |
