A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: GdPicturePDF.AddListFormField, GdPicturePDF.GetFormFieldId or GdPicturePDF.GetFormFieldChildID.
A string separator, that is used to delimit names of the currently selected items of the list box in the resulting value. This parameter is meaningful only for list boxes allowing multiple selections.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / GetFormFieldValue Method / GetFormFieldValue(Int32,String) Method

GetFormFieldValue(Int32,String) Method

In This Topic
Returns the current value of a required form field, here a list box, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. This method is intended to be used for list boxes, which allow multiple selections.

The returned value is the string composed from the names of the currently selected items in the required list box, where individual names are delimited with the specified parameter Separator.

Syntax
'Declaration

 


Public Overloads Function GetFormFieldValue( _

   ByVal FieldId As Integer, _

   ByVal Separator As String _

) As String
public string GetFormFieldValue( 

   int FieldId,

   string Separator

)
public function GetFormFieldValue( 

    FieldId: Integer;

    Separator: String

): String; 
public function GetFormFieldValue( 

   FieldId : int,

   Separator : String

) : String;
public: string* GetFormFieldValue( 

   int FieldId,

   string* Separator

) 
public:

String^ GetFormFieldValue( 

   int FieldId,

   String^ Separator

)

Parameters

FieldId
A unique form field identifier specifying a required form field object. You can obtain this identifier using these methods: GdPicturePDF.AddListFormField, GdPicturePDF.GetFormFieldId or GdPicturePDF.GetFormFieldChildID.
Separator
A string separator, that is used to delimit names of the currently selected items of the list box in the resulting value. This parameter is meaningful only for list boxes allowing multiple selections.

Return Value

A string representation of the current value of the specified form field. The GdPicturePDF.GetStat method can be subsequently used to determine if this method has been successful.
Remarks
This method is only allowed for use with non-encrypted documents.

It is recommend to use the GdPicturePDF.GetStat method to identify the specific reason for the method's failure, if any.

Just to remind you, that this method is only meaningful for list boxes that allow multiple selections, otherwise, the Separator parameter is not taking into account.

Example
How to use your own separator to delimit currently selected items in a list box with multiple selections allowed. 
Dim caption As String = "Example: GetFormFieldValue"

    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 title As String = "", value As String = "", message As String = ""

                Dim formID As Integer = 0

                Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown

                Dim multi 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.PdfFormFieldTypeList Then

                                title = gdpicturePDF.GetFormFieldTitle(formID)

                                If gdpicturePDF.GetStat() <> GdPictureStatus.OK Then

                                    MessageBox.Show("The GetFormFieldTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString())

                                    Exit For

                                End If

                                multi = gdpicturePDF.GetFormFieldMultiSelect(formID)

                                If gdpicturePDF.GetStat() <> GdPictureStatus.OK Then

                                    MessageBox.Show("The GetFormFieldMultiSelect() method has failed with the status: " + gdpicturePDF.GetStat().ToString())

                                    Exit For

                                End If

                                'If multiple selections are allowed, the default separator is used.

                                value = gdpicturePDF.GetFormFieldValue(formID)

                                If gdpicturePDF.GetStat() <> GdPictureStatus.OK Then

                                    MessageBox.Show("The GetFormFieldValue() method has failed with the status: " + gdpicturePDF.GetStat().ToString())

                                    Exit For

                                End If

                                message = message + title + ":" + vbCrLf + "    value: " + value

                                If multi Then

                                    'Using your preferred separator.

                                    value = gdpicturePDF.GetFormFieldValue(formID, ";")

                                    If gdpicturePDF.GetStat() <> GdPictureStatus.OK Then

                                        MessageBox.Show("The GetFormFieldValue() method has failed with the status: " + gdpicturePDF.GetStat().ToString())

                                        Exit For

                                    End If

                                    message = message + "    value: " + value + vbCrLf

                                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 MessageBox.Show(message, caption)

            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()

End Sub
string caption = "Example: GetFormFieldValue";

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

        {

            string title = "", value = "", message = "";

            int formID = 0;

            PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown;

            bool multi = 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.PdfFormFieldTypeList)

                        {

                            title = gdpicturePDF.GetFormFieldTitle(formID);

                            if (gdpicturePDF.GetStat() != GdPictureStatus.OK)

                            {

                                MessageBox.Show("The GetFormFieldTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString());

                                break;

                            }

                            multi = gdpicturePDF.GetFormFieldMultiSelect(formID);

                            if (gdpicturePDF.GetStat() != GdPictureStatus.OK)

                            {

                                MessageBox.Show("The GetFormFieldMultiSelect() method has failed with the status: " + gdpicturePDF.GetStat().ToString());

                                break;

                            }

                            //If multiple selections are allowed, the default separator is used.

                            value = gdpicturePDF.GetFormFieldValue(formID);

                            if (gdpicturePDF.GetStat() != GdPictureStatus.OK)

                            {

                                MessageBox.Show("The GetFormFieldValue() method has failed with the status: " + gdpicturePDF.GetStat().ToString());

                                break;

                            }

                            message = message + title + ":\n    value: " + value;

                            if (multi)

                            {

                                //Using your preferred separator.

                                value = gdpicturePDF.GetFormFieldValue(formID, ";");

                                if (gdpicturePDF.GetStat() != GdPictureStatus.OK)

                                {

                                    MessageBox.Show("The GetFormFieldValue() method has failed with the status: " + gdpicturePDF.GetStat().ToString());

                                    break;

                                }

                                message = message + "    value: " + value + "\n";

                            }

                        }

                    }

                    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)

                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. Status: " + gdpicturePDF.GetStat().ToString(), caption);

