DeleteFormFieldItem Method (GdPicturePDF)

In This Topic

Removes a required item from a 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. The item to remove is identified by its index, that simply represents its position in the item's list.

Please note that if the specified form field does not contain any items, this method will fail.

Syntax

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

'Declaration
 
Public Function DeleteFormFieldItem( _
   ByVal FieldId As Integer, _
   ByVal ItemIdx As Integer _
) As GdPictureStatus

public GdPictureStatus DeleteFormFieldItem( 
   int FieldId,
   int ItemIdx
)

public function DeleteFormFieldItem( 
    FieldId: Integer;
    ItemIdx: Integer
): GdPictureStatus;

public function DeleteFormFieldItem( 
   FieldId : int,
   ItemIdx : int
) : GdPictureStatus;

public: GdPictureStatus DeleteFormFieldItem( 
   int FieldId,
   int ItemIdx
)

public:
GdPictureStatus DeleteFormFieldItem( 
   int FieldId,
   int ItemIdx
)

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.
ItemIdx: The index of the required item to remove. It must be a value from 0 to GdPicturePDF.GetFormFieldItemCount-1.

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.

Remarks

This method is only allowed for use with non-encrypted documents.

Just to remind you, that this method is meaningful for the choice form fields, that means it is only enabled to remove items from combo boxes or list boxes. If the specified form field does not contain any items, this method will fail as well.

Example

How to delete the first item in the combo box field and add another one.

VB.NET
C#

Dim caption As String = "Example: DeleteFormFieldItem"
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: DeleteFormFieldItem";
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();

Reference

GdPicturePDF Class
GdPicturePDF Members
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
GetFormFieldItemCount Method
AddFormFieldItem(Int32,String) Method
RemoveFormField Method