showMdiPinMenu

Type: Boolean

Availability: Read or write at any time

The showMdiPinMenu property of the Form class toggles status of the Pin command displayed in the popup (context) menu when a user right‑clicks on the caption of an MDI child form or the tab associated with the form if the value of the Application class mdiStyle property is MdiStyle_Mdi_With_Tabs (1) or MdiStyle_Tabs_Only (2).

The default value is false, which means that the popup menu is not displayed by right‑clicking the MDI child caption. When this property is set to true, selecting the Pin command toggles the pinned status of a MDI child form. All pinned MDI child form tabs are displayed to the left of all non‑pinned form tabs. Pinned tabs have a pin icon displayed. A check mark is displayed at the left of the Pin command if the tab is pinned. Clicking on the pinned icon in the tab also unpins the tab.

The showMdiPinMenu property (and the corresponding Pincommand) is disabled if the value of the Application class mdiStyle property has the default value of MdiStyle_Mdi (0).

The showMdiCloseAllButThisMenu property is ignored if the form is not an MDI child form or the allowClose property is set to false.

Right‑clicking the MDI child form caption does not display a menu if all of the showMdiCloseAllButPinnedMenu, showMdiCloseAllButThisMenu, showMdiCloseMenu, showMdiDockMenu, showMdiFloatMenu, and showMdiPinMenu properties are set to false.

2020.0.01 and higher