Aspose::Pdf::LogicalStructure::StructureAttribute Class Reference

Represents attribute of structure element. More...

#include "StructureAttribute.h"

Inherits System::Object.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< AttributeKeyget_Key () const
 Gets attribute key. More...
 
ASPOSE_PDF_SHARED_API bool get_IsInitializedValue ()
 Gets status of structure attribute value. True if value is set. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< AttributeNameGetNameValue ()
 Gets Value Name. More...
 
ASPOSE_PDF_SHARED_API System::String GetStringValue ()
 Gets Value String. More...
 
ASPOSE_PDF_SHARED_API System::Nullable< double > GetNumberValue ()
 Gets Value Number. More...
 
ASPOSE_PDF_SHARED_API System::ArrayPtr< System::SharedPtr< AttributeName > > GetArrayValue ()
 Gets Value Name Array. More...
 
ASPOSE_PDF_SHARED_API System::ArrayPtr< System::Nullable< double > > GetArrayNumberValue ()
 Gets Value Number Array. More...
 
ASPOSE_PDF_SHARED_API void SetNameValue (System::SharedPtr< AttributeName > name)
 Sets Value Name. More...
 
ASPOSE_PDF_SHARED_API void SetStringValue (System::String value)
 Sets Value String. More...
 
ASPOSE_PDF_SHARED_API void SetNumberValue (double number)
 Sets Value Number. More...
 
ASPOSE_PDF_SHARED_API void SetArrayValue (System::ArrayPtr< System::SharedPtr< AttributeName >> array)
 Sets Value Name Array. More...
 
ASPOSE_PDF_SHARED_API void SetArrayNumberValue (System::ArrayPtr< System::Nullable< double >> arrayNumber)
 Sets Value Number Array. More...
 
ASPOSE_PDF_SHARED_API void SetColorValue (System::SharedPtr< Color > color)
 Sets Value Color. More...
 
ASPOSE_PDF_SHARED_API void SetRectangleValue (System::SharedPtr< Rectangle > rectangle)
 Sets Value Rectangle. More...
 
ASPOSE_PDF_SHARED_API StructureAttribute (System::SharedPtr< AttributeKey > attributeKey)
 Initializes a new instance of the StructureAttribute. 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

 StructureAttribute (System::SharedPtr< AttributeKey > attributeKey, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > pdfEntity)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (StructureAttribute, CODEPORTING_ARGS(System::SharedPtr< AttributeKey > attributeKey, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > pdfEntity))
 

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 attribute of structure element.

Constructor & Destructor Documentation

◆ StructureAttribute() [1/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::LogicalStructure::StructureAttribute::StructureAttribute ( System::SharedPtr< AttributeKey attributeKey)

Initializes a new instance of the StructureAttribute.

Parameters
attributeKeyAttribute Key

◆ StructureAttribute() [2/2]

Aspose::Pdf::LogicalStructure::StructureAttribute::StructureAttribute ( System::SharedPtr< AttributeKey attributeKey,
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive >  pdfEntity 
)
protected

Member Function Documentation

◆ get_IsInitializedValue()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::LogicalStructure::StructureAttribute::get_IsInitializedValue ( )

Gets status of structure attribute value. True if value is set.

◆ get_Key()

ASPOSE_PDF_SHARED_API System::SharedPtr<AttributeKey> Aspose::Pdf::LogicalStructure::StructureAttribute::get_Key ( ) const

Gets attribute key.

Attribute Key.

◆ GetArrayNumberValue()

ASPOSE_PDF_SHARED_API System::ArrayPtr<System::Nullable<double> > Aspose::Pdf::LogicalStructure::StructureAttribute::GetArrayNumberValue ( )

Gets Value Number Array.

Returns
Value Number Array.

◆ GetArrayValue()

ASPOSE_PDF_SHARED_API System::ArrayPtr<System::SharedPtr<AttributeName> > Aspose::Pdf::LogicalStructure::StructureAttribute::GetArrayValue ( )

Gets Value Name Array.

Returns
Value Name Array.

◆ GetNameValue()

ASPOSE_PDF_SHARED_API System::SharedPtr<AttributeName> Aspose::Pdf::LogicalStructure::StructureAttribute::GetNameValue ( )

Gets Value Name.

Returns
Value Name.

◆ GetNumberValue()

ASPOSE_PDF_SHARED_API System::Nullable<double> Aspose::Pdf::LogicalStructure::StructureAttribute::GetNumberValue ( )

Gets Value Number.

Returns
Value Number.

◆ GetStringValue()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::LogicalStructure::StructureAttribute::GetStringValue ( )

Gets Value String.

Returns
Value String.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::LogicalStructure::StructureAttribute::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( StructureAttribute  ,
CODEPORTING_ARGS(System::SharedPtr< AttributeKey > attributeKey, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > pdfEntity)   
)
protected

◆ SetArrayNumberValue()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureAttribute::SetArrayNumberValue ( System::ArrayPtr< System::Nullable< double >>  arrayNumber)

Sets Value Number Array.

Parameters
arrayNumberArray of Numbers.

◆ SetArrayValue()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureAttribute::SetArrayValue ( System::ArrayPtr< System::SharedPtr< AttributeName >>  array)

Sets Value Name Array.

Parameters
arrayArray of allowable Value Names.

◆ SetColorValue()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureAttribute::SetColorValue ( System::SharedPtr< Color color)

Sets Value Color.

Parameters
colorColor.

◆ SetNameValue()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureAttribute::SetNameValue ( System::SharedPtr< AttributeName name)

Sets Value Name.

Parameters
nameAllowable Value Name.

◆ SetNumberValue()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureAttribute::SetNumberValue ( double  number)

Sets Value Number.

Parameters
numberValue Number.

◆ SetRectangleValue()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureAttribute::SetRectangleValue ( System::SharedPtr< Rectangle rectangle)

Sets Value Rectangle.

Parameters
rectangleRectangle.

◆ SetStringValue()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::StructureAttribute::SetStringValue ( System::String  value)

Sets Value String.

Parameters
valueValue String.