List

In spreadsheet and list formulas, you can use the List property to reference properties of report objects.

You can also use the List property on the Data Area tab of the Client List Designer to filter the output of client lists.

Example: properties of report objects

These formulas return the unique name of the first element of a list displayed in a report object:

=ReportObjects.[report_object_name].List.Text

=ReportObjects.[report_object_name].Text

These formulas return the caption of the first element of a list displayed in a report object:

=ReportObjects.[report_object_name].List.Alias

=ReportObjects.[report_object_name].Alias

These properties can also be used with .Listg properties can be used with List: Attribute, Attributes 1-3, Set, StructureSet, ListResult, Name.

Example: List in the Client List Designer

You can use the .List property to filter one client list displayed in a list view by a set of members of another list. This is typically used for zero suppression.

In this example two client lists, Region and Period, are in overlapping hyperblocks in cells D5 and C6. The shared data cell of the hyperblocks (D6) contains this formula:

=ROC("Best_Practices_Templates","ANALYSIS","[CHANNEL].[All Channels]","[MEASURE].[Gross Margin]","[POS].[All Pos]","[PRODUCT].[All Tires]",D5,C6,"[VALTYPE].[Variance]")

The figures returned by the formula are:
Jan 2011 Feb 2011 Mar 2011
Alabama 0 0 0
Alaska 0 8909 8624
Arizona 0 0 0
Arkansas 0 17160 1135

To suppress the rows which contain only zero values:

  1. Select the Region hyperblock and open the Client List Designer.
  2. Click the Data Area tab.
  3. Select Use data filter.

    The Data Area grid is populated.

  4. In the Elements column, click the browse button of the Period dimension.

    The Select Elements dialog is displayed.

  5. Click the Variables tab and expand Global lists.
  6. Double-click the Period list.

    The right-hand pane displays =GlobalLists.Period.Text

  7. Click OK.
  8. Select Suppress empty cells

    The Preview pane in the Client List Designer displays no results. This is because =GlobalLists.Period.Text returns only the first element of a list. In this example, the first element of the Period list (Jan 2011) contains only zero values - and they are suppressed.

  9. In the Select Elements dialog change .Text to .List: =GlobalLists.Period.List.

    The Preview pane displays Alaska and Arkansas and the report displays:

Jan 2011 Feb 2011 Mar 2011
Alaska 0 8909 8624
Arkansas 0 17160 1135
The .List property specifies that all elements of the selected list are used to filter the report values.
Parent topic: Examples