A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: AddComboFormField(Single,Single,Single,Single,String,String,Single,Byte,Byte,Byte,Boolean), GetFormFieldId or GetFormFieldChildID.
Set this parameter to true, if you want to enable the Edit flag, otherwise set it to false to disable it.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / SetFormFieldItemEdit Method

SetFormFieldItemEdit Method (GdPicturePDF)

In This Topic
Sets the Edit flag of a required form field, here a combo box, 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 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 SetFormFieldItemEdit( _

   ByVal FieldId As Integer, _

   ByVal Editable As Boolean _

) As GdPictureStatus
public GdPictureStatus SetFormFieldItemEdit( 

   int FieldId,

   bool Editable

)
public function SetFormFieldItemEdit( 

    FieldId: Integer;

    Editable: Boolean

): GdPictureStatus; 
public function SetFormFieldItemEdit( 

   FieldId : int,

   Editable : boolean

) : GdPictureStatus;
public: GdPictureStatus SetFormFieldItemEdit( 

   int FieldId,

   bool Editable

) 
public:

GdPictureStatus SetFormFieldItemEdit( 

   int FieldId,

   bool Editable

)

Parameters

FieldId
A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: AddComboFormField(Single,Single,Single,Single,String,String,Single,Byte,Byte,Byte,Boolean), GetFormFieldId or GetFormFieldChildID.
Editable
Set this parameter to true, if you want to enable the Edit 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 combo boxes, otherwise it will fail.

Example
How to change all combo boxes in the current document to be editable. 
Dim caption As String = "Example: SetFormFieldItemEdit"

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 save As Boolean = False

            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

                            If (gdpicturePDF.SetFormFieldItemEdit(formID, True) = GdPictureStatus.OK) AndAlso

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

                                save = True

                            Else

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

                                Exit For

                            End If

                        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

                If save Then

                    If gdpicturePDF.SaveToFile("forms_updated.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

                Else

                    MessageBox.Show("This document includes no combo boxes. The file has not been changed and has not been saved as well.", caption)

                End If

            End If

        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: SetFormFieldItemEdit";

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 save = false;

            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)

                        {

                            if ((gdpicturePDF.SetFormFieldItemEdit(formID, true) == GdPictureStatus.OK) &&

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

                            {

                                save = true;

                            }

                            else

                            {

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

                                break;

                            }

                        }

                    }

                    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)

            {

                if (save)

                {

                    if (gdpicturePDF.SaveToFile("forms_updated.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("This document includes no combo boxes. The file has not been changed and has not been saved as well.", 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();
Example
How to change all combo boxes in the current document to be editable. Dim caption As String = "Example: SetFormFieldItemEdit" 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 save As Boolean = False 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 If (gdpicturePDF.SetFormFieldItemEdit(formID, True) = GdPictureStatus.OK) AndAlso (gdpicturePDF.SetFormFieldItemCommit(formID, True) = GdPictureStatus.OK) Then save = True Else MessageBox.Show("The SetFormFieldItemEdit()/SetFormFieldItemCommit() method has failed with the status: " + gdpicturePDF.GetStat().ToString()) Exit For End If 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 If save Then If gdpicturePDF.SaveToFile("forms_updated.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 Else MessageBox.Show("This document includes no combo boxes. The file has not been changed and has not been saved as well.", caption) End If End If 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: SetFormFieldItemEdit"; 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 save = false; 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) { if ((gdpicturePDF.SetFormFieldItemEdit(formID, true) == GdPictureStatus.OK) && (gdpicturePDF.SetFormFieldItemCommit(formID, true) == GdPictureStatus.OK)) { save = true; } else { MessageBox.Show("The SetFormFieldItemEdit()/SetFormFieldItemCommit() method has failed with the status: " + gdpicturePDF.GetStat().ToString()); break; } } } 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) { if (save) { if (gdpicturePDF.SaveToFile("forms_updated.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("This document includes no combo boxes. The file has not been changed and has not been saved as well.", 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

Reference

GdPicturePDF Class
GdPicturePDF Members
AddComboFormField(Single,Single,Single,Single,String,String,Single,Byte,Byte,Byte,Boolean) Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldItemEdit Method
GetFormFieldItemCount Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
AddComboFormField(Single,Single,Single,Single,String,String,Single,Byte,Byte,Byte,Boolean) Method