Click or drag to resize

CalloutAnnotation Properties

The CalloutAnnotation type exposes the following members.

Properties
  NameDescription
Public propertyAdditionalActions
Gets the additional actions associated with the annotation. These are generally only used by widget annotations.
(Inherited from BaseAnnotation.)
Public propertyAnnotationType
Gets the type of the original PDF annotation if this annotation was imported from a file. This is generally only useful if the annotation was a type not recognized or not currently modeled by DotPdf
(Inherited from BaseAnnotation.)
Public propertyAppearance
Gets or sets the AppearanceSet for the annotation. This property defaults to null (no appearance set).
(Inherited from BaseAnnotation.)
Public propertyAuthorName
Gets or sets the name of the author of the annotation.
(Inherited from BaseMarkupAnnotation.)
Public propertyBorder
Gets or sets the AnnotationBorder for this annotation.
(Inherited from BaseAnnotation.)
Public propertyBorderStyle
Gets or sets the BorderStyle for the annotation.
(Inherited from BaseAnnotation.)
Public propertyBounds
Gets or sets the bounding rectangle for this annotation.
(Inherited from BaseAnnotation.)
Public propertyClickActions
Gets the set of actions performed when the annotation has been clicked.
(Inherited from BaseAnnotation.)
Public propertyColor
Gets or sets the color of the annotation. The meaning of this color varies based on the annotation type. It may represent the background color of the annotation's icon (if any) when closed, the title bar of the annotation's pop-up window, the border color of the annotation.
(Inherited from BaseAnnotation.)
Public propertyContents
Gets or sets the text contents of the annotation. How contents is used depends on the annotation type. For example a StickyNoteAnnotation will use Contents to represent text the user has entered.
(Inherited from BaseAnnotation.)
Public propertyCreationDate
Gets the creation date of the annotation. When a new BaseMarkupAnnotation is constructed the CreationDate is automatically set to the current date and time. When a BaseMarkupAnnotation is read from a file, the CreationDate will reflect the date in the file.
(Inherited from BaseMarkupAnnotation.)
Public propertyDefaultAppearanceState
Gets or sets the name of the default appearance state for the annotation. In annotations that may have multiple possible states (say, "On" of "Off") this the name of the default state. In an annotation's "normal" state, this corresponds to Appearance.Normal[DefaultAppearanceState].
(Inherited from BaseAnnotation.)
Public propertyCode exampleDefaultRichTextStyleString
Gets or sets the default style string. The style string is a string that specifies the rich text style to use by default for the annotation, if using the RichTextContent property.
(Inherited from TextBoxAnnotation.)
Public propertyDefaultTextAppearance
Gets or sets the default text appearance for the annotation. If set to null, this will internally default to Helvetica 10 point.
(Inherited from TextBoxAnnotation.)
Public propertyDocumentRevision
Gets the revision of the document in which this widget was found.
(Inherited from BaseAnnotation.)
Public propertyEffect
Gets or sets the effect for the border of the annotation.
(Inherited from TextBoxAnnotation.)
Public propertyEnforceReadyOnlyWithException
Gets or sets a value indicating whether to enforce ready only with the ReadOnly propery with an exception.
(Inherited from BaseAnnotation.)
Public propertyHidden
Gets or sets a value indicating whether this BaseAnnotation is hidden. A hidden annotation is neither displayed nor printed by a viewer under any circumstances. Default is false.
(Inherited from BaseAnnotation.)
Public propertyInReplyTo
Gets or sets the BaseAnnotation that this annotation is in reply to.
(Inherited from BaseMarkupAnnotation.)
Public propertyInReplyToRelation
Gets or sets the relationship of this annotation to its InReplyTo. Default is Reply.
(Inherited from BaseMarkupAnnotation.)
Public propertyCode exampleInsetArea
Gets or sets the inset area of the annotation. This is a way of setting margins for the annotation. The InsetArea must be fully contained within the Bounds property.
(Inherited from TextBoxAnnotation.)
Public propertyIntent
Gets or sets the intent of the annotation. Set automatically where required.
(Inherited from BaseMarkupAnnotation.)
Public propertyInvisible
Gets or sets a value indicating whether this BaseAnnotation is invisible. Invisibility specifically means that if the annotation is not recognized by the viewer, then it should not be displayed, otherwise the viewer may make a substitute appearance for the annotation. Default is false.
(Inherited from BaseAnnotation.)
Public propertyIsDirty
Gets or sets a value indicating whether the annotation is dirty and in need of being written.
(Inherited from BaseAnnotation.)
Protected propertyIsParentRequired
Gets a value indicating whether this instance requires the parent property.
(Inherited from BaseAnnotation.)
Public propertyIsReadOnlyOrFieldReadOnly
Determines whether the annotation is read only if either ReadOnly is true or if this object implements IFormElement, if IsFieldReadOnly is true.
(Inherited from BaseAnnotation.)
Public propertyIsTransparent
Gets or sets a value indicating whether this instance is transparent. This is an indication that there was no Color specified for the annotation.
(Inherited from BaseAnnotation.)
Public propertyLine
Gets or sets the line for the CalloutAnnotation. There is no guidance in the PDF specification as how the line in the callout should be defined, including making lines that don't originate from the annotation. Be aware that while unusual representations may be rendered correctly, if they are moved a viewer is likely to change the location of at least the starting point.
Public propertyLineEnding
Gets or sets the line ending for the callout.
Public propertyLocked
Gets or sets a value indicating whether this BaseAnnotation is locked. A locked annotation may not be deleted or have its properties changed, but its contents (such as a form field) may still be editable.
(Inherited from BaseAnnotation.)
Public propertyModificationDate
Gets or sets the modification date for this annotation. DotPdf does not update this property. It is the client's responsibility to change it.
(Inherited from BaseAnnotation.)
Public propertyName
Gets or sets the name of the annotation. This name is meant to be a unique identifier for the annotation and may be use in scripts in PdfJavaScriptAction objects that want to find an annotation.
(Inherited from BaseAnnotation.)
Public propertyNoRotate
Gets or sets a value indicating whether the annotation should be rotated when a page is rotated. Default is false.
(Inherited from BaseAnnotation.)
Public propertyNoView
Gets or sets a value indicating whether the annotation is viewable and will interact with the user. This is different from hidden in that an annotation NoView set to true can be printed. This is a way, for example, to put watermarks on a page that only show when printed. Default is false.
(Inherited from BaseAnnotation.)
Public propertyNoZoom
Gets or sets a value indicating whether the annotation's appearance is scaled when the page is zoomed in. Default is false.
(Inherited from BaseAnnotation.)
Public propertyParentPage
Gets or sets the parent page that contains this annotation.
(Inherited from BaseAnnotation.)
Public propertyPopup
Gets or sets the a popup annotation for this annotation. A popup annotation can either be hidden or shown and allows extra information about an annotation to be shown. When adding a popup annotation to another annotation, the popup will need to be added to the same Annotations collection. When attached to a BaseMarkupAnnotation, the PopupAnnotation will project the text content and author of the BaseMarkupAnnotation.
(Inherited from BaseMarkupAnnotation.)
Public propertyPrint
Gets or sets a value indicating whether this BaseAnnotation is printed. Default is false.
(Inherited from BaseAnnotation.)
Public propertyReadOnly
Gets or sets a value indicating whether the annotation can interact with the user. Default is false.
(Inherited from BaseAnnotation.)
Public propertyRichTextContent
The Contents property can also be represented as rich text. Rich text is content that may include a subset of XHTML markup include body, p, i, b, and span tags. When setting the RichTextContent property, you should also set the Contents property to the plain text equivalent with no markup.
(Inherited from BaseMarkupAnnotation.)
Public propertyTextAlignment
Gets or sets the text alignment.
(Inherited from TextBoxAnnotation.)
Public propertyToggleNoView
Gets or sets a value indicating whether to toggle the sense of the NoView property. This might be used to make an annotation visible when the mouse enters it.
(Inherited from BaseAnnotation.)
Public propertyTransparency
Gets or sets the transparency of the annotation. 1.0 means fully transparent and 0.0 means fully opaque. Default is 0.
(Inherited from BaseMarkupAnnotation.)
Top
See Also