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 / GetFormFieldChecked Method / GetFormFieldChecked(Int32,Int32) Method

GetFormFieldChecked(Int32,Int32) Method

In This Topic
Returns, if a required form field, here a child radio button in a group, is checked, in other words, if it's checked state is On. The radio button is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As said, this method is only applicable to radio buttons.
Syntax
'Declaration

 

Public Overloads Function GetFormFieldChecked( _

   ByVal FieldId As Integer, _

   ByVal ChildIdx As Integer _

) As Boolean
public bool GetFormFieldChecked( 

   int FieldId,

   int ChildIdx

)
public function GetFormFieldChecked( 

    FieldId: Integer;

    ChildIdx: Integer

): Boolean; 
public function GetFormFieldChecked( 

   FieldId : int,

   ChildIdx : int

) : boolean;
public: bool GetFormFieldChecked( 

   int FieldId,

   int ChildIdx

) 
public:

bool GetFormFieldChecked( 

   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

true if the specified child radio button in a group is checked (it's checked state is On), otherwise false.
Remarks
This method is only allowed for use with non-encrypted documents.

It is recommend to use the GetStat method to identify the specific reason for the method's failure, if any.

Just to remind you that this method is only meaningful for radio buttons, otherwise it will fail.

Example
How to find out indexes of the checked child radio buttons in a group.
Dim caption As String = "Example: GetFormFieldChecked"

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 message As String = "This document contains " + count.ToString() + " form fields." + vbCrLf

        Dim formID As Integer = 0, radioButtons As Integer = 0, childCount As Integer = 0

        Dim 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

                        radioButtons += 1

                        message = message + (i + 1).ToString() + ". rb group - index if checked: "

                        childCount = gdpicturePDF.GetFormFieldChildCount(formID)

                        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                            For j As Integer = 0 To childCount - 1

                                isChecked = gdpicturePDF.GetFormFieldChecked(formID, j)

                                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                                    If isChecked Then message = message + (j + 1).ToString() + "  "

                                Else

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

                                    Exit For

                                End If

                            Next

                            If gdpicturePDF.GetStat() = GdPictureStatus.OK message += VbCrLf Else Exit For

                        Else

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

                            Exit For

                        End If

                    End If

                Else

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

                    Exit For

                End If

            Else

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

                Exit For

            End If

        Next

        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

            If radioButtons = 0 Then message = message + "This document does not contain radio buttons."

            MessageBox.Show(message, caption)

        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: GetFormFieldChecked";

GdPicturePDF gdpicturePDF = new GdPicturePDF();

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

{

    int count = gdpicturePDF.GetFormFieldsCount();

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

    {

        string message = "This document contains " + count.ToString() + " form fields.\n";

        int formID = 0, radioButtons = 0, childCount = 0;

        bool 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)

                    {

                        radioButtons++;

                        message = message + (i+1).ToString() + ". rb group - index if checked: ";

                        childCount = gdpicturePDF.GetFormFieldChildCount(formID);

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

                        {

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

                            {

                                isChecked = gdpicturePDF.GetFormFieldChecked(formID, j);

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

                                {

                                    if (isChecked) message = message + (j + 1).ToString() + "  ";

                                }

                                else

                                {

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

                                    break;

                                }

                            }

                            if (gdpicturePDF.GetStat() == GdPictureStatus.OK) message += "\n"; else break;

                        }

                        else

                        {

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

                            break;

                        }

                    }

                }

                else

                {

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

                    break;

                }

            }

            else

            {

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

                break;

            }

        }

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

        {

            if (radioButtons == 0) message = message + "This document does not contain radio buttons.";

            MessageBox.Show(message, 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