Reference Guide
GdPicture14 Namespace / GdPicturePDF Class / SetLineColor Method / SetLineColor(Byte,Byte,Byte) Method
The amount of red color to be used for the resulting color. Use the value between 0 and 255.
The amount of green color to be used for the resulting color. Use the value between 0 and 255.
The amount of blue color to be used for the resulting color. Use the value between 0 and 255.
Example





In This Topic
    SetLineColor(Byte,Byte,Byte) Method
    In This Topic
    Sets the line color used by all subsequent stroking operations, like the DrawLine method or the DrawRectangle method. The initial value is set to black.

    This method uses the RGB color space for specifying the required color.

    The line (stroke) color 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 Overloads Function SetLineColor( _
       ByVal Red As Byte, _
       ByVal Green As Byte, _
       ByVal Blue As Byte _
    ) As GdPictureStatus
    public GdPictureStatus SetLineColor( 
       byte Red,
       byte Green,
       byte Blue
    )
    public function SetLineColor( 
        Red: Byte;
        Green: Byte;
        Blue: Byte
    ): GdPictureStatus; 
    public function SetLineColor( 
       Red : byte,
       Green : byte,
       Blue : byte
    ) : GdPictureStatus;
    public: GdPictureStatus SetLineColor( 
       byte Red,
       byte Green,
       byte Blue
    ) 
    public:
    GdPictureStatus SetLineColor( 
       byte Red,
       byte Green,
       byte Blue
    ) 

    Parameters

    Red
    The amount of red color to be used for the resulting color. Use the value between 0 and 255.
    Green
    The amount of green color to be used for the resulting color. Use the value between 0 and 255.
    Blue
    The amount of blue color to be used for the resulting color. Use the value between 0 and 255.

    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
    Please note that this method is only allowed for use with non-encrypted documents.

    Just to remind you that the initial line color is black.

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

    Example
    How to set the different line colors to draw various rectangles.
    Dim caption As String = "Example: SetLineColor"
    Dim oGdPicturePDF As New GdPicturePDF()
    Dim status As GdPictureStatus = oGdPicturePDF.NewPDF()
    If status = GdPictureStatus.OK Then
        oGdPicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
        oGdPicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitMillimeter)
        If (oGdPicturePDF.NewPage(210, 297) = GdPictureStatus.OK) AndAlso
           (oGdPicturePDF.ResetGraphicsState() = GdPictureStatus.OK) AndAlso 'The default graphics state is set.
           (oGdPicturePDF.SetLineWidth(1) = GdPictureStatus.OK) AndAlso
           (oGdPicturePDF.SetLineColor(0, 0, 255) = GdPictureStatus.OK) AndAlso
           (oGdPicturePDF.SetFillColor(0, 255, 255) = GdPictureStatus.OK) AndAlso
           (oGdPicturePDF.DrawRectangle(10, 20, 40, 20, True, True) = GdPictureStatus.OK) AndAlso
           (oGdPicturePDF.SetLineWidth(3) = GdPictureStatus.OK) AndAlso
           (oGdPicturePDF.SetLineColor(255, 0, 0) = GdPictureStatus.OK) AndAlso
           (oGdPicturePDF.SetFillColor(255, 228, 196) = GdPictureStatus.OK) AndAlso
           (oGdPicturePDF.DrawRectangle(80, 20, 40, 20, True, True) = GdPictureStatus.OK) AndAlso
           (oGdPicturePDF.SetLineWidth(5) = GdPictureStatus.OK) AndAlso
           (oGdPicturePDF.SetLineColor(210, 105, 30) = GdPictureStatus.OK) AndAlso
           (oGdPicturePDF.SetFillColor(255, 0, 255) = GdPictureStatus.OK) AndAlso
           (oGdPicturePDF.DrawRectangle(150, 20, 40, 20, True, True) = GdPictureStatus.OK) Then
            status = oGdPicturePDF.SaveToFile("test_LineColor.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 " + oGdPicturePDF.GetStat().ToString(), caption)
        End If
    Else
        MessageBox.Show("The NewPDF() method has failed with the status: " + status.ToString(), caption)
    End If
    oGdPicturePDF.Dispose()
    string caption = "Example: SetLineColor";
    GdPicturePDF oGdPicturePDF = new GdPicturePDF();
    GdPictureStatus status = oGdPicturePDF.NewPDF();
    if (status == GdPictureStatus.OK)
    {
        oGdPicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
        oGdPicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitMillimeter);
        if ((oGdPicturePDF.NewPage(210, 297) == GdPictureStatus.OK) &&
            (oGdPicturePDF.ResetGraphicsState() == GdPictureStatus.OK) && //The default graphics state is set.
            (oGdPicturePDF.SetLineWidth(1) == GdPictureStatus.OK) &&
            (oGdPicturePDF.SetLineColor(0, 0, 255) == GdPictureStatus.OK) &&
            (oGdPicturePDF.SetFillColor(0, 255, 255) == GdPictureStatus.OK) &&
            (oGdPicturePDF.DrawRectangle(10, 20, 40, 20, true, true) == GdPictureStatus.OK) &&
            (oGdPicturePDF.SetLineWidth(3) == GdPictureStatus.OK) &&
            (oGdPicturePDF.SetLineColor(255, 0, 0) == GdPictureStatus.OK) &&
            (oGdPicturePDF.SetFillColor(255, 228, 196) == GdPictureStatus.OK) &&
            (oGdPicturePDF.DrawRectangle(80, 20, 40, 20, true, true) == GdPictureStatus.OK) &&
            (oGdPicturePDF.SetLineWidth(5) == GdPictureStatus.OK) &&
            (oGdPicturePDF.SetLineColor(210, 105, 30) == GdPictureStatus.OK) &&
            (oGdPicturePDF.SetFillColor(255, 0, 255) == GdPictureStatus.OK) &&
            (oGdPicturePDF.DrawRectangle(150, 20, 40, 20, true, true) == GdPictureStatus.OK))
        {
            status = oGdPicturePDF.SaveToFile("test_LineColor.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 " + oGdPicturePDF.GetStat().ToString(), caption);
    }
    else
        MessageBox.Show("The NewPDF() method has failed with the status: " + status.ToString(), caption);
    oGdPicturePDF.Dispose();
    See Also