Class representing annotation object. More...

Inherits Aspose::Pdf::BaseParagraph.

Inherited by Aspose::Pdf::Annotations::GenericAnnotation, Aspose::Pdf::Annotations::LinkAnnotation, Aspose::Pdf::Annotations::MarkupAnnotation, Aspose::Pdf::Annotations::MovieAnnotation, Aspose::Pdf::Annotations::PDF3DAnnotation, Aspose::Pdf::Annotations::PopupAnnotation, Aspose::Pdf::Annotations::RichMediaAnnotation, Aspose::Pdf::Annotations::ScreenAnnotation, Aspose::Pdf::Annotations::WatermarkAnnotation, and Aspose::Pdf::Annotations::WidgetAnnotation.

Classes

class  AppearanceParameters
 Class representing parameters which have influence on element appearance (checked/not checked etc) More...
 
class  ITitledAnnotation
 This annotation allows to get/set Title property. More...
 

Public Member Functions

ASPOSE_PDF_SHARED_API AnnotationFlags get_Flags ()
 Flags of the annotation. More...
 
ASPOSE_PDF_SHARED_API void set_Flags (AnnotationFlags value)
 Flags of the annotation. More...
 
virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::AnnotationType get_AnnotationType ()=0
 Gets type of annotation. More...
 
virtual ASPOSE_PDF_SHARED_API double get_Width ()
 Gets width of the annotation. More...
 
virtual ASPOSE_PDF_SHARED_API void set_Width (double value)
 Sets width of the annotation. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< PdfActionCollectionget_Actions ()
 Gets list of annotatation actions. More...
 
virtual ASPOSE_PDF_SHARED_API double get_Height ()
 Gets height of the annotation. More...
 
virtual ASPOSE_PDF_SHARED_API void set_Height (double value)
 Sets height of the annotation. More...
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< Rectangleget_Rect ()
 Gets annotation rectangle. More...
 
virtual ASPOSE_PDF_SHARED_API void set_Rect (System::SharedPtr< Rectangle > value)
 Sets annotation rectangle. More...
 
ASPOSE_PDF_SHARED_API System::String get_Contents ()
 Gets annotation text. More...
 
ASPOSE_PDF_SHARED_API void set_Contents (System::String value)
 Sets annotation text. More...
 
ASPOSE_PDF_SHARED_API System::String get_Name ()
 Gets annotation name on the page. More...
 
ASPOSE_PDF_SHARED_API void set_Name (System::String value)
 Sets annotation name on the page. More...
 
ASPOSE_PDF_SHARED_API System::DateTime get_Modified ()
 Gets date and time when annotation was recently modified. More...
 
ASPOSE_PDF_SHARED_API void set_Modified (System::DateTime value)
 Sets date and time when annotation was recently modified. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Colorget_Color ()
 Gets annotation color. More...
 
ASPOSE_PDF_SHARED_API void set_Color (System::SharedPtr< Aspose::Pdf::Color > value)
 Sets annotation color. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Annotations::Borderget_Border () const
 Gets annotation border characteristics. Border More...
 
ASPOSE_PDF_SHARED_API void set_Border (System::SharedPtr< Aspose::Pdf::Annotations::Border > value)
 Sets annotation border characteristics. Border More...
 
virtual ASPOSE_PDF_SHARED_API System::String get_ActiveState ()
 Gets current annotation appearance state. More...
 
virtual ASPOSE_PDF_SHARED_API void set_ActiveState (System::String value)
 Sets current annotation appearance state. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Annotations::Characteristicsget_Characteristics ()
 Gets annotation characteristics. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< AppearanceDictionaryget_States ()
 Gets appearance dictionary of annotation. More...
 
ASPOSE_PDF_SHARED_API TextAlignment get_Alignment ()
 Annotation alignment. This property is obsolete. Use HorizontalAligment instead. More...
 
ASPOSE_PDF_SHARED_API void set_Alignment (TextAlignment value)
 Annotation alignment. This property is obsolete. Use HorizontalAligment instead. More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::HorizontalAlignment get_HorizontalAlignment () override
 Gets text alignment for annotation. More...
 
ASPOSE_PDF_SHARED_API void set_HorizontalAlignment (Aspose::Pdf::HorizontalAlignment value) override
 Sets text alignment for annotation. More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::HorizontalAlignment get_TextHorizontalAlignment ()
 Gets text alignment for annotation. More...
 
