SetFormFieldDefaultChecked(Int32,Int32) Method

In This Topic

Sets, 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 child radio button is checked by default in this group.

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 currently defined default selection in a radio button group using the ResetFormFieldDefaultCheckedState method.

Syntax

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

'Declaration
 
Public Overloads Function SetFormFieldDefaultChecked( _
   ByVal FieldId As Integer, _
   ByVal ChildIdx As Integer _
) As GdPictureStatus

public GdPictureStatus SetFormFieldDefaultChecked( 
   int FieldId,
   int ChildIdx
)

public function SetFormFieldDefaultChecked( 
    FieldId: Integer;
    ChildIdx: Integer
): GdPictureStatus;

public function SetFormFieldDefaultChecked( 
   FieldId : int,
   ChildIdx : int
) : GdPictureStatus;

public: GdPictureStatus SetFormFieldDefaultChecked( 
   int FieldId,
   int ChildIdx
)

public:
GdPictureStatus SetFormFieldDefaultChecked( 
   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 child radio button in a group to be checked by default in this group.

VB.NET
C#

Dim caption As String = "Example: SetFormFieldDefaultChecked"
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()
If (gdpicturePDF.NewPDF() = GdPictureStatus.OK) AndAlso
   (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) Then
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter)
    'Please always select the required page before adding a form field.
    If gdpicturePDF.SelectPage(1) = GdPictureStatus.OK Then
        Dim fontResName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesItalic)
        If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso
           (gdpicturePDF.DrawText(fontResName, 1, 0.8F, "What colour do you prefer for your T-shirt?") = GdPictureStatus.OK) Then
            Dim formID As Integer = 0
            Dim buttonName As String = "RadioButton"
            Dim colors As String() = New String() {"white", "yellow", "red", "blue", "green", "black"}
            For i As Integer = 0 To colors.Length - 1
                formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleStar, Color.Black)
                If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) OrElse
                   (gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) <> GdPictureStatus.OK) OrElse
                   (gdpicturePDF.SetFormFieldBorderColor(formID, Color.Brown) <> GdPictureStatus.OK) OrElse
                   (gdpicturePDF.SetFormFieldOnStateName(formID, i, colors(i)) <> GdPictureStatus.OK) OrElse
                   (gdpicturePDF.DrawText(fontResName, 2.5F, 1.65F + i, colors(i)) <> GdPictureStatus.OK) Then
                    MessageBox.Show("Adding the radio button nr." + (i + 1).ToString() + " has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                    Exit For
                End If
            Next
            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                'Setting the last child radio button in a group to be checked by default.
                If gdpicturePDF.SetFormFieldDefaultChecked(formID, colors.Length - 1) <> GdPictureStatus.OK Then
                    MessageBox.Show("The SetFormFieldDefaultChecked() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                End If
            End If
            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                If gdpicturePDF.SaveToFile("forms_radiobutton.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
        Else
            MessageBox.Show("Adding font or drawing text has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
        End If
    Else
        MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
    End If
Else
    MessageBox.Show("The file can't be created.", caption)
End If
gdpicturePDF.Dispose()

string caption = "Example: SetFormFieldDefaultChecked";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if ((gdpicturePDF.NewPDF() == GdPictureStatus.OK) &&
    (gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK))
{
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter);
    //Please always select the required page before adding a form field.
    if (gdpicturePDF.SelectPage(1) == GdPictureStatus.OK)
    {
        string fontResName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontTimesItalic);
        if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&
            (gdpicturePDF.DrawText(fontResName, 1, 0.8f, "What colour do you prefer for your T-shirt?") == GdPictureStatus.OK))
        {
            int formID = 0;
            string buttonName = "RadioButton";
            string[] colors = new string[] { "white", "yellow", "red", "blue", "green", "black" };
            for (int i = 0; i < colors.Length; i++)
            {
                formID = gdpicturePDF.AddRadioButtonFormField(1, 1 + i, 1, 1, "Group1", buttonName + (i + 1).ToString(), PdfCheckBoxStyle.PdfCheckBoxStyleStar, Color.Black);
                if ((gdpicturePDF.GetStat() != GdPictureStatus.OK) ||
                    (gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) != GdPictureStatus.OK) ||
                    (gdpicturePDF.SetFormFieldBorderColor(formID, Color.Brown) != GdPictureStatus.OK) ||
                    (gdpicturePDF.SetFormFieldOnStateName(formID, i, colors[i]) != GdPictureStatus.OK) ||
                    (gdpicturePDF.DrawText(fontResName, 2.5f, 1.65f + i, colors[i]) != GdPictureStatus.OK))
                {
                    MessageBox.Show("Adding the radio button nr." + (i + 1).ToString() + " has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                    break;
                }
            }
            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            {
                //Setting the last child radio button in a group to be checked by default.
                if (gdpicturePDF.SetFormFieldDefaultChecked(formID, colors.Length - 1) != GdPictureStatus.OK)
                    MessageBox.Show("The SetFormFieldDefaultChecked() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
            }
            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            {
                if (gdpicturePDF.SaveToFile("forms_radiobutton.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("Adding font or drawing text has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
    }
    else
        MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
    MessageBox.Show("The file can't be created.", caption);
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
GetFormFieldDefaultChecked(Int32,Int32) Method
ResetFormFieldDefaultCheckedState Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildCount Method
GetFormFieldType Method
GetFormFieldChecked(Int32,Int32) Method
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,Color) Method