Aspose::Pdf::InteractiveFeatures::Annotations Namespace Reference

Classes

class  Annotation
 Class representing annotation object. More...
 
class  AnnotationActionCollection
 Represents the collection of annotation actions. More...
 
class  AnnotationCollection
 Class representing annotation collection. More...
 
class  AnnotationFlagsConverter
 
class  AnnotationSelector
 This class is used for selecting annotations using Visitor template idea. More...
 
class  AnnotationStateConverter
 
class  AnnotationStateModelConverter
 
class  AnnotationTypeConverter
 
class  AppearanceDictionary
 Annotation appearance dictionary specifying how the annotation shall be presented visually on the page. More...
 
class  Border
 Class representing characteristics of annotation border. More...
 
class  BorderEffectConverter
 
class  BorderStyleConverter
 
class  CaptionPositionConverter
 
class  CaretAnnotation
 Class representing Caret annotation. More...
 
class  CaretSymbolConverter
 
class  Characteristics
 Represents annotation characteristics More...
 
class  CircleAnnotation
 Class representing Circle annotation. More...
 
class  CommonFigureAnnotation
 Abstract class representing common figure annotation. More...
 
class  Dash
 Class representing line dash pattern. More...
 
class  FileAttachmentAnnotation
 Class describes file attachment annotation. More...
 
class  FileIconConverter
 
class  FreeTextAnnotation
 Represents a free text annotation that displays text directly on the page. Unlike an ordinary text annotation, a free text annotation has no open or closed state; instead of being displayed in a pop-up window, the text is always visible. More...
 
class  FreeTextIntentConverter
 
class  GenericAnnotation
 The class describes general annotation. More...
 
class  HighlightAnnotation
 Represents a highlight annotation that highlights a range of text in the document. More...
 
class  IAnnotationVisitor
 Defines Visitor for visiting different document annotations. More...
 
class  InkAnnotation
 Represents a freehand "scribble" composed of one or more disjoint paths. More...
 
class  LineAnnotation
 Class representing line annotation. More...
 
class  LineEndingConverter
 
class  LineIntentConverter
 
class  LinkAnnotation
 Represents either a hypertext link to a destination elsewhere in the document or an action to be performed. More...
 
class  MarkupAnnotation
 Abstract class representing markup annotation. More...
 
class  Measure
 Class which describes Measure coordinate system. More...
 
class  MovieAnnotation
 Represents a movie annotation that contains animated graphics and sound to be presented on the computer screen and through the speakers. When the annotation is activated, the movie is played. More...
 
class  NamespaceDoc
 The Aspose.Pdf.InteractiveFeatures.Annotations namespace provides classes for almost all types of annotations document can have. More...
 
class  PolyAnnotation
 Abstract base class for poly- annotations. More...
 
class  PolygonAnnotation
 Class representing polygon annotation. More...
 
class  PolyIntentConverter
 
class  PolylineAnnotation
 Represents polyline annotation that is similar to polygon, except that the first and last vertex are not implicitly connected. More...
 
class  PopupAnnotation
 Represents the pop-up annotation that displays text in a pop-up window for entry and editing. More...
 
class  RedactionAnnotation
 Represents Redact annotation. More...
 
class  ReplyTypeConverter
 
class  ScreenAnnotation
 A screen annotation that specifies a region of a page upon which media clips may be played. More...
 
class  SoundAnnotation
 Represents a sound annotation that contains sound recorded from the computer�s microphone or imported from a file. More...
 
class  SoundEncodingConverter
 
class  SoundIconConverter
 
class  SoundSampleData
 Represents additional entries specific to a sound object (Section 9.2 PDF1-7) More...
 
class  SquareAnnotation
 Class representing square annotation. More...
 
class  SquigglyAnnotation
 Represents the squiggly annotation that appears as a jagged underline in the text of a document. More...
 
class  StampAnnotation
 Represents rubber stamp annotation. This type of annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp. More...
 
