AddCheckBoxFormField(Single,Single,Single,Single,String,PdfCheckBoxStyle,Boolean,Byte,Byte,Byte) Method

In This Topic

Adds a check box form field to the currently selected page of the loaded PDF document according to what you have specified. A check box field toggles between two states, checked (on) and unchecked (off), when interacted by the user.

This method uses the RGB color space for specifying the required color of the displayed check box field's checkmark.

You can subsequently use other methods for assigning more form field properties, as it is shown in the Example section below.

Syntax

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

'Declaration
 
Public Overloads Function AddCheckBoxFormField( _
   ByVal Left As Single, _
   ByVal Top As Single, _
   ByVal Width As Single, _
   ByVal Height As Single, _
   ByVal FieldName As String, _
   ByVal Style As PdfCheckBoxStyle, _
   ByVal Checked As Boolean, _
   ByVal CheckMarkRed As Byte, _
   ByVal CheckMarkGreen As Byte, _
   ByVal CheckMarkBlue As Byte _
) As Integer

public int AddCheckBoxFormField( 
   float Left,
   float Top,
   float Width,
   float Height,
   string FieldName,
   PdfCheckBoxStyle Style,
   bool Checked,
   byte CheckMarkRed,
   byte CheckMarkGreen,
   byte CheckMarkBlue
)

public function AddCheckBoxFormField( 
    Left: Single;
    Top: Single;
    Width: Single;
    Height: Single;
    FieldName: String;
    Style: PdfCheckBoxStyle;
    Checked: Boolean;
    CheckMarkRed: Byte;
    CheckMarkGreen: Byte;
    CheckMarkBlue: Byte
): Integer;

public function AddCheckBoxFormField( 
   Left : float,
   Top : float,
   Width : float,
   Height : float,
   FieldName : String,
   Style : PdfCheckBoxStyle,
   Checked : boolean,
   CheckMarkRed : byte,
   CheckMarkGreen : byte,
   CheckMarkBlue : byte
) : int;

public: int AddCheckBoxFormField( 
   float Left,
   float Top,
   float Width,
   float Height,
   string* FieldName,
   PdfCheckBoxStyle Style,
   bool Checked,
   byte CheckMarkRed,
   byte CheckMarkGreen,
   byte CheckMarkBlue
)

public:
int AddCheckBoxFormField( 
   float Left,
   float Top,
   float Width,
   float Height,
   String^ FieldName,
   PdfCheckBoxStyle Style,
   bool Checked,
   byte CheckMarkRed,
   byte CheckMarkGreen,
   byte CheckMarkBlue
)

Parameters

Left: The horizontal (X) coordinate of the closest point to the currently defined origin, where the form field's bounding box is to be located. The value is expressed in the current units specified by the SetMeasurementUnit method and it is related to the current page. For further assistance, please see the Remarks section below.
Top: The vertical (Y) coordinate of the closest point to the currently defined origin, where the form field's bounding box is to be located. The value is expressed in the current units specified by the SetMeasurementUnit method and it is related to the current page. For further assistance, please see the Remarks section below.
Width: The width of the form field's bounding box, expressed in the current units specified by the SetMeasurementUnit method.
Height: The height of the form field's bounding box, expressed in the current units specified by the SetMeasurementUnit method.
FieldName: The name of the form field. It can be an empty string, but it is recommended to set a value.
Style: A member of the PdfCheckBoxStyle enumeration. The style of the checkmark to be used to display a checked state of a check box field.
Checked: The state value of a check box field. Set this parameter to true, if you want to check the check box field, otherwise set it to false.
CheckMarkRed: The amount of red color to be used for the resulting color when displaying the check box's checkmark. Use the value between 0 and 255.
CheckMarkGreen: The amount of green color to be used for the resulting color when displaying the check box's checkmark. Use the value between 0 and 255.
CheckMarkBlue: The amount of blue color to be used for the resulting color when displaying the check box's checkmark. Use the value between 0 and 255.

Return Value

The unique identifier of the newly created check box form field. 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.

Please always ensure that you have selected the correct page using the GdPicturePDF.SelectPage method before adding a required form field.

You also need to be aware that the values of coordinates and dimensions are expressed in the current units defined by the GdPicturePDF.SetMeasurementUnit method according to the current coordinate space defined by the GdPicturePDF.SetOrigin method.

Example

How to add two check boxes on the first page of the newly created PDF document.

VB.NET
C#

Dim caption As String = "Example: AddCheckBoxFormField"
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.PdfStandardFontHelvetica)
        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
            'Creating the first checkbox.
            Dim formID As Integer = gdpicturePDF.AddCheckBoxFormField(1, 1, 1, 1, "CheckBox1", PdfCheckBoxStyle.PdfCheckBoxStyleCheck, True, 0, 0, 255)
            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) = GdPictureStatus.OK) AndAlso
                   (gdpicturePDF.SetFormFieldBorderColor(formID, 165, 42, 42) = GdPictureStatus.OK) Then
                    gdpicturePDF.DrawText(fontResName, 2.5F, 1.5F, "checked")
                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(6, 1, 1, 1, "CheckBox2", PdfCheckBoxStyle.PdfCheckBoxStyleCheck, False, 0, 0, 255)
                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                    If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) = GdPictureStatus.OK) AndAlso
                       (gdpicturePDF.SetFormFieldBorderColor(formID, 165, 42, 42) = GdPictureStatus.OK) Then
                        gdpicturePDF.DrawText(fontResName, 7.5F, 1.5F, "unchecked")
                    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: AddCheckBoxFormField";
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.PdfStandardFontHelvetica);
        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
        {
            //Creating the first checkbox.
            int formID = gdpicturePDF.AddCheckBoxFormField(1, 1, 1, 1, "CheckBox1", PdfCheckBoxStyle.PdfCheckBoxStyleCheck, true, 0, 0, 255);
            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            {
                if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) == GdPictureStatus.OK) &&
                    (gdpicturePDF.SetFormFieldBorderColor(formID, 165, 42, 42) == GdPictureStatus.OK))
                {
                    gdpicturePDF.DrawText(fontResName, 2.5f, 1.5f, "checked");
                }
                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(6, 1, 1, 1, "CheckBox2", PdfCheckBoxStyle.PdfCheckBoxStyleCheck, false, 0, 0, 255);
                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                {
                    if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) == GdPictureStatus.OK) &&
                        (gdpicturePDF.SetFormFieldBorderColor(formID, 165, 42, 42) == GdPictureStatus.OK))
                    {
                        gdpicturePDF.DrawText(fontResName, 7.5f, 1.5f, "unchecked");
                    }
                    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
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldType Method
GetFormFieldPage Method
RemoveFormField Method