A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: GdPicturePDF.AddRadioButtonFormField, GdPicturePDF.GetFormFieldId or GdPicturePDF.GetFormFieldChildID.
The index of the required child radio button in a group. It must be a value from 0 to GdPicturePDF.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 / GetFormFieldDefaultChecked Method / GetFormFieldDefaultChecked(Int32,Int32) Method

GetFormFieldDefaultChecked(Int32,Int32) Method

In This Topic
Returns, if a required form field, here a child radio button in a group, is checked by default. The radio button group 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.

If this flag is set for the specified child radio button in a group, then this radio button is checked by default in this group.

Syntax
'Declaration

 

Public Overloads Function GetFormFieldDefaultChecked( _

   ByVal FieldId As Integer, _

   ByVal ChildIdx As Integer _

) As Boolean
public bool GetFormFieldDefaultChecked( 

   int FieldId,

   int ChildIdx

)
public function GetFormFieldDefaultChecked( 

    FieldId: Integer;

    ChildIdx: Integer

): Boolean; 
public function GetFormFieldDefaultChecked( 

   FieldId : int,

   ChildIdx : int

) : boolean;
public: bool GetFormFieldDefaultChecked( 

   int FieldId,

   int ChildIdx

) 
public:

bool GetFormFieldDefaultChecked( 

   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: GdPicturePDF.AddRadioButtonFormField, GdPicturePDF.GetFormFieldId or GdPicturePDF.GetFormFieldChildID.
ChildIdx
The index of the required child radio button in a group. It must be a value from 0 to GdPicturePDF.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 is checked by default, otherwise false. The GdPicturePDF.GetStat method can be subsequently used to determine if this method has been successful.
Remarks
This method is only allowed for use with non-encrypted documents.

It is recommend to use the GdPicturePDF.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 reset all radio buttons in the current document to be not checked by default. All radio buttons are completely unchecked.
Dim caption As String = "Example: GetFormFieldDefaultChecked"

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, childCount As Integer = 0, radioButtons As Integer = 0

        Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown

        Dim defChecked As Boolean = False, isChanged As Boolean = False

        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

                        childCount = gdpicturePDF.GetFormFieldChildCount(formID)

                        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                            For j As Integer = 0 To childCount - 1

                                defChecked = gdpicturePDF.GetFormFieldDefaultChecked(formID, j)

                                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                                    If defChecked Then

                                        'Removing the current default selection for the given radio button completely.

                                        If gdpicturePDF.ResetFormFieldDefaultCheckedState(formID) = GdPictureStatus.OK Then

                                            message = message + (i + 1).ToString() + ". rb group has been changed successfully." + vbCrLf

                                            isChanged = True

                                            'Removing the current selection for the given radio button completely.

                                            If gdpicturePDF.ResetFormFieldCheckedState(formID) <> GdPictureStatus.OK Then

                                                MessageBox.Show(message + "Something has failed in unchecking buttons with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                                            End If

                                        Else

                                            MessageBox.Show(message + "Something has failed in changing default settings with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                                        End If

                                    'Only one radio button can be checked by default at a time.

                                    Exit For

                                    End If

                                Else

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

                                End If

                            Next

                        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("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 radioButtons = 0 Then

                message = message + "This document does not contain radio buttons." + vbCrLf

            ElseIf Not isChanged Then

                message = message + "This document has not been changed."

            Else

                If gdpicturePDF.SaveToFile("forms_updated.pdf") = GdPictureStatus.OK Then

                    message = message + "The example has been followed successfully and the file has been saved."

                Else

                    message = message + "The example has been followed successfully, but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString()

                End If

            End If

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

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, childCount = 0, radioButtons = 0;

        PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;

        bool defChecked = false, isChanged = false;

        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++;

                        childCount = gdpicturePDF.GetFormFieldChildCount(formID);

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

                        {

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

                            {

                                defChecked = gdpicturePDF.GetFormFieldDefaultChecked(formID, j);

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

                                {

                                    if (defChecked)

                                    {

                                        //Removing the current default selection for the given radio button completely.

                                        if (gdpicturePDF.ResetFormFieldDefaultCheckedState(formID) == GdPictureStatus.OK)

                                        {

                                            message = message + (i + 1).ToString() + ". rb group has been changed successfully.\n";

                                            isChanged = true;

                                            //Removing the current selection for the given radio button completely.

                                            if (gdpicturePDF.ResetFormFieldCheckedState(formID) != GdPictureStatus.OK)

                                                MessageBox.Show(message + "Something has failed in unchecking buttons with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                                        }

                                        else

                                            MessageBox.Show(message + "Something has failed in changing default settings with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                                        break; //Only one radio button can be checked by default at a time.

                                    }

                                }

                                else

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

                            }

                        }

                        else

                        {

                            MessageBox.Show(message + "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 (radioButtons == 0) message = message + "This document does not contain radio buttons.\n";

            else if (!isChanged) message = message + "This document has not been changed.";

            else

            {

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

                    message = message + "The example has been followed successfully and the file has been saved.";

                else

                    message = message + "The example has been followed successfully, but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString();

            }

            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