ASPOSE_PDF_SHARED_API void set_TextHorizontalAlignment (Aspose::Pdf::HorizontalAlignment value)
 Sets text alignment for annotation. More...
 
ASPOSE_PDF_SHARED_API System::String get_FullName ()
 Gets full qualified name of the annotation. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< AppearanceDictionaryget_Appearance ()
 Gets appearance dictionary of the annotation. More...
 
virtual ASPOSE_PDF_SHARED_API int32_t get_PageIndex ()
 Gets index of page which contains annotation. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< RectangleGetRectangle (bool considerRotation)
 Returns rectangle of annotation taking into consideration page rotation. More...
 
virtual ASPOSE_PDF_SHARED_API void Accept (System::SharedPtr< AnnotationSelector > visitor)=0
 Accepts visitor for annotation processing. More...
 
virtual ASPOSE_PDF_SHARED_API 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_SHARED_API Aspose::Pdf::VerticalAlignment get_VerticalAlignment ()
 Gets a vertical alignment of paragraph More...
 
virtual ASPOSE_PDF_SHARED_API void set_VerticalAlignment (Aspose::Pdf::VerticalAlignment value)
 Sets a vertical alignment of paragraph More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< MarginInfoget_Margin ()
 Gets a outer margin for paragraph (for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_Margin (System::SharedPtr< MarginInfo > value)
 Sets a outer margin for paragraph (for pdf generation) More...
 
ASPOSE_PDF_SHARED_API bool get_IsFirstParagraphInColumn () const
 Gets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API bool get_IsKeptWithNext () const
 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...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API bool get_IsInNewPage () const
 Gets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_IsInNewPage (bool value)
 Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API bool get_IsInLineParagraph () const
 Gets a paragraph is inline. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_IsInLineParagraph (bool value)
 Sets a paragraph is inline. Default is false.(for pdf generation) More...
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Hyperlinkget_Hyperlink ()
 Gets the fragment hyperlink(for pdf generator). More...
 
virtual ASPOSE_PDF_SHARED_API void set_Hyperlink (System::SharedPtr< Aspose::Pdf::Hyperlink > value)
 Sets the fragment hyperlink(for pdf generator). More...
 
ASPOSE_PDF_SHARED_API int32_t get_ZIndex () const
 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...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::ObjectClone () override
 Clones this instance. Virtual method. Always return null. More...
 
ASPOSE_PDF_SHARED_API 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 () 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)
 

Static Public Member Functions

static ASPOSE_PDF_SHARED_API 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 ASPOSE_PDF_SHARED_API 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 ASPOSE_PDF_SHARED_API bool get_UseFontSubset ()
 If this property set to true, fonts will be added to document as subsets. Default value is true. More...
 
static ASPOSE_PDF_SHARED_API 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...
 

Protected Member Functions

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > get_EngineObj () const
 
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 () const
 
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 ASPOSE_PDF_SHARED_API System::SharedPtr< Rectangleget_InnerRect ()
 Returns internal rectnagle of annotation, i.e. rectangle recalculated according to RD entry of annotation More...
 
double get_TemplateWidth () const
 Property for generator support. This property gets field width originally set by user (width of the "template"). More...
 
double get_TemplateHeight () const
 Property for generator support. This property gets field height originally set by user (height of the "template"). More...
 
virtual ASPOSE_PDF_SHARED_API void DeleteAllChildElements ()
 
void Initialize (System::SharedPtr< Document > doc)
 
void assertAppearance ()
 
virtual ASPOSE_PDF_SHARED_API void AfterImport ()
 Method which must be called after annotation import. More...
 
virtual ASPOSE_PDF_SHARED_API System::Drawing::Color GetBackgroundColor ()
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > CreateFrame (System::SharedPtr< Annotation::AppearanceParameters > parametes, System::SharedPtr< Annotation > annotation)
 Create frame. More...
 
virtual ASPOSE_PDF_SHARED_API 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 ASPOSE_PDF_SHARED_API void ClearAppearance (System::SharedPtr< OperatorCollection > appearance)
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< XFormPrepareAppearance (System::String key, System::SharedPtr< Annotation > annotation)
 
