SetFormFieldTitle Method (GdPicturePDF)

In This Topic

Sets 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 SetFormFieldTitle( _

   ByVal FieldId As Integer, _

   ByVal Title As String _

) As GdPictureStatus

public GdPictureStatus SetFormFieldTitle( 

   int FieldId,

   string Title

)

public function SetFormFieldTitle( 

    FieldId: Integer;

    Title: String

): GdPictureStatus;

public function SetFormFieldTitle( 

   FieldId : int,

   Title : String

) : GdPictureStatus;

public: GdPictureStatus SetFormFieldTitle( 

   int FieldId,

   string* Title

)

public:

GdPictureStatus SetFormFieldTitle( 

   int FieldId,

   String^ Title

)

Parameters

FieldId: A unique form field identifier specifying a required form field object. You can obtain this identifier using methods like GdPicturePDF.GetFormFieldId, GdPicturePDF.GetFormFieldChildID or methods intended to add form fields.
Title: The new title (name) of the specified form field.

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.

Example

How to change the title (the name) of all form fields in the current document.

VB.NET
C#

Dim caption As String = "Example: SetFormFieldTitle"

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

        Dim message As String = "", title As String = ""

        If count = 0 Then

            message = "This document does not contain any forms."

        Else

            Dim formID As Integer = 0

            For i As Integer = 0 To count - 1

                formID = gdpicturePDF.GetFormFieldId(i)

                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                    title = gdpicturePDF.GetFormFieldTitle(formID)

                    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

                        title = i.ToString() + "_" + title

                        If gdpicturePDF.SetFormFieldTitle(formID, title) = GdPictureStatus.OK Then

                            message = message + i.ToString() + ": The title has been changed successfully." + vbCrLf

                        Else

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

                        End If

                    Else

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

                    End If

                Else

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

                End If

            Next

            If gdpicturePDF.SaveToFile("forms_updated.pdf") = GdPictureStatus.OK Then

                message = message + "The file has been saved."

            Else

                message = message + "The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString()

            End If

        End If

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

GdPicturePDF gdpicturePDF = new GdPicturePDF();

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

{

    int count = gdpicturePDF.GetFormFieldsCount();

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

    {

        string message = "", title = "";

        if (count == 0)

            message = "This document does not contain any forms.";

        else

        {

            int formID = 0;

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

            {

                formID = gdpicturePDF.GetFormFieldId(i);

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

                {

                    title = gdpicturePDF.GetFormFieldTitle(formID);

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

                    {

                        title = i.ToString() + "_" + title;

                        if (gdpicturePDF.SetFormFieldTitle(formID, title) == GdPictureStatus.OK)

                            message = message + i.ToString() + ": The title has been changed successfully.\n";

                        else

                            message = message + i.ToString() + ": The SetFormFieldTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";

                    }

                    else

                        message = message + i.ToString() + ": The GetFormFieldTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";

                }

                else

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

            }

            if (gdpicturePDF.SaveToFile("forms_updated.pdf") == GdPictureStatus.OK)

                message = message + "The file has been saved.";

            else

                message = message + "The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString();

        }

        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
GetFormFieldTitle Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
GetFormFieldValue(Int32) Method