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.
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.

The amount of cyan color to be used for the resulting color. Use the value between 0 and 255.
The amount of magenta color to be used for the resulting color. Use the value between 0 and 255.
The amount of yellow color to be used for the resulting color. Use the value between 0 and 255.
The amount of black color to be used for the resulting color. Use the value between 0 and 255.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / SetFormFieldBackgroundColor Method / SetFormFieldBackgroundColor(Int32,Int32,Byte,Byte,Byte,Byte) Method

SetFormFieldBackgroundColor(Int32,Int32,Byte,Byte,Byte,Byte) Method

In This Topic
Sets the background (fill) 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 background (fill) 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 background (fill) 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
'Declaration

 

Public Overloads Function SetFormFieldBackgroundColor( _

   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 SetFormFieldBackgroundColor( 

   int FieldId,

   int ChildIdx,

   byte Cyan,

   byte Magenta,

   byte Yellow,

   byte Black

)
public function SetFormFieldBackgroundColor( 

    FieldId: Integer;

    ChildIdx: Integer;

    Cyan: Byte;

    Magenta: Byte;

    Yellow: Byte;

    Black: Byte

): GdPictureStatus; 
public function SetFormFieldBackgroundColor( 

   FieldId : int,

   ChildIdx : int,

   Cyan : byte,

   Magenta : byte,

   Yellow : byte,

   Black : byte

) : GdPictureStatus;
public: GdPictureStatus SetFormFieldBackgroundColor( 

   int FieldId,

   int ChildIdx,

   byte Cyan,

   byte Magenta,

   byte Yellow,

   byte Black

) 
public:

GdPictureStatus SetFormFieldBackgroundColor( 

   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 background (fill) color attribute is not assigned automatically when creating the form field.

Example
How to specify the background color for the newly added radio button group. Each child radio button will have its own background color.
Dim caption As String = "Example: SetFormFieldBackgroundColor"

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.PdfStandardFontHelvetica)

        If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso

           (gdpicturePDF.SetLineColor(255, 255, 255, 255) = GdPictureStatus.OK) Then

            Dim formID As Integer = 0

            Dim buttonName As String = "RadioButton"

            'Creating the first group of radio buttons.

            If gdpicturePDF.DrawRectangle(0.5F, 0.5F, 4, 4, False, True) = GdPictureStatus.OK Then

                Dim colors1 As String() = New String() {"RED", "GREEN", "BLUE"}

                Dim backColors1 As Byte()() = New Byte(2)() {New Byte(3) {0, 255, 255, 0}, New Byte(3) {255, 128, 255, 0}, New Byte(3) {255, 255, 0, 0}}

                For i As Integer = 0 To colors1.Length - 1

                    formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleStar, 0, 0, 0, 0)

                    If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) OrElse

                       (gdpicturePDF.SetFormFieldBackgroundColor(formID, i, backColors1(i)(0), backColors1(i)(1), backColors1(i)(2), backColors1(i)(3)) <> GdPictureStatus.OK) OrElse

                       (gdpicturePDF.SetFormFieldBorderColor(formID, 90, 213, 213, 90) <> GdPictureStatus.OK) OrElse

                       (gdpicturePDF.DrawText(fontResName, 2.5F, 1.65F + i, colors1(i)) <> GdPictureStatus.OK) Then

                        MessageBox.Show("1.group: adding the radio button nr." + (i + 1).ToString() + " has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                        'stop creating anything

                        Exit For

                    End If

                Next

                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                    'Creating the second group of radio buttons.

                    If gdpicturePDF.DrawRectangle(5.5F, 0.5F, 5, 5, False, True) = GdPictureStatus.OK Then

                        Dim colors2 As String() = New String() {"CYAN", "MAGENTA", "YELLOW", "BLACK"}

                        Dim backColors2 As Byte()() = New Byte(3)() {New Byte(3) {255, 0, 0, 0}, New Byte(3) {0, 255, 0, 0}, New Byte(3) {0, 0, 255, 0}, New Byte(3) {255, 255, 255, 255}}

                        For i As Integer = 0 To colors2.Length - 1

                            formID = gdpicturePDF.AddRadioButtonFormField(6, 1 + i, 1, 1, "Group2", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleCircle, 0, 0, 0, 0)

                            If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) OrElse

                               (gdpicturePDF.SetFormFieldBackgroundColor(formID, i, backColors2(i)(0), backColors2(i)(1), backColors2(i)(2), backColors2(i)(3)) <> GdPictureStatus.OK) OrElse

                               (gdpicturePDF.SetFormFieldBorderColor(formID, 90, 213, 213, 90) <> GdPictureStatus.OK) OrElse

                               (gdpicturePDF.DrawText(fontResName, 7.5F, 1.65F + i, colors2(i)) <> GdPictureStatus.OK) Then

                                MessageBox.Show("2.group: adding the radio button nr." + (i + 1).ToString() + " has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                                'stop creating anything

                                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 file can't be saved. Status: " + gdpicturePDF.GetStat().ToString(), caption)

                            End If

                        End If

                    Else

                        MessageBox.Show("The 2.DrawRectangle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                    End If

                End If

            Else

                MessageBox.Show("The 1.DrawRectangle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

            End If

        Else

            MessageBox.Show("The AddStandardFont() or the SetLineColor() method 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: SetFormFieldBackgroundColor";

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.PdfStandardFontHelvetica);

        if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&

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

        {

            int formID = 0;

            string buttonName = "RadioButton";

            //Creating the first group of radio buttons.

            if (gdpicturePDF.DrawRectangle(0.5f, 0.5f, 4, 4, false, true) == GdPictureStatus.OK)

            {

                string[] colors1 = new string[] { "RED", "GREEN", "BLUE" };

                byte[][] backColors1 = new byte[3][] { new byte[4] {0, 255, 255, 0}, new byte[4] {255, 128, 255, 0}, new byte[4] {255, 255, 0, 0} };

                for (int i = 0; i < colors1.Length; i++)

                {

                    formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleStar, 0, 0, 0, 0);

                    if ((gdpicturePDF.GetStat() != GdPictureStatus.OK) ||

                        (gdpicturePDF.SetFormFieldBackgroundColor(formID, i, backColors1[i][0], backColors1[i][1], backColors1[i][2], backColors1[i][3]) != GdPictureStatus.OK) ||

                        (gdpicturePDF.SetFormFieldBorderColor(formID, (byte)90, (byte)213, (byte)213, (byte)90) != GdPictureStatus.OK) ||

                        (gdpicturePDF.DrawText(fontResName, 2.5f, 1.65f + i, colors1[i]) != GdPictureStatus.OK))

                    {

                        MessageBox.Show("1.group: adding the radio button nr." + (i + 1).ToString() + " has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                        break; //stop creating anything

                    }

                }

                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

                {

                    //Creating the second group of radio buttons.

                    if (gdpicturePDF.DrawRectangle(5.5f, 0.5f, 5, 5, false, true) == GdPictureStatus.OK)

                    {

                        string[] colors2 = new string[] { "CYAN", "MAGENTA", "YELLOW", "BLACK" };

                        byte[][] backColors2 = new byte[4][] { new byte[4] { 255, 0, 0, 0 }, new byte[4] { 0, 255, 0, 0 }, new byte[4] { 0, 0, 255, 0 }, new byte[4] { 255, 255, 255, 255 } };

                        for (int i = 0; i < colors2.Length; i++)

                        {

            

                            formID = gdpicturePDF.AddRadioButtonFormField(6, 1 + i, 1, 1, "Group2", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleCircle, 255, 255, 255);

                            if ((gdpicturePDF.GetStat() != GdPictureStatus.OK) ||

                                (gdpicturePDF.SetFormFieldBackgroundColor(formID, i, backColors2[i][0], backColors2[i][1], backColors2[i][2], backColors2[i][3]) != GdPictureStatus.OK) ||

                                (gdpicturePDF.SetFormFieldBorderColor(formID, (byte)90, (byte)213, (byte)213, (byte)90) != GdPictureStatus.OK) ||

                                (gdpicturePDF.DrawText(fontResName, 7.5f, 1.65f + i, colors2[i]) != GdPictureStatus.OK))

                            {

                                MessageBox.Show("2.group: adding the radio button nr." + (i + 1).ToString() + " has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                                break; //stop creating anything

                            }

            

                        }

                        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

                        {

                            if (gdpicturePDF.SaveToFile("forms_radiobutton.pdf") == GdPictureStatus.OK)

                                MessageBox.Show("\nThe example has been followed successfully and the file has been saved.", caption);

                            else

                                MessageBox.Show("\nThe example has been followed successfully, but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString(), caption);

                        }

                    }

                    else

                        MessageBox.Show("The 2.DrawRectangle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                }

            }

            else

                MessageBox.Show("The 1.DrawRectangle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

        }

        else

            MessageBox.Show("The AddStandardFont() or the SetLineColor() method 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();
See Also