Excel Essbase View Properties

The text that appears on the view tab or title bar after the view builds or refreshes. If no value is specified, the CaptionBeforeBuild value is used. If no CaptionBeforeBuild value is specified, the view name is used.

The value can be tokenized, which allows the caption to reflect the current context. For example, if the view has selectors and the CaptionAfterBuild contains a token for each of the selectors, the caption after the view is built or refreshed reflects the selections represented by the view data.

See also: CaptionBeforeBuild

The text that appears on the view tab or title bar when the view is opened and before the view builds for the first time. If no value is specified, the view name is used as the caption.

The value can be tokenized.

See also: CaptionAfterBuild

Configures the auto-complete ranges.

Each AutoComplete Range defines the range of cells for which the configuration applies as well as the source from which (and when) the list of available cell values is generated along with various aspects of the presentation and behavior.

true

Controls whether the user is allowed to copy and cut from the view to the clipboard using the Ctrl+C and Ctrl+X keys, respectively, or using the Copy and Cut tools.

When content is copied (or cut) from the view and then pasted into an Excel spreadsheet, any hidden rows and/or columns within the copied range are automatically unhidden in Excel.

true

Controls whether the Find and Replace dialog can be launched from the WorkbookView grid control.

The Find and Replace dialog is launched using the F5 + Shift, Ctrl + F, or Ctrl + H keys.

false

Controls whether only a single instance of the view can be opened by the user from the view selector. When the setting is True, only a single instance is allowed. When the user attempts to open another instance of the view from the view selector, the existing view’s window is activated.

true

Controls whether the user is allowed to paste into the grid control using the Ctrl+V or the Shift+Insert keys, or using the Paste tool.

false

Controls whether the view can be saved by a user. If true, the Save View As and Save View button tools are enabled.

false

Controls whether a saved view can be shared by the owner.

AllowSharing is only applicable when AllowSave is true.

See also: AllowSave

false

Controls whether the view automatically builds when opened.

If true, the view automatically builds, but only if the view is buildable. Whether or not the view is buildable is based on the view state. For instance, if a view has selectors and each selector has a selection, the view is buildable.

true

Controls whether calculation of Excel formulas is performed on a background thread, which can improve performance.

NonEssbaseDoubleClickPolicy.None

Controls what happens when the user double-clicks an non-Essbase cell with the left mouse button.

None — Nothing happens.

Retrieve — A Essbase retrieve operation is performed.

EnterEditMode - The cursor is displayed in the cell and allows the user to edit the value.

In a Universal Excel view, when multiple Essbase universal ranges exist on the same sheet, edit mode is entered only when all the universal ranges set the value as EnterEditMode. The None and Retrieve options can be specified for a given universal range independent of the option assigned to the other universal ranges.

PasteOption.All

Controls whether formulas, formats, and/or values are pasted into a worksheet when the Ctrl+V or the Shift+Insert keys are pressed to initiate the paste.

When the PastePolicy is None, no paste operation is performed.

false

Controls whether sheets that contain a retrieve range are persisted when the view is saved.

As a rule, when a sheet contains a retrieve range that represents content that has a static layout, the sheet should not be saved, because the layout is defined by the Excel template. However, when a sheet contains a retrieve range that represents a layout that can be changed by the user, such as when the AllowEssbaseOperationsOnRetrieveRange is true, the sheet should be persisted when the view is saved to ensure that the user’s layout is retained.

SaveSheetsContainingRetrieveRange is only applicable when AllowSave is True.

See also: AllowSave, AllowEssbaseOperationsOnRetrieveRange

Controls whether the worksheet zoom magnification percentages are restored when a view is rebuilt, when a view is opened and built, or not at all.

DoNotRestore - (Default) When a user changes the zoom magnfication percentages for any worksheet in a view, and then rebuilds or opens a new instance of the view, the magnification of the worksheets is the same as in the Excel template.

RestoreOnRebuild - When a view is rebuilt, the zoom magnification of each worksheet is restored to the percentage as set by the user before rebuilding the view.

RestoreOnOpenAndRebuild - As with the RestoreOnRebuild option, when a view is rebuilt, the zoom magnification of each worksheet is restored to the percentage as set by the user before rebuilding the view. And, when a new instance of the view is opened and built, the zoom magnification of the worksheets is set to the percentages of the worksheets in the instance of the view for which the percentages were most recently changed.

true

Controls whether operations that support it are executed asynchronously.

false

Controls whether multiple Essbase and SQL operations such as retrieves and sends will be performed concurrently.

EvenValuesTo24.Four

Controls the maximum number of concurrent Essbase and SQL operations allowed by this view.

true

Controls whether the Linked Objects Browser dialog appears when a user double-clicks the left mouse button in a data cell on a drillthrough sheet.

Refer to DataCellDoubleClickPolicy for an explanation of a drillthrough sheet.

See also: AllowedLROTypesOnDrillthroughSheet

false

Controls whether the user is allowed to update Essbase data by posting changes to the database with the data from the active drillthrough sheet.

Refer to DataCellDoubleClickPolicy for an explanation of a drillthrough sheet.

EssbaseViewBase.AllLROTypesMask

Controls the LRO (linked reporting object) types available in the Linked Objects Browser dialog for a drillthrough sheet.

Refer to DataCellDoubleClickPolicy for an explanation of a drillthrough sheet.

AllowedLROTypesOnDrillthroughSheet is only applicable when AllowLROsOnDrillthroughSheet is true.

See also: AllowLROsOnDrillthroughSheet

false

Controls whether the selectors are visible when a drillthrough sheet is the active sheet.

Refer to DataCellDoubleClickPolicy for an explanation of a drillthrough sheet.

See also: SelectorConfiguration

false

Controls whether the Essbase operations, including Zoom In, Zoom Out, Remove Only, Keep Only, and Pivot, can be performed by the user on the data that is contained within a retrieve range.

When a sheet contains a retrieve range that represents content that has a static layout, Essbase operations should not be allowed. However, when a sheet contains data on which the user can perform adhoc analysis, a retrieve range can be used to simply define the area within the sheet that contains the Essbase data. When Essbase operations are performed, the retrieve range is automatically adjusted based on the data.

