Clipping

Docotic.Pdf Library Help > Samples > Graphics > Clipping

This sample shows how to use current graphics path as a clip region of a canvas.

After a graphics path is constructed, you can set it as a clip region of a canvas using PdfCanvas.SetClip method. After a clip region is set, you can fill or stroke it. You can also just continue drawing on a canvas.

When a clip region is set on a canvas, any part of a drawn object (including text and images) that lay outside the clip region will not be visible.

CopyC#

using System.Diagnostics;
using System.Drawing;
using System.Drawing.Drawing2D;

namespace BitMiracle.Docotic.Pdf.Samples
{
    public static class Clipping
    {
        public static void Main()
        {
            // NOTE: 
            // When used in trial mode, the library imposes some restrictions.
            // Please visit http://bitmiracle.com/pdf-library/trial-restrictions.aspx
            // for more information.

            PdfDocument pdf = new PdfDocument();

            PdfCanvas canvas = pdf.Pages[0].Canvas;
            canvas.Pen.Width = 2;
            canvas.Brush.Color = new PdfRgbColor(255, 0, 0);

            drawStar(canvas);

            canvas.SetClip(PdfFillMode.Alternate);
            canvas.StrokePath();

            canvas.DrawRectangle(new PdfRectangle(0, 0, 500, 500), PdfDrawMode.Fill);

            string pathToFile = "Clipping.pdf";
            pdf.Save(pathToFile);
            pdf.Dispose();

            Process.Start(pathToFile);
        }

        private static void drawStar(PdfCanvas canvas)
        {
            canvas.CurrentPosition = new PdfPoint(10, 100);
            canvas.AppendLineTo(110, 100);
            canvas.AppendLineTo(30, 160);
            canvas.AppendLineTo(60, 70);
            canvas.AppendLineTo(80, 160);
            canvas.ClosePath();
        }
    }
}

CopyVB.NET

Imports System.Diagnostics
Imports System.Drawing
Imports System.Drawing.Drawing2D
Imports System.IO

Imports BitMiracle.Docotic.Pdf

Namespace BitMiracle.Docotic.Pdf.Samples
    Public NotInheritable Class Clipping
        Public Shared Sub Main()
            ' NOTE: 
            ' When used in trial mode, the library imposes some restrictions.
            ' Please visit http://bitmiracle.com/pdf-library/trial-restrictions.aspx
            ' for more information.


            Dim pdf As New PdfDocument()

            Dim canvas As PdfCanvas = pdf.Pages(0).Canvas
            canvas.Pen.Width = 2
            canvas.Brush.Color = New PdfRgbColor(255, 0, 0)

            drawStar(canvas)

            canvas.SetClip(PdfFillMode.Alternate)
            canvas.StrokePath()

            canvas.DrawRectangle(New PdfRectangle(0, 0, 500, 500), PdfDrawMode.Fill)

            Dim pathToFile As String = "Clipping.pdf"
            pdf.Save(pathToFile)
            pdf.Dispose()

            Process.Start(pathToFile)
        End Sub

        Private Shared Sub drawStar(ByVal canvas As PdfCanvas)
            canvas.CurrentPosition = New PdfPoint(10, 100)
            canvas.AppendLineTo(110, 100)
            canvas.AppendLineTo(30, 160)
            canvas.AppendLineTo(60, 70)
            canvas.AppendLineTo(80, 160)
            canvas.ClosePath()
        End Sub
    End Class
End Namespace