SetLineJoinStyle Method (GdPicturePDF)

In This Topic

Sets the line join style. The line join style specifies the shape to be used at the corners of paths that are stroked, for example, when you subsequently use the GdPicturePDF.DrawRectangle method. The initial value is set to miter join style (0).

The line join 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 SetLineJoinStyle( _
   ByVal LineJoin As PdfLineJoinStyle _
) As GdPictureStatus

public GdPictureStatus SetLineJoinStyle( 
   PdfLineJoinStyle LineJoin
)

public function SetLineJoinStyle( 
    LineJoin: PdfLineJoinStyle
): GdPictureStatus;

public function SetLineJoinStyle( 
   LineJoin : PdfLineJoinStyle
) : GdPictureStatus;

public: GdPictureStatus SetLineJoinStyle( 
   PdfLineJoinStyle LineJoin
)

public:
GdPictureStatus SetLineJoinStyle( 
   PdfLineJoinStyle LineJoin
)

Parameters

LineJoin: A member of the PdfLineJoinStyle enumeration. Specifies the shape of joints between connected segments of a stroked path. Initial value is PdfLineJoinStyle.PdfLineJoinStyleMiter.

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.

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

Example

How to set different styles to join lines when drawing various rectangles.

VB.NET
C#

Dim caption As String = "Example: SetLineJoinStyle"
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(5) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetLineColor(255, 0, 0) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetFillColor(0, 255, 255) = GdPictureStatus.OK) AndAlso ' (gdpicturePDF.SetLineJoinStyle(PdfLineJoinStyle.PdfLineJoinStyleMiter) == GdPictureStatus.OK) AndAlso ' initial value
       (gdpicturePDF.DrawRectangle(20, 10, 40, 20, True, True) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetLineJoinStyle(PdfLineJoinStyle.PdfLineJoinStyleRound) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.DrawRectangle(20, 50, 40, 20, True, True) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetLineJoinStyle(PdfLineJoinStyle.PdfLineJoinStyleBevel) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.DrawRectangle(20, 90, 40, 20, True, True) = 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: SetLineJoinStyle";
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(5) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetLineColor(255, 0, 0) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetFillColor(0, 255, 255) == GdPictureStatus.OK) &&
        //(gdpicturePDF.SetLineJoinStyle(PdfLineJoinStyle.PdfLineJoinStyleMiter) == GdPictureStatus.OK) && // initial value
        (gdpicturePDF.DrawRectangle(20, 10, 40, 20, true, true) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetLineJoinStyle(PdfLineJoinStyle.PdfLineJoinStyleRound) == GdPictureStatus.OK) &&
        (gdpicturePDF.DrawRectangle(20, 50, 40, 20, true, true) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetLineJoinStyle(PdfLineJoinStyle.PdfLineJoinStyleBevel) == GdPictureStatus.OK) &&
        (gdpicturePDF.DrawRectangle(20, 90, 40, 20, true, true) == 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
SetLineCapStyle Method
SetLineWidth Method
SetLineColor(Byte,Byte,Byte) Method
DrawLine Method
DrawRectangle Method
ResetGraphicsState Method