SetFormFieldBorderColor(Int32,Int32,Byte,Byte,Byte,Byte) Method

In This Topic

Sets the border color of a required form field, here a child radio button in a group. The radio button group is specified by its unique form field's identifier and it is related to the currently loaded PDF document. Please note that every single child radio button in a group of radio buttons within a radio button field can have its own border color defined, that you are allowed to set using this method. As said, this method is only applicable to radio buttons.

Please use this method right after adding the required form field on the page, as the form field's border color attribute is not assigned automatically. Otherwise, the form field may display invisible.

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

Syntax

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

'Declaration
 
Public Overloads Function SetFormFieldBorderColor( _
   ByVal FieldId As Integer, _
   ByVal ChildIdx As Integer, _
   ByVal Cyan As Byte, _
   ByVal Magenta As Byte, _
   ByVal Yellow As Byte, _
   ByVal Black As Byte _
) As GdPictureStatus

public GdPictureStatus SetFormFieldBorderColor( 
   int FieldId,
   int ChildIdx,
   byte Cyan,
   byte Magenta,
   byte Yellow,
   byte Black
)

public function SetFormFieldBorderColor( 
    FieldId: Integer;
    ChildIdx: Integer;
    Cyan: Byte;
    Magenta: Byte;
    Yellow: Byte;
    Black: Byte
): GdPictureStatus;

public function SetFormFieldBorderColor( 
   FieldId : int,
   ChildIdx : int,
   Cyan : byte,
   Magenta : byte,
   Yellow : byte,
   Black : byte
) : GdPictureStatus;

public: GdPictureStatus SetFormFieldBorderColor( 
   int FieldId,
   int ChildIdx,
   byte Cyan,
   byte Magenta,
   byte Yellow,
   byte Black
)

public:
GdPictureStatus SetFormFieldBorderColor( 
   int FieldId,
   int ChildIdx,
   byte Cyan,
   byte Magenta,
   byte Yellow,
   byte Black
)

Parameters

FieldId: A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,Byte,Byte,Byte), GetFormFieldId or GetFormFieldChildID.
ChildIdx: The index of the required child radio button in a group. It must be a value from 0 to GetFormFieldChildCount-1.
It is simply a sequence index of a radio button in a group, it does not correspond to the unique form field's identifier.
Cyan: The amount of cyan color to be used for the resulting color. Use the value between 0 and 255.
Magenta: The amount of magenta color to be used for the resulting color. Use the value between 0 and 255.
Yellow: The amount of yellow color to be used for the resulting color. Use the value between 0 and 255.
Black: The amount of black 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. At the same, this method is only meaningful for radio buttons, otherwise it will fail.

Just to remind you, that the form field's border color attribute is not assigned automatically when creating the form field.

Example

How to specify the border color for the newly added radio button group. Each child radio button will have its own border color.

VB.NET
C#

