Aspose::Pdf::Text::PageMarkup Class Referencefinal

Page markup represented by collections of MarkupSection and MarkupParagraph. More...

#include "PageMarkup.h"

Inherits System::Object.

Public Member Functions

ASPOSE_PDF_SHARED_API int32_t get_Number () const
 Gets processed page number. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Rectangleget_Rectangle () const
 Gets processed page rectangle. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< MarkupSection > > > get_Sections () const
 Gets collection of MarkupSection that was found on the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< MarkupParagraph > > > get_Paragraphs () const
 Gets collection of MarkupParagraph that was found on the page. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< TextFragment > > > get_TextFragments () const
 Gets collection of TextFragment that was found on the page. More...
 
ASPOSE_PDF_SHARED_API bool get_IsMulticolumnParagraphsAllowed () const
 Gets value that indicates whether starting text lines of a next section may be treated as continuation of the last paragraph of a previous section. More...
 
ASPOSE_PDF_SHARED_API void set_IsMulticolumnParagraphsAllowed (bool value)
 Sets value that indicates whether starting text lines of a next section may be treated as continuation of the last paragraph of a previous section. More...
 
- 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

ASPOSE_PDF_SHARED_API void set_Sections (System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< MarkupSection >>> value)
 Gets collection of MarkupSection that was found on the page. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< MarkupParagraph > > > get_StartlessParagraphs () const
 Gets collection of MarkupParagraph that was found on the page. More...
 
System::ArrayPtr< std::vector< uint8_t > > get_Grid () const
 
 PageMarkup ()
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (PageMarkup, CODEPORTING_ARGS())
 
void Attach (System::SharedPtr< Page > page)
 Initializes this PageMarkup with page object. More...
 
void DistributeFragmentsForSections ()
 Distributes page (markup) text fragments for sections. More...
 
double GetAverageFontSize ()
 Calculates average fontsize of text on the markup. More...
 
void ToCrossSectionParagraphs (System::SharedPtr< PageMarkup > previousePageMarkup)
 Rebuilds paragraphs using 'cross-section' rule More...
 
void ToIsolatedSectionParagraphs (System::SharedPtr< PageMarkup > previousePageMarkup)
 Rebuilds paragraphs using 'isolated section' rule More...
 
virtual ASPOSE_PDF_SHARED_API ~PageMarkup ()
 

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

Page markup represented by collections of MarkupSection and MarkupParagraph.

Constructor & Destructor Documentation

◆ PageMarkup()

Aspose::Pdf::Text::PageMarkup::PageMarkup ( )
protected

◆ ~PageMarkup()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::PageMarkup::~PageMarkup ( )
protectedvirtual

Member Function Documentation

◆ Attach()

void Aspose::Pdf::Text::PageMarkup::Attach ( System::SharedPtr< Page page)
protected

Initializes this PageMarkup with page object.

Parameters
pagePage object

◆ DistributeFragmentsForSections()

void Aspose::Pdf::Text::PageMarkup::DistributeFragmentsForSections ( )
protected

Distributes page (markup) text fragments for sections.

◆ get_Grid()

System::ArrayPtr<std::vector<uint8_t> > Aspose::Pdf::Text::PageMarkup::get_Grid ( ) const
protected

◆ get_IsMulticolumnParagraphsAllowed()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Text::PageMarkup::get_IsMulticolumnParagraphsAllowed ( ) const

Gets value that indicates whether starting text lines of a next section may be treated as continuation of the last paragraph of a previous section.

◆ get_Number()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Text::PageMarkup::get_Number ( ) const

Gets processed page number.

◆ get_Paragraphs()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<MarkupParagraph> > > Aspose::Pdf::Text::PageMarkup::get_Paragraphs ( ) const

Gets collection of MarkupParagraph that was found on the page.

◆ get_Rectangle()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Text::PageMarkup::get_Rectangle ( ) const

Gets processed page rectangle.

◆ get_Sections()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<MarkupSection> > > Aspose::Pdf::Text::PageMarkup::get_Sections ( ) const

Gets collection of MarkupSection that was found on the page.

◆ get_StartlessParagraphs()

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<MarkupParagraph> > > Aspose::Pdf::Text::PageMarkup::get_StartlessParagraphs ( ) const
protected

Gets collection of MarkupParagraph that was found on the page.

◆ get_TextFragments()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<TextFragment> > > Aspose::Pdf::Text::PageMarkup::get_TextFragments ( ) const

Gets collection of TextFragment that was found on the page.

The TextFragment object provides access to the search occurrence text, text properties, and allows to edit text and change the text state (font, font size, color etc).

◆ GetAverageFontSize()

double Aspose::Pdf::Text::PageMarkup::GetAverageFontSize ( )
protected

Calculates average fontsize of text on the markup.

Returns
Average size of font

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::Text::PageMarkup::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( PageMarkup  ,
CODEPORTING_ARGS()   
)
protected

◆ set_IsMulticolumnParagraphsAllowed()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::PageMarkup::set_IsMulticolumnParagraphsAllowed ( bool  value)

Sets value that indicates whether starting text lines of a next section may be treated as continuation of the last paragraph of a previous section.

◆ set_Sections()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::PageMarkup::set_Sections ( System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< MarkupSection >>>  value)
protected

Gets collection of MarkupSection that was found on the page.

◆ ToCrossSectionParagraphs()

void Aspose::Pdf::Text::PageMarkup::ToCrossSectionParagraphs ( System::SharedPtr< PageMarkup previousePageMarkup)
protected

Rebuilds paragraphs using 'cross-section' rule

◆ ToIsolatedSectionParagraphs()

void Aspose::Pdf::Text::PageMarkup::ToIsolatedSectionParagraphs ( System::SharedPtr< PageMarkup previousePageMarkup)
protected

Rebuilds paragraphs using 'isolated section' rule