Represents heading. More...

Inherits Aspose::Pdf::Text::TextFragment.

Public Member Functions

System::SharedPtr< Aspose::Pdf::Pageget_TocPage ()
 Gets the page that contains this heading. More...
 
void set_TocPage (System::SharedPtr< Aspose::Pdf::Page > value)
 Gets the page that contains this heading. More...
 
double get_Top ()
 Gets the top Y of this headings. More...
 
void set_Top (double value)
 Gets the top Y of this headings. More...
 
int32_t get_StartNumber ()
 Gets the heading start number. More...
 
void set_StartNumber (int32_t value)
 Gets the heading start number. More...
 
bool get_IsAutoSequence ()
 Gets the heading should be numered automatically. More...
 
void set_IsAutoSequence (bool value)
 Gets the heading should be numered automatically. More...
 
bool get_IsInList ()
 Gets the heading should be in toc list. More...
 
void set_IsInList (bool value)
 Gets the heading should be in toc list. More...
 
System::SharedPtr< Aspose::Pdf::Pageget_DestinationPage ()
 Gets the destination page. More...
 
void set_DestinationPage (System::SharedPtr< Aspose::Pdf::Page > value)
 Gets the destination page. More...
 
int32_t get_Level ()
 Gets the level. More...
 
void set_Level (int32_t value)
 Gets the level. More...
 
NumberingStyle get_Style ()
 Gets style. More...
 
void set_Style (NumberingStyle value)
 Sets style. More...
 
System::SharedPtr< Text::TextSegmentget_UserLabel ()
 Gets user label. More...
 
void set_UserLabel (System::SharedPtr< Text::TextSegment > value)
 Sets user label. More...
 
 Heading (int32_t level)
 Initializes a new instance of the Cell class. More...
 
virtual System::SharedPtr< System::ObjectClone ()
 Clone the heading. More...
 
virtual System::SharedPtr< System::ObjectCloneWithSegments ()
 Clone the heading with all segments. More...
 
- Public Member Functions inherited from Aspose::Pdf::Text::TextFragment
System::String get_Text ()
 Gets System::String text object that the TextFragment object represents. More...
 
void set_Text (System::String value)
 Sets System::String text object that the TextFragment object represents. More...
 
virtual Aspose::Pdf::VerticalAlignment get_VerticalAlignment ()
 Gets a vertical alignment of text fragment. More...
 
virtual void set_VerticalAlignment (Aspose::Pdf::VerticalAlignment value)
 Sets a vertical alignment of text fragment. More...
 
virtual Aspose::Pdf::HorizontalAlignment get_HorizontalAlignment ()
 Gets a horizontal alignment of text fragment. More...
 
virtual void set_HorizontalAlignment (Aspose::Pdf::HorizontalAlignment value)
 Sets a horizontal alignment of text fragment. More...
 
virtual void set_Hyperlink (System::SharedPtr< Aspose::Pdf::Hyperlink > value)
 Sets the fragment hyperlink More...
 
System::SharedPtr< TextFragmentStateget_TextState ()
 Gets text state for the text that TextFragment object represents. More...
 
System::SharedPtr< TextSegmentCollectionget_Segments ()
 Gets text segments for current TextFragment. More...
 
void set_Segments (System::SharedPtr< TextSegmentCollection > value)
 Gets text segments for current TextFragment. More...
 
System::SharedPtr< Aspose::Pdf::Text::Positionget_Position ()
 Gets text position for text, represented with TextFragment object. More...
 
void set_Position (System::SharedPtr< Aspose::Pdf::Text::Position > value)
 Sets text position for text, represented with TextFragment object. More...
 
System::SharedPtr< Aspose::Pdf::Text::Positionget_BaselinePosition ()
 Gets text position for text, represented with TextFragment object. The YIndent of the Position structure represents baseline coordinate of the text fragment. More...
 
void set_BaselinePosition (System::SharedPtr< Aspose::Pdf::Text::Position > value)
 Gets text position for text, represented with TextFragment object. The YIndent of the Position structure represents baseline coordinate of the text fragment. More...
 
System::SharedPtr< Aspose::Pdf::Rectangleget_Rectangle ()
 Gets rectangle of the TextFragment More...
 
System::SharedPtr< Aspose::Pdf::Pageget_Page ()
 Gets page that contains the TextFragment More...
 
System::SharedPtr< XFormget_Form ()
 Gets form object that contains the TextFragment More...
 
