Aspose::Pdf::Annotations::LineAnnotation Class Referencefinal

Class representing line annotation. More...

Inherits Aspose::Pdf::Annotations::MarkupAnnotation.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< Pointget_Starting ()
 Gets starting point of line. More...
 
ASPOSE_PDF_SHARED_API void set_Starting (System::SharedPtr< Point > value)
 Sets starting point of line. More...
 
ASPOSE_PDF_SHARED_API LineEnding get_StartingStyle ()
 Gets line ending style for line starting point. More...
 
ASPOSE_PDF_SHARED_API void set_StartingStyle (LineEnding value)
 Sets line ending style for line starting point. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Pointget_Ending ()
 Gets line ending point. More...
 
ASPOSE_PDF_SHARED_API void set_Ending (System::SharedPtr< Point > value)
 Sets line ending point. More...
 
ASPOSE_PDF_SHARED_API LineEnding get_EndingStyle ()
 Gets ending style for end point of line. More...
 
ASPOSE_PDF_SHARED_API void set_EndingStyle (LineEnding value)
 Sets ending style for end point of line. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Colorget_InteriorColor ()
 Gets interior color of the annotation. More...
 
ASPOSE_PDF_SHARED_API void set_InteriorColor (System::SharedPtr< Aspose::Pdf::Color > value)
 Sets interior color of the annotation. More...
 
ASPOSE_PDF_SHARED_API double get_LeaderLine ()
 Gets leader line length. More...
 
ASPOSE_PDF_SHARED_API void set_LeaderLine (double value)
 Sets leader line length. More...
 
ASPOSE_PDF_SHARED_API double get_LeaderLineExtension ()
 Gets length of leader line extension. More...
 
ASPOSE_PDF_SHARED_API void set_LeaderLineExtension (double value)
 Sets length of leader line extension. More...
 
ASPOSE_PDF_SHARED_API bool get_ShowCaption ()
 Gets boolean flag which determinies is contents must be shown as caption. More...
 
ASPOSE_PDF_SHARED_API void set_ShowCaption (bool value)
 Sets boolean flag which determinies is contents must be shown as caption. More...
 
ASPOSE_PDF_SHARED_API double get_LeaderLineOffset ()
 Gets leader line offset. More...
 
ASPOSE_PDF_SHARED_API void set_LeaderLineOffset (double value)
 Sets leader line offset. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Pointget_CaptionOffset ()
 Gets caption text offset from its normal position. More...
 
ASPOSE_PDF_SHARED_API void set_CaptionOffset (System::SharedPtr< Point > value)
 Sets caption text offset from its normal position. More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::CaptionPosition get_CaptionPosition ()
 Gets annotation caption position. More...
 
ASPOSE_PDF_SHARED_API void set_CaptionPosition (Aspose::Pdf::Annotations::CaptionPosition value)
 Sets annotation caption position. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Annotations::Measureget_Measure ()
 Measure units specifed for this annotation. More...
 
ASPOSE_PDF_SHARED_API void set_Measure (System::SharedPtr< Aspose::Pdf::Annotations::Measure > value)
 Measure units specifed for this annotation. More...
 
ASPOSE_PDF_SHARED_API LineIntent get_Intent ()
 Gets the intent of the line annotation. More...
 
ASPOSE_PDF_SHARED_API void set_Intent (LineIntent value)
 Sets the intent of the line annotation. More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::AnnotationType get_AnnotationType () override
 Gets type of annotation. More...
 
ASPOSE_PDF_SHARED_API void Accept (System::SharedPtr< AnnotationSelector > visitor) override
 Accepts visitor to annotation processing. More...
 
ASPOSE_PDF_SHARED_API LineAnnotation (System::SharedPtr< Document > document, System::SharedPtr< Point > start, System::SharedPtr< Point > end)
 Constructor for using with Generator. More...
 
ASPOSE_PDF_SHARED_API LineAnnotation (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect, System::SharedPtr< Point > start, System::SharedPtr< Point > end)
 Creates new Line annotation on the specified page. More...
 
ASPOSE_PDF_SHARED_API void ChangeAfterResize (System::SharedPtr< Matrix > transform) override
 Updates the Starting and Ending points, according to the matrix transform. More...
 
- Public Member Functions inherited from Aspose::Pdf::Annotations::MarkupAnnotation
ASPOSE_PDF_SHARED_API System::String get_Title () override
 Gets a text that shall be displayed in title bar of annotation. More...
 
ASPOSE_PDF_SHARED_API void set_Title (System::String value) override
 Sets a text that shall be displayed in title bar of annotation. More...
 
