GetFormFieldDefaultChecked(Int32) Method

In This Topic

Returns, if a required form field, here a check box, is checked by default. The check box 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.

If this flag is set for the specified check box, then this check box is checked by default.

Syntax

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

'Declaration
 
Public Overloads Function GetFormFieldDefaultChecked( _
   ByVal FieldId As Integer _
) As Boolean

public bool GetFormFieldDefaultChecked( 
   int FieldId
)

public function GetFormFieldDefaultChecked( 
    FieldId: Integer
): Boolean;

public function GetFormFieldDefaultChecked( 
   FieldId : int
) : boolean;

public: bool GetFormFieldDefaultChecked( 
   int FieldId
)

public:
bool GetFormFieldDefaultChecked( 
   int FieldId
)

Parameters

FieldId: A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: GdPicturePDF.AddCheckBoxFormField, GdPicturePDF.GetFormFieldId or GdPicturePDF.GetFormFieldChildID.

Return Value

true if the specified check box is checked by default, otherwise false. 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, otherwise it will fail.

Example

How to remove the default checked property for all check boxes, which have this attribute defined.

VB.NET
C#

Dim caption As String = "Example: GetFormFieldDefaultChecked"
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 defChecked As Boolean = False
        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
                        defChecked = gdpicturePDF.GetFormFieldDefaultChecked(formID)
                        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                            If defChecked Then
                                If (gdpicturePDF.SetFormFieldChecked(formID, False) <> GdPictureStatus.OK) AndAlso
                                   (gdpicturePDF.SetFormFieldDefaultChecked(formID, False) <> GdPictureStatus.OK) Then
                                    MessageBox.Show("The SetFormFieldChecked()/SetFormFieldDefaultChecked() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                                    Exit For
                                End If
                            End If
                        Else
                            MessageBox.Show("The GetFormFieldDefaultChecked() 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: GetFormFieldDefaultChecked";
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;
        bool defChecked = false;
        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)
                    {
                        defChecked = gdpicturePDF.GetFormFieldDefaultChecked(formID);
                        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                        {
                            if (defChecked)
                            {
                                if ((gdpicturePDF.SetFormFieldChecked(formID, false) != GdPictureStatus.OK) &&
                                    (gdpicturePDF.SetFormFieldDefaultChecked(formID, false) != GdPictureStatus.OK))
            
                                {
                                    MessageBox.Show("The SetFormFieldChecked()/SetFormFieldDefaultChecked() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                                    break;
                                }
                            }
                        }
                        else
                        {
                            MessageBox.Show("The GetFormFieldDefaultChecked() 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();

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
SetFormFieldDefaultChecked(Int32,Boolean) Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
SetFormFieldChecked(Int32,Boolean) Method
AddCheckBoxFormField(Single,Single,Single,Single,String,PdfCheckBoxStyle,Boolean,Byte,Byte,Byte) Method