Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / SetLineNoDash Method

SetLineNoDash Method (GdPicturePDF)

In This Topic
Removes (resets) the currently defined dash pattern previously set by the SetLineDash(Single,Single) method to the initial value, which is a solid line. The dash pattern is used when paths are stroked, for example, when you use the DrawLine method or the DrawRectangle method.

The line dash pattern 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
'Declaration

 

Public Function SetLineNoDash() As GdPictureStatus
public GdPictureStatus SetLineNoDash()
public function SetLineNoDash(): GdPictureStatus; 
public function SetLineNoDash() : GdPictureStatus;
public: GdPictureStatus SetLineNoDash(); 
public:

GdPictureStatus SetLineNoDash(); 

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 setting all parameters to zero when using the SetLineDash(Single,Single) method restores the dash pattern to a solid line in the same way like using the SetLineNoDash method.

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

Example
How to set and remove dash patterns to draw various rectangles.
Dim caption As String = "Example: SetLineNoDash"

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(1) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.SetLineColor(0, 0, 255) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.SetFillColor(0, 255, 255) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.DrawRectangle(10, 10, 40, 20, True, True) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.SetLineWidth(5) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.DrawRectangle(80, 10, 40, 20, True, True) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.SetLineWidth(2) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.SetLineDash(5, 3) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.DrawRectangle(150, 10, 40, 20, True, True) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.SetLineNoDash() = GdPictureStatus.OK) AndAlso 'it is the same as (gdpicturePDF.SetLineDash(0, 0) = GdPictureStatus.OK)

       (gdpicturePDF.SetLineColor(255, 0, 0) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.SetLineWidth(0) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.DrawRectangle(10, 50, 40, 20, True, True) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.SetLineWidth(3) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.DrawRectangle(80, 50, 40, 20, True, True) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.SetLineWidth(1) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.SetLineDash(New Single() {2, 1, 1, 1}) = GdPictureStatus.OK) AndAlso

       (gdpicturePDF.DrawRectangle(150, 50, 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: SetLineNoDash";

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(1) == GdPictureStatus.OK) &&

        (gdpicturePDF.SetLineColor(0, 0, 255) == GdPictureStatus.OK) &&

        (gdpicturePDF.SetFillColor(0, 255, 255) == GdPictureStatus.OK) &&

        (gdpicturePDF.DrawRectangle(10, 10, 40, 20, true, true) == GdPictureStatus.OK) &&

        (gdpicturePDF.SetLineWidth(5) == GdPictureStatus.OK) &&

        (gdpicturePDF.DrawRectangle(80, 10, 40, 20, true, true) == GdPictureStatus.OK) &&

        (gdpicturePDF.SetLineWidth(2) == GdPictureStatus.OK) &&

        (gdpicturePDF.SetLineDash(5, 3) == GdPictureStatus.OK) &&

        (gdpicturePDF.DrawRectangle(150, 10, 40, 20, true, true) == GdPictureStatus.OK) &&

        (gdpicturePDF.SetLineNoDash() == GdPictureStatus.OK) && //it is the same as (gdpicturePDF.SetLineDash(0, 0) == GdPictureStatus.OK)

        (gdpicturePDF.SetLineColor(255, 0, 0) == GdPictureStatus.OK) &&

        (gdpicturePDF.SetLineWidth(0) == GdPictureStatus.OK) &&

        (gdpicturePDF.DrawRectangle(10, 50, 40, 20, true, true) == GdPictureStatus.OK) &&

        (gdpicturePDF.SetLineWidth(3) == GdPictureStatus.OK) &&

        (gdpicturePDF.DrawRectangle(80, 50, 40, 20, true, true) == GdPictureStatus.OK) &&

        (gdpicturePDF.SetLineWidth(1) == GdPictureStatus.OK) &&

        (gdpicturePDF.SetLineDash(new float[] {2, 1, 1, 1}) == GdPictureStatus.OK) &&

        (gdpicturePDF.DrawRectangle(150, 50, 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();
See Also