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

GetFormFieldCheckBoxStyle(Int32,Int32) Method

In This Topic
Returns the graphical style of a checkmark used to represent the checked state of a required form field, here a child radio button in a group. 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.

The checkmark is a shape, that appears in the specified radio button field, when it is checked/selected. Please note that every single child radio button in a group of radio buttons within a radio button field can have its own checkmark defined.

Syntax
'Declaration

 


Public Overloads Function GetFormFieldCheckBoxStyle( _

   ByVal FieldId As Integer, _

   ByVal ChildIdx As Integer _

) As PdfCheckBoxStyle
public PdfCheckBoxStyle GetFormFieldCheckBoxStyle( 

   int FieldId,

   int ChildIdx

)
public function GetFormFieldCheckBoxStyle( 

    FieldId: Integer;

    ChildIdx: Integer

): PdfCheckBoxStyle; 
public function GetFormFieldCheckBoxStyle( 

   FieldId : int,

   ChildIdx : int

) : PdfCheckBoxStyle;
public: PdfCheckBoxStyle GetFormFieldCheckBoxStyle( 

   int FieldId,

   int ChildIdx

) 
public:

PdfCheckBoxStyle GetFormFieldCheckBoxStyle( 

   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

A member of the PdfCheckBoxStyle enumeration. 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 find out the style of the checkmark for child radio buttons in a group. 
Dim caption As String = "Example: GetFormFieldCheckBoxStyle"

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 = ""

        Dim formID As Integer = 0

        Dim hasRB As Boolean = False

        Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown

        Dim style As PdfCheckBoxStyle = PdfCheckBoxStyle.PdfCheckBoxStyleCheck

        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

                        hasRB = True

                        message = message + "RB " + gdpicturePDF.GetFormFieldTitle(formID)

                        style = gdpicturePDF.GetFormFieldCheckBoxStyle(formID)

                        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                            'The style of the checkmark is the same for all child radio buttons in this group.

                            message = message + " - style: " + style.ToString()

                        Else

                            If gdpicturePDF.GetStat() = GdPictureStatus.Aborted Then

                                'The style of the checkmark is different for the individual child radio buttons in this group.

                                message = message + " has a different style for its child radio buttons."

                                Dim kids As Integer = gdpicturePDF.GetFormFieldChildCount(formID)

                                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                                    For j As Integer = 0 To kids - 1

                                        message = message + vbCrLf + "  " + j.ToString() + ".child - style: "

                                        style = gdpicturePDF.GetFormFieldCheckBoxStyle(formID, j)

                                        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                                            message = message + style.ToString()

                                        Else

                                            message = message + gdpicturePDF.GetStat().ToString()

                                        End If

                                    Next

                                Else

                                    message = message + vbCrLf + "  The GetFormFieldChildCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString()

                                End If

                            Else

                                message = message + vbCrLf + "  The GetFormFieldCheckBoxStyle() method has failed with the status: " + gdpicturePDF.GetStat().ToString()

                            End If

                        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

            message += vbCrLf

        Next

        If count = 0 Then

            message = "This file doesn't include forms."

        ElseIf Not hasRB Then

            message = "This file doesn't include radio button form fields."

        End If

        MessageBox.Show(message, caption)

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

GdPicturePDF gdpicturePDF = new GdPicturePDF();

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

{

    int count = gdpicturePDF.GetFormFieldsCount();

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

    {

        string message = "";

        int formID = 0;

        bool hasRB = false;

        PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;

        PdfCheckBoxStyle style = PdfCheckBoxStyle.PdfCheckBoxStyleCheck;

        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)

                    {

                        hasRB = true;

                        message = message + "RB " + gdpicturePDF.GetFormFieldTitle(formID);

                        style = gdpicturePDF.GetFormFieldCheckBoxStyle(formID);

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

                        {

                            //The style of the checkmark is the same for all child radio buttons in this group.

                            message = message + " - style: " + style.ToString();

                        }

                        else

                        {

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

                            {

                                //The style of the checkmark is different for the individual child radio buttons in this group.

                                message = message + " has a different style for its child radio buttons.";

                                int kids = gdpicturePDF.GetFormFieldChildCount(formID);

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

                                {

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

                                    {

                                        message = message + "\n  " + j.ToString() + ".child - style: ";

                                        style = gdpicturePDF.GetFormFieldCheckBoxStyle(formID, j);

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

                                            message = message + style.ToString();

                                        else

                                            message = message + gdpicturePDF.GetStat().ToString();

                                    }

                                }

                                else message = message + "\n  The GetFormFieldChildCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString();

                            }

                            else message = message + "\n  The GetFormFieldCheckBoxStyle() method has failed with the status: " + gdpicturePDF.GetStat().ToString();

                        }

                    }

                }

                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;

            }

            message += "\n";

        }

        if (count == 0) message = "This file doesn't include forms.";

        else if (!hasRB) message = "This file doesn't include radio button form fields.";

        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 find out the style of the checkmark for child radio buttons in a group. Dim caption As String = "Example: GetFormFieldCheckBoxStyle" 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 = "" Dim formID As Integer = 0 Dim hasRB As Boolean = False Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown Dim style As PdfCheckBoxStyle = PdfCheckBoxStyle.PdfCheckBoxStyleCheck 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 hasRB = True message = message + "RB " + gdpicturePDF.GetFormFieldTitle(formID) style = gdpicturePDF.GetFormFieldCheckBoxStyle(formID) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then 'The style of the checkmark is the same for all child radio buttons in this group. message = message + " - style: " + style.ToString() Else If gdpicturePDF.GetStat() = GdPictureStatus.Aborted Then 'The style of the checkmark is different for the individual child radio buttons in this group. message = message + " has a different style for its child radio buttons." Dim kids As Integer = gdpicturePDF.GetFormFieldChildCount(formID) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then For j As Integer = 0 To kids - 1 message = message + vbCrLf + " " + j.ToString() + ".child - style: " style = gdpicturePDF.GetFormFieldCheckBoxStyle(formID, j) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then message = message + style.ToString() Else message = message + gdpicturePDF.GetStat().ToString() End If Next Else message = message + vbCrLf + " The GetFormFieldChildCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString() End If Else message = message + vbCrLf + " The GetFormFieldCheckBoxStyle() method has failed with the status: " + gdpicturePDF.GetStat().ToString() End If 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 message += vbCrLf Next If count = 0 Then message = "This file doesn't include forms." ElseIf Not hasRB Then message = "This file doesn't include radio button form fields." End If MessageBox.Show(message, caption) 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: GetFormFieldCheckBoxStyle"; GdPicturePDF gdpicturePDF = new GdPicturePDF(); if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK) { int count = gdpicturePDF.GetFormFieldsCount(); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { string message = ""; int formID = 0; bool hasRB = false; PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown; PdfCheckBoxStyle style = PdfCheckBoxStyle.PdfCheckBoxStyleCheck; 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) { hasRB = true; message = message + "RB " + gdpicturePDF.GetFormFieldTitle(formID); style = gdpicturePDF.GetFormFieldCheckBoxStyle(formID); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { //The style of the checkmark is the same for all child radio buttons in this group. message = message + " - style: " + style.ToString(); } else { if (gdpicturePDF.GetStat() == GdPictureStatus.Aborted) { //The style of the checkmark is different for the individual child radio buttons in this group. message = message + " has a different style for its child radio buttons."; int kids = gdpicturePDF.GetFormFieldChildCount(formID); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { for (int j = 0; j < kids; j++) { message = message + "\n " + j.ToString() + ".child - style: "; style = gdpicturePDF.GetFormFieldCheckBoxStyle(formID, j); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) message = message + style.ToString(); else message = message + gdpicturePDF.GetStat().ToString(); } } else message = message + "\n The GetFormFieldChildCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(); } else message = message + "\n The GetFormFieldCheckBoxStyle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(); } } } 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; } message += "\n"; } if (count == 0) message = "This file doesn't include forms."; else if (!hasRB) message = "This file doesn't include radio button form fields."; 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
Overload List
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,Byte,Byte,Byte) Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldChildCount Method
GetStat Method
GetStat Method
SetFormFieldCheckBoxStyle(Int32,Int32,PdfCheckBoxStyle) Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,GdPictureColor) Method