Table of Contents

Class PdfRedactionOptions

Namespace
LMKit.Document.Pdf
Assembly
LM-Kit.NET.dll

Controls how PdfRedactor removes content. The defaults remove every content type intersecting a redaction area (text glyphs, image pixels, vector graphics, annotations, content nested in Form XObjects) and draw an opaque black box over each redacted area.

public sealed class PdfRedactionOptions
Inheritance
PdfRedactionOptions
Inherited Members

Examples

using LMKit.Document.Pdf;
using LMKit.Graphics.Primitives;

var options = new PdfRedactionOptions
{
    FillColor = Color32.FromRgb(0x333333),
    RemoveAnnotations = false
};

Properties

DrawFillBoxes

Gets or sets whether an opaque box is drawn over each redacted area after content removal. Default: true.

FillColor

Gets or sets the fill box color. The alpha channel is honored, so a translucent fill is possible. Default: opaque black.

Password

Gets or sets the password used to open encrypted source documents. The redacted output is always written unencrypted.

RecurseIntoForms

Gets or sets whether redaction descends into Form XObjects. The affected form instance is cloned before editing, so the same form referenced from other pages keeps its original content. Default: true.

RedactImages

Gets or sets whether image pixels intersecting a redaction area are scrubbed. When an intersecting image cannot be decoded it is removed entirely; redacted pixel data never survives. Default: true.

RedactVectorGraphics

Gets or sets whether vector path content intersecting a redaction area is removed. Default: true.

RemoveAnnotations

Gets or sets whether annotations whose rectangle intersects a redaction area are removed. Annotation payloads (markup contents, link targets, form field values) often duplicate the content being redacted. Default: true.

Share