TextParagraph
Overview
TextParagraph is a class in Aspose.PDF FOSS for .NET.
Represents a text paragraph that can be placed on a page via AppendParagraph.
This class declares 10 methods for TextParagraph objects in .NET programs.
Available methods include: AppendLine, BeginEdit, EndEdit, TextParagraph.
Public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package.
Properties: BackgroundColor, FirstLineIndent, FormattingOptions, HorizontalAlignment, HyphenSymbol, Justify, and 10 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
Rectangle | Rectangle? | Read/Write | The bounding rectangle where the paragraph is rendered on the page. |
Position | Position? | Read/Write | The absolute position for the paragraph. |
FormattingOptions | TextFormattingOptions | Read/Write | Formatting options for the paragraph, including word wrap mode. |
Rotation | double | Read/Write | Rotation angle in degrees for the entire paragraph. |
RemainingLines | TextFragmentCollection | Read | The wrapped lines that did not fit in the rectangle when LimitWithBounds cut the paragraph, each as a fragment ready to be appended to a paragraph on the next page. |
BackgroundColor | Color? | Read/Write | Background colour painted behind the whole paragraph block: one rectangle the height of the block, as wide as the widest line plus BackgroundPad (or the content width when a line overflows), seated at the block’s bottom-left. |
updatePositioningCalls | int | Read/Write | Diagnostic counter incremented whenever the renderer performs a layout-positioning pass for this paragraph. |
HorizontalAlignment | HorizontalAlignment | Read/Write | Horizontal alignment of text within the paragraph rectangle. |
VerticalAlignment | VerticalAlignment | Read/Write | Vertical alignment of text within the paragraph rectangle. |
Margin | MarginInfo | Read/Write | Margin around the paragraph. |
LimitWithBounds | bool | Read/Write | When true, text is limited to the bounds of the paragraph rectangle. |
HyphenSymbol | string | Read/Write | The symbol a hyphenating wrap writes at the break. |
TextRectangle | Rectangle | Read | The calculated bounding rectangle of the paragraph text. |
FirstLineIndent | float | Read/Write | First-line indent in points. |
SubsequentLinesIndent | float | Read/Write | Indent (points) applied to every line except the first. |
Justify | bool | Read/Write | When true, paragraph lines fill the rectangle width by adjusting word spacing. |
Methods
| Signature | Description |
|---|---|
TextParagraph() | Creates an empty paragraph with no lines. |
BeginEdit() | Begin a batched edit window. |
EndEdit() | End a batched edit window started by BeginEdit. |
AppendLine(line: TextFragment) | Append a text fragment as a new line in the paragraph. |
AppendLine(line: TextFragment, textState: TextState) | Append a TextFragment line and override its text state. |
AppendLine(line: TextFragment, textState: TextState, lineSpacing: float) | Append a TextFragment with text-state override and per-line spacing. |
AppendLine(line: string) | Append a text string as a new line in the paragraph using default text state. |
AppendLine(line: string, textState: TextState) | Append a text string with the given text state as a new line. |
AppendLine(line: string, textState: TextState, lineSpacing: float) | Append a text string with text state and per-line spacing. |
AppendLine(line: string, lineSpacing: float) | Append a text string with per-line spacing using default text state. |
