PdfClearContentRegions Class

A collection of page regions to clear.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v23.2.Core.dll

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public class PdfClearContentRegions

VB.NET

Public Class PdfClearContentRegions

Remarks

Pass the PdfClearContentRegions object as the PdfPageFacade.ClearContent to clear multiple page regions.

The code sample below clears all found entries of a specific word:

C#

using (PdfDocumentProcessor pdfDocumentProcessor = new PdfDocumentProcessor())
{
    pdfDocumentProcessor.LoadDocument("Document.pdf");
    PdfDocumentFacade documentFacade = pdfDocumentProcessor.DocumentFacade;
    PdfPageFacade pageFacade = documentFacade.Pages[0];

    //Find target phrase in the document
    string removeText = "Ounce";

    PdfTextSearchParameters searchParameters = new PdfTextSearchParameters() { WholeWords = true };
    PdfTextSearchResults searchResults = pdfDocumentProcessor.FindText(removeText, searchParameters);

    PdfClearContentRegions contentRegions = new PdfClearContentRegions();

    // Retrieve text rectangles
    while (searchResults.Status == PdfTextSearchStatus.Found && searchResults.PageNumber == 1)
    {
        contentRegions.Add(searchResults.Rectangles);
        searchResults = pdfDocumentProcessor.FindText(removeText, searchParameters);
    }

    // Remove found entries
    pageFacade.ClearContent(contentRegions, new PdfClearContentOptions());

    pdfDocumentProcessor.SaveDocument("Document_cleared.pdf");
}

VB.NET

Using pdfDocumentProcessor As New PdfDocumentProcessor()
  pdfDocumentProcessor.LoadDocument("Document.pdf")
  Dim documentFacade As PdfDocumentFacade = pdfDocumentProcessor.DocumentFacade
  Dim pageFacade As PdfPageFacade = documentFacade.Pages(0)

  'Find target phrase in the document
  Dim removeText As String = "Ounce"

  Dim searchParameters As New PdfTextSearchParameters() With {.WholeWords = True}
  Dim searchResults As PdfTextSearchResults = pdfDocumentProcessor.FindText(removeText, searchParameters)

  Dim contentRegions As New PdfClearContentRegions()

  ' Retrieve text rectangles
  Do While searchResults.Status = PdfTextSearchStatus.Found AndAlso searchResults.PageNumber = 1
    contentRegions.Add(searchResults.Rectangles)
    searchResults = pdfDocumentProcessor.FindText(removeText, searchParameters)
  Loop

  ' Remove found entries
  pageFacade.ClearContent(contentRegions, New PdfClearContentOptions())

  pdfDocumentProcessor.SaveDocument("Document_cleared.pdf")
End Using

Inheritance

Object

PdfClearContentRegions