How to: Use PDF Facade API to Clear Page Content

• Mar 02, 2022
• 3 minutes to read

The following article describes how to use PDF Facade API to clear PDF page content.

Important

The Universal Subscription or an additional Office File API Subscription is required to use this example in production code. Refer to the DevExpress Subscription page for pricing information.

The PdfViewerExtensions.GetDocumentFacade method retrieves a PdfDocumentFacade class object that allows you to change the PDF document without access to its inner structure.

The PdfDocumentFacade.Pages property returns a list of PdfPageFacade objects that contain PDF page properties. Call the ClearContent method to remove content in one or multiple page areas. You can specify what content type to keep in the areas that are to be cleared. To do that, pass the PdfClearContentOptions class object as the method parameter.

The code sample below removes only text in selected page area:

C#

using DevExpress.Pdf;
using System;

public Form1()
{
    InitializeComponent();
    pdfViewer.LoadDocument("Document.pdf");
    pdfViewer.MouseDown += pdfViewer_MouseDown;
    pdfViewer.MouseUp += pdfViewer_MouseUp;
}

PdfDocumentPosition startSelectionPosition;

void pdfViewer_MouseDown(object sender, MouseEventArgs e)
{
    // Get the start position of the selection
    startSelectionPosition = pdfViewer.GetDocumentPosition(e.Location, true);
    if (startSelectionPosition == null) return;
}

void pdfViewer_MouseUp(object sender, MouseEventArgs e)
{
    // Retrieve the end position of the selection
    PdfDocumentPosition endSelectionPosition = pdfViewer.GetDocumentPosition(e.Location);
    if (endSelectionPosition == null || startSelectionPosition == null) return;
    if (endSelectionPosition.Point.Equals(startSelectionPosition.Point)) return;

    // Define the selection area
    double left = Math.Min(startSelectionPosition.Point.X, endSelectionPosition.Point.X);
    double bottom = Math.Min(startSelectionPosition.Point.Y, endSelectionPosition.Point.Y);
    double right = Math.Max(startSelectionPosition.Point.X, endSelectionPosition.Point.X);
    double top = Math.Max(startSelectionPosition.Point.Y, endSelectionPosition.Point.Y);
    PdfRectangle rectangle = new PdfRectangle(left, bottom, right, top );
    int pageNumber = startSelectionPosition.PageNumber;

    // Retrieve the page properties
    PdfPageFacade pageFacade = pdfViewer.GetDocumentFacade().Pages[pageNumber - 1];

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

    // Clear the selected area
    pageFacade.ClearContent(rectangle, options);
}

VB.NET

Imports DevExpress.Pdf
Imports System

Public Sub New()
    InitializeComponent()
    pdfViewer.LoadDocument("Document.pdf")
    AddHandler pdfViewer.MouseDown, AddressOf pdfViewer_MouseDown
    AddHandler pdfViewer.MouseUp, AddressOf pdfViewer_MouseUp
End Sub

Private startSelectionPosition As PdfDocumentPosition

Private Sub pdfViewer_MouseDown(ByVal sender As Object, ByVal e As MouseEventArgs)
    ' Get the start position of the selection
    startSelectionPosition = pdfViewer.GetDocumentPosition(e.Location, True)
    If startSelectionPosition Is Nothing Then
        Return
    End If
End Sub

Private Sub pdfViewer_MouseUp(ByVal sender As Object, ByVal e As MouseEventArgs)
    ' Retrieve the end position of the selection
    Dim endSelectionPosition As PdfDocumentPosition = pdfViewer.GetDocumentPosition(e.Location)
    If endSelectionPosition Is Nothing OrElse startSelectionPosition Is Nothing Then
        Return
    End If
    If endSelectionPosition.Point.Equals(startSelectionPosition.Point) Then
        Return
    End If

    ' Define the selection area
    Dim left As Double = Math.Min(startSelectionPosition.Point.X, endSelectionPosition.Point.X)
    Dim bottom As Double = Math.Min(startSelectionPosition.Point.Y, endSelectionPosition.Point.Y)
    Dim right As Double = Math.Max(startSelectionPosition.Point.X, endSelectionPosition.Point.X)
    Dim top As Double = Math.Max(startSelectionPosition.Point.Y, endSelectionPosition.Point.Y)
    Dim rectangle As New PdfRectangle(left, bottom, right, top)
    Dim pageNumber As Integer = startSelectionPosition.PageNumber

    ' Retrieve the page properties
    Dim pageFacade As PdfPageFacade = pdfViewer.GetDocumentFacade().Pages(pageNumber - 1)

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

    ' Clear the selected area
    pageFacade.ClearContent(rectangle, options)
End Sub