This table describe the mnemonics that control how a column is formatted.
Mnemonic |
Description |
Valid Values |
Comments |
---|---|---|---|
type= |
Defines how the column’s value is formatted. Note:
Icon and Foreign
Key columns. The source=
source mnemonic may be used to
indicate a column should be derived from an icon reference or a foreign
key (FK) reference. If you use either of these sources, the type= mnemonic is not relevant
as either an icon or a context menu / info string will appear in the
column.
|
STRING |
Columns of this type capture a string. This is the default value. |
DATE |
Columns of this type capture a date. |
||
TIME |
Columns of this type capture a time (in database format) and will be displayed using the user's display profile. |
||
DATE/TIME |
Columns of this type capture a date and time (in database format) and will be displayed using the user's display profile. |
||
MONEY |
Columns of this type capture a monetary field. This type of column may also reference the cur= mnemonic. If the cur mnemonic is not specified, the currency code on the installation record is used. |
||
NUMBER |
Columns of this type capture a numeric field. This type of column may also reference the dec= mnemonic. |
||
label= |
Defines the column's override label. The label appears in the column's heading and in the zone's drag and drop area. If this mnemonic is not defined, the system uses the column's default label. The source of a column's default label differs depending on the column's source. Note that some sources don't have a default value and omitting this mnemonic will result in a blank label. |
FIELD_NAME |
Enter a valid field name whose label should be used for the column label. This should always be the option used if multiple languages are needed. |
'text' |
Defines the text directly. |
||
cur= |
Defines the currency code applied when type=MONEY if the installation record’s currency should not be used. |
Cx |
This means currency code value is defined in an earlier column. For example, define C1 if column 1 defines the currency code. |
COLUMN_NAME |
This means the currency code was retrieved by the SELECT statement. The value should match the name defined in the SELECT clause. |
||
‘Currency Code’ |
This means the currency code is defined directly. For example ‘USD’. |
||
dec= |
Defines the number of decimal places when type=NUMBER. It is optional. If provided it should be an integer. If not provided, the number of decimals will default to the number of decimal places defined on the currency code specified on the installation record. |
nR |
Where n is the number of decimal places to show. Suffixing the number of decimal places with R means that the system should round up / down. Simply specifying n (without an R) means that decimal places should be truncated. For example, entering dec=4 will display 4 decimal places and truncate the remainder. Note:
Formatting only.
This mnemonic is only used for formatting, it does not impact the
precision used for subsequent calculations. For example, if
a column retrieved from the database contains 6 significant digits
and dec=0, the column
will be shown with no decimal places (truncated), however any references
to the column in subsequent will use 6 decimal places. For example,
if the column is referenced in a formula or set function, all 6 decimal
places will be used.
|
char= |
This mnemonic applies special character(s) to the column’s value. |
‘x[]x’ |
Where x references the literal value to display and [ ] defines the relative position of the characters (before or after the value). You need only include the [ ] if you want to position characters in front of the value. For example, char='%' will place a percent sign after the value. If you want to position the word ‘minutes’ before a value, enter char='minutes [ ]'. If you want to output a value like BUDGET $123.12 (YTD), enter char='BUDGET [ ] (YTD)'. |
suppress= |
This is used to indicate a column should not be displayed. A column would be suppressed if it's only defined for use by subsequent columns, for example, if there is a formula that derives a column using two other columns. In this scenario, the columns referenced in the formula can be suppressed. |
true |
|
false |
This is the default, meaning that you don’t need to indicate suppress=false at all to indicate that the field should be shown. |
||
suppressSearch= |
This is used to indicate a column should not be displayed when the zone is invoked in search mode only. |
true |
|
false |
This is the default, meaning that you don’t need to indicate suppressSearch=false at all to indicate that the field should be shown. |
||
suppressExport= |
This is used to indicate a column should not be downloaded to Excel. |
true |
|
false |
This is the default, meaning that you don’t need to indicate suppressExport=false at all to indicate that the field should be included in a download. |
||
width= |
This is used to override the width of a column (number of pixels). The default value is the maximum width of any cell in the column. |
n |
Where n is a number between 0 and 999. Note:
If there is no available breaking point in the data, the column will be longer than the specified number of pixels. The length of the column's label (which appears in the column's heading) may also make the width wider than specified. |
color= |
This is used to override the column’s text color. |
A valid HTML “named” color |
For example color=red or color=yellow. |
A valid RGB color model combination |
For example color=#FF0000 or color=#CCCCCC. Note that the # is required. |
||
bgcolor= |
This is used to override the column’s background color. |
A valid HTML “named” color |
Similar to the color= mnemonic. |
A valid RGB color model combination |
Similar to the color= mnemonic. |
||
order= |
Defines the column’s default sort order. |
ASC |
Indicates that the order is ascending. This is the default meaning that it is not necessary to indicate order=ASC. |
DESC |
Indicates that the order is descending. |
Copyright © 2007, 2016, Oracle and/or its affiliates. All rights reserved. Documentation build: 2.5.2016 10:21:45 [T1_1454696505000]