getFormat (Client API reference)
Returns a string value that represents formatting options for the column.
Column types supported
All
Syntax
formContext.getAttribute(arg).getFormat()
Return Value
This method will return one of the following string values or "null":
- date
- datetime
- duration
- language
- none
- phone
- text
- textarea
- tickersymbol
- timezone
- url
Note
This format information generally represents the format options of the application column. Format options for Boolean columns are not provided.
The following table lists the format string values to expect for each type of column type and format option.
| Application column Type | Format Option | Column Type | Format Value |
|---|---|---|---|
| Date and Time | Date Only | datetime | date |
| Date and Time | Date and Time | datetime | datetime |
| Whole Number | Duration | integer | duration |
| Single Line of Text | string | ||
| Whole Number | Language | choice | language |
| Whole Number | None | integer | none |
| Single Line of Text | Text Area | string | textarea |
| Single Line of Text | Text | string | text |
| Single Line of Text | Ticker Symbol | string | tickersymbol |
| Single Line of Text | Phone | string | phone |
| Whole Number | Time Zone | choice | timezone |
| Single Line of Text | Url | string | url |