Aspose::Pdf::LogicalStructure::Element Class Referenceabstract

Represents a base class for element in logical structure. More...

#include "Element.h"

Inherits System::Object.

Inherited by Aspose::Pdf::LogicalStructure::MCRElement, Aspose::Pdf::LogicalStructure::OBJRElement, Aspose::Pdf::LogicalStructure::StructTreeRootElement, and Aspose::Pdf::LogicalStructure::StructureElement.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< Elementget_ParentElement () const
 Get parent element. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< ElementListget_ChildElements ()
 Gets children collection of T:/Aspose::Pdf::LogicalStructure::Element objects. More...
 
template<typename T >
System::SharedPtr< System::Collections::Generic::List< T > > FindElements (bool recursiveSearch=false)
 Find Elements of a given type More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< ElementAppendChild (System::SharedPtr< Element > element)
 Append T:/Aspose::Pdf::LogicalStructure::Element to collection of children. More...
 
ASPOSE_PDF_SHARED_API System::String ToString () const override
 Returns a string that represents the current object. 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 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::SharedPtr< ElementPdfEngine > get_ElementEngine () const
 
System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable > get_Trailer ()
 
System::SharedPtr< Aspose::Pdf::Tagged::ITaggedContentget_TaggedContent ()
 
 Element (System::SharedPtr< Aspose::Pdf::Tagged::TaggedContext > taggedContext, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfName > pdfObjectType, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > pdfEngineEntity)
 
virtual ASPOSE_PDF_SHARED_API void PreSave ()
 
virtual ASPOSE_PDF_SHARED_API void Save ()
 
virtual ASPOSE_PDF_SHARED_API void SetParentElement (System::SharedPtr< Element > parentElement)
 
virtual bool CanBeAppended (System::SharedPtr< Element > element)=0
 
virtual ASPOSE_PDF_SHARED_API ~Element ()
 

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 base class for element in logical structure.

Constructor & Destructor Documentation

◆ Element()

Aspose::Pdf::LogicalStructure::Element::Element ( System::SharedPtr< Aspose::Pdf::Tagged::TaggedContext >  taggedContext,
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfName >  pdfObjectType,
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive >  pdfEngineEntity 
)
protected

◆ ~Element()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::LogicalStructure::Element::~Element ( )
protectedvirtual

Member Function Documentation

◆ AppendChild()

ASPOSE_PDF_SHARED_API System::SharedPtr<Element> Aspose::Pdf::LogicalStructure::Element::AppendChild ( System::SharedPtr< Element element)

Append T:/Aspose::Pdf::LogicalStructure::Element to collection of children.

Parameters
elementT:/Aspose::Pdf::LogicalStructure::Element object to add.
Returns
T:/Aspose::Pdf::LogicalStructure::Element which has been added.

◆ CanBeAppended()

◆ FindElements()

template<typename T >
System::SharedPtr<System::Collections::Generic::List<T> > Aspose::Pdf::LogicalStructure::Element::FindElements ( bool  recursiveSearch = false)
inline

Find Elements of a given type

Template Parameters
TType of Structure Element for search
Parameters
recursiveSearch(Optional) Recursive Search (default false, search only from direct children)
Returns
List of found Elements

◆ get_ChildElements()

ASPOSE_PDF_SHARED_API System::SharedPtr<ElementList> Aspose::Pdf::LogicalStructure::Element::get_ChildElements ( )

Gets children collection of T:/Aspose::Pdf::LogicalStructure::Element objects.

Children collection of T:/Aspose::Pdf::LogicalStructure::Element objects.

◆ get_ElementEngine()

System::SharedPtr<ElementPdfEngine> Aspose::Pdf::LogicalStructure::Element::get_ElementEngine ( ) const
protected

◆ get_ParentElement()

ASPOSE_PDF_SHARED_API System::SharedPtr<Element> Aspose::Pdf::LogicalStructure::Element::get_ParentElement ( ) const

Get parent element.

Parent element.

◆ get_TaggedContent()

System::SharedPtr<Aspose::Pdf::Tagged::ITaggedContent> Aspose::Pdf::LogicalStructure::Element::get_TaggedContent ( )
protected

◆ get_Trailer()

System::SharedPtr<Aspose::Pdf::Engine::Data::ITrailerable> Aspose::Pdf::LogicalStructure::Element::get_Trailer ( )
protected

◆ PreSave()

◆ Save()

◆ SetParentElement()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::Element::SetParentElement ( System::SharedPtr< Element parentElement)
protectedvirtual

◆ ToString()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::LogicalStructure::Element::ToString ( ) const
overridevirtual

Returns a string that represents the current object.

Returns
String that represents the current object.

Reimplemented from System::Object.

Reimplemented in Aspose::Pdf::LogicalStructure::StructureElement, Aspose::Pdf::LogicalStructure::MCRElement, and Aspose::Pdf::LogicalStructure::OBJRElement.