The AllowPivot setting takes precedence when determining whether a pivot operation is allowed. For instance, when AllowEssbaseOperationsOnRetrieveRange is true and AllowPivot is false, then Zoom In, Zoom Out, Remove Only, and Keep Only are allowed, but Pivot is not allowed.

See also: AllowPivot

true

Controls whether the Linked Objects Browser dialog appears when a user double-clicks the left mouse button in a data cell.

For an Excel Essbase view or Essbase universal range, see also: DataCellDoubleClickPolicy

true

Controls whether the user is allowed to initiate an Essbase Pivot operation. If true, a pivot operation can be initiated by pressing the right mouse button in a member cell, and then holding and dragging the mouse to a destination cell. The Pivot button tool can also be used to pivot a member. The tool is enabled when the AllowPivot setting is true.

For an Excel Essbase view, pivoting is not allowed when the RetainOnRetrieval setting is true or when the active worksheet contains named retrieve ranges and AllowEssbaseOperationsOnRetrieveRange is false.

For an Essbase universal range, pivoting is not allowed when the RetainOnRetrieval setting is true or AllowEssbaseOperationsOnRetrieveRange is false.

false

Controls whether the user is allowed to update Essbase data by posting changes to the database. If true, the Send button tool is enabled.

For an Excel Essbase view, see also: SendPolicy For an Essbase universal range, see also: RetrieveAndSendPolicy

EssbaseViewBase.AllLROTypesMask

Controls the LRO (linked reporting object) types available in the Linked Objects Browser dialog.

See also: AllowLROs

For an Excel Essbase view or Essbase universal range, see also: DataCellDoubleClickPolicy

false

Controls whether named ranges are automatically added for the Essbase page, row, column, and data areas when any Essbase operation is performed that retrieves data. These operations include retrieve, pivot, zoom in, zoom out, remove only, and keep only.

The names of the ranges are Ess.PageHeaderRange, Ess.RowHeaderRange, Ess.ColumnHeaderRange, and Ess.DataRange.

For an Excel Essbase view that contains named retrieve ranges, such as Ess.Retrieve.Range.1, the sub-range names are given an extension to uniquely identify and associate the sub-ranges with the retrieve range. The extension is based on the retrieve range identifier. For example, if the named retrieve range is Ess.Retrieve.Range.1, the sub-range names are Ess.PageHeaderRange.1, Ess.RowHeaderRange.1, Ess.ColumnHeaderRange.1, and Ess.DataRange.1.

For an Essbase universal range, the sub-range names use the universal range’s SheetRangeName as the extension. For example, if the SheetRangeName is SampleBasic, the sub-range names are Ess.PageHeaderRange.SampleBasic, Ess.RowHeaderRange.SampleBasic, Ess.ColumnHeaderRange.SampleBasic, and Ess.DataRange.SampleBasic.

The named ranges can be used by the view’s workbook script to format the page, row, column, and/or data areas after an Essbase operation is performed.

EssbaseRetrievePolicy.ActiveSheet

Controls whether only the active sheet, or all sheets, or all named retrieve ranges are retrieved by an Essbase retrieve operation.

None — No data is retrieved.

ActiveSheet — Only the active sheet is retrieved. If the active sheet contains named retrieve ranges, all the ranges are retrieved. If the active sheet does not contain any ranges, the used range is retrieved.

AllSheets — All sheets are retrieved. For any given sheet, if the sheet contains named retrieve ranges, all the ranges are retrieved. If the sheet does not contain any ranges, the used range is retrieved.

RetrieveRanges — All named retrieve ranges are retrieved. For any given sheet, if the sheet does not contain any named retrieve ranges, the sheet is skipped.

A named retrieve range must begin with 'Ess.Retrieve.Range.' followed by an identifier, which can be any string.

EssbaseSendPolicy.ActiveSheet

Controls what data is updated by an Essbase Send operation.

ActiveSheet — Only the data from the active sheet are sent. If the active sheet contains named send ranges, the data from all the ranges are sent. If the active sheet does not contain any named send ranges, the data from the used range are sent.

AllSheets — The data from all sheets are sent. For any given sheet, if the sheet contains named send ranges, the data from all the ranges are sent. If the sheet does not contain any named send ranges, the data from the used range are sent.

SendRanges — The data from all named send ranges are sent. For any given sheet, if the sheet does not contain any named send ranges, the sheet is skipped.

false

Controls whether the view is cascaded when the view is built.

When the view is cascaded, the list of items represented by each cascade source is obtained. The Cartesian product of the lists is generated, and a copy of the cascade template sheet is created for each ordered combination of items. The cascade template sheet is then deleted.

Typically, the RetrievePolicy should be set to either AllSheets, if the cascade template sheet does not contain a named retrieve range(s), or to RetrieveRanges, if the cascade template sheet does contain a named retrieve range(s).

This setting allows for configuring a single or multiple cascade sheets. When specified, the CascadeSheetConfig takes precedence over the view’s CascadeTemplateSheetNumber and CascadeSheetnamePattern settings, which have been deprecated.

31

Controls the maximum length of a cascade sheet name.

The default setting is 31, which is the maximum number of characters allowed by Excel for a sheet name.

CascadeSheetNameMaxLength is only applicable when CascadeDoCascade is true.

Refer to CascaseDoCascade for an explanation of cascading.

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.

Controls whether the view is cascaded when the view is built.

When the view is cascaded, the list of items represented by each cascade source is obtained. The Cartesian product of the lists is generated, and a copy of the cascade template sheet is created for each ordered combination of items. The cascade template sheet is then deleted.

CascadeSources is only applicable when CascaseDoCascade is True.

Refer to CascaseDoCascade for an explanation of cascading.

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

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

Refer to CascaseDoCascade for an explanation of cascading.

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 the CascadeTemplateSheetPolicy is SheetNumber and CascadeDoCascade is true.

Refer to CascaseDoCascade for an explanation of cascading.

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.

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.

See also: SummarySheetSummaryRangeAddress, SummarySheetName, SummarySheetPosition, SummarySheetIncludeSheetAddress.

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

