GetFormFieldItemCount Method (GdPicturePDF)
Returns the number of all items included in the required choice form field, hereabout a combo box or a list box, that is specified by its unique form field's
identifier and it is related to the currently loaded PDF document. As said, this method is only applicable to combo boxes and list boxes.
public int GetFormFieldItemCount(
int
)
public function GetFormFieldItemCount(
: Integer
): Integer;
public function GetFormFieldItemCount(
: int
) : int;
public: int GetFormFieldItemCount(
int
)
public:
int GetFormFieldItemCount(
int
)
'Declaration
Public Function GetFormFieldItemCount( _
ByVal As Integer _
) As Integer
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.
Return Value
The number of items included in the required form field. The
GdPicturePDF.GetStat method can be subsequently used to determine if this method has been successful.
How to find out the total number of items in the combo box field.
Dim caption As String = "Example: GetFormFieldItemCount"
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 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.PdfFormFieldTypeCombo Then
Dim itemsCount As Integer = gdpicturePDF.GetFormFieldItemCount(formID)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
If itemsCount > 0 Then
If gdpicturePDF.DeleteFormFieldItem(formID, 0) = GdPictureStatus.OK Then
Dim message As String = "The item has been successfully deleted." + vbCrLf
If gdpicturePDF.AddFormFieldItem(formID, "Zucchini") = GdPictureStatus.OK Then
message = message + "The new item has been successfully added." + 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
Else
message = "The AddFormFieldItem() method has failed with the status: " + gdpicturePDF.GetStat().ToString()
End If
MessageBox.Show(message, caption)
Exit For
Else
MessageBox.Show("The DeleteFormFieldItem() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
Exit For
End If
Else
MessageBox.Show("The first combo box includes no items.", caption)
Exit For
End If
Else
MessageBox.Show("The GetFormFieldItemCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
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 count = 0 Then MessageBox.Show("This document includes no form fields.", 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. Status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
gdpicturePDF.Dispose()
string caption = "Example: GetFormFieldItemCount";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("forms.pdf", false) == GdPictureStatus.OK)
{
int count = gdpicturePDF.GetFormFieldsCount();
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
int formID = 0;
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.PdfFormFieldTypeCombo)
{
int itemsCount = gdpicturePDF.GetFormFieldItemCount(formID);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
if (itemsCount > 0)
{
if (gdpicturePDF.DeleteFormFieldItem(formID, 0) == GdPictureStatus.OK)
{
string message = "The item has been successfully deleted.\n";
if (gdpicturePDF.AddFormFieldItem(formID, "Zucchini") == GdPictureStatus.OK)
{
message = message + "The new item has been successfully added.\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();
}
else
{
message = "The AddFormFieldItem() method has failed with the status: " + gdpicturePDF.GetStat().ToString();
}
MessageBox.Show(message, caption);
break;
}
else
{
MessageBox.Show("The DeleteFormFieldItem() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
break;
}
}
else
{
MessageBox.Show("The first combo box includes no items.", caption);
break;
}
}
else
{
MessageBox.Show("The GetFormFieldItemCount() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
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 (count == 0)
MessageBox.Show("This document includes no form fields.", 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();
