All Commands All Reference Commands
OBJ_DATA
This command is probably one of the most used and versatile in the language.
It is essentially used to retrieve data from an object but it can do a lot more.
It's most common use might be something like {OBJ_DATA(0, 1)} which is requesting part 1 (the object title) from the current object. {OBJ_DATA(0, 2)} would therefore be requesting part 2 from the current object. See this help page for the other part numbers you can use in this command.
XML data is held in part 3 of an object (the text area). So to retrieve the XML value for the tag "first_name", you would use the code {OBJ_DATA(0, 3, first_name)}. This can also be abbreviated to {OBJ_DATA(0, first_name)}.
| Number | Name | Default | Type | Description |
|---|---|---|---|---|
| 1 | query | 0 | String | A UDB Query pointing to the required Object. |
| 2 | obj_part | 1 | Integer | The Part Number of the object you want to retrieve data from or 99 to return the BASIC_DISP. There are also a number of other more advanced options that can be achieved with this parameter. |
| 3 | tag | String | The tag name of the XML element you want to retrieve. Only relevant to part 3. | |
| 4 | default | String | This is the default value to be returned if the referenced Object does not exist and you are using parts 1 or 2 or an XML field, or if the Object does exist and the XML element is not set. | |
| - | style | String | A style to apply to the element | |
| - | title | String | Title to add to returned element | |
| - | media_group | String | media group name | |
| - | total | 0 | Integer | Total number |
| - | class | String | The class to apply to the element | |
| - | edit_opt | SMALL | String | Space separated list of Edit options to pass to the input field when using +800 or +900 on the part number. Options include SMALL, LARGE, READONLY, NOLINK, NOFOCUS, NOEDIT, DIALOG, INLINE, TICKBUT, RELEXP(), WRAP |
| - | ap1 | String | Additional Parameters 1 - 4 to pass to the query | |
| - | media_param | String | Any additional parameters to pass to the Youtube iFrame. e.g. autoplay=1 See https://developers.google.com/youtube/player_parameters for a full list of parameters. |
|
| - | page_num | 0 | Integer | Specifies the page number of the query result. |
| - | page_size | 0 | Integer | The number of records per page for the query output. |
| - | inner_class | String | The class to apply to the inner element. Only relevant if you have something like a link surrounding an image. e.g. obj_part = 432. |
|
| - | inner_style | String | The style to apply to the inner element. Only relevant if you have something like a link surrounding an image. e.g. obj_part = 432. |