See also: SummarySheetAdd.

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

See also: SummarySheetAdd.

Summary

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

See also: SummarySheetAdd.

Last

Specifies the position for the cascade summary sheet.

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

See also: SummarySheetAdd.

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.

See also: SummarySheetAdd.

Relates each chart control in the view user-interface to the retrieve range that contains the data represented by the chart.

false

Controls whether to allow the Comments Editor to be used to display and edit comments.

Controls the behavior of comments within each specified comment range.

Dodeca.Common.CommentsEditMode.Grid

Controls whether to use a Chat or Grid user-interface to display and edit comments.

true

Controls whether the comments are loaded when the view is built.

This setting is applied to all the comment ranges, and is typically only set to False for development/debugging purposes.

true

Controls whether to expose the Context pane in the Comments Editor.

Only applicable when EditMode is Grid.

true

Controls whether to enable the field-chooser in the Comments Editor.

Only applicable when EditMode is Grid.

true

Controls whether to expose the Links pane in the Comments Editor.

Only applicable when EditMode is Grid.

Worksheet Comments and Attachments

Specifies the caption used for the caption of the Comments Editor.

Edit worksheet comments and attachments.

Specifies the tooltip used for the caption of the Comments Editor

SelectorControlUIDisplayMode.DockedControl

Controls whether the Comments Editor is displayed in a docked pane or a modal dialog.

DockedControl: The comments editor is displayed in a dockable pane. The docked location is specified by the DockedControlLocation property.

LockedDockedControl: Same as a DockedControl, except that the user cannot move the Comments Editor to a different docked location.

ModalDialog: The comments editor is displayed in a modal dialog.

false

Controls whether the Comments Editor is automatically displayed when the view is built.

DockedControlLocation.Right

The initial docked location for dockable Comments Editor. The setting is only applicable when the CommentsExplorerDisplayMode is set to DockedControl or LockedDockedControl.

true

Controls whether to show the Context pane in the Comments Editor.

Only applicable when EditMode is Grid.

true

Controls whether to show the DateTime column in the Comments Editor.

Only applicable when EditMode is Grid.

true

Controls whether to show the LastDateTime column in the Comments Editor.

Only applicable when EditMode is Grid.

true

Controls whether to show the LastUserID column in the Comments Editor.

Only applicable when EditMode is Grid.

true

Controls whether to show the Links pane in the Comments Editor.

Only applicable when EditMode is Grid.

false

Controls whether to show the Subject column in the Comments Editor.

Only applicable when EditMode is Grid.

true

Controls whether to show the UserID column in the Comments Editor.

Only applicable when EditMode is Grid.

Worksheet Comments and Attachments

Specifies the caption used for the tab of the Comments Editor

Edit worksheet comments and attachments.

Specifies the tooltip used for the tab of the Comments Editor

The collection of components that are added to the view upon initialization. Component configurations define properties for component plugins that interact with this view.

English (United States)

When the CulturePolicy is set to UseSpecifiedCulture, the CultureName setting specifies the name of the culture used by the view.

CulturePolicy.UseSpecifiedCulture

Controls whether the culture associated with the view is the culture specifed by the CultureName setting or is the culture of the client operating system. The culture determines the list separator used when Excel formulas are evaluated. It also determines the culture-specific formatting used for Essbase numeric data values. For instance, the decimal symbol for the English (Unitied States) culture is a period; whereas, the decimal symbol for the French (France) culture is a comma.

In Excel formulas that contain a function, the function arguments are separated by either a comma or a semicolon. The list separator that is defined by the regional settings associated with the culture is used as the function argument separator in Excel formulas.

Any Excel formulas entered into the grid control by the user or through a workbook script must use the culture’s list separator.

For an Excel Essbase view , the formulas that are in the Excel template are automatically converted to use the specified culture’s list separator as the function argument separator.

The Excel formulas used in workbook scripts must use the culture’s list separator as the argument separator explicitly. For example, if a workbook script uses the Address function, the row and column numbers must be separated by a comma when the CultureName is English (United States) and a semicolon when the CultureName is French (France).

Alternatively, the @SEP function can be used to create a workbook script that is culture-neutral. For example, =Address(ROW()@SEP()COL())

Controls whether the action defined by the DataCellDoubleClickPolicy is performed based on the level number, level name, member name, or UDA’s of the contributing members.

See also: DataCellDoubleClickPolicy

DataDoubleClickPolicy.None

Controls what happens when the user double-clicks an Essbase data cell with the left mouse button.

None - Nothing happens.

ShowLROsDialog - The Linked Objects Browser is displayed.

For an Excel Essbase view, if the policy is ShowLROsDialog and the AllowLROs setting is false, the dialog is displayed regardless of the AllowLROs setting.

See also: AllowedLROTypes

EnterEditMode - The cursor is displayed in the cell and allows the user to edit the value.

AddSheetForDrillthrough - A sheet is added that contains the members that intersect at the datapoint represented by the data cell. The user can perform ad hoc analysis on the drillthrough sheet.

See also: AllowLROsOnDrillthroughSheets, AllowedLROTypesOnDrillthroughSheets, AllowSendOnDrillthroughSheets, AllowUserEssbaseOptionsOnDrillthroughSheet, AutoFitColumnWidthOnDrillthroughSheet, GridContextMenuIdForDrillthroughSheet, GridLinesVisibleOnDrillthroughSheet, RowAndColumnHeadersVisibleOnDrillthroughSheet

OpenViewForDrillthrough - Opens the view specified by the DataDrillthroughViewID setting.

Controls the value assigned to the tokens that represent the datapoint’s context and that are passed to the target view. A rule defined for a given dimension controls whether the dimension’s datapoint member, members related to the datapoint member, or members returned by an MDX script are assigned to the dimension’s associated token. The rule can also specify the formatting used for each member, and the formatting can contain relational database string functions.

Indicates the base name used for a drillthrough sheet. A drillthrough sheet is added when the DataCellDoubleClickPolicy is AddSheetForDrillthrough and the user double-clicks a data cell with the left mouse button.