ASPOSE_PDF_SHARED_API System::String get_RichText ()
 Gets a rich text string to be displayed in the pop-up window when the annotation is opened. More...
 
ASPOSE_PDF_SHARED_API void set_RichText (System::String value)
 Sets a rich text string to be displayed in the pop-up window when the annotation is opened. More...
 
ASPOSE_PDF_SHARED_API System::DateTime get_CreationDate ()
 Gets date and time when annotation was created. More...
 
ASPOSE_PDF_SHARED_API System::String get_Subject ()
 Gets text representing desciption of the object. More...
 
ASPOSE_PDF_SHARED_API void set_Subject (System::String value)
 Gets text representing desciption of the object. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< PopupAnnotationget_Popup ()
 Pop-up annotation for entering or editing the text associated with this annotation. More...
 
ASPOSE_PDF_SHARED_API void set_Popup (System::SharedPtr< PopupAnnotation > value)
 Pop-up annotation for entering or editing the text associated with this annotation. More...
 
ASPOSE_PDF_SHARED_API double get_Opacity ()
 Gets the constant opacity value to be used in painting the annotation. More...
 
ASPOSE_PDF_SHARED_API void set_Opacity (double value)
 Sets the constant opacity value to be used in painting the annotation. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Annotationget_InReplyTo ()
 A reference to the annotation that this annotation is "in reply to". Both annotations must be on the same page of the document. More...
 
ASPOSE_PDF_SHARED_API void set_InReplyTo (System::SharedPtr< Annotation > value)
 A reference to the annotation that this annotation is "in reply to". Both annotations must be on the same page of the document. More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::ReplyType get_ReplyType ()
 A string specifying the relationship (the "reply type") between this annotation and one specified by InReplyTo. More...
 
ASPOSE_PDF_SHARED_API void set_ReplyType (Aspose::Pdf::Annotations::ReplyType value)
 A string specifying the relationship (the "reply type") between this annotation and one specified by InReplyTo. More...
 
ASPOSE_PDF_SHARED_API MarkupAnnotation (System::SharedPtr< Document > document)
 Constructor for markup annotation. More...
 
- Public Member Functions inherited from Aspose::Pdf::Annotations::Annotation
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 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 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 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

ASPOSE_PDF_SHARED_API void WriteXfdf (System::SharedPtr< System::Xml::XmlWriter > writer) override
 
ASPOSE_PDF_SHARED_API void ReadXfdf (System::SharedPtr< System::Xml::XmlReader > reader) override
 
ASPOSE_PDF_SHARED_API void ReadXfdfElements (System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String >> table) override
 When overridden in a derived class, import annotation elements from XFDF. More...
 
 LineAnnotation (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > engineAnnot, System::SharedPtr< Document > document)
 Ititializes Line annotation with engine annotation object. More...
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (LineAnnotation, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > engineAnnot, System::SharedPtr< Document > document))
 
ASPOSE_PDF_SHARED_API bool AppearanceSupported () override
 This method must be overriden to return true in classes where apperance generation is supported. More...
 
ASPOSE_PDF_SHARED_API void GeneratorUpdateRectangle (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect) override
 This method should be called if annotation requires some additional actions when generator updates its rectangle. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< XFormPrepareAppearance (System::String key, System::SharedPtr< Annotation > annotation) override
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > CreateAppearanceProgram (System::SharedPtr< Annotation::AppearanceParameters > parameters, System::SharedPtr< Annotation > annotation) override
 Create program for displaying this annotation. More...
 
virtual ASPOSE_PDF_SHARED_API ~LineAnnotation ()
 
- Protected Member Functions inherited from Aspose::Pdf::Annotations::MarkupAnnotation
 MarkupAnnotation (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotation, System::SharedPtr< Document > document)
 
ASPOSE_PDF_SHARED_API MarkupAnnotation (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< Rectangle > rect)
 Constructor. More...
 
ASPOSE_PDF_SHARED_API void WriteXfdfAttributes (System::SharedPtr< System::Xml::XmlWriter > writer) override
 When overridden in a derived class, exports annotation attributes into XFDF. More...
 
ASPOSE_PDF_SHARED_API void WriteXfdfElements (System::SharedPtr< System::Xml::XmlWriter > writer) override
 When overridden in a derived class, exports annotation elements into XFDF. More...
 
ASPOSE_PDF_SHARED_API void ReadXfdfAttributes (System::SharedPtr< System::Xml::XmlReader > reader) override
 When overridden in a derived class, import annotation attributes from XFDF. More...
 
ASPOSE_PDF_SHARED_API void AfterImport () override
 Method which must be called after annotation import. More...
 
