SetFormFieldDefaultValue Method (GdPicturePDF)

In This Topic

Sets the default value 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. It is a value to which the form field reverts when it is reset, that means reset-form action is executed. The format of this value is the same as defined for the field's current value attribute.

Syntax

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

'Declaration
 
Public Function SetFormFieldDefaultValue( _
   ByVal FieldId As Integer, _
   ByVal DefaultValue As String _
) As GdPictureStatus

public GdPictureStatus SetFormFieldDefaultValue( 
   int FieldId,
   string DefaultValue
)

public function SetFormFieldDefaultValue( 
    FieldId: Integer;
    DefaultValue: String
): GdPictureStatus;

public function SetFormFieldDefaultValue( 
   FieldId : int,
   DefaultValue : String
) : GdPictureStatus;

public: GdPictureStatus SetFormFieldDefaultValue( 
   int FieldId,
   string* DefaultValue
)

public:
GdPictureStatus SetFormFieldDefaultValue( 
   int FieldId,
   String^ DefaultValue
)

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.
DefaultValue: A string representation of the new default value 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 set the default value for the list box and combo box form fields.

VB.NET
C#

Dim caption As String = "Example: SetFormFieldDefaultValue"
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 = "This document contains " + count.ToString() + " form fields." + vbCrLf
        Dim formID As Integer = 0, itemCount As Integer = 0
        Dim value As String = ""
        Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown
        Dim save As Boolean = False
        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.PdfFormFieldTypeList) OrElse
                       (type = PdfFormFieldType.PdfFormFieldTypeCombo) Then
                        itemCount = gdpicturePDF.GetFormFieldItemCount(formID)
                        If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                            If itemCount > 0 Then
                                value = gdpicturePDF.GetFormFieldItemValue(formID, 0)
                                If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
                                    If gdpicturePDF.SetFormFieldDefaultValue(formID, value) = GdPictureStatus.OK Then
                                        save = True
                                    Else
                                        message = message + i.ToString() + ": The SetFormFieldDefaultValue() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf
                                    End If
                                Else
                                    message = message + i.ToString() + ": The GetFormFieldItemValue() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf
                                End If
                            End If
                        Else
                            message = message + i.ToString() + ": The GetFormFieldItemCount() 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
                Exit For
            End If
        Next
        If save Then
            If gdpicturePDF.SaveToFile("forms_updated.pdf") = GdPictureStatus.OK Then
                message = message + "The example has been followed successfully and the file has been saved."
            Else
                message = message + "The example has been followed successfully, but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString()
            End If
        Else
            message = message + "The document has not been changed, so it has not been saved as well."
        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: SetFormFieldDefaultValue";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("forms.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, itemCount = 0;
        string value = "";
        PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;
        bool save = false;
        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.PdfFormFieldTypeList) ||
                        (type == PdfFormFieldType.PdfFormFieldTypeCombo))
                    {
                        itemCount = gdpicturePDF.GetFormFieldItemCount(formID);
                        if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                        {
                            if (itemCount > 0)
                            {
                                value = gdpicturePDF.GetFormFieldItemValue(formID, 0);
                                if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
                                {
                                    if (gdpicturePDF.SetFormFieldDefaultValue(formID, value) == GdPictureStatus.OK)
                                        save = true;
                                    else
                                        message = message + i.ToString() + ": The SetFormFieldDefaultValue() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";
                                }
                                else
                                    message = message + i.ToString() + ": The GetFormFieldItemValue() method has failed with the status: " + gdpicturePDF.GetStat().ToString() + "\n";
                            }
                        }
                        else
                            message = message + i.ToString() + ": The GetFormFieldItemCount() 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";
                break;
            }
        }
        if (save)
        {
            if (gdpicturePDF.SaveToFile("forms_updated.pdf") == GdPictureStatus.OK)
                message = message + "The example has been followed successfully and the file has been saved.";
            else
                message = message + "The example has been followed successfully, but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString();
        }
        else
            message = message + "The document has not been changed, so it has not been saved as well.";
        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
GetFormFieldDefaultValue Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
GetFormFieldValue(Int32) Method