When a drillthrough sheet is added, the sheet name is constructed using the DataDrillthroughSheetName. If other drillthrough sheets exist, the name is appended with a number of the copy in parentheses. This is the same naming convention used by Excel when a sheet is copied.

The DataDrillthroughSheetName can be tokenized.

By default, the DataDrillthroughSheetName setting is empty. When the setting is empty, the name of a drillthrough sheet is a concatenated list (delimited by dashes) of the members that intersect at the data cell. For example, East - Actual - Qtr1 - Sales - Cola.

DataDrillthroughSheetName is only applicable when the DataCellDoubleClickPolicy is AddSheetForDrillthrough.

See also: DataDrillthroughSheetNameMaxLength, DataCellDoubleClickPolicy

31

Controls the maximum length of a drillthrough sheet name.

The default setting is 31, which is the maximum number of characters allowed by Excel for a sheet name. If you intend to allow the view to be saved to Excel, use the default setting.

To indicate that the length of the sheet name should not be restricted to a maximum number of characters, specify the value as 0.

DataDrillthroughSheetNameMaxLength is only applicable when the DataCellDoubleClickPolicy is AddSheetForDrillthrough.

See also: DataDrillthroughSheetName, DataCellDoubleClickPolicy

true

Controls whether the opened view becomes the active window when the DataCellDoubleClickPolicy is OpenViewForDrillthrough, and the user double-clicks a data cell with the left mouse button.

DataDrillthroughShowViewAsActiveWindow is only applicable when the DataCellDoubleClickPolicy is OpenViewForDrillthrough.

See also: DataCellDoubleClickPolicy, DataDrillthroughViewID

Indicates the ID of the view that is opened when the DataCellDoubleClickPolicy is OpenViewForDrillthrough and the user double-clicks a data cell with the left mouse button.

Every token that is defined by a selector for a dimension whose member contributes to the data cell is passed as a view token to the drillthrough view using the ViewTokens. Since the ViewTokens is used to set the default selections for the drillthrough view, both views can represent the same Essbase data, as appropriate.

DataDrillthroughViewID is only applicable when the DataCellDoubleClickPolicy is OpenViewForDrillthrough.

See also: DataCellDoubleClickPolicy

true

When the DataCellDoubleClickPolicy is OpenViewForDrillthrough, this setting controls whether the view is opened when an Essbase filter prevents the user from accessing the data cell.

If the setting is True, the view is not opened when the user has no access to the data cell. If the setting is False, the view is opened whether or not the user has access to the data cell.

See also: DataCellDoubleClickPolicy, DataDrillthroughViewID

The Essbase connection ID used to look up the connection metadata that defines the Essbase connection settings for the Essbase view or for the Essbase universal range.

The object type ID of the login service that obtains the credentials used to sign on to the Dodeca Essbase service.

false

Controls whether a user’s Essbase option settings are used instead of the Essbase option settings that are defined for this view, which are represented by the EssProperties settings.

When used in conjunction with the AllowedUserEssbaseOptions setting, you can also control which Essbase options a user is allowed to set.

See also: EssProperties, AllowedUserEssbaseOptions

Controls the Essbase options that a user is allowed to set.

When AllowUserEssbaseOptions is true, the AllowedUserEssbaseOptions setting can be used to restrict the options a user is able to set. AllowedUserEssbaseOptions controls which options are displayed on the Essbase Options dialog. Any option that cannot be set by the user is obtained from the view’s EssProperties settings.

See also: AllowUserEssbaseOptions, EssProperties

false

Controls whether the width of the columns is automatically set to the minimum width necessary to display the data.

Defines the option settings used for Essbase-related operations.

See also: AllowUserEssbaseOptions

false

Controls whether formulas within the retrieve range are retained when building or refreshing the view and during a retrieve operation.

EssbaseOptionsContextScope.Global

Controls the caching of the user’s Essbase Options settings. The cache is used to initialize the settings when a view is opened.

None — The user’s settings are not cached. When the view is opened, the settings are assigned a default value based on the EssProperties settings. Any changes made to the settings by the user are applied while the view is open, but are not cached.

Global — The user’s settings are shared by all views configured with a global context. Any changes made to the settings by the user are applied to the current view and to other views that are subsequently opened that are also configured with a UserEssbaseOptionsContext of Global.

ByView — The user’s settings only apply to instances of this view. When the view is opened, the settings are initialized to the settings most recently used by an instance of this view.

ByLabel — The user’s settings are shared by all views configured with a ByLabel context and assigned the same label as this view. Any changes made to the settings by the user are applied to the current view and to other views that are subsequently opened that are also configured with a UserEssbaseOptionsContext of ByLabel with the same UserEssbaseOptionsContextLabel.

UserEssbaseOptionsContext is only applicable when AllowUserEssbaseOptions is true.

See also: AllowUserEssbaseOptions, UserEssbaseOptionsContextLabel

The context label used when the UserEssbaseOptionsContextLabel is set to ByLabel. Views that are assigned the same label share the user’s Essbase Options settings.

See also: UserEssbaseOptionsContext

true

Controls whether a user’s Essbase option settings are used instead of the Essbase option settings that are defined for this view on drillthrough sheets, which are represented by the EssPropertiesForDrillthroughSheet settings.

When used in conjunction with the AllowedUserEssbaseOptionsOnDrillthroughSheet setting, you can also control which Essbase options a user is allowed to set.

See also: EssPropertiesForDrillthroughSheet, AllowedUserEssbaseOptionsOnDrillthroughSheet

Controls the Essbase options that a user is allowed to set for drillthrough sheets.

When AllowUserEssbaseOptionsOnDrillthroughSheet is true, the AllowedUserEssbaseOptionsOnDrillthroughSheet setting can be used to restrict the options a user is able to set for drillthrough sheets. AllowedUserEssbaseOptionsOnDrillthroughSheet controls which options are displayed on the Essbase Options dialog when the active sheet is a drillthrough sheet. Any option that cannot be set by the user is obtained from the view’s EssPropertiesForDrillthroughSheet settings.

