Heading

Heading class

Represents heading.

The Heading type exposes the following members:

Constructors

NameDescription
Heading(level)Initializes a new instance of the Heading class

Properties

NameDescription
vertical_alignmentGets or sets a vertical alignment of text fragment.
horizontal_alignmentGets or sets a horizontal alignment of text fragment.
marginGets or sets a outer margin for paragraph (for pdf generation)
is_first_paragraph_in_columnGets or sets a bool value that indicates whether this paragraph will be at next column.
Default is false.(for pdf generation)
is_kept_with_nextGets or sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph.
Default is false.(for pdf generation)
is_in_new_pageGets or sets a bool value that force this paragraph generates at new page.
Default is false.(for pdf generation)
is_in_line_paragraphGets or sets a paragraph is inline.
Default is false.(for pdf generation)
hyperlinkSets the fragment hyperlink
z_indexGets or sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex
will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative
ZIndex will be placed behind the text in the page.
replace_optionsGets text replace options. The options define behavior when fragment text is replaced to more short/long.
textGets or sets string text object that the TextFragment object represents.
text_stateGets or sets text state for the text that TextFragment object represents.
segmentsGets text segments for current TextFragment.
positionGets or sets text position for text, represented with TextFragment object.
baseline_positionGets text position for text, represented with TextFragment object.
The YIndent of the Position structure represents baseline coordinate of the text fragment.
rectangleGets rectangle of the TextFragment
pageGets page that contains the TextFragment
formGets form object that contains the TextFragment
wrap_lines_countGets or sets wrap lines count for this paragraph(for pdf generation only)
end_noteGets or sets the paragraph end note.(for pdf generation only)
foot_noteGets or sets the paragraph foot note.(for pdf generation only)
toc_pageGets the page that contains this heading.
topGets the top Y of this headings.
start_numberGets the heading start number.
is_auto_sequenceGets the heading should be numered automatically.
is_in_listGets the heading should be in toc list.
destination_pageGets the destination page.
levelGets the level.
styleGets or sets style.
user_labelGets or sets user label.

Methods

NameDescription
clone()Clone the heading.
isolate_text_segments(start_index, length)Gets TextSegment(s) representing specified part of the TextFragment text.
clone_with_segments()Clone the heading with all segments.

See Also