GdPicture.NET.14
GdPicture14 Namespace / GdPicturePDF Class / AddTextFormField Method / AddTextFormField(Single,Single,Single,Single,String,String,Boolean,String,Single,Color) Method
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.
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.
The width of the form field's bounding box, expressed in the current units specified by the SetMeasurementUnit method.
The height of the form field's bounding box, expressed in the current units specified by the SetMeasurementUnit method.
The name of the form field. It can be an empty string, but it is recommended to set a value.
The text to be displayed in the form field, applying the defined font and color. This value is used both as the current value and as the default value as well. Use an empty string to create a blank field without setting a default value.
Set this parameter to true to allow the field to contain multiple lines of text, otherwise set it to false to restrict the field to accept only a single line.
The resource name of the font you prefer for displaying text in the form field. You can obtain this name using the AddStandardFont method or any of the AddTrueTypeFont...() methods. For further assistance, please see the Fonts section of the GdPicturePDF class in the Reference Guide.
A text (font) size, in points, for displayed text. Please note that 1 point = 1/72 inch.
A color object that defines the color to be used for displaying text in the form field.
Example





In This Topic
AddTextFormField(Single,Single,Single,Single,String,String,Boolean,String,Single,Color) Method
In This Topic
Adds a text form field to the currently selected page of the loaded PDF document according to what you have specified. A text field is a box or space in which the user can enter text from the keyboard. The text may be restricted to a single line or may be permitted to span multiple lines.

This method uses the RGB color space for specifying the required color of text displayed in the field.

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

Syntax
'Declaration
 

Public Overloads Function AddTextFormField( _
   ByVal Left As Single, _
   ByVal Top As Single, _
   ByVal Width As Single, _
   ByVal Height As Single, _
   ByVal FieldName As String, _
   ByVal Text As String, _
   ByVal MultiLines As Boolean, _
   ByVal FontResName As String, _
   ByVal FontSize As Single, _
   ByVal TextColor As Color _
) As Integer
public int AddTextFormField( 
   float Left,
   float Top,
   float Width,
   float Height,
   string FieldName,
   string Text,
   bool MultiLines,
   string FontResName,
   float FontSize,
   Color TextColor
)
public function AddTextFormField( 
    Left: Single;
    Top: Single;
    Width: Single;
    Height: Single;
    FieldName: String;
    Text: String;
    MultiLines: Boolean;
    FontResName: String;
    FontSize: Single;
    TextColor: Color
): Integer; 
public function AddTextFormField( 
   Left : float,
   Top : float,
   Width : float,
   Height : float,
   FieldName : String,
   Text : String,
   MultiLines : boolean,
   FontResName : String,
   FontSize : float,
   TextColor : Color
) : int;
public: int AddTextFormField( 
   float Left,
   float Top,
   float Width,
   float Height,
   string* FieldName,
   string* Text,
   bool MultiLines,
   string* FontResName,
   float FontSize,
   Color TextColor
) 
public:
int AddTextFormField( 
   float Left,
   float Top,
   float Width,
   float Height,
   String^ FieldName,
   String^ Text,
   bool MultiLines,
   String^ FontResName,
   float FontSize,
   Color TextColor
)

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.
Text
The text to be displayed in the form field, applying the defined font and color. This value is used both as the current value and as the default value as well. Use an empty string to create a blank field without setting a default value.
MultiLines
Set this parameter to true to allow the field to contain multiple lines of text, otherwise set it to false to restrict the field to accept only a single line.
FontResName
The resource name of the font you prefer for displaying text in the form field. You can obtain this name using the AddStandardFont method or any of the AddTrueTypeFont...() methods. For further assistance, please see the Fonts section of the GdPicturePDF class in the Reference Guide.
FontSize
A text (font) size, in points, for displayed text. Please note that 1 point = 1/72 inch.
TextColor
A color object that defines the color to be used for displaying text in the form field.

Return Value

The unique identifier of the newly created text form field. The 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 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 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 SetMeasurementUnit method according to the current coordinate space defined by the SetOrigin method.

Example
How to add a text form field on the first page of the newly created PDF document and how to set its several properties. 
Dim caption As String = "Example: AddTextFormField"
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
            Dim formID As Integer = gdpicturePDF.AddTextFormField(1, 2, 8, 1, "TextField_Name", "GdPicture", False, fontResName, 20, Color.Brown)
            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                Dim formType As PdfFormFieldType = gdpicturePDF.GetFormFieldType(formID)
                If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso
                   (gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.White) = GdPictureStatus.OK) AndAlso
                   (gdpicturePDF.SetFormFieldBorderColor(formID, Color.OrangeRed) = GdPictureStatus.OK) AndAlso
                   (gdpicturePDF.SetFormFieldDoNotScroll(formID, True) = GdPictureStatus.OK) AndAlso
                   (gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, True) = GdPictureStatus.OK) AndAlso
                   (gdpicturePDF.SetFormFieldMaxLen(formID, 20) = GdPictureStatus.OK) Then
                    Dim message As String = "The text form field has been created." + vbCrLf + "Type: " + formType.ToString() + "    ID: " + formID.ToString()
                    If gdpicturePDF.SaveToFile("forms_textfield.pdf") = GdPictureStatus.OK Then
                        message = message + vbCrLf + "The file has been saved successfully."
                    Else
                        message = message + vbCrLf + "The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString()
                    End If
                    MessageBox.Show(message, caption)
                Else
                    MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                End If
            Else
                MessageBox.Show("The AddTextFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
            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: AddTextFormField";
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)
        {
            int formID = gdpicturePDF.AddTextFormField(1, 2, 8, 1, "TextField_Name", "GdPicture", false, fontResName, 20, Color.Brown);
            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
            {
                PdfFormFieldType formType = gdpicturePDF.GetFormFieldType(formID);
                if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&
                    (gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.White) == GdPictureStatus.OK) &&
                    (gdpicturePDF.SetFormFieldBorderColor(formID, Color.OrangeRed) == GdPictureStatus.OK) &&
                    (gdpicturePDF.SetFormFieldDoNotScroll(formID, true) == GdPictureStatus.OK) &&
                    (gdpicturePDF.SetFormFieldDoNotSpellCheck(formID, true) == GdPictureStatus.OK) &&
                    (gdpicturePDF.SetFormFieldMaxLen(formID, 20) == GdPictureStatus.OK))
                {
                    string message = "The text form field has been created.\n" + "Type: " + formType.ToString() + "    ID: " + formID.ToString();
                    if (gdpicturePDF.SaveToFile("forms_textfield.pdf") == GdPictureStatus.OK)
                        message = message + "\nThe file has been saved successfully.";
                    else
                        message = message + "\nThe file can't be saved. Status: " + gdpicturePDF.GetStat().ToString();
                    MessageBox.Show(message, caption);
                }
                else
                    MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
            }
            else
                MessageBox.Show("The AddTextFormField() method has failed with the 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();
See Also

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldType Method
GetFormFieldPage Method
FlattenFormFields Method
RemoveFormField Method

 

 

Ⓒ Copyright 2024 Nutrient. All rights reserved