Back to Devexpress

NavBarControl Members

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

latest154.3 KB
Original Source

NavBarControl Members

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

Constructors

NameDescription
NavBarControl()Creates a new NavBarControl object.

Fields

NameDescription
DefaultPaintStyleNameGets the default paint style name.

Properties

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.

Methods

NameDescription
About() staticInvokes the About dialog window.
AccessibilityNotifyClients(AccessibleEvents, Int32, Int32) protectedNotifies the accessibility client applications of the specified AccessibleEvents for the specified child control . Inherited from Control.
AccessibilityNotifyClients(AccessibleEvents, Int32) protectedNotifies the accessibility client applications of the specified AccessibleEvents for the specified child control. Inherited from Control.
BeginInit()Begins the runtime initialization of the NavBarControl control that is used on a form, or by another component.
BeginInvoke(Delegate, Object[])Executes the specified delegate asynchronously with the specified arguments, on the thread that the control’s underlying handle was created on. Inherited from Control.
BeginInvoke(Delegate)Executes the specified delegate asynchronously on the thread that the control’s underlying handle was created on. Inherited from Control.
BeginUpdate()Locks the NavBarControl object by preventing visual updates of the object and its elements until the EndUpdate method is called.
BringToFront()Brings the control to the front of the z-order. Inherited from Control.
CalcCollapsedPaneWidth()Calculates the NavBarControl’s width in the minimized state (when the NavigationPane paint style is applied).
CalcHitInfo(Point)Gets an object containing information about the control at a specified point.
Contains(Control)Retrieves a value indicating whether the specified control is a child of the control. Inherited from Control.
CreateControl()Forces the creation of the visible control, including the creation of the handle and any visible child controls. Inherited from Control.
CreateControlsInstance() protectedCreates a new instance of the control collection for the control. Inherited from Control.
CreateGraphics()Creates the Graphics for the control. Inherited from Control.
CreateObjRef(Type)Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
DefWndProc(Message) protectedSends the specified message to the default window procedure. Inherited from Control.
DestroyHandle() protectedDestroys the handle associated with the control. Inherited from Control.
Dispose()Releases all resources used by the Component. Inherited from Component.
DoDragDrop(Object, DragDropEffects)Begins a drag-and-drop operation. Inherited from Control.
DrawToBitmap(Bitmap, Rectangle)Supports rendering to the specified bitmap. Inherited from Control.
EndInit()Ends the runtime initialization of the NavBarControl control.
EndInvoke(IAsyncResult)Retrieves the return value of the asynchronous operation represented by the IAsyncResult passed. Inherited from Control.
EndUpdate()Unlocks the NavBarControl object after a call to the BeginUpdate method and causes an immediate visual update.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
FindForm()Retrieves the form that the control is on. Inherited from Control.
Focus()Sets input focus to the control. Inherited from Control.
FromChildHandle(IntPtr) staticRetrieves the control that contains the specified handle. Inherited from Control.
FromHandle(IntPtr) staticReturns the control that is currently associated with the specified handle. Inherited from Control.
GetAllowSelectedLink()Returns a value that determines whether links can actually be selected in the current View.
GetAutoSizeMode() protectedRetrieves a value indicating how a control will behave when its AutoSize property is enabled. Inherited from Control.
GetChildAtPoint(Point, GetChildAtPointSkip)Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type. Inherited from Control.
GetChildAtPoint(Point)Retrieves the child control that is located at the specified coordinates. Inherited from Control.
GetContainerControl()Returns the next ContainerControl up the control’s chain of parent controls. Inherited from Control.
GetDragDropFlags()Returns a set of flags which specify the control’s drag and drop behavior.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetHideGroupCaptions()Returns a value that determines whether group captions are actually visible,
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetNextControl(Control, Boolean)Retrieves the next control forward or back in the tab order of child controls. Inherited from Control.
GetPreferredSize(Size)Retrieves the size of a rectangular area into which a control can be fitted. Inherited from Control.
GetScaledBounds(Rectangle, SizeF, BoundsSpecified) protectedRetrieves the bounds within which the control is scaled. Inherited from Control.
GetService(Type) protectedReturns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetStyle(ControlStyles) protectedRetrieves the value of the specified control style bit for the control. Inherited from Control.
GetToolTipController()Returns the tooltip controller component that controls the appearance, position and content of the hints displayed by the XtraNavBar control.
GetTopLevel() protectedDetermines if the control is a top-level control. Inherited from Control.
GetType()Gets the Type of the current instance. Inherited from Object.
GetViewInfo()Returns the object which contains the internal information used to render the control.
Hide()Conceals the control from the user. Inherited from Control.
HideNavPaneForm()Closes the opened NavPane Form.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
InitLayout() protectedCalled after the control has been added to another container. Inherited from Control.
Invalidate()Invalidates the entire surface of the control and causes the control to be redrawn. Inherited from Control.
Invalidate(Boolean)Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control.
Invalidate(Rectangle, Boolean)Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control.
Invalidate(Rectangle)Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Inherited from Control.
Invalidate(Region, Boolean)Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control.
Invalidate(Region)Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Inherited from Control.
Invoke(Delegate, Object[])Executes the specified delegate, on the thread that owns the control’s underlying window handle, with the specified list of arguments. Inherited from Control.
Invoke(Delegate)Executes the specified delegate on the thread that owns the control’s underlying window handle. Inherited from Control.
InvokeGotFocus(Control, EventArgs) protectedRaises the GotFocus event for the specified control. Inherited from Control.
InvokeLostFocus(Control, EventArgs) protectedRaises the LostFocus event for the specified control. Inherited from Control.
InvokeOnClick(Control, EventArgs) protectedRaises the Click event for the specified control. Inherited from Control.
InvokePaint(Control, PaintEventArgs) protectedRaises the Paint event for the specified control. Inherited from Control.
InvokePaintBackground(Control, PaintEventArgs) protectedRaises the PaintBackground event for the specified control. Inherited from Control.
IsInputChar(Char) protectedDetermines if a character is an input character that the control recognizes. Inherited from Control.
IsInputKey(Keys) protectedDetermines whether the specified key is a regular input key or a special key that requires preprocessing. Inherited from Control.
IsKeyLocked(Keys) staticDetermines whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK key is in effect. Inherited from Control.
IsMnemonic(Char, String) staticDetermines if the specified character is the mnemonic character assigned to the control in the specified string. Inherited from Control.
LayoutChanged()Recalculates look and feel information and forces the control to repaint itself.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
NavPaneShowCollapsedGroupContent()Obsolete. Displays the content of the nav bar control when it is painted using the Navigation Pane style and the nav bar is collapsed.
NotifyInvalidate(Rectangle) protectedRaises the Invalidated event with a specified region of the control to invalidate. Inherited from Control.
OnAutoSizeChanged(EventArgs) protectedRaises the AutoSizeChanged event. Inherited from Control.
OnBackColorChanged(EventArgs) protectedRaises the BackColorChanged event. Inherited from Control.
OnBackgroundImageChanged(EventArgs) protectedRaises the BackgroundImageChanged event. Inherited from Control.
OnBackgroundImageLayoutChanged(EventArgs) protectedRaises the BackgroundImageLayoutChanged event. Inherited from Control.
OnBindingContextChanged(EventArgs) protectedRaises the BindingContextChanged event. Inherited from Control.
OnCausesValidationChanged(EventArgs) protectedRaises the CausesValidationChanged event. Inherited from Control.
OnChangeUICues(UICuesEventArgs) protectedRaises the ChangeUICues event. Inherited from Control.
OnClick(EventArgs) protectedRaises the Click event. Inherited from Control.
OnClientSizeChanged(EventArgs) protectedRaises the ClientSizeChanged event. Inherited from Control.
OnContextMenuChanged(EventArgs) protectedRaises the ContextMenuChanged event. Inherited from Control.
OnContextMenuStripChanged(EventArgs) protectedRaises the ContextMenuStripChanged event. Inherited from Control.
OnControlAdded(ControlEventArgs) protectedRaises the ControlAdded event. Inherited from Control.
OnControlRemoved(ControlEventArgs) protectedRaises the ControlRemoved event. Inherited from Control.
OnCreateControl() protectedRaises the CreateControl() method. Inherited from Control.
OnCursorChanged(EventArgs) protectedRaises the CursorChanged event. Inherited from Control.
OnDockChanged(EventArgs) protectedRaises the DockChanged event. Inherited from Control.
OnDoubleClick(EventArgs) protectedRaises the DoubleClick event. Inherited from Control.
OnEnabledChanged(EventArgs) protectedRaises the EnabledChanged event. Inherited from Control.
OnEnter(EventArgs) protectedRaises the Enter event. Inherited from Control.
OnFontChanged(EventArgs) protectedRaises the FontChanged event. Inherited from Control.
OnForeColorChanged(EventArgs) protectedRaises the ForeColorChanged event. Inherited from Control.
OnGotFocus(EventArgs) protectedRaises the GotFocus event. Inherited from Control.
OnHelpRequested(HelpEventArgs) protectedRaises the HelpRequested event. Inherited from Control.
OnImeModeChanged(EventArgs) protectedRaises the ImeModeChanged event. Inherited from Control.
OnInvalidated(InvalidateEventArgs) protectedRaises the Invalidated event. Inherited from Control.
OnKeyPress(KeyPressEventArgs) protectedRaises the KeyPress event. Inherited from Control.
OnKeyUp(KeyEventArgs) protectedRaises the KeyUp event. Inherited from Control.
OnLayout(LayoutEventArgs) protectedRaises the Layout event. Inherited from Control.
OnLeave(EventArgs) protectedRaises the Leave event. Inherited from Control.
OnLocationChanged(EventArgs) protectedRaises the LocationChanged event. Inherited from Control.
OnLostFocus(EventArgs) protectedRaises the LostFocus event. Inherited from Control.
OnMarginChanged(EventArgs) protectedRaises the MarginChanged event. Inherited from Control.
OnMouseCaptureChanged(EventArgs) protectedRaises the MouseCaptureChanged event. Inherited from Control.
OnMouseClick(MouseEventArgs) protectedRaises the MouseClick event. Inherited from Control.
OnMouseDoubleClick(MouseEventArgs) protectedRaises the MouseDoubleClick event. Inherited from Control.
OnMouseHover(EventArgs) protectedRaises the MouseHover event. Inherited from Control.
OnMove(EventArgs) protectedRaises the Move event. Inherited from Control.
OnNotifyMessage(Message) protectedNotifies the control of Windows messages. Inherited from Control.
OnPaddingChanged(EventArgs) protectedRaises the PaddingChanged event. Inherited from Control.
OnPaintBackground(PaintEventArgs) protectedPaints the background of the control. Inherited from Control.
OnParentBackColorChanged(EventArgs) protectedRaises the BackColorChanged event when the BackColor property value of the control’s container changes. Inherited from Control.
OnParentBackgroundImageChanged(EventArgs) protectedRaises the BackgroundImageChanged event when the BackgroundImage property value of the control’s container changes. Inherited from Control.
OnParentBindingContextChanged(EventArgs) protectedRaises the BindingContextChanged event when the BindingContext property value of the control’s container changes. Inherited from Control.
OnParentCursorChanged(EventArgs) protectedRaises the CursorChanged event. Inherited from Control.
OnParentEnabledChanged(EventArgs) protectedRaises the EnabledChanged event when the Enabled property value of the control’s container changes. Inherited from Control.
OnParentFontChanged(EventArgs) protectedRaises the FontChanged event when the Font property value of the control’s container changes. Inherited from Control.
OnParentForeColorChanged(EventArgs) protectedRaises the ForeColorChanged event when the ForeColor property value of the control’s container changes. Inherited from Control.
OnParentRightToLeftChanged(EventArgs) protectedRaises the RightToLeftChanged event when the RightToLeft property value of the control’s container changes. Inherited from Control.
OnParentVisibleChanged(EventArgs) protectedRaises the VisibleChanged event when the Visible property value of the control’s container changes. Inherited from Control.
OnPreviewKeyDown(PreviewKeyDownEventArgs) protectedRaises the PreviewKeyDown event. Inherited from Control.
OnPrint(PaintEventArgs) protectedRaises the Paint event. Inherited from Control.
OnQueryContinueDrag(QueryContinueDragEventArgs) protectedRaises the QueryContinueDrag event. Inherited from Control.
OnRegionChanged(EventArgs) protectedRaises the RegionChanged event. Inherited from Control.
OnStyleChanged(EventArgs) protectedRaises the StyleChanged event. Inherited from Control.
OnTabIndexChanged(EventArgs) protectedRaises the TabIndexChanged event. Inherited from Control.
OnTabStopChanged(EventArgs) protectedRaises the TabStopChanged event. Inherited from Control.
OnTextChanged(EventArgs) protectedRaises the TextChanged event. Inherited from Control.
OnValidated(EventArgs) protectedRaises the Validated event. Inherited from Control.
OnValidating(CancelEventArgs) protectedRaises the Validating event. Inherited from Control.
OnVisibleChanged(EventArgs) protectedRaises the VisibleChanged event. Inherited from Control.
PerformLayout()Forces the control to apply layout logic to all its child controls. Inherited from Control.
PerformLayout(Control, String)Forces the control to apply layout logic to all its child controls. Inherited from Control.
PointToClient(Point)Computes the location of the specified screen point into client coordinates. Inherited from Control.
PointToScreen(Point)Computes the location of the specified client point into screen coordinates. Inherited from Control.
PreProcessControlMessage(Message)Preprocesses keyboard or input messages within the message loop before they are dispatched. Inherited from Control.
PreProcessMessage(Message)Preprocesses keyboard or input messages within the message loop before they are dispatched. Inherited from Control.
ProcessCmdKey(Message, Keys) protectedProcesses a command key. Inherited from Control.
ProcessDialogChar(Char) protectedProcesses a dialog character. Inherited from Control.
ProcessDialogKey(Keys) protectedProcesses a dialog key. Inherited from Control.
ProcessKeyEventArgs(Message) protectedProcesses a key message and generates the appropriate control events. Inherited from Control.
ProcessKeyMessage(Message) protectedProcesses a keyboard message. Inherited from Control.
ProcessKeyPreview(Message) protectedPreviews a keyboard message. Inherited from Control.
ProcessMnemonic(Char) protectedProcesses a mnemonic character. Inherited from Control.
RaiseDragEvent(Object, DragEventArgs) protectedRaises the appropriate drag event. Inherited from Control.
RaiseKeyEvent(Object, KeyEventArgs) protectedRaises the appropriate key event. Inherited from Control.
RaiseMouseEvent(Object, MouseEventArgs) protectedRaises the appropriate mouse event. Inherited from Control.
RaisePaintEvent(Object, PaintEventArgs) protectedRaises the appropriate paint event. Inherited from Control.
RecreateHandle() protectedForces the re-creation of the handle for the control. Inherited from Control.
RectangleToClient(Rectangle)Computes the size and location of the specified screen rectangle in client coordinates. Inherited from Control.
RectangleToScreen(Rectangle)Computes the size and location of the specified client rectangle in screen coordinates. Inherited from Control.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
ReflectMessage(IntPtr, Message) protected staticReflects the specified message to the control that is bound to the specified handle. Inherited from Control.
Refresh()Forces the control to invalidate its client area and immediately redraw itself and any child controls. Inherited from Control.
ResetBackColor()Resets the BackColor property to its default value. Inherited from Control.
ResetBindings()Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values. Inherited from Control.
ResetCursor()Resets the Cursor property to its default value. Inherited from Control.
ResetFont()Resets the Font property to its default value. Inherited from Control.
ResetForeColor()Resets the ForeColor property to its default value. Inherited from Control.
ResetImeMode()Resets the ImeMode property to its default value. Inherited from Control.
ResetMouseEventArgs() protectedResets the control to handle the MouseLeave event. Inherited from Control.
ResetRightToLeft()Resets the RightToLeft property to its default value. Inherited from Control.
ResetStyles()Restores the control’s styles to the default state.
ResetText()Resets the Text property to its default value (Empty). Inherited from Control.
RestoreCursor()Sets the mouse cursor to the type specified by the NavBarControl.Cursor property.
RestoreFromJson(Stream)Loads the NavBar’s layout from a file in JSON format.
RestoreFromRegistry(String)Restores the control layout stored at a specified system registry path.
RestoreFromStream(Stream)Loads a control’s layout from a stream.
RestoreFromXml(String)Loads a control’s layout from a specified XML file.
ResumeLayout()Resumes usual layout logic. Inherited from Control.
ResumeLayout(Boolean)Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. Inherited from Control.
RtlTranslateAlignment(ContentAlignment) protectedConverts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. Inherited from Control.
RtlTranslateAlignment(HorizontalAlignment) protectedConverts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. Inherited from Control.
RtlTranslateAlignment(LeftRightAlignment) protectedConverts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. Inherited from Control.
RtlTranslateContent(ContentAlignment) protectedConverts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. Inherited from Control.
RtlTranslateHorizontal(HorizontalAlignment) protectedConverts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. Inherited from Control.
RtlTranslateLeftRight(LeftRightAlignment) protectedConverts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. Inherited from Control.
SaveToJson(Stream)Saves the control’s layout to a JSON object.
SaveToRegistry(String)Saves the control’s layout to the specified system registry path.
SaveToStream(Stream)Saves the control’s layout to a stream.
SaveToXml(String)Saves a control’s layout to a specified XML file.
Scale(SizeF)Scales the control and all child controls by the specified scaling factor. Inherited from Control.
Scale(Single, Single)Scales the entire control and any child controls. Inherited from Control.
Scale(Single)Scales the control and any child controls. Inherited from Control.
ScaleCore(Single, Single) protectedThis method is not relevant for this class. Inherited from Control.
Select()Activates the control. Inherited from Control.
Select(Boolean, Boolean) protectedActivates a child control. Optionally specifies the direction in the tab order to select the control from. Inherited from Control.
SelectNextControl(Control, Boolean, Boolean, Boolean, Boolean)Activates the next control. Inherited from Control.
SendToBack()Sends the control to the back of the z-order. Inherited from Control.
SetAutoSizeMode(AutoSizeMode) protectedSets a value indicating how a control will behave when its AutoSize property is enabled. Inherited from Control.
SetBounds(Int32, Int32, Int32, Int32, BoundsSpecified)Sets the specified bounds of the control to the specified location and size. Inherited from Control.
SetBounds(Int32, Int32, Int32, Int32)Sets the bounds of the control to the specified location and size. Inherited from Control.
SetClientSizeCore(Int32, Int32) protectedSets the size of the client area of the control. Inherited from Control.
SetCursor(Cursor)Sets the mouse pointer type when it is over the control.
SetStyle(ControlStyles, Boolean) protectedSets a specified ControlStyles flag to either true or false. Inherited from Control.
SetTopLevel(Boolean) protectedSets the control as the top-level control. Inherited from Control.
SetVisibleCore(Boolean) protectedSets the control to the specified visible state. Inherited from Control.
Show()Displays the control to the user. Inherited from Control.
ShowNavPaneForm()Shows the NavPane Form. This method is in effect if the Navigation Pane View is applied.
SizeFromClientSize(Size) protectedDetermines the size of the entire control from the height and width of its client area. Inherited from Control.
SuspendLayout()Temporarily suspends the layout logic for the control. Inherited from Control.
IDropTarget.OnDragDrop(DragEventArgs)Raises the DragDrop event. Inherited from Control.
IDropTarget.OnDragEnter(DragEventArgs)Raises the DragEnter event. Inherited from Control.
IDropTarget.OnDragLeave(EventArgs)Raises the DragLeave event. Inherited from Control.
IDropTarget.OnDragOver(DragEventArgs)Raises the DragOver event. Inherited from Control.
ToString()Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.
Update()Causes the control to redraw the invalidated regions within its client area. Inherited from Control.
UpdateBounds() protectedUpdates the bounds of the control with the current size and location. Inherited from Control.
UpdateBounds(Int32, Int32, Int32, Int32, Int32, Int32) protectedUpdates the bounds of the control with the specified size, location, and client size. Inherited from Control.
UpdateBounds(Int32, Int32, Int32, Int32) protectedUpdates the bounds of the control with the specified size and location. Inherited from Control.
UpdateSelectedLink()Updates the selected link in the active group.
UpdateStyles() protectedForces the assigned styles to be reapplied to the control. Inherited from Control.
UpdateZOrder() protectedUpdates the control in its parent’s z-order. Inherited from Control.

