Class represents header or footer pdf page. More...

Inherits System::ICloneable.

Public Member Functions

System::SharedPtr< Aspose::Pdf::Paragraphsget_Paragraphs ()
 Gets the end note paragraphs. More...
 
void set_Paragraphs (System::SharedPtr< Aspose::Pdf::Paragraphs > value)
 Sets the end note paragraphs. More...
 
System::SharedPtr< MarginInfoget_Margin ()
 Gets the margin info. More...
 
void set_Margin (System::SharedPtr< MarginInfo > value)
 Sets the margin info. More...
 
System::SharedPtr< System::ObjectClone ()
 Clones a new object. More...
 
 HeaderFooter ()
 
- 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

bool get_IsNoteMoreThanPage ()
 Gets is note more than page. More...
 
void set_IsNoteMoreThanPage (bool value)
 Sets is note more than page. More...
 
double get_FootNoteHeight ()
 Gets footer with footnotes size. More...
 
void set_FootNoteHeight (double value)
 Sets footer with footnotes size. More...
 
double get_EndNoteRightX ()
 Gets end note footer top line rightX. More...
 
void set_EndNoteRightX (double value)
 Sets end note footer top line rightX. More...
 
double get_RightX ()
 Gets footer top line rightX. More...
 
void set_RightX (double value)
 Sets footer top line rightX. More...
 
System::SharedPtr< Aspose::Pdf::Paragraphsget_EndNoteParagraphs ()
 Gets the paragraphs. More...
 
void set_EndNoteParagraphs (System::SharedPtr< Aspose::Pdf::Paragraphs > value)
 Sets the paragraphs. More...
 
System::SharedPtr< Aspose::Pdf::Paragraphsget_FootNoteParagraphs ()
 Gets the paragraphs. More...
 
void set_FootNoteParagraphs (System::SharedPtr< Aspose::Pdf::Paragraphs > value)
 Sets the paragraphs. More...
 
double get_ParagraphsHeight ()
 Gets paragraphs without footnotes height. More...
 
void set_ParagraphsHeight (double value)
 Sets paragraphs without footnotes height. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Rectangle > > > get_Rectangles ()
 Gets the rectangles for links for notes. More...
 
void set_Rectangles (System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Rectangle >>> value)
 Sets the rectangles for links for notes. More...
 
System::SharedPtr< PageGenerator > get_Generator ()
 Gets page generator. More...
 
void set_Generator (System::SharedPtr< PageGenerator > value)
 Sets page generator. More...
 
System::SharedPtr< Aspose::Pdf::ParagraphsGetAllParagraphs (bool isFootNote)
 Gets all paragraphs. More...
 
System::SharedPtr< System::ObjectGetObjectById (System::String id)
 Gets a object with specified ID in the document. More...
 
void Serialize (System::SharedPtr< System::Xml::XmlTextWriter > writer)
 
void Deserialize (System::SharedPtr< System::Xml::XmlReader > reader)
 

Static Protected Member Functions

static System::SharedPtr< MarginInfoget_DefaultMargin ()
 

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...
 

Detailed Description

Class represents header or footer pdf page.

Constructor & Destructor Documentation

◆ HeaderFooter()

Aspose::Pdf::HeaderFooter::HeaderFooter ( )

Member Function Documentation

◆ Clone()

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

Clones a new object.

Returns
The new object.

Implements System::ICloneable.

◆ Deserialize()

void Aspose::Pdf::HeaderFooter::Deserialize ( System::SharedPtr< System::Xml::XmlReader reader)
protected

◆ get_DefaultMargin()

static System::SharedPtr<MarginInfo> Aspose::Pdf::HeaderFooter::get_DefaultMargin ( )
staticprotected

◆ get_EndNoteParagraphs()

System::SharedPtr<Aspose::Pdf::Paragraphs> Aspose::Pdf::HeaderFooter::get_EndNoteParagraphs ( )
protected

Gets the paragraphs.

◆ get_EndNoteRightX()

double Aspose::Pdf::HeaderFooter::get_EndNoteRightX ( )
protected

Gets end note footer top line rightX.

◆ get_FootNoteHeight()

double Aspose::Pdf::HeaderFooter::get_FootNoteHeight ( )
protected

