Cascade Sheet Info Properties

The following properties are available on CascadeSheetInfo objects, which appear as expandable sub-properties of the objects that use them.

Information

Property Type Default Description

Caption
displayed as Name

string

The cascade sheet configuration name, which is used to uniquely identify the instance in the CascadeSheetConfig Editor.

Summary Sheet

Property Type Default Description

SummarySheetAdd

bool

false

Controls whether a cascade summary sheet is added to the view.

If a summary sheet is added, [T.SummarySheetsList] and [T.SummarySheetsRange] will be added to the view’s tokens.

SummarySheetIncludeSheetAddress

string

Specifies an address of a boolean value to examine on each cascade sheet to determine if the sheet should be included in the summary.

SummarySheetIsSummarySheetAddress

string

Specifies an cell address where a value of TRUE will be put on the summary sheet.

SummarySheetName

string

Specifies the name to give to the Cascade Summary Sheet. The default is "Summary".

SummarySheetPosition

string

Last

Specifies the position for the cascade summary sheet.

The choices are "First" and "Last". The default is "Last".

SummarySheetSummaryRangeAddress

string

Specifies the address of the range to put the summary formulas into.

A summary formula is added for each numeric cell within the summary range. Cells that contain a formula and empty cells are ignored. Since the cascade sheets and the summary sheet are added before Essbase data is retrieved, numeric cells within the summary range must be set to a numeric value, such as 0, in the Excel template; otherwise, the cells are empty and are ignored.

Template Sheet

Property Type Default Description

CascadeSheetnamePattern
displayed as CascadeSheetNamePattern

string

Specifies the tokenized string used to build the name of each cascade sheet.

By default, the sheet name contains the text displayed for each selected item represented by the sheet delimited by a dash. For example, if the cascade sources are the Essbase selectors for Product, Market, and Scenario, and the members represented by the sheet are Cola, New York, and Actual, the default sheet name is 'Cola - New York - Actual'.

The sheet name can be customized using tokens that represent various values associated with the item.

For an item that represents an Essbase member, the following tokens are available: A token that represents the selector item value, such as [T.Product]; a token that represents the member name [T.Member.n]; a token that represents the alias [T.Alias.n], and a token that represents the display text [T.DisplayText.n], which has the same value as the token that represents the selector item. This token is supported for consistency with non-Essbase items.

For an item that represents a generic, SQL, or date selector item, the following tokens are available: A token that represents the selector item value, such as [T.Employee]; and a token that represents the display text [T.DisplayText.n].

The 'n' is a 1-based number that reflects the position of the item within the list of cascade sources. For example, if the cascade sources are the selectors for Product, Market, and Scenario, the item that represents Product is 1; Market is 2; and Scenario is 3. To specify that the sheet names contain only the Product and Scenario member names delimited by a bar, the CascadeSheetnamePattern could be set to [T.Member.1] | [T.Member.3].

CascadeSheetNamePattern is only applicable when CascaseDoCascade is True.

Refer to CascaseDoCascade for an explanation of cascading.

CascadeTemplateSheetName

string

Specifies the name of the sheet in the Excel template that is used as the cascade template sheet.

CascadeTemplateSheetName is only applicable when CascadeTemplateSheetPolicy is SheetName and CascadeDoCascade is true.

Refer to CascaseDoCascade for an explanation of cascading.

CascadeTemplateSheetNumber

int

0

Specifies the 0-based index of the sheet in the Excel template that is used as the cascade template sheet.

CascadeTemplateSheetNumber is only applicable when CascadeTemplateSheetPolicy is SheetNumber and CascadeDoCascade is true.

Refer to CascaseDoCascade for an explanation of cascading.

CascadeTemplateSheetPolicy

CascadeTemplateSheetPolicy

CascadeTemplateSheetPolicy.SheetNumber

Specifies whether to use a sheet name or sheet number to identify the sheet in the Excel template that is used as the cascade template sheet.

CascadeTemplateSheetPolicy is only applicable when CascadeDoCascade is true.

Refer to CascaseDoCascade for an explanation of cascading.