AddFormFieldItem(Int32,String,String) Method
In This Topic
Adds a new item to a choice form field, hereabout a combo box or a list box, specified by its unique form field's identifier. At the same, this
item is set to be the current value of the specified form field roght after adding. The items are always displayed in that order, in which they are added
to the specified form field, it means they are not sorted in any way. Be aware that this method is only applicable to choice form field objects.
Syntax
'Declaration
Public Overloads Function AddFormFieldItem( _
ByVal As Integer, _
ByVal As String, _
ByVal As String _
) As GdPictureStatus
public GdPictureStatus AddFormFieldItem(
int ,
string ,
string
)
public function AddFormFieldItem(
: Integer;
: String;
: String
): GdPictureStatus;
public function AddFormFieldItem(
: int,
: String,
: String
) : GdPictureStatus;
public: GdPictureStatus AddFormFieldItem(
int ,
string* ,
string*
)
public:
GdPictureStatus AddFormFieldItem(
int ,
String^ ,
String^
)
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.
- Text
- A text string to be displayed in the form field as the name of the newly added form field's item. It represents the form field's value.
- Value
- An export value of the newly added item, which is used when exporting form field's data from the document.
Please do not confuse an export value of the added item with its name. The export value does not represent the item's value.
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.
Example
How to populate a newly created list box form field with required text items together with their export values.
Dim caption As String = "Example: AddFormFieldItem"
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()
If (gdpicturePDF.NewPDF() = GdPictureStatus.OK) AndAlso
(gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) Then
gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter)
'Please always select the required page before adding a form field.
If gdpicturePDF.SelectPage(1) = GdPictureStatus.OK Then
Dim fontResName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontHelvetica)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
Dim formID As Integer = gdpicturePDF.AddListFormField(1, 1, 3, 4, "ListBox1", fontResName, 20, Color.DarkBlue, False, True)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
Dim formType As PdfFormFieldType = gdpicturePDF.GetFormFieldType(formID)
If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldBorderColor(formID, Color.DarkBlue) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldMultiSelect(formID, True) = GdPictureStatus.OK) Then
If (gdpicturePDF.AddFormFieldItem(formID, "English", "ENG") = GdPictureStatus.OK) AndAlso
(gdpicturePDF.AddFormFieldItem(formID, "German", "GER") = GdPictureStatus.OK) AndAlso
(gdpicturePDF.AddFormFieldItem(formID, "French", "FRA") = GdPictureStatus.OK) AndAlso
(gdpicturePDF.AddFormFieldItem(formID, "Slovak", "SVK") = GdPictureStatus.OK) Then
Dim message As String = "The list box form field has been created." + vbCrLf + "Type: " + formType.ToString() + " ID: " + formID.ToString()
If gdpicturePDF.SaveToFile("ListBox_ExportValue.pdf") = GdPictureStatus.OK Then
message = message + vbCrLf + "The file has been saved successfully."
Else
message = message + vbCrLf + "The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString()
End If
MessageBox.Show(message, caption)
Else
MessageBox.Show("Setting form field items has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("The AddListFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("The AddStandardFont() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("The file can't be created.", caption)
End If
gdpicturePDF.Dispose()
string caption = "Example: AddFormFieldItem";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if ((gdpicturePDF.NewPDF() == GdPictureStatus.OK) &&
(gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK))
{
gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter);
//Please always select the required page before adding a form field.
if (gdpicturePDF.SelectPage(1) == GdPictureStatus.OK)
{
string fontResName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontHelvetica);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
int formID = gdpicturePDF.AddListFormField(1, 1, 3, 4, "ListBox1", fontResName, 20, Color.DarkBlue, false, true);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
PdfFormFieldType formType = gdpicturePDF.GetFormFieldType(formID);
if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldBorderColor(formID, Color.DarkBlue) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldMultiSelect(formID, true) == GdPictureStatus.OK))
{
if ((gdpicturePDF.AddFormFieldItem(formID, "English", "ENG") == GdPictureStatus.OK) &&
(gdpicturePDF.AddFormFieldItem(formID, "German", "GER") == GdPictureStatus.OK) &&
(gdpicturePDF.AddFormFieldItem(formID, "French", "FRA") == GdPictureStatus.OK) &&
(gdpicturePDF.AddFormFieldItem(formID, "Slovak", "SVK") == GdPictureStatus.OK))
{
string message = "The list box form field has been created.\n" + "Type: " + formType.ToString() + " ID: " + formID.ToString();
if (gdpicturePDF.SaveToFile("ListBox_ExportValue.pdf") == GdPictureStatus.OK)
message = message + "\nThe file has been saved successfully.";
else
message = message + "\nThe file can't be saved. Status: " + gdpicturePDF.GetStat().ToString();
MessageBox.Show(message, caption);
}
else
MessageBox.Show("Setting form field items has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The AddListFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The AddStandardFont() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The file can't be created.", caption);
gdpicturePDF.Dispose();
Example
How to populate a newly created list box form field with required text items together with their export values.
Dim caption As String = "Example: AddFormFieldItem"
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF()
If (gdpicturePDF.NewPDF() = GdPictureStatus.OK) AndAlso
(gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) = GdPictureStatus.OK) Then
gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter)
'Please always select the required page before adding a form field.
If gdpicturePDF.SelectPage(1) = GdPictureStatus.OK Then
Dim fontResName As String = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontHelvetica)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
Dim formID As Integer = gdpicturePDF.AddListFormField(1, 1, 3, 4, "ListBox1", fontResName, 20, Color.DarkBlue, False, True)
If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
Dim formType As PdfFormFieldType = gdpicturePDF.GetFormFieldType(formID)
If (gdpicturePDF.GetStat() = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldBorderColor(formID, Color.DarkBlue) = GdPictureStatus.OK) AndAlso
(gdpicturePDF.SetFormFieldMultiSelect(formID, True) = GdPictureStatus.OK) Then
If (gdpicturePDF.AddFormFieldItem(formID, "English", "ENG") = GdPictureStatus.OK) AndAlso
(gdpicturePDF.AddFormFieldItem(formID, "German", "GER") = GdPictureStatus.OK) AndAlso
(gdpicturePDF.AddFormFieldItem(formID, "French", "FRA") = GdPictureStatus.OK) AndAlso
(gdpicturePDF.AddFormFieldItem(formID, "Slovak", "SVK") = GdPictureStatus.OK) Then
Dim message As String = "The list box form field has been created." + vbCrLf + "Type: " + formType.ToString() + " ID: " + formID.ToString()
If gdpicturePDF.SaveToFile("ListBox_ExportValue.pdf") = GdPictureStatus.OK Then
message = message + vbCrLf + "The file has been saved successfully."
Else
message = message + vbCrLf + "The file can't be saved. Status: " + gdpicturePDF.GetStat().ToString()
End If
MessageBox.Show(message, caption)
Else
MessageBox.Show("Setting form field items has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("The AddListFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("The AddStandardFont() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
Else
MessageBox.Show("The file can't be created.", caption)
End If
gdpicturePDF.Dispose()
string caption = "Example: AddFormFieldItem";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if ((gdpicturePDF.NewPDF() == GdPictureStatus.OK) &&
(gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeA4) == GdPictureStatus.OK))
{
gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter);
//Please always select the required page before adding a form field.
if (gdpicturePDF.SelectPage(1) == GdPictureStatus.OK)
{
string fontResName = gdpicturePDF.AddStandardFont(PdfStandardFont.PdfStandardFontHelvetica);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
int formID = gdpicturePDF.AddListFormField(1, 1, 3, 4, "ListBox1", fontResName, 20, Color.DarkBlue, false, true);
if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
{
PdfFormFieldType formType = gdpicturePDF.GetFormFieldType(formID);
if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldBackgroundColor(formID, Color.Bisque) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldBorderColor(formID, Color.DarkBlue) == GdPictureStatus.OK) &&
(gdpicturePDF.SetFormFieldMultiSelect(formID, true) == GdPictureStatus.OK))
{
if ((gdpicturePDF.AddFormFieldItem(formID, "English", "ENG") == GdPictureStatus.OK) &&
(gdpicturePDF.AddFormFieldItem(formID, "German", "GER") == GdPictureStatus.OK) &&
(gdpicturePDF.AddFormFieldItem(formID, "French", "FRA") == GdPictureStatus.OK) &&
(gdpicturePDF.AddFormFieldItem(formID, "Slovak", "SVK") == GdPictureStatus.OK))
{
string message = "The list box form field has been created.\n" + "Type: " + formType.ToString() + " ID: " + formID.ToString();
if (gdpicturePDF.SaveToFile("ListBox_ExportValue.pdf") == GdPictureStatus.OK)
message = message + "\nThe file has been saved successfully.";
else
message = message + "\nThe file can't be saved. Status: " + gdpicturePDF.GetStat().ToString();
MessageBox.Show(message, caption);
}
else
MessageBox.Show("Setting form field items has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("Setting form field properties has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The AddListFormField() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The AddStandardFont() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The SelectPage() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
}
else
MessageBox.Show("The file can't be created.", caption);
gdpicturePDF.Dispose();
See Also
Reference
GdPicturePDF Class
GdPicturePDF Members
Overload List
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
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldType Method
GetFormFieldItemCount Method
DeleteFormFieldItem Method
RemoveFormField Method