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.

Example





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

SetFormFieldNoBackgroundColor(Int32,Int32) Method

In This Topic
Removes the background (fill) color attribute 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 remove using this method. As said, this method is only applicable to radio buttons.

Be aware that the background (fill) color attribute becomes undefined using this method, which causes the form field background not to appear on the page.

Syntax
'Declaration

 


Public Overloads Function SetFormFieldNoBackgroundColor( _

   ByVal FieldId As Integer, _

   ByVal ChildIdx As Integer _

) As GdPictureStatus
public GdPictureStatus SetFormFieldNoBackgroundColor( 

   int FieldId,

   int ChildIdx

)
public function SetFormFieldNoBackgroundColor( 

    FieldId: Integer;

    ChildIdx: Integer

): GdPictureStatus; 
public function SetFormFieldNoBackgroundColor( 

   FieldId : int,

   ChildIdx : int

) : GdPictureStatus;
public: GdPictureStatus SetFormFieldNoBackgroundColor( 

   int FieldId,

   int ChildIdx

) 
public:

GdPictureStatus SetFormFieldNoBackgroundColor( 

   int FieldId,

   int ChildIdx

)

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.

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.

Be aware that the background (fill) color attribute becomes undefined using this method.

Example
How to remove the background color for checked child radio buttons. 
Dim caption As String = "Example: SetFormFieldNoBackgroundColor"

Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()

If gdpicturePDF.LoadFromFile("forms.pdf", False) = GdPictureStatus.OK Then

    Dim count As Integer = gdpicturePDF.GetFormFieldsCount()

    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

        Dim formID As Integer = 0, kids As Integer = 0

        Dim hasRB As Boolean = False, isChecked As Boolean = False

        Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown

        For i As Integer = 0 To count - 1

            formID = gdpicturePDF.GetFormFieldId(i)

            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                type = gdpicturePDF.GetFormFieldType(formID)

                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                    If type = PdfFormFieldType.PdfFormFieldTypeRadioButton Then

                        hasRB = True

                        kids = gdpicturePDF.GetFormFieldChildCount(formID)

                        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                            For j As Integer = 0 To kids - 1

                                isChecked = gdpicturePDF.GetFormFieldChecked(formID, j)

                                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                                    If isChecked Then

                                        'Removing the background color (setting it to No Color) for checked child radio button.

                                        If gdpicturePDF.SetFormFieldNoBackgroundColor(formID, j) <> GdPictureStatus.OK Then

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

                                            Exit For

                                        End If

                                    End If

                                Else

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

                                    Exit For

                                End If

                            Next

                        Else

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

                            Exit For

                        End If

                    End If

                Else

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

                    Exit For

                End If

            Else

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

                Exit For

            End If

        Next

        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

            If count = 0 Then

                MessageBox.Show("This file doesn't include forms.", caption)

            ElseIf Not hasRB Then

                MessageBox.Show("This file doesn't include radio button form fields.", caption)

            Else

                If gdpicturePDF.SaveToFile("forms_updated.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

        End If

    Else

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

    End If

Else

    MessageBox.Show("The file can't be loaded.", caption)

End If

gdpicturePDF.Dispose()
string caption = "Example: SetFormFieldNoBackgroundColor";

GdPicturePDF gdpicturePDF = new GdPicturePDF();

if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK)

{

    int count = gdpicturePDF.GetFormFieldsCount();

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

    {

        int formID = 0, kids = 0;

        bool hasRB = false, isChecked = false;

        PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;

        for (int i = 0; i < count; i++)

        {

            formID = gdpicturePDF.GetFormFieldId(i);

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

            {

                type = gdpicturePDF.GetFormFieldType(formID);

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

                {

                    if (type == PdfFormFieldType.PdfFormFieldTypeRadioButton)

                    {

                        hasRB = true;

                        kids = gdpicturePDF.GetFormFieldChildCount(formID);

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

                        {

                            for (int j = 0; j < kids; j++)

                            {

                                isChecked = gdpicturePDF.GetFormFieldChecked(formID, j);

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

                                {

                                    if (isChecked)

                                    {

                                        //Removing the background color (setting it to No Color) for checked child radio button.

                                        if (gdpicturePDF.SetFormFieldNoBackgroundColor(formID, j) != GdPictureStatus.OK)

                                        {

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

                                            break;

                                        }

                                    }

                                }

                                else

                                {

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

                                    break;

                                }

                            }

                        }

                        else

                        {

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

                            break;

                        }

                    }

                }

                else

                {

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

                    break;

                }

            }

            else

            {

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

                break;

            }

        }

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

        {

            if (count == 0) MessageBox.Show("This file doesn't include forms.", caption);

            else

                if (!hasRB) MessageBox.Show("This file doesn't include radio button form fields.", caption);

            else

            {

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

            }

        }

    }

    else

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

}

