BaseAnnotation Properties |
The BaseAnnotation type exposes the following members.
Name | Description | |
---|---|---|
AdditionalActions |
Gets the additional actions associated with the annotation. These are generally only used by widget annotations.
| |
AnnotationType |
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
| |
Appearance |
Gets or sets the AppearanceSet for the annotation. This property defaults to null (no appearance set).
| |
Border |
Gets or sets the AnnotationBorder for this annotation.
| |
BorderStyle |
Gets or sets the BorderStyle for the annotation.
| |
Bounds |
Gets or sets the bounding rectangle for this annotation.
| |
ClickActions |
Gets the set of actions performed when the annotation has been clicked.
| |
Color |
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.
| |
Contents |
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.
| |
DefaultAppearanceState |
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].
| |
DocumentRevision |
Gets the revision of the document in which this widget was found.
| |
EnforceReadyOnlyWithException |
Gets or sets a value indicating whether to enforce ready only with the ReadOnly propery with an exception.
| |
Hidden |
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.
| |
Invisible |
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.
| |
IsDirty |
Gets or sets a value indicating whether the annotation is dirty and in need of being written.
| |
IsParentRequired |
Gets a value indicating whether this instance requires the parent property.
| |
IsReadOnlyOrFieldReadOnly |
Determines whether the annotation is read only if either ReadOnly is true or if
this object implements IFormElement, if
IsFieldReadOnly is true.
| |
IsTransparent |
Gets or sets a value indicating whether this instance is transparent. This is an indication that there was
no Color specified for the annotation.
| |
Locked |
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.
| |
ModificationDate |
Gets or sets the modification date for this annotation. DotPdf does not update this property.
It is the client's responsibility to change it.
| |
Name |
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.
| |
NoRotate |
Gets or sets a value indicating whether the annotation should be rotated when a page is rotated. Default is false.
| |
NoView |
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.
| |
NoZoom |
Gets or sets a value indicating whether the annotation's appearance is scaled when the page is zoomed in. Default is false.
| |
ParentPage |
Gets or sets the parent page that contains this annotation.
| |
Gets or sets a value indicating whether this BaseAnnotation is printed. Default is false.
| ||
ReadOnly |
Gets or sets a value indicating whether the annotation can interact with the user. Default is false.
| |
ToggleNoView |
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.
|