Dim caption As String = "Example: SetFormFieldBorderColor"
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()
If (gdpicturePDF.NewPDF() = GdPictureStatus.OK) AndAlso
   (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) Then
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter)
    'Please always select the required page before adding a form field.
    If gdpicturePDF.SelectPage(1) = GdPictureStatus.OK Then
        Dim fontResName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesItalic)
        If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso
           (gdpicturePDF.DrawText(fontResName, 1, 0.8F, "What colour do you prefer for your T-shirt?") = GdPictureStatus.OK) Then
            Dim formID As Integer = 0
            Dim buttonName As String = "RadioButton"
            Dim colors1 As String() = New String(5) {"white", "yellow", "red", "blue", "green", "black"}
            Dim colors2 As Byte()() = New Byte(5)() {New Byte(3) {10, 10, 10, 10}, New Byte(3) {0, 0, 255, 0}, New Byte(3) {0, 255, 255, 0},
                                                     New Byte(3) {255, 255, 0, 0}, New Byte(3) {255, 127, 255, 127}, New Byte(3) {255, 255, 255, 255}}
            For i As Integer = 0 To colors1.Length - 1
                formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleCheck, 0, 0, 0, 0)
                If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) OrElse
                   (gdpicturePDF.SetFormFieldBackgroundColor(formID, 0, 0, 0, 0) <> GdPictureStatus.OK) OrElse
                   (gdpicturePDF.SetFormFieldBorderColor(formID, i, colors2(i)(0), colors2(i)(1), colors2(i)(2), colors2(i)(3)) <> GdPictureStatus.OK) OrElse
                   (gdpicturePDF.SetFormFieldFontColor(formID, i, colors2(i)(0), colors2(i)(1), colors2(i)(2), colors2(i)(3)) <> GdPictureStatus.OK) OrElse
                   (gdpicturePDF.SetFormFieldOnStateName(formID, i, colors1(i)) <> GdPictureStatus.OK) OrElse
                   (gdpicturePDF.DrawText(fontResName, 2.5F, 1.65F + i, colors1(i)) <> GdPictureStatus.OK) Then
                    MessageBox.Show("Adding the radio button nr." + (i + 1).ToString() + " has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                    Exit For
                End If
            Next
            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                If gdpicturePDF.SaveToFile("forms_radiobutton.pdf") = 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 SaveToFile() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                End If
            End If
        Else
            MessageBox.Show("Adding font or drawing text has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
        End If
    Else
        MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
    End If
Else
    MessageBox.Show("The file can't be created.", caption)
End If
gdpicturePDF.Dispose()

string caption = "Example: SetFormFieldBorderColor";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if ((gdpicturePDF.NewPDF() == GdPictureStatus.OK) &&
    (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK))
{
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter);
    //Please always select the required page before adding a form field.
    if (gdpicturePDF.SelectPage(1) == GdPictureStatus.OK)
    {
        string fontResName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesItalic);
        if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&
            (gdpicturePDF.DrawText(fontResName, 1, 0.8f, "What colour do you prefer for your T-shirt?") == GdPictureStatus.OK))
        {
            int formID = 0;
            string buttonName = "RadioButton";
            string[] colors1 = new string[6] { "white", "yellow", "red", "blue", "green", "black" };
            byte[][] colors2 = new byte[6][] { new byte[4] { 10, 10, 10, 10 }, new byte[4] { 0, 0, 255, 0 }, new byte[4] { 0, 255, 255, 0 },
                                               new byte[4] { 255, 255, 0, 0 }, new byte[4] { 255, 127, 255, 127 }, new byte[4] { 255, 255, 255, 255 } };
            for (int i = 0; i < colors1.Length; i++)
            {
                formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleCheck, 0, 0, 0, 0);
                if ((gdpicturePDF.GetStat() != GdPictureStatus.OK) ||
                    (gdpicturePDF.SetFormFieldBackgroundColor(formID, (byte)0, (byte)0, (byte)0, (byte)0) != GdPictureStatus.OK) ||
                    (gdpicturePDF.SetFormFieldBorderColor(formID, i, colors2[i][0], colors2[i][1], colors2[i][2], colors2[i][3]) != GdPictureStatus.OK) ||
                    (gdpicturePDF.SetFormFieldFontColor(formID, i, colors2[i][0], colors2[i][1], colors2[i][2], colors2[i][3]) != GdPictureStatus.OK) ||
                    (gdpicturePDF.SetFormFieldOnStateName(formID, i, colors1[i]) != GdPictureStatus.OK) ||
                    (gdpicturePDF.DrawText(fontResName, 2.5f, 1.65f + i, colors1[i]) != GdPictureStatus.OK))
                {
                    MessageBox.Show("Adding the radio button nr." + (i + 1).ToString() + " has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                    break;
                }
            }
            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            {
                if (gdpicturePDF.SaveToFile("forms_radiobutton.pdf") == 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 SaveToFile() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
            }
        }
        else
            MessageBox.Show("Adding font or drawing text has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
    }
    else
        MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
    MessageBox.Show("The file can't be created.", caption);
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
GetFormFieldBorderColor(Int32,Int32) Method
FormFieldHasBorderColor(Int32,Int32) Method
SetFormFieldNoBorderColor(Int32,Int32) Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,Color) Method