Click or drag to resize
Aspose.Pdf.Annotations Namespace
The Aspose.Pdf.InteractiveFeatures 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
  ClassDescription
Public classActionCollection
Collection of actions
Public classAnnotation
Class representing annotation object.
Public classAnnotationActionCollection
Represents the collection of annotation actions.
Public classAnnotationCollection
Class representing annotation collection.
Public classAnnotationSelector
This class is used for selecting annotations using Visitor template idea.
Public classAppearanceDictionary
Annotation appearance dictionary specifying how the annotation shall be presented visually on the page.
Public classBorder
Class representing characteristics of annotation border.
Public classCaretAnnotation
Class representing Caret annotation.
Public classCharacteristics
Represents annotation characteristics
Public classCircleAnnotation
Class representing Circle annotation.
Public classCommonFigureAnnotation
Abstract class representing common figure annotation.
Public classDash
Class representing line dash pattern.
Public classDefaultAppearance
Describes default appearance of field (font, text size and color).
Public classDocumentActionCollection
Class describes actions performed on some actions with document
Public classExplicitDestination
Represents the base class for explicit destinations in PDF document.
Public classFileAttachmentAnnotation
Class describes file attachment annotation.
Public classFitBExplicitDestination
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.
Public classFitBHExplicitDestination
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.
Public classFitBVExplicitDestination
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.
Public classFitExplicitDestination
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.
Public classFitHExplicitDestination
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.
Public classFitRExplicitDestination
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.
Public classFitVExplicitDestination
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.
Public classFixedPrint
Represent Fixed print data of Watermark Annotation.
Public classFreeTextAnnotation
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.
Public classGoToAction
Represents a go-to action that changes the view to a specified destination (page, location, and magnification factor).
Public classGoToRemoteAction
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.
Public classGoToURIAction
Represents a URI action causes a URI to be resolved.
Public classHighlightAnnotation
Represents a highlight annotation that highlights a range of text in the document.
Public classInkAnnotation
Represents a freehand "scribble" composed of one or more disjoint paths.
Public classJavascriptAction
Class representing javascript action.
Public classLaunchAction
Represents a launch action that launches an application or opens or prints a document.
Public classLineAnnotation
Class representing line annotation.
Public classLinkAnnotation
Represents either a hypertext link to a destination elsewhere in the document or an action to be performed.
Public classMarkupAnnotation
Abstract class representing markup annotation.
Public classMeasure
Class which describes Measure coordinate system.
Public classMeasureNumberFormat
Number format for measure.
Public classMeasureNumberFormatList
Represents list of number formats.
Public classMovieAnnotation
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.
Public classNamedAction
Represents named actions that PDF viewer applications are expected to support.
Public classNamedDestination
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.
Public classPDF3DAnnotation
Class PDF3DAnnotation. This class cannot be inherited.
Public classPDF3DArtwork
Class PDF3DArtwork.
Public classPDF3DContent
Class PDF3DContent.
Public classPDF3DCrossSection
Class PDF3DCrossSection.
Public classPDF3DCrossSectionArray
Class PDF3DCrossSectionArray.
Public classPDF3DCuttingPlaneOrientation
Class PDF3DCuttingPlaneOrientation.
Public classPDF3DLightingScheme
Class PDF3DLightingScheme.
Public classPDF3DRenderMode
Class PDF3DRenderMode.
Public classPDF3DStream
Class PDF3DStream.
Public classPDF3DView
Class PDF3DView.
Public classPDF3DViewArray
Class PDF3DViewArray.
Public classPdfAction
Represents Action in PDF document
Public classPolyAnnotation
Abstract base class for poly- annotations.
Public classPolygonAnnotation
Class representing polygon annotation.
Public classPolylineAnnotation
Represents polyline annotation that is similar to polygon, except that the first and last vertex are not implicitly connected.
Public classPopupAnnotation
Represents the pop-up annotation that displays text in a pop-up window for entry and editing.
Public classRedactionAnnotation
Represents Redact annotation.
Public classRenditionAction
A rendition action that controls the playing of multimedia content.
Public classRichMediaAnnotation
Class describes RichMediaAnnotation which allows embed video/audio data into PDF document.
Public classScreenAnnotation
A screen annotation that specifies a region of a page upon which media clips may be played.
Public classSoundAnnotation
Represents a sound annotation that contains sound recorded from the computer’s microphone or imported from a file.
Public classSoundData
Represents a sound data defining the sound to be played when the annotation is activated.
Public classSoundSampleData
Represents additional entries specific to a sound object (Section 9.2 PDF1-7)
Public classSquareAnnotation
Class representing square annotation.
Public classSquigglyAnnotation
Represents the squiggly annotation that appears as a jagged underline in the text of a document.
Public classCode exampleStampAnnotation
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.
Public classStrikeOutAnnotation
Represents a strikeout annotation that appears as a strikeout in the text of the document.
Public classSubmitFormAction
Class which describes submit-form action.
Public classTextAnnotation
Represents a text annotation that is a “sticky note” attached to a point in the PDF document.
Public classTextMarkupAnnotation
Abstract base class for text markup annotations.
Public classTextStyle
Class represents style of text in annotation
Public classUnderlineAnnotation
Represents an underline annotation that appears as an underline in the text of the document.
Public classWatermarkAnnotation
Public classWidgetAnnotation
Class representing widget annotation.
Public classCode exampleXfdfReader
Class which peroformes reading of XFDF format.
Public classCode exampleXYZExplicitDestination
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
  InterfaceDescription
