Aspose.Pdf.Annotations

The Aspose.Pdf.Annotations namespace provides classes for working with various types of actions, destinations and other features of document which traditionally called as interactive providing means user can intercommunicate with it.

Classes

Class Description
ActionCollection Collection of actions
Annotation Class representing annotation object.
AnnotationActionCollection Represents the collection of annotation actions.
AnnotationCollection Class representing annotation collection.
AnnotationSelector This class is used for selecting annotations using Visitor template idea.
AppearanceDictionary Annotation appearance dictionary specifying how the annotation shall be presented visually on the page.
Border Class representing characteristics of annotation border.
CaretAnnotation Class representing Caret annotation.
Characteristics Represents annotation characteristics
CircleAnnotation Class representing Circle annotation.
CommonFigureAnnotation Abstract class representing common figure annotation.
CustomExplicitDestination Represents custom explicit destination.
Dash Class representing line dash pattern.
DefaultAppearance Describes default appearance of field (font, text size and color).
DocumentActionCollection Class describes actions performed on some actions with document
ExplicitDestination Represents the base class for explicit destinations in PDF document.
FileAttachmentAnnotation Class describes file attachment annotation.
FitBExplicitDestination Represents explicit destination that displays the page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension.
FitBHExplicitDestination Represents explicit destination that displays the page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window. A null value for top specifies that the current value of that parameter is to be retained unchanged.
FitBVExplicitDestination Represents explicit destination that displays the page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window. A null value for left specifies that the current value of that parameter is to be retained unchanged.
FitExplicitDestination Represents explicit destination that displays the page with its contents magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.
FitHExplicitDestination Represents explicit destination that displays the page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window. A null value for top specifies that the current value of that parameter is to be retained unchanged.
FitRExplicitDestination Represents explicit destination that displays the page with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and topentirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension. A null value for any of the parameters may result in unpredictable behavior.
FitVExplicitDestination Represents explicit destination that displays the page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window. A null value for left specifies that the current value of that parameter is to be retained unchanged.
FixedPrint Represent Fixed print data of Watermark Annotation.
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.
GoToAction Represents a go-to action that changes the view to a specified destination (page, location, and magnification factor).
GoToRemoteAction Represents a remote go-to action that is similar to an ordinary go-to action but jumps to a destination in another PDF file instead of the current file.
GoToURIAction Represents a URI action causes a URI to be resolved.
HideAction Represents a hide action that hides or shows one or more annotations on the screen by setting or clearing their Hidden flags.
HighlightAnnotation Represents a highlight annotation that highlights a range of text in the document.
ImportDataAction Upon invocation of an import-data action, Forms Data Format (FDF) data shall be imported into the document’s interactive form from a specified file.
InkAnnotation Represents a freehand “scribble” composed of one or more disjoint paths.
JavascriptAction Class representing javascript action.
LaunchAction Represents a launch action that launches an application or opens or prints a document.
LineAnnotation Class representing line annotation.
LinkAnnotation Represents either a hypertext link to a destination elsewhere in the document or an action to be performed.
MarkupAnnotation Abstract class representing markup annotation.
Measure Class which describes Measure coordinate system.
MediaClip Class describes media clip object of rendition.
MediaClipData Class describes media clip data.
MediaClipSection This class descibes Media clip section.
MediaRendition Class describes media rendition.
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.
NamedAction Represents named actions that PDF viewer applications are expected to support.
NamedDestination Instead of being defined directly with the explicit syntax, a destination may be referred to indirectly by means of a name object or a byte string.
PDF3DAnnotation Class PDF3DAnnotation. This class cannot be inherited.
PDF3DArtwork Class PDF3DArtwork.
PDF3DContent Class PDF3DContent.
PDF3DCrossSection Class PDF3DCrossSection.
PDF3DCrossSectionArray Class PDF3DCrossSectionArray.
PDF3DCuttingPlaneOrientation Class PDF3DCuttingPlaneOrientation.
PDF3DLightingScheme Class PDF3DLightingScheme.
PDF3DRenderMode Class PDF3DRenderMode.
PDF3DStream Class PDF3DStream.
PDF3DView Class PDF3DView.
PDF3DViewArray Class PDF3DViewArray.
PdfAction Represents Action in PDF document
PdfActionCollection Class describes list of actions.
PolyAnnotation Abstract base class for poly- annotations.
PolygonAnnotation Class representing polygon annotation.
PolylineAnnotation Represents polyline annotation that is similar to polygon, except that the first and last vertex are not implicitly connected.
PopupAnnotation Represents the pop-up annotation that displays text in a pop-up window for entry and editing.
RedactionAnnotation Represents Redact annotation.
Rendition Class which describes rendition object of RendtionAnnotation.
RenditionAction A rendition action that controls the playing of multimedia content.
RichMediaAnnotation Class describes RichMediaAnnotation which allows embed video/audio data into PDF document.
ScreenAnnotation A screen annotation that specifies a region of a page upon which media clips may be played.
SelectorRendition Class describes selector rendition.
SoundAnnotation Represents a sound annotation that contains sound recorded from the computer�s microphone or imported from a file.
SoundData Represents a sound data defining the sound to be played when the annotation is activated.
SoundSampleData Represents additional entries specific to a sound object (Section 9.2 PDF1-7)
SquareAnnotation Class representing square annotation.
SquigglyAnnotation Represents the squiggly annotation that appears as a jagged underline in the text of a document.
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.
StrikeOutAnnotation Represents a strikeout annotation that appears as a strikeout in the text of the document.
SubmitFormAction Class which describes submit-form action.
TextAnnotation Represents a text annotation that is a �sticky note� attached to a point in the PDF document.
TextMarkupAnnotation Abstract base class for text markup annotations.
TextStyle Class represents style of text in annotation
UnderlineAnnotation Represents an underline annotation that appears as an underline in the text of the document.
WatermarkAnnotation Class describes Watermark annotation object.
WidgetAnnotation Class representing widget annotation.
XfdfReader Class which peroformes reading of XFDF format.
XYZExplicitDestination Represents explicit destination that displays the page with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. A null value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged. A zoom value of 0 has the same meaning as a null value.

