RedactionAnnotation Class

A redaction annotation.

Namespace: DevExpress.Docs.Pdf

Assembly: DevExpress.Docs.Pdf.v26.1.dll

Declaration

C#

public class RedactionAnnotation :
    MarkupAnnotation

VB.NET

Public Class RedactionAnnotation
    Inherits MarkupAnnotation

Example

How to: Create a Redaction Annotation

The following code snippet creates redaction annotations over the search results and saves the document to a new file:

C#

using DevExpress.Docs.Pdf;
using System.Collections.Generic;
using System.IO;
using System.Linq;

using (PdfDocument pdfDocument =
    new PdfDocument(File.OpenRead(@"C:\Documents\document_001.pdf"))) {
    string[] search = {
        "Maria Anders", "030-0074321",
        "[e-mail]"
    };
    foreach (string word in search) {
        IEnumerable<TextSearchInfo> results =
            pdfDocument.FindText(word, new TextSearchOptions(true, true));
        foreach (TextSearchInfo searchResult in results) {
            var page = pdfDocument.Pages[searchResult.PageIndex];
            var rects = searchResult.Matches
                .SelectMany(x => x.MatchFragments)
                .Select(x => x.Rectangle);
            // Create a redaction annotation.
            var redactionAnnotation =
                new RedactionAnnotation(rects);

            redactionAnnotation.Color = PdfColor.Black;
            redactionAnnotation.FillColor = PdfColor.Red;

            redactionAnnotation.OverlayText = "Classified";
            redactionAnnotation.TextJustification =
                TextJustification.Centered;
            redactionAnnotation.RepeatText = false;
            page.Annotations.Add(redactionAnnotation);
        }
    }

    // Save the document with the redaction annotation.
    using (FileStream stream =
        File.Create("UpdatedDocument.pdf"))
    {
        pdfDocument.Save(stream);
    }
}

VB.NET

Imports DevExpress.Docs.Pdf
Imports System.Collections.Generic
Imports System.IO
Imports System.Linq

Using pdfDocument As New PdfDocument(
    File.OpenRead("C:\Documents\document_001.pdf"))
    Dim search As String() = {
        "Maria Anders", "030-0074321",
        "[e-mail]"
    }
    For Each word As String In search
        Dim results As IEnumerable(Of TextSearchInfo) =
            pdfDocument.FindText(word,
                New TextSearchOptions(True, True))
        For Each searchResult As TextSearchInfo In results
            Dim page = pdfDocument.Pages(
                searchResult.PageIndex)
            Dim rects = searchResult.Matches _
                .SelectMany(Function(x) x.MatchFragments) _
                .Select(Function(x) x.Rectangle)
            ' Create a redaction annotation.
            Dim redactionAnnotation As _
                New RedactionAnnotation(rects)

            redactionAnnotation.Color = PdfColor.Black
            redactionAnnotation.FillColor = PdfColor.Red

            redactionAnnotation.OverlayText = "Classified"
            redactionAnnotation.TextJustification = _
                TextJustification.Centered
            redactionAnnotation.RepeatText = False

            page.Annotations.Add(redactionAnnotation)
        Next searchResult
    Next word
    ' Save the document with the redaction annotation.
    Using stream As FileStream = _
        File.Create("UpdatedDocument.pdf")
        pdfDocument.Save(stream)
    End Using
End Using

Implements

ICloneable

Inheritance

Object

BaseAnnotation

MarkupAnnotation

RedactionAnnotation