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.

You can use either the identifier of the required radio button field or its child button as well.

Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / ResetFormFieldCheckedState Method

ResetFormFieldCheckedState Method (GdPicturePDF)

In This Topic
Resets, in other words completely removes the current selection of a required form field, here a radio button. That means no child button in a group of radio buttons within a radio button field stays selected using this method. The radio button group or the child radio button in this 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 explicitly applicable to radio button form field objects and their child buttons as well.
Syntax
'Declaration

 


Public Function ResetFormFieldCheckedState( _

   ByVal FieldId As Integer _

) As GdPictureStatus
public GdPictureStatus ResetFormFieldCheckedState( 

   int FieldId

)
public function ResetFormFieldCheckedState( 

    FieldId: Integer

): GdPictureStatus; 
public function ResetFormFieldCheckedState( 

   FieldId : int

) : GdPictureStatus;
public: GdPictureStatus ResetFormFieldCheckedState( 

   int FieldId

) 
public:

GdPictureStatus ResetFormFieldCheckedState( 

   int FieldId

)

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.

You can use either the identifier of the required radio button field or its child button as well.

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.

Just to remind you that this method is only meaningful for radio buttons, both the radio button fields and their children as well, 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: ResetFormFieldCheckedState"

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

        Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown

        Dim 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

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

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

                            isChanged = True

                        Else

                            MessageBox.Show("The ResetFormFieldCheckedState() method 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: ResetFormFieldCheckedState";

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;

        PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;

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

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

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

                            isChanged = true;

                        else

                        {

                            MessageBox.Show("The ResetFormFieldCheckedState() method 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();
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: ResetFormFieldCheckedState" 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 Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown Dim 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 'Removing the current selection for the given radio button completely. If gdpicturePDF.ResetFormFieldCheckedState(formID) = GdPictureStatus.OK Then isChanged = True Else MessageBox.Show("The ResetFormFieldCheckedState() method 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: ResetFormFieldCheckedState"; 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; PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown; bool 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++; //Removing the current selection for the given radio button completely. if (gdpicturePDF.ResetFormFieldCheckedState(formID) == GdPictureStatus.OK) isChanged = true; else { MessageBox.Show("The ResetFormFieldCheckedState() method 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

Reference

GdPicturePDF Class
GdPicturePDF Members
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,Byte,Byte,Byte) Method
GetFormFieldId Method
GetFormFieldChildID Method
ResetFormFieldDefaultCheckedState Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildCount Method
GetFormFieldType Method
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,Byte,Byte,Byte) Method
GetFormFieldChecked(Int32) Method
SetFormFieldChecked(Int32,Boolean) Method
GetFormFieldDefaultChecked(Int32) Method
SetFormFieldDefaultChecked(Int32,Boolean) Method