GetFormFieldAllowedValuesByIndex Method

 Top  Previous  Next

The GetFormFieldAllowedValuesbyIndex method specifies the values that are allowed in the form field.

 

 

 

Syntax

 

 

[VC++]

VARIANT GetFormFieldAllowedValuesByIndex(long FieldNo);

 

[CS]

public abstract new Object GetFormFieldAllowedValuesByIndex ( Int32 FieldNo )

 

[VB]

Function GetFormFieldAllowedValuesByIndex(FieldNo As Long) As IStrings

 

 

 

Parameters

 

 

FieldNo

[in] Specifies index of the form field in the PDF Document for which allowed values needs to be retrieved.

 

 

 

Return Value

 

 

An Instance of CStrings contains the list of allowed values. The allowed values can be accessed using the methods of CStrings class.

 

 

 

Remarks

 

 

This is not applicable for text fields. Text fields can take any string as a value.

 

 

 

Exceptions Raised

 

 

If the field, specified by FieldNo does not exist, an EFieldNotFound exception is raised.

 

 

ENoAcroFields exception is raised if the document does not contain any AcroForm Fields.