int32_t get_WrapLinesCount ()
 Gets wrap lines count for this paragraph(for pdf generation only) More...
 
void set_WrapLinesCount (int32_t value)
 Sets wrap lines count for this paragraph(for pdf generation only) More...
 
System::SharedPtr< Noteget_EndNote ()
 Gets the paragraph end note.(for pdf generation only) More...
 
void set_EndNote (System::SharedPtr< Note > value)
 Sets the paragraph end note.(for pdf generation only) More...
 
System::SharedPtr< Noteget_FootNote ()
 Gets the paragraph foot note.(for pdf generation only) More...
 
void set_FootNote (System::SharedPtr< Note > value)
 Sets the paragraph foot note.(for pdf generation only) More...
 
 TextFragment ()
 Initializes new instance of the TextFragment object. More...
 
 TextFragment (System::SharedPtr< TabStops > tabStops)
 Initializes new instance of the TextFragment object with predefined TabStops positions. More...
 
 TextFragment (System::String text)
 Creates TextFragment object with single TextSegment object inside. Specifies text string inside the segment. More...
 
 TextFragment (System::String text, System::SharedPtr< TabStops > tabStops)
 Creates TextFragment object with single TextSegment object inside and predefined TabStops positions. More...
 
System::SharedPtr< TextSegmentCollectionIsolateTextSegments (int32_t startIndex, int32_t length)
 Gets TextSegment(s) representing specified part of the TextFragment text. More...
 
- Public Member Functions inherited from Aspose::Pdf::BaseParagraph
System::SharedPtr< MarginInfoget_Margin ()
 Gets a outer margin for paragraph (for pdf generation) More...
 
void set_Margin (System::SharedPtr< MarginInfo > value)
 Sets a outer margin for paragraph (for pdf generation) More...
 
bool get_IsFirstParagraphInColumn ()
 Gets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) More...
 
void set_IsFirstParagraphInColumn (bool value)
 Sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) More...
 
bool get_IsKeptWithNext ()
 Gets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) More...
 
void set_IsKeptWithNext (bool value)
 Sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) More...
 
bool get_IsInNewPage ()
 Gets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
void set_IsInNewPage (bool value)
 Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
bool get_IsInLineParagraph ()
 Gets a paragraph is inline. Default is false.(for pdf generation) More...
 
void set_IsInLineParagraph (bool value)
 Sets a paragraph is inline. Default is false.(for pdf generation) More...
 
virtual System::SharedPtr< Aspose::Pdf::Hyperlinkget_Hyperlink ()
 Gets the fragment hyperlink(for pdf generator). More...
 
int32_t get_ZIndex ()
 Gets 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. More...
 
void set_ZIndex (int32_t value)
 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. More...
 
 BaseParagraph ()
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

double get_Left ()
 Gets the left X of this headings(for internal use). More...
 
void set_Left (double value)
 Gets the left X of this headings(for internal use). More...
 
 Heading ()
 
System::String GetDashString ()
 
System::SharedPtr< Text::TextParagraphProcess (double curX, double &curY, System::SharedPtr< Aspose::Pdf::Rectangle > rect, System::SharedPtr< MarginInfo > marginInfo, double width, double realWidth, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Heading >>> keptWithNextTocLinks, System::SharedPtr< Aspose::Pdf::Page > page)
 Process headings for table of contents. More...
 
virtual void Serialize (System::SharedPtr< System::Xml::XmlTextWriter > writer)
 
virtual void Deserialize (System::SharedPtr< System::Xml::XmlReader > reader)
 
- Protected Member Functions inherited from Aspose::Pdf::Text::TextFragment
Aspose::Pdf::Text::TextState::AttachState get_AttachedState ()
 
void set_AttachedState (Aspose::Pdf::Text::TextState::AttachState value)
 
System::SharedPtr< TextReplaceOptionsget_ReplaceOptions ()
 
void set_ReplaceOptions (System::SharedPtr< TextReplaceOptions > value)
 
System::String get_McName ()
 
int32_t get_McId ()
 
System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::SegmentsGroupState > get_SegmentsGroupState ()
 
void set_SegmentsGroupState (System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::SegmentsGroupState > value)
 
void set_TextState (System::SharedPtr< TextFragmentState > value)
 Sets text state for the text that TextFragment object represents. More...
 
System::SharedPtr< TextFragmentCollectionget_Fragments ()
 Gets collection that contains current fragment More...
 
void set_Fragments (System::SharedPtr< TextFragmentCollection > value)
 Sets collection that contains current fragment More...
 
