GetFormFieldAlternateTitle Method (GdPicturePDF)

In This Topic

Returns the alternate title (the alternate field 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.

This alternate name is used in place of the actual field name wherever the field must be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document’s content in support of accessibility to users with disabilities or for other purposes. For example, it can be displayed as the field's tooltip when users are hovering with the mouse over the field.

Syntax

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

'Declaration

 

Public Function GetFormFieldAlternateTitle( _

   ByVal FieldId As Integer _

) As String

public string GetFormFieldAlternateTitle( 

   int FieldId

)

public function GetFormFieldAlternateTitle( 

    FieldId: Integer

): String;

public function GetFormFieldAlternateTitle( 

   FieldId : int

) : String;

public: string* GetFormFieldAlternateTitle( 

   int FieldId

)

public:

String^ GetFormFieldAlternateTitle( 

   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 alternate title (alternate name) 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.

Example

How to change or define the alternate title for the fields, which have this attribute blank or undefined.

VB.NET
C#

Dim caption As String = "Example: GetFormFieldAlternateTitle"

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 formID As Integer = 0

        Dim title As String = "", altertitle As String = ""

        Dim save As Boolean = True

        Dim status As GdPictureStatus = GdPictureStatus.OK

        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

                    If String.IsNullOrEmpty(title) Then title = "Created"

                    altertitle = gdpicturePDF.GetFormFieldAlternateTitle(formID)

                    Select Case gdpicturePDF.GetStat()

                        Case GdPictureStatus.OK

                            If String.IsNullOrEmpty(altertitle) Then status = gdpicturePDF.SetFormFieldAlternateTitle(formID, title + " by GdPicture")

                        Case GdPictureStatus.PropertyNotFound

                            status = gdpicturePDF.SetFormFieldAlternateTitle(formID, title + " by GdPicture")

                        Case Else

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

                    End Select

                    If status <> GdPictureStatus.OK Then

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

                    End If

                Else

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

                End If

            Else

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

                save = False

                Exit For

            End If

        Next

        If save Then

            If count = 0 Then

                MessageBox.Show("This file doesn't include forms.", caption)

            Else

                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 file can't be saved.", 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.", caption)

End If

gdpicturePDF.Dispose()

string caption = "Example: GetFormFieldAlternateTitle";

GdPicturePDF gdpicturePDF = new GdPicturePDF();

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

{

    int count = gdpicturePDF.GetFormFieldsCount();

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

    {

        int formID = 0;

        string title = "", altertitle = "";

        bool save = true;

        GdPictureStatus status = GdPictureStatus.OK;

        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)

                {

                    if (String.IsNullOrEmpty(title))

                        title = "Created";

                    altertitle = gdpicturePDF.GetFormFieldAlternateTitle(formID);

                    switch (gdpicturePDF.GetStat())

                    {

                        case GdPictureStatus.OK:

                            if (String.IsNullOrEmpty(altertitle)) status = gdpicturePDF.SetFormFieldAlternateTitle(formID, title + " by GdPicture");

                            break;

                        case GdPictureStatus.PropertyNotFound:

                            status = gdpicturePDF.SetFormFieldAlternateTitle(formID, title + " by GdPicture");

                            break;

                        default:

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

                            break;

                    }

                    if (status != GdPictureStatus.OK)

                    {

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

                    }

                }

                else

                {

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

                }

            }

            else

            {

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

                save = false;

                break;

            }

        }

        if (save)

        {

            if (count == 0)

                MessageBox.Show("This file doesn't include forms.", caption);

            else

            {

                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 file can't be saved.", 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 change or define the alternate title for the fields, which have this attribute blank or undefined. Dim caption As String = "Example: GetFormFieldAlternateTitle" 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 formID As Integer = 0 Dim title As String = "", altertitle As String = "" Dim save As Boolean = True Dim status As GdPictureStatus = GdPictureStatus.OK 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 If String.IsNullOrEmpty(title) Then title = "Created" altertitle = gdpicturePDF.GetFormFieldAlternateTitle(formID) Select Case gdpicturePDF.GetStat() Case GdPictureStatus.OK If String.IsNullOrEmpty(altertitle) Then status = gdpicturePDF.SetFormFieldAlternateTitle(formID, title + " by GdPicture") Case GdPictureStatus.PropertyNotFound status = gdpicturePDF.SetFormFieldAlternateTitle(formID, title + " by GdPicture") Case Else MessageBox.Show("The GetFormFieldAlternateTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End Select If status <> GdPictureStatus.OK Then MessageBox.Show("The SetFormFieldAlternateTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("The GetFormFieldTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) End If Else MessageBox.Show("The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption) save = False Exit For End If Next If save Then If count = 0 Then MessageBox.Show("This file doesn't include forms.", caption) Else 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 file can't be saved.", 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.", caption) End If gdpicturePDF.Dispose() string caption = "Example: GetFormFieldAlternateTitle"; GdPicturePDF gdpicturePDF = new GdPicturePDF(); if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK) { int count = gdpicturePDF.GetFormFieldsCount(); if (gdpicturePDF.GetStat() == GdPictureStatus.OK) { int formID = 0; string title = "", altertitle = ""; bool save = true; GdPictureStatus status = GdPictureStatus.OK; 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) { if (String.IsNullOrEmpty(title)) title = "Created"; altertitle = gdpicturePDF.GetFormFieldAlternateTitle(formID); switch (gdpicturePDF.GetStat()) { case GdPictureStatus.OK: if (String.IsNullOrEmpty(altertitle)) status = gdpicturePDF.SetFormFieldAlternateTitle(formID, title + " by GdPicture"); break; case GdPictureStatus.PropertyNotFound: status = gdpicturePDF.SetFormFieldAlternateTitle(formID, title + " by GdPicture"); break; default: MessageBox.Show("The GetFormFieldAlternateTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); break; } if (status != GdPictureStatus.OK) { MessageBox.Show("The SetFormFieldAlternateTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); } } else { MessageBox.Show("The GetFormFieldTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); } } else { MessageBox.Show("The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption); save = false; break; } } if (save) { if (count == 0) MessageBox.Show("This file doesn't include forms.", caption); else { 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 file can't be saved.", 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
GetFormFieldId Method
GetFormFieldChildID Method
GetStat Method
GetStat Method
SetFormFieldAlternateTitle Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
SetFormFieldTitle Method
AttachTagToFormField Method