Class RedactionOptions

Namespace

MiPdf.Redaction

Assembly

MiPdf.dll

Options for redaction.

public sealed class RedactionOptions

Inheritance

object

RedactionOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

FillColor

Color of the boxes drawn over redacted areas (default black); null draws nothing.

public PdfColor? FillColor { get; set; }

Property Value

PdfColor?

GlyphOverlapThreshold

A glyph is removed when this share of its box overlaps a redacted area (default 0.3).

public double GlyphOverlapThreshold { get; set; }

Property Value

double

OverlayFont

Font of the OverlayText (default Helvetica); the size is fitted to each box.

public PdfFont OverlayFont { get; set; }

Property Value

PdfFont

OverlayText

Optional text drawn into each box (e.g. "REDACTED").

public string? OverlayText { get; set; }

Property Value

string

OverlayTextColor

Color of the OverlayText (default white).

public PdfColor OverlayTextColor { get; set; }

Property Value

PdfColor

RemoveAnnotations

Remove annotations and form fields that intersect a redacted area (default true).

public bool RemoveAnnotations { get; set; }

Property Value

bool

RemoveVectorGraphics

Remove vector graphics (paths) that lie completely inside a redacted area (default true).

public bool RemoveVectorGraphics { get; set; }

Property Value

bool