else

    MessageBox.Show("The file can't be loaded.", caption);

gdpicturePDF.Dispose();
Example
How to remove the background color for checked child radio buttons. Dim caption As String = "Example: SetFormFieldNoBackgroundColor" Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF() If gdpicturePDF.LoadFromFile("forms.pdf", False) = GdPictureStatus.OK Then Dim count As Integer = gdpicturePDF.GetFormFieldsCount() If gdpicturePDF.GetStat() = GdPictureStatus.OK Then Dim formID As Integer = 0, kids As Integer = 0 Dim hasRB As Boolean = False, isChecked As Boolean = False Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown For i As Integer = 0 To count - 1 formID = gdpicturePDF.GetFormFieldId(i) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then type = gdpicturePDF.GetFormFieldType(formID) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then If type = PdfFormFieldType.PdfFormFieldTypeRadioButton Then hasRB = True kids = gdpicturePDF.GetFormFieldChildCount(formID) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then For j As Integer = 0 To kids - 1 isChecked = gdpicturePDF.GetFormFieldChecked(formID, j) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then If isChecked Then 'Removing the background color (setting it to No Color) for checked child radio button. If gdpicturePDF.SetFormFieldNoBackgroundColor(formID, j) <> GdPictureStatus.OK Then MessageBox.Show("The SetFormFieldNoBackgroundColor() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) Exit For End If End If Else MessageBox.Show("The GetFormFieldChecked() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) Exit For End If Next Else MessageBox.Show("The GetFormFieldChildCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) Exit For End If End If Else MessageBox.Show("The GetFormFieldType() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) Exit For End If Else MessageBox.Show("The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) Exit For End If Next If gdpicturePDF.GetStat() = GdPictureStatus.OK Then If count = 0 Then MessageBox.Show("This file doesn't include forms.", caption) ElseIf Not hasRB Then MessageBox.Show("This file doesn't include radio button form fields.", caption) Else If gdpicturePDF.SaveToFile("forms_updated.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 End If Else MessageBox.Show("The GetFormFieldsCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("The file can't be loaded.", caption) End If gdpicturePDF.Dispose() string caption = "Example: SetFormFieldNoBackgroundColor"; GdPicturePDF gdpicturePDF = new GdPicturePDF(); if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK) { int count = gdpicturePDF.GetFormFieldsCount(); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { int formID = 0, kids = 0; bool hasRB = false, isChecked = false; PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown; for (int i = 0; i < count; i++) { formID = gdpicturePDF.GetFormFieldId(i); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { type = gdpicturePDF.GetFormFieldType(formID); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { if (type == PdfFormFieldType.PdfFormFieldTypeRadioButton) { hasRB = true; kids = gdpicturePDF.GetFormFieldChildCount(formID); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { for (int j = 0; j < kids; j++) { isChecked = gdpicturePDF.GetFormFieldChecked(formID, j); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { if (isChecked) { //Removing the background color (setting it to No Color) for checked child radio button. if (gdpicturePDF.SetFormFieldNoBackgroundColor(formID, j) != GdPictureStatus.OK) { MessageBox.Show("The SetFormFieldNoBackgroundColor() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); break; } } } else { MessageBox.Show("The GetFormFieldChecked() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); break; } } } else { MessageBox.Show("The GetFormFieldChildCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); break; } } } else { MessageBox.Show("The GetFormFieldType() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); break; } } else { MessageBox.Show("The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); break; } } if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { if (count == 0) MessageBox.Show("This file doesn't include forms.", caption); else if (!hasRB) MessageBox.Show("This file doesn't include radio button form fields.", caption); else { if (gdpicturePDF.SaveToFile("forms_updated.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 file can't be saved. Status: " + gdpicturePDF.GetStat().ToString(), caption); } } } else MessageBox.Show("The GetFormFieldsCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); } else MessageBox.Show("The file can't be loaded.", caption); gdpicturePDF.Dispose();
See Also

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,Byte,Byte,Byte) Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldChildCount Method
FormFieldHasBackgroundColor(Int32,Int32) Method
SetFormFieldBackgroundColor(Int32,Int32,Color) Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
SetFormFieldBorderColor(Int32,Int32,Color) Method
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,Color) Method