ASPOSE_PDF_SHARED_API void ReadXfdfElements (System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String >> table) override
 When overridden in a derived class, import annotation elements from XFDF. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > DrawLines (System::SharedPtr< Point > p1, System::SharedPtr< Point > p2, double angle1, double angle2, bool closed)
 Drawes triangle ("arrow") whcih consists of two strokes by angles "angle1" and "angle2" to p1, p2 vector. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > DrawSlash (System::SharedPtr< Point > p1, System::SharedPtr< Point > p2)
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > DrawButt (System::SharedPtr< Point > p1, System::SharedPtr< Point > p2)
 
double GetEndingRadius ()
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > DrawRArrow (System::SharedPtr< Point > p1, System::SharedPtr< Point > p2, bool closed)
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > DrawArrow (System::SharedPtr< Point > p1, System::SharedPtr< Point > p2, bool closed)
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > DrawSquare (System::SharedPtr< Point > p1)
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > DrawDiamond (System::SharedPtr< Point > p1)
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > DrawCircle (System::SharedPtr< Point > p1)
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > DrawLineEnding (System::SharedPtr< Point > ending, System::SharedPtr< Point > starting, LineEnding endingStyle)
 
virtual ASPOSE_PDF_SHARED_API ~MarkupAnnotation ()
 
- Protected Member Functions inherited from Aspose::Pdf::Annotations::Annotation
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)
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API 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 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 void ClearAppearance (System::SharedPtr< OperatorCollection > appearance)
 
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 ()
 
 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)
 
ASPOSE_PDF_SHARED_API 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)
 
ASPOSE_PDF_SHARED_API 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...
 
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)
 Converts annotation to image stream. More...
 
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...
 
const System::SharedPtr< Annotations::LinkAnnotation > & get_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)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from Aspose::Pdf::Annotations::Annotation
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 ()
 Implements 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 const System::String DefaultFontName
 
static const System::String DefaultFontKey
 
static ASPOSE_PDF_SHARED_API System::String message1
 The message. More...
 

Detailed Description

Class representing line annotation.

Constructor & Destructor Documentation

◆ LineAnnotation() [1/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::LineAnnotation::LineAnnotation ( System::SharedPtr< Document document,
System::SharedPtr< Point start,
System::SharedPtr< Point end 
)

Constructor for using with Generator.

Parameters
documentDocument where annotation will be created.
startStarting point.
endEnding point.

◆ LineAnnotation() [2/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::LineAnnotation::LineAnnotation ( System::SharedPtr< Aspose::Pdf::Page page,
System::SharedPtr< Rectangle rect,
System::SharedPtr< Point start,
System::SharedPtr< Point end 
)

Creates new Line 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.
startA point, specifying the starting coordinate of the line.
endA point, specifying the ending coordinate of the line.

◆ LineAnnotation() [3/3]

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

Ititializes Line annotation with engine annotation object.

Parameters
engineAnnotEngine object that represents the annotation.
documentThe Aspose.Pdf.Document object.

◆ ~LineAnnotation()

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

Member Function Documentation

◆ Accept()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::Accept ( System::SharedPtr< AnnotationSelector visitor)
overridevirtual

Accepts visitor to annotation processing.

Parameters
visitorVisitor object

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

◆ AppearanceSupported()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::LineAnnotation::AppearanceSupported ( )
overrideprotectedvirtual

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

Returns

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

◆ ChangeAfterResize()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::ChangeAfterResize ( System::SharedPtr< Matrix transform)
overridevirtual

Updates the Starting and Ending points, according to the matrix transform.

Parameters
transformMatrix specifying the transformation.

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

◆ CreateAppearanceProgram()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > > Aspose::Pdf::Annotations::LineAnnotation::CreateAppearanceProgram ( System::SharedPtr< Annotation::AppearanceParameters parameters,
System::SharedPtr< Annotation annotation 
)
overrideprotectedvirtual

Create program for displaying this annotation.

Parameters
parametersAppearance parameters for this field (normal/mouse moved appearance, pressed/unpressed for button etc)
annotationAnnotation of the appearance
Returns
List of appearance program.

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

◆ GeneratorUpdateRectangle()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::GeneratorUpdateRectangle ( System::SharedPtr< Aspose::Pdf::Page page,
System::SharedPtr< Rectangle rect 
)
overrideprotectedvirtual

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

Parameters
rect

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

◆ get_AnnotationType()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::AnnotationType Aspose::Pdf::Annotations::LineAnnotation::get_AnnotationType ( )
overridevirtual

Gets type of annotation.

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

◆ get_CaptionOffset()

ASPOSE_PDF_SHARED_API System::SharedPtr<Point> Aspose::Pdf::Annotations::LineAnnotation::get_CaptionOffset ( )

Gets caption text offset from its normal position.

◆ get_CaptionPosition()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::CaptionPosition Aspose::Pdf::Annotations::LineAnnotation::get_CaptionPosition ( )

Gets annotation caption position.

◆ get_Ending()

ASPOSE_PDF_SHARED_API System::SharedPtr<Point> Aspose::Pdf::Annotations::LineAnnotation::get_Ending ( )

Gets line ending point.

◆ get_EndingStyle()

ASPOSE_PDF_SHARED_API LineEnding Aspose::Pdf::Annotations::LineAnnotation::get_EndingStyle ( )

Gets ending style for end point of line.

◆ get_Intent()

ASPOSE_PDF_SHARED_API LineIntent Aspose::Pdf::Annotations::LineAnnotation::get_Intent ( )

Gets the intent of the line annotation.

◆ get_InteriorColor()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Color> Aspose::Pdf::Annotations::LineAnnotation::get_InteriorColor ( )

Gets interior color of the annotation.

◆ get_LeaderLine()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Annotations::LineAnnotation::get_LeaderLine ( )

Gets leader line length.

◆ get_LeaderLineExtension()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Annotations::LineAnnotation::get_LeaderLineExtension ( )

Gets length of leader line extension.

◆ get_LeaderLineOffset()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Annotations::LineAnnotation::get_LeaderLineOffset ( )

Gets leader line offset.

◆ get_Measure()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Annotations::Measure> Aspose::Pdf::Annotations::LineAnnotation::get_Measure ( )

Measure units specifed for this annotation.

◆ get_ShowCaption()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::LineAnnotation::get_ShowCaption ( )

Gets boolean flag which determinies is contents must be shown as caption.

◆ get_Starting()

ASPOSE_PDF_SHARED_API System::SharedPtr<Point> Aspose::Pdf::Annotations::LineAnnotation::get_Starting ( )

Gets starting point of line.

◆ get_StartingStyle()

ASPOSE_PDF_SHARED_API LineEnding Aspose::Pdf::Annotations::LineAnnotation::get_StartingStyle ( )

Gets line ending style for line starting point.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

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

◆ PrepareAppearance()

ASPOSE_PDF_SHARED_API System::SharedPtr<XForm> Aspose::Pdf::Annotations::LineAnnotation::PrepareAppearance ( System::String  key,
System::SharedPtr< Annotation annotation 
)
overrideprotectedvirtual

◆ ReadXfdf()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::ReadXfdf ( System::SharedPtr< System::Xml::XmlReader reader)
overrideprotectedvirtual

◆ ReadXfdfElements()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::ReadXfdfElements ( System::SharedPtr< System::Collections::Generic::Dictionary< System::String, System::String >>  table)
overrideprotectedvirtual

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

Parameters
tableHashtable with information parsed from the XFDF file.

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

◆ set_CaptionOffset()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_CaptionOffset ( System::SharedPtr< Point value)

Sets caption text offset from its normal position.

◆ set_CaptionPosition()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_CaptionPosition ( Aspose::Pdf::Annotations::CaptionPosition  value)

Sets annotation caption position.

◆ set_Ending()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_Ending ( System::SharedPtr< Point value)

Sets line ending point.

◆ set_EndingStyle()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_EndingStyle ( LineEnding  value)

Sets ending style for end point of line.

◆ set_Intent()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_Intent ( LineIntent  value)

Sets the intent of the line annotation.

◆ set_InteriorColor()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_InteriorColor ( System::SharedPtr< Aspose::Pdf::Color value)

Sets interior color of the annotation.

◆ set_LeaderLine()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_LeaderLine ( double  value)

Sets leader line length.

◆ set_LeaderLineExtension()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_LeaderLineExtension ( double  value)

Sets length of leader line extension.

◆ set_LeaderLineOffset()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_LeaderLineOffset ( double  value)

Sets leader line offset.

◆ set_Measure()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_Measure ( System::SharedPtr< Aspose::Pdf::Annotations::Measure value)

Measure units specifed for this annotation.

◆ set_ShowCaption()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_ShowCaption ( bool  value)

Sets boolean flag which determinies is contents must be shown as caption.

◆ set_Starting()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_Starting ( System::SharedPtr< Point value)

Sets starting point of line.

◆ set_StartingStyle()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::set_StartingStyle ( LineEnding  value)

Sets line ending style for line starting point.

◆ WriteXfdf()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::LineAnnotation::WriteXfdf ( System::SharedPtr< System::Xml::XmlWriter writer)
overrideprotectedvirtual