See also: AllowUserEssbaseOptionsOnDrillthroughSheet, EssPropertiesForDrillthroughSheet

true

Controls whether the width of the columns on a drillthrough sheet is automatically set to the minimum width necessary to display the data.

Refer to DataCellDoubleClickPolicy for an explanation of a drillthrough sheet.

Defines the option settings used for Essbase-related operations on a drillthrough sheet.

Refer to DataCellDoubleClickPolicy for an explanation of a drillthrough sheet.

See also: DataCellDoubleClickPolicy

EssbaseOptionsContextScope.Global

Controls the caching of the user’s Essbase Options settings for the view’s drillthrough sheets. The cache is used to initialize the settings when a view is opened.

None — The user’s settings are not cached. When the view is opened, the settings are assigned a default value based on the EssPropertiesForDrillthroughSheet settings. Any changes made to the settings by the user are applied while the view is open, but are not cached.

Global — The user’s settings are shared by all views configured with a global context. Any changes made to the settings by the user are applied to the current view and to other views that are subsequently opened that are also configured with a UserEssbaseOptionsContext or UserEssbaseOptionsContextForDrillthroughSheet of Global.

ByView — The user’s settings only apply to instances of this view. When the view is opened, the settings are initialized to the settings most recently used by an instance of this view.

ByLabel — The user’s settings are shared by all views configured with a ByLabel context and assigned the same label as this view. Any changes made to the settings by the user are applied to the current view and to other views that are subsequently opened that are also configured with a UserEssbaseOptionsContext or UserEssbaseOptionsContextForDrillthroughSheet of ByLabel with the same UserEssbaseOptionsContextLabel or UserEssbaseOptionsContextLabelForDrillthroughSheet.

UserEssbaseOptionsContextForDrillthroughSheet is only applicable when AllowUserEssbaseOptionsOnDrillthroughSheet is true.

See also: AllowUserEssbaseOptionsOnDrillthroughSheet, UserEssbaseOptionsContextLabelForDrillthroughSheet

The context label used when the UserEssbaseOptionsContextLabelForDrillthroughSheet is set to ByLabel. Views that are assigned the same label share the user’s Essbase Options settings.

See also: UserEssbaseOptionsContextForDrillthroughSheet

false

The ID and version number of the binary artifact that contains the Excel template.

When the user exports the view to Excel, each protected worksheet is password protected with the ExportToExcelProtectedWorksheetPassword value in order to prevent a user from unprotecting the worksheet in the Excel file.

In effect, The ExportToExcelProtectedWorksheetPassword, at the time the view is saved to Excel, is used as the password.

View Export Definitions

true

Controls whether the user is allowed to customize the auto-calculate functions that are displayed in the Status bar. When AutoCalculateAllowCustomize is True, the user can open the AutoCalculate menu by clicking the right mouse button in the Status bar.

true

Controls whether the auto-calculate function results are displayed in the Status bar and whether the AutoCalculate menu is displayed when the user clicks the right mouse button in the Status bar.

Controls which auto-calculate function results are displayed in the Status bar by default.

As in Excel, the auto-calculate feature provides a way to see the results of the following calculation functions as applied to the selected range of cells:

Average - Finds the average of the numerical values. Count - Counts the cells that contain a value. Numerical Count - Counts the cells that contain a numerical value. Min - Finds the smallest numerical value. Max - Finds the largest numerical value. Sum - Adds the numerical values.

DefaultableBooleanValue.Default

Controls whether the grid lines are visible or hidden for template and cascade sheets.

Default — The grid line visibility setting in the Excel template is used.

True — Grid lines are visible.

False — Grid lines are hidden.

true

Controls whether the grid lines are visible on a drillthrough sheet.

Refer to DataCellDoubleClickPolicy for an explanation of a drillthrough sheet.

See also: DataCellDoubleClickPolicy

DefaultableBooleanValue.Default

Controls whether the horizontal scroll bar is visible.

Default — The horizontal scroll bar option setting in the Excel template is used.

True — The horizontal scroll bar is visible.

False — The horizontal scroll bar is hidden.

DefaultableBooleanValue.Default

Controls whether the outline symbols are visible or hidden for template and cascade sheets.

Default — The outline symbols visibility setting in the Excel template is used.

True — For worksheets with an outline, the outline symbols are displayed.

False — Outline symbols are hidden.

DefaultableBooleanValue.Default

Controls whether the row and column headers are visible or hidden for template and cascade sheets.

Default — The row and column headers visibility setting in the Excel template is used.

True — Row and column headers are visible.

False — Row and column headers are hidden.

true

Controls whether the row and column headers are visible on a drillthrough sheet.

Refer to DataCellDoubleClickPolicy for an explanation of a drillthrough sheet.

See also: DataCellDoubleClickPolicy

The ratio of the width of the worksheet tabs to the width of the horizontal scrollbar as a number between zero and one.

For example, if set to .75, the width of the area for worksheet tabs is 75% and the width of the scroll bar area is 25% of the total width of the view window.

DefaultableBooleanValue.Default

Controls whether sheet tabs are visible or hidden.

Default — The sheet tabs visibility setting in the Excel template is used.

True — Sheet tabs are visible.

False — Sheet tabs are hidden.

See also: ExcelTemplateBinaryArtifact

DefaultableBooleanValue.Default

Controls whether the vertical scroll bar is visible.

Default — The vertical scroll bar option setting in the Excel template is used.

True — The vertical scroll bar is visible.

False — The vertical scroll bar is hidden.

Controls whether the action defined by the MemberCellDoubleClickPolicy is performed only for members that belong to a particular dimension or to any dimension. If one or more dimensions are specified, each selected member must belong to a specified dimension for the action to be performed.

For example, if the MemberCellDoubleClickPolicy is Zoom and the MemberCellDoubleClickAllowedDimensions is Product;Market, then a Zoom In or Zoom Out operation is performed only when the user double clicks a member (or members) that belongs to the Product or Market dimension.

By default, the value is empty, which indicates that the MemberCellDoubleClickPolicy is performed on members belonging to any dimension.

