Aspose::Pdf::Annotations Namespace Reference

Namespaces

 JavascriptExtensions
 

Classes

class  ActionCollection
 Collection of actions More...
 
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  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  ColorBarAnnotation
 Class 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). More...
 
class  ColorsOfCMYKConverter
 
class  CommonFigureAnnotation
 Abstract class representing common figure annotation. More...
 
class  CustomExplicitDestination
 Represents custom explicit destination. More...
 
class  Dash
 Class representing line dash pattern. More...
 
class  DefaultAppearance
 Describes default appearance of field (font, text size and color). More...
 
class  DocumentActionCollection
 Class describes actions performed on some actions with document More...
 
class  ExplicitDestination
 Represents the base class for explicit destinations in PDF document. More...
 
class  ExplicitDestinationTypeConverter
 
class  FdfReader
 Class which performes reading of FDF format. More...
 
class  FileAttachmentAnnotation
 Class describes file attachment annotation. More...
 
class  FileIconConverter
 
class  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. More...
 
class  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. More...
 
class  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. More...
 
class  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. More...
 
class  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. More...
 
class  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. More...
 
class  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. More...
 
class  FixedPrint
 Represent Fixed print data of Watermark Annotation. More...
 
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  GoToAction
 Represents a go-to action that changes the view to a specified destination (page, location, and magnification factor). More...
 
class  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. More...
 
class  GoToURIAction
 Represents a URI action causes a URI to be resolved. More...
 
class  HideAction
 Represents a hide action that hides or shows one or more annotations on the screen by setting or clearing their Hidden flags. More...
 
class  HighlightAnnotation
 Represents a highlight annotation that highlights a range of text in the document. More...
 
class  HighlightingModeConverter
 
class  IAnnotationVisitor
 Defines Visitor for visiting different document annotations. More...
 
class  IAppointment
 Represents general interface for actions and destinations. More...
 
class  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. More...
 
class  InkAnnotation
 Represents a freehand "scribble" composed of one or more disjoint paths. More...
 
class  JavascriptAction
 Class representing javascript action. More...
 
class  JustificationConverter
 
class  LaunchAction
 Represents a launch action that launches an application or opens or prints a document. More...
 
class  LaunchActionOperationConverter
 
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  MediaClip
 Class describes media clip object of rendition. More...
 
class  MediaClipData
 Class describes media clip data. More...
 
class  MediaClipSection
 This class descibes Media clip section. More...
 
class  MediaRendition
 Class describes media rendition. 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  NamedAction
 Represents named actions that PDF viewer applications are expected to support. More...
 
class  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. More...
 
class  PDF3DAnnotation
 Class PDF3DAnnotation. This class cannot be inherited. More...
 
class  PDF3DArtwork
 Class PDF3DArtwork. More...
 
class  PDF3DContent
 Class PDF3DContent. More...
 
class  PDF3DCrossSection
 Class PDF3DCrossSection. More...
 
class  PDF3DCrossSectionArray
 Class PDF3DCrossSectionArray. More...
 
class  PDF3DCuttingPlaneOrientation
 Class PDF3DCuttingPlaneOrientation. More...
 
class  PDF3DLightingScheme
 Class PDF3DLightingScheme. More...
 
class  PDF3DRenderMode
 Class PDF3DRenderMode. More...
 
class  PDF3DStream
 Class PDF3DStream. More...
 
class  PDF3DView
 Class PDF3DView. More...
 
class  PDF3DViewArray
 Class PDF3DViewArray. More...
 
class  PdfAction
 Represents Action in PDF document More...
 
class  PdfActionCollection
 Class describes list of actions. 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  PredefinedActionConverter
 
class  PrinterMarkAnnotation
 Abstract class representing printer mark annotation. More...
 
class  RedactionAnnotation
 Represents Redact annotation. More...
 
class  Rendition
 Class which describes rendition object of RendtionAnnotation. More...
 
class  RenditionAction
 A rendition action that controls the playing of multimedia content. More...
 
class  ReplyTypeConverter
 
class  RichMediaAnnotation
 Class describes RichMediaAnnotation which allows embed video/audio data into PDF document. More...
 
class  ScreenAnnotation
 A screen annotation that specifies a region of a page upon which media clips may be played. More...
 