virtual ASPOSE_PDF_SHARED_API bool AppearanceSupported ()
 This method must be overriden to return true in classes where apperance generation is supported. More...
 
virtual ASPOSE_PDF_SHARED_API void UpdateAppearance (System::SharedPtr< Annotation > annotation)
 Updated appearance dictionary of the field. More...
 
virtual ASPOSE_PDF_SHARED_API void UpdateAppearances ()
 
virtual ASPOSE_PDF_SHARED_API void WriteXfdf (System::SharedPtr< System::Xml::XmlWriter > writer)
 
virtual ASPOSE_PDF_SHARED_API void WriteXfdfAttributes (System::SharedPtr< System::Xml::XmlWriter > writer)
 When overridden in a derived class, exports annotation attributes into XFDF. More...
 
virtual ASPOSE_PDF_SHARED_API void WriteXfdfElements (System::SharedPtr< System::Xml::XmlWriter > writer)
 When overridden in a derived class, exports annotation elements into XFDF. More...
 
virtual ASPOSE_PDF_SHARED_API void ReadXfdf (System::SharedPtr< System::Xml::XmlReader > reader)
 
virtual ASPOSE_PDF_SHARED_API void ReadXfdfAttributes (System::SharedPtr< System::Xml::XmlReader > reader)
 When overridden in a derived class, import annotation attributes from XFDF. More...
 
virtual ASPOSE_PDF_SHARED_API 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 ASPOSE_PDF_SHARED_API 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 ASPOSE_PDF_SHARED_API void AttachToPage (System::SharedPtr< Aspose::Pdf::Page > page)
 
void Initialize (System::SharedPtr< Document > doc, System::SharedPtr< Rectangle > rect)
 Create annotation data structure. More...
 
ASPOSE_PDF_SHARED_API Annotation (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect)
 Constructor. More...
 
ASPOSE_PDF_SHARED_API Annotation (System::SharedPtr< Document > doc, System::SharedPtr< Rectangle > rect)
 Constructor for Annotation. More...
 
virtual ASPOSE_PDF_SHARED_API 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 ASPOSE_PDF_SHARED_API void InternalFlatten (System::SharedPtr< Resources > resources, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>> operators)
 
virtual ASPOSE_PDF_SHARED_API System::String InternalFlatten2 (System::SharedPtr< Resources > resources)
 
virtual ASPOSE_PDF_SHARED_API System::String InternalFlatten3 (System::SharedPtr< Resources > resources)
 
virtual ASPOSE_PDF_SHARED_API bool IsBackground ()
 true if the annotation must be background. More...
 
int32_t GetPageIndex (System::SharedPtr< Annotation > annotation)
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::StreamToImage (System::SharedPtr< System::Drawing::Imaging::ImageFormat > format)
 
virtual ASPOSE_PDF_SHARED_API ~Annotation ()
 
- Protected Member Functions inherited from Aspose::Pdf::BaseParagraph
System::String get_Id () const
 Gets a paragraph id. More...
 
void set_Id (System::String value)
 Sets a paragraph id. More...
 
System::SharedPtr< Annotations::LinkAnnotationget_ReferencedFrom () const
 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 ASPOSE_PDF_SHARED_API void Serialize (System::SharedPtr< System::Xml::XmlTextWriter > writer)
 
virtual ASPOSE_PDF_SHARED_API void Deserialize (System::SharedPtr< System::Xml::XmlReader > reader)
 

Static Protected Member Functions

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

System::SharedPtr< System::Globalization::CultureInfoCulture
 
System::WeakPtr< Document_document
 
bool _disableUpdateAppearance
 
bool _flatteningState
 
bool needBaseInitialization
 

Static Protected Attributes

static ASPOSE_PDF_SHARED_API System::String message1
 The message. More...
 

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...
 

Detailed Description

Class representing annotation object.

Constructor & Destructor Documentation

◆ Annotation() [1/5]

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

◆ Annotation() [2/5]

Aspose::Pdf::Annotations::Annotation::Annotation ( System::SharedPtr< Document document)
protected

Constructor to use in Generator.

Parameters
documentDocument where annotation will be created.

◆ Annotation() [3/5]

Aspose::Pdf::Annotations::Annotation::Annotation ( )
protected

