PdfPageFacade.ClearContent(PdfRectangle, Boolean, PdfClearContentOptions) Method

Clears the document content located in the specified rectangle. Allows you to specify whether to use the page coordinate system, and what content type to keep.

Namespace : DevExpress.Pdf

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

NuGet Package : DevExpress.Pdf.Core

csharp

public void ClearContent(
    PdfRectangle rect,
    bool usePageCoordinateSystem,
    PdfClearContentOptions options
)

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

Parameters

Name	Type	Description
rect	PdfRectangle

A page rectangle to clear.

| | usePageCoordinateSystem | Boolean |

true to use the page coordinate system; otherwise, false.

| | options | PdfClearContentOptions |

An object that contains clear content options.

Remarks

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

C#
VB.NET

csharp

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

    PdfRectangle cropBox = pdfDocumentProcessor.Document.Pages[0].CropBox;
    double halfPage = cropBox.Top / 2;

    PdfRectangle pageRectangle = new PdfRectangle(cropBox.Left, halfPage, cropBox.Right + halfPage, cropBox.Top);

    PdfClearContentOptions options = new PdfClearContentOptions()
    {
      ClearAnnotations = false,
      ClearGraphics = false, 
      ClearImages = false
    };

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

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

Using pdfDocumentProcessor As New PdfDocumentProcessor()
  pdfDocumentProcessor.LoadDocument("Document.pdf")

  Dim pageFacade As PdfPageFacade = pdfDocumentProcessor.DocumentFacade.Pages(0)

  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)

  Dim options As New PdfClearContentOptions() With
   {
      .ClearAnnotations = False,
      .ClearGraphics = False,
      .ClearImages = False
  }

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

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