class  SelectorRendition
 Class describes selector rendition. More...
 
class  SoundAnnotation
 Represents a sound annotation that contains sound recorded from the computer�s microphone or imported from a file. More...
 
class  SoundData
 Represents a sound data defining the sound to be played when the annotation is activated. 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  SubmitFormAction
 Class which describes submit-form action. 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  WatermarkAnnotation
 Class describes Watermark annotation object. More...
 
class  WidgetAnnotation
 Class representing widget annotation. More...
 
class  XfdfReader
 Class which peroformes reading of XFDF format. More...
 
class  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. 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::RichMedia, AnnotationType::Unknown, AnnotationType::PDF3D,
  AnnotationType::ColorBar
}
 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  ColorsOfCMYK { ColorsOfCMYK::Cyan, ColorsOfCMYK::Magenta, ColorsOfCMYK::Yellow, ColorsOfCMYK::Black }
 Colors included in the CMYK color model. 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  PDF3DActivation { PDF3DActivation::activeWhenOpen, PDF3DActivation::activeWhenVisible, PDF3DActivation::activatedUserOrScriptAction }
 Enum PDF3DActivation: set of 3D annotation activation mode. More...
 
enum  LightingSchemeType {
  LightingSchemeType::Artwork, LightingSchemeType::None, LightingSchemeType::White, LightingSchemeType::Day,
  LightingSchemeType::Night, LightingSchemeType::Hard, LightingSchemeType::Primary, LightingSchemeType::Blue,
  LightingSchemeType::Red, LightingSchemeType::Cube, LightingSchemeType::CAD, LightingSchemeType::Headlamp
}
 Enum LightingSchemeType: set of lighting scheme types. More...
 
enum  RenderModeType {
  RenderModeType::Solid, RenderModeType::SolidWireframe, RenderModeType::Transparent, RenderModeType::TransparentWareFrame,
  RenderModeType::BoundingBox, RenderModeType::TransparentBoundingBox, RenderModeType::TransparentBoundingBoxOutline, RenderModeType::Wireframe,
  RenderModeType::ShadedWireframe, RenderModeType::Vertices, RenderModeType::ShadedVertices, RenderModeType::Illustration,
  RenderModeType::SolidOutline, RenderModeType::ShadedIllustration
}
 Enum RenderModeType: set of render mode types More...
 
enum  PolyIntent { PolyIntent::Undefined, PolyIntent::PolygonCloud, PolyIntent::PolyLineDimension, PolyIntent::PolygonDimension }
 Enumerates the intents of the polygon or polyline annotation. More...
 
enum  RenditionOperation {
  RenditionOperation::PlayStop = 0, RenditionOperation::Stop = 1, RenditionOperation::Pause = 2, RenditionOperation::Resume = 3,
  RenditionOperation::PlayResume = 4, RenditionOperation::Undefined = -1
}
 The operation to perform when the action is triggered. More...
 
enum  RenditionType { RenditionType::Media, RenditionType::Selector, RenditionType::Undefined }
 Enumeration describes possible types of Rendition. 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...
 
enum  ExplicitDestinationType {
  ExplicitDestinationType::XYZ, ExplicitDestinationType::Fit, ExplicitDestinationType::FitH, ExplicitDestinationType::FitV,
  ExplicitDestinationType::FitR, ExplicitDestinationType::FitB, ExplicitDestinationType::FitBH, ExplicitDestinationType::FitBV
}
 Enumerates the types of explicit destinations. More...
 
enum  HighlightingMode {
  HighlightingMode::None, HighlightingMode::Invert, HighlightingMode::Outline, HighlightingMode::Push,
  HighlightingMode::Toggle
}
 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. More...
 
enum  Justification { Justification::Left = 0, Justification::Center = 1, Justification::Right = 2 }
 Enumerates the forms of quadding (justification) to be used in displaying the annotation�s text. More...
 
enum  LaunchActionOperation { LaunchActionOperation::Undefined, LaunchActionOperation::Open, LaunchActionOperation::Print }
 Enumerates the operations to perform with document during launch action executing. More...
 
