RedactionProposalAnnotation Class |
Namespace: Atalasoft.PdfDoc.Generating.Annotations
The RedactionProposalAnnotation type exposes the following members.
Name | Description | |
---|---|---|
RedactionProposalAnnotation |
Initializes a new instance of the RedactionProposalAnnotation class with empty bounds.
| |
RedactionProposalAnnotation(PdfBounds) |
Initializes a new instance of the RedactionProposalAnnotation class.
|
Name | Description | |
---|---|---|
AdditionalActions |
Gets the additional actions associated with the annotation. These are generally only used by widget annotations.
(Inherited from BaseAnnotation.) | |
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
(Inherited from BaseAnnotation.) | |
Appearance |
Gets or sets the AppearanceSet for the annotation. This property defaults to null (no appearance set).
(Inherited from BaseAnnotation.) | |
AuthorName |
Gets or sets the name of the author of the annotation.
(Inherited from BaseMarkupAnnotation.) | |
AutoGenerateBasicAppearance |
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.
| |
Border |
Gets or sets the AnnotationBorder for this annotation.
(Inherited from BaseAnnotation.) | |
BorderStyle |
Gets or sets the BorderStyle for the annotation.
(Inherited from BaseAnnotation.) | |
Bounds |
Gets or sets the bounding rectangle for this annotation.
(Inherited from BaseAnnotation.) | |
ClickActions |
Gets the set of actions performed when the annotation has been clicked.
(Inherited from BaseAnnotation.) | |
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.
(Inherited from BaseAnnotation.) | |
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.
(Inherited from BaseAnnotation.) | |
CreationDate |
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.) | |
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].
(Inherited from BaseAnnotation.) | |
DefaultTextAppearance |
Gets or sets the default text appearance for the annotation. If set to null, this will internally default to
Helvetica 10 point.
| |
DocumentRevision |
Gets the revision of the document in which this widget was found.
(Inherited from BaseAnnotation.) | |
EnforceReadyOnlyWithException |
Gets or sets a value indicating whether to enforce ready only with the ReadOnly propery with an exception.
(Inherited from BaseAnnotation.) | |
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.
(Inherited from BaseAnnotation.) | |
InReplyTo |
Gets or sets the BaseAnnotation that this annotation is in reply to.
(Inherited from BaseMarkupAnnotation.) | |
InReplyToRelation | (Inherited from BaseMarkupAnnotation.) | |
Intent |
Gets or sets the intent of the annotation. Set automatically where required.
(Inherited from BaseMarkupAnnotation.) | |
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.
(Inherited from BaseAnnotation.) | |
IsDirty |
Gets or sets a value indicating whether the annotation is dirty and in need of being written.
(Inherited from BaseAnnotation.) | |
IsOverlayTextRepeated |
Gets or sets a value indicating whether the OverlayText, if present, will be repeated.
| |
IsParentRequired |
Gets a value indicating whether this instance requires the parent property.
(Inherited from BaseAnnotation.) | |
IsReadOnlyOrFieldReadOnly |
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.) | |
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.
(Inherited from BaseAnnotation.) | |
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.
(Inherited from BaseAnnotation.) | |
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.
(Inherited from BaseAnnotation.) | |
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.
(Inherited from BaseAnnotation.) | |
NoRotate |
Gets or sets a value indicating whether the annotation should be rotated when a page is rotated. Default is false.
(Inherited from BaseAnnotation.) | |
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.
(Inherited from BaseAnnotation.) | |
NoZoom |
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.) | |
OverlayText |
Gets or sets the overlay text that will be used on the redaction when placed.
| |
ParentPage |
Gets or sets the parent page that contains this annotation.
(Inherited from BaseAnnotation.) | |
Popup |
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.) | |
Gets or sets a value indicating whether this BaseAnnotation is printed. Default is false.
(Inherited from BaseAnnotation.) | ||
ReadOnly |
Gets or sets a value indicating whether the annotation can interact with the user. Default is false.
(Inherited from BaseAnnotation.) | |
RedactionInteriorColor |
Gets or sets the color of the interior of the redacted area. If not set, the redacted area will be transparent.
| |
RedactionTemplate |
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.
| |
Regions |
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.
| |
RichTextContent |
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.) | |
TextAlignment |
Gets or sets the text alignment.
| |
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.
(Inherited from BaseAnnotation.) | |
Transparency |
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.) |
Name | Description | |
---|---|---|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetRichTextContent | (Inherited from BaseMarkupAnnotation.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
HasAppearance |
Determines whether this instance has at least 1 element in the Normal appearance set.
(Inherited from BaseAnnotation.) | |
MakeBasicAppearance |
Makes the basic appearance for the annotation. Unlike CheckboxWidgetAnnotation, TextWidgetAnnotation
can't easily share the same appearance since appearances are geometrically scaled to fit the bounds of the annotation.
This means that border outlines will grow or shrink when drawn. When the Bounds of the
annotation change, the appearance needs to be rebuilt in order to render correctly in the document.
This method is provided so that, for example, client code might add in custom coloring or easily build consistent
appearances for when the annotation has been cliecked on or when it is rolled over.
| |
MakeRepairContext |
Makes the repair context for repairing problems in this annotation object. An object implementing IValidatable
should at least return an empty RepairContext object.
(Inherited from BaseAnnotation.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
NotifyResourceRenamed |
This method is called when a global resourec has been renamed, allowing the resource consumer to update to the
new name. Annotations defer this to their appearance, if any.
(Inherited from BaseAnnotation.) | |
ResourcesUsed |
Reports a list of all resources consumed by the object of the given class.
(Inherited from BaseAnnotation.) | |
ThrowIfReadOnlyT |
If EnforceReadyOnlyWithException is true and ReadOnly is true,
throw an InvalidOperationException, otherwise return value.
(Inherited from BaseAnnotation.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
Validate |
Validates the annotation and accumulates any problems.
(Inherited from BaseAnnotation.) | |
ValidateActionList |
Validates the action list.
(Inherited from BaseAnnotation.) | |
ValidateActions |
Validates the actions.
(Inherited from BaseAnnotation.) | |
ValidateProperties |
Validates the properties for the CaretAnnotation.
(Inherited from BaseMarkupAnnotation.) |
public static bool PageHasRedactions(PdfGeneratedPage page) { if (page == null) throw new Exception("page was null or not a PdfGeneratedPage."); foreach (BaseAnnotation annot in page.Annotations) { if (annot is RedactionProposalAnnotation) return true; } return false; } public static bool DocumentHasRedactions(PdfGeneratedDocument doc) { foreach (BasePage page in doc.Pages) { // page argument will be null if BasePage is not a PdfGeneratedPage // this would happen if the document was opened without the "attempt to import foreign content" flag set. if (PageHasRedactions(page as PdfGeneratedPage)) return true; } return false; }