GetFormFieldItemCommit Method (GdPicturePDF)

In This Topic

Returns, if the CommitOnSelChange flag of a required form field, hereabout a choice field, is set. The required form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to choice fields, so this method is explicitly applicable to combo box and list box form field objects.

If this flag set, the new value is committed as soon as a selection is made with the pointing device. This option enables applications to perform an action once a selection is made, without requiring the user to exit the field. If this flag is not set, the new value is not committed until the user exits the field.

Syntax

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

'Declaration
 
Public Function GetFormFieldItemCommit( _
   ByVal FieldId As Integer _
) As Boolean

public bool GetFormFieldItemCommit( 
   int FieldId
)

public function GetFormFieldItemCommit( 
    FieldId: Integer
): Boolean;

public function GetFormFieldItemCommit( 
   FieldId : int
) : boolean;

public: bool GetFormFieldItemCommit( 
   int FieldId
)

public:
bool GetFormFieldItemCommit( 
   int FieldId
)

Parameters

FieldId: A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: AddComboFormField(Single,Single,Single,Single,String,String,Single,Byte,Byte,Byte,Boolean), AddComboFormField(Single,Single,Single,Single,String,String,Single,Byte,Byte,Byte,Boolean), GetFormFieldId or GetFormFieldChildID.

Return Value

true if the CommitOnSelChange flag of the specified choice form field is set, otherwise false. 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.

Just to remind you, that this method is only meaningful for choice form fields, that means for combo boxes or list boxes, otherwise it will fail.

Example

How to determine, which combo boxes have the CommitOnSelChange flag set in the current document.

VB.NET
C#

Dim caption As String = "Example: GetFormFieldItemCommit"
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
        If count = 0 Then
            MessageBox.Show("This document includes no form fields.", caption)
        Else
            Dim formID As Integer = 0
            Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown
            Dim edit As Boolean = False, commit As Boolean = False
            Dim title As String = "", editM As String = "Editable combo boxes:" + vbCrLf, commitM As String = "Combo boxes with CommitOnSelChange flag:" + vbCrLf
            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.PdfFormFieldTypeCombo Then
                            title = gdpicturePDF.GetFormFieldTitle(formID)
                            If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) Then
                                MessageBox.Show("The GetFormFieldTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString())
                                Exit For
                            End If
            
                            edit = gdpicturePDF.GetFormFieldItemEdit(formID)
                            If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) Then
                                MessageBox.Show("The GetFormFieldItemEdit() method has failed with the status: " + gdpicturePDF.GetStat().ToString())
                                Exit For
                            End If
            
                            commit = gdpicturePDF.GetFormFieldItemCommit(formID)
                            If (gdpicturePDF.GetStat() <> GdPictureStatus.OK) Then
                                MessageBox.Show("The GetFormFieldItemCommit() method has failed with the status: " + gdpicturePDF.GetStat().ToString())
                                Exit For
                            End If
            
                            If (edit) Then editM = editM + title + "; "
                            If (commit) Then commitM = commitM + title + "; "
                        End If
                    Else
                        MessageBox.Show("The GetFormFieldType() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                        Exit For
                    End If
                Else
                    MessageBox.Show("The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
                    Exit For
                End If
            Next
            If gdpicturePDF.GetStat() = GdPictureStatus.OK Then MessageBox.Show(editM + vbCrLf + commitM, caption)
        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. Status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
gdpicturePDF.Dispose()

string caption = "Example: GetFormFieldItemCommit";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK)
{
    int count = gdpicturePDF.GetFormFieldsCount();
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        if (count == 0)
            MessageBox.Show("This document includes no form fields.", caption);
        else
        {
            int formID = 0;
            PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;
            bool edit = false, commit = false;
            string title = "", editM = "Editable combo boxes:\n", commitM = "Combo boxes with CommitOnSelChange flag:\n";
            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.PdfFormFieldTypeCombo)
                        {
                            title = gdpicturePDF.GetFormFieldTitle(formID);
                            if (gdpicturePDF.GetStat() != GdPictureStatus.OK)
                            {
                                MessageBox.Show("The GetFormFieldTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString());
                                break;
                            }
            
                            edit = gdpicturePDF.GetFormFieldItemEdit(formID);
                            if (gdpicturePDF.GetStat() != GdPictureStatus.OK)
                            {
                                MessageBox.Show("The GetFormFieldItemEdit() method has failed with the status: " + gdpicturePDF.GetStat().ToString());
                                break;
                            }
            
                            commit = gdpicturePDF.GetFormFieldItemCommit(formID);
                            if (gdpicturePDF.GetStat() != GdPictureStatus.OK)
                            {
                                MessageBox.Show("The GetFormFieldItemCommit() method has failed with the status: " + gdpicturePDF.GetStat().ToString());
                                break;
                            }
            
                            if (edit) editM = editM + title + "; ";
                            if (commit) commitM = commitM + title + "; ";
                        }
                    }
                    else
                    {
                        MessageBox.Show("The GetFormFieldType() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                        break;
                    }
                }
                else
                {
                    MessageBox.Show("The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
                    break;
                }
            }
            if (gdpicturePDF.GetStat() == GdPictureStatus.OK) MessageBox.Show(editM + "\n" + commitM, 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. Status: " + gdpicturePDF.GetStat().ToString(), caption);
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
SetFormFieldItemCommit Method
GetFormFieldItemCount Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
AddComboFormField(Single,Single,Single,Single,String,String,Single,Byte,Byte,Byte,Boolean) Method
AddListFormField(Single,Single,Single,Single,String,String,Single,Byte,Byte,Byte,Boolean,Boolean) Method