Back to Devexpress

NavBarControl Methods

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

latest82.4 KB
Original Source

NavBarControl Methods

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

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.

See Also

NavBarControl Class

NavBarControl Members

DevExpress.XtraNavBar Namespace