SetFormFieldItemCommit Method (GdPicturePDF)
Sets the CommitOnSelChange flag of a required form field, hereabout a choice field. 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. Be aware that it is only allowed to set this flag if the MultiSelect flag is not set for a list box, otherwise the method will fail.
public function SetFormFieldItemCommit(
: Integer;
: Boolean
): GdPictureStatus;
public function SetFormFieldItemCommit(
: int,
: boolean
) : GdPictureStatus;
'Declaration
Public Function SetFormFieldItemCommit( _
ByVal As Integer, _
ByVal As Boolean _
) As GdPictureStatus
Parameters
- FieldId
- A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: GdPicturePDF.AddComboFormField, GdPicturePDF.AddListFormField, GdPicturePDF.GetFormFieldId or GdPicturePDF.GetFormFieldChildID.
- Commit
- Set this parameter to true, if you want to enable the CommitOnSelChange flag, otherwise set it to false to disable it.
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.
How to set the CommitOnSelChange flag to all combo boxes in the current document.
Dim caption As String = "Example: SetFormFieldItemCommit"
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 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.PdfFormFieldTypeCombo Then
If (gdpicturePDF.SetFormFieldItemEdit(formID, True) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldItemCommit(formID, True) = GdPictureStatus.OK) Then
save = True
Else
MessageBox.Show("The SetFormFieldItemEdit()/SetFormFieldItemCommit() method has failed with the status: " + gdpicturePDF.GetStat().ToString())
Exit For
End If
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
If save Then
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 example has been followed successfully, but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("This document includes no combo boxes. The file has not been changed and has not been saved as well.", 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. Status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
gdpicturePDF.Dispose()
string caption = "Example: SetFormFieldItemCommit";
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 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.PdfFormFieldTypeCombo)
{
if ((gdpicturePDF.SetFormFieldItemEdit(formID, true) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldItemCommit(formID, true) == GdPictureStatus.OK))
{
save = true;
}
else
{
MessageBox.Show("The SetFormFieldItemEdit()/SetFormFieldItemCommit() method has failed with the status: " + gdpicturePDF.GetStat().ToString());
break;
}
}
}
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)
{
if (save)
{
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 example has been followed successfully, but the file can't be saved. Status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("This document includes no combo boxes. The file has not been changed and has not been saved as well.", 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
GetFormFieldItemCommit 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