COLUMNFORMAT
- Last UpdatedMar 24, 2023
- 1 minute read
The column object defines the way in which a column of a table object is populated.
The formatting of a column should be separate from the column definition itself and be held within the report object used to extract data from a table object. This will allow the same table to have many different reports produced from it, without the need to regenerate the table.
Methods
|
Name |
Result |
Purpose |
|---|---|---|
|
ColumnFormat() |
Constructor (initializes all the object settings). |
|
|
Format(FORMAT) |
Sets the format of the column to the passed format. |
|
|
Format(DATEFORMAT) |
Sets the format of the column to the passed date format. |
|
|
FORMAT('STRING') |
Unsets the format of the column. |
|
|
Width (REAL) |
Sets the column width. |
|
|
Widest() |
Sets the maximum column width flag. Setting a specific width value automatically sets the flag to FALSE. Note: |
|
|
Indent(REAL, REAL) |
Sets left and right indents (that is, spaces) in the column. |
|
|
Format() |
FORMAT |
Returns the format for numeric values in a column. |
|
Width() |
REAL |
Returns the column width, strings greater than the column width are wrapped on to the next line, numeric values greater than the column width are output as a column of hashes. |
|
GetWidest() |
BOOLEAN |
Returns TRUE if "widest" is set. |
|
Justification() |
STRING |
Returns the column justification. |
|
LeftIndent() |
REAL |
Returns the left indent setting. |
|
RightIndent() |
REAL |
Returns the right indent setting. |