WebFormField
Field Functions
| setDisplayValue | WebFormField.setDisplayValue( value ) | Sets a value for the form field using the appropriate display format for the field type and the language currently in use. |
| getDisplayValue | WebFormField.getDisplayValue( [formatted ] ) | Returns a String representing the displayable value of the form field,
optionally formatted for the user's locale. |
| getStringValue | WebFormField.getStringValue( ) | Returns a String value for the field that can be used to pass the value when calling another form, an Integration Service or opening a workflow job (see examples below). |
| getType | WebFormField.getType( ) | Returns the form field type. |
| setValue | WebFormField.setValue( value ) | Sets a value for the form field. |
| getValue | WebFormField.getValue( ) | Returns an Object representing the value of the form field. |
WebFormFieldOrColumn Functions
| isClientAccessible | WebFormField.isClientAccessible( ) | Returns true if the form field or table column is accessible via the client api, otherwise returns false. |
| createCustomList | WebFormField.createCustomList( [entries ] ) | Creates a list for the field and adds the passed entries. |
| getDisplayLength | WebFormField.getDisplayLength( ) | Returns the size of the input box used for the form field when it is editable. |
| getDisplayType | WebFormField.getDisplayType( ) | Returns the field's display type. |
| getHelpText | WebFormField.getHelpText( ) | Returns the help com.ebasetech.xi.api.Text for the form field for the current language. |
| getLabelText | WebFormField.getLabelText( ) | Returns the label com.ebasetech.xi.api.Text for the form field for the current language. |
| getList | WebFormField.getList( ) | Returns the list associated with the form field or null if no list exists. |
| getMaxDisplayLength | WebFormField.getMaxDisplayLength( ) | Returns the maximum number of characters that can be entered by the user for the form field. |
Element Functions
| getElementName | WebFormField.getElementName( ) | Returns the element name |
| getElementType | WebFormField.getElementType( ) | Returns the element type |
WebFormFieldinterface represents a form field in an interactive web form.Individual fields can be accessed via the Fields interface.