RedactionProposalAnnotation 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 name of the author of the annotation.

Gets or sets a value indicating whether to auto generate a basic appearance for the proposed redaction. Generation of the appearance happens when the document is saved.

Gets or sets the AnnotationBorder for this annotation.

Gets or sets the BorderStyle for the annotation.

Gets or sets the bounding rectangle for this annotation.

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

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 for the annotation. If set to null, this will internally default to Helvetica 10 point.

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 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 BaseAnnotation that this annotation is in reply to.

Gets or sets the relationship of this annotation to its InReplyTo. Default is Reply.

Gets or sets the intent of the annotation. Set automatically where required.

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 the OverlayText, if present, will be repeated.

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 overlay text that will be used on the redaction when placed.

Gets or sets the parent page that contains this annotation.

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.

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 the color of the interior of the redacted area. If not set, the redacted area will be transparent.

Gets or sets the name of a template resource to be used when the redaction is applied. If specified, this template will take precedence over all other appearance related properties.

Gets the regions for this annotation. Regions represents a set of quadrilaterals each of which represent the area covered by the annotation. Typically, parts of the annotation are drawn through sections of the quatrilateral. For example, underlines are drawn across the bottom of the annotation, strike outs through the middle.

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.

Gets or sets the text alignment.

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 or sets the transparency of the annotation. 1.0 means fully transparent and 0.0 means fully opaque. Default is 0.