SetFormFieldChecked(Int32,Int32) Method

In This Topic

Checks a required form field, here a child radio button in a group, in other words toggles the field's checked state to On. 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.

As only one child radio button in a group may be checked at a time (assuming the RadiosInUnison flag is not set), the currently selected child radio button is automatically unchecked, it means its checked state is set to Off. You can completely remove the current selection in a radio button group using the ResetFormFieldCheckedState method.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration

 

Public Overloads Function SetFormFieldChecked( _

   ByVal FieldId As Integer, _

   ByVal ChildIdx As Integer _

) As GdPictureStatus

public GdPictureStatus SetFormFieldChecked( 

   int FieldId,

   int ChildIdx

)

public function SetFormFieldChecked( 

    FieldId: Integer;

    ChildIdx: Integer

): GdPictureStatus;

public function SetFormFieldChecked( 

   FieldId : int,

   ChildIdx : int

) : GdPictureStatus;

public: GdPictureStatus SetFormFieldChecked( 

   int FieldId,

   int ChildIdx

)

public:

GdPictureStatus SetFormFieldChecked( 

   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.

Just to remind you that this method is only meaningful for radio buttons, otherwise it will fail. Be aware that selecting any one of the child radio buttons in a group automatically deselects all the others (assuming the RadiosInUnison flag is not set).

Example

How to check the last radio button in a group for all radio buttons in the current document.

VB.NET
C#

Dim caption As String = "Example: SetFormFieldChecked"

Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()

If gdpicturePDF.LoadFromFile("forms_radiobutton.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 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

                        childCount = gdpicturePDF.GetFormFieldChildCount(formID)

                        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                            If gdpicturePDF.SetFormFieldChecked(formID, childCount - 1) <> GdPictureStatus.OK Then

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

                                Exit For

                            End If

                        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

            message = message + radioButtons.ToString() + " radio buttons have changed their checked value." + vbCrLf

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

                message = message + "The file has been saved successfully."

            Else

                message = message + "The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString()

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

GdPicturePDF gdpicturePDF = new GdPicturePDF();

if (gdpicturePDF.LoadFromFile("forms_radiobutton.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;

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

                        childCount = gdpicturePDF.GetFormFieldChildCount(formID);

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

                        {

                            if (gdpicturePDF.SetFormFieldChecked(formID, childCount - 1) != GdPictureStatus.OK)

                            {

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

                                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)

        {

            message = message + radioButtons.ToString() + " radio buttons have changed their checked value.\n";

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

                message = message + "The file has been saved successfully.";

            else

                message = message + "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 check the last radio button in a group for all radio buttons in the current document. Dim caption As String = "Example: SetFormFieldChecked" Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF() If gdpicturePDF.LoadFromFile("forms_radiobutton.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 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 childCount = gdpicturePDF.GetFormFieldChildCount(formID) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then If gdpicturePDF.SetFormFieldChecked(formID, childCount - 1) <> GdPictureStatus.OK Then MessageBox.Show(message + "The SetFormFieldChecked() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) Exit For End If 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 message = message + radioButtons.ToString() + " radio buttons have changed their checked value." + vbCrLf If gdpicturePDF.SaveToFile("forms_radiobutton_updated.pdf") = GdPictureStatus.OK Then message = message + "The file has been saved successfully." Else message = message + "The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString() 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: SetFormFieldChecked"; GdPicturePDF gdpicturePDF = new GdPicturePDF(); if (gdpicturePDF.LoadFromFile("forms_radiobutton.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; 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++; childCount = gdpicturePDF.GetFormFieldChildCount(formID); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { if (gdpicturePDF.SetFormFieldChecked(formID, childCount - 1) != GdPictureStatus.OK) { MessageBox.Show(message + "The SetFormFieldChecked() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); 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) { message = message + radioButtons.ToString() + " radio buttons have changed their checked value.\n"; if (gdpicturePDF.SaveToFile("forms_radiobutton_updated.pdf") == GdPictureStatus.OK) message = message + "The file has been saved successfully."; else message = message + "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();

Reference