◆ Annotation() [4/5]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::Annotation::Annotation ( System::SharedPtr< Aspose::Pdf::Page page,
System::SharedPtr< Rectangle rect 
)
protected

Constructor.

Parameters
pageThe page with which the annotation will be associated.
rectThe annotation rectangle, defining the location of the annotation on the page.

◆ Annotation() [5/5]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::Annotation::Annotation ( System::SharedPtr< Document doc,
System::SharedPtr< Rectangle rect 
)
protected

Constructor for Annotation.

Parameters
docDocument where annotation is added.
rectAnnotation rectangle.

◆ ~Annotation()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::Annotation::~Annotation ( )
protectedvirtual

Member Function Documentation

◆ Accept()

◆ AfterImport()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::AfterImport ( )
protectedvirtual

Method which must be called after annotation import.

Reimplemented in Aspose::Pdf::Annotations::MarkupAnnotation.

◆ AppearanceSupported()

◆ assertAppearance()

void Aspose::Pdf::Annotations::Annotation::assertAppearance ( )
protected

◆ AttachToPage()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::AttachToPage ( System::SharedPtr< Aspose::Pdf::Page page)
protectedvirtual

◆ ClearAppearance()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::ClearAppearance ( System::SharedPtr< OperatorCollection appearance)
protectedvirtual

◆ CreateAnnotation()

static System::SharedPtr<Annotation> Aspose::Pdf::Annotations::Annotation::CreateAnnotation ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >  annotEngineObj,
System::SharedPtr< Aspose::Pdf::Page page 
)
staticprotected

Initializes annotation from PDF object which describes the annotation.

Parameters
annotEngineObjPDF obejct describing annotation
pageTODO:
Returns
Created annotation object of appropriate type

◆ CreateAppearanceProgram()

◆ CreateFrame()

virtual ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > > Aspose::Pdf::Annotations::Annotation::CreateFrame ( System::SharedPtr< Annotation::AppearanceParameters parametes,
System::SharedPtr< Annotation annotation 
)
protectedvirtual

Create frame.

Parameters
parametesAppearance parameters.
annotationThe annotation.
Returns
List of frame appearance commands.

Reimplemented in Aspose::Pdf::Annotations::FreeTextAnnotation.

◆ DeleteAllChildElements()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::DeleteAllChildElements ( )
protectedvirtual

◆ Flatten()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::Flatten ( )
virtual

Places annotation contents directly on the page, annotation object will be removed.

Reimplemented in Aspose::Pdf::Forms::Field, and Aspose::Pdf::Annotations::RedactionAnnotation.

◆ GeneratorUpdateRectangle()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::GeneratorUpdateRectangle ( System::SharedPtr< Aspose::Pdf::Page page,
System::SharedPtr< Rectangle rect 
)
protectedvirtual

This method should be called if annotation requires some additional actions when generator updates its rectangle.

Parameters
rect

Reimplemented in Aspose::Pdf::Annotations::FreeTextAnnotation, Aspose::Pdf::Annotations::LineAnnotation, and Aspose::Pdf::Annotations::InkAnnotation.

◆ get_Actions()

ASPOSE_PDF_SHARED_API System::SharedPtr<PdfActionCollection> Aspose::Pdf::Annotations::Annotation::get_Actions ( )

Gets list of annotatation actions.

◆ get_ActiveState()

virtual ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::Annotation::get_ActiveState ( )
virtual

Gets current annotation appearance state.

Reimplemented in Aspose::Pdf::Forms::CheckboxField.

◆ get_Alignment()

ASPOSE_PDF_SHARED_API TextAlignment Aspose::Pdf::Annotations::Annotation::get_Alignment ( )

Annotation alignment. This property is obsolete. Use HorizontalAligment instead.

Deprecated:
Use TextHorizontalAlignment property

◆ get_AnnotationType()

◆ get_Appearance()

ASPOSE_PDF_SHARED_API System::SharedPtr<AppearanceDictionary> Aspose::Pdf::Annotations::Annotation::get_Appearance ( )

Gets appearance dictionary of the annotation.

◆ get_Border()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Annotations::Border> Aspose::Pdf::Annotations::Annotation::get_Border ( ) const

Gets annotation border characteristics. Border

◆ get_Characteristics()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Annotations::Characteristics> Aspose::Pdf::Annotations::Annotation::get_Characteristics ( )

