Object properties
This table lists objects and their properties:
| Object | Property | Description |
|---|---|---|
| List, ListView | Text | Unique name of the displayed element. |
| List, ListView | Alias | Caption of the displayed element. |
| List, ListView | Attribute or Attribute 1 | The first attribute value. In a custom hierarchy, Attribute 1 returns the same value as the Name attribute. |
| List, ListView | Attribute 2 | The second attribute value. In a custom hierarchy, Attribute 2 returns the same value as the Description attribute. |
| List, ListView | Attribute 3 | The third attribute value. |
| List, ListView | List | .Name, to
return the name of a list. For example, specify Use with global lists, and in
combination with =reportobjects.listview1.list.name to return the name of the list
in ListView1. |
| List, ListView | ListResult | Use with global lists, and in combination.
Returns all members of a list and their member properties as an xml table. The xml contains element unique names such as keys and all the member properties of the list as properties. The order of elements in the xml may not correspond to the order of elements in the list. If there are multiple elements with the same unique name in the list, only one occurrences is in the xml. |
| List, Hyperblock,ListView | Set | The MDX expression that represents the list definition, including structure selection, filters and sorting. |
| List, Hyperblock,ListView | StructureSet | The MDX expression that represents the structure selection of the list. |
| Hyperblock | Text | Unique name of the first element displayed in the hyperblock. |
| Hyperblock | Alias | Caption of the first element displayed in the hyperblock. |
| Hyperblock | Attribute 1 | The first attribute of the first element displayed in the hyperblock. |
| Hyperblock | Attribute 2 | The second attribute of the first element displayed in the hyperblock. |
| Hyperblock | Attribute 3 | The third attribute of the first element displayed in the hyperblock. |
| Global Variables | Text | Current value of the variable. |
| Global Variables | GlobalText | Current value of the variable, read from the repository. |
| Global Variables | DefaultText | Variable values are set at user log-on. If there is no value for a user, the default value is used. If a variable is non-persistent, the value reverts to the default on log-out. |
| Report Variables | Text | Current value of the variable. |
| Report Variables | DefaultText | Variable values are set at user log-on. If there is no value for a user, the default value is used. If a variable is non-persistent, the value reverts to the default on log-out. |
This table shows the syntax to access the properties of different report objects:
| Object | Syntax |
|---|---|
| List |
GlobalLists.[list_name].[property_name]
|
| Global variable |
GlobalVariables.[variable_name].[property_name]
|
| Report variable |
ReportVariables.[variable_name].[property_name]
|
| ListViews (combo boxes, list boxes, option buttons) |
ReportObjects.[ListView_name].[property_name]
|
| Hyperblocks |
ReportObjects.[hyperblock_name].[property_name]
|
Good practice
Application Studio recognizes an object's type by its name and automatically includes the object type in formulas. Therefore the output of these two formulas is the same:
-
=[myvariable].text -
=ReportVariables.[myvariable].text
However, if there is a global variable of the same name as the report variable, Application Studio displays an error.
We recommend that you specify the object type explicitly.
You can access up to three attributes of an object. If an object has only one attribute you can refer to it as Attribute or Attribute1.
We recommend that you specify the attribute number.