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

#include "StructureElement.h"

Inherits Aspose::Pdf::LogicalStructure::Element.

Inherited by Aspose::Pdf::LogicalStructure::BLSElement, Aspose::Pdf::LogicalStructure::GroupingElement, Aspose::Pdf::LogicalStructure::IllustrationElement, Aspose::Pdf::LogicalStructure::ILSElement, Aspose::Pdf::LogicalStructure::ListChildElement, Aspose::Pdf::LogicalStructure::RubyChildElement, Aspose::Pdf::LogicalStructure::TableChildElement, and Aspose::Pdf::LogicalStructure::WarichuChildElement.

Public Member Functions
ASPOSE_PDF_SHARED_API System::SharedPtr< AttributeOwnerStandard >	get_DefaultAttributeOwner () const
	Gets T:/Aspose::Pdf::LogicalStructure::AttributeOwnerStandard object. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< StructureAttributeCollection >	get_Attributes () const
	Gets T:/Aspose::Pdf::LogicalStructure::StructureAttributeCollection object. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< StructureTypeStandard >	get_StructureType () const
	Gets type of structure element. More...

ASPOSE_PDF_SHARED_API System::String	get_ID ()
	Gets the ID for structure element. More...

ASPOSE_PDF_SHARED_API System::String	get_Title ()
	Gets the title for structure element. More...

ASPOSE_PDF_SHARED_API void	set_Title (System::String value)
	Sets the title for structure element. More...

ASPOSE_PDF_SHARED_API System::String	get_Language ()
	Gets the language for structure element. More...

ASPOSE_PDF_SHARED_API void	set_Language (System::String value)
	Sets the language for structure element. More...

ASPOSE_PDF_SHARED_API System::String	get_AlternativeText ()
	Gets the alternative text for structure element. More...

ASPOSE_PDF_SHARED_API void	set_AlternativeText (System::String value)
	Sets the alternative text for structure element. More...

ASPOSE_PDF_SHARED_API System::String	get_ExpansionText ()
	Gets the expansion text for structure element. More...

ASPOSE_PDF_SHARED_API void	set_ExpansionText (System::String value)
	Sets the expansion text for structure element. More...

ASPOSE_PDF_SHARED_API System::String	get_ActualText ()
	Gets the actual text for structure element. More...

ASPOSE_PDF_SHARED_API void	set_ActualText (System::String value)
	Sets the actual text for structure element. More...

ASPOSE_PDF_SHARED_API void	ChangeParentElement (System::SharedPtr< StructureElement > newParentElement)
	Change parent element for current structure element More...

ASPOSE_PDF_SHARED_API void	GenerateId ()
	Generate ID for structure element. More...

ASPOSE_PDF_SHARED_API void	SetId (System::String id)
	Sets ID for structure element. More...

ASPOSE_PDF_SHARED_API void	ClearId ()
	Clear ID for structure element. More...

ASPOSE_PDF_SHARED_API void	SetTag (System::String newTag)
	Sets custom tag for structure element. More...

ASPOSE_PDF_SHARED_API System::String	ToString () const override
	Returns a string that represents the current object. More...

Public Member Functions inherited from Aspose::Pdf::LogicalStructure::Element
ASPOSE_PDF_SHARED_API System::SharedPtr< Element >	get_ParentElement () const
	Get parent element. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< ElementList >	get_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< Element >	AppendChild (System::SharedPtr< Element > element)
	Append T:/Aspose::Pdf::LogicalStructure::Element to collection of children. 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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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< Aspose::Pdf::Engine::Data::IPdfName >	get_S ()

void	set_S (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfName > value)

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	get_Pg ()

void	set_Pg (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > value)

	StructureElement (System::SharedPtr< Aspose::Pdf::Tagged::TaggedContext > taggedContext, System::SharedPtr< StructureTypeStandard > structureType, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > pdfEngineEntity, System::SharedPtr< AttributeOwnerStandard > attributeOwner=nullptr)

ASPOSE_PDF_SHARED_API void	SetParentElement (System::SharedPtr< Element > parentElement) override

ASPOSE_PDF_SHARED_API bool	CanBeAppended (System::SharedPtr< Element > element) override

virtual ASPOSE_PDF_SHARED_API	~StructureElement ()

Protected Member Functions inherited from Aspose::Pdf::LogicalStructure::Element
System::SharedPtr< ElementPdfEngine >	get_ElementEngine () const

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

System::SharedPtr< Aspose::Pdf::Tagged::ITaggedContent >	get_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	~Element ()

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	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 TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

Detailed Description

Represents a base class for structure elements in logical structure.

Constructor & Destructor Documentation

◆ StructureElement()

Aspose::Pdf::LogicalStructure::StructureElement::StructureElement	(	System::SharedPtr< Aspose::Pdf::Tagged::TaggedContext >	taggedContext,
		System::SharedPtr< StructureTypeStandard >	structureType,
		System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive >	pdfEngineEntity,
		System::SharedPtr< AttributeOwnerStandard >	attributeOwner = `nullptr`
	)

protected

◆ ~StructureElement()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::LogicalStructure::StructureElement::~StructureElement ( )

protectedvirtual

Member Function Documentation