Gets annotation characteristics.

◆ get_Color()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Color> Aspose::Pdf::Annotations::Annotation::get_Color ( )

Gets annotation color.

◆ get_Contents()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::Annotation::get_Contents ( )

Gets annotation text.

◆ get_EngineDict()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> Aspose::Pdf::Annotations::Annotation::get_EngineDict ( )
protected

◆ get_EngineObj()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> Aspose::Pdf::Annotations::Annotation::get_EngineObj ( ) const
protected

◆ get_Flags()

ASPOSE_PDF_SHARED_API AnnotationFlags Aspose::Pdf::Annotations::Annotation::get_Flags ( )

Flags of the annotation.

◆ get_FlatteningState()

bool Aspose::Pdf::Annotations::Annotation::get_FlatteningState ( ) const
protected

◆ get_FullName()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::Annotation::get_FullName ( )

Gets full qualified name of the annotation.

Returns

◆ get_Height()

virtual ASPOSE_PDF_SHARED_API double Aspose::Pdf::Annotations::Annotation::get_Height ( )
virtual

Gets height of the annotation.

◆ get_HorizontalAlignment()

ASPOSE_PDF_SHARED_API Aspose::Pdf::HorizontalAlignment Aspose::Pdf::Annotations::Annotation::get_HorizontalAlignment ( )
overridevirtual

Gets text alignment for annotation.

Deprecated:
Use TextHorizontalAlignment property

Reimplemented from Aspose::Pdf::BaseParagraph.

◆ get_InnerRect()

virtual ASPOSE_PDF_SHARED_API System::SharedPtr<Rectangle> Aspose::Pdf::Annotations::Annotation::get_InnerRect ( )
protectedvirtual

Returns internal rectnagle of annotation, i.e. rectangle recalculated according to RD entry of annotation

Reimplemented in Aspose::Pdf::Annotations::FreeTextAnnotation.

◆ get_Modified()

ASPOSE_PDF_SHARED_API System::DateTime Aspose::Pdf::Annotations::Annotation::get_Modified ( )

Gets date and time when annotation was recently modified.

◆ get_Name()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::Annotation::get_Name ( )

Gets annotation name on the page.

◆ get_NormalAppearance()

System::SharedPtr<XForm> Aspose::Pdf::Annotations::Annotation::get_NormalAppearance ( )
protected

Gets normal appearance.

Returns

◆ get_Page()

System::SharedPtr<Aspose::Pdf::Page> Aspose::Pdf::Annotations::Annotation::get_Page ( )
protected

Gets the page object with which this annotation is associated.

◆ get_PageIndex()

virtual ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::Annotation::get_PageIndex ( )
virtual

Gets index of page which contains annotation.

Reimplemented in Aspose::Pdf::Forms::Field, and Aspose::Pdf::Forms::RadioButtonField.

◆ get_Rect()

virtual ASPOSE_PDF_SHARED_API System::SharedPtr<Rectangle> Aspose::Pdf::Annotations::Annotation::get_Rect ( )
virtual

Gets annotation rectangle.

Reimplemented in Aspose::Pdf::Forms::Field.

◆ get_RotatedRect()

System::SharedPtr<Rectangle> Aspose::Pdf::Annotations::Annotation::get_RotatedRect ( )
protected

Gets rotated rectangle.

◆ get_States()

ASPOSE_PDF_SHARED_API System::SharedPtr<AppearanceDictionary> Aspose::Pdf::Annotations::Annotation::get_States ( )

Gets appearance dictionary of annotation.

◆ get_StructParent()

int32_t Aspose::Pdf::Annotations::Annotation::get_StructParent ( )
protected

◆ get_TemplateHeight()

double Aspose::Pdf::Annotations::Annotation::get_TemplateHeight ( ) const
protected

Property for generator support. This property gets field height originally set by user (height of the "template").

◆ get_TemplateWidth()

double Aspose::Pdf::Annotations::Annotation::get_TemplateWidth ( ) const
protected

Property for generator support. This property gets field width originally set by user (width of the "template").

◆ get_TextHorizontalAlignment()

ASPOSE_PDF_SHARED_API Aspose::Pdf::HorizontalAlignment Aspose::Pdf::Annotations::Annotation::get_TextHorizontalAlignment ( )

