Heading
Overview
Heading is a class in Aspose.PDF FOSS for .NET.
Inherits from: BaseParagraph.
Represents a TOC heading entry that links to a destination page.
This class provides 3 methods for working with Heading objects in .NET programs.
Available methods include: Clone, CloneWithSegments, Heading.
All public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package.
Properties: DestinationPage, HorizontalAlignment, Hyperlink, HyperlinkText, IsAutoSequence, IsFirstParagraphInColumn, and 16 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
Level | int | Read/Write | Heading level (1-based). |
Style | NumberingStyle | Read/Write | Numbering style used for auto-numbered headings. |
Segments | TextSegmentCollection | Read | Text segments of this heading entry. |
TocPage | Page? | Read/Write | The TOC page this heading belongs to. |
DestinationPage | Page? | Read/Write | The destination page this heading links to. |
Top | double | Read/Write | Y coordinate (in points) of the destination on DestinationPage that this TOC entry’s link points to. |
IsInList | bool | Read/Write | Whether the heading is inserted into the TOC list. |
IsAutoSequence | bool | Read/Write | Whether the heading number is auto-incremented. |
TextState | Aspose.Pdf.Text.TextState | Read/Write | Default text state applied to the heading text. |
Text | string | Read/Write | Convenience text accessor — sets a single TextSegment as the heading text. |
StartNumber | int | Read/Write | Heading auto-sequence start number. |
UserLabel | TextSegment? | Read/Write | Custom user label shown in place of the auto number. |
HorizontalAlignment | HorizontalAlignment | Read/Write | Horizontal alignment applied to this paragraph. |
VerticalAlignment | VerticalAlignment | Read/Write | Vertical alignment applied to this paragraph. |
Margin | MarginInfo? | Read/Write | Outer-margin info applied to this paragraph. |
IsFirstParagraphInColumn | bool | Read/Write | Force the paragraph to start a new column. |
IsKeptWithNext | bool | Read/Write | Keep this paragraph on the same page as the next one. |
IsInNewPage | bool | Read/Write | Force the paragraph to start on a new page. |
IsInLineParagraph | bool | Read/Write | Inline paragraph flag (does not start a new line). |
HyperlinkText | string? | Read/Write | Legacy string-typed hyperlink target. |
Hyperlink | Hyperlink? | Read/Write | Typed hyperlink decoration applied to the paragraph. |
ZIndex | int | Read/Write | Z-order index used by the DOM renderer. |
Methods
| Signature | Description |
|---|---|
Heading(level: int) | Calls Heading on this Heading instance. |
Clone() | Shallow clone of this heading. |
CloneWithSegments() | Clone the heading and copy its segments by reference. |