Class RedactionAnnotation

A redaction annotation (PDF spec §12.5.13). Marks regions of the page for permanent removal. When ApplyRedactions() is called, the content within each redaction region is permanently removed and filled with the specified overlay color.

Inheritance

object

Annotation

MarkupAnnotation

RedactionAnnotation

Inherited Members

MarkupAnnotation.Title

MarkupAnnotation.Subject

MarkupAnnotation.RichText

MarkupAnnotation.CreationDate

MarkupAnnotation.ReplyType

MarkupAnnotation.Popup

Annotation.Rect

Annotation.Contents

Annotation.Name

Annotation.Modified

Annotation.Flags

Annotation.Color

Annotation.Border

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: DRIT.Pdf.Annotations

Assembly: DRIT.Pdf.dll

Syntax

public sealed class RedactionAnnotation : MarkupAnnotation

Properties

InteriorColor

Interior fill color applied after redaction (/IC). Default is black.

Declaration

public PdfColor InteriorColor { get; set; }

Property Value

Type	Description
PdfColor

OverlayText

Overlay text to display over the redacted region (/OverlayText).

Declaration

public string? OverlayText { get; set; }

Property Value

Type	Description
string

Quads

Quadrilaterals defining the redaction regions (/QuadPoints).

Declaration

public IReadOnlyList<Quad> Quads { get; }

Property Value

Type	Description
IReadOnlyList<Quad>

RepeatOverlayText

Whether to repeat the overlay text to fill the redaction region (/Repeat).

Declaration

public bool RepeatOverlayText { get; set; }

Property Value

Type	Description
bool

Methods

AddQuad(Quad)

Add a quad defining a redaction region.

Declaration

public void AddQuad(Quad quad)

Parameters

Type	Name	Description
Quad	quad

AddQuad(double, double, double, double)

Add a redaction region from an axis-aligned rectangle.

Declaration

public void AddQuad(double left, double bottom, double right, double top)

Parameters

Type	Name	Description
double	left
double	bottom
double	right
double	top