Aspose::Pdf::Annotations::LinkAnnotation Class Referencefinal

Represents either a hypertext link to a destination elsewhere in the document or an action to be performed. More...

Inherits Aspose::Pdf::Annotations::Annotation.

Public Member Functions

System::SharedPtr< PdfActionget_Action ()
 An action to be performed when the link annotation is activated. More...
 
void set_Action (System::SharedPtr< PdfAction > value)
 An action to be performed when the link annotation is activated. More...
 
System::SharedPtr< IAppointmentget_Destination ()
 A destination to be displayed when the annotation is activated. More...
 
void set_Destination (System::SharedPtr< IAppointment > value)
 A destination to be displayed when the annotation is activated. More...
 
HighlightingMode get_Highlighting ()
 The visual effect to be used when the mouse button is pressed or held down inside its active area. More...
 
void set_Highlighting (HighlightingMode value)
 The visual effect to be used when the mouse button is pressed or held down inside its active area. More...
 
virtual Aspose::Pdf::Annotations::AnnotationType get_AnnotationType ()
 Gets type of annotation. More...
 
virtual void Accept (System::SharedPtr< AnnotationSelector > visitor)
 Accepts visitor object to process the annotation. More...
 
 LinkAnnotation (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect)
 Creates new Link annotation on the specified page. More...
 
- Public Member Functions inherited from Aspose::Pdf::Annotations::Annotation
AnnotationFlags get_Flags ()
 Flags of the annotation. More...
 
void set_Flags (AnnotationFlags value)
 Flags of the annotation. More...
 
virtual double get_Width ()
 Gets width of the annotation. More...
 
virtual void set_Width (double value)
 Sets width of the annotation. More...
 
System::SharedPtr< PdfActionCollectionget_Actions ()
 Gets list of annotatation actions. More...
 
virtual double get_Height ()
 Gets height of the annotation. More...
 
virtual void set_Height (double value)
 Sets height of the annotation. More...
 
virtual System::SharedPtr< Rectangleget_Rect ()
 Gets annotation rectangle. More...
 
virtual void set_Rect (System::SharedPtr< Rectangle > value)
 Sets annotation rectangle. More...
 
System::String get_Contents ()
 Gets annotation text. More...
 
void set_Contents (System::String value)
 Sets annotation text. More...
 
System::String get_Name ()
 Gets annotation name on the page. More...
 
void set_Name (System::String value)
 Sets annotation name on the page. More...
 
System::DateTime get_Modified ()
 Gets date and time when annotation was recently modified. More...
 
void set_Modified (System::DateTime value)
 Sets date and time when annotation was recently modified. More...
 
System::SharedPtr< Aspose::Pdf::Colorget_Color ()
 Gets annotation color. More...
 
void set_Color (System::SharedPtr< Aspose::Pdf::Color > value)
 Sets annotation color. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::Borderget_Border ()
 Gets annotation border characteristics. Border More...
 
void set_Border (System::SharedPtr< Aspose::Pdf::Annotations::Border > value)
 Sets annotation border characteristics. Border More...
 
virtual System::String get_ActiveState ()
 Gets current annotation appearance state. More...
 
virtual void set_ActiveState (System::String value)
 Sets current annotation appearance state. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::Characteristicsget_Characteristics ()
 Gets annotation characteristics. More...
 
System::SharedPtr< AppearanceDictionaryget_States ()
 Gets appearance dictionary of annotation. More...
 
TextAlignment get_Alignment ()
 Annotation alignment. This property is obsolete. Use HorizontalAligment instead. More...
 
void set_Alignment (TextAlignment value)
 Annotation alignment. This property is obsolete. Use HorizontalAligment instead. More...
 
Aspose::Pdf::HorizontalAlignment get_HorizontalAlignment ()
 Gets text alignmennt for annotation. More...
 
void set_HorizontalAlignment (Aspose::Pdf::HorizontalAlignment value)
 Sets text alignmennt for annotation. More...
 
System::String get_FullName ()
 Gets full qualified name of the annotation. More...
 
System::SharedPtr< AppearanceDictionaryget_Appearance ()
 Gets appearance dictionary of the annotation. More...
 
virtual int32_t get_PageIndex ()
 Gets index of page which contains annotation. More...
 
