NCommandBar Class

In This Topic

Represents a command bar, that consists of a gripper, collection of items and a pendant.

Object Model

Syntax

public class NCommandBar : NWidget, Nevron.Nov.Dom.INArrangeElement, Nevron.Nov.Dom.INArrangeElementParent, Nevron.Nov.Dom.INDomDeepEquals, Nevron.Nov.Dom.INDomDeeplyCloneable, Nevron.Nov.Dom.INMeasureElement, Nevron.Nov.Dom.INMeasureElementParent, Nevron.Nov.INDeeplyCloneable, INInputNode, INPopupDirectionProvider

Remarks

A command bar can be vertically or horizontally oriented that is determined by its Orientation property. When set to Horizontal, the command bar content will flow horizontally, from left to right. When set to Vertical, the command bar content will flow vertically, from top to bottom. The Orientation is automatically updated by Nevron, when the command bar is added to dock lanes.

A command bar can be in one of the following states:

Docked - a command bar is docked when it resides in an NCommandBarDock. When you drag a command bar inside the dock, the command bar changes lanes and/or lane position. When you drag a command bar outside the dock, the command bar will attempt to float. You can prevent it from floating by setting the AllowFloat property to false.
Floating - a command bar is floating when it resides in an NCommandBarFloater window. When you drag the floater not over a dock, the command bar floater will follow the mouse position. When you drag the floater over a dock, the command bar will attempt to dock. You can prevent it from docking by setting the AllowDock property to false.
Closed - a command bar is closed when it resides in the ClosedCommandBars collection of an NCommandBarsManager. A command bar can be closed from the command bar manager context menu, or from the floater close button. You can prevent a command bar from closing by setting the AllowClose property to false. A command bar can be reopened from the command bar manager context menu, in the case of which it is either redocked, or refloated depending on whether the bar was floating or was docked at the time of close.

The items of a command bar can be any widgets. For the purpose of presenting a command bar item in customization interfaces, the command bar provides two extended properties - TextPropertyEx and ImagePropertyEx, which can be applied to the items contained in the bar.

The command bar has support for mouse and keyboard selection. The command bar automatically sets the SelectedPropertyEx to true, to the command bar item that is currently selected via the mouse or the keyboard and automatically deselects all other items. If the keyboard focus was contained in the command bar before the selection change, the command bar will try transfer the focus to the newly selected item.

Inheritance Hierarchy

System.Object
   Nevron.Nov.Dom.NNode
      Nevron.Nov.Dom.NDocumentNode
         Nevron.Nov.Dom.NElement
            Nevron.Nov.Dom.NVisual
               Nevron.Nov.UI.NInputElement
                  Nevron.Nov.UI.NBoxElement
                     Nevron.Nov.UI.NWidget
                        Nevron.Nov.UI.NCommandBar
                           Nevron.Nov.UI.NMenuBar
                           Nevron.Nov.UI.NStatusBar
                           Nevron.Nov.UI.NToolBar

Requirements

Target Platforms: Windows 11, Windows 10, Windows 7, Windows Server 2019, Windows Server 2016, Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later)

Reference

NCommandBar Members
Nevron.Nov.UI Namespace