enum  PredefinedAction {
  PredefinedAction::FirstPage, PredefinedAction::LastPage, PredefinedAction::NextPage, PredefinedAction::PrevPage,
  PredefinedAction::PrintDialog, PredefinedAction::Print, PredefinedAction::Bookmarks_ExpanCurrentBookmark, PredefinedAction::Bookmarks_HightlightCurrentBookmark,
  PredefinedAction::Document_AttachFile, PredefinedAction::Document_CropPages, PredefinedAction::Document_DeletePages, PredefinedAction::Document_ExtractPages,
  PredefinedAction::Document_InsertPages, PredefinedAction::Document_ReplacePages, PredefinedAction::Document_RotatePages, PredefinedAction::Edit_CheckSpelling_InComFieldEdit,
  PredefinedAction::Edit_Find, PredefinedAction::Edit_Preferences, PredefinedAction::Edit_Search, PredefinedAction::File_AttachToEmail,
  PredefinedAction::File_Close, PredefinedAction::File_CreatePDF_FromScanner, PredefinedAction::File_CreatePDF_FromWebPage, PredefinedAction::File_Exit,
  PredefinedAction::File_Organizer_OpenOrganizer, PredefinedAction::File_Print, PredefinedAction::File_Properties, PredefinedAction::File_SaveAs,
  PredefinedAction::Miscellaneous_ZoomIn, PredefinedAction::Miscellaneous_ZoomOut, PredefinedAction::PageImages_PrintPages, PredefinedAction::View_GoTo_NextView,
  PredefinedAction::View_GoTo_Page, PredefinedAction::View_GoTo_PreDocument, PredefinedAction::View_GoTo_PreView, PredefinedAction::View_NavigationPanels_Articles,
  PredefinedAction::View_NavigationPanels_Attachments, PredefinedAction::View_NavigationPanels_Boomarks, PredefinedAction::View_NavigationPanels_Comments, PredefinedAction::View_NavigationPanels_Fields,
  PredefinedAction::View_NavigationPanels_Layers, PredefinedAction::View_NavigationPanels_ModelTree, PredefinedAction::View_NavigationPanels_Pages, PredefinedAction::View_NavigationPanels_Signatures,
  PredefinedAction::View_PageDisplay_SinglePage, PredefinedAction::View_PageDisplay_SinglePageContinuous, PredefinedAction::View_PageDisplay_TwoUp, PredefinedAction::View_PageDisplay_TwoUpContinuous,
  PredefinedAction::View_Toolbars_AdvanceEditing, PredefinedAction::View_Toolbars_CommentMarkup, PredefinedAction::View_Toolbars_Edit, PredefinedAction::View_Toolbars_File,
  PredefinedAction::View_Toolbars_Find, PredefinedAction::View_Toolbars_Forms, PredefinedAction::View_Toolbars_Measuring, PredefinedAction::View_Toolbars_ObjectData,
  PredefinedAction::View_Toolbars_PageDisplay, PredefinedAction::View_Toolbars_PageNavigation, PredefinedAction::View_Toolbars_PrintProduction, PredefinedAction::View_Toolbars_PropertiesBar,
  PredefinedAction::View_Toolbars_Redaction, PredefinedAction::View_Toolbars_SelectZoom, PredefinedAction::View_Toolbars_Tasks, PredefinedAction::View_Toolbars_Typewriter,
  PredefinedAction::View_Zoom_ActualSize, PredefinedAction::View_Zoom_FitHeight, PredefinedAction::View_Zoom_FitPage, PredefinedAction::View_Zoom_FitVisible,
  PredefinedAction::View_Zoom_FitWidth, PredefinedAction::View_Zoom_ZoomTo, PredefinedAction::Window_FullScreenMode
}
 Defines different actions which can be triggered from a PDF file. More...
 

Functions

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

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.

RichMedia 

Rich media annotation type

Unknown 

Unknown annotation.

PDF3D 

3D annotation.

ColorBar 

ColorBar 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.

◆ ColorsOfCMYK

Colors included in the CMYK color model.

Enumerator
Cyan 

Cyan color.

Magenta 

Magenta color.

Yellow 

Yellow color.

Black 

Black color.

◆ ExplicitDestinationType

Enumerates the types of explicit destinations.

Enumerator
XYZ 

Display 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.

Fit 

Display 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.

FitH 

Display 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.

FitV 

Display 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.

FitR 

Display 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.

FitB 

Display 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.

FitBH 

