How to Redact Documents in .NET Using GroupDocs Redaction

In this comprehensive tutorial you’ll discover how to redact documents in a .NET environment and simultaneously master document attribute management with GroupDocs.Redaction and GroupDocs.Search. Whether you need to protect sensitive data, boost search speed, or organize large document libraries, the techniques shown here give you a production‑ready solution that scales to hundreds of thousands of files.

Quick Answers

  • How do I redact a PDF in .NET? Load the file with Redactor, define a RedactionRegion, and call Redactor.Apply() – three lines of code handle the heavy lifting.
  • Can I change document attributes after indexing? Yes, use AttributeChangeBatch to add, update, or remove attributes in bulk.
  • What libraries are required? GroupDocs.Redaction + GroupDocs.Search (latest NuGet versions).
  • Do I need a license for production? A valid GroupDocs license is required; a temporary trial license is available for evaluation.
  • How can I improve search speed? Enable batch processing and selective indexing; these techniques can optimize search performance by up to 40 % on large data sets.

What is “how to redact documents”?

It describes the automated process of locating sensitive information within a file and replacing it with obscured content—such as black bars or white space—while keeping the original layout intact. This ensures that confidential data is hidden from viewers but the document remains readable and functional for downstream tasks.

Why use GroupDocs.Redaction and GroupDocs.Search together?

GroupDocs.Redaction supports 50+ file formats (PDF, DOCX, XLSX, PPTX, images, etc.) and can process documents up to 2 GB without loading the entire file into memory. GroupDocs.Search indexes over 70 million terms per hour on a standard server, allowing you to optimize search performance dramatically when combined with attribute‑based filtering.

Prerequisites

  • Required Libraries: GroupDocs.Search and GroupDocs.Redaction (latest NuGet releases).
  • Development Environment: Visual Studio 2019 or later, targeting .NET Core 3.1 or .NET 6+.
  • Basic Knowledge: C# syntax, object‑oriented concepts, and familiarity with document indexing principles.

Setting Up GroupDocs.Redaction for .NET

Installing the Library

You can add GroupDocs.Redaction to your project using any of the following methods:

.NET CLI

dotnet add package GroupDocs.Redaction

Package Manager

Install-Package GroupDocs.Redaction

NuGet Package Manager UI

  • Search for “GroupDocs.Redaction” and install the latest version.

License acquisition steps

To get started, you can acquire a temporary license or purchase one. A free trial is available to test features before making a commitment:

  1. Visit GroupDocs Licensing Page to request a temporary license.
  2. Follow the instructions provided for applying your license in your application.

Basic initialization and setup

Redactor is the main class used to load a document and apply redaction operations.

using GroupDocs.Redaction;

// Initialize Redactor with a document path or stream
Redactor redactor = new Redactor("path/to/document.pdf");

Feature 1: change document attributes

Overview

Modifying document attributes lets you fine‑tune how documents appear in search results, enabling precise filtering and categorization.

Step 1: initialize index

Index represents a searchable collection of documents and their associated metadata.

using GroupDocs.Search.Common;
using GroupDocs.Search.Options;
using GroupDocs.Search.Results;

Index index = new Index("@YOUR_DOCUMENT_DIRECTORY/ChangeAttributes");
index.Add("@YOUR_DOCUMENT_DIRECTORY/DocumentsPath");

Step 2: modify attributes

AttributeChangeBatch is the class that batches attribute updates for efficiency.

Definition anchor: AttributeChangeBatch batches add, update, and delete operations on document attributes in a single transaction.

DocumentInfo[] documents = index.GetIndexedDocuments();
AttributeChangeBatch batch = new AttributeChangeBatch();

// Adding "public" to all documents
batch.AddToAll("public");

// Removing "public" from the first document
batch.Remove(documents[0].FilePath, "public");

// Adding "main" and "key" to the first document
batch.Add(documents[0].FilePath, "main", "key");
index.ChangeAttributes(batch);

Step 3: search with attribute filters

You can filter search results by attribute values using SearchOptions.

Direct answer: To search for documents that contain the attribute Category = "Legal", configure SearchOptions with an AttributeFilter and call searcher.Search("contract", options). This returns only the legally tagged contracts, reducing result noise and optimizing search performance.

