Represents a abstract base object can be added to the page(doc.Paragraphs.Add()). More...

#include "BaseParagraph.h"

Inherits System::ICloneable.

Inherited by Aspose::Pdf::Annotations::Annotation, Aspose::Pdf::Drawing::Graph, Aspose::Pdf::FloatingBox, Aspose::Pdf::FormattedFragment, Aspose::Pdf::Image, Aspose::Pdf::Table, and Aspose::Pdf::Text::TextFragment.

Public Member Functions

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::VerticalAlignment get_VerticalAlignment ()
 Gets a vertical alignment of paragraph More...
 
virtual ASPOSE_PDF_SHARED_API void set_VerticalAlignment (Aspose::Pdf::VerticalAlignment value)
 Sets a vertical alignment of paragraph More...
 
virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::HorizontalAlignment get_HorizontalAlignment ()
 Gets a horizontal alignment of paragraph More...
 
virtual ASPOSE_PDF_SHARED_API void set_HorizontalAlignment (Aspose::Pdf::HorizontalAlignment value)
 Sets a horizontal alignment of paragraph More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< MarginInfoget_Margin ()
 Gets a outer margin for paragraph (for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_Margin (System::SharedPtr< MarginInfo > value)
 Sets a outer margin for paragraph (for pdf generation) More...
 
ASPOSE_PDF_SHARED_API bool get_IsFirstParagraphInColumn () const
 Gets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API bool get_IsKeptWithNext () const
 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...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API bool get_IsInNewPage () const
 Gets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_IsInNewPage (bool value)
 Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API bool get_IsInLineParagraph () const
 Gets a paragraph is inline. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_IsInLineParagraph (bool value)
 Sets a paragraph is inline. Default is false.(for pdf generation) More...
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Hyperlinkget_Hyperlink ()
 Gets the fragment hyperlink(for pdf generator). More...
 
virtual ASPOSE_PDF_SHARED_API void set_Hyperlink (System::SharedPtr< Aspose::Pdf::Hyperlink > value)
 Sets the fragment hyperlink(for pdf generator). More...
 
ASPOSE_PDF_SHARED_API int32_t get_ZIndex () const
 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...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::ObjectClone () override
 Clones this instance. Virtual method. Always return null. More...
 
ASPOSE_PDF_SHARED_API 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 reference 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 int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

System::String get_Id () const
 Gets a paragraph id. More...
 
void set_Id (System::String value)
 Sets a paragraph id. More...
 
const System::SharedPtr< Annotations::LinkAnnotation > & get_ReferencedFrom () const
 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)
 
virtual ASPOSE_PDF_SHARED_API void Serialize (System::SharedPtr< System::Xml::XmlTextWriter > writer)
 
virtual ASPOSE_PDF_SHARED_API void Deserialize (System::SharedPtr< System::Xml::XmlReader > reader)
 

Static Protected Member Functions

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...
 
- 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 ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Represents a abstract base object can be added to the page(doc.Paragraphs.Add()).

Constructor & Destructor Documentation

◆ BaseParagraph()

ASPOSE_PDF_SHARED_API Aspose::Pdf::BaseParagraph::BaseParagraph ( )

Member Function Documentation

◆ ChangePosition()

void Aspose::Pdf::BaseParagraph::ChangePosition ( double &  curX,
double &  curY,
double  newX,
double  newY,
bool  isNextParagraphInline 
)
protected

◆ Clone()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Object> Aspose::Pdf::BaseParagraph::Clone ( )
overridevirtual

◆ Deserialize()

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

◆ get_HorizontalAlignment()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::HorizontalAlignment Aspose::Pdf::BaseParagraph::get_HorizontalAlignment ( )
virtual

Gets a horizontal alignment of paragraph

Reimplemented in Aspose::Pdf::Annotations::Annotation, and Aspose::Pdf::Text::TextFragment.

◆ get_Hyperlink()

virtual ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Hyperlink> Aspose::Pdf::BaseParagraph::get_Hyperlink ( )
virtual

Gets the fragment hyperlink(for pdf generator).

◆ get_Id()