void set_Rectangle (System::SharedPtr< Aspose::Pdf::Rectangle > value)
 Gets rectangle of the TextFragment More...
 
void set_Page (System::SharedPtr< Aspose::Pdf::Page > value)
 Gets page that contains the TextFragment More...
 
System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::TextSegmenter > get_Segmenter ()
 Gets TextSegmenter that was used for creation segments of this fragment. More...
 
bool get_IsPositionChanged ()
 Indicates whether position of the fragment is changed or default More...
 
void SetEncodedTextProperties (System::SharedPtr< Font > font, System::String text, System::ArrayPtr< int32_t > indices)
 Sets font and indices inside the font More...
 
void Attach (System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::TextSegmenter > segmenter)
 Attaches to the segmenter More...
 
void IsolateToSingleSegment ()
 Isolates segments to single segment for simpler editing. More...
 
void IsolateToText ()
 Isolates segments to segment that represent the text only. i.e. we Trim from beginning and end More...
 
System::SharedPtr< Aspose::Pdf::RectangleComputeUnderlineRectangle ()
 
System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::PhysicalTextSegment > > GetAttachedPhysicalSegmentsArray (int32_t &firstSegmentIndex, int32_t &lastSegmentIndex)
 
void ResetTabstops ()
 
bool IsMultiline ()
 Indicates whether the fragment contains segments on different "text lines" More...
 
 TextFragment (System::String text, System::SharedPtr< TextSegmentCollection > segments)
 
 TextFragment (System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::TextSegmenter > segmenter, System::String text, System::SharedPtr< TextSegmentCollection > segments)
 
void SyncVerticalAlignment (Aspose::Pdf::VerticalAlignment verticalAlignment)
 
void SyncHorizontalAlignment (Aspose::Pdf::HorizontalAlignment horizontalAlignment1)
 
void LightWeightTextSetter (System::String inText)
 Set text with no adjustment. More...
 
void LightWeightTextSetterWithNoTextShift (System::String inText)
 Set text with no adjustment. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::PhysicalTextSegment > > > GetLineSegments (double x_indent, double y_indent, double angle)
 
void SetMarkedContentProperties (System::String name, int32_t id)
 
void Assign (System::SharedPtr< TextFragment > fragment)
 
void AssignWithSegments (System::SharedPtr< TextFragment > fragment)
 
- Protected Member Functions inherited from Aspose::Pdf::BaseParagraph
System::String get_Id ()
 Gets a paragraph id. More...
 
void set_Id (System::String value)
 Sets a paragraph id. More...
 
System::SharedPtr< Annotations::LinkAnnotationget_ReferencedFrom ()
 Gets the fragment hyperlink(for pdf generator internal use). More...
 
void set_ReferencedFrom (System::SharedPtr< Annotations::LinkAnnotation > value)
 Sets the fragment hyperlink(for pdf generator internal use). More...
 
void ChangePosition (double &curX, double &curY, double newX, double newY, bool isNextParagraphInline)
 
void ProcessHyperlink (System::SharedPtr< Page > page, System::SharedPtr< Rectangle > rect)
 

Static Protected Member Functions

static System::SharedPtr< TocInfoget_DefaultTOC ()
 DefaultTocInfo. More...
 
- Static Protected Member Functions inherited from Aspose::Pdf::Text::TextFragment
static System::SharedPtr< Aspose::Pdf::RectangleGetGroupRectangle (System::SharedPtr< TextSegmentCollection > segments, int32_t firstSegmentBeginIndex, int32_t lastSegmentEndIndex, bool measureLastTechnicalSpacings)
 
- Static Protected Member Functions inherited from Aspose::Pdf::BaseParagraph
static bool get_IsZIndexSet ()
 Gets the fragment hyperlink(for pdf generator performance internal use). More...
 
static void set_IsZIndexSet (bool value)
 Sets the fragment hyperlink(for pdf generator performance internal use). More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
- Protected Attributes inherited from Aspose::Pdf::Text::TextFragment
System::EventHandler OnRectChanged
 

Detailed Description

Represents heading.

Constructor & Destructor Documentation

◆ Heading() [1/2]

Aspose::Pdf::Heading::Heading ( int32_t  level)

Initializes a new instance of the Cell class.

Parameters
levelThe headings level.

◆ Heading() [2/2]

Aspose::Pdf::Heading::Heading ( )
protected

Member Function Documentation

◆ Clone()

virtual System::SharedPtr<System::Object> Aspose::Pdf::Heading::Clone ( )
virtual

