The 0-based index of the required form field within the current document. It must be a value from 0 to GetFormFieldsCount-1.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / GetFormFieldId Method

GetFormFieldId Method (GdPicturePDF)

In This Topic
Returns the unique form field identifier of a form field specified by its index related to the currently loaded PDF document. You always have to apply this identifier when working with the specified form field object.
Syntax
'Declaration

 


Public Function GetFormFieldId( _

   ByVal FieldIdx As Integer _

) As Integer
public int GetFormFieldId( 

   int FieldIdx

)
public function GetFormFieldId( 

    FieldIdx: Integer

): Integer; 
public function GetFormFieldId( 

   FieldIdx : int

) : int;
public: int GetFormFieldId( 

   int FieldIdx

) 
public:

int GetFormFieldId( 

   int FieldIdx

)

Parameters

FieldIdx
The 0-based index of the required form field within the current document. It must be a value from 0 to GetFormFieldsCount-1.

Return Value

A unique form field identifier of the specified form field. The 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 GetStat method to identify the specific reason for the method's failure, if any.

Please ensure that you correctly identify the form field's ID using this method in order to handle the specific form field object.

Example
How to correctly determine the form field identifier to be able to subsequently handle the form field object. 
Dim caption As String = "Example: GetFormFieldId"

Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()

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

    Dim count As Integer = gdpicturePDF.GetFormFieldsCount()

    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

        Dim message As String = "This document contains " + count.ToString() + " form fields." + vbCrLf

        Dim formID As Integer = 0, pagenr As Integer = 0

        Dim name As String = ""

        Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown

        For i As Integer = 0 To count - 1

            'Getting the form field unique identifier.

            formID = gdpicturePDF.GetFormFieldId(i)

            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                message = message + (i + 1).ToString() + ". "

                'Getting the form fields' title (name).

                name = gdpicturePDF.GetFormFieldTitle(formID)

                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                    message = message + name

                Else

                    message = message + gdpicturePDF.GetStat().ToString()

                End If

                'Getting the form field's type.

                message = message + "  type: "

                type = gdpicturePDF.GetFormFieldType(formID)

                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                    message = message + type.ToString()

                Else

                    message = message + gdpicturePDF.GetStat().ToString()

                End If

                'Getting the form field's page.

                message = message + "  page nr."

                pagenr = gdpicturePDF.GetFormFieldPage(formID)

                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                    message = message + pagenr.ToString()

                Else

                    message = message + gdpicturePDF.GetStat().ToString()

                End If

                message += vbCrLf

            Else

                message = message + "The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString()

                Exit For

            End If

        Next

        MessageBox.Show(message, caption)

    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.", caption)

End If

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

GdPicturePDF gdpicturePDF = new GdPicturePDF();

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

{

    int count = gdpicturePDF.GetFormFieldsCount();

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

    {

        string message = "This document contains " + count.ToString() + " form fields.\n";

        int formID = 0, pagenr = 0;

        string name = "";

        PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;

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

        {

            //Getting the form field unique identifier.

            formID = gdpicturePDF.GetFormFieldId(i);

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

            {

                message = message + (i + 1).ToString() + ". ";

                //Getting the form fields' title (name).

                name = gdpicturePDF.GetFormFieldTitle(formID);

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

                    message = message + name;

                else

                    message = message + gdpicturePDF.GetStat().ToString();

                //Getting the form field's type.

                message = message + "  type: ";

                type = gdpicturePDF.GetFormFieldType(formID);

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

                    message = message + type.ToString();

                else

                    message = message + gdpicturePDF.GetStat().ToString();

                //Getting the form field's page.

                message = message + "  page nr.";

                pagenr = gdpicturePDF.GetFormFieldPage(formID);

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

                    message = message + pagenr.ToString();

                else

                    message = message + gdpicturePDF.GetStat().ToString();

                message += "\n";

            }

            else

            {

                message = message + "The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString();

                break;

            }

        }

        MessageBox.Show(message, 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.", caption);

gdpicturePDF.Dispose();
Example
How to correctly determine the form field identifier to be able to subsequently handle the form field object. Dim caption As String = "Example: GetFormFieldId" Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF() If gdpicturePDF.LoadFromFile("test.pdf", False) = GdPictureStatus.OK Then Dim count As Integer = gdpicturePDF.GetFormFieldsCount() If gdpicturePDF.GetStat() = GdPictureStatus.OK Then Dim message As String = "This document contains " + count.ToString() + " form fields." + vbCrLf Dim formID As Integer = 0, pagenr As Integer = 0 Dim name As String = "" Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown For i As Integer = 0 To count - 1 'Getting the form field unique identifier. formID = gdpicturePDF.GetFormFieldId(i) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then message = message + (i + 1).ToString() + ". " 'Getting the form fields' title (name). name = gdpicturePDF.GetFormFieldTitle(formID) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then message = message + name Else message = message + gdpicturePDF.GetStat().ToString() End If 'Getting the form field's type. message = message + " type: " type = gdpicturePDF.GetFormFieldType(formID) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then message = message + type.ToString() Else message = message + gdpicturePDF.GetStat().ToString() End If 'Getting the form field's page. message = message + " page nr." pagenr = gdpicturePDF.GetFormFieldPage(formID) If gdpicturePDF.GetStat() = GdPictureStatus.OK Then message = message + pagenr.ToString() Else message = message + gdpicturePDF.GetStat().ToString() End If message += vbCrLf Else message = message + "The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString() Exit For End If Next MessageBox.Show(message, caption) 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.", caption) End If gdpicturePDF.Dispose() string caption = "Example: GetFormFieldId"; GdPicturePDF gdpicturePDF = new GdPicturePDF(); if (gdpicturePDF.LoadFromFile("test.pdf", false) == GdPictureStatus.OK) { int count = gdpicturePDF.GetFormFieldsCount(); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { string message = "This document contains " + count.ToString() + " form fields.\n"; int formID = 0, pagenr = 0; string name = ""; PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown; for (int i = 0; i < count; i++) { //Getting the form field unique identifier. formID = gdpicturePDF.GetFormFieldId(i); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { message = message + (i + 1).ToString() + ". "; //Getting the form fields' title (name). name = gdpicturePDF.GetFormFieldTitle(formID); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) message = message + name; else message = message + gdpicturePDF.GetStat().ToString(); //Getting the form field's type. message = message + " type: "; type = gdpicturePDF.GetFormFieldType(formID); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) message = message + type.ToString(); else message = message + gdpicturePDF.GetStat().ToString(); //Getting the form field's page. message = message + " page nr."; pagenr = gdpicturePDF.GetFormFieldPage(formID); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) message = message + pagenr.ToString(); else message = message + gdpicturePDF.GetStat().ToString(); message += "\n"; } else { message = message + "The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(); break; } } MessageBox.Show(message, 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.", caption); gdpicturePDF.Dispose();
See Also

Reference

GdPicturePDF Class
GdPicturePDF Members
GetFormFieldsCount Method
GetStat Method
GetStat Method
GetFormFieldsCount Method
GetFormFieldType Method
GetFormFieldPage Method
GetFormFieldTitle Method
GetFormFieldChildCount Method
RemoveFormField Method