PdfRedactAnnotation Class

A redaction annotation (ISO 32000-2, 12.5.6.23): marks regions of the page whose content is to be removed. The content stays until the redaction is applied, by PdfDocument.ApplyRedactions or by a viewer.

public sealed class PdfRedactAnnotation : PdfMarkupAnnotation
Inheritance
PdfMarkupAnnotation PdfRedactAnnotation

Properties

NameDescription
InteriorColorGets or sets the color that fills the regions once they are redacted (/IC), or null to leave them empty.
OverlayTextGets or sets the text drawn in the regions once they are redacted (/OverlayText), such as REDACTED.
RegionsGets or sets the regions to remove (/QuadPoints), in default user space; when the annotation has none, the region is its rectangle. The getter returns the bounds of each quadrilateral, all of them: a region left out would stay readable once the redaction is applied.
RepeatOverlayTextGets or sets a value indicating whether PdfRedactAnnotation.OverlayText is repeated to fill the regions (/Repeat).

Gets or sets the color that fills the regions once they are redacted (/IC), or null to leave them empty.

public PdfColor? InteriorColor { get; set; }

Property value

PdfColor?

Gets or sets the text drawn in the regions once they are redacted (/OverlayText), such as REDACTED.

public string? OverlayText { get; set; }

Property value

string?

Gets or sets the regions to remove (/QuadPoints), in default user space; when the annotation has none, the region is its rectangle. The getter returns the bounds of each quadrilateral, all of them: a region left out would stay readable once the redaction is applied.

public IReadOnlyList<PdfRectangle> Regions { get; set; }

RepeatOverlayText

PdfRedactAnnotation.cs

Gets or sets a value indicating whether PdfRedactAnnotation.OverlayText is repeated to fill the regions (/Repeat).

public bool RepeatOverlayText { get; set; }

Property value

bool