Adds, modifies, or removes a selector configuration before the view is displayed. This method should be called from either the AfterConstruct or BeforeInitializeUI event link.
| Overload Name | Description |
|---|---|
| Add | Adds or modifies a Generic, SQL, or Date selector configuration. |
| AddEssbase | Adds or modifies an Essbase selector configuration. |
| Remove | Removes an existing selector configuration. |
| ResetAllEssbase (8.1) | Modifies the connection settings for all Essbase selectors. |
Adds or modifies a Generic, SQL, or Date selector configuration.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SelectorID | (Required) The ID of the Selector to be added to, modified, or removed from the view's selector configuration. |
| Required |
Controls whether a selection is required. If required, the view is not buildable until the selector has a selection. By default, the argument value is TRUE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SelectionPolicy |
Controls whether the user is allowed to select multiple items or only a single item. By default, the argument value is SingleItem.
Specify one of the following values or an arbitrary value:
<blank>SingleItemMultipleItems
|
| Caption | (Optional) A caption that overrides the default caption defined for the selector. |
| SelectorListID | (Optional) The ID of the Selector List assigned to the selector. If no selector list ID is specified, the selector's default selector list is used. |
| LastUsedItemContext |
Controls the caching of the item(s) selected when the view is built or refreshed. The cache is used to determine the default selected item(s) for a selector with selector list configured with a DefaultSelectionPolicy of LastUsedItem. By default, the argument is Default. Default - Uses the view's SelectorLastUsedItemContext setting. None - The last used item(s) are not cached. BySelector - The cache is shared by all views configured with the BySelector context. ByView - The cache is used only by the view for which the selector is configured. ByLabel - The cache is shared by all views configured with the ByLabel context and assigned the same LastUsedItemContextLabel.
Specify one of the following values or an arbitrary value:
<blank>DefaultNoneBySelectorByViewByLabel
|
| LastUsedItemContextLabel | The context label used when the LastUsedItemContext argument is ByLabel. |
| ToolbarKey |
(Optional) Specifies the key of the toolbar to which the selector is added. By default, the selector is added to the toolbar assigned the key "View", which is typically the view's main toolbar. |
Adds or modifies an Essbase selector configuration.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SelectorID | (Required) The ID of the Selector to be added to, modified, or removed from the view's selector configuration. |
| Required |
Controls whether a selection is required. If required, the view is not buildable until the selector has a selection. By default, the argument value is TRUE.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SelectionPolicy |
Controls whether the user is allowed to select multiple items or only a single item. By default, the argument value is SingleItem.
Specify one of the following values or an arbitrary value:
<blank>SingleItemMultipleItems
|
| Caption | (Optional) A caption that overrides the default caption defined for the selector. |
| SelectorListID | (Optional) The ID of the Selector List assigned to the selector. If no selector list ID is specified, the selector's default selector list is used. |
| LastUsedItemContext |
Controls the caching of the item(s) selected when the view is built or refreshed. The cache is used to determine the default selected item(s) for a selector with selector list configured with a DefaultSelectionPolicy of LastUsedItem. By default, the argument is Default. Default - Uses the view's SelectorLastUsedItemContext setting. None - The last used item(s) are not cached. BySelector - The cache is shared by all views configured with the BySelector context. ByView - The cache is used only by the view for which the selector is configured. ByLabel - The cache is shared by all views configured with the ByLabel context and assigned the same LastUsedItemContextLabel.
Specify one of the following values or an arbitrary value:
<blank>DefaultNoneBySelectorByViewByLabel
|
| LastUsedItemContextLabel | The context label used when the LastUsedItemContext argument is ByLabel. |
| ToolbarKey |
(Optional) Specifies the key of the toolbar to which the selector is added. By default, the selector is added to the toolbar assigned the key "View", which is typically the view's main toolbar. |
| ConnectionPolicy |
Controls whether the view's Essbase connection or a specified Essbase connection is used for the selector. If set to UseSpecifiedConnection, the EssbaseConnectionID argument must be specified. For a non-Essbase view, the connection policy should be set to UseSpecifiedConnection. By default, the argument is UseViewConnection.
Specify one of the following values or an arbitrary value:
<blank>UseViewConnectionUseSpecifiedConnection
|
| ConnectionID | If the ConnectionPolicy is UseSpecifiedConnection, indicates the Essbase connection ID. |
| EssbaseLoginServiceObjectTypeID | If the ConnectionPolicy is UseSpecifiedConnection, the name of the IEssbaseLoginService to use to prompt for Essbase credentials. |
| UseAliases |
If the ConnectionPolicy is UseSpecifiedConnection, controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. By default, the value is False.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AliasTableName |
If the ConnectionPolicy is UseSpecifiedConnection, indicates the name of the alias table used for the selector. If not specified, the Default alias table is used. |
Removes an existing selector configuration.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SelectorID | (Required) The ID of the Selector to be added to, modified, or removed from the view's selector configuration. |
Modifies the connection settings for all Essbase selectors.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ConnectionPolicy |
Controls whether the view's Essbase connection or a specified Essbase connection is used for the selector. If set to UseSpecifiedConnection, the EssbaseConnectionID argument must be specified. For a non-Essbase view, the connection policy should be set to UseSpecifiedConnection. By default, the argument is UseViewConnection.
Specify one of the following values or an arbitrary value:
<blank>UseViewConnectionUseSpecifiedConnection
|
| ConnectionID | If the ConnectionPolicy is UseSpecifiedConnection, indicates the Essbase connection ID. |
| EssbaseLoginServiceObjectTypeID | If the ConnectionPolicy is UseSpecifiedConnection, the name of the IEssbaseLoginService to use to prompt for Essbase credentials. |
| UseAliases |
If the ConnectionPolicy is UseSpecifiedConnection, controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases. By default, the value is False.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AliasTableName |
If the ConnectionPolicy is UseSpecifiedConnection, indicates the name of the alias table used for the selector. If not specified, the Default alias table is used. |