PdfPageFacade.ClearContent(PdfOrientedRectangle, Boolean, PdfClearContentOptions) Method

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

Namespace: DevExpress.Pdf

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

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

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

VB.NET

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

Parameters

Name	Type	Description
rect	PdfOrientedRectangle	A page rectangle to clear.
usePageCoordinateSystem	Boolean	true to use the page coordinate system; otherwise, false.
options	PdfClearContentOptions	Options that specify what content type to keep in the target rectangle.

Remarks

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");

    // Define the upper half of the first page
    PdfRectangle cropBox = pdfDocumentProcessor.Document.Pages[0].CropBox;
    PdfOrientedRectangle pageRectangle =
      new PdfOrientedRectangle(cropBox.TopLeft, cropBox.Width, cropBox.Height / 2, 0);

    // Specify what content type to keep in the target area
    PdfClearContentOptions options = new PdfClearContentOptions()
    {
        ClearAnnotations = false,
        ClearGraphics = false,
        ClearImages = false
    };

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

    // Clear the upper half of the page
    pageFacade.ClearContent(pageRectangle, true, options);

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

VB.NET

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

  ' Define the upper half of the first page
  Dim cropBox As PdfRectangle = pdfDocumentProcessor.Document.Pages(0).CropBox
  Dim pageRectangle As
     New PdfOrientedRectangle(cropBox.TopLeft, cropBox.Width, cropBox.Height \ 2, 0)

  ' Specify what content type to keep in the target area
  Dim options As New PdfClearContentOptions() With
     {.ClearAnnotations = False, .ClearGraphics = False, .ClearImages = False}

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

  ' Clear the upper half of the page
  pageFacade.ClearContent(pageRectangle, True, options)

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