System::SharedPtr< RectangleGetRectangle (bool considerRotation)
 Returns rectangle of annotation taking into consideration page rotation. More...
 
virtual void Flatten ()
 Places annotation contents directly on the page, annotation object will be removed. More...
 
- Public Member Functions inherited from Aspose::Pdf::BaseParagraph
virtual Aspose::Pdf::VerticalAlignment get_VerticalAlignment ()
 Gets a vertical alignment of paragraph More...
 
virtual void set_VerticalAlignment (Aspose::Pdf::VerticalAlignment value)
 Sets a vertical alignment of paragraph More...
 
System::SharedPtr< MarginInfoget_Margin ()
 Gets a outer margin for paragraph (for pdf generation) More...
 
void set_Margin (System::SharedPtr< MarginInfo > value)
 Sets a outer margin for paragraph (for pdf generation) More...
 
bool get_IsFirstParagraphInColumn ()
 Gets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) More...
 
void set_IsFirstParagraphInColumn (bool value)
 Sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) More...
 
bool get_IsKeptWithNext ()
 Gets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) More...
 
void set_IsKeptWithNext (bool value)
 Sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) More...
 
bool get_IsInNewPage ()
 Gets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
void set_IsInNewPage (bool value)
 Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
bool get_IsInLineParagraph ()
 Gets a paragraph is inline. Default is false.(for pdf generation) More...
 
void set_IsInLineParagraph (bool value)
 Sets a paragraph is inline. Default is false.(for pdf generation) More...
 
virtual System::SharedPtr< Aspose::Pdf::Hyperlinkget_Hyperlink ()
 Gets the fragment hyperlink(for pdf generator). More...
 
virtual void set_Hyperlink (System::SharedPtr< Aspose::Pdf::Hyperlink > value)
 Sets the fragment hyperlink(for pdf generator). More...
 
int32_t get_ZIndex ()
 Gets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page. More...
 
void set_ZIndex (int32_t value)
 Sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page. More...
 
virtual System::SharedPtr< System::ObjectClone ()
 Clones this instance. Virtual method. Always return null. More...
 
 BaseParagraph ()
 
