GdPicture.NET.14
GdPicture14 Namespace / GdPicturePDF Class / EndPath Method
Example





In This Topic
EndPath Method (GdPicturePDF)
In This Topic
Ends the current path object, that means empties the current path, defined within a currently selected page of the loaded PDF document, without filling or stroking it. More precisely, this method sets the path-painting no-op operator "n". If the current sub-path is already closed, any other additional "n" operator does nothing (see PDF Reference, Section "Path Construction Operators"). This operator is mostly used with a clipping path operator.
Syntax
'Declaration
 
Public Function EndPath() As GdPictureStatus
public GdPictureStatus EndPath()
public function EndPath(): GdPictureStatus; 
public function EndPath() : GdPictureStatus;
public: GdPictureStatus EndPath(); 
public:
GdPictureStatus EndPath(); 

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.

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

Example
How to end a currently defined path.
Dim caption As String = "Example: EndPath"
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.AddEllipseToPath(300, 400, 400, 200) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetFillColor(0, 0, 255) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.FillPath() = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.AddEllipseToPath(300, 400, 400, 200) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.ClipPath() = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.EndPath() = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetFillColor(128, 128, 0) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.BeginPath(50, 20) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.AddCurveToPath1(10, 500, 200, 400) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.FillPath() = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.BeginPath(550, 20) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.AddCurveToPath2(510, 500, 300, 400) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.FillPath() = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.BeginPath(50, 750) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.AddCurveToPath3(10, 550, 300, 480, 500, 600) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.FillPath() = GdPictureStatus.OK) Then
        status = gdpicturePDF.SaveToFile("test_EndPath.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: EndPath";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
GdPictureStatus status = gdpicturePDF.NewPDF();
if (status == GdPictureStatus.OK)
{
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
    if ((gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK) &&
        (gdpicturePDF.AddEllipseToPath(300, 400, 400, 200) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetFillColor(0, 255, 255) == GdPictureStatus.OK) &&
        (gdpicturePDF.FillPath() == GdPictureStatus.OK) &&
        (gdpicturePDF.AddEllipseToPath(300, 400, 400, 200) == GdPictureStatus.OK) &&
        (gdpicturePDF.ClipPath() == GdPictureStatus.OK) &&
        (gdpicturePDF.EndPath() == GdPictureStatus.OK) &&
        (gdpicturePDF.SetFillColor(128, 128, 0) == GdPictureStatus.OK) &&
        (gdpicturePDF.BeginPath(50, 20) == GdPictureStatus.OK) &&
        (gdpicturePDF.AddCurveToPath1(10, 500, 200, 400) == GdPictureStatus.OK) &&
        (gdpicturePDF.FillPath() == GdPictureStatus.OK) &&
        (gdpicturePDF.BeginPath(550, 20) == GdPictureStatus.OK) &&
        (gdpicturePDF.AddCurveToPath2(510, 500, 300, 400) == GdPictureStatus.OK) &&
        (gdpicturePDF.FillPath() == GdPictureStatus.OK) &&
        (gdpicturePDF.BeginPath(50, 750) == GdPictureStatus.OK) &&
        (gdpicturePDF.AddCurveToPath3(10, 550, 300, 480, 500, 600) == GdPictureStatus.OK) &&
        (gdpicturePDF.FillPath() == GdPictureStatus.OK))
    {
        status = gdpicturePDF.SaveToFile("test_EndPath1.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();
See Also