SetFormFieldDefaultChecked(Int32,Boolean) Method

In This Topic

Sets, 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 SetFormFieldDefaultChecked( _
   ByVal FieldId As Integer, _
   ByVal Checked As Boolean _
) As GdPictureStatus

public GdPictureStatus SetFormFieldDefaultChecked( 
   int FieldId,
   bool Checked
)

public function SetFormFieldDefaultChecked( 
    FieldId: Integer;
    Checked: Boolean
): GdPictureStatus;

public function SetFormFieldDefaultChecked( 
   FieldId : int,
   Checked : boolean
) : GdPictureStatus;

public: GdPictureStatus SetFormFieldDefaultChecked( 
   int FieldId,
   bool Checked
)

public:
GdPictureStatus SetFormFieldDefaultChecked( 
   int FieldId,
   bool Checked
)

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.
Checked: Set this parameter to true, if you want to check the specified check box by default, otherwise set it to false.

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, otherwise it will fail.

Example

How to define that the newly created check box will be checked by default.

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 Then
            'Creating the first checkbox.
            Dim formID As Integer = gdpicturePDF.AddCheckBoxFormField(1, 1, 1, 1, "CheckBox1", PdfCheckBoxStyle.PdfCheckBoxStyleStar, False, Color.Blue)
            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                If (gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) = GdPictureStatus.OK) AndAlso
                   (gdpicturePDF.SetFormFieldBorderColor(formID, Color.Brown) = GdPictureStatus.OK) AndAlso
                   (gdpicturePDF.SetFormFieldDefaultChecked(formID, True) = GdPictureStatus.OK) Then
                    gdpicturePDF.DrawText(fontResName, 2.5F, 1.5F, "I love GdPicturePDF.")
                Else
                    MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                End If
            Else
                MessageBox.Show("The AddCheckBoxFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
            End If
            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                'Creating the second checkbox.
                formID = gdpicturePDF.AddCheckBoxFormField(1, 4, 1, 1, "CheckBox2", PdfCheckBoxStyle.PdfCheckBoxStyleStar, False, Color.Blue)
                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                    If (gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) = GdPictureStatus.OK) AndAlso
                       (gdpicturePDF.SetFormFieldBorderColor(formID, Color.Brown) = GdPictureStatus.OK) AndAlso
                       (gdpicturePDF.SetFormFieldDefaultChecked(formID, False) = GdPictureStatus.OK) Then
                        gdpicturePDF.DrawText(fontResName, 2.5F, 4.5F, "I will use it.")
                    Else
                        MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                    End If
                Else
                    MessageBox.Show("The AddCheckBoxFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                End If
            End If
            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                'Saving the document.
                If gdpicturePDF.SaveToFile("forms_checkbox.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("The AddStandardFont() method 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)
        {
            //Creating the first checkbox.
            int formID = gdpicturePDF.AddCheckBoxFormField(1, 1, 1, 1, "CheckBox1", PdfCheckBoxStyle.PdfCheckBoxStyleStar, false, Color.Blue);
            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            {
                if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) == GdPictureStatus.OK) &&
                    (gdpicturePDF.SetFormFieldBorderColor(formID, Color.Brown) == GdPictureStatus.OK) &&
                    (gdpicturePDF.SetFormFieldDefaultChecked(formID, true) == GdPictureStatus.OK))
                {
                    gdpicturePDF.DrawText(fontResName, 2.5f, 1.5f, "I love GdPicturePDF.");
                }
                else
                    MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
            }
            else
                MessageBox.Show("The AddCheckBoxFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            {
                //Creating the second checkbox.
                formID = gdpicturePDF.AddCheckBoxFormField(1, 4, 1, 1, "CheckBox2", PdfCheckBoxStyle.PdfCheckBoxStyleStar, false, Color.Blue);
                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                {
                    if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) == GdPictureStatus.OK) &&
                        (gdpicturePDF.SetFormFieldBorderColor(formID, Color.Brown) == GdPictureStatus.OK) &&
                        (gdpicturePDF.SetFormFieldDefaultChecked(formID, false) == GdPictureStatus.OK))
            
                    {
                        gdpicturePDF.DrawText(fontResName, 2.5f, 4.5f, "I will use it.");
                    }
                    else
                        MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                }
                else
                    MessageBox.Show("The AddCheckBoxFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
            }
            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            {
                //Saving the document.
                if (gdpicturePDF.SaveToFile("forms_checkbox.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 AddStandardFont() method 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) Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
GetFormFieldChecked(Int32) Method
AddCheckBoxFormField(Single,Single,Single,Single,String,PdfCheckBoxStyle,Boolean,Byte,Byte,Byte) Method