Gets text alignment for annotation.

◆ get_UpdateAppearanceOnConvert()

static ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::Annotation::get_UpdateAppearanceOnConvert ( )
static

If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time.

◆ get_UseFontSubset()

static ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::Annotation::get_UseFontSubset ( )
static

If this property set to true, fonts will be added to document as subsets. Default value is true.

◆ get_Width()

virtual ASPOSE_PDF_SHARED_API double Aspose::Pdf::Annotations::Annotation::get_Width ( )
virtual

Gets width of the annotation.

◆ GetBackgroundColor()

virtual ASPOSE_PDF_SHARED_API System::Drawing::Color Aspose::Pdf::Annotations::Annotation::GetBackgroundColor ( )
protectedvirtual

◆ GetCheckedStateName()

System::String Aspose::Pdf::Annotations::Annotation::GetCheckedStateName ( )
protected

Returns name of "checked" state according to existing state names.

Returns

◆ GetPageIndex()

int32_t Aspose::Pdf::Annotations::Annotation::GetPageIndex ( System::SharedPtr< Annotation annotation)
protected

◆ GetRectangle()

ASPOSE_PDF_SHARED_API System::SharedPtr<Rectangle> Aspose::Pdf::Annotations::Annotation::GetRectangle ( bool  considerRotation)

Returns rectangle of annotation taking into consideration page rotation.

Parameters
considerRotationIf true, page rotation is takein into consideration.
Returns

◆ Initialize() [1/5]

void Aspose::Pdf::Annotations::Annotation::Initialize ( System::SharedPtr< Document doc)
protected

◆ Initialize() [2/5]

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::Initialize ( System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable >  trailer,
System::SharedPtr< Rectangle rect 
)
protectedvirtual

◆ Initialize() [3/5]

void Aspose::Pdf::Annotations::Annotation::Initialize ( System::SharedPtr< Aspose::Pdf::Page page,
System::SharedPtr< Rectangle rect 
)
protected

Initialize the annotation.

Parameters
pageThe Aspose.Pdf.Page object.
rectThe rectangle of the annotation.

◆ Initialize() [4/5]

void Aspose::Pdf::Annotations::Annotation::Initialize ( System::SharedPtr< Document doc,
System::SharedPtr< Rectangle rect 
)
protected

Create annotation data structure.

Parameters
docDocument where annotation is created.
rectAnnotation rectangle.

◆ Initialize() [5/5]

void Aspose::Pdf::Annotations::Annotation::Initialize ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >  annotEngineObj)
protected

Initializes this object with internal engine annotation object.

Parameters
annotEngineObjInternal engine annotEngineObj object.

◆ InternalFlatten()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::InternalFlatten ( System::SharedPtr< Resources resources,
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>>  operators 
)
protectedvirtual

◆ InternalFlatten2()

virtual ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::Annotation::InternalFlatten2 ( System::SharedPtr< Resources resources)
protectedvirtual

◆ InternalFlatten3()

virtual ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::Annotation::InternalFlatten3 ( System::SharedPtr< Resources resources)
protectedvirtual

◆ InternalFlatten4()

static System::String Aspose::Pdf::Annotations::Annotation::InternalFlatten4 ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >  annotation,
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >  resources 
)
staticprotected

◆ IsBackground()

virtual ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::Annotation::IsBackground ( )
protectedvirtual

true if the annotation must be background.

Returns

Reimplemented in Aspose::Pdf::Annotations::HighlightAnnotation.

◆ IsEmptyAppearance()

static bool Aspose::Pdf::Annotations::Annotation::IsEmptyAppearance ( System::SharedPtr< System::IO::Stream s)
staticprotected

◆ PrepareAppearance()

◆ ReadXfdf()

◆ ReadXfdfAttributes()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::ReadXfdfAttributes ( System::SharedPtr< System::Xml::XmlReader reader)
protectedvirtual

◆ ReadXfdfElements()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::ReadXfdfElements ( System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String >>  table)
protectedvirtual

When overridden in a derived class, import annotation elements from XFDF.

Parameters
tableHashtable with information parsed from the XFDF file.

Reimplemented in Aspose::Pdf::Annotations::LineAnnotation, Aspose::Pdf::Annotations::MarkupAnnotation, and Aspose::Pdf::Annotations::PolyAnnotation.

