ClipPathOdd Method (GdPicturePDF)

In This Topic

Modifies the currently specified clipping path by intersecting it with the currently constructed path, defined within a currently selected page of the loaded PDF document. This method uses the even-odd rule to determine which regions lie inside the clipping path. In other words, this method sets the clipping path operator "W*". The clipping path is part of the graphics state and thus it is affected by the currently specified graphics state parameters (see PDF Reference, Section "Clipping Path Operators").

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function ClipPathOdd() As GdPictureStatus

public GdPictureStatus ClipPathOdd()

public function ClipPathOdd(): GdPictureStatus;

public function ClipPathOdd() : GdPictureStatus;

public: GdPictureStatus ClipPathOdd();

public:
GdPictureStatus ClipPathOdd();

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

This method is only allowed for use with non-encrypted documents.

Just to remind you that the initial clipping path includes the entire page.

For further assistance, please see the Path Construction and Painting section of the GdPicturePDF class in the Reference Guide, as well as the Clipping Path Operators section in the PDF Reference.

Example

How to utilize a clipping path to draw your images. The examples below show you the difference between the nonzero winding number rule and the even-odd rule.

VB.NET
C#

Dim caption As String = "Example: ClipPathOdd"
Dim gdpicturePDF As New GdPicturePDF()
Dim status As GdPictureStatus = gdpicturePDF.NewPDF()
If status = GdPictureStatus.OK Then
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
    If (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetFillColor(0, 0, 128) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.BeginPath(250, 100) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.AddLineToPath(100, 350) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.AddLineToPath(390, 170) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.AddLineToPath(110, 170) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.AddLineToPath(400, 350) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.ClosePath() = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.ClipPath() = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.DrawRectangle(0, 0, 612, 400, True, False) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetFillColor(0, 0, 128) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.BeginPath(250, 400) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.AddLineToPath(100, 650) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.AddLineToPath(390, 470) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.AddLineToPath(110, 470) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.AddLineToPath(400, 650) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.ClosePath() = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.ClipPathOdd() = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.DrawRectangle(0, 400, 612, 800, True, False) = GdPictureStatus.OK) Then
        status = gdpicturePDF.SaveToFile("test_ClipPathOdd.pdf")
        If status = GdPictureStatus.OK Then
            MessageBox.Show("The example has been followed successfully and the file has been saved.", caption)
        Else
            MessageBox.Show("The example has been followed successfully, but the file can't be saved. Status: " + status.ToString(), caption)
        End If
    Else
        MessageBox.Show("The example has not been followed successfully." + vbCrLf + "The last known status is " + gdpicturePDF.GetStat().ToString(), caption)
    End If
Else
    MessageBox.Show("The NewPDF() method has failed with the status: " + status.ToString(), caption)
End If
gdpicturePDF.Dispose()

string caption = "Example: ClipPathOdd";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
GdPictureStatus status = gdpicturePDF.NewPDF();
if (status == GdPictureStatus.OK)
{
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
    if ((gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetFillColor(0, 0, 128) == GdPictureStatus.OK) &&
        (gdpicturePDF.BeginPath(250, 100) == GdPictureStatus.OK) &&
        (gdpicturePDF.AddLineToPath(100, 350) == GdPictureStatus.OK) &&
        (gdpicturePDF.AddLineToPath(390, 170) == GdPictureStatus.OK) &&
        (gdpicturePDF.AddLineToPath(110, 170) == GdPictureStatus.OK) &&
        (gdpicturePDF.AddLineToPath(400, 350) == GdPictureStatus.OK) &&
        (gdpicturePDF.ClosePath() == GdPictureStatus.OK) &&
        (gdpicturePDF.ClipPath() == GdPictureStatus.OK) &&
        (gdpicturePDF.DrawRectangle(0, 0, 612, 400, true, false) == GdPictureStatus.OK) &&
        (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetFillColor(0, 0, 128) == GdPictureStatus.OK) &&
        (gdpicturePDF.BeginPath(250, 400) == GdPictureStatus.OK) &&
        (gdpicturePDF.AddLineToPath(100, 650) == GdPictureStatus.OK) &&
        (gdpicturePDF.AddLineToPath(390, 470) == GdPictureStatus.OK) &&
        (gdpicturePDF.AddLineToPath(110, 470) == GdPictureStatus.OK) &&
        (gdpicturePDF.AddLineToPath(400, 650) == GdPictureStatus.OK) &&
        (gdpicturePDF.ClosePath() == GdPictureStatus.OK) &&
        (gdpicturePDF.ClipPathOdd() == GdPictureStatus.OK) &&
        (gdpicturePDF.DrawRectangle(0, 400, 612, 800, true, false) == GdPictureStatus.OK))
    {
        status = gdpicturePDF.SaveToFile("test_ClipPathOdd.pdf");
        if (status == GdPictureStatus.OK)
            MessageBox.Show("The example has been followed successfully and the file has been saved.", caption);
        else
            MessageBox.Show("The example has been followed successfully, but the file can't be saved. Status: " + status.ToString(), caption);
    }
    else
        MessageBox.Show("The example has not been followed successfully.\nThe last known status is " + gdpicturePDF.GetStat().ToString(), caption);
}
else
    MessageBox.Show("The NewPDF() method has failed with the status: " + status.ToString(), caption);
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
BeginPath Method
AddLineToPath Method
AddEllipseToPath Method
ClosePath Method
ClipPath Method