class  StampIconConverter
 
class  StrikeOutAnnotation
 Represents a strikeout annotation that appears as a strikeout in the text of the document. More...
 
class  TextAnnotation
 Represents a text annotation that is a �sticky note� attached to a point in the PDF document. More...
 
class  TextIconConverter
 
class  TextMarkupAnnotation
 Abstract base class for text markup annotations. More...
 
class  TextStyle
 Class represents style of text in annotation More...
 
class  UnderlineAnnotation
 Represents an underline annotation that appears as an underline in the text of the document. More...
 
class  WidgetAnnotation
 Class representing widget annotation. More...
 

Enumerations

enum  AnnotationFlags {
  AnnotationFlags::Default = 0, AnnotationFlags::Invisible = 1, AnnotationFlags::Hidden = 2, AnnotationFlags::Print = 4,
  AnnotationFlags::NoZoom = 8, AnnotationFlags::NoRotate = 16, AnnotationFlags::NoView = 32, AnnotationFlags::ReadOnly = 64,
  AnnotationFlags::Locked = 128, AnnotationFlags::ToggleNoView = 256, AnnotationFlags::LockedContents = 512
}
 A set of flags specifying various characteristics of the annotation. More...
 
enum  AnnotationState {
  AnnotationState::Undefined, AnnotationState::Marked, AnnotationState::Unmarked, AnnotationState::Accepted,
  AnnotationState::Rejected, AnnotationState::Cancelled, AnnotationState::Completed, AnnotationState::None
}
 The enumeration of states to which the original annotation can be set. More...
 
enum  AnnotationStateModel { AnnotationStateModel::Undefined, AnnotationStateModel::Marked, AnnotationStateModel::Review }
 The state model corresponding to state of annotation. More...
 
enum  AnnotationType {
  AnnotationType::Text, AnnotationType::Circle, AnnotationType::Polygon, AnnotationType::PolyLine,
  AnnotationType::Line, AnnotationType::Square, AnnotationType::FreeText, AnnotationType::Highlight,
  AnnotationType::Underline, AnnotationType::Squiggly, AnnotationType::StrikeOut, AnnotationType::Caret,
  AnnotationType::Ink, AnnotationType::Link, AnnotationType::Popup, AnnotationType::FileAttachment,
  AnnotationType::Sound, AnnotationType::Movie, AnnotationType::Screen, AnnotationType::Widget,
  AnnotationType::Watermark, AnnotationType::TrapNet, AnnotationType::PrinterMark, AnnotationType::Redaction,
  AnnotationType::Stamp, AnnotationType::Unknown
}
 Enumeration of annotation types. More...
 
enum  BorderEffect { BorderEffect::None, BorderEffect::Cloudy }
 Describes effect which should be applied to the border of the annotations. More...
 
enum  BorderStyle {
  BorderStyle::Solid, BorderStyle::Dashed, BorderStyle::Beveled, BorderStyle::Inset,
  BorderStyle::Underline
}
 Describes style of the annotation border. More...
 
enum  CapStyle { CapStyle::Rectangular = 1, CapStyle::Rounded = 2 }
 Style of line ending of Ink annotation line. More...
 
enum  CaptionPosition { CaptionPosition::Inline, CaptionPosition::Top }
 Enumeration of the annotation�s caption positioning. More...
 
enum  CaretSymbol { CaretSymbol::None, CaretSymbol::Paragraph }
 A symbol to be associated with the caret. More...
 
enum  FileIcon { FileIcon::PushPin, FileIcon::Graph, FileIcon::Paperclip, FileIcon::Tag }
 An icon to be used in displaying the annotation. More...
 
enum  FreeTextIntent { FreeTextIntent::Undefined, FreeTextIntent::FreeTextCallout, FreeTextIntent::FreeTextTypeWriter }
 Enumerates the intents of the free text annotation. More...
 
