A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: GdPicturePDF.AddTextFormField, GdPicturePDF.GetFormFieldId or GdPicturePDF.GetFormFieldChildID.
Set this parameter to true, if you want to enable the Multiline flag, otherwise set it to false to disable it.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / SetFormFieldMultiLine Method

SetFormFieldMultiLine Method (GdPicturePDF)

In This Topic
Sets the Multiline flag of a required form field, here a text field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.

If this flag is set, then the text field can contain multiple lines of text. It it is not set, the field's text is restricted to a single line.

Syntax
'Declaration

 


Public Function SetFormFieldMultiLine( _

   ByVal FieldId As Integer, _

   ByVal MultiLine As Boolean _

) As GdPictureStatus
public GdPictureStatus SetFormFieldMultiLine( 

   int FieldId,

   bool MultiLine

)
public function SetFormFieldMultiLine( 

    FieldId: Integer;

    MultiLine: Boolean

): GdPictureStatus; 
public function SetFormFieldMultiLine( 

   FieldId : int,

   MultiLine : boolean

) : GdPictureStatus;
public: GdPictureStatus SetFormFieldMultiLine( 

   int FieldId,

   bool MultiLine

) 
public:

GdPictureStatus SetFormFieldMultiLine( 

   int FieldId,

   bool MultiLine

)

Parameters

FieldId
A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: GdPicturePDF.AddTextFormField, GdPicturePDF.GetFormFieldId or GdPicturePDF.GetFormFieldChildID.
MultiLine
Set this parameter to true, if you want to enable the Multiline flag, otherwise set it to false to disable it.

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

Example
How to utilize the Multiline flag when creating the text form field. 
Dim caption As String = "Example: SetFormFieldMultiLine"

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

            If (gdpicturePDF.SetTextSize(16) = GdPictureStatus.OK) AndAlso

                (gdpicturePDF.DrawText(fontResName, 1, 1, "Write your story here ...") = GdPictureStatus.OK) Then

                Dim formID As Integer = gdpicturePDF.AddTextFormField(1, 1, 19, 12, "TextField_Story", "", False, fontResName, 16, 165, 42, 42)

                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                    If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 173, 216, 230) = GdPictureStatus.OK) AndAlso

                       (gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 139) = GdPictureStatus.OK) AndAlso

                       (gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) = GdPictureStatus.OK) AndAlso

                       (gdpicturePDF.SetFormFieldMultiLine(formID, True) = GdPictureStatus.OK) Then

                        Dim message As String = "The text form field has been created."

                        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 SetTextSize()/DrawText() 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: SetFormFieldMultiLine";

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)

        {

            if ((gdpicturePDF.SetTextSize(16) == GdPictureStatus.OK) &&

                (gdpicturePDF.DrawText(fontResName, 1, 1, "Write your story here ...") == GdPictureStatus.OK))

            {

                int formID = gdpicturePDF.AddTextFormField(1, 2, 19, 15, "TextField_Story", "", false, fontResName, 16, 165, 42, 42);

                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

                {

                    if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 173, 216, 230) == GdPictureStatus.OK) &&

                        (gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 139) == GdPictureStatus.OK) &&

                        (gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) == GdPictureStatus.OK) &&

                        (gdpicturePDF.SetFormFieldMultiLine(formID, true) == GdPictureStatus.OK))

                    {

                        string message = "The text form field has been created.";

                        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 SetTextSize()/DrawText() 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();
Example
How to utilize the Multiline flag when creating the text form field. Dim caption As String = "Example: SetFormFieldMultiLine" 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 If (gdpicturePDF.SetTextSize(16) = GdPictureStatus.OK) AndAlso (gdpicturePDF.DrawText(fontResName, 1, 1, "Write your story here ...") = GdPictureStatus.OK) Then Dim formID As Integer = gdpicturePDF.AddTextFormField(1, 1, 19, 12, "TextField_Story", "", False, fontResName, 16, 165, 42, 42) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 173, 216, 230) = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 139) = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetFormFieldMultiLine(formID, True) = GdPictureStatus.OK) Then Dim message As String = "The text form field has been created." 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 SetTextSize()/DrawText() 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: SetFormFieldMultiLine"; 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) { if ((gdpicturePDF.SetTextSize(16) == GdPictureStatus.OK) && (gdpicturePDF.DrawText(fontResName, 1, 1, "Write your story here ...") == GdPictureStatus.OK)) { int formID = gdpicturePDF.AddTextFormField(1, 2, 19, 15, "TextField_Story", "", false, fontResName, 16, 165, 42, 42); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 173, 216, 230) == GdPictureStatus.OK) && (gdpicturePDF.SetFormFieldBorderColor(formID, 0, 0, 139) == GdPictureStatus.OK) && (gdpicturePDF.SetFormFieldTextAlignment(formID, TextAlignment.TextAlignmentNear) == GdPictureStatus.OK) && (gdpicturePDF.SetFormFieldMultiLine(formID, true) == GdPictureStatus.OK)) { string message = "The text form field has been created."; 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 SetTextSize()/DrawText() 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
AddTextFormField(Single,Single,Single,Single,String,String,Boolean,String,Single,Byte,Byte,Byte) Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldMultiLine Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
GetFormFieldValue(Int32) Method
AddTextFormField(Single,Single,Single,Single,String,String,Boolean,String,Single,Byte,Byte,Byte) Method