gdpicturePDF.Dispose();
Example
How to use your own separator to delimit currently selected items in a list box with multiple selections allowed. Dim caption As String = "Example: GetFormFieldValue" 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 title As String = "", value As String = "", message As String = "" Dim formID As Integer = 0 Dim type As PdfFormFieldType = PdfFormFieldType.PdfFormFieldTypeUnknown Dim multi 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.PdfFormFieldTypeList Then title = gdpicturePDF.GetFormFieldTitle(formID) If gdpicturePDF.GetStat() <> GdPictureStatus.OK Then MessageBox.Show("The GetFormFieldTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString()) Exit For End If multi = gdpicturePDF.GetFormFieldMultiSelect(formID) If gdpicturePDF.GetStat() <> GdPictureStatus.OK Then MessageBox.Show("The GetFormFieldMultiSelect() method has failed with the status: " + gdpicturePDF.GetStat().ToString()) Exit For End If 'If multiple selections are allowed, the default separator is used. value = gdpicturePDF.GetFormFieldValue(formID) If gdpicturePDF.GetStat() <> GdPictureStatus.OK Then MessageBox.Show("The GetFormFieldValue() method has failed with the status: " + gdpicturePDF.GetStat().ToString()) Exit For End If message = message + title + ":" + vbCrLf + " value: " + value If multi Then 'Using your preferred separator. value = gdpicturePDF.GetFormFieldValue(formID, ";") If gdpicturePDF.GetStat() <> GdPictureStatus.OK Then MessageBox.Show("The GetFormFieldValue() method has failed with the status: " + gdpicturePDF.GetStat().ToString()) Exit For End If message = message + " value: " + value + vbCrLf 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 MessageBox.Show(message, caption) 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() End Sub string caption = "Example: GetFormFieldValue"; 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 { string title = "", value = "", message = ""; int formID = 0; PdfFormFieldType type = PdfFormFieldType.PdfFormFieldTypeUnknown; bool multi = 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.PdfFormFieldTypeList) { title = gdpicturePDF.GetFormFieldTitle(formID); if (gdpicturePDF.GetStat() != GdPictureStatus.OK) { MessageBox.Show("The GetFormFieldTitle() method has failed with the status: " + gdpicturePDF.GetStat().ToString()); break; } multi = gdpicturePDF.GetFormFieldMultiSelect(formID); if (gdpicturePDF.GetStat() != GdPictureStatus.OK) { MessageBox.Show("The GetFormFieldMultiSelect() method has failed with the status: " + gdpicturePDF.GetStat().ToString()); break; } //If multiple selections are allowed, the default separator is used. value = gdpicturePDF.GetFormFieldValue(formID); if (gdpicturePDF.GetStat() != GdPictureStatus.OK) { MessageBox.Show("The GetFormFieldValue() method has failed with the status: " + gdpicturePDF.GetStat().ToString()); break; } message = message + title + ":\n value: " + value; if (multi) { //Using your preferred separator. value = gdpicturePDF.GetFormFieldValue(formID, ";"); if (gdpicturePDF.GetStat() != GdPictureStatus.OK) { MessageBox.Show("The GetFormFieldValue() method has failed with the status: " + gdpicturePDF.GetStat().ToString()); break; } message = message + " value: " + value + "\n"; } } } 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) 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. Status: " + gdpicturePDF.GetStat().ToString(), caption); gdpicturePDF.Dispose();
See Also

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
AddListFormField(Single,Single,Single,Single,String,String,Single,Byte,Byte,Byte,Boolean,Boolean) Method
GetFormFieldId Method
GetFormFieldChildID Method
GetStat Method
GetStat Method
SetFormFieldValue(Int32,String) Method
GetFormFieldDefaultValue Method
GetFormFieldsCount Method
GetFormFieldId Method
GetFormFieldChildID Method
GetFormFieldType Method
AddListFormField(Single,Single,Single,Single,String,String,Single,Byte,Byte,Byte,Boolean,Boolean) Method
SetFormFieldMultiSelect Method