- 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_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 (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

 LinkAnnotation (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > engineAnnot, System::SharedPtr< Document > document)
 Ititializes Link annotation with engine annotation object. More...
 
virtual bool AppearanceSupported ()
 This method must be overriden to return true in classes where apperance generation is supported. More...
 
- Protected Member Functions inherited from Aspose::Pdf::Annotations::Annotation
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > get_EngineObj ()
 
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > get_EngineDict ()
 
int32_t get_StructParent ()
 
void set_StructParent (int32_t value)
 
System::SharedPtr< XFormget_NormalAppearance ()
 Gets normal appearance. More...
 
bool get_FlatteningState ()
 
void set_FlatteningState (bool value)
 
System::SharedPtr< Aspose::Pdf::Pageget_Page ()
 Gets the page object with which this annotation is associated. More...
 
void set_Page (System::SharedPtr< Aspose::Pdf::Page > value)
 Gets the page object with which this annotation is associated. More...
 
System::SharedPtr< Rectangleget_RotatedRect ()
 Gets rotated rectangle. More...
 
virtual System::SharedPtr< Rectangleget_InnerRect ()
 Returns internal rectnagle of annotation, i.e. rectangle recalculated according to RD entry of annotation More...
 
double get_TemplateWidth ()
 Property for generator support. This property gets field width originally set by user (width of the "template"). More...
 
double get_TemplateHeight ()
 Property for generator support. This property gets field height originally set by user (height of the "template"). More...
 
virtual void DeleteAllChildElements ()
 
void Initialize (System::SharedPtr< Document > doc)
 
void assertAppearance ()
 
virtual void AfterImport ()
 Method which must be called after annotation import. More...
 
virtual System::Drawing::Color GetBackgroundColor ()
 
virtual System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > CreateFrame (System::SharedPtr< Annotation::AppearanceParameters > parametes, System::SharedPtr< Annotation > annotation)
 Create frame. More...
 
virtual System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > CreateAppearanceProgram (System::SharedPtr< Annotation::AppearanceParameters > parameters, System::SharedPtr< Annotation > annotation)
 Create program for displaying this annotation. More...
 
virtual void ClearAppearance (System::SharedPtr< OperatorCollection > appearance)
 
virtual System::SharedPtr< XFormPrepareAppearance (System::String key, System::SharedPtr< Annotation > annotation)
 
virtual void UpdateAppearance (System::SharedPtr< Annotation > annotation)
 Updated appearance dictionary of the field. More...
 
virtual void UpdateAppearances ()
 
virtual void WriteXfdf (System::SharedPtr< System::Xml::XmlWriter > writer)
 
virtual void WriteXfdfAttributes (System::SharedPtr< System::Xml::XmlWriter > writer)
 When overridden in a derived class, exports annotation attributes into XFDF. More...
 
virtual void WriteXfdfElements (System::SharedPtr< System::Xml::XmlWriter > writer)
 When overridden in a derived class, exports annotation elements into XFDF. More...
 
virtual void ReadXfdf (System::SharedPtr< System::Xml::XmlReader > reader)
 
virtual void ReadXfdfAttributes (System::SharedPtr< System::Xml::XmlReader > reader)
 When overridden in a derived class, import annotation attributes from XFDF. More...
 
virtual void ReadXfdfElements (System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String >> table)
 When overridden in a derived class, import annotation elements from XFDF. More...
 
 Annotation (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotation, System::SharedPtr< Document > document)
 
 Annotation (System::SharedPtr< Document > document)
 Constructor to use in Generator. More...
 
 Annotation ()
 
virtual void Initialize (System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable > trailer, System::SharedPtr< Rectangle > rect)
 
void Initialize (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect)
 Initialize the annotation. More...
 
virtual void AttachToPage (System::SharedPtr< Aspose::Pdf::Page > page)
 
void Initialize (System::SharedPtr< Document > doc, System::SharedPtr< Rectangle > rect)
 Create annotation data structure. More...
 
 Annotation (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect)
 Constructor. More...
 
 Annotation (System::SharedPtr< Document > doc, System::SharedPtr< Rectangle > rect)
 Constructor for Annotation. More...
 
virtual void GeneratorUpdateRectangle (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect)
 This method should be called if annotation requires some additional actions when generator updates its rectangle. More...
 
System::String GetCheckedStateName ()
 Returns name of "checked" state according to existing state names. More...
 
void Initialize (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotEngineObj)
 Initializes this object with internal engine annotation object. More...
 
virtual void InternalFlatten (System::SharedPtr< Resources > resources, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>> operators)
 
virtual System::String InternalFlatten2 (System::SharedPtr< Resources > resources)
 
virtual System::String InternalFlatten3 (System::SharedPtr< Resources > resources)
 
virtual bool IsBackground ()
 true if the annotation must be background. More...
 
int32_t GetPageIndex (System::SharedPtr< Annotation > annotation)
 
System::SharedPtr< System::IO::StreamToImage (System::SharedPtr< System::Drawing::Imaging::ImageFormat > format)
 
- Protected Member Functions inherited from Aspose::Pdf::BaseParagraph
System::String get_Id ()
 Gets a paragraph id. More...
 
void set_Id (System::String value)
 Sets a paragraph id. More...
 
System::SharedPtr< Annotations::LinkAnnotationget_ReferencedFrom ()
 Gets the fragment hyperlink(for pdf generator internal use). More...
 
void set_ReferencedFrom (System::SharedPtr< Annotations::LinkAnnotation > value)
 Sets the fragment hyperlink(for pdf generator internal use). More...
 
void ChangePosition (double &curX, double &curY, double newX, double newY, bool isNextParagraphInline)
 
void ProcessHyperlink (System::SharedPtr< Page > page, System::SharedPtr< Rectangle > rect)
 
virtual void Serialize (System::SharedPtr< System::Xml::XmlTextWriter > writer)
 
virtual void Deserialize (System::SharedPtr< System::Xml::XmlReader > reader)
 

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 Aspose::Pdf::Annotations::Annotation
static bool get_UpdateAppearanceOnConvert ()
 If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time. More...
 
static void set_UpdateAppearanceOnConvert (bool value)
 If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time. More...
 
static bool get_UseFontSubset ()
 If this property set to true, fonts will be added to document as subsets. Default value is true. More...
 
static void set_UseFontSubset (bool value)
 If this property set to true, fonts will be added to document as subsets. Default value is true. 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...
 
- Static Protected Member Functions inherited from Aspose::Pdf::Annotations::Annotation
static System::SharedPtr< AnnotationCreateAnnotation (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotEngineObj, System::SharedPtr< Aspose::Pdf::Page > page)
 Initializes annotation from PDF object which describes the annotation. More...
 
static bool IsEmptyAppearance (System::SharedPtr< System::IO::Stream > s)
 
static System::String InternalFlatten4 (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > annotation, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > resources)
 
- Static Protected Member Functions inherited from Aspose::Pdf::BaseParagraph
static bool get_IsZIndexSet ()
 Gets the fragment hyperlink(for pdf generator performance internal use). More...
 
static void set_IsZIndexSet (bool value)
 Sets the fragment hyperlink(for pdf generator performance internal use). More...
 
- Protected Attributes inherited from Aspose::Pdf::Annotations::Annotation
System::SharedPtr< System::Globalization::CultureInfoCulture
 
System::WeakPtr< Document_document
 
bool _disableUpdateAppearance
 
bool _flatteningState
 
bool needBaseInitialization
 
- Static Protected Attributes inherited from Aspose::Pdf::Annotations::Annotation
static System::String message1
 

Detailed Description

Represents either a hypertext link to a destination elsewhere in the document or an action to be performed.

Constructor & Destructor Documentation

◆ LinkAnnotation() [1/2]

Aspose::Pdf::Annotations::LinkAnnotation::LinkAnnotation ( System::SharedPtr< Aspose::Pdf::Page page,
System::SharedPtr< Rectangle rect 
)

Creates new Link annotation on the specified page.

Parameters
pageThe document's page where annotation should be created.
rectThe annotation rectangle, defining the location of the annotation on the page.

◆ LinkAnnotation() [2/2]

Aspose::Pdf::Annotations::LinkAnnotation::LinkAnnotation ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >  engineAnnot,
System::SharedPtr< Document document 
)
protected