System::String Aspose::Pdf::BaseParagraph::get_Id ( ) const
protected

Gets a paragraph id.

◆ get_IsFirstParagraphInColumn()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::BaseParagraph::get_IsFirstParagraphInColumn ( ) const

Gets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation)

◆ get_IsInLineParagraph()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::BaseParagraph::get_IsInLineParagraph ( ) const

Gets a paragraph is inline. Default is false.(for pdf generation)

◆ get_IsInNewPage()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::BaseParagraph::get_IsInNewPage ( ) const

Gets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation)

◆ get_IsKeptWithNext()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::BaseParagraph::get_IsKeptWithNext ( ) const

Gets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation)

◆ get_IsZIndexSet()

static bool Aspose::Pdf::BaseParagraph::get_IsZIndexSet ( )
staticprotected

Gets the fragment hyperlink(for pdf generator performance internal use).

◆ get_Margin()

ASPOSE_PDF_SHARED_API System::SharedPtr<MarginInfo> Aspose::Pdf::BaseParagraph::get_Margin ( )

Gets a outer margin for paragraph (for pdf generation)

◆ get_ReferencedFrom()

const System::SharedPtr<Annotations::LinkAnnotation>& Aspose::Pdf::BaseParagraph::get_ReferencedFrom ( ) const
protected

Gets the fragment hyperlink(for pdf generator internal use).

◆ get_VerticalAlignment()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::VerticalAlignment Aspose::Pdf::BaseParagraph::get_VerticalAlignment ( )
virtual

Gets a vertical alignment of paragraph

Reimplemented in Aspose::Pdf::Text::TextFragment.

◆ get_ZIndex()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::BaseParagraph::get_ZIndex ( ) const

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.

◆ ProcessHyperlink()

void Aspose::Pdf::BaseParagraph::ProcessHyperlink ( System::SharedPtr< Page page,
System::SharedPtr< Rectangle rect 
)
protected

◆ Serialize()

◆ set_HorizontalAlignment()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::BaseParagraph::set_HorizontalAlignment ( Aspose::Pdf::HorizontalAlignment  value)
virtual

Sets a horizontal alignment of paragraph

Reimplemented in Aspose::Pdf::Annotations::Annotation, and Aspose::Pdf::Text::TextFragment.

◆ set_Hyperlink()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::BaseParagraph::set_Hyperlink ( System::SharedPtr< Aspose::Pdf::Hyperlink value)
virtual

Sets the fragment hyperlink(for pdf generator).

Reimplemented in Aspose::Pdf::Text::TextFragment.

◆ set_Id()

void Aspose::Pdf::BaseParagraph::set_Id ( System::String  value)
protected

Sets a paragraph id.

◆ set_IsFirstParagraphInColumn()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::BaseParagraph::set_IsFirstParagraphInColumn ( bool  value)

Sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation)

◆ set_IsInLineParagraph()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::BaseParagraph::set_IsInLineParagraph ( bool  value)

Sets a paragraph is inline. Default is false.(for pdf generation)

◆ set_IsInNewPage()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::BaseParagraph::set_IsInNewPage ( bool  value)

Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation)

◆ set_IsKeptWithNext()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::BaseParagraph::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)

◆ set_IsZIndexSet()

static void Aspose::Pdf::BaseParagraph::set_IsZIndexSet ( bool  value)
staticprotected

Sets the fragment hyperlink(for pdf generator performance internal use).

◆ set_Margin()

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

Sets a outer margin for paragraph (for pdf generation)

◆ set_ReferencedFrom()

void Aspose::Pdf::BaseParagraph::set_ReferencedFrom ( System::SharedPtr< Annotations::LinkAnnotation value)
protected

Sets the fragment hyperlink(for pdf generator internal use).

◆ set_VerticalAlignment()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::BaseParagraph::set_VerticalAlignment ( Aspose::Pdf::VerticalAlignment  value)
virtual

Sets a vertical alignment of paragraph

Reimplemented in Aspose::Pdf::Text::TextFragment.

◆ set_ZIndex()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::BaseParagraph::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.