A unique form field identifier specifying a required form field object. You can obtain this identifier using methods like GetFormFieldId, GetFormFieldChildID or methods intended to add form fields.
A member of the PdfCheckBoxStyle enumeration. A graphical style of a checkmark to be used when checking/selecting the required form field.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / SetFormFieldCheckBoxStyle Method / SetFormFieldCheckBoxStyle(Int32,PdfCheckBoxStyle) Method

SetFormFieldCheckBoxStyle(Int32,PdfCheckBoxStyle) Method

In This Topic
Sets the graphical style of a checkmark used to represent the checked state of a required form field, hereabout a check box or a radio button group. The form field 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, here a check box or a radio button group, when it is checked/selected. This method doesn't alter the form field's visual appearance in any way.

Syntax
'Declaration

 


Public Overloads Function SetFormFieldCheckBoxStyle( _

   ByVal FieldId As Integer, _

   ByVal CheckStyle As PdfCheckBoxStyle _

) As GdPictureStatus
public GdPictureStatus SetFormFieldCheckBoxStyle( 

   int FieldId,

   PdfCheckBoxStyle CheckStyle

)
public function SetFormFieldCheckBoxStyle( 

    FieldId: Integer;

    CheckStyle: PdfCheckBoxStyle

): GdPictureStatus; 
public function SetFormFieldCheckBoxStyle( 

   FieldId : int,

   CheckStyle : PdfCheckBoxStyle

) : GdPictureStatus;
public: GdPictureStatus SetFormFieldCheckBoxStyle( 

   int FieldId,

   PdfCheckBoxStyle CheckStyle

) 
public:

GdPictureStatus SetFormFieldCheckBoxStyle( 

   int FieldId,

   PdfCheckBoxStyle CheckStyle

)

Parameters

FieldId
A unique form field identifier specifying a required form field object. You can obtain this identifier using methods like GetFormFieldId, GetFormFieldChildID or methods intended to add form fields.
CheckStyle
A member of the PdfCheckBoxStyle enumeration. A graphical style of a checkmark to be used when checking/selecting the required form field.

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 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: SetFormFieldCheckBoxStyle"

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

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();
Example
How to change the circle checkmark to the cross checkmark for all check boxes in the current document. Dim caption As String = "Example: SetFormFieldCheckBoxStyle" 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: SetFormFieldCheckBoxStyle"; 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

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldCheckBoxStyle(Int32) Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
AddCheckBoxFormField(Single,Single,Single,Single,String,PdfCheckBoxStyle,Boolean,Color) Method
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,Color) Method