Both the MemberCellDoubleClickAllowedDimensions and MemberCellDoubleClickAllowedOrientations settings are used to control whether the action is performed when the user double clicks a member cell (or multiple member cells).

See also: MemberCellDoubleClickPolicy, MemberCellDoubleClickAllowedOrientations

MemberCellOrientations.All

Controls whether the action defined by the MemberCellDoubleClickPolicy applies to page, column, and/or row members.

For example, if the MemberCellDoubleClickPolicy is Zoom and the MemberCellDoubleClickAllowedOrientations is Row, then a Zoom In or Zoom Out operation is performed only when the user double clicks a row member (or members), but not when the user double clicks a page or column member.

By default, the value is All, which indicates that the MemberCellDoubleClickPolicy is performed for page, row, and column members.

Both the MemberCellDoubleClickAllowedOrientations and MemberCellDoubleClickAllowedDimensions settings are used to control whether the action is performed when the user double clicks a member cell (or multiple member cells).

See also: MemberCellDoubleClickPolicy, MemberCellDoubleClickAllowedDimensions

MemberDoubleClickPolicy.None

Controls what happens when the user double-clicks an Essbase member cell with the mouse button.

None — Nothing happens.

Zoom — A zoom-in operation is performed when the left mouse button is used, and a zoom-out operation is performed when the right mouse button is used.

EnterEditMode — The cursor is displayed in the cell and the user can edit the value.

The Notes property can be used by developers to record information related to the view, such as notes about the design, history of changes, etc.

Defines one or more SQLPassthroughDataSetRanges.

A SQLPassthroughDataSetRange associates a SQLPassthroughDataSet with the view. At runtime, the SQLPassthroughDataSetRange is built, which executes the query (or queries) and copies the resulting DataSet to the view. By default, a SQLPassthroughDataSet range automatically builds when the view builds, but can be configured to build on demand, such as from a workbook script.

A SQLPassthroughDataSetRange defines a DataTableRange for each query defined by the SQLPassthroughDataSet. A DataTableRange controls the behavior and presentation of the data.

Multiple SQLPassthroughDataSetRanges can be defined for the view, which allows data from multiple relational databases to be presented within the same view.

Configures the selectors for the view, including the order the selectors are displayed in the toolbar as well as the following settings for each selector:

Optional — Controls whether a selection is optional or required.

MultiSelect — Controls whether the user is allowed to select multiple items or only a single item. If checked, multiple items can be selected.

Caption — An optional caption that overrides the default caption defined for the selector.

Selector List — The selector list that defines 1) how the list of selectable items is generated and 2) the user-interface control used to display the items. If no selector list is specified, the default selector list defined for the selector is used.

Last Used Item Context — Controls the caching of the item(s) selected when the view is built or refreshed. Refer to the SelectorLastUsedItemContext for additional information.

LastUsedItemContextLabel — The context label used when the Last Used Item Context is set to ByLabel.

Connection Policy — For a selector that requires a connection to generate the list of selectable items, the connection policy controls whether the selector uses the view’s connection or uses a specified connection.

Connection Settings —  When the connection policy is UseSpecifiedConnection, the connection settings identify and configure the connection.

SelectorControlUIDisplayMode.DockedControl

Controls whether a docked pane or a modal dialog contains the user-interface control that displays the selectable items. The setting is only applicable to selectors that display the items in a user-interface control, such as a treeview or listbox, when the user clicks the 'Show' button on the selector tool.

DockedControl — Displays a pane that contains the user-interface control. The pane is docked the first time the user clicks the 'Show' button. The docked location is specified by the SelectorDockedControlLocation. If multiple selector user-interface controls are docked, each is displayed as a separate tab in the pane.

LockedDockedControl — Same as a DockedControl, except that the user cannot move the control to a different docked location.

ModalDialog — Displays a modal dialog that contains the user-interface control. The dialog is displayed each time the user clicks the 'Show' button, and must be closed by the user.

See also: SelectorDockedControlLocation

DockedControlGroupStyle.Tabbed

The layout of the group of dockable selector user-interface controls. The setting is only applicable when the SelectorControlDisplayMode is set to DockedControl.

Tabbed - Each selector control is displayed as a tabbed window within the group. Only the content of the selector control that is displayed in the active tab is visible.

Stacked - The selector controls are displayed as stacked tiles.

SlidingHeaders - Each selector control is represented by a button and only the content of the active selector control is visible. A selector control is activated by pressing its button.

SideBySide - The selector controls displayed as side-by-side tiles.

The combination of the SelectorDockedControlLocation and SelectorDockedControlGroupStyle settings determines the location and layout of the selector controls.

See also: SelectorControlUIDisplayMode, SelectorDockedControlLocation

DockedControlLocation.Right

The initial docked location for dockable selector user-interface controls. The setting is only applicable when the SelectorControlDisplayMode is set to DockedControl.

See also: SelectorControlUIDisplayMode

LastUsedItemContextScope.BySelector

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 the selectors that are assigned a selector list with a DefaultSelectionPolicy of LastUsedItem.

BySelector — The cache is shared by all views configured with the BySelector context.

BySelectorList — The cache is shared by all views configured with the BySelectorList context.

ByView — The cache is used only by this view.

ByLabel — The cache is shared by all views configured with the ByLabel context and assigned the same SelectorLastUsedItemContextLabel as this view.

See also: SelectorLastUsedItemContextLabel

The context label used when the SelectorLastUsedItemContext is set to ByLabel. Views that are assigned the same label share the same default selections.

See also: SelectorLastUsedItemContext

StatusBarContentAlignment.Center

Controls the alignment of the progress text within the progress text area on the status bar.

ProgressTextAlign is only applicable when ShowStatusBar is true.

See also: ShowStatusBar, ShowProgressText

true

Controls whether the progress text is displayed in the status bar. ShowProgressText is only applicable when ShowStatusBar is true.

See also: ShowStatusBar, ProgressTextAlign

true

Controls whether the status bar is displayed in the view window.

See also: ShowStatusIcon, ShowStatusText, ShowProgressText, ProgressTextAlign

true

Controls whether the status icon is displayed in the status bar. ShowStatusIcon is only applicable when ShowStatusBar is true.

