Aspose::Pdf::Heading class

Heading class

Represents heading.

class Heading : public Aspose::Pdf::Text::TextFragment

Methods

MethodDescription
BaseParagraph()
Clone() overrideClone the heading.
CloneWithSegments() overrideClone the heading with all segments.
get_BaselinePosition()Gets text position for text, represented with TextFragment object. The YIndent of the Position structure represents baseline coordinate of the text fragment.
get_DestinationPage() constGets the destination page.
get_EndNote() constGets the paragraph end note.(for pdf generation only)
get_FootNote() constGets the paragraph foot note.(for pdf generation only)
get_Form() constGets form object that contains the TextFragment.
get_HorizontalAlignment() overrideGets a horizontal alignment of text fragment.
virtual get_Hyperlink()Gets the fragment hyperlink(for pdf generator).
get_IsAutoSequence() constGets the heading should be numered automatically.
get_IsFirstParagraphInColumn() constGets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation)
get_IsInLineParagraph() constGets a paragraph is inline. Default is false.(for pdf generation)
get_IsInList() constGets the heading should be in toc list.
get_IsInNewPage() constGets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation)
get_IsKeptWithNext() constGets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation)
get_Level() constGets the level.
get_Margin()Gets a outer margin for paragraph (for pdf generation)
get_Page() constGets page that contains the TextFragment.
get_Position()Gets text position for text, represented with TextFragment object.
get_Rectangle()Gets rectangle of the TextFragment.
get_ReplaceOptions() constGets text replace options. The options define behavior when fragment text is replaced to more short/long.
get_Segments() constGets text segments for current TextFragment.
get_StartNumber() constGets the heading start number.
get_Style() constGets style.
get_Text()Gets System::String text object that the TextFragment object represents.
get_TextState()Gets text state for the text that TextFragment object represents.
get_TocPage() constGets the page that contains this heading.
get_Top() constGets the top Y of this headings.
get_UserLabel() constGets user label.
get_VerticalAlignment() overrideGets a vertical alignment of text fragment.
get_WrapLinesCount() constGets wrap lines count for this paragraph(for pdf generation only)
get_ZIndex() constGets 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.
Heading(int32_t)Initializes a new instance of the Cell class.
IsolateTextSegments(int32_t, int32_t)Gets TextSegment(s) representing specified part of the TextFragment text.
set_BaselinePosition(System::SharedPtr<Aspose::Pdf::Text::Position>)Gets text position for text, represented with TextFragment object. The YIndent of the Position structure represents baseline coordinate of the text fragment.
set_DestinationPage(System::SharedPtr<Aspose::Pdf::Page>)Gets the destination page.
set_EndNote(System::SharedPtr<Note>)Sets the paragraph end note.(for pdf generation only)
set_FootNote(System::SharedPtr<Note>)Sets the paragraph foot note.(for pdf generation only)
set_HorizontalAlignment(Aspose::Pdf::HorizontalAlignment) overrideSets a horizontal alignment of text fragment.
set_Hyperlink(System::SharedPtr<Aspose::Pdf::Hyperlink>) overrideSets the fragment hyperlink.
set_IsAutoSequence(bool)Gets the heading should be numered automatically.
set_IsFirstParagraphInColumn(bool)Sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation)
set_IsInLineParagraph(bool)Sets a paragraph is inline. Default is false.(for pdf generation)
set_IsInList(bool)Gets the heading should be in toc list.
set_IsInNewPage(bool)Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation)
set_IsKeptWithNext(bool)Sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation)
set_Level(int32_t)Gets the level.
set_Margin(System::SharedPtr<MarginInfo>)Sets a outer margin for paragraph (for pdf generation)
set_Position(System::SharedPtr<Aspose::Pdf::Text::Position>)Sets text position for text, represented with TextFragment object.
set_Segments(System::SharedPtr<TextSegmentCollection>)Gets text segments for current TextFragment.
set_StartNumber(int32_t)Gets the heading start number.
set_Style(NumberingStyle)Sets style.
set_Text(System::String)Sets System::String text object that the TextFragment object represents.
set_TocPage(System::SharedPtr<Aspose::Pdf::Page>)Gets the page that contains this heading.
set_Top(double)Gets the top Y of this headings.
set_UserLabel(System::SharedPtr<Text::TextSegment>)Sets user label.
set_VerticalAlignment(Aspose::Pdf::VerticalAlignment) overrideSets a vertical alignment of text fragment.
set_WrapLinesCount(int32_t)Sets wrap lines count for this paragraph(for pdf generation only)
set_ZIndex(int32_t)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.
TextFragment()Initializes new instance of the TextFragment object.
TextFragment(System::SharedPtr<TabStops>)Initializes new instance of the TextFragment object with predefined TabStops positions.
TextFragment(System::String)Creates TextFragment object with single TextSegment object inside. Specifies text string inside the segment.
TextFragment(System::String, System::SharedPtr<TabStops>)Creates TextFragment object with single TextSegment object inside and predefined TabStops positions.

See Also