Clone the heading.

Returns
The cloned object

Reimplemented from Aspose::Pdf::Text::TextFragment.

◆ CloneWithSegments()

virtual System::SharedPtr<System::Object> Aspose::Pdf::Heading::CloneWithSegments ( )
virtual

Clone the heading with all segments.

Returns
The cloned object

Reimplemented from Aspose::Pdf::Text::TextFragment.

◆ Deserialize()

virtual void Aspose::Pdf::Heading::Deserialize ( System::SharedPtr< System::Xml::XmlReader reader)
protectedvirtual

Reimplemented from Aspose::Pdf::Text::TextFragment.

◆ get_DefaultTOC()

static System::SharedPtr<TocInfo> Aspose::Pdf::Heading::get_DefaultTOC ( )
staticprotected

DefaultTocInfo.

The page.

◆ get_DestinationPage()

System::SharedPtr<Aspose::Pdf::Page> Aspose::Pdf::Heading::get_DestinationPage ( )

Gets the destination page.

◆ get_IsAutoSequence()

bool Aspose::Pdf::Heading::get_IsAutoSequence ( )

Gets the heading should be numered automatically.

◆ get_IsInList()

bool Aspose::Pdf::Heading::get_IsInList ( )

Gets the heading should be in toc list.

◆ get_Left()

double Aspose::Pdf::Heading::get_Left ( )
protected

Gets the left X of this headings(for internal use).

◆ get_Level()

int32_t Aspose::Pdf::Heading::get_Level ( )

Gets the level.

◆ get_StartNumber()

int32_t Aspose::Pdf::Heading::get_StartNumber ( )

Gets the heading start number.

◆ get_Style()

NumberingStyle Aspose::Pdf::Heading::get_Style ( )

Gets style.

◆ get_TocPage()

System::SharedPtr<Aspose::Pdf::Page> Aspose::Pdf::Heading::get_TocPage ( )

Gets the page that contains this heading.

◆ get_Top()

double Aspose::Pdf::Heading::get_Top ( )

Gets the top Y of this headings.

◆ get_UserLabel()

System::SharedPtr<Text::TextSegment> Aspose::Pdf::Heading::get_UserLabel ( )

Gets user label.

◆ GetDashString()

System::String Aspose::Pdf::Heading::GetDashString ( )
protected

◆ Process()

System::SharedPtr<Text::TextParagraph> Aspose::Pdf::Heading::Process ( double  curX,
double &  curY,
System::SharedPtr< Aspose::Pdf::Rectangle rect,
System::SharedPtr< MarginInfo marginInfo,
double  width,
double  realWidth,
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Heading >>>  keptWithNextTocLinks,
System::SharedPtr< Aspose::Pdf::Page page 
)
protected

Process headings for table of contents.

The heading.

The text builder.

◆ Serialize()

virtual void Aspose::Pdf::Heading::Serialize ( System::SharedPtr< System::Xml::XmlTextWriter writer)
protectedvirtual

Reimplemented from Aspose::Pdf::Text::TextFragment.

◆ set_DestinationPage()

void Aspose::Pdf::Heading::set_DestinationPage ( System::SharedPtr< Aspose::Pdf::Page value)

Gets the destination page.

◆ set_IsAutoSequence()

void Aspose::Pdf::Heading::set_IsAutoSequence ( bool  value)

Gets the heading should be numered automatically.

◆ set_IsInList()

void Aspose::Pdf::Heading::set_IsInList ( bool  value)

Gets the heading should be in toc list.

◆ set_Left()

void Aspose::Pdf::Heading::set_Left ( double  value)
protected

Gets the left X of this headings(for internal use).

◆ set_Level()

void Aspose::Pdf::Heading::set_Level ( int32_t  value)

Gets the level.

◆ set_StartNumber()

void Aspose::Pdf::Heading::set_StartNumber ( int32_t  value)

Gets the heading start number.

◆ set_Style()

void Aspose::Pdf::Heading::set_Style ( NumberingStyle  value)

Sets style.

◆ set_TocPage()

void Aspose::Pdf::Heading::set_TocPage ( System::SharedPtr< Aspose::Pdf::Page value)

Gets the page that contains this heading.

◆ set_Top()

void Aspose::Pdf::Heading::set_Top ( double  value)

Gets the top Y of this headings.

◆ set_UserLabel()

void Aspose::Pdf::Heading::set_UserLabel ( System::SharedPtr< Text::TextSegment value)

Sets user label.