A unique form field identifier specifying a required form field object. You can obtain this identifier using methods like GdPicturePDF.GetFormFieldId, GdPicturePDF.GetFormFieldChildID or methods intended to add form fields.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / GetFormFieldCheckBoxStyle Method / GetFormFieldCheckBoxStyle(Int32) Method

GetFormFieldCheckBoxStyle(Int32) Method

In This Topic
Returns the graphical style of a checkmark used to represent the checked state of check boxes and radio buttons. The required form field (check box or 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 check boxes and radio buttons.

The checkmark is a shape, that appears in the corresponding form field (check box or radio button), when it is checked/selected.

Be aware that if the checkmark's style differs for each single child radio button in a group of radio buttons within a radio button field, this method will fail. Please use the GdPicturePDF.GetFormFieldCheckBoxStyle method to determine the individual checkmark's style for each child radio button in a group instead.

Syntax
'Declaration

 

Public Overloads Function GetFormFieldCheckBoxStyle( _

   ByVal FieldId As Integer _

) As PdfCheckBoxStyle
public PdfCheckBoxStyle GetFormFieldCheckBoxStyle( 

   int FieldId

)
public function GetFormFieldCheckBoxStyle( 

    FieldId: Integer

): PdfCheckBoxStyle; 
public function GetFormFieldCheckBoxStyle( 

   FieldId : int

) : PdfCheckBoxStyle;
public: PdfCheckBoxStyle GetFormFieldCheckBoxStyle( 

   int FieldId

) 
public:

PdfCheckBoxStyle GetFormFieldCheckBoxStyle( 

   int FieldId

) 

Parameters

FieldId
A unique form field identifier specifying a required form field object. You can obtain this identifier using methods like GdPicturePDF.GetFormFieldId, GdPicturePDF.GetFormFieldChildID or methods intended to add form fields.

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 check boxes and radio buttons, otherwise it will fail.

Example
How to change the circle checkmark to the cross checkmark for all check boxes in the current document.
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 formID As Integer = 0

        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.PdfFormFieldTypeCheckBoxButton Then

                        style = gdpicturePDF.GetFormFieldCheckBoxStyle(formID)

                        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                            If style = PdfCheckBoxStyle.PdfCheckBoxStyleCircle Then

                                If gdpicturePDF.SetFormFieldCheckBoxStyle(formID, PdfCheckBoxStyle.PdfCheckBoxStyleCross) <> GdPictureStatus.OK Then

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

                                    Exit For

                                End If

                            End If

                        Else

                            MessageBox.Show("The GetFormFieldCheckBoxStyle() 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 count = 0 Then

            MessageBox.Show("This file doesn't include forms.", caption)

        Else

            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                If gdpicturePDF.SaveToFile("forms_updated.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

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

GdPicturePDF gdpicturePDF = new GdPicturePDF();

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

{

    int count = gdpicturePDF.GetFormFieldsCount();

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

    {

        int formID = 0;

        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.PdfFormFieldTypeCheckBoxButton)

                    {

                        style = gdpicturePDF.GetFormFieldCheckBoxStyle(formID);

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

                        {

                            if (style == PdfCheckBoxStyle.PdfCheckBoxStyleCircle)

                            {

                                if (gdpicturePDF.SetFormFieldCheckBoxStyle(formID, PdfCheckBoxStyle.PdfCheckBoxStyleCross) != GdPictureStatus.OK)

                                {

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

                                    break;

                                }

                            }

                        }

                        else

                        {

                            MessageBox.Show("The GetFormFieldCheckBoxStyle() 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 (count == 0)

            MessageBox.Show("This file doesn't include forms.", caption);

        else

        {

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

            {

                if (gdpicturePDF.SaveToFile("forms_updated.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("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