BaseWidgetAnnotation Properties

Gets the additional actions associated with the annotation. These are generally only used by widget annotations.

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

Gets or sets the AppearanceSet for the annotation. This property defaults to null (no appearance set).

Gets or sets the color of the background.

Gets or sets the AnnotationBorder for this annotation.

Gets or sets the color of the border.

Gets or sets the BorderStyle for the annotation.

Gets or sets the bounding rectangle for this annotation.

Gets the child fields for this annotation. This will always be null in a BaseWidgetAnnotation

Gets the set of actions performed when the annotation has been clicked.

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.

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.

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

Gets or sets the default text appearance.

Gets the default value as string.

Gets the revision of the document in which this widget was found.

Gets or sets a value indicating whether to enforce ready only with the ReadOnly propery with an exception.

Gets or sets the field alternate description for display in the UI.

Gets the fully qualified name of the field. This value is only correct if ParentField has been set. When the parent chain is properly set up, this will return ParentField.FieldFullName + '.' + FieldName

Gets or sets the name of the field.

Gets or sets the field name for export. When data from a form is aggregated, if FieldNameForExport is non-null, it will be used in place of FieldName. This allows you to have field values mapped to a different name which may be more suitable for a data collection application.

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.

Gets or sets the highlight appearance.

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.

Gets or sets a value indicating whether the annotation is dirty and in need of being written.

Gets or sets a value indicating whether this field should not be export.

Gets or sets a value indicating whether this field is read only.

Gets or sets a value indicating whether this field is required.

Gets a value indicating whether this instance requires the parent property.

Determines whether the annotation is read only if either ReadOnly is true or if this object implements IFormElement, if IsFieldReadOnly is true.

Gets or sets a value indicating whether this instance is transparent. This is an indication that there was no Color specified for the annotation.

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.

Gets or sets the modification date for this annotation. DotPdf does not update this property. It is the client's responsibility to change it.

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.

Gets or sets a value indicating whether the annotation should be rotated when a page is rotated. Default is false.

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.

Gets or sets a value indicating whether the annotation's appearance is scaled when the page is zoomed in. Default is false.

Gets or sets the parent field. When the document is saved, this will be set for you if you haven't set it yourself.

Gets or sets the parent page that contains this annotation.

Gets or sets a value indicating whether this BaseAnnotation is printed. Default is false.

Gets or sets a value indicating whether the annotation can interact with the user. Default is false.

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.

Gets the value as string.