Ititializes Link annotation with engine annotation object.

Parameters
engineAnnotEngine object that represents the annotation.
documentDocument.

Member Function Documentation

◆ Accept()

virtual void Aspose::Pdf::Annotations::LinkAnnotation::Accept ( System::SharedPtr< AnnotationSelector visitor)
virtual

Accepts visitor object to process the annotation.

Parameters
visitorVisitor object.

Implements Aspose::Pdf::Annotations::Annotation.

◆ AppearanceSupported()

virtual bool Aspose::Pdf::Annotations::LinkAnnotation::AppearanceSupported ( )
protectedvirtual

This method must be overriden to return true in classes where apperance generation is supported.

Returns

Reimplemented from Aspose::Pdf::Annotations::Annotation.

◆ get_Action()

System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::LinkAnnotation::get_Action ( )

An action to be performed when the link annotation is activated.

◆ get_AnnotationType()

virtual Aspose::Pdf::Annotations::AnnotationType Aspose::Pdf::Annotations::LinkAnnotation::get_AnnotationType ( )
virtual

Gets type of annotation.

Implements Aspose::Pdf::Annotations::Annotation.

◆ get_Destination()

System::SharedPtr<IAppointment> Aspose::Pdf::Annotations::LinkAnnotation::get_Destination ( )

A destination to be displayed when the annotation is activated.

◆ get_Highlighting()

HighlightingMode Aspose::Pdf::Annotations::LinkAnnotation::get_Highlighting ( )

The visual effect to be used when the mouse button is pressed or held down inside its active area.

◆ set_Action()

void Aspose::Pdf::Annotations::LinkAnnotation::set_Action ( System::SharedPtr< PdfAction value)

An action to be performed when the link annotation is activated.

◆ set_Destination()

void Aspose::Pdf::Annotations::LinkAnnotation::set_Destination ( System::SharedPtr< IAppointment value)

A destination to be displayed when the annotation is activated.

◆ set_Highlighting()

void Aspose::Pdf::Annotations::LinkAnnotation::set_Highlighting ( HighlightingMode  value)

The visual effect to be used when the mouse button is pressed or held down inside its active area.