GetFormFieldAllowedValuesByName Method

 Top  Previous  Next

The GetFormFieldAllowedValuesByName method specifies the name of the values that are allowed in the form field.

 

 

 

Syntax

 

 

[VC++]

VARIANT GetFormFieldAllowedValuesByName(LPCTSTR FieldName);

 

[CS]

public abstract new Object GetFormFieldAllowedValuesByName ( String FieldName )

 

[VB]

Function GetFormFieldAllowedValuesByName(FieldName As String) As IStrings

 

 

 

Parameters

 

 

FieldName

[in] Specifies the name 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 FieldName does not exist, an EFieldNotFound exception is raised.

 

 

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