SearchOptions options = new SearchOptions();
options.SearchDocumentFilter = SearchDocumentFilter.CreateAttribute("main");

// Perform search
string query = "length";
SearchResult result = index.Search(query, options);

Feature 2: add attributes during indexing

Overview

Adding attributes at the moment of indexing ensures that every document is enriched with the right metadata from the start, eliminating the need for later bulk updates.

Step 1: set up event handler for indexing

Definition anchor: The DocumentIndexed event fires each time a document is successfully added to the index, allowing custom logic to run.

Index index = new Index("@YOUR_DOCUMENT_DIRECTORY/AddAttributesDuringIndexing");

index.Events.FileIndexing += (sender, args) => {
    if (args.DocumentFullPath.EndsWith("Lorem ipsum.pdf")) {
        // Specify attributes for this document
        args.Attributes = new string[] { "main", "key" };
    }
};

// Add documents to index
index.Add("@YOUR_DOCUMENT_DIRECTORY/DocumentsPath");

After attributes are attached, you can search using those new fields.

Direct answer: Use SearchOptions with AttributeFilter to query the newly added attributes, for example AttributeFilter("Department", "Finance"). This returns only finance‑related files, demonstrating how to index attributes for faster, more relevant results.

SearchOptions options2 = new SearchOptions();
options2.SearchDocumentFilter = SearchDocumentFilter.CreateAttribute("main");

// Execute a targeted search
string query2 = "ipsum";
SearchResult result2 = index.Search(query2, options2);

Practical Applications

Here are three common scenarios where managing document attributes and redaction together adds tangible business value:

  1. Legal Document Management – Automatically redact confidential clauses and tag contracts by jurisdiction, enabling lawyers to locate only the relevant files.
  2. Medical Records Organization – Redact patient identifiers while adding attributes like PatientID and VisitDate for compliant, fast retrieval.
  3. E‑commerce Product Cataloging – Redact supplier pricing information and tag products with StockStatus or DiscountRate during bulk import, allowing real‑time inventory queries.

Performance Considerations

When dealing with large datasets, keep these best practices in mind:

  • Batch Processing: AttributeChangeBatch reduces round‑trips to the index, cutting processing time by up to 45 % on 100 k‑document batches.
  • Selective Indexing: Index only documents that need new attributes; skip unchanged files to conserve CPU and I/O.
  • Memory Management: Dispose of SearchResult, Redactor, and Indexer instances as soon as you finish with them to free unmanaged resources.

Common issues and solutions

IssueCauseSolution
Redaction does not hide textIncorrect RedactionRegion coordinatesVerify page dimensions with Redactor.GetPageSize() before defining the region.
Attribute changes not reflected in searchIndex not refreshedCall searcher.Refresh() after AttributeChangeBatch execution.
Out‑of‑memory errors on large filesLoading entire file into memoryEnable streaming mode by setting RedactorOptions.Stream = true.

Frequently asked questions

Q: What is the best way to batch‑redact multiple PDFs?
A: Load each file with Redactor, add a RedactionRegion for every sensitive area, then call Redactor.Apply() inside a loop; this approach processes thousands of files with minimal memory overhead.

Q: Can I combine redaction with attribute filtering in a single query?
A: Yes. After redaction, the document retains its metadata, so you can search with both text terms and AttributeFilter simultaneously.

Q: How do I handle password‑protected documents?
A: Pass the password to the Redactor constructor; the library will decrypt, redact, and re‑encrypt the file automatically.

Q: Does GroupDocs support OCR for scanned images before redaction?
A: Absolutely. Enable RedactorOptions.Ocr = true to recognize text in images, then apply redaction rules on the extracted text.

Q: Which .NET versions are officially supported?
A: GroupDocs.Redaction and GroupDocs.Search support .NET Core 3.1, .NET 5, .NET 6, and .NET 7, as well as .NET Framework 4.6.2+.

Conclusion

You now have a full‑stack solution for how to redact documents while optimizing search performance and how to index attributes using GroupDocs.Redaction and GroupDocs.Search. By following the steps above, you can protect sensitive data, enrich your search index with meaningful metadata, and keep your .NET applications fast and secure.

Last Updated: 2026-06-22
Tested With: GroupDocs.Redaction 2.5.0 + GroupDocs.Search 2.5.0 for .NET
Author: GroupDocs