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

ClassDescription
ActionCollectionCollection of actions
AnnotationClass representing annotation object.
AnnotationActionCollectionRepresents the collection of annotation actions.
AnnotationCollectionClass representing annotation collection.
AnnotationSelectorThis class is used for selecting annotations using Visitor template idea.
AppearanceDictionaryAnnotation appearance dictionary specifying how the annotation shall be presented visually on the page.
BorderClass representing characteristics of annotation border.
CaretAnnotationClass representing Caret annotation.
CharacteristicsRepresents annotation characteristics
CircleAnnotationClass representing Circle annotation.
ColorBarAnnotationClass representing ColorBarAnnotation annotation. Property Color ignored, instead used ColorsOfCMYK color. On creation, the ratio of width and height determines the orientation of the annotation - horizontal or vertical. Next, it checks that the annotation rectangle is outside the TrimBox, and if not, then it is shifted to the nearest location outside the TrimBox, taking into account the orientation of the annotation. It is possible to reduce the width (height) so that the annotation fits outside the TrimBox. If there is no space for the layout, the width/height can be set to zero (in this case, the annotation is present on the page, but not displayed).
CommonFigureAnnotationAbstract class representing common figure annotation.
CustomExplicitDestinationRepresents custom explicit destination.
DashClass representing line dash pattern.
DefaultAppearanceDescribes default appearance of field (font, text size and color).
DocumentActionCollectionClass describes actions performed on some actions with document
ExplicitDestinationRepresents the base class for explicit destinations in PDF document.
FdfReaderClass which performes reading of FDF format.
FileAttachmentAnnotationClass describes file attachment annotation.
FitBExplicitDestinationRepresents 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.
FitBHExplicitDestinationRepresents 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.
FitBVExplicitDestinationRepresents 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.
FitExplicitDestinationRepresents 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.
FitHExplicitDestinationRepresents 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.
FitRExplicitDestinationRepresents 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.
FitVExplicitDestinationRepresents 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.
FixedPrintRepresent Fixed print data of Watermark Annotation.
FreeTextAnnotationRepresents 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.
GoToActionRepresents a go-to action that changes the view to a specified destination (page, location, and magnification factor).
GoToRemoteActionRepresents 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.
GoToURIActionRepresents a URI action causes a URI to be resolved.
HideActionRepresents a hide action that hides or shows one or more annotations on the screen by setting or clearing their Hidden flags.
HighlightAnnotationRepresents a highlight annotation that highlights a range of text in the document.
ImportDataActionUpon invocation of an import-data action, Forms Data Format (FDF) data shall be imported into the document’s interactive form from a specified file.
InkAnnotationRepresents a freehand “scribble” composed of one or more disjoint paths.
JavascriptActionClass representing javascript action.
LaunchActionRepresents a launch action that launches an application or opens or prints a document.
LineAnnotationClass representing line annotation.
LinkAnnotationRepresents either a hypertext link to a destination elsewhere in the document or an action to be performed.
MarkupAnnotationAbstract class representing markup annotation.
MeasureClass which describes Measure coordinate system.
MediaClipClass describes media clip object of rendition.
MediaClipDataClass describes media clip data.
MediaClipSectionThis class descibes Media clip section.
MediaRenditionClass describes media rendition.
MovieAnnotationRepresents 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.
NamedActionRepresents named actions that PDF viewer applications are expected to support.
NamedDestinationInstead 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.
PDF3DAnnotationClass PDF3DAnnotation. This class cannot be inherited.
PDF3DArtworkClass PDF3DArtwork.
PDF3DContentClass PDF3DContent.
PDF3DCrossSectionClass PDF3DCrossSection.
PDF3DCrossSectionArrayClass PDF3DCrossSectionArray.
PDF3DCuttingPlaneOrientationClass PDF3DCuttingPlaneOrientation.
PDF3DLightingSchemeClass PDF3DLightingScheme.
PDF3DRenderModeClass PDF3DRenderMode.
PDF3DStreamClass PDF3DStream.
PDF3DViewClass PDF3DView.
PDF3DViewArrayClass PDF3DViewArray.
PdfActionRepresents Action in PDF document
PdfActionCollectionClass describes list of actions.
PolyAnnotationAbstract base class for poly- annotations.
PolygonAnnotationClass representing polygon annotation.
PolylineAnnotationRepresents polyline annotation that is similar to polygon, except that the first and last vertex are not implicitly connected.
PopupAnnotationRepresents the pop-up annotation that displays text in a pop-up window for entry and editing.
PrinterMarkAnnotationAbstract class representing printer mark annotation.
RedactionAnnotationRepresents Redact annotation.
RenditionClass which describes rendition object of RendtionAnnotation.
RenditionActionA rendition action that controls the playing of multimedia content.
RichMediaAnnotationClass describes RichMediaAnnotation which allows embed video/audio data into PDF document.
ScreenAnnotationA screen annotation that specifies a region of a page upon which media clips may be played.
SelectorRenditionClass describes selector rendition.
SoundAnnotationRepresents a sound annotation that contains sound recorded from the computer�s microphone or imported from a file.
SoundDataRepresents a sound data defining the sound to be played when the annotation is activated.
SoundSampleDataRepresents additional entries specific to a sound object (Section 9.2 PDF1-7)
SquareAnnotationClass representing square annotation.
SquigglyAnnotationRepresents the squiggly annotation that appears as a jagged underline in the text of a document.
StampAnnotationRepresents 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.
StrikeOutAnnotationRepresents a strikeout annotation that appears as a strikeout in the text of the document.
SubmitFormActionClass which describes submit-form action.
TextAnnotationRepresents a text annotation that is a �sticky note� attached to a point in the PDF document.
TextMarkupAnnotationAbstract base class for text markup annotations.
TextStyleClass represents style of text in annotation
UnderlineAnnotationRepresents an underline annotation that appears as an underline in the text of the document.
WatermarkAnnotationClass describes Watermark annotation object.
WidgetAnnotationClass representing widget annotation.
XfdfReaderClass which peroformes reading of XFDF format.
XYZExplicitDestinationRepresents 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
IAnnotationVisitorDefines Visitor for visiting different document annotations.
IAppointmentRepresents general interface for actions and destinations.

