Nevron Open Vision Documentation
NCommandBar Class Members
Fields  Properties  Methods  Events


The following tables list the members exposed by NCommandBar.

Public Constructors
 NameDescription
Public ConstructorNCommandBar ConstructorDefault constructor.  
Top
Public Fields
 NameDescription
Public Fieldstatic (Shared in Visual Basic)AllowCloseProperty  
Public Fieldstatic (Shared in Visual Basic)AllowDockProperty  
Public Fieldstatic (Shared in Visual Basic)AllowFloatProperty  
Public Fieldstatic (Shared in Visual Basic)ClosePopupsOnMouseOutPropertyReference to the CloseOnMouseOut property  
Public Fieldstatic (Shared in Visual Basic)FillLaneProperty  
Public Fieldstatic (Shared in Visual Basic)FloatingAnchorProperty  
Public Fieldstatic (Shared in Visual Basic)FloatingWidthProperty  
Public Fieldstatic (Shared in Visual Basic)GripperChildReference to the Gripper child  
Public Fieldstatic (Shared in Visual Basic)HasHiddenItemsProperty  
Public Fieldstatic (Shared in Visual Basic)HasOpenedPopupPropertyReference to the HasOpenedPopup property  
Public Fieldstatic (Shared in Visual Basic)ImagePropertyExReference to the Image extended property  
Public Fieldstatic (Shared in Visual Basic)ItemsChildReference to the Content child  
Public Fieldstatic (Shared in Visual Basic)LanePositionProperty  
Public Fieldstatic (Shared in Visual Basic)NCommandBarSchemaSchema associated with NCommandBar  
Public Fieldstatic (Shared in Visual Basic)OpenPopupsOnMouseInPropertyReference to the OpenOnClick property  
Public Fieldstatic (Shared in Visual Basic)OrientationPropertyReference to the Orientation property  
Public Fieldstatic (Shared in Visual Basic)PendantChildReference to the Pendant child  
Public Fieldstatic (Shared in Visual Basic)RedockLanePositionProperty  
Public Fieldstatic (Shared in Visual Basic)RedockLaneRefProperty  
Public Fieldstatic (Shared in Visual Basic)RefloatLocationProperty  
Public Fieldstatic (Shared in Visual Basic)ReopenModeProperty  
Public Fieldstatic (Shared in Visual Basic)SelectedPropertyExReference to the Selected extended property  
Public Fieldstatic (Shared in Visual Basic)StackFillModePropertyReference to the StackFillMode property.  
Public Fieldstatic (Shared in Visual Basic)StackFitModePropertyReference to the StackFitMode property.  
Public Fieldstatic (Shared in Visual Basic)TextComparerCompares command bars by their name  
Public Fieldstatic (Shared in Visual Basic)TextProperty  
Public Fieldstatic (Shared in Visual Basic)TextPropertyExReference to the Text extended property  
Public Fieldstatic (Shared in Visual Basic)WrappableProperty  
Top
Public Properties
 NameDescription
Public PropertyAllowCloseGets or sets whether this command bar can be closed.  
Public PropertyAllowDockGets or sets whether this command bar can be docked or redocked, if it is floating. A command bar can always be redocked, if it is closed.  
Public PropertyAllowFloatGets or sets whether this command bar can float, if it is docked. A command bar can always be refloated, if it is closed.  
Public PropertyClosePopupsOnMouseOutGets or sets whether the popup windows of the command bar items should be automatically closed when the mouse is no longer inside them. By default set to false, meaning that the popup window will stay open, until another popup is shown, or the popup loses activation (e.g. user clicks away).  
Public PropertyFillLaneGets or sets whether the command bar fills the lane, when it is the only command bar inside it. When set to true the command bar cannot be dragged to a lane that contains other command bars and also other command bars cannot be dragged to the lane in which it resides. By default set to false.  
Public PropertyFloatingAnchorGets or sets the floating anchor, which is a point in local coordinates of the floating window header and is used to align the dragged floating window to the current mouse position. Automatically updated by Nevron when the user starts dragging the floater and reset when the user starts dragging the command bar in the dock.  
Public PropertyFloatingWidthGets or sets the width of the floating window created for the command bar, when it is made to float. By default set to NaN, meaning that the window is automatically sized to fit the command bar content. The value of this property is updated when the user resizes the floating window by grabbing its sides. The height of the floating window is always automatically calculated.  
Public PropertyGripperGets or sets the command bar gripper, which is arranged at the heading of the bar. Dragging the gripper inside the dock, repositions the command bar by changing its lane and lane position.  
Public PropertyHasHiddenItemsGets whether the command bar has hidden items or not. Automatically updated by Nevron.  
Public PropertyHasOpenedPopupGets or sets whether at least one of the menu bar items has its menu opened. The value of this property is automatically updated by Nevron.  
Public PropertyItemsGets or sets the command bar items collections.  
Public PropertyLanePositionGets or sets the preferred position of the bar inside the lane. It is specified relatively to the content area of the lane.  
Public PropertyOpenPopupsOnMouseInGets or sets whether the popup windows of the command bar items are opened when the mouse enters them. By default set to false, meaning that you normally have to click a popup host to open its popup window.  
Public PropertyOrientationGets whether this is command bar is vertically arranged. By default set to false. Automatically updated by Nevron when this bar is added to a command bars lane.  
Public PropertyOwnerDockGets the dock in which this bar resides.  
Public PropertyOwnerFloaterGets the floating window in which this bar resides.  
Public PropertyOwnerLaneGets the lane in which this bar resides.  
Public PropertyOwnerManagerGets the manager in which this bar resides.  
Public PropertyPendantGets or sets the command bar pendant, which is arranged at the ending of the bar.  
Public PropertyRedockLanePositionGets or sets the offset part of the LanePosition, at which the command bar needs to be placed, when redocked. Automatically updated by Nevron, when the command bar starts to be dragged or was docked when closed.  
Public PropertyRedockLaneRefGets or sets a reference to the lane, at which the command bar needs to be placed, when redocked. Automatically updated by Nevron, when the command bar starts to be dragged or was docked when closed.  
Public PropertyRefloatLocationGets or sets the position of the floater window, at which to refloat the command bar. Automatically updated by Nevron, when the floater start to be dragged or was floating when closed.  
Public PropertyReopenModeGets or sets the mode in which to reopen a closed command bar. Automatically updated by Nevron when the command bar is closed.  
Public PropertySelectedItemGets the selected command bar item.  
Public PropertyStackFillModeGets or sets the fill mode to apply on this command bar items. Valid only if this command bar is not wrappable (Wrappable set to false).  
Public PropertyStackFitModeGets or sets the fit mode to apply on this command bar items. Valid only if this command bar is not wrappable (Wrappable set to false).  
Public PropertyTextGets or sets the name of the command bar. The name appears in the pendant menu and as title in the command bar floater.  
Public PropertyWrappableGets or sets whether the command bar wraps its items or not when docked. When set to false the command bar will arrange the items in a single lane in command bar flow direction. When set to false the command bar will arrange the items in multiple lanes in command bar flow direction. When the bar is floating it is always wrappable. By default set to false.  
Top
Public Methods
 NameDescription