Events

NameDescription
ActiveGroupChangedFires when the active group changes.
AutoSizeChangedThis event is not relevant for this class. Inherited from Control.
BackColorChangedOccurs when the value of the BackColor property changes. Inherited from Control.
BackgroundImageChangedOccurs when the value of the BackgroundImage property changes. Inherited from Control.
BackgroundImageLayoutChangedOccurs when the BackgroundImageLayout property changes. Inherited from Control.
BeforeLoadLayoutOccurs before a layout is restored from storage (a stream, xml file or the system registry).
BindingContextChangedOccurs when the value of the BindingContext property changes. Inherited from Control.
CalcHintSizeAllows you to assign a custom hint size before a hint is displayed in the VSToolBoxView paint style.
CausesValidationChangedOccurs when the value of the CausesValidation property changes. Inherited from Control.
ChangeUICuesOccurs when the focus or keyboard user interface (UI) cues change. Inherited from Control.
ClickOccurs when the control is clicked. Inherited from Control.
ClientSizeChangedOccurs when the value of the ClientSize property changes. Inherited from Control.
ContextMenuChangedOccurs when the value of the ContextMenu property changes. Inherited from Control.
ContextMenuStripChangedOccurs when the value of the ContextMenuStrip property changes. Inherited from Control.
ControlAddedOccurs when a new control is added to the Control.ControlCollection. Inherited from Control.
ControlRemovedOccurs when a control is removed from the Control.ControlCollection. Inherited from Control.
CursorChangedOccurs when the value of the Cursor property changes. Inherited from Control.
CustomDrawBackgroundProvides the capability to custom paint the control’s background.
CustomDrawGroupCaptionProvides the ability to perform custom painting of group captions.
CustomDrawGroupClientBackgroundProvides the ability to perform custom painting of group client areas.
CustomDrawGroupClientForegroundProvides the ability to perform custom painting of a group client area’s foreground.
CustomDrawHintProvides the capability to perform custom painting of hints in the VSToolBoxView paint style.
CustomDrawLinkProvides the ability to perform custom painting of links.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DockChangedOccurs when the value of the Dock property changes. Inherited from Control.
DoubleClickOccurs when the control is double-clicked. Inherited from Control.
DragDropOccurs when a drag-and-drop operation is completed. Inherited from Control.
DragEnterOccurs when an object is dragged into the control’s bounds. Inherited from Control.
DragLeaveOccurs when an object is dragged out of the control’s bounds. Inherited from Control.
DragOverOccurs when an object is dragged over the control’s bounds. Inherited from Control.
EnabledChangedOccurs when the Enabled property value has changed. Inherited from Control.
EnterOccurs when the control is entered. Inherited from Control.
FontChangedOccurs when the Font property value changes. Inherited from Control.
ForeColorChangedOccurs when the ForeColor property value changes. Inherited from Control.
GetHintAllows hints to be customized dynamically.
GiveFeedbackOccurs during a drag operation. Inherited from Control.
GotFocusOccurs when the control receives focus. Inherited from Control.
GroupCollapsedFires immediately after a group has been collapsed.
GroupCollapsingOccurs when a group is about to be collapsed.
GroupExpandedFires immediately after a group has been expanded.
GroupExpandingOccurs when a group is about to be expanded.
HandleCreatedOccurs when a handle is created for the control. Inherited from Control.
HandleDestroyedOccurs when the control’s handle is in the process of being destroyed. Inherited from Control.
HelpRequestedOccurs when the user requests help for a control. Inherited from Control.
HotTrackedLinkChangedFires when the mouse pointer either enters or leaves a link area.
ImeModeChangedOccurs when the ImeMode property has changed. Inherited from Control.
InvalidatedOccurs when a control’s display requires redrawing. Inherited from Control.
KeyDownOccurs when a key is pressed while the control has focus. Inherited from Control.
KeyPressOccurs when a character. space or backspace key is pressed while the control has focus. Inherited from Control.
KeyUpOccurs when a key is released while the control has focus. Inherited from Control.
LayoutOccurs when a control should reposition its child controls. Inherited from Control.
LayoutUpgradeOccurs after a layout whose version doesn’t match the current layout version has been loaded from a stream, xml file or system registry.
LeaveOccurs when the input focus leaves the control. Inherited from Control.
LinkClickedFires immediately after a link has been clicked.
LinkPressedFires immediately after a link has been pressed.
LocationChangedOccurs when the Location property value has changed. Inherited from Control.
LostFocusOccurs when the control loses focus. Inherited from Control.
MarginChangedOccurs when the control’s margin changes. Inherited from Control.
MouseCaptureChangedOccurs when the control loses mouse capture. Inherited from Control.
MouseClickOccurs when the control is clicked by the mouse. Inherited from Control.
MouseDoubleClickOccurs when the control is double clicked by the mouse. Inherited from Control.
MouseDownOccurs when the mouse pointer is over the control and a mouse button is pressed. Inherited from Control.
MouseEnterOccurs when the mouse pointer enters the control. Inherited from Control.
MouseHoverOccurs when the mouse pointer rests on the control. Inherited from Control.
MouseLeaveOccurs when the mouse pointer leaves the control. Inherited from Control.
MouseMoveOccurs when the mouse pointer is moved over the control. Inherited from Control.
MouseUpOccurs when the mouse pointer is over the control and a mouse button is released. Inherited from Control.
MouseWheelOccurs when the mouse wheel moves while the control has focus. Inherited from Control.
MoveOccurs when the control is moved. Inherited from Control.
NavDragDropFires immediately after a link has been dropped.
NavDragOverFires repeatedly when a link is being dragged and is allowed to be dropped.
NavPaneMinimizedGroupFormShowingOccurs when a minimized NavBarGroup within a Navigation Pane View is expanded.
NavPaneOptionsApplyGroupFontAllows you to apply a font to a group after font settings have been changed by an end-user via the Navigation Pane Options dialog.
NavPaneOptionsCanEditGroupFontAllows you to specify whether an end-user can edit font settings for individual groups via the Navigation Pane Options dialog.
NavPaneOptionsResetFires when the Reset button in the Navigation Pane Options dialog is clicked.
NavPaneStateChangedFires after the NavBarControl’s expansion state has been changed (in the NavigationPane paint style).
PaddingChangedOccurs when the control’s padding changes. Inherited from Control.
PaintOccurs when the control is redrawn. Inherited from Control.
ParentChangedOccurs when the Parent property value changes. Inherited from Control.
PreviewKeyDownOccurs before the KeyDown event when a key is pressed while focus is on this control. Inherited from Control.
QueryAccessibilityHelpOccurs when AccessibleObject is providing help to accessibility applications. Inherited from Control.
QueryContinueDragOccurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. Inherited from Control.
RegionChangedOccurs when the value of the Region property changes. Inherited from Control.
ResizeOccurs when the control is resized. Inherited from Control.
RightToLeftChangedOccurs when the RightToLeft property value changes. Inherited from Control.
SelectedLinkChangedFires immediately after a link has been selected.
SizeChangedOccurs when the Size property value changes. Inherited from Control.
StyleChangedOccurs when the control style changes. Inherited from Control.
SystemColorsChangedOccurs when the system colors change. Inherited from Control.
TabIndexChangedOccurs when the TabIndex property value changes. Inherited from Control.
TabStopChangedOccurs when the TabStop property value changes. Inherited from Control.
TextChangedOccurs when the Text property value changes. Inherited from Control.
ValidatedOccurs when the control is finished validating. Inherited from Control.
ValidatingOccurs when the control is validating. Inherited from Control.
VisibleChangedOccurs when the Visible property value changes. Inherited from Control.

See Also

NavBarControl Class

DevExpress.XtraNavBar Namespace