Enumeration

EnumerationDescription
AnnotationFlagsA set of flags specifying various characteristics of the annotation.
AnnotationStateThe enumeration of states to which the original annotation can be set.
AnnotationStateModelThe state model corresponding to state of annotation.
AnnotationTypeEnumeration of annotation types.
BorderEffectDescribes effect which should be applied to the border of the annotations.
BorderStyleDescribes style of the annotation border.
CapStyleStyle of line ending of Ink annotation line.
CaptionPositionEnumeration of the annotation�s caption positioning.
CaretSymbolA symbol to be associated with the caret.
ColorsOfCMYKColors included in the CMYK color model.
ExplicitDestinationTypeEnumerates the types of explicit destinations.
FileIconAn icon to be used in displaying the annotation.
FreeTextIntentEnumerates the intents of the free text annotation.
HighlightingModeEnumerates the annotation�s highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area.
JustificationEnumerates the forms of quadding (justification) to be used in displaying the annotation�s text.
LaunchActionOperationEnumerates the operations to perform with document during launch action executing.
LightingSchemeTypeEnum LightingSchemeType: set of lighting scheme types.
LineEndingEnumerates the line ending styles to be used in drawing the line.
LineIntentEnumerates the intents of the line annotation.
PDF3DActivationEnum PDF3DActivation: set of 3D annotation activation mode.
PolyIntentEnumerates the intents of the polygon or polyline annotation.
PredefinedActionDefines different actions which can be triggered from a PDF file.
RenderModeTypeEnum RenderModeType: set of render mode types
RenditionOperationThe operation to perform when the action is triggered.
RenditionTypeEnumeration describes possible types of Rendition.
ReplyTypeEnumerates the kinds of the relationships (the “reply type”) between the annotation and one specified by InReplyTo.
SoundEncodingThe encoding format for the sample data.
SoundIconEnumerates the icons to be used in displaying the annotation.
SoundSampleDataEncodingFormatThe encoding format for the sound sample data.
StampIconEnumerates the icons to be used in displaying the annotation.
TextIconEnumerates the icons to be used in displaying the annotation.