◆ set_ActiveState()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_ActiveState ( System::String  value)
virtual

Sets current annotation appearance state.

Reimplemented in Aspose::Pdf::Forms::CheckboxField.

◆ set_Alignment()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_Alignment ( TextAlignment  value)

Annotation alignment. This property is obsolete. Use HorizontalAligment instead.

Deprecated:
Use TextHorizontalAlignment property

◆ set_Border()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_Border ( System::SharedPtr< Aspose::Pdf::Annotations::Border value)

Sets annotation border characteristics. Border

◆ set_Color()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_Color ( System::SharedPtr< Aspose::Pdf::Color value)

Sets annotation color.

◆ set_Contents()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_Contents ( System::String  value)

Sets annotation text.

◆ set_Flags()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_Flags ( AnnotationFlags  value)

Flags of the annotation.

◆ set_FlatteningState()

void Aspose::Pdf::Annotations::Annotation::set_FlatteningState ( bool  value)
protected

◆ set_Height()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_Height ( double  value)
virtual

Sets height of the annotation.

◆ set_HorizontalAlignment()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_HorizontalAlignment ( Aspose::Pdf::HorizontalAlignment  value)
overridevirtual

Sets text alignment for annotation.

Deprecated:
Use TextHorizontalAlignment property

Reimplemented from Aspose::Pdf::BaseParagraph.

◆ set_Modified()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_Modified ( System::DateTime  value)

Sets date and time when annotation was recently modified.

◆ set_Name()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_Name ( System::String  value)

Sets annotation name on the page.

◆ set_Page()

void Aspose::Pdf::Annotations::Annotation::set_Page ( System::SharedPtr< Aspose::Pdf::Page value)
protected

Gets the page object with which this annotation is associated.

◆ set_Rect()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_Rect ( System::SharedPtr< Rectangle value)
virtual

Sets annotation rectangle.

Reimplemented in Aspose::Pdf::Forms::Field.

◆ set_StructParent()

void Aspose::Pdf::Annotations::Annotation::set_StructParent ( int32_t  value)
protected

◆ set_TextHorizontalAlignment()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_TextHorizontalAlignment ( Aspose::Pdf::HorizontalAlignment  value)

Sets text alignment for annotation.

◆ set_UpdateAppearanceOnConvert()

static ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_UpdateAppearanceOnConvert ( bool  value)
static

If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time.

◆ set_UseFontSubset()

static ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_UseFontSubset ( bool  value)
static

If this property set to true, fonts will be added to document as subsets. Default value is true.

◆ set_Width()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::set_Width ( double  value)
virtual

Sets width of the annotation.

◆ ToImage()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::Pdf::Annotations::Annotation::ToImage ( System::SharedPtr< System::Drawing::Imaging::ImageFormat format)
protected

◆ UpdateAppearance()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::UpdateAppearance ( System::SharedPtr< Annotation annotation)
protectedvirtual

◆ UpdateAppearances()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::UpdateAppearances ( )
protectedvirtual

◆ WriteXfdf()

◆ WriteXfdfAttributes()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::WriteXfdfAttributes ( System::SharedPtr< System::Xml::XmlWriter writer)
protectedvirtual

◆ WriteXfdfElements()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Annotation::WriteXfdfElements ( System::SharedPtr< System::Xml::XmlWriter writer)
protectedvirtual

When overridden in a derived class, exports annotation elements into XFDF.

Parameters
writerWriter of destination file.

Reimplemented in Aspose::Pdf::Annotations::MarkupAnnotation, and Aspose::Pdf::Annotations::PolyAnnotation.

Member Data Documentation

◆ _disableUpdateAppearance

bool Aspose::Pdf::Annotations::Annotation::_disableUpdateAppearance
protected

◆ _document

System::WeakPtr<Document> Aspose::Pdf::Annotations::Annotation::_document
protected

◆ _flatteningState

bool Aspose::Pdf::Annotations::Annotation::_flatteningState
protected

◆ Culture

System::SharedPtr<System::Globalization::CultureInfo> Aspose::Pdf::Annotations::Annotation::Culture
protected

◆ message1

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::Annotation::message1
staticprotected

The message.

◆ needBaseInitialization

bool Aspose::Pdf::Annotations::Annotation::needBaseInitialization
protected