WebFormTableColumn

The WebFormTableColumn represents a table column in an interactive web form.

Individual table columns can be accessed via their parent table.

TableColumn Functions

getTable WebFormTableColumn.getTable( ) Returns the Table of which this column forms a part.

WebFormFieldOrColumn Functions

isClientAccessible WebFormTableColumn.isClientAccessible( ) Returns true if the form field or table column is accessible via the client api, otherwise returns false.
createCustomList WebFormTableColumn.createCustomList( [entries ] ) Creates a list for the field and adds the passed entries.
getDisplayLength WebFormTableColumn.getDisplayLength( ) Returns the size of the input box used for the form field when it is editable.
getDisplayType WebFormTableColumn.getDisplayType( ) Returns the field's display type.
getHelpText WebFormTableColumn.getHelpText( ) Returns the help com.ebasetech.xi.api.Text for the form field for the current language.
getLabelText WebFormTableColumn.getLabelText( ) Returns the label com.ebasetech.xi.api.Text for the form field for the current language.
getList WebFormTableColumn.getList( ) Returns the list associated with the form field or null if no list exists.
getMaxDisplayLength WebFormTableColumn.getMaxDisplayLength( ) Returns the maximum number of characters that can be entered by the user for the form field.

Field Functions

setDisplayValue WebFormTableColumn.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 WebFormTableColumn.getDisplayValue( [formatted ] ) Returns a String representing the displayable value of the form field, optionally formatted for the user's locale.
getStringValue WebFormTableColumn.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 WebFormTableColumn.getType( ) Returns the form field type.
setValue WebFormTableColumn.setValue( value ) Sets a value for the form field.
getValue WebFormTableColumn.getValue( ) Returns an Object representing the value of the form field.

Element Functions

getElementName WebFormTableColumn.getElementName( ) Returns the element name
getElementType WebFormTableColumn.getElementType( ) Returns the element type