Aspose::Pdf::LogicalStructure::LinkElement Class Referencefinal

Represents Link structure element in logical structure. More...

Inherits Aspose::Pdf::LogicalStructure::AnnotationElement, and Aspose::Pdf::LogicalStructure::ITextElement.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Hyperlinkget_Hyperlink () const
 Gets or Sets Hyperlink for Link Element. More...
 
ASPOSE_PDF_SHARED_API void set_Hyperlink (System::SharedPtr< Aspose::Pdf::Hyperlink > value)
 Gets or Sets Hyperlink for Link Element. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::LogicalStructure::StructureTextStateget_StructureTextState () override
 Gets T:/Aspose::Pdf::LogicalStructure::StructureTextState object for current element. More...
 
ASPOSE_PDF_SHARED_API void SetText (System::String text) override
 Appends text content to current text element. More...
 
- Public Member Functions inherited from Aspose::Pdf::LogicalStructure::AnnotationElement
ASPOSE_PDF_SHARED_API System::String get_AlternateDescriptions () const
 Gets or Sets the Alternate Descriptions for annotation. Text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. More...
 
ASPOSE_PDF_SHARED_API void set_AlternateDescriptions (System::String value)
 Gets or Sets the Alternate Descriptions for annotation. Text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. More...
 
- Public Member Functions inherited from Aspose::Pdf::LogicalStructure::StructureElement
ASPOSE_PDF_SHARED_API System::SharedPtr< AttributeOwnerStandardget_DefaultAttributeOwner () const
 Gets T:/Aspose::Pdf::LogicalStructure::AttributeOwnerStandard object. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< StructureAttributeCollectionget_Attributes () const
 Gets T:/Aspose::Pdf::LogicalStructure::StructureAttributeCollection object. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< StructureTypeStandardget_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
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
- Public Member Functions inherited from Aspose::Pdf::LogicalStructure::Element
ASPOSE_PDF_SHARED_API System::SharedPtr< Elementget_ParentElement () const
 Get parent element. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< ElementListget_ChildElements () const
 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...
 
- 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 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 (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

 LinkElement (System::SharedPtr< Aspose::Pdf::Tagged::TaggedContext > taggedContext, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > pdfEngineEntity)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (LinkElement, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Tagged::TaggedContext > taggedContext, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > pdfEngineEntity))
 
ASPOSE_PDF_SHARED_API void PreSave () override
 
virtual ASPOSE_PDF_SHARED_API ~LinkElement ()
 
- Protected Member Functions inherited from Aspose::Pdf::LogicalStructure::AnnotationElement
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Aspose::Pdf::Annotations::Annotation > > > get_Annotations () const
 
 AnnotationElement (System::SharedPtr< Aspose::Pdf::Tagged::TaggedContext > taggedContext, System::SharedPtr< StructureTypeStandard > structureType, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > pdfEngineEntity)
 
ASPOSE_PDF_SHARED_API void Save () override
 
- Protected Member Functions inherited from Aspose::Pdf::LogicalStructure::ILSElement
 ILSElement (System::SharedPtr< Aspose::Pdf::Tagged::TaggedContext > taggedContext, System::SharedPtr< StructureTypeStandard > structureType, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > pdfEngineEntity)
 
- Protected Member Functions inherited from Aspose::Pdf::LogicalStructure::StructureElement
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::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 ~Element ()
 

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 Link structure element in logical structure.

Constructor & Destructor Documentation

◆ LinkElement()

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

◆ ~LinkElement()

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

Member Function Documentation

◆ get_Hyperlink()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Hyperlink> Aspose::Pdf::LogicalStructure::LinkElement::get_Hyperlink ( ) const

Gets or Sets Hyperlink for Link Element.

◆ get_StructureTextState()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::LogicalStructure::StructureTextState> Aspose::Pdf::LogicalStructure::LinkElement::get_StructureTextState ( )
overridevirtual

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::LogicalStructure::LinkElement::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( LinkElement  ,
CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Tagged::TaggedContext > taggedContext, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > pdfEngineEntity)   
)
protected

◆ PreSave()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::LinkElement::PreSave ( )
overrideprotectedvirtual

◆ set_Hyperlink()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::LinkElement::set_Hyperlink ( System::SharedPtr< Aspose::Pdf::Hyperlink value)

Gets or Sets Hyperlink for Link Element.

◆ SetText()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::LogicalStructure::LinkElement::SetText ( System::String  text)
overridevirtual

Appends text content to current text element.

Parameters
textText content.

Implements Aspose::Pdf::LogicalStructure::ITextElement.