GetFormFieldsCount Method (GdPicturePDF)
In This Topic
Returns the total number of all form fields in the currently loaded PDF document. Form fields are interactive objects for gathering information from users through the PDF document.
Please use the GdPicturePDF.GetFormFieldId method to retrieve the unique form field identifier in order to correctly identify the specific form field object.
Syntax
'Declaration
Public Function GetFormFieldsCount() As Integer
public int GetFormFieldsCount()
public function GetFormFieldsCount(): Integer;
public function GetFormFieldsCount() : int;
public: int GetFormFieldsCount();
public:
int GetFormFieldsCount();
Return Value
The total number of form field objects in the current document. The
GdPicturePDF.GetStat method can be subsequently used to determine if this method has been successful.
Example
How to find out the total number of form fields in the loaded PDF document.
Dim caption As String = "Example: GetFormFieldsCount"
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()
If gdpicturePDF.LoadFromFile("test.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, pagenr As Integer = 0
Dim name As String = ""
Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown
For i As Integer = 0 To count - 1
'Getting the form field unique identifier.
formID = gdpicturePDF.GetFormFieldId(i)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + (i + 1).ToString() + ". "
'Getting the form fields' title (name).
name = gdpicturePDF.GetFormFieldTitle(formID)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + name
Else
message = message + gdpicturePDF.GetStat().ToString()
End If
'Getting the form field's type.
message = message + " type: "
type = gdpicturePDF.GetFormFieldType(formID)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + type.ToString()
Else
message = message + gdpicturePDF.GetStat().ToString()
End If
'Getting the form field's page.
message = message + " page nr."
pagenr = gdpicturePDF.GetFormFieldPage(formID)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + pagenr.ToString()
Else
message = message + gdpicturePDF.GetStat().ToString()
End If
message += vbCrLf
Else
message = message + "The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString()
Exit For
End If
Next
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: GetFormFieldsCount";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("test.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, pagenr = 0;
string name = "";
PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;
for (int i = 0; i < count; i++)
{
//Getting the form field unique identifier.
formID = gdpicturePDF.GetFormFieldId(i);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
message = message + (i + 1).ToString() + ". ";
//Getting the form fields' title (name).
name = gdpicturePDF.GetFormFieldTitle(formID);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
message = message + name;
else
message = message + gdpicturePDF.GetStat().ToString();
//Getting the form field's type.
message = message + " type: ";
type = gdpicturePDF.GetFormFieldType(formID);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
message = message + type.ToString();
else
message = message + gdpicturePDF.GetStat().ToString();
//Getting the form field's page.
message = message + " page nr.";
pagenr = gdpicturePDF.GetFormFieldPage(formID);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
message = message + pagenr.ToString();
else
message = message + gdpicturePDF.GetStat().ToString();
message += "\n";
}
else
{
message = message + "The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString();
break;
}
}
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();
Example
How to find out the total number of form fields in the loaded PDF document.
Dim caption As String = "Example: GetFormFieldsCount"
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()
If gdpicturePDF.LoadFromFile("test.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, pagenr As Integer = 0
Dim name As String = ""
Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown
For i As Integer = 0 To count - 1
'Getting the form field unique identifier.
formID = gdpicturePDF.GetFormFieldId(i)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + (i + 1).ToString() + ". "
'Getting the form fields' title (name).
name = gdpicturePDF.GetFormFieldTitle(formID)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + name
Else
message = message + gdpicturePDF.GetStat().ToString()
End If
'Getting the form field's type.
message = message + " type: "
type = gdpicturePDF.GetFormFieldType(formID)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + type.ToString()
Else
message = message + gdpicturePDF.GetStat().ToString()
End If
'Getting the form field's page.
message = message + " page nr."
pagenr = gdpicturePDF.GetFormFieldPage(formID)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
message = message + pagenr.ToString()
Else
message = message + gdpicturePDF.GetStat().ToString()
End If
message += vbCrLf
Else
message = message + "The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString()
Exit For
End If
Next
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: GetFormFieldsCount";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("test.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, pagenr = 0;
string name = "";
PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;
for (int i = 0; i < count; i++)
{
//Getting the form field unique identifier.
formID = gdpicturePDF.GetFormFieldId(i);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
message = message + (i + 1).ToString() + ". ";
//Getting the form fields' title (name).
name = gdpicturePDF.GetFormFieldTitle(formID);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
message = message + name;
else
message = message + gdpicturePDF.GetStat().ToString();
//Getting the form field's type.
message = message + " type: ";
type = gdpicturePDF.GetFormFieldType(formID);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
message = message + type.ToString();
else
message = message + gdpicturePDF.GetStat().ToString();
//Getting the form field's page.
message = message + " page nr.";
pagenr = gdpicturePDF.GetFormFieldPage(formID);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
message = message + pagenr.ToString();
else
message = message + gdpicturePDF.GetStat().ToString();
message += "\n";
}
else
{
message = message + "The GetFormFieldId() method has failed with the status: " + gdpicturePDF.GetStat().ToString();
break;
}
}
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();
See Also