Display 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.

FitBV 

Display 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.

◆ 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.

◆ 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.

Enumerator
None 

No highlighting.

Invert 

Invert the contents of the annotation rectangle.

Outline 

Invert the annotation�s border.

Push 

Display the annotation�s down appearance, if any. If no down appearance is defined, offset the contents of the annotation rectangle to appear as if it were being pushed below the surface of the page.

Toggle 

Same as Push (which is preferred).

◆ Justification

Enumerates the forms of quadding (justification) to be used in displaying the annotation�s text.

Enumerator
Left 

Left justification.

Center 

Center justification.

Right 

Right justification.

◆ LaunchActionOperation

Enumerates the operations to perform with document during launch action executing.

Enumerator
Undefined 

Undefined state.

Open 

Open a document.

Print 

Print a document.

◆ LightingSchemeType

Enum LightingSchemeType: set of lighting scheme types.

Enumerator
Artwork 

The "Artwork" lighting scheme.

None 

The "None" lighting scheme.

White 

The "White" lighting scheme.

Day 

The "Day" lighting scheme.

Night 

The "Night" lighting scheme.

Hard 

The "Hard" lighting scheme.

Primary 

The "Primary" lighting scheme.

Blue 

The "Blue" lighting scheme.

Red 

The "Red" lighting scheme.

Cube 

The "Cube" lighting scheme.

CAD 

The "Cad" lighting scheme.

Headlamp 

The "Headlamp" lighting scheme.

◆ 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.

◆ PDF3DActivation

Enum PDF3DActivation: set of 3D annotation activation mode.

Enumerator
activeWhenOpen 

The active when open

activeWhenVisible 

The active when visible

activatedUserOrScriptAction 

The activated by user or script action

◆ 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.

◆ PredefinedAction

Defines different actions which can be triggered from a PDF file.

Enumerator
FirstPage 

A named action to go to the first page.

LastPage 

A named action to go to the last page.

NextPage 

A named action to go to the next page.

PrevPage 

A named action to go to the previous page.

PrintDialog 

A named action to open a print dialog (JavaScript).

Print 

A named action to open a print dialog.

Bookmarks_ExpanCurrentBookmark 

A named action to find current bookmark.

Bookmarks_HightlightCurrentBookmark 

A named action to highlight current bookmark.

Document_AttachFile 

A named action to add file attachment.

Document_CropPages 

A named action to crop document pages.

Document_DeletePages 

A named action to delete document pages.

Document_ExtractPages 

A named action to exctract document pages.

Document_InsertPages 

A named action to insert pages from a document.

Document_ReplacePages 

A named action to replace document pages.

Document_RotatePages 

A named action to rotate document pages.

Edit_CheckSpelling_InComFieldEdit 

A named action to check spelling in comments.

Edit_Find 

A named action to find.

Edit_Preferences 

A named action to edit preferences.

Edit_Search 

A named action for searching.

File_AttachToEmail 

A named action for attaching current pdf document into email message.

File_Close 

A named action to close the document.

File_CreatePDF_FromScanner 

A named action to create pdf document from scanner.

File_CreatePDF_FromWebPage 

A named action to create pdf document from web page.

File_Exit 

A named action to exit pdf reader.

File_Organizer_OpenOrganizer 

A named action to open organizer.

File_Print 

A named action to print the document.

File_Properties 

A named action to open the document properties.

File_SaveAs 

A named action to save the document with another name.

Miscellaneous_ZoomIn 

A named action to zoom in the document.

Miscellaneous_ZoomOut 

A named action to zoom out the document.

PageImages_PrintPages 

A named action to print the document pages.

View_GoTo_NextView 

A named action to go to the next view.

View_GoTo_Page 

A named action to go to the certain page.

View_GoTo_PreDocument 

A named action to go to the previous document.

View_GoTo_PreView 

A named action to go to the previous view.

View_NavigationPanels_Articles 

A named action to show/hide articles panel.

View_NavigationPanels_Attachments 

A named action to show/hide attachment panel.

View_NavigationPanels_Boomarks 

A named action to show/hide bookmark panel.

View_NavigationPanels_Comments 

A named action to show/hide comments panel.

View_NavigationPanels_Fields 

A named action to show/hide fields panel.

View_NavigationPanels_Layers 

