Essbase Message Viewer Tool Arguments

The following properties are available for Essbase Message Viewer Tool Arguments objects, grouped by the categories shown in the Toolbars Designer.

Misc

Property	Type	Default	Description
AutoOpenDockedControl	bool	true	Controls whether Essbase Message Viewer user-interface control automatically opens when the view opens. The AutoOpenDockedControl setting is only applicable when the ControlDisplayMode is DockedControl or LockedDockedControl. By default, the docked control is automatically opened.
ControlDisplayMode	UserControlDisplayMode	UserControlDisplayMode.DockedControl	Controls whether a docked pane or a modal dialog contains the Essbase Message Viewer user-interface control that displays the Essbase messages. DockedControl — Displays a pane that contains the user-interface control. The pane is docked the first time the user clicks the tool button. The docked location is specified by the DockedControlLocation. 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 tool button, and must be closed by the user.
DockedControlLocation	DockedControlLocation	DockedControlLocation.Bottom	The initial docked location for the Essbase Message Viewer user-interface control. The setting is only applicable when the ControlDisplayMode is set to DockedControl or LockedDockedControl.

Property

Type

Default

Description

AutoOpenDockedControl

bool

true

Controls whether Essbase Message Viewer user-interface control automatically opens when the view opens. The AutoOpenDockedControl setting is only applicable when the ControlDisplayMode is DockedControl or LockedDockedControl.

By default, the docked control is automatically opened.

ControlDisplayMode

UserControlDisplayMode

UserControlDisplayMode.DockedControl

Controls whether a docked pane or a modal dialog contains the Essbase Message Viewer user-interface control that displays the Essbase messages.

DockedControl — Displays a pane that contains the user-interface control. The pane is docked the first time the user clicks the tool button. The docked location is specified by the DockedControlLocation.

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 tool button, and must be closed by the user.

DockedControlLocation

DockedControlLocation.Bottom

The initial docked location for the Essbase Message Viewer user-interface control. The setting is only applicable when the ControlDisplayMode is set to DockedControl or LockedDockedControl.