PdfPageFacade.ClearContent(PdfClearContentRegions) Method

Clears the document content located in the specified regions.

Namespace: DevExpress.Pdf

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

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public void ClearContent(
    PdfClearContentRegions regions
)

VB.NET

Public Sub ClearContent(
    regions As PdfClearContentRegions
)

Parameters

Name	Type	Description
regions	PdfClearContentRegions	Page regions to clear.

Remarks

The code sample below removes all entries of a specific phrase from the first page;

C#

using (PdfDocumentProcessor pdfDocumentProcessor = new PdfDocumentProcessor())
{
    // Load a document
    pdfDocumentProcessor.LoadDocument("Document.pdf");
    PdfClearContentRegions contentRegions = new PdfClearContentRegions();

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

    PdfTextSearchParameters searchParameters = new PdfTextSearchParameters()
    {
       WholeWords = true
    };

    PdfTextSearchResults searchResults = pdfDocumentProcessor.FindText(removeText, searchParameters);

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

    // Get the first page properties
    PdfPageFacade pageFacade = pdfDocumentProcessor.DocumentFacade.Pages[0];

    // Remove found entries
    pageFacade.ClearContent(contentRegions);

    // Save the result
    pdfDocumentProcessor.SaveDocument("Document_cleared.pdf");
}

VB.NET

Using pdfDocumentProcessor As New PdfDocumentProcessor()
  ' Load a document
  pdfDocumentProcessor.LoadDocument("Document.pdf")

  Dim contentRegions As New PdfClearContentRegions()

  ' Find the 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)

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

  ' Get the first page properties
  Dim pageFacade As PdfPageFacade = pdfDocumentProcessor.DocumentFacade.Pages(0)

  ' Remove found entries
  pageFacade.ClearContent(contentRegions)

  ' Save the result
  pdfDocumentProcessor.SaveDocument("Document_cleared.pdf")
End Using