Public interfaceIAnnotationVisitor
Defines Visitor for visiting different document annotations.
Public interfaceIAppointment
Represents general interface for actions and destinations.
Enumerations
  EnumerationDescription
Public enumerationAnnotationFlags
A set of flags specifying various characteristics of the annotation.
Public enumerationAnnotationState
The enumeration of states to which the original annotation can be set.
Public enumerationAnnotationStateModel
The state model corresponding to state of annotation.
Public enumerationAnnotationType
Enumeration of annotation types.
Public enumerationBorderEffect
Describes effect which should be applied to the border of the annotations.
Public enumerationBorderStyle
Describes style of the annotation border.
Public enumerationCapStyle
Style of line ending of Ink annotation line.
Public enumerationCaptionPosition
Enumeration of the annotation’s caption positioning.
Public enumerationCaretSymbol
A symbol to be associated with the caret.
Public enumerationExplicitDestinationType
Enumerates the types of explicit destinations.
Public enumerationFileIcon
An icon to be used in displaying the annotation.
Public enumerationFreeTextIntent
Enumerates the intents of the free text annotation.
Public enumerationHighlightingMode
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.
Public enumerationJustification
Enumerates the forms of quadding (justification) to be used in displaying the annotation’s text.
Public enumerationLaunchActionOperation
Enumerates the operations to perform with document during launch action executing.
Public enumerationLightingSchemeType
Enum LightingSchemeType: set of lighting scheme types.
Public enumerationLineEnding
Enumerates the line ending styles to be used in drawing the line.
Public enumerationLineIntent
Enumerates the intents of the line annotation.
Public enumerationMeasureNumberFormatFractionStyle
Value which indicates in which manner fraction values are displayed.
Public enumerationPDF3DActivation
Enum PDF3DActivation: set of 3D annotation activation mode.
Public enumerationPolyIntent
Enumerates the intents of the polygon or polyline annotation.
Public enumerationPredefinedAction
Defines different actions which can be triggered from a PDF file.
Public enumerationRenderModeType
Enum RenderModeType: set of render mode types
Public enumerationReplyType
Enumerates the kinds of the relationships (the “reply type”) between the annotation and one specified by InReplyTo.
Public enumerationRichMediaAnnotationActivationEvent
Event which activates annotation.
Public enumerationRichMediaAnnotationContentType
Type of the multimedia.
Public enumerationSoundEncoding
The encoding format for the sample data.
Public enumerationSoundIcon
Enumerates the icons to be used in displaying the annotation.
Public enumerationSoundSampleDataEncodingFormat
The encoding format for the sound sample data.
Public enumerationStampIcon
Enumerates the icons to be used in displaying the annotation.
Public enumerationTextAlignment Obsolete.
Alignment of text in annotation.
Public enumerationTextIcon
Enumerates the icons to be used in displaying the annotation.