GdPicture.NET.14
GdPicture14 Namespace / GdPicturePDF Class / SetFormFieldMaxLen Method
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.
The new value of the maximum length of the field's text, in characters, that is user allowed to enter.
Example





In This Topic
SetFormFieldMaxLen Method (GdPicturePDF)
In This Topic
Sets the maximum length of the text, in characters, allowed to enter into 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.
Syntax
'Declaration
 

Public Function SetFormFieldMaxLen( _
   ByVal FieldId As Integer, _
   ByVal MaxLen As Integer _
) As GdPictureStatus
public GdPictureStatus SetFormFieldMaxLen( 
   int FieldId,
   int MaxLen
)
public function SetFormFieldMaxLen( 
    FieldId: Integer;
    MaxLen: Integer
): GdPictureStatus; 
public function SetFormFieldMaxLen( 
   FieldId : int,
   MaxLen : int
) : GdPictureStatus;
public: GdPictureStatus SetFormFieldMaxLen( 
   int FieldId,
   int MaxLen
) 
public:
GdPictureStatus SetFormFieldMaxLen( 
   int FieldId,
   int MaxLen
)

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.
MaxLen
The new value of the maximum length of the field's text, in characters, that is user allowed to enter.

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 specify the maximum length of the inserted text for the newly added text form fields. 
Dim caption As String = "Example: SetFormFieldMaxLen"
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(20) = GdPictureStatus.OK) AndAlso
               (gdpicturePDF.DrawText(fontResName, 1, 2, "GER") = GdPictureStatus.OK) AndAlso
               (gdpicturePDF.DrawText(fontResName, 1, 4, "FRA") = GdPictureStatus.OK) Then
                Dim formID As Integer = gdpicturePDF.AddTextFormField(3, 1, 3, 1, "GER-PostalCode", "", False, fontResName, 20, 165, 42, 42)
                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                    If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) <> GdPictureStatus.OK) OrElse
                       (gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) <> GdPictureStatus.OK) OrElse
                       (gdpicturePDF.SetFormFieldMaxLen(formID, 5) <> GdPictureStatus.OK) OrElse
                       (gdpicturePDF.SetFormFieldComb(formID, True) <> GdPictureStatus.OK) OrElse
                       (gdpicturePDF.SetFormFieldDefaultValue(formID, "00000") <> GdPictureStatus.OK) Then
                        MessageBox.Show("Setting 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
                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                    formID = gdpicturePDF.AddTextFormField(3, 3, 3, 1, "FRA-PostalCode", "", False, fontResName, 20, 165, 42, 42)
                    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                        If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) <> GdPictureStatus.OK) OrElse
                           (gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) <> GdPictureStatus.OK) OrElse
                           (gdpicturePDF.SetFormFieldMaxLen(formID, 4) <> GdPictureStatus.OK) OrElse
                           (gdpicturePDF.SetFormFieldComb(formID, True) <> GdPictureStatus.OK) OrElse
                           (gdpicturePDF.SetFormFieldDefaultValue(formID, "0000") <> GdPictureStatus.OK) Then
                            MessageBox.Show("Setting 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
                End If
                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                    If gdpicturePDF.SaveToFile("forms_textfield.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("Drawing text 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: SetFormFieldMaxLen";
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(20) == GdPictureStatus.OK) &&
                (gdpicturePDF.DrawText(fontResName, 1, 2, "GER") == GdPictureStatus.OK) &&
                (gdpicturePDF.DrawText(fontResName, 1, 4, "FRA") == GdPictureStatus.OK))
            {
                int formID = gdpicturePDF.AddTextFormField(3, 1, 3, 1, "GER-PostalCode", "", false, fontResName, 20, 165, 42, 42);
                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                {
                    if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) != GdPictureStatus.OK) ||
                        (gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) != GdPictureStatus.OK) ||
                        (gdpicturePDF.SetFormFieldMaxLen(formID, 5) != GdPictureStatus.OK) ||
                        (gdpicturePDF.SetFormFieldComb(formID, true) != GdPictureStatus.OK) ||
                        (gdpicturePDF.SetFormFieldDefaultValue(formID, "00000") != GdPictureStatus.OK))
                    {
                        MessageBox.Show("Setting 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);
                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                {
                    formID = gdpicturePDF.AddTextFormField(3, 3, 3, 1, "FRA-PostalCode", "", false, fontResName, 20, 165, 42, 42);
                    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                    {
                        if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) != GdPictureStatus.OK) ||
                            (gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) != GdPictureStatus.OK) ||
                            (gdpicturePDF.SetFormFieldMaxLen(formID, 4) != GdPictureStatus.OK) ||
                            (gdpicturePDF.SetFormFieldComb(formID, true) != GdPictureStatus.OK) ||
                            (gdpicturePDF.SetFormFieldDefaultValue(formID, "0000") != GdPictureStatus.OK))
                        {
                            MessageBox.Show("Setting 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);
                }
                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                {
                    if (gdpicturePDF.SaveToFile("forms_textfield.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("Drawing text 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 specify the maximum length of the inserted text for the newly added text form fields. Dim caption As String = "Example: SetFormFieldMaxLen" 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(20) = GdPictureStatus.OK) AndAlso (gdpicturePDF.DrawText(fontResName, 1, 2, "GER") = GdPictureStatus.OK) AndAlso (gdpicturePDF.DrawText(fontResName, 1, 4, "FRA") = GdPictureStatus.OK) Then Dim formID As Integer = gdpicturePDF.AddTextFormField(3, 1, 3, 1, "GER-PostalCode", "", False, fontResName, 20, 165, 42, 42) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) <> GdPictureStatus.OK) OrElse (gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) <> GdPictureStatus.OK) OrElse (gdpicturePDF.SetFormFieldMaxLen(formID, 5) <> GdPictureStatus.OK) OrElse (gdpicturePDF.SetFormFieldComb(formID, True) <> GdPictureStatus.OK) OrElse (gdpicturePDF.SetFormFieldDefaultValue(formID, "00000") <> GdPictureStatus.OK) Then MessageBox.Show("Setting 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 If gdpicturePDF.GetStat() = GdPictureStatus.OK Then formID = gdpicturePDF.AddTextFormField(3, 3, 3, 1, "FRA-PostalCode", "", False, fontResName, 20, 165, 42, 42) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then If (gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) <> GdPictureStatus.OK) OrElse (gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) <> GdPictureStatus.OK) OrElse (gdpicturePDF.SetFormFieldMaxLen(formID, 4) <> GdPictureStatus.OK) OrElse (gdpicturePDF.SetFormFieldComb(formID, True) <> GdPictureStatus.OK) OrElse (gdpicturePDF.SetFormFieldDefaultValue(formID, "0000") <> GdPictureStatus.OK) Then MessageBox.Show("Setting 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 End If If gdpicturePDF.GetStat() = GdPictureStatus.OK Then If gdpicturePDF.SaveToFile("forms_textfield.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("Drawing text 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: SetFormFieldMaxLen"; 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(20) == GdPictureStatus.OK) && (gdpicturePDF.DrawText(fontResName, 1, 2, "GER") == GdPictureStatus.OK) && (gdpicturePDF.DrawText(fontResName, 1, 4, "FRA") == GdPictureStatus.OK)) { int formID = gdpicturePDF.AddTextFormField(3, 1, 3, 1, "GER-PostalCode", "", false, fontResName, 20, 165, 42, 42); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) != GdPictureStatus.OK) || (gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) != GdPictureStatus.OK) || (gdpicturePDF.SetFormFieldMaxLen(formID, 5) != GdPictureStatus.OK) || (gdpicturePDF.SetFormFieldComb(formID, true) != GdPictureStatus.OK) || (gdpicturePDF.SetFormFieldDefaultValue(formID, "00000") != GdPictureStatus.OK)) { MessageBox.Show("Setting 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); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { formID = gdpicturePDF.AddTextFormField(3, 3, 3, 1, "FRA-PostalCode", "", false, fontResName, 20, 165, 42, 42); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { if ((gdpicturePDF.SetFormFieldBackgroundColor(formID, 255, 228, 196) != GdPictureStatus.OK) || (gdpicturePDF.SetFormFieldBorderColor(formID, 255, 69, 0) != GdPictureStatus.OK) || (gdpicturePDF.SetFormFieldMaxLen(formID, 4) != GdPictureStatus.OK) || (gdpicturePDF.SetFormFieldComb(formID, true) != GdPictureStatus.OK) || (gdpicturePDF.SetFormFieldDefaultValue(formID, "0000") != GdPictureStatus.OK)) { MessageBox.Show("Setting 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); } if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { if (gdpicturePDF.SaveToFile("forms_textfield.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("Drawing text 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
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldMaxLen Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
AddTextFormField(Single,Single,Single,Single,String,String,Boolean,String,Single,Byte,Byte,Byte) Method
GetFormFieldComb Method

 

 

Ⓒ Copyright 2024 Nutrient. All rights reserved