Gets footer with footnotes size.

◆ get_FootNoteParagraphs()

System::SharedPtr<Aspose::Pdf::Paragraphs> Aspose::Pdf::HeaderFooter::get_FootNoteParagraphs ( )
protected

Gets the paragraphs.

◆ get_Generator()

System::SharedPtr<PageGenerator> Aspose::Pdf::HeaderFooter::get_Generator ( )
protected

Gets page generator.

◆ get_IsNoteMoreThanPage()

bool Aspose::Pdf::HeaderFooter::get_IsNoteMoreThanPage ( )
protected

Gets is note more than page.

◆ get_Margin()

System::SharedPtr<MarginInfo> Aspose::Pdf::HeaderFooter::get_Margin ( )

Gets the margin info.

◆ get_Paragraphs()

System::SharedPtr<Aspose::Pdf::Paragraphs> Aspose::Pdf::HeaderFooter::get_Paragraphs ( )

Gets the end note paragraphs.

◆ get_ParagraphsHeight()

double Aspose::Pdf::HeaderFooter::get_ParagraphsHeight ( )
protected

Gets paragraphs without footnotes height.

◆ get_Rectangles()

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Rectangle> > > Aspose::Pdf::HeaderFooter::get_Rectangles ( )
protected

Gets the rectangles for links for notes.

◆ get_RightX()

double Aspose::Pdf::HeaderFooter::get_RightX ( )
protected

Gets footer top line rightX.

◆ GetAllParagraphs()

System::SharedPtr<Aspose::Pdf::Paragraphs> Aspose::Pdf::HeaderFooter::GetAllParagraphs ( bool  isFootNote)
protected

Gets all paragraphs.

◆ GetObjectById()

System::SharedPtr<System::Object> Aspose::Pdf::HeaderFooter::GetObjectById ( System::String  id)
protected

Gets a object with specified ID in the document.

Parameters
idThe object id.
Returns
The object with specified id. Null if the id is not found.

◆ Serialize()

void Aspose::Pdf::HeaderFooter::Serialize ( System::SharedPtr< System::Xml::XmlTextWriter writer)
protected

◆ set_EndNoteParagraphs()

void Aspose::Pdf::HeaderFooter::set_EndNoteParagraphs ( System::SharedPtr< Aspose::Pdf::Paragraphs value)
protected

Sets the paragraphs.

◆ set_EndNoteRightX()

void Aspose::Pdf::HeaderFooter::set_EndNoteRightX ( double  value)
protected

Sets end note footer top line rightX.

◆ set_FootNoteHeight()

void Aspose::Pdf::HeaderFooter::set_FootNoteHeight ( double  value)
protected

Sets footer with footnotes size.

◆ set_FootNoteParagraphs()

void Aspose::Pdf::HeaderFooter::set_FootNoteParagraphs ( System::SharedPtr< Aspose::Pdf::Paragraphs value)
protected

Sets the paragraphs.

◆ set_Generator()

void Aspose::Pdf::HeaderFooter::set_Generator ( System::SharedPtr< PageGenerator >  value)
protected

Sets page generator.

◆ set_IsNoteMoreThanPage()

void Aspose::Pdf::HeaderFooter::set_IsNoteMoreThanPage ( bool  value)
protected

Sets is note more than page.

◆ set_Margin()

void Aspose::Pdf::HeaderFooter::set_Margin ( System::SharedPtr< MarginInfo value)

Sets the margin info.

◆ set_Paragraphs()

void Aspose::Pdf::HeaderFooter::set_Paragraphs ( System::SharedPtr< Aspose::Pdf::Paragraphs value)

Sets the end note paragraphs.

◆ set_ParagraphsHeight()

void Aspose::Pdf::HeaderFooter::set_ParagraphsHeight ( double  value)
protected

Sets paragraphs without footnotes height.

◆ set_Rectangles()

void Aspose::Pdf::HeaderFooter::set_Rectangles ( System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Rectangle >>>  value)
protected

Sets the rectangles for links for notes.

◆ set_RightX()

void Aspose::Pdf::HeaderFooter::set_RightX ( double  value)
protected

Sets footer top line rightX.