Clip PDF page content in C#
This sample demonstrates how to mask out a rectangular area on a PDF page using a clip shape in C#. This will not erase the actual graphics. Masked out text will still be selectable for example.
Clip shape is an object that masks out graphics so that only the content inside the clip shape is visible. In other words, anything outside the clip shape will not be visible. In this sample we will create a clip shape that preserves the whole page except a specified rectangular area. To achieve that effect, we will combine two rectangular paths using the even-odd fill rule like this:
Two paths:
The combined result:
private static Page ClipContent(Page page, Rectangle eraserRect)
{
// extract all graphics as shapes
ShapeCollection shapes = page.CreateShapes();
Rectangle visibleRectangle = page.MediaBox;
// create a rectangular path that encloses the entire page
// (the 'true' argument closes the path)
FreeHandPath visibleArea = new FreeHandPath(true);
visibleArea.Segments.Add(new FreeHandStartSegment(
visibleRectangle.Left, visibleRectangle.Bottom));
visibleArea.Segments.Add(new FreeHandLineSegment(
visibleRectangle.Left + visibleRectangle.Width,
visibleRectangle.Bottom));
visibleArea.Segments.Add(new FreeHandLineSegment(
visibleRectangle.Left + visibleRectangle.Width,
visibleRectangle.Bottom + visibleRectangle.Height));
visibleArea.Segments.Add(new FreeHandLineSegment(
visibleRectangle.Left,
visibleRectangle.Bottom + visibleRectangle.Height));
// create a path for the rectangular area that we want to exclude
FreeHandPath exludedArea = new FreeHandPath(true);
exludedArea.Segments.Add(new FreeHandStartSegment(
eraserRect.Left, eraserRect.Bottom));
exludedArea.Segments.Add(new FreeHandLineSegment(
eraserRect.Left + eraserRect.Width,
eraserRect.Bottom));
exludedArea.Segments.Add(new FreeHandLineSegment(
eraserRect.Left + eraserRect.Width,
eraserRect.Bottom + eraserRect.Height));
exludedArea.Segments.Add(new FreeHandLineSegment(
eraserRect.Left,
eraserRect.Bottom + eraserRect.Height));
// now combine the two paths (see illustration above) using even-odd fill rule
// closed paths inside other paths will alternate from being included to being
// excluded and vice versa
// this results in the combined path as shown above
ClipShape clipShape = new ClipShape();
clipShape.FillRule = FillRule.EvenOdd;
clipShape.Paths.Add(visibleArea);
clipShape.Paths.Add(exludedArea);
// insert the clipShape at the very start because the clipping
// affects all subsequent shapes in the collection
shapes.Insert(0, clipShape);
// create a new page based on the original page without the graphics (empty)
page = page.Clone(PageCloneSettings.NoOriginalGraphics);
page.Overlay.Add(shapes);
return page;
}
Private Function ClipContent(page As Page, eraserRect As Rectangle) As Page
' extract all graphics as shapes
Dim shapes As ShapeCollection = page.CreateShapes()
Dim visibleRectangle As Rectangle = page.MediaBox
' create a rectangular path that encloses the entire page
' (the 'true' argument closes the path)
Dim visibleArea As New FreeHandPath(True)
visibleArea.Segments.Add(New FreeHandStartSegment(visibleRectangle.Left, visibleRectangle.Bottom))
visibleArea.Segments.Add(New FreeHandLineSegment(visibleRectangle.Left + visibleRectangle.Width, visibleRectangle.Bottom))
visibleArea.Segments.Add(New FreeHandLineSegment(visibleRectangle.Left + visibleRectangle.Width, visibleRectangle.Bottom + visibleRectangle.Height))
visibleArea.Segments.Add(New FreeHandLineSegment(visibleRectangle.Left, visibleRectangle.Bottom + visibleRectangle.Height))
' create a path for the rectangular area that we want to exclude
Dim exludedArea As New FreeHandPath(True)
exludedArea.Segments.Add(New FreeHandStartSegment(eraserRect.Left, eraserRect.Bottom))
exludedArea.Segments.Add(New FreeHandLineSegment(eraserRect.Left + eraserRect.Width, eraserRect.Bottom))
exludedArea.Segments.Add(New FreeHandLineSegment(eraserRect.Left + eraserRect.Width, eraserRect.Bottom + eraserRect.Height))
exludedArea.Segments.Add(New FreeHandLineSegment(eraserRect.Left, eraserRect.Bottom + eraserRect.Height))
' now combine the two paths (see illustration above) using even-odd fill rule
' closed paths inside other paths will alternate from being included to being
' excluded and vice versa
' this results in the combined path as shown above
Dim clipShape As New ClipShape()
clipShape.FillRule = FillRule.EvenOdd
clipShape.Paths.Add(visibleArea)
clipShape.Paths.Add(exludedArea)
' insert the clipShape at the very start because the clipping
' affects all subsequent shapes in the collection
shapes.Insert(0, clipShape)
' create a new page based on the original page without the graphics (empty)
page = page.Clone(PageCloneSettings.NoOriginalGraphics)
page.Overlay.Add(shapes)
Return page
End Function
The initial page and the result.
No results
Add Long Term Validation (LTV) data to an existing signature
Render PDF to multipage color TIFF
Render PDF page to Skia surface
Render PDF page as PNG
How to downscale all images in a PDF
How to generate and export certificates
How to downscale all images in a PDF
Add Stamp to PDF
How to use a system font for rendering text
Customize the GUI interaction of a radio button
Customize the UI interaction of a check box
PDF to grayscale TIFF
How to reduce PDF file size
How do I create graphics with Icc based colors
Highlight fields in PDF
Add a note to PDF
Display PDF in a WPF app and stay responsive – the code
Draw interactively on a PDF page
Resize PDF pages
Verify a custom digital PDF signature
C# Print PDF documents from a WPF application
Extract glyph boxes from PDF
Use TrueType font collections
Layout text with MultilineTextShape
Calculate the height of a paragraph in PDF
Merge PDF files in C# .NET
How do I extract page destinations from bookmarks?
Clip PDF page content in C#
How do I use PDFControls.NET in a WPF application
Fill PDF form
Extract glyphs and sort by reading order
Add bookmarks to PDF
How to scale content of PDF
Create rectangles with rounded corners
Create text with decorations
Create layers in PDF and draw on each layer
Multipage TIFF to PDF
TIFF to PDF C#
Crop content on a PDF page
How to embed files in a PDF document
Remove graphics from PDF
Change the color inside a PDF
Create PDF in C#
Text formatting
Import FDF into PDF
Flatten PDF form
Digitally sign a PDF form in C# or VB.NET
Vector graphics in PDF
Translate PDF page content
Extract graphics from PDF
Determine the content bounding box
How to add page numbers to your PDF
Create / impose PDF 2-up
Search text in PDF
Append multiple PDF documents
Convert PDF to plain text
Flatten Markup Annotation
Add text field to PDF
Extract embedded files from PDF
Extract images from PDF
Add a Diagonal Watermark to PDF in C#
Fit image to PDF page
Add simple html text to PDF
Add multiline text to a PDF document
Add single-line text to PDF
Create a new digitally signed PDF document
PDF Viewer Preferences
Change page orientation PDF
Split PDF pages in C# and VB.NET
Append two or more existing PDF files
Change colors of black-and-white TIFF after converting from PDF
Determine if a PDF only contains images
Add footer to PDF
Convert SVG to PDF
Fill in a PDF form using MVC
C# render pdf in browser using MVC
Convert XHTML to PDF
Add hyperlink to PDF
Rotate a PDF page
Change the formatting of a numeric field
How to mirror PDF pages and other shapes
Fill in a template PDF document
How to add autosized text to PDF
Create formfields in PDF documents
Export FDF from PDF form
Add a link with an internal destination to PDF
Remove PDF security settings
Add a link to PDF with an external destination
How to sign and verify updates to a PDF document
Convert PDF to PNG using WPF
Embed TrueType font
Override MouseWheel event
Convert PDF to an image using a dither matrix
Font mapping
Convert PDF with layers to image
C# Print PDF Document
Render PDF with ResolveFont event handler
Render PDF to EMF
Convert PDF to XPS
How to create a thumbnail viewer
How to create a tiling for shapes in PDF
Add footer with left and right aligned text on same line
Convert PDF to JPG in C#
EMF to PDF as vector image
EMF to PDF as raster image
Replace field with image
Add a rubber stamp annotation with a custom icon
Create a text annotation in PDF with rich text
XhtmlParagraph and TrueType fonts
What is the resulting fontsize in PDF for rich text used in a SimpleXhtmlShape
Read and write meta data from PDF
Create a custom signature handler to sign and verify PDF documents
Merge PDF
Stitch PDF documents
Download and convert image to PDF
Convert TXT to PDF
Add barcodes to PDF
Convert PDF to multipage TIFF in C# .NET
Convert multiple PDF pages to bitmap
Render a PDF to bitmap
Bulleted list from XML and XSL
Tagged PDF
PDFKit.NET 5.0 – detailed changes to the API
Create tagged PDF
PDFKit.NET 5.0 and .NET Core
PDFKit.NET 5.0 and Xamarin
Dynamic XFA
PDFKit.NET 5.0 .NET Standard API
.NET Core console app on MacOS
Add tags to existing PDF
Read PDF tags
Merge XDP data with dynamic XFA form
Fill XFA form and export XDP data
Fill and save dynamic XFA form
Use PDFKit.NET 5.0 with a Xamarin.Forms app
Use multiple licenses
Licensing and .NET Standard
Reduce PDF size
Generate PDF form from XML
Generate PDF with local images from XML with Xamarin.iOS
Disable submit button after submitting
Write Document to HttpResponse