Public MethodCanCloseDetermines whether this command bar can be closed.  
Public MethodCanDockDetermines whether the command bar can be docked to the specified dock  
Public MethodCanFloatDetermines whether the command bar can float  
Public MethodCanRedockDetermines whether the command bar can be redocked.  
Public MethodCanRefloatDetermines whether the command bar can be refloated.  
Public MethodCloseCloses the command bar.  
Public MethodDockDocks the command bar to the specifed dock and screen position.  
Public MethodFloatFloats the command bar to the specified screen location.  
Public MethodGetDefaultPopupDirectionGets the default direction of the popups  
Public Methodstatic (Shared in Visual Basic)GetImageGets the value for the ImagePropertyEx for the specified item  
Public MethodGetMinimalExtendGet the minimal width/height of the command bar depending on its orientation, when it resides in a lane, below which the lane is not allowed to shrink the bar.  
Public Methodstatic (Shared in Visual Basic)GetSelectedGets the value for the SelectedPropertyEx for the specified item  
Public Methodstatic (Shared in Visual Basic)GetTextGets the value for the TextPropertyEx for the specified item  
Public MethodIsClosedDetermines whether the command bar is closed (e.g. resides in the closed bars collection of the OwnerMananager)  
Public MethodIsDockedDetermines whether the command bar is docked  
Public MethodIsFloatingDetermines whether the command bar is floating  
Public MethodIsOpenedDetermines whether the command bar is opened (e.g. is either floating or is docked)  
Public MethodNavigateToFirstItemNavigates to the first item  
Public MethodNavigateToItemNavigates to the specified item  
Public MethodNavigateToLastItemNavigates to the last item  
Public MethodNavigateToNextItemNavigates to the down item  
Public MethodNavigateToPrevItemNavigates to the down item  
Public MethodPopulatePendantMenuPopulates the pendant menu with items.  
Public MethodRedockRedocks the command bar to its last known docked state.  
Public MethodRefloatRefloats the command bar to its last known floating state.  
Public MethodReopenOpens the command bar.  
Public Methodstatic (Shared in Visual Basic)SetImageSets the value for the ImagePropertyEx for the specified item  
Public Methodstatic (Shared in Visual Basic)SetTextSets the value for the TextPropertyEx for the specified item  
Top
Protected Methods
 NameDescription
Protected MethodArrangeContentOverridden. Arranges the content of the element within the specified content area.  
Protected MethodCreateAddRemoveMenuItemOverloaded. Creates the root "Add/Remove" menu item, the subitems of which are the menu items for each command bar that resides in this command bar owner lane.  
Protected MethodCreateCommandBarItemMenuItemCreates a menu item that represents the specified command bar item  
Protected MethodCreateFloaterCreates a floating window for this command bar.  
Protected MethodCreateHiddenItemsGroupCreates the widget that contains a representation for the currently hidden items of the command bar.  
Protected MethodCreatePropertiesMenuItemCreates the properties menu item  
Protected MethodCreatePropertyMenuItemCreates a menu item for a command bar property  
Protected MethodGetNavigateToNextItemKeyGets the keyboard key that navigates to the next item  
Protected MethodGetNavigateToPrevItemKeyGets the keyboard key that navigates to the prev item  
Protected MethodMeasureContentOverridden. Measures the desired size of the element content  
Protected MethodOnAddRemoveMenuItemClickedCalled when an add/remove menu item was clicked  
Protected MethodOnChildInsertedOverridden. Called when a child node has been inserted  
Protected MethodOnKeyDownOverridden. Default handler for a key down event  
Protected MethodOnMouseMoveOverridden.   
Protected MethodOnMouseOutOverridden. Called when the NMouse.OverPropertyEx property gets a false value  
Protected MethodOnOrientationChangedCalled when Orientation has changed  
Protected MethodOnPropertyMenuItemClickedCalled when a menu item that represents a command bar menu item is clicked  
Protected MethodOnWrappableChangedCalled when Wrappable has changed  
Top
See Also

Reference

NCommandBar Class
Nevron.Nov.UI Namespace

 

 


©2017. Nevron Software LLC.

Send Feedback