SetLineCapStyle Method (GdPicturePDF)

In This Topic

Sets the line cap style. The line cap style specifies the shape to be used at the ends of open subpaths (and dashes, if any) when they are stroked. This style is subsequently used for example, when drawing a line with the DrawLine method(). The initial value is set to square butt cap (0).

The line cap parameter is one of the graphics state parameters. These parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Graphics State").

Syntax

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

'Declaration
 
Public Function SetLineCapStyle( _
   ByVal LineCap As PdfLineCapStyle _
) As GdPictureStatus

public GdPictureStatus SetLineCapStyle( 
   PdfLineCapStyle LineCap
)

public function SetLineCapStyle( 
    LineCap: PdfLineCapStyle
): GdPictureStatus;

public function SetLineCapStyle( 
   LineCap : PdfLineCapStyle
) : GdPictureStatus;

public: GdPictureStatus SetLineCapStyle( 
   PdfLineCapStyle LineCap
)

public:
GdPictureStatus SetLineCapStyle( 
   PdfLineCapStyle LineCap
)

Parameters

LineCap: A member of the PdfLineCapStyle enumeration. Specifies the shape of the endpoints for any open path that is stroked. Initial value is PdfLineCapStyle.PdfLineCapStyleButt.

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 any open path, that is subsequently stroked, uses the defined endpoint shape (cap style).

Be aware also that graphics state parameters are initialized to their default values at the beginning of each page.

Example

How to set different cap styles to draw various lines.

VB.NET
C#

Dim caption As String = "Example: SetLineCapStyle"
Dim gdpicturePDF As New GdPicturePDF()
Dim status As GdPictureStatus = gdpicturePDF.NewPDF()
If status = GdPictureStatus.OK Then
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitMillimeter)
    If (gdpicturePDF.NewPage(210, 297) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.ResetGraphicsState() = GdPictureStatus.OK) AndAlso 'The default graphics state is set.
       (gdpicturePDF.SetLineWidth(10) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetLineColor(255, 0, 0) = GdPictureStatus.OK) AndAlso '(gdpicturePDF.SetLineCapStyle(PdfLineCapStyle.PdfLineCapStyleButt) == GdPictureStatus.OK) AndAlso ' initial value
       (gdpicturePDF.DrawLine(20, 20, 60, 20) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetLineCapStyle(PdfLineCapStyle.PdfLineCapStyleProjectingSquare) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.DrawLine(20, 50, 60, 50) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetLineCapStyle(PdfLineCapStyle.PdfLineCapStyleRound) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.DrawLine(20, 80, 60, 80) = GdPictureStatus.OK) Then
        status = gdpicturePDF.SaveToFile("test_Lines.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: SetLineCapStyle";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
GdPictureStatus status = gdpicturePDF.NewPDF();
if (status == GdPictureStatus.OK)
{
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitMillimeter);
    if ((gdpicturePDF.NewPage(210, 297) == GdPictureStatus.OK) &&
        (gdpicturePDF.ResetGraphicsState() == GdPictureStatus.OK) && //The default graphics state is set.
        (gdpicturePDF.SetLineWidth(10) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetLineColor(255, 0, 0) == GdPictureStatus.OK) &&
        //(gdpicturePDF.SetLineCapStyle(PdfLineCapStyle.PdfLineCapStyleButt) == GdPictureStatus.OK) &&  // initial value
        (gdpicturePDF.DrawLine(20, 20, 60, 20) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetLineCapStyle(PdfLineCapStyle.PdfLineCapStyleProjectingSquare) == GdPictureStatus.OK) &&
        (gdpicturePDF.DrawLine(20, 50, 60, 50) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetLineCapStyle(PdfLineCapStyle.PdfLineCapStyleRound) == GdPictureStatus.OK) &&
        (gdpicturePDF.DrawLine(20, 80, 60, 80) == GdPictureStatus.OK))
    {
        status = gdpicturePDF.SaveToFile("test_Lines.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
SetLineJoinStyle Method
SetLineWidth Method
SetLineColor(Byte,Byte,Byte) Method
DrawLine Method
DrawRectangle Method
ResetGraphicsState Method