Aspose::Pdf::Structure::Element Class Reference

Class representing base element of logical structure. More...

#include "Element.h"

Inherits System::Object.

Inherited by Aspose::Pdf::Structure::FigureElement, Aspose::Pdf::Structure::RootElement, Aspose::Pdf::Structure::StructElement, and Aspose::Pdf::Structure::TextElement.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< ElementCollectionget_Children ()
 Gets child elements collection. More...
 
virtual ASPOSE_PDF_SHARED_API System::String get_Lang ()
 (Optional; PDF 1.4) A language specifying the natural language for all text in the structure element except where overridden by language specifications for nested structure elements or marked content. More...
 
virtual ASPOSE_PDF_SHARED_API void set_Lang (System::String value)
 (Optional; PDF 1.4) A language specifying the natural language for all text in the structure element except where overridden by language specifications for nested structure elements or marked content. More...
 
virtual ASPOSE_PDF_SHARED_API System::String get_ActualText ()
 (Optional; PDF 1.4) Text that is an exact replacement for the structure element and its children. This replacement text (which should apply to as small a piece of content as possible) is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes. More...
 
virtual ASPOSE_PDF_SHARED_API void set_ActualText (System::String value)
 (Optional; PDF 1.4) Text that is an exact replacement for the structure element and its children. This replacement text (which should apply to as small a piece of content as possible) is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes. More...
 
virtual ASPOSE_PDF_SHARED_API System::String get_Alt ()
 (Optional) An alternate description of the structure element and its children in human-readableform, which is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes. More...
 
virtual ASPOSE_PDF_SHARED_API void set_Alt (System::String value)
 (Optional) An alternate description of the structure element and its children in human-readableform, which is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes. More...
 
virtual ASPOSE_PDF_SHARED_API System::String get_E ()
 (Optional; PDF 1.5) The expanded form of an abbreviation. More...
 
virtual ASPOSE_PDF_SHARED_API void set_E (System::String value)
 (Optional; PDF 1.5) The expanded form of an abbreviation. More...
 
ASPOSE_PDF_SHARED_API void Remove ()
 Remove element. 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

System::String get_Type ()
 
void set_Type (System::String value)
 
System::String get_StructureType ()
 
System::SharedPtr< Elementget_Parent () const
 
System::SharedPtr< Aspose::Pdf::Collections::AsposeHashDictionary< System::String, System::String > > get_Attributes ()
 
 Element (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > engineDict, System::SharedPtr< Element > parent)
 Ctor. More...
 
 Element (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > obj, System::SharedPtr< Element > parent)
 
virtual ASPOSE_PDF_SHARED_API ~Element ()
 

Protected Attributes

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > EngineDict
 
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > PdfObject
 

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

Class representing base element of logical structure.

Constructor & Destructor Documentation

◆ Element() [1/2]

Aspose::Pdf::Structure::Element::Element ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >  engineDict,
System::SharedPtr< Element parent 
)
protected

Ctor.

Parameters
engineDictEngine dictionary.
parentParent element.

◆ Element() [2/2]

Aspose::Pdf::Structure::Element::Element ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >  obj,
System::SharedPtr< Element parent 
)
protected

◆ ~Element()

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

Member Function Documentation

◆ get_ActualText()

virtual ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Structure::Element::get_ActualText ( )
virtual

(Optional; PDF 1.4) Text that is an exact replacement for the structure element and its children. This replacement text (which should apply to as small a piece of content as possible) is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes.

◆ get_Alt()

virtual ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Structure::Element::get_Alt ( )
virtual

(Optional) An alternate description of the structure element and its children in human-readableform, which is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes.

◆ get_Attributes()

System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::String> > Aspose::Pdf::Structure::Element::get_Attributes ( )
protected

◆ get_Children()

ASPOSE_PDF_SHARED_API System::SharedPtr<ElementCollection> Aspose::Pdf::Structure::Element::get_Children ( )

Gets child elements collection.

◆ get_E()

virtual ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Structure::Element::get_E ( )
virtual

(Optional; PDF 1.5) The expanded form of an abbreviation.

◆ get_Lang()

virtual ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Structure::Element::get_Lang ( )
virtual

(Optional; PDF 1.4) A language specifying the natural language for all text in the structure element except where overridden by language specifications for nested structure elements or marked content.

◆ get_Parent()

System::SharedPtr<Element> Aspose::Pdf::Structure::Element::get_Parent ( ) const
protected

◆ get_StructureType()

System::String Aspose::Pdf::Structure::Element::get_StructureType ( )
protected

◆ get_Type()

System::String Aspose::Pdf::Structure::Element::get_Type ( )
protected

◆ Remove()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Structure::Element::Remove ( )

Remove element.

◆ set_ActualText()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Structure::Element::set_ActualText ( System::String  value)
virtual

(Optional; PDF 1.4) Text that is an exact replacement for the structure element and its children. This replacement text (which should apply to as small a piece of content as possible) is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes.

◆ set_Alt()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Structure::Element::set_Alt ( System::String  value)
virtual

(Optional) An alternate description of the structure element and its children in human-readableform, which is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes.

◆ set_E()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Structure::Element::set_E ( System::String  value)
virtual

(Optional; PDF 1.5) The expanded form of an abbreviation.

◆ set_Lang()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Structure::Element::set_Lang ( System::String  value)
virtual

(Optional; PDF 1.4) A language specifying the natural language for all text in the structure element except where overridden by language specifications for nested structure elements or marked content.

◆ set_Type()

void Aspose::Pdf::Structure::Element::set_Type ( System::String  value)
protected

Member Data Documentation

◆ EngineDict

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> Aspose::Pdf::Structure::Element::EngineDict
protected

◆ PdfObject

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::Structure::Element::PdfObject
protected