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

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

'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

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.

VB.NET
C#

Dim caption As String = "Example: SetLineColor"
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, 20, 40, 20, True, True) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetLineWidth(3) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetLineColor(255, 0, 0) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetFillColor(255, 228, 196) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.DrawRectangle(80, 20, 40, 20, True, True) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetLineWidth(5) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetLineColor(210, 105, 30) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.SetFillColor(255, 0, 255) = GdPictureStatus.OK) AndAlso
       (gdpicturePDF.DrawRectangle(150, 20, 40, 20, True, True) = GdPictureStatus.OK) Then
        status = gdpicturePDF.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 " + 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: SetLineColor";
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, 20, 40, 20, true, true) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetLineWidth(3) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetLineColor(255, 0, 0) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetFillColor(255, 228, 196) == GdPictureStatus.OK) &&
        (gdpicturePDF.DrawRectangle(80, 20, 40, 20, true, true) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetLineWidth(5) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetLineColor(210, 105, 30) == GdPictureStatus.OK) &&
        (gdpicturePDF.SetFillColor(255, 0, 255) == GdPictureStatus.OK) &&
        (gdpicturePDF.DrawRectangle(150, 20, 40, 20, true, true) == GdPictureStatus.OK))
    {
        status = gdpicturePDF.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 " + 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
Overload List
SetFillColor(Byte,Byte,Byte) Method
SetLineWidth Method
DrawLine Method
DrawRectangle Method
RestoreGraphicsState Method