See also: ShowStatusBar, ShowStatusText

true

Controls whether a status icon is displayed on the view window tab.

true

Controls whether the status text is displayed in the status bar. ShowStatusText is only applicable when ShowStatusBar is true.

See also: ShowStatusBar, ShowStatusIcon

Ready to Build

The text displayed in the status bar to indicate the view is buildable as determined by the view state. For instance, a view that has selectors is typically considered buildable when each selector has a selected item.

Cancelled

The text displayed in the status bar to indicate the view was cancelled.

Error

The text displayed in the status bar to indicate a view operation failed.

Information

The text displayed in the status bar to indicate that the status details contain information. The details are displayed when the Details button is clicked.

Not Ready to Build

The text displayed in the status bar to indicate the view is not buildable as determined by the view state.

Ready

The text displayed in the status bar to indicate a view operation is complete.

Selection Changed

The text displayed in the status bar to indicate a selection changed.

Waiting for Essbase Login

The text displayed in the status bar to indicate the view is waiting for an Essbase login.

Waiting for Server Response

The text displayed in the status bar to indicate the view is waiting for a response from the server.

Warning

The text displayed in the status bar to indicate that the status details contain a warning. The details are displayed when the Details button is clicked.

Working

The text displayed in the status bar to indicate a view operation is processing.

The token definitions assigned to the view. The view tokens along with the application tokens and, if applicable, selector tokens are used during token replacement.

The key of the PopupMenuTool to use as the context menu for the grid control. Any popup menu tool that is defined in the toolbars configuration assigned as the ViewToolbarsConfigurationID can be used as the grid context menu.

See also: ViewToolbarsConfigurationID

The key of the PopupMenuTool to use as the context menu for the grid control when the active worksheet is a drillthrough sheet. Any popup menu tool that is defined in the toolbars configuration assigned as the ViewToolbarsConfigurationID can be used as the grid context menu.

Refer to DataCellDoubleClickPolicy for an explanation of a drillthrough sheet.

See also: DataCellDoubleClickPolicy, ViewToolbarsConfigurationID

The ID of the toolbars configuration that defines the view-specific menus and tools. At run-time, the menus and tools are merged with the application menus and tools.

See also: ViewToolbarsConfigurationID

RenderExcelViewAsDocumentPolicy.RenderAsExcel

Controls whether the view is rendered as an Excel spreadsheet, which is the default, or as a PDF.

When the value is RenderAsPDF, the WindowsViewUIObjectTypeID should be set to WorkbookViewAndPdfViewer. The PDF toolbar, which contains the PDF tools, is built into the PDF viewer. If the view requires a Build button and POV selectors, set the ViewToolbarsConfigurationID to View Standard, which is included in the metadata starter kit.

The key of the PopupMenuTool displayed when the sheet tab area of the grid control is clicked with the right mouse button. Although any popup menu tool that is defined in the toolbars configuration assigned as the ViewToolbarsConfigurationID can be specified as the sheet context menu, only a popup menu tool that contains any of the tools with the following keys should be used: InsertSheetContextMenuButton, DeleteSheetContextMenuButton, and RenameSheetContextMenuButton. The SheetContextMenu is a standard popup menu tool that contains these tools and can be imported into a toolbars configuration.

See also: ViewToolbarsConfigurationID

false

Controls whether a formula bar is displayed along the top of the grid. The formula bar contains a dropdown list of range names for the workbook and the active worksheet. It also contains an area that displays the constant value or formula stored in the active cell, and can be used to enter or edit values or formulas in cells.

false

Controls whether a formula bar is displayed along the top of the grid when a drillthrough sheet is the active sheet. The formula bar contains a dropdown list of range names for the workbook and the active worksheet. It also contains an area that displays the constant value or formula stored in the active cell, and can be used to enter or edit values or formulas in cells.

The ID of the toolbars configuration that defines the view-specific menus and tools displayed within the view window.

See also: MergeableToolbarsConfigurationID

The object type ID of the Windows form that contains the user-interface controls used to display the view data.

This is a required setting.

false

Controls whether the Chart Explorer can be launched from the WorkbookView grid control.

The Chart Explorer is launched using the F6 + Shift keys.

false

Controls whether the Range Explorer can be launched from the WorkbookView grid control.

The Range Explorer is launched using the F6 + Shift keys.

false

Controls whether the Shape Explorer can be launched from the WorkbookView grid control.

The Shape Explorer is launched using the F6 + Shift keys.

false

Controls whether the Workbook Designer can be launched from the WorkbookView grid control.

The Workbook Designer is launched using the F3 key.

false

Controls whether the Workbook Explorer can be launched from the WorkbookView grid control.

The Workbook Explorer is launched using the F6 key.

False

Controls whether to allow files to be attached to the view.

AllowAttachments can be specified as a formula that evaluates to True or False.

If AllowAttachments is blank, a value of False will be used.

True

Controls whether to allow attachments to be deleted.

AllowDelete can be specified as a formula that evaluates to True or False.

If AllowDelete is blank, a value of True will be used.

A semicolon delimited string of file types. For example, ".xlsx;.txt;.docx".

Only attachments of the file types specified are allowed to be attached.

If no file types are specified, then all types are allowed, except for restricted types, which include files with any of the following extensions: exe, pif, application, gadget, msi, msp, com, scr, hta, cpl, msc, jar, bat, cmd, vb, vbs, vbe, js, jse, ws, wsf, wsc, wsh, ps1, ps1xml, ps2, ps2xml, psc1, psc2, msh, msh1, msh2, mshxml, msh1xml, msh2xml, scf, inf, reg, docm, dotm, xlsm, xltm, xlam, pptm, potm, ppam, ppsm, sldmS1

1024

The maximum allowed file size of an attachment in KB.

1

The maximum number of files that can be attached to a the view.

MaximumAttachments can be specified as an integer value or a formula that evaluates to 0 or greater.

If MaximumAttachments is blank, a value of 1 will be used.

True

Controls whether to allow view comments to be added.

AllowAdd can be specified as a formula that evaluates to True or False.