Interfaces

Interface Description
IAnnotationVisitor Defines Visitor for visiting different document annotations.
IAppointment Represents general interface for actions and destinations.

Enumeration

Enumeration Description
AnnotationFlags A set of flags specifying various characteristics of the annotation.
AnnotationState The enumeration of states to which the original annotation can be set.
AnnotationStateModel The state model corresponding to state of annotation.
AnnotationType Enumeration of annotation types.
BorderEffect Describes effect which should be applied to the border of the annotations.
BorderStyle Describes style of the annotation border.
CapStyle Style of line ending of Ink annotation line.
CaptionPosition Enumeration of the annotation�s caption positioning.
CaretSymbol A symbol to be associated with the caret.
ExplicitDestinationType Enumerates the types of explicit destinations.
FileIcon An icon to be used in displaying the annotation.
FreeTextIntent Enumerates the intents of the free text annotation.
HighlightingMode Enumerates the annotation�s highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area.
Justification Enumerates the forms of quadding (justification) to be used in displaying the annotation�s text.
LaunchActionOperation Enumerates the operations to perform with document during launch action executing.
LightingSchemeType Enum LightingSchemeType: set of lighting scheme types.
LineEnding Enumerates the line ending styles to be used in drawing the line.
LineIntent Enumerates the intents of the line annotation.
PDF3DActivation Enum PDF3DActivation: set of 3D annotation activation mode.
PolyIntent Enumerates the intents of the polygon or polyline annotation.
PredefinedAction Defines different actions which can be triggered from a PDF file.
RenderModeType Enum RenderModeType: set of render mode types
RenditionOperation The operation to perform when the action is triggered.
RenditionType Enumeration describes possible types of Rendition.
ReplyType Enumerates the kinds of the relationships (the “reply type”) between the annotation and one specified by InReplyTo.
SoundEncoding The encoding format for the sample data.
SoundIcon Enumerates the icons to be used in displaying the annotation.
SoundSampleDataEncodingFormat The encoding format for the sound sample data.
StampIcon Enumerates the icons to be used in displaying the annotation.
TextIcon Enumerates the icons to be used in displaying the annotation.