◆ CanBeAppended()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::LogicalStructure::StructureElement::CanBeAppended ( System::SharedPtr< Element > element )

overrideprotectedvirtual

Implements Aspose::Pdf::LogicalStructure::Element.

◆ ChangeParentElement()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureElement::ChangeParentElement ( System::SharedPtr< StructureElement > newParentElement )

Change parent element for current structure element

Parameters

newParentElement New parent structure element

◆ ClearId()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureElement::ClearId ( )

Clear ID for structure element.

◆ GenerateId()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureElement::GenerateId ( )

Generate ID for structure element.

◆ get_ActualText()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::LogicalStructure::StructureElement::get_ActualText ( )

Gets the actual text for structure element.

Actual text of the structure element.

◆ get_AlternativeText()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::LogicalStructure::StructureElement::get_AlternativeText ( )

Gets the alternative text for structure element.

Alternative text of the structure element.

◆ get_Attributes()

ASPOSE_PDF_SHARED_API System::SharedPtr<StructureAttributeCollection> Aspose::Pdf::LogicalStructure::StructureElement::get_Attributes ( ) const

Gets T:/Aspose::Pdf::LogicalStructure::StructureAttributeCollection object.

T:/Aspose::Pdf::LogicalStructure::StructureAttributeCollection object.

◆ get_DefaultAttributeOwner()

ASPOSE_PDF_SHARED_API System::SharedPtr<AttributeOwnerStandard> Aspose::Pdf::LogicalStructure::StructureElement::get_DefaultAttributeOwner ( ) const

Gets T:/Aspose::Pdf::LogicalStructure::AttributeOwnerStandard object.

T:/Aspose::Pdf::LogicalStructure::AttributeOwnerStandard object.

◆ get_ExpansionText()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::LogicalStructure::StructureElement::get_ExpansionText ( )

Gets the expansion text for structure element.

Expansion text of the structure element.

◆ get_ID()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::LogicalStructure::StructureElement::get_ID ( )

Gets the ID for structure element.

ID of the structure element.

◆ get_Language()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::LogicalStructure::StructureElement::get_Language ( )

Gets the language for structure element.

Language of the structure element.

◆ get_Pg()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::LogicalStructure::StructureElement::get_Pg ( )

protected

◆ get_S()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfName> Aspose::Pdf::LogicalStructure::StructureElement::get_S ( )

protected

◆ get_StructureType()

ASPOSE_PDF_SHARED_API System::SharedPtr<StructureTypeStandard> Aspose::Pdf::LogicalStructure::StructureElement::get_StructureType ( ) const

Gets type of structure element.

T:/Aspose::Pdf::LogicalStructure::StructureTypeStandard object of structure element.

◆ get_Title()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::LogicalStructure::StructureElement::get_Title ( )

Gets the title for structure element.

Title of the structure element.

◆ set_ActualText()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureElement::set_ActualText ( System::String value )

Sets the actual text for structure element.

Actual text of the structure element.

◆ set_AlternativeText()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureElement::set_AlternativeText ( System::String value )

Sets the alternative text for structure element.

Alternative text of the structure element.

◆ set_ExpansionText()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureElement::set_ExpansionText ( System::String value )

Sets the expansion text for structure element.

Expansion text of the structure element.

◆ set_Language()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureElement::set_Language ( System::String value )

Sets the language for structure element.

Language of the structure element.

◆ set_Pg()

void Aspose::Pdf::LogicalStructure::StructureElement::set_Pg ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > value )

protected

◆ set_S()

void Aspose::Pdf::LogicalStructure::StructureElement::set_S ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfName > value )

protected

◆ set_Title()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureElement::set_Title ( System::String value )

Sets the title for structure element.

Title of the structure element.

◆ SetId()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureElement::SetId ( System::String id )

Sets ID for structure element.

Parameters

id	ID value for structure element

◆ SetParentElement()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureElement::SetParentElement ( System::SharedPtr< Element > parentElement )

overrideprotectedvirtual

Reimplemented from Aspose::Pdf::LogicalStructure::Element.

◆ SetTag()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureElement::SetTag ( System::String newTag )

Sets custom tag for structure element.

Parameters

newTag Tag name

◆ ToString()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::LogicalStructure::StructureElement::ToString ( ) const

overridevirtual

Returns a string that represents the current object.

Returns: String that represents the current object.

Reimplemented from Aspose::Pdf::LogicalStructure::Element.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StructureElement()

◆ ~StructureElement()

Member Function Documentation

◆ CanBeAppended()

◆ ChangeParentElement()

◆ ClearId()

◆ GenerateId()

◆ get_ActualText()

◆ get_AlternativeText()

◆ get_Attributes()

◆ get_DefaultAttributeOwner()

◆ get_ExpansionText()

◆ get_ID()

◆ get_Language()

◆ get_Pg()

◆ get_S()

◆ get_StructureType()

◆ get_Title()

◆ set_ActualText()

◆ set_AlternativeText()

◆ set_ExpansionText()

◆ set_Language()

◆ set_Pg()

◆ set_S()

◆ set_Title()

◆ SetId()

◆ SetParentElement()

◆ SetTag()

◆ ToString()