ShowSheetList

Applies to

RibbonBar controls

Description

Whether to show a SheetList button with a dropdown menu that contains a list of opened sheets. When True and when there are opened sheets, the SheetList button is automatically added to the last panel in the first category in the ribbon bar.

Note

This property is valid only when the RibbonBar is converted from the menu (when DisplayMenuAsRibbonBar is selected). The standalone RibbonBar control does not support this property.

TRUE – (Default) Displays the SheetList button when a sheet window is opened.

FALSE – Does not display the SheetList button when a sheet window is opened.

Usage

In scripts

This statement specifies to show a SheetList button when a sheet list is available:

mdirbb_1.ShowSheetList = true

When the ShowSheetList property is true, a panel named OpenSheet (visible is false by default) and a button (whose tag value is SheetList) will be added after the last panel of the first category. This OpenSheet panel will only be visible when there is an open sheet window.

The sheet list is displayed in the Window menu in the original menu style:

When ShowSheetList is TRUE and a sheet window is opened, the sheet list is shown as follows: