Index...
Centrallix Documentation
|
report/parameter
parameter :: Defines a parameter that can be passed to a report
Metadata:
| type: | report/parameter |
| visual: | no |
| container: | no |
Overview:
A parameter defines a value that can be passed to a report, as well as various constraints and aspects of that value.
A default value can be specified, which will be used if the user does not supply a value when running the report.
A variety of constraint properties are also allowed, such as allowchars and badchars.
Usage:
The parameter object can only be used inside a system/report object.
Properties:
| Property | Type | Description |
|---|
| allowchars |
string |
The set of characters that are allowed. (e.g. allowchars="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"; ) |
| badchars |
string |
The set of characters that are explicitly not allowed. (e.g. badchars=" \"'/,;"; ) |
| default |
mixed |
If a parameter is not passed in, then the (optional) default value is assigned to the parameter (e.g. default = null, or 2745). |
| type |
string |
The data type of the parameter. Can be "integer", "string", "double", "datetime", or "money". |
Child Properties:
none currently available
Sample Code:
none currently available
Comments...
(none yet)
Add a Comment...
|
