PdfPageFacade.ClearContent(PdfRectangle, PdfClearContentOptions) Method

Clears the document content located in the specified rectangle. Allows you to specify what content type to keep.

Namespace: DevExpress.Pdf

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

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public void ClearContent(
    PdfRectangle rect,
    PdfClearContentOptions options
)

VB.NET

Public Sub ClearContent(
    rect As PdfRectangle,
    options As PdfClearContentOptions
)

Parameters

Name	Type	Description
rect	PdfRectangle	A page rectangle to clear.
options	PdfClearContentOptions	Options that specify what content type to keep in the target rectangle.

Example

The code sample below removes only text in the upper half of the first page:

C#

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

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

    // Define an area to clear
    PdfRectangle cropBox = pdfDocumentProcessor.Document.Pages[0].CropBox;
    double halfPage = cropBox.Top / 2;
    PdfRectangle pageRectangle = new PdfRectangle(cropBox.Left, halfPage, cropBox.Right + halfPage, cropBox.Top);

    // Set what content type to keep
    PdfClearContentOptions options = new PdfClearContentOptions()
    {
      ClearAnnotations = false,
      ClearGraphics = false, 
      ClearImages = false
    };

    // Clear the page area
    pageFacade.ClearContent(pageRectangle, options);

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

VB.NET

Using pdfDocumentProcessor As New PdfDocumentProcessor()

  ' Load a document
  pdfDocumentProcessor.LoadDocument("Document.pdf")

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

  ' Define an area to clear
  Dim cropBox As PdfRectangle = pdfDocumentProcessor.Document.Pages(0).CropBox
  Dim halfPage As Double = cropBox.Top / 2
  Dim pageRectangle As New PdfRectangle(cropBox.Left, halfPage, cropBox.Right + halfPage, cropBox.Top)

  ' Set what content type to keep
  Dim options As New PdfClearContentOptions() With
   {
      .ClearAnnotations = False,
      .ClearGraphics = False,
      .ClearImages = False
  }

  ' Clear the page area
  pageFacade.ClearContent(pageRectangle, options)

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