PdfRedactionAnnotation Class
A redaction annotation (PDF 1.7) identifies content that is intended to be removed from the document. The intent of redaction annotations is to enable the following process:
- Content identification. A user applies redact annotations that specify the pieces or regions of content that should be removed. Up until the next step is performed, the user can see, move and redefine these annotations.
- Content removal. The user instructs the viewer application to apply the redact annotations, after which the content in the area specified by the redact annotations is removed. In the removed content’s place, some marking appears to indicate the area has been redacted. Also, the redact annotations are removed from the PDF document.
public sealed class PdfRedactionAnnotation : PdfMarkupAnnotationPublic NotInheritable Class PdfRedactionAnnotation
Inherits PdfMarkupAnnotation- Inheritance:
- System.ObjectPdfRedactionAnnotation
Properties
AnnotationType
Gets the Redact value.
public override PdfAnnotationType AnnotationType { get; }Public Overrides ReadOnly Property AnnotationType As PdfAnnotationTypeProperty Value
The Redact value.
Overrides
Appearance
Gets the appearance settings for this PdfRedactionAnnotation.
public PdfRedactionAppearance Appearance { get; }Public ReadOnly Property Appearance As PdfRedactionAppearanceProperty Value
The appearance settings for this PdfRedactionAnnotation.
Quads
(Optional)An array of 8 x n numbers specifying the coordinates of n quadrilaterals in default user space, as described in Table 179 for text markup annotations. If present, these quadrilaterals denote the content region that is intended to be removed. If this entry is not present, the Bounds entry denotes the content region that is intended to be removed.
public PdfCollection<PdfQuad> Quads { get; }Public ReadOnly Property Quads As PdfCollection(Of PdfQuad)Property Value
An array of 8 x n numbers specifying the coordinates of n quadrilaterals in default user space, as described in Table 179 for text markup annotations.
See Also
Methods
Apply()
Performs the Content removal phase of the redaction process after which the content in the area specified (either via Quads or Bounds) by this PdfRedactionAnnotation is removed. In the removed content's place, some marking appears to indicate the area has been redacted as specified by the RedactedAreaFillColor, OverlayText, and related properties. Also, this PdfRedactionAnnotation (and its associated pop-up annotation) is removed from the parent PdfAnnotationCollection. If a portion of a content (either text, path, image, or form) is contained in a redaction region, that portion of the content is destroyed; clipping or image masks are not used to hide that content.
See Also
Inherited Properties
| AssociatedFiles | (Optional; PDF 2.0) An array of one or more PdfFileSpecifications which denote the associated files for this PdfAnnotation. (Inherited from PdfAnnotation) |
| Author | (Optional; PDF 1.1) The text label that shall be displayed in the title bar of the annotation's pop-up window when open and active. This entry shall identify the user who added the annotation. (Inherited from PdfMarkupAnnotation) |
| Bounds | (Required) The annotation bounds, defining the location and the size of the annotation on the page in default user space units. (Inherited from PdfAnnotation) |
| InReplyTo | (Required if a ReplyType entry is present, otherwise optional; PDF 1.5) A reference to the PdfMarkupAnnotation that this PdfMarkupAnnotation is "in reply to". Both PdfMarkupAnnotations shall be on the same page of the document. The relationship between the two PdfMarkupAnnotations shall be specified by the ReplyType entry. (Inherited from PdfMarkupAnnotation) |
| Intent | (Optional; PDF 1.6) A name describing the intent of the markup annotation. Intents allow conforming readers to distinguish between different uses and behaviors of a single markup annotation type. PdfFreeTextAnnotations (Table 174), line annotations (Table 175), polygon annotations (Table 178), and (PDF 1.7) polyline annotations (Table 178) have defined intents. (Inherited from PdfMarkupAnnotation) |
| Locked | (PDF 1.4) If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field. (Inherited from PdfAnnotation) |
| Metadata | (Optional; PDF 1.4) A metadata stream containing metadata for the component. (Inherited from PdfObject) |
| Page | Gets the page with which this annotation is associated. (Inherited from PdfAnnotation) |
| ReplyType | (Optional; meaningful only if InReplyTo is present; PDF 1.6) A name specifying the relationship (the "reply type") between this PdfMarkupAnnotation and the one specified by the InReplyTo property. Default value: Reply. (Inherited from PdfMarkupAnnotation) |
| Subject | (Optional; PDF 1.5) Text representing a short description of the subject being addressed by the annotation. (Inherited from PdfMarkupAnnotation) |
Inherited Methods
| SetBounds(System.Double, System.Double) | Sets the size of the Bounds. (Inherited from PdfAnnotation) |
| SetBounds(System.Double, System.Double, System.Double, System.Double) | Sets the Bounds. (Inherited from PdfAnnotation) |