False

Controls whether to allow comments that have already been saved to be deleted.

AllowDelete can be specified as a formula that evaluates to True or False.

The following tokens are available for the current comment: [T.Comment.CreatedBy], [T.Comment.CreatedDate], [T.Comment.UpdatedBy], [T.Comment.UpdatedDate].

False

Controls whether to allow comments that have already been saved to be updated.

AllowUpdate can be specified as a formula that evaluates to True or False.

The following tokens are available for the current comment: [T.Comment.CreatedBy], [T.Comment.CreatedDate], [T.Comment.UpdatedBy], [T.Comment.UpdatedDate].

true

Controls whether the selector values are automatically added to the KeyItems.

true

Controls whether the view’s ID is automatically added to the KeyItems.

The context string is stored with each comment. It can be used to capture context specific information that may be important to understanding the comment.

A formula can be used to specify this string.

g

Specifies the format used when displaying a date, such as the created or last modified date, in the View View Comments Editor or an Excel comment.

The DateFormat value can either be a standard or a custom format string. The default value, g, combines the short date and short time patterns, as defined by the view’s culture, separated by a space.

A standard format string consists of a single format character specifier from the following list of standard format specifiers. The patterns are influenced by the view’s culture, which defines the short and long patterns as well as the date separator and time separator.

With the following standard format specifiers, the displayed time is the local time. The examples are based on the United States (English) culture:

d: Short date pattern, 4/9/2009 D: Long date pattern, Thursday, April 09, 2009 t: Short time pattern, 7:53 PM T: Long time pattern, 7:53:03 PM f: Combination of long date and short time patterns separated by a space, Thursday, April 09, 2009 7:53 PM F: Full date/time pattern, Thursday, April 09, 2009 7:53:03 PM g: Combination of short date and short time patterns separated by a space, 4/9/2009 7:53 PM G: Combination of short date and long time patterns separated by a space, 4/9/2009 7:53:03 PM

The format specifiers are based on the .NET framework conventions. Refer to the following links for more information about standard and custom format specifiers, all of which are supported for the DateFormat property:

http://msdn.microsoft.com/en-us/library/az4se3k1.aspx http://msdn.microsoft.com/en-us/library/8kb3ddd4.aspx

Dodeca.Common.CommentsEditMode.Chat

Controls whether to use a Chat or Grid user-interface to display and edit comments.

false

Controls whether to allow view comments.

Specifies the KeyItems the View Comments Editor will use to link comments to the view.

A miminmum of one KeyItem is required for view comments.

The view’s AutoAddViewIdToKeyItems property can be used to include the view’s ID in the KeyItems without having to actually enter it.

-1

The maximum number of characters to display of each comment in the comment cell. Enter -1 for no limit.

CommentSortPolicy.DateAscending

When EditMode is Grid, specifies how to sort comments when displayed in the View Comments Editor.

false

Controls whether to provide view comments spell-checking.

CommentThreadPolicy.ThreadedMultipleRootComments

When EditMode is Grid, controls the type of threading allowed for view comments.

false

Controls whether the ShowContext button is available for the user to control whether the context is displayed.

false

Controls whether the comments grid FieldChooser is available to the user.

false

Controls whether the ShowLinks button is available for the user to control whether linking information is displayed.

View Comments and Attachments

The Caption of the View Comments Editor.

Edit view comments and attachments.

Specifies the tooltip used for the caption of the View Comments Editor.

SelectorControlUIDisplayMode.DockedControl

Controls whether the View Comments Editor is displayed in a docked pane or a modal dialog. - DockedControl: The editor is displayed in a dockable pane. The docked location is specified by the DockedControlLocation property. - LockedDockedControl: Same as a DockedControl, except that the user cannot move the Comments Editor to a different docked location. - ModalDialog: The editor is displayed in a modal dialog.

false

Controls whether to show the View Comments Editor automatically.

DockedControlLocation.Right

Sets or returns the initial docked location for View Comments Editor.

false

Controls whether the view comments Context is displayed.

false

Controls whether Date Created of comments is displayed in the comments grid.

true

Controls whether Date Modified is displayed in the comments grid.

true

Controls whether Modified By is displayed in the comments grid.

false

Controls whether view Links info is displayed.

false

Controls whether a subject is shown in the comments grid.

false

Controls whether Created By is displayed in the comments grid.

View Comments and Attachments

Specifies the caption used for the tab of the View Comments Editor.

Edit view comments and attachments.

Specifies the tooltip used for the tab of the View Comments Editor.

The caption for the View Help window.

SelectorControlUIDisplayMode.DockedControl

Controls whether a docked window or a modal dialog contains the view help.

DockedControl — Displays a docked window that contains the view help. The window is docked the first time the window is displayed. The DockedControlLocation indicates along which side the window is located.

LockedDockedControl — Same as a DockedControl, except that the user cannot move the window to a different docked location.

ModalDialog — Displays a modal dialog that contains the view help. The dialog is displayed each time the user clicks the 'View Help' button, and must be closed by the user.

true

Whether to display the View Help dockable window when the view is opened.

DockedControlLocation.Right

When the DisplayMode is DockedControl or LockedDockedControl, indicates the initial docked location for the view help window.

The ID and version of the RTF binary artifact that contains the help content.

Most of the rich text formatting is supported in the View Help control, including font sizes, colors, underlines, strike-throughs, italics, bolding, and highlights as well as bulleted and numbered lists, paragraph alignment, indentation, and images.

Custom functionality in the View Help content includes: - A Worksheet Navigation Link navigates to a specified address in the workbook. The link address is GoTo|<worksheet address>, such as GoTo|'Product Analysis'!$C$10. - A Tool Click Link triggers a click action for a specified tool key. The link address is ToolClick|<tool key>, such as ToolClick|SaveView. The tool can be visible or hidden. - Workbook script functions can be included in the content. - Tokens can be included in the content.

The workbook script functions and tokens are resolved when the control is opened, and, if the RefreshOnViewBuild view setting is True, also when the view builds.

false

Whether to refresh the View Help after the view is built.

Indicates the ID of the workbook script executed by the view.