Back to Devexpress

NavBarControl Properties

windowsforms-devexpress-dot-xtranavbar-dot-navbarcontrol-dot-underscore-properties.md

latest44.4 KB
Original Source

NavBarControl Properties

Implements a side navigation UI found in MS Office or MS Explorer.

NameDescription
AccessibilityObjectGets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications. Inherited from Control.
AccessibleDescriptionGets or sets the description of the control used by accessibility client applications. Inherited from Control.
AccessibleNameGets or sets the name of the control used by accessibility client applications. Inherited from Control.
AccessibleRoleGets or sets the accessible role of the control. Inherited from Control.
ActiveGroupReturns an object representing the currently active group.
ActiveGroupNameThis member supports the .NET Framework infrastructure and cannot be used directly from your code.
AllowDropGets or sets a value that specifies whether the XtraNavBar can accept data that an end-user drags onto it.
AllowGlyphSkinningGets or sets whether all items within the current NavBarControl should paint their icons in the items’ foreground colors.
AllowHorizontalResizingGets or sets whether a built-in resizer is enabled at the control’s right or left edge (depending on the control’s Dock setting) that allows an end-user to resize the control horizontally.
AllowHtmlStringGets or sets whether the group and item captions are formatted using HTML tags.
AllowSelectedLinkObsolete. This property is obsolete. Use the NavBarControl.LinkSelectionMode property instead.
AnchorGets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. Inherited from Control.
AppearanceProvides access to the properties that control the appearance of the NavBarControl’s elements.
AutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoSizeThis property is not relevant for this class. Inherited from Control.
AvailableNavBarViewsProvides access to the collection of BaseViewInfoRegistrator objects that contain information on painting corresponding Views.
BackColorGets or sets the background color for the control. Inherited from Control.
BackgroundImageThis property is not supported by the NavBarControl class.
BackgroundImageLayoutThis property is not supported by the NavBarControl class.
BindingContextGets or sets the BindingContext for the control. Inherited from Control.
BorderStyleGets or sets the border style of the NavBarControl.
BottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control.
BoundsGets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control.
CanEnableIme protectedGets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from Control.
CanFocusGets a value indicating whether the control can receive focus. Inherited from Control.
CanRaiseEvents protectedDetermines if events can be raised on the control. Inherited from Control.
CanSelectGets a value indicating whether the control can be selected. Inherited from Control.
CaptureGets or sets a value indicating whether the control has captured the mouse. Inherited from Control.
CausesValidationGets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. Inherited from Control.
CheckForIllegalCrossThreadCalls staticGets or sets a value indicating whether to catch calls on the wrong thread that access a control’s Handle property when an application is being debugged. Inherited from Control.
ClientRectangleGets the rectangle that represents the client area of the control. Inherited from Control.
ClientSizeGets or sets the height and width of the client area of the control. Inherited from Control.
CompanyNameGets the name of the company or creator of the application containing the control. Inherited from Control.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContainsFocusGets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control.
ContentButtonHintGets or sets the content button’s hint.
ContextMenuGets or sets the shortcut menu associated with the control. Inherited from Control.
ContextMenuStripGets or sets the ContextMenuStrip associated with this control. Inherited from Control.
ControlsGets the collection of controls contained within the control. Inherited from Control.
CreatedGets a value indicating whether the control has been created. Inherited from Control.
CreateParams protectedGets the required creation parameters when the control handle is created. Inherited from Control.
CursorGets or sets a value specifying the cursor type used when the mouse pointer is over the control, but is not over a group caption or a link.
DataBindingsGets the data bindings for the control. Inherited from Control.
DefaultBackColor staticGets the default background color of the control. Inherited from Control.
DefaultCursor protectedGets or sets the default cursor for the control. Inherited from Control.
DefaultFont staticGets the default font of the control. Inherited from Control.
DefaultForeColor staticGets the default foreground color of the control. Inherited from Control.
DefaultImeMode protectedGets the default Input Method Editor (IME) mode supported by the control. Inherited from Control.
DefaultMargin protectedGets the space, in pixels, that is specified by default between controls. Inherited from Control.
DefaultMaximumSize protectedGets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control.
DefaultMinimumSize protectedGets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control.
DefaultPadding protectedGets the internal spacing, in pixels, of the contents of a control. Inherited from Control.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayRectangleGets the rectangle that represents the display area of the control. Inherited from Control.
DisposingGets a value indicating whether the base Control class is in the process of disposing. Inherited from Control.
DockGets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. Inherited from Control.
DoubleBuffered protectedGets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control.
DragDropFlagsGets or sets a set of flags controlling the control’s behavior as it relates to link drag and drop operations.
EachGroupHasSelectedLinkObsolete. This property is obsolete. Use the NavBarControl.LinkSelectionMode property instead.
EnabledGets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExplorerBarGroupIntervalGets or sets the interval (in pixels) between neighboring groups when any of the explorer views are applied.
ExplorerBarGroupOuterIndentGets or sets the size of the horizontal indent (in pixels) between a group’s edges and the NavBarControl’s edges when any of the explorer views are applied.
ExplorerBarShowGroupButtonsGets or sets whether group expand buttons are visible within group headers (when any of the explorer bar views are applied. ).
ExplorerBarStretchLastGroupGets or sets whether the last group in the Explorer Bar View is stretched to fill the NavBarControl.
FireDelayedSelectedLinkChangedEventGets whether the last added item link is selected and the NavBarControl.SelectedLinkChanged event fires as a result.
FocusedGets a value indicating whether the control has input focus. Inherited from Control.
FontGets or sets the font of the text displayed by the control. Inherited from Control.
FontHeight protectedGets or sets the height of the font of the control. Inherited from Control.
ForeColorGets or sets the foreground color of the control. Inherited from Control.
GroupBackgroundImageSpecifies the image displayed as a background for groups.
GroupsGets a collection of objects representing groups of the NavBarControl.
GroupTextureBackgroundBrushGets an object representing the brush used to fill a group’s background.
HandleGets the window handle that the control is bound to. Inherited from Control.
HasChildrenGets a value indicating whether the control contains one or more child controls. Inherited from Control.
HeightGets or sets the height of the control. Inherited from Control.
HideGroupCaptionsGets or sets a value specifying whether group captions are visible.
HotTrackedGroupGets an object representing the group over whose caption the mouse pointer rests.
HotTrackedGroupCursorGets or sets a value specifying the cursor type used when a mouse pointer is over a group caption.
HotTrackedItemCursorGets or sets a value specifying the cursor type used when a mouse pointer is over a group caption.
HotTrackedLinkGets an object representing the link over which the mouse pointer rests.
HtmlImagesGets or sets a collection of images that can be inserted into the group and item captions using the image tag.
ImeModeGets or sets the Input Method Editor (IME) mode of the control. Inherited from Control.
ImeModeBase protectedGets or sets the IME mode of a control. Inherited from Control.
InvokeRequiredGets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. Inherited from Control.
IsAccessibleGets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control.
IsDesignModeGets a value indicating whether the control is currently in design mode.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from Control.
IsHandleCreatedGets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsLoadingGets a value indicating whether the control is being initialized.
IsMirroredGets a value indicating whether the control is mirrored. Inherited from Control.
ItemsGets the collection of items within the NavBarControl control.
LargeImagesGets or sets an object that serves as the source of large images used in the NavBarControl.
LayoutEngineGets a cached instance of the control’s layout engine. Inherited from Control.
LayoutVersionGets or sets the version of the control’s layout.
LeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container’s client area. Inherited from Control.
LinkIntervalGets or sets the interval (in pixels) between neighboring links in a group.
LinkSelectionModeGets or sets whether link selection is enabled and whether each group or only one group can contain a selected link simultaneously.
LocationGets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control.
LookAndFeelProvides access to the settings which control the NavBarControl’s look and feel.
MarginGets or sets the space between controls. Inherited from Control.
MaximumSizeGets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MenuManagerGets or sets an object that controls the look and feel of the control’s popup menus.
MinimumSizeGets or sets the minimal NavBarControl size.
ModifierKeys staticGets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control.
MouseButtons staticGets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control.
MousePosition staticGets the position of the mouse cursor in screen coordinates. Inherited from Control.
NameGets or sets the name of the control. Inherited from Control.
NavigationPaneGroupClientHeightGets or sets the default minimum height of the client area for the active group when the “NavigationPane” view is applied.
NavigationPaneMaxVisibleGroupsGets the maximum number of groups for which buttons are displayed within a NavBarControl when the “NavigationPane” view is applied.
NavigationPaneOverflowPanelUseSmallImagesGets or sets whether groups in the Overflow panel are represented by small or large icons.
NavPaneFormGets the NavPane Form’s settings.
OptionsLayoutContains options that control how the NavBarControl‘s layout is stored to/restored from a stream, xml file or system registry.
OptionsNavPaneContains options that determine the appearance and behavior of the NavBarControl when the NavigationPane paint style is applied.
PaddingGets or sets padding within the control. Inherited from Control.
PaintAppearanceProvides access to the appearance settings currently used to paint the NavBarControl’s elements.
PaintStyleKindGets or sets the kind of the NavBarControl’s paint style.
PaintStyleNameThis member is not supported.
ParentGets or sets the parent container of the control. Inherited from Control.
PreferredSizeGets the size of a rectangular area into which the control can fit. Inherited from Control.
PressedGroupGets an object representing the group whose caption is pressed.
PressedLinkGets an object representing the pressed link.
ProductNameGets the product name of the assembly containing the control. Inherited from Control.
ProductVersionGets the version of the assembly containing the control. Inherited from Control.
PropagatingImeMode protected staticGets an object that represents a propagating IME mode. Inherited from Control.
RecreatingHandleGets a value indicating whether the control is currently re-creating its handle. Inherited from Control.
RegionGets or sets the window region associated with the control. Inherited from Control.
RenderRightToLeft protectedThis property is now obsolete. Inherited from Control.
ResizeRedraw protectedGets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
RightGets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control.
RightToLeftGets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control.
ScaleChildren protectedGets a value that determines the scaling of child controls. Inherited from Control.
ScaleImagesGets or sets whether icons are automatically stretched to match the current DPI settings of the user’s monitor.
ScrollModeGets or sets a value that specifies when the NavBarControl’s content can be scrolled.
SelectedLinkGets or sets an object representing the selected link.
SelectLinkOnPressGets or sets whether a link is selected on the MouseDown or MouseUp event.
SharedImageCollectionImageSizeModeGets or sets the value that specifies how the display size of images is determined when the images are obtained from a SharedImageCollection.
ShowFocusCues protectedGets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowGroupHintGets or sets a value specifying whether group hints are displayed.
ShowHintIntervalGets or sets the time interval after the mouse pointer stops over an element and before its hint is displayed.
ShowIconsGets or sets whether link icons are shown.
ShowKeyboardCues protectedGets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
ShowLinkHintGets or sets a value specifying whether link hints are displayed.
SiteGets or sets the site of the control. Inherited from Control.
SizeGets or sets the height and width of the control. Inherited from Control.
SkinExplorerBarViewScrollStyleGets or sets how the control is scrolled when a skinning Explorer Bar View paint scheme is applied.
SmallImagesGets or sets an object that serves as the source of small images used in the NavBarControl.
StateGets a value indicating the control’s state.
StoreDefaultPaintStyleNameThis member supports the .NET Framework infrastructure and cannot be used directly from your code.
SuspendFormLayoutInAnimationThis member supports the internal infrastructure, and is not intended to be used directly from your code.
TabIndexGets or sets the tab order of the control within its container. Inherited from Control.
TabStopGets or sets a value indicating whether a user can focus this control using the TAB key.
TagGets or sets the object that contains data about the control. Inherited from Control.
TextGets or sets the text associated with this control. Inherited from Control.
ToolTipControllerGets or sets the tooltip controller component that controls the appearance, position and the content of the hints displayed by the XtraNavBar control.
TopGets or sets the distance, in pixels, between the top edge of the control and the top edge of its container’s client area. Inherited from Control.
TopLevelControlGets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. Inherited from Control.
UseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
ViewGets or sets an object specifying the control’s paint style.
ViewNameGets or sets the name of the View that specifies the paint scheme.
VisibleGets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
WidthGets or sets the width of the control. Inherited from Control.
WindowTargetThis property is not relevant for this class. Inherited from Control.

See Also

NavBarControl Class

NavBarControl Members

DevExpress.XtraNavBar Namespace