Back to Devexpress

PdfPageFacade.ClearContent(PdfOrientedRectangle, PdfClearContentOptions) Method

officefileapi-devexpress-dot-pdf-dot-pdfpagefacade-dot-clearcontent-x28-devexpress-dot-pdf-dot-pdforientedrectangle-devexpress-dot-pdf-dot-pdfclearcontentoptions-x29.md

latest3.5 KB
Original Source

PdfPageFacade.ClearContent(PdfOrientedRectangle, 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.v25.2.Core.dll

NuGet Package : DevExpress.Pdf.Core

Declaration

csharp
public void ClearContent(
    PdfOrientedRectangle rect,
    PdfClearContentOptions options
)
vb
Public Sub ClearContent(
    rect As PdfOrientedRectangle,
    options As PdfClearContentOptions
)

Parameters

NameTypeDescription
rectPdfOrientedRectangle

A page rectangle to clear.

| | 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:

csharp
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, options);

    // Save the result
    pdfDocumentProcessor.SaveDocument("Document_cleared.pdf");
}
vb
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, options)

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

See Also

PdfPageFacade Class

PdfPageFacade Members

DevExpress.Pdf Namespace