Skip to main content

TCustomdxBarControl.HideAll(TdxBarCloseUpReason) Method

Removes focus from the currently active control and/or closes it.

Declaration

procedure HideAll(AReason: TdxBarCloseUpReason = bcrCancel); virtual;

Parameters

Name Type
AReason TdxBarCloseUpReason

Remarks

This method applies only to currently active controls. Its functionality varies depending on the control type (a TCustomdxBarControl class descendant), as shown below.

  • For toolbar controls (TdxBarControl), this method removes focus from the currently focused toolbar control and its item controls. The method sets the toolbar control’s IsActive property to False and hides all the toolbar’s submenus and popup menus (if these menus are active).

  • For toolbar submenu controls (TdxBarSubMenuControl), calling the HideAll method does one of the following:

  • If a submenu control has no parent, the method destroys this control.

  • If a submenu control has a parent (a submenu control is displayed for a subitem residing on a toolbar control), the method makes this submenu control inactive along with its item controls and the parent (toolbar control).

Pass a TdxBarCloseUpReason enumerated type value as the AReason parameter to specify the cause of closing the currently active control and bar item controls associated with it.

Possible TdxBarCloseUpReason values include:

Value Meaning
bcrCancel Operations with the currently active control are canceled due to moving focus to another control.
bcrEnter A menu item is activated or data is entered into a focused item control.
bcrEscape The Escape key is pressed canceling operations with the currently active control and moving focus to another control.
bcrUnknown Any other reason.
See Also