All Commands
All Reference
Commands
OBJ
Performs the specified query (if not already run) and returns information based on the result.
With the default method of 0 and a number (possibly 0) as the limit, this will return TRUE or FALSE depending on the data found.
It can also be used to manipulate the current row in the query and return information such as the number of rows resulting from the query.
e.g.
{OBJ(1234)} will return TRUE or FALSE depending on weather there is an object linked to the current object via relationship 1234 or not.
{OBJ(1234, 5678)} is the same as above except it will only return TRUE if the relationship links to object 5678.
{OBJ(1234, 5678, 8)} will display a checkbox allowing the user to set or delete relationship 1234 between the current object and object 5678.
{OBJ(1234:5678, QTY)} will return the number of rows resulting from the Query.
Number | Name | Default | Type | Description |
---|---|---|---|---|
1 | query | 0 | String | The Query to access the object |
2 | limit | 0 | String | The Limiting Object ID or OBJ Action |
3 | method | 0 | Integer | Boolean Rendering method |
4 | xml | String | XML Element Name | |
5 | xml_content | * | String | XML TRUE Content If Empty then any value will result in true. An * Evaluates the value as a boolean expression. If checking a potential list of values, surround the value in square brackets to ensure that it exists as a whole. |
6 | default | String | XML Default Content | |
- | page_num | 0 | Integer | Page Number required |
- | page_size | 20 | Integer | The size of the Page to return |
- | title | String | Element Title If you set this to AUTO then it will adopt the text of the linked object. |
|
- | text | String | Display Text for Checkbox If you set this to AUTO then it will adopt the text of the linked object. |
|
- | tot_id | 0 | Integer | The ID of the Total that you want to link the True/False state to. If this is to be rendered as a checkbox then the total will change live when the checkbox is checked, provided the total is rendered with "dynamic" parameter set to TRUE. |
- | class | checkbox | String | This specifies the class to use when rendering the result as a checkbox. If you start the class with "btn " then buttons will be used instead of checkboxes. When using method 8 (checkbox), if you set the class to "heart" then a clickable heart will be displayed instead of a checkbox. |