GetFormFieldTitle Method (GdPicturePDF)

In This Topic

Returns the title (the name) of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function GetFormFieldTitle( _
   ByVal FieldId As Integer _
) As String

public string GetFormFieldTitle( 
   int FieldId
)

public function GetFormFieldTitle( 
    FieldId: Integer
): String;

public function GetFormFieldTitle( 
   FieldId : int
) : String;

public: string* GetFormFieldTitle( 
   int FieldId
)

public:
String^ GetFormFieldTitle( 
   int FieldId
)

Parameters

FieldId: A unique form field identifier specifying a required form field object. You can obtain this identifier using methods like GetFormFieldId, GetFormFieldChildID or methods intended to add form fields.

Return Value

The title (name) of the specified form field.

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.

Just to inform you, that the field name is optional, so it can be an empty string. But it is recommended to set a value.

Example

How to determine all used form fields in the document, their types and their names.

VB.NET
C#

Dim caption As String = "Example: GetFormFieldTitle"
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: GetFormFieldTitle";
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();

Reference

GdPicturePDF Class
GdPicturePDF Members
SetFormFieldTitle Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
GetFormFieldValue(Int32) Method