SetFormFieldNormalCaption Method (GdPicturePDF)

In This Topic

Sets the normal caption of a required form field, here a button form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this attribute is only specific to button form fields, so this method is explicitly applicable to button form field objects.

This caption is displayed when the button form field is not interacting with the user.

Syntax

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

'Declaration
 
Public Function SetFormFieldNormalCaption( _
   ByVal FieldId As Integer, _
   ByVal NormalCaption As String _
) As GdPictureStatus

public GdPictureStatus SetFormFieldNormalCaption( 
   int FieldId,
   string NormalCaption
)

public function SetFormFieldNormalCaption( 
    FieldId: Integer;
    NormalCaption: String
): GdPictureStatus;

public function SetFormFieldNormalCaption( 
   FieldId : int,
   NormalCaption : String
) : GdPictureStatus;

public: GdPictureStatus SetFormFieldNormalCaption( 
   int FieldId,
   string* NormalCaption
)

public:
GdPictureStatus SetFormFieldNormalCaption( 
   int FieldId,
   String^ NormalCaption
)

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.
NormalCaption: The new normal caption 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.

Just to remind you, that this method is only meaningful for button form fields (these are push buttons, check boxes, radio buttons), otherwise it will fail.

Example

How to find out and change the caption of all push buttons in the current document.

VB.NET
C#

Dim caption As String = "Example: SetFormFieldNormalCaption"
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 = ""
        If count = 0 Then
            message = "This document does not contain any forms."
        Else
            Dim formID As Integer = 0
            Dim normalCaption As String = ""
            Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown
            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.PdfFormFieldTypePushButton Then
                            normalCaption = gdpicturePDF.GetFormFieldNormalCaption(formID)
                            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                                normalCaption = "* " + normalCaption + " *"
                                If gdpicturePDF.SetFormFieldNormalCaption(formID, normalCaption) <> GdPictureStatus.OK Then
                                    message = message + i.ToString() + ": The SetFormFieldNormalCaption() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf
                                End If
                            Else
                                message = message + i.ToString() + ": The GetFormFieldNormalCaption() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf
                            End If
                        End If
                    Else
                        message = message + i.ToString() + ": The GetFormFieldType() 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
        End If
        If message.Equals("") Then message = "The example has been followed successfully." + vbCrLf
        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
        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: SetFormFieldNormalCaption";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK)
{
    int count = gdpicturePDF.GetFormFieldsCount();
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        string message = "";
        if (count == 0)
            message = "This document does not contain any forms.";
        else
        {
            int formID = 0;
            string normalCaption = "";
            PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;
            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.PdfFormFieldTypePushButton)
                        {
                            normalCaption = gdpicturePDF.GetFormFieldNormalCaption(formID);
                            if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                            {
                                normalCaption = "* " + normalCaption + " *";
                                if (gdpicturePDF.SetFormFieldNormalCaption(formID, normalCaption) != GdPictureStatus.OK)
                                    message = message + i.ToString() + ": The SetFormFieldNormalCaption() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";
                            }
                            else
                                message = message + i.ToString() + ": The GetFormFieldNormalCaption() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";
                        }
                    }
                    else
                        message = message + i.ToString() + ": The GetFormFieldType() 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 (message.Equals("")) message = "The example has been followed successfully.\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
GetFormFieldNormalCaption Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
AddPushButtonFormField(Single,Single,Single,Single,String,String,String,Single,Byte,Byte,Byte) Method
AddCheckBoxFormField(Single,Single,Single,Single,String,PdfCheckBoxStyle,Boolean,Byte,Byte,Byte) Method
AddRadioButtonFormField(Single,Single,Single,Single,String,String,PdfCheckBoxStyle,Byte,Byte,Byte) Method