enum  LineEnding {
  LineEnding::None, LineEnding::Square, LineEnding::Circle, LineEnding::Diamond,
  LineEnding::OpenArrow, LineEnding::ClosedArrow, LineEnding::Butt, LineEnding::ROpenArrow,
  LineEnding::RClosedArrow, LineEnding::Slash
}
 Enumerates the line ending styles to be used in drawing the line. More...
 
enum  LineIntent { LineIntent::Undefined, LineIntent::LineArrow, LineIntent::LineDimension }
 Enumerates the intents of the line annotation. More...
 
enum  PolyIntent { PolyIntent::Undefined, PolyIntent::PolygonCloud, PolyIntent::PolyLineDimension, PolyIntent::PolygonDimension }
 Enumerates the intents of the polygon or polyline annotation. More...
 
enum  ReplyType { ReplyType::Undefined, ReplyType::Reply, ReplyType::Group }
 Enumerates the kinds of the relationships (the “reply type”) between the annotation and one specified by InReplyTo. More...
 
enum  SoundEncoding { SoundEncoding::Raw, SoundEncoding::Signed, SoundEncoding::MuLaw, SoundEncoding::ALaw }
 The encoding format for the sample data. More...
 
enum  SoundIcon { SoundIcon::Speaker, SoundIcon::Mic }
 Enumerates the icons to be used in displaying the annotation. More...
 
enum  SoundSampleDataEncodingFormat { SoundSampleDataEncodingFormat::Raw, SoundSampleDataEncodingFormat::Signed, SoundSampleDataEncodingFormat::muLaw, SoundSampleDataEncodingFormat::ALaw }
 The encoding format for the sound sample data. More...
 
enum  StampIcon {
  StampIcon::Draft, StampIcon::Approved, StampIcon::Experimental, StampIcon::NotApproved,
  StampIcon::AsIs, StampIcon::Expired, StampIcon::NotForPublicRelease, StampIcon::Confidential,
  StampIcon::Final, StampIcon::Sold, StampIcon::Departmental, StampIcon::ForComment,
  StampIcon::ForPublicRelease, StampIcon::TopSecret
}
 Enumerates the icons to be used in displaying the annotation. More...
 
enum  TextAlignment { TextAlignment::Left, TextAlignment::Center, TextAlignment::Right }
 Alignment of text in annotation. More...
 
enum  TextIcon {
  TextIcon::Note, TextIcon::Comment, TextIcon::Key, TextIcon::Help,
  TextIcon::NewParagraph, TextIcon::Paragraph, TextIcon::Insert, TextIcon::Check,
  TextIcon::Cross, TextIcon::Circle, TextIcon::Star
}
 Enumerates the icons to be used in displaying the annotation. More...
 

Functions

 DECLARE_ENUM_OPERATORS (Aspose::Pdf::InteractiveFeatures::Annotations::AnnotationFlags)
 
bool operator== (System::SharedPtr< Dash > l, System::SharedPtr< Dash > r)
 
bool operator!= (System::SharedPtr< Dash > l, System::SharedPtr< Dash > r)
 

Enumeration Type Documentation

◆ AnnotationFlags

A set of flags specifying various characteristics of the annotation.

Enumerator
Default 

Default value.

Invisible 

If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an unknown annotation using an appearance stream specified by its appearance dictionary, if any.

Hidden 

If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available. In cases where screen space is limited, the ability to hide and show annotations selectively can be used in combination with appearance streams to display auxiliary pop-up information similar in function to online help systems.

Print 

If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.

NoZoom 

If set, do not scale the annotation�s appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) remains fixed, regardless of the page magnification.

NoRotate 

If set, do not rotate the annotation�s appearance to match the rotation of the page. The upper-left corner of the annotation rectangle remains in a fixed location on the page, regardless of the page rotation.

NoView 

If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction.

ReadOnly 

If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions. This flag is ignored for widget annotations; its function is subsumed by the ReadOnly flag of the associated form field.

Locked 

If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation�s contents, such as the value of a form field.

