A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: GdPicturePDF.AddComboFormField, GdPicturePDF.GetFormFieldId or GdPicturePDF.GetFormFieldChildID.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / GetFormFieldItemEdit Method

GetFormFieldItemEdit Method (GdPicturePDF)

In This Topic
Returns, if the Edit flag of a required form field, here a combo box, is set. The combo box field 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 combo boxes, so this method is explicitly applicable to combo box form field objects.

If this flag is set, the combo box includes an editable text box as well as a drop-down list, if this flag is not set, the combo box includes only a drop-down list. In other words, if the flag is set, the combo box is editable and allows to enter custom text.

Syntax
'Declaration

 

Public Function GetFormFieldItemEdit( _

   ByVal FieldId As Integer _

) As Boolean
public bool GetFormFieldItemEdit( 

   int FieldId

)
public function GetFormFieldItemEdit( 

    FieldId: Integer

): Boolean; 
public function GetFormFieldItemEdit( 

   FieldId : int

) : boolean;
public: bool GetFormFieldItemEdit( 

   int FieldId

) 
public:

bool GetFormFieldItemEdit( 

   int FieldId

) 

Parameters

FieldId
A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: GdPicturePDF.AddComboFormField, GdPicturePDF.GetFormFieldId or GdPicturePDF.GetFormFieldChildID.

Return Value

true if the Edit flag of the specified combo box field is set, otherwise false. 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.

Just to remind you, that this method is only meaningful for combo boxes, otherwise it will fail.

Example
How to determine, which combo boxes are editable in the current document.
Dim caption As String = "Example: GetFormFieldItemEdit"

Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()

If gdpicturePDF.LoadFromFile("forms.pdf", False) = GdPictureStatus.OK Then

    Dim count As Integer = gdpicturePDF.GetFormFieldsCount()

    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

        If count = 0 Then

            MessageBox.Show("This document includes no form fields.", caption)

        Else

            Dim formID As Integer = 0

            Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown

            Dim edit As Boolean = False, commit As Boolean = False

            Dim title As String = "", editM As String = "Editable combo boxes:" + vbCrLf, commitM As String = "Combo boxes with CommitOnSelChange flag:" + vbCrLf

            For i As Integer = 0 To count - 1

                formID = gdpicturePDF.GetFormFieldId(i)

                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                    type = gdpicturePDF.GetFormFieldType(formID)

                    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                        If type = PdfFormFieldType.PdfFormFieldTypeCombo Then

                            title = gdpicturePDF.GetFormFieldTitle(formID)

                            If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) Then

                                MessageBox.Show("The GetFormFieldTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString())

                                Exit For

                            End If

            

                            edit = gdpicturePDF.GetFormFieldItemEdit(formID)

                            If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) Then

                                MessageBox.Show("The GetFormFieldItemEdit() method has failed with the status: " + gdpicturePDF.GetStat().ToString())

                                Exit For

                            End If

            

                            commit = gdpicturePDF.GetFormFieldItemCommit(formID)

                            If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) Then

                                MessageBox.Show("The GetFormFieldItemCommit() method has failed with the status: " + gdpicturePDF.GetStat().ToString())

                                Exit For

                            End If

            

                            If (edit) Then editM = editM + title + "; "

                            If (commit) Then commitM = commitM + title + "; "

                        End If

                    Else

                        MessageBox.Show("The GetFormFieldType() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                        Exit For

                    End If

                Else

                    MessageBox.Show("The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

                    Exit For

                End If

            Next

            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then MessageBox.Show(editM + vbCrLf + commitM, caption)

        End If

    Else

        MessageBox.Show("The GetFormFieldsCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)

    End If

Else

    MessageBox.Show("The file can't be loaded. Status: " + gdpicturePDF.GetStat().ToString(), caption)

End If

gdpicturePDF.Dispose()
string caption = "Example: GetFormFieldItemEdit";

GdPicturePDF gdpicturePDF = new GdPicturePDF();

if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK)

{

    int count = gdpicturePDF.GetFormFieldsCount();

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

    {

        if (count == 0)

            MessageBox.Show("This document includes no form fields.", caption);

        else

        {

            int formID = 0;

            PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;

            bool edit = false, commit = false;

            string title = "", editM = "Editable combo boxes:\n", commitM = "Combo boxes with CommitOnSelChange flag:\n";

            for (int i = 0; i < count; i++)

            {

                formID = gdpicturePDF.GetFormFieldId(i);

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

                {

                    type = gdpicturePDF.GetFormFieldType(formID);

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

                    {

                        if (type == PdfFormFieldType.PdfFormFieldTypeCombo)

                        {

                            title = gdpicturePDF.GetFormFieldTitle(formID);

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

                            {

                                MessageBox.Show("The GetFormFieldTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString());

                                break;

                            }

            

                            edit = gdpicturePDF.GetFormFieldItemEdit(formID);

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

                            {

                                MessageBox.Show("The GetFormFieldItemEdit() method has failed with the status: " + gdpicturePDF.GetStat().ToString());

                                break;

                            }

            

                            commit = gdpicturePDF.GetFormFieldItemCommit(formID);

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

                            {

                                MessageBox.Show("The GetFormFieldItemCommit() method has failed with the status: " + gdpicturePDF.GetStat().ToString());

                                break;

                            }

            

                            if (edit) editM = editM + title + "; ";

                            if (commit) commitM = commitM + title + "; ";

                        }

                    }

                    else

                    {

                        MessageBox.Show("The GetFormFieldType() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                        break;

                    }

                }

                else

                {

                    MessageBox.Show("The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

                    break;

                }

            }

            if (gdpicturePDF.GetStat() == GdPictureStatus.OK) MessageBox.Show(editM + "\n" + commitM, caption);

        }

    }

    else

        MessageBox.Show("The GetFormFieldsCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);

}

else

    MessageBox.Show("The file can't be loaded. Status: " + gdpicturePDF.GetStat().ToString(), caption);

gdpicturePDF.Dispose();
See Also