A named action to show/hide layers panel.

View_NavigationPanels_ModelTree 

A named action to show/hide model tree panel.

View_NavigationPanels_Pages 

A named action to show/hide pages panel.

View_NavigationPanels_Signatures 

A named action to show/hide signatures panel.

View_PageDisplay_SinglePage 

A named action to display single page.

View_PageDisplay_SinglePageContinuous 

A named action to display single continious page.

View_PageDisplay_TwoUp 

A named action to display pages as Two-Up.

View_PageDisplay_TwoUpContinuous 

A named action to display pages as Two-Up continious.

View_Toolbars_AdvanceEditing 

A named action to show/hide advanced editing toolbar.

View_Toolbars_CommentMarkup 

A named action to show/hide commenting toolbar.

View_Toolbars_Edit 

A named action to show/hide edit toolbar.

View_Toolbars_File 

A named action to show/hide file toolbar.

View_Toolbars_Find 

A named action to show/hide find toolbar.

View_Toolbars_Forms 

A named action to show/hide forms toolbar.

View_Toolbars_Measuring 

A named action to show/hide measuring toolbar.

View_Toolbars_ObjectData 

A named action to show/hide object data toolbar.

View_Toolbars_PageDisplay 

A named action to show/hide page display toolbar.

View_Toolbars_PageNavigation 

A named action to show/hide navigation toolbar.

View_Toolbars_PrintProduction 

A named action to show/hide print production toolbar.

View_Toolbars_PropertiesBar 

A named action to show/hide property toolbar.

View_Toolbars_Redaction 

A named action to show/hide redaction toolbar.

View_Toolbars_SelectZoom 

A named action to show/hide select & zoom toolbar.

View_Toolbars_Tasks 

A named action to show/hide tasks toolbar.

View_Toolbars_Typewriter 

A named action to show/hide typewriter toolbar.

View_Zoom_ActualSize 

A named action to view pages in actual size.

View_Zoom_FitHeight 

A named action to fit page on height.

View_Zoom_FitPage 

A named action to fit page.

View_Zoom_FitVisible 

A named action to fit page visibility.

View_Zoom_FitWidth 

A named action to fit page on width.

View_Zoom_ZoomTo 

A named action to make zoom.

Window_FullScreenMode 

A named action to view the document in the full screen mode.

◆ RenderModeType

Enum RenderModeType: set of render mode types

Enumerator
Solid 

The "Solid" render mode.

SolidWireframe 

The "SolidWireFrame" render mode.

Transparent 

The "Transparent" render mode.

TransparentWareFrame 

The "TransparentWareFrame" render mode.

BoundingBox 

The "BoundingBox" render mode.

TransparentBoundingBox 

The "TransparentBoundingBox" render mode.

TransparentBoundingBoxOutline 

The "TransparentBoundingBoxOutline" render mode.

Wireframe 

The "WireFrame" render mode.

ShadedWireframe 

The "ShadedWireFrame" render mode.

Vertices 

The "Vertices" render mode.

ShadedVertices 

The "ShadedVertices" render mode.

Illustration 

The "Illustration" render mode.

SolidOutline 

The "SolidOutline" render mode.

ShadedIllustration 

The "ShadedIllustration" render mode.

◆ RenditionOperation

The operation to perform when the action is triggered.

Enumerator
PlayStop 

If no rendition is associated with the annotation, play the specified rendition, associating it with the annotation. If a rendition is already associated with the annotation, it shall be stopped, and the new rendition shall be associated with the annotation.

Stop 

Stop any rendition being played in association with the annotation.

Pause 

Pause any rendition being played in association with the annotation.

Resume 

Resume any rendition being played in association with the annotation.

PlayResume 

Play the specified rendition, associating it with the annotation. If a rendition is already associated with the annotation, resume the rendition if it is paused.

Undefined 

Operation not defined.

◆ RenditionType

Enumeration describes possible types of Rendition.

Enumerator
Media 

Media rendition object.

Selector 

Selector rendition object.

Undefined 

Rendition type is undefined.

◆ 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.

Deprecated:
Use Aspose.Pdf.HorizontalAlignment type
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::Annotations::DECLARE_ENUM_OPERATORS ( Aspose::Pdf::Annotations::AnnotationFlags  )