Aspose::Pdf::Text::TableAbsorber Class Reference

Represents an absorber object of table elements. Performs search and provides access to search results via TableAbsorber::TableList collection. More...

Inherits System::Object.

Public Member Functions

virtual System::SharedPtr< Aspose::Pdf::Text::TextSearchOptionsget_TextSearchOptions ()
 Gets text search options. More...
 
virtual void set_TextSearchOptions (System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions > value)
 Sets text search options. More...
 
virtual System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< AbsorbedTable > > > get_TableList ()
 Returns readonly IList containing tables that were found More...
 
 TableAbsorber (System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions > textSearchOptions)
 Initializes a new instance of the TableAbsorber with text search options. More...
 
 TableAbsorber ()
 Initializes a new instance of the TableAbsorber. More...
 
virtual void Visit (System::SharedPtr< Page > page)
 Extracts tables on the specified page More...
 
void Remove (System::SharedPtr< AbsorbedTable > table)
 Removes an AbsorbedTable from the page. More...
 
void Replace (System::SharedPtr< Page > page, System::SharedPtr< AbsorbedTable > oldTable, System::SharedPtr< Table > newTable)
 Replaces an AbsorbedTable with Table on the page. 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 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 () 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

System::ArrayPtr< System::SharedPtr< Rectangle > > GetCellsToRectArray (System::SharedPtr< Page > page)
 Gets reactangles array representing table cells found on the page. Internal usage of TableAbsorber for TextPostReplaceFixer (PDFNET-45252). 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...
 

Detailed Description

Represents an absorber object of table elements. Performs search and provides access to search results via TableAbsorber::TableList collection.

The example demonstrates how to find table on the first PDF document page and replace the text in a table cell.

// Open document
Document doc = new Document(@"D:\Tests\input.pdf");
// Create TableAbsorber object to find tables
TableAbsorber absorber = new TableAbsorber();
// Visit first page with absorber
absorber.Visit(pdfDocument.Pages[1]);
// Get access to first table on page, their first cell and text fragments in it
TextFragment fragment = absorber.TableList[0].RowList[0].CellList[0].TextFragments[1];
// Change text of the first text fragment in the cell
fragment.Text = "hi world";
// Save document
doc.Save(@"D:\Tests\output.pdf");

Constructor & Destructor Documentation

◆ TableAbsorber() [1/2]

Aspose::Pdf::Text::TableAbsorber::TableAbsorber ( System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions textSearchOptions)

Initializes a new instance of the TableAbsorber with text search options.

Performs searching for tables and provides access to the tables via TableList object.

Parameters
textSearchOptionsText search options

◆ TableAbsorber() [2/2]

Aspose::Pdf::Text::TableAbsorber::TableAbsorber ( )

Initializes a new instance of the TableAbsorber.

Performs searching for tables and provides access to the tables via TableList object.

Member Function Documentation

◆ get_TableList()

virtual System::SharedPtr<System::Collections::Generic::IList<System::SharedPtr<AbsorbedTable> > > Aspose::Pdf::Text::TableAbsorber::get_TableList ( )
virtual

Returns readonly IList containing tables that were found

◆ get_TextSearchOptions()

virtual System::SharedPtr<Aspose::Pdf::Text::TextSearchOptions> Aspose::Pdf::Text::TableAbsorber::get_TextSearchOptions ( )
virtual

Gets text search options.

Allows to define several options that will be used during search text containing in tables.

◆ GetCellsToRectArray()

System::ArrayPtr<System::SharedPtr<Rectangle> > Aspose::Pdf::Text::TableAbsorber::GetCellsToRectArray ( System::SharedPtr< Page page)
protected

Gets reactangles array representing table cells found on the page. Internal usage of TableAbsorber for TextPostReplaceFixer (PDFNET-45252).

Parameters
pagePdf pocument page object.
Returns
Array of reactangles representing table cells.

◆ Remove()

void Aspose::Pdf::Text::TableAbsorber::Remove ( System::SharedPtr< AbsorbedTable table)

Removes an AbsorbedTable from the page.

Parameters
tableAbsorbedTable to remove.

Please take into account it changes TableList collection. In case removing/replacing tables in loop please use copy of TableList collection.

◆ Replace()

void Aspose::Pdf::Text::TableAbsorber::Replace ( System::SharedPtr< Page page,
System::SharedPtr< AbsorbedTable oldTable,
System::SharedPtr< Table newTable 
)

Replaces an AbsorbedTable with Table on the page.

Parameters
pagePdf pocument page object.
oldTableAbsorbedTable to be replaced.
newTableTable to replace old table.

Please take into account it changes TableList collection. In case removing/replacing tables in loop please use copy of TableList collection.

◆ set_TextSearchOptions()

virtual void Aspose::Pdf::Text::TableAbsorber::set_TextSearchOptions ( System::SharedPtr< Aspose::Pdf::Text::TextSearchOptions value)
virtual

Sets text search options.

Allows to define several options that will be used during search text containing in tables.

◆ Visit()

virtual void Aspose::Pdf::Text::TableAbsorber::Visit ( System::SharedPtr< Page page)
virtual

Extracts tables on the specified page

The example demonstrates how to extract table on the first PDF document page.

// Open document
Document doc = new Document(@"D:\Tests\input.pdf");
// Create TableAbsorber object to find tables
TableAbsorber absorber = new TableAbsorber();
// Visit first page with absorber
absorber.Visit(pdfDocument.Pages[1]);
// Get access to first table on page, their first cell and text fragments in it
TextFragment fragment = absorber.TableList[0].RowList[0].CellList[0].TextFragments[1];
// Change text of the first text fragment in the cell
fragment.Text = "hi world";
// Save document
doc.Save(@"D:\Tests\output.pdf");
Parameters
pagePdf pocument page object.