GdPicture.NET.14
GdPicture14 Namespace / GdPicturePDF Class / SetFormFieldComb Method
A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: AddTextFormField(Single,Single,Single,Single,String,String,Boolean,String,Single,Byte,Byte,Byte), GetFormFieldId or GetFormFieldChildID.
Set this parameter to true, if you want to enable the Comb flag, otherwise set it to false to disable it.
Example





In This Topic
SetFormFieldComb Method (GdPicturePDF)
In This Topic
Sets the Comb 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 explicitely applicable to text form field objects.

If this flag is set, then the text field is automatically divided into as many equally spaced positions, or combs, as the value of maximum length of the field's text defines, and the text is laid out into those combs. This flag is meaningful only if the MaxLen attribute is defined for the text form field and if the Multiline, Password, and FileSelect flags are not set.

Syntax
'Declaration
 
Public Function SetFormFieldComb( _
   ByVal FieldId As Integer, _
   ByVal Comb As Boolean _
) As GdPictureStatus
public GdPictureStatus SetFormFieldComb( 
   int FieldId,
   bool Comb
)
public function SetFormFieldComb( 
    FieldId: Integer;
    Comb: Boolean
): GdPictureStatus; 
public function SetFormFieldComb( 
   FieldId : int,
   Comb : boolean
) : GdPictureStatus;
public: GdPictureStatus SetFormFieldComb( 
   int FieldId,
   bool Comb
) 
public:
GdPictureStatus SetFormFieldComb( 
   int FieldId,
   bool Comb
) 

Parameters

FieldId
A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: AddTextFormField(Single,Single,Single,Single,String,String,Boolean,String,Single,Byte,Byte,Byte), GetFormFieldId or GetFormFieldChildID.
Comb
Set this parameter to true, if you want to enable the Comb 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. Likewise, be careful about constraints when using this method, please refer to the Summary section above.

Example
How to utilize the Comb flag for the newly added text form fields, which represent the different postal codes.
Dim caption As String = "Example: SetFormFieldComb"
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", "12345", 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", "1234", 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: SetFormFieldComb";
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", "12345", 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", "1234", 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