Description of location functions
The Column function
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | Column(MatrixCode, ColumnNumber) |
| Parameters | - MatrixCode Matrix code written between inverted commas - ColumnNumber Column number of the matrix |
| Value returned | Column "ColumnNumber" of the matrix with code "MatrixCode" |
Example
column("MATRIX 1", 10).$Entity.code
Returns the code of the entity present in column 10 of "MATRIX1"
The Matrix function
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | Matrix(MatrixCode) |
| Parameters | - MatrixCode Matrix code written between inverted commas |
| Value returned | Reference to the matrix filters of the matrix with code "MatrixCode" |
Example
matrix("MATRIX 2").$Entity.code
Returns the code of the entity present in the matrix filters of the matrix with code "MATRIX 2".
The Parameter function
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | Parameter(ParameterCode) |
| Parameters | - ParameterCode Parameter code written between inverted commas |
| Value returned | Reference to the parametric filter with code "ParameterCode" |
Example
parameter("S01").$Scenario.code
Returns the code of the scenario associated with the parametric filter with code "S01".
The ParameterValue function
| Element | Description |
|---|---|
| Availability | From 3.1012 |
| Syntax | ParameterValue |
| Value returned | The value of a parameter |
Example
parameter("PP").parameterValue
Returns the value of parameter "PP".
The PositionIndex function
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | PositionIndex |
| Value returned | Current sheet for cell fields, queries, data processing or deployment. Current row or column for conditional formatting expressions |
Example
positionIndex.$Scenario.code
Returns the code of the scenario associated with the sheet, e.g. when the scenario is inserted as a tab filter.
The PrintFilters function
| Element | Description |
|---|---|
| Availability | From 4.2.1 |
| Syntax | printFilters([Position],[cellField 1],[cellField 2],...,[cellField N]) |
| Parameters | - Position (optional) Reference to a position via location function - cellField1,...,cellField N (optional) List of field attributes for every filter, must be written between inverted commas |
| Value returned | String obtained by concatenating the field attributes. The separator between two fields of a filter is "-" (dash between two spaces) and the separator between two filters is "," (comma followed by space) |
Examples
- Sheet(1).Printfilters
Returns the concatenation between code and description of the filters of the first sheet.
- PrintFilters(row("MATRIX1", "5"),"code", "attribute1")
Returns the concatenation between code and attribute 1 of the filters on row 5 of MATRIX 1.
The Prompt function
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | Prompt |
| Value returned | Reference to dynamic global filters for the VBA client (also left compatible for the .NET client) |
Example
prompt.$Scenario.code
Returns the code of the scenario associated with the dynamic global filters.
The ReportFilters function
| Element | Description |
|---|---|
| Availability | From 3.1006 |
| Syntax | reportFilters |
| Value returned | Reference to the form filters for .NET Client Reporting. |
Example
reportFilters.$Scenario.code
Returns the code of the scenario associated with the form filters.
The Row function
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | Row(MatrixCode, RowNumber) |
| Parameters | - MatrixCode Matrix code between inverted commas - RowNumber Matrix row number |
| Value returned | Row "RowNumber" of the matrix with code "MatrixCode" |
Example
row("MATRIX 1", 10).$Entity.code
Returns the entity code of row 10 of the matrix with code "MATRIX1".
The Sheet function
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Syntax | Sheet |
| Parameters | sheet Sheet number between inverted commas |
| Value returned | Reference to the "sheet" sheet |
Example
Sheet("13").$Scenario.code
Returns the scenario code read from sheet 13.