ToggleNoView 

If set, invert the interpretation of the NoView flag for certain events. A typical use is to have an annotation that appears only when a mouse cursor is held over it.

LockedContents 

If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.

◆ AnnotationState

The enumeration of states to which the original annotation can be set.

Enumerator
Undefined 

Not defined state.

Marked 

The annotation has been marked by the user.

Unmarked 

The annotation has not been marked by the user.

Accepted 

The user agrees with the change.

Rejected 

The user disagrees with the change.

Cancelled 

The change has been cancelled.

Completed 

The change has been completed.

None 

The user has indicated nothing about the change.

◆ AnnotationStateModel

The state model corresponding to state of annotation.

Enumerator
Undefined 

Not defined state model.

Marked 

The annotation has been marked (or unmarked) by the user.

Review 

The annotation has been reviewed (accepted, rejected, cancelled, completed, none) by the user.

◆ AnnotationType

Enumeration of annotation types.

Enumerator
Text 

Text annotation type.

Circle 

Circle annotation type.

Polygon 

Polygon annotation type.

PolyLine 

Plyline annotation type.

Line 

Line annotation type.

Square 

Square annotatotion type.

FreeText 

Free text annotation type.

Highlight 

Highlight annotation type.

Underline 

Underline annotation type.

Squiggly 

Squiggle annotation type.

StrikeOut 

Strikeout annotation type.

Caret 

Caret annotation type.

Ink 

Ink annotation type.

Link 

Link annotation type.

Popup 

Popup annotation type.

FileAttachment 

File attachment annotation type.

Sound 

Sound annotation type.

Movie 

Movie annotation type.

Screen 

Screen annotation type.

Widget 

Widget annotation type.

Watermark 

Watermark annotation type.

TrapNet 

Trap network annotation type.

PrinterMark 

Printer mark annotation type.

Redaction 

Redaction annotation type.

Stamp 

Rubber stamp annotation type.

Unknown 

Unknown annotation.

◆ BorderEffect

Describes effect which should be applied to the border of the annotations.

Enumerator
None 

No effect.

Cloudy 

The border will appear "cloudly".

◆ BorderStyle

Describes style of the annotation border.

Enumerator
Solid 

Solid border.

Dashed 

Dashed border.

Beveled 

Bevelled border.

Inset 

Inset border.

Underline 

Underlined border.

◆ CapStyle

Style of line ending of Ink annotation line.

Enumerator
Rectangular 

End is rectangular.

Rounded 

End is rounded.

◆ CaptionPosition

Enumeration of the annotation�s caption positioning.

Enumerator
Inline 

The caption will be centered inside the line (default value).

Top 

The caption will be on top of the line.

◆ CaretSymbol

A symbol to be associated with the caret.

Enumerator
None 

No symbol should be associated with the caret.

Paragraph 

A new paragraph symbol (�) should be associated with the caret.

◆ FileIcon

An icon to be used in displaying the annotation.

Enumerator
PushPin 

PushPin icon (default value).

Graph 

Graph icon.

Paperclip 

Paperclip icon.

Tag 

This is tag icon.

◆ FreeTextIntent

Enumerates the intents of the free text annotation.

Enumerator
Undefined 

Not defined state.

FreeTextCallout 

Means that the annotation is intended to function as a callout.

FreeTextTypeWriter 

Means that the annotation is intended to function as a click-to-type or typewriter object.

◆ LineEnding

Enumerates the line ending styles to be used in drawing the line.

Enumerator
None 

No line ending.

Square 

A square filled with the annotation�s interior color, if any.

Circle 

A circle filled with the annotation�s interior color, if any.

Diamond 

A diamond shape filled with the annotation�s interior color, if any.

OpenArrow 

Two short lines meeting in an acute angle to form an open arrowhead.

ClosedArrow 

Two short lines meeting in an acute angle as in the OpenArrow style and connected by a third line to form a triangular closed arrowhead filled with the annotation�s interior color, if any.

Butt 

A short line at the endpoint perpendicular to the line itself.

ROpenArrow 

Two short lines in the reverse direction from OpenArrow.

RClosedArrow 

A triangular closed arrowhead in the reverse direction from ClosedArrow.

Slash 

A short line at the endpoint approximately 30 degrees clockwise from perpendicular to the line itself.

◆ LineIntent

Enumerates the intents of the line annotation.

Enumerator
Undefined 

Undefined state.

LineArrow 

Means that the annotation is intended to function as an arrow.

LineDimension 

Means that the annotation is intended to function as a dimension line.

◆ PolyIntent

Enumerates the intents of the polygon or polyline annotation.

Enumerator
Undefined 

Undefined state.

PolygonCloud 

Means that the annotation is intended to function as a cloud object.

PolyLineDimension 

Indicates that the polyline annotation is intended to function as a dimension.

PolygonDimension 

Indicates that the polygon annotation is intended to function as a dimension.

◆ ReplyType

Enumerates the kinds of the relationships (the “reply type”) between the annotation and one specified by InReplyTo.

Enumerator
Undefined 

Undefined relationship.

Reply 

The annotation is considered a reply to the annotation specified by InReplyTo. Viewer applications should not display replies to an annotation individually but together in the form of threaded comments.

Group 

The annotation is grouped with the annotation specified by InReplyTo.

◆ SoundEncoding

The encoding format for the sample data.

Enumerator
Raw 

Unspecified or unsigned values in the range 0 to 2^bits − 1.

Signed 

Twos-complement values.

MuLaw 

μ-law–encoded samples.

ALaw 

A-law–encoded samples.

◆ SoundIcon

Enumerates the icons to be used in displaying the annotation.

Enumerator
Speaker 

Speaker icon.

Mic 

Microphone icon.

◆ SoundSampleDataEncodingFormat

The encoding format for the sound sample data.

Enumerator
Raw 

Unspecified or unsigned values in the range 0 to 2B − 1.

Signed 

Twos-complement values.

muLaw 

μ-law–encoded samples.

ALaw 

A-law–encoded samples.

◆ StampIcon

Enumerates the icons to be used in displaying the annotation.

Enumerator
Draft 

Draft stamp icon.

Approved 

Approved stamp icon.

Experimental 

Experimental stamp icon.

NotApproved 

Stamp icon is not approved.

AsIs 

Stamp icon "as is".

Expired 

Stamp icon is expired.

NotForPublicRelease 

Not for public release.

Confidential 

Confidential.

Final 

Final stamp.

Sold 

Sold stamp.

Departmental 

Departamental.

ForComment 

For comment.

ForPublicRelease 

For public release.

TopSecret 

Top secret.

◆ TextAlignment

Alignment of text in annotation.

Enumerator
Left 

Text is aligned to left.

Center 

Text is centered.

Right 

Text is aligned to right.

◆ TextIcon

Enumerates the icons to be used in displaying the annotation.

Enumerator
Note 

Note icon.

Comment 

Comment icon.

Key 

Key icon.

Help 

Help icon.

NewParagraph 

NewParagraph icon.

Paragraph 

Paragraph icon.

Insert 

Insert icon.

Check 

Check icon.

Cross 

Cross icon.

Circle 

Circle icon.

Star 

Star icon.

Function Documentation

◆ DECLARE_ENUM_OPERATORS()

Aspose::Pdf::InteractiveFeatures::Annotations::DECLARE_ENUM_OPERATORS ( Aspose::Pdf::InteractiveFeatures::Annotations::AnnotationFlags  )

◆ operator!=()

bool Aspose::Pdf::InteractiveFeatures::Annotations::operator!= ( System::SharedPtr< Dash l,
System::SharedPtr< Dash r 
)

◆ operator==()

bool Aspose::Pdf::InteractiveFeatures::Annotations::operator== ( System::SharedPtr< Dash l,
System::SharedPtr< Dash r 
)