Back to Devexpress

DockPanel Members

windowsforms-devexpress-dot-xtrabars-dot-docking-dot-dockpanel-dot-underscore-members.md

latest165.9 KB
Original Source

DockPanel Members

Represents a dock panel.

Constructors

NameDescription
DockPanel()Initializes a new instance of the DockPanel class.

Fields

NameDescription
OptimizeBoundsCalculation staticThis member supports the internal infrastructure and is not intended to be used directly from your code.
ScrollStateAutoScrolling protected staticDetermines the value of the AutoScroll property. Inherited from ScrollableControl.
ScrollStateFullDrag protected staticDetermines whether the user has enabled full window drag. Inherited from ScrollableControl.
ScrollStateHScrollVisible protected staticDetermines whether the value of the HScroll property is set to true. Inherited from ScrollableControl.
ScrollStateUserHasScrolled protected staticDetermines whether the user had scrolled through the ScrollableControl control. Inherited from ScrollableControl.
ScrollStateVScrollVisible protected staticDetermines whether the value of the VScroll property is set to true. Inherited from ScrollableControl.

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.
ActivateOnContentFocusWhenAutoHiddenGets or sets whether this auto-hide DockPanel should be activated when an end-user focuses its content.
ActiveChildGets or sets the currently active child dock panel.
ActiveChildIndexGets or sets the index of the currently active child dock panel.
ActiveControlGets or sets the active control on the container control. Inherited from ContainerControl.
ActualImageReturns the image this panel currently shows.
AllowBorderColorBlendingGets or sets whether to colorize the dock panel’s caption and border according to the Appearance.BorderColor setting in skinning paint schemes (only in legacy background skinning mode).
AllowCustomHeaderButtonsGlyphSkinningGets or sets whether Custom Header Button icons should be painted according to the currently applied skin. This property is obsolete. Use the DockPanel.ImageOptions.AllowCustomHeaderButtonsGlyphSkinning property instead.
AllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
AllowGlyphSkinningGets or sets whether the current DockPanel icon should be painted in this panel’s foreground color. This property is obsolete. Use the DockPanel.ImageOptions.AllowGlyphSkinning property instead.
AllowTouchGestures

Gets or sets whether this DockPanel should process user gestures when the app runs on touch-enabled devices. Dock Panels support “Press and Tap” and “Two-Finger Tap” gestures.

| | Anchor | Gets 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. | | Appearance | Specifies appearance settings of the dock panel’s client region. | | AutoScaleDimensions | Gets or sets the dimensions that the control was designed to. Inherited from ContainerControl. | | AutoScaleFactor protected | Gets the scaling factor between the current and design-time automatic scaling dimensions. Inherited from ContainerControl. | | AutoScaleMode | Gets or sets the automatic scaling mode of the control. Inherited from ContainerControl. | | AutoScroll | This is an internal property that should not be used in your code. | | AutoScrollMargin | Gets or sets the size of the auto-scroll margin. Inherited from ScrollableControl. | | AutoScrollMinSize | Gets or sets the minimum size of the auto-scroll. Inherited from ScrollableControl. | | AutoScrollOffset | Gets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control. | | AutoScrollPosition | Gets or sets the location of the auto-scroll position. Inherited from ScrollableControl. | | AutoSize | This property is not relevant for this class. Inherited from Control. | | AutoValidate | Gets or sets a value that indicates whether controls in this container will be automatically validated when the focus changes. Inherited from ContainerControl. | | BackColor | Gets or sets the panel’s background color. | | BackgroundImage | Gets or sets the background image displayed in the control. Inherited from Control. | | BackgroundImageLayout | Gets or sets the background image layout as defined in the ImageLayout enumeration. Inherited from Control. | | BindingContext | Gets the BindingContext object for the current panel. | | Bottom | Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control. | | Bounds | Gets or sets the dock panel’s size and location. | | CanActivate | Indicates whether a dock panel can be activated. | | CanEnableIme protected | Gets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from ContainerControl. | | CanFocus | Gets a value indicating whether the control can receive focus. Inherited from Control. | | CanRaiseEvents protected | Determines if events can be raised on the control. Inherited from Control. | | CanSelect | Gets a value indicating whether the control can be selected. Inherited from Control. | | Capture | Gets or sets a value indicating whether the control has captured the mouse. Inherited from Control. | | CausesValidation | Gets 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 static | Gets 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. | | ChildPanelOrientation | For internal use. | | ClientRectangle | Gets the rectangle that represents the client area of the control. Inherited from Control. | | ClientSize | Gets or sets the height and width of the client area of the control. Inherited from Control. | | CompanyName | Gets the name of the company or creator of the application containing the control. Inherited from Control. | | Container | Gets the IContainer that contains the Component. Inherited from Component. | | ContainsFocus | Gets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control. | | ContextMenu | Gets or sets the shortcut menu associated with the control. Inherited from Control. | | ContextMenuStrip | Gets or sets the ContextMenuStrip associated with this control. Inherited from Control. | | ControlContainer | Gets the control container representing the dock panel’s client area when this panel does not contain other dock panels. | | Controls | Gets the collection of controls contained within the control. Inherited from Control. | | Count | Gets the number of dock panels the current dock panel owns. | | Created | Gets a value indicating whether the control has been created. Inherited from Control. | | CreateParams protected | Gets the required creation parameters when the control handle is created. Inherited from ContainerControl. | | CurrentAutoScaleDimensions | Gets the current run-time dimensions of the screen. Inherited from ContainerControl. | | Cursor | Gets or sets the cursor that is displayed when the mouse pointer is over the control. Inherited from Control. | | CustomHeaderButtons | Gets all custom header buttons used within the current DockPanel. | | DataBindings | Gets the data bindings for the control. Inherited from Control. | | DefaultBackColor static | Gets the default background color of the control. Inherited from Control. | | DefaultCursor protected | Gets or sets the default cursor for the control. Inherited from Control. | | DefaultFont static | Gets the default font of the control. Inherited from Control. | | DefaultForeColor static | Gets the default foreground color of the control. Inherited from Control. | | DefaultImeMode protected | Gets the default Input Method Editor (IME) mode supported by the control. Inherited from Control. | | DefaultMargin protected | Gets the space, in pixels, that is specified by default between controls. Inherited from Control. | | DefaultMaximumSize protected | Gets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control. | | DefaultMinimumSize protected | Gets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control. | | DefaultPadding protected | Gets the internal spacing, in pixels, of the contents of a control. Inherited from Control. | | DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. | | DisplayRectangle | Gets the rectangle that represents the virtual display area of the control. Inherited from ScrollableControl. | | Disposing | Gets a value indicating whether the base Control class is in the process of disposing. Inherited from Control. | | Dock | Gets or sets a value specifying how the dock panel is aligned within its parent control. | | DockedAsTabbedDocument | Gets or sets whether the DockPanel is displayed as a tab within a Tabbed UI, created using the DocumentManager component. | | DockLevel | Gets a value indicating the nesting level of the dock panel. | | DockManager | Gets the DockManager which coordinates any docking operations performed on the current panel. | | DockPadding | Gets the dock padding settings for all edges of the control. Inherited from ScrollableControl. | | DockVertical | Gets or sets whether the current panel’s children should be arranged vertically or horizontally when the panel is docked to a form/user control. | | DoubleBuffered protected | Gets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control. | | Enabled | Gets or sets a value indicating whether the control can respond to user interaction. Inherited from Control. | | Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. | | FloatForm | Gets the floating form which the panel resides on. | | FloatFormRestoreBounds | For internal use. | | FloatFormWindowState | For internal use. | | FloatLocation | Gets or sets the floating panel’s location. | | FloatSize | Gets or sets the size of the panel when it is floating. | | FloatVertical | Gets or sets whether the current panel’s children should be arranged vertically or horizontally when the panel is floated. | | Focused | Gets a value indicating whether the control has input focus. Inherited from Control. | | Font | Gets or sets the font of the text displayed by the control. Inherited from Control. | | FontHeight protected | Gets or sets the height of the font of the control. Inherited from Control. | | Footer | Gets or sets the current DockPanel‘s footer. | | ForeColor | Gets or sets the foreground color of the control. Inherited from Control. | | Handle | Gets the window handle that the control is bound to. Inherited from Control. | | HasChildren | Gets a value indicating whether the control contains one or more child controls. Inherited from Control. | | Header | Gets or sets the current DockPanel‘s header. | | Height | Gets or sets the height of the control. Inherited from Control. | | Hint | Gets or sets the dock panel’s hint text. | | HorizontalScroll | Gets the characteristics associated with the horizontal scroll bar. Inherited from ScrollableControl. | | HScroll protected | Gets or sets a value indicating whether the horizontal scroll bar is visible. Inherited from ScrollableControl. | | ID | Gets or sets the dock panel’s unique identifier. | | Image | Gets or sets the current DockPanel‘s icon. This property is obsolete. Use the DockPanel.ImageOptions.Image property instead. | | ImageIndex | Gets or sets the index of an image associated with the dock panel. This property is obsolete. Use the DockPanel.ImageOptions.ImageIndex property instead. | | ImageOptions | Provides access to properties that allow you to set up raster and vector images for this panel. | | Images | Gets the image source for dock panels. | | ImageUri | Gets or sets an image stored within the DevExpress Image Gallery that should be assigned to this DockPanel. This property is obsolete. Use the DockPanel.ImageOptions.ImageUri property instead. | | ImeMode | Gets or sets the Input Method Editor (IME) mode of the control. Inherited from Control. | | ImeModeBase protected | Gets or sets the IME mode of a control. Inherited from Control. | | Index | Gets or sets the position of the dock panel within the owning collection. | | InvokeRequired | Gets 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. | | IsAccessible | Gets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control. | | IsDisposed | Gets a value indicating whether the control has been disposed of. Inherited from Control. | | IsHandleCreated | Gets a value indicating whether the control has a handle associated with it. Inherited from Control. | | IsMdiDocument | Gets whether the panel is docked to a DocumentManager‘s TabbedView. | | IsMirrored | Gets a value indicating whether the control is mirrored. Inherited from Control. | | IsTab | Gets whether the current panel belongs to a tab container. | | Item[Int32] | Provides indexed access to the child panels of the current panel. | | LayoutEngine | Gets a cached instance of the control’s layout engine. Inherited from Control. | | Left | Gets 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. | | Location | Gets or sets the dock panel’s location. | | Margin | Gets or sets the space between controls. Inherited from Control. | | MaximumSize | Gets the control’s maximum size. This property is not supported. | | MinimumSize | Gets the control’s minimum size. This property is not supported. | | ModifierKeys static | Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control. | | MouseButtons static | Gets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control. | | MousePosition static | Gets the position of the mouse cursor in screen coordinates. Inherited from Control. | | Name | Gets or sets the name of the control. Inherited from Control. | | Options | Provides access to the dock panel’s settings. | | OriginalSize | This member supports the internal infrastructure and is not intended to be used directly from your code.. | | Padding | Gets or sets padding within the control. Inherited from Control. | | Parent | Gets or sets the parent container of the control. Inherited from Control. | | ParentAutoHideContainer | Gets the auto-hide container which displays the panel’s label when its automatic hiding functionality is enabled. | | ParentForm | Gets the form that the container control is assigned to. Inherited from ContainerControl. | | ParentPanel | Gets the immediate parent panel of the current panel. | | PreferredSize | Gets the size of a rectangular area into which the control can fit. Inherited from Control. | | ProductName | Gets the product name of the assembly containing the control. Inherited from Control. | | ProductVersion | Gets the version of the assembly containing the control. Inherited from Control. | | PropagatingImeMode protected static | Gets an object that represents a propagating IME mode. Inherited from Control. | | RecreatingHandle | Gets a value indicating whether the control is currently re-creating its handle. Inherited from Control. | | Region | Gets or sets the window region associated with the control. Inherited from Control. | | RenderRightToLeft protected | This property is now obsolete. Inherited from Control. | | ResizeRedraw protected | Gets or sets a value indicating whether the control redraws itself when resized. Inherited from Control. | | Right | Gets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control. | | RightToLeft | Gets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control. | | RootPanel | Gets the root panel of the current panel. | | SavedDock | Gets or sets the docking style applied to a panel before it’s made to float or is hidden. | | SavedDockingContainerId | | | SavedIndex | Gets or sets the panel’s index before it’s made to float or is hidden. | | SavedMdiDocument | Gets or sets whether the panel was docked in a DocumentManager, before it was made floating or hidden. | | SavedMdiDocumentIndex | | | SavedParent | Gets or sets the panel’s parent before it’s made to float or is hidden. | | SavedSizeFactor | Returns the panel scale factor. This property is used by the Workspace Manager component to correctly save and restore dock panels. Normally, you should not modify this setting manually. | | SavedTabbed | Gets or sets a value indicating whether the panel was a tab container, before it was made to float or was hidden. | | ScaleChildren protected | Gets a value that determines the scaling of child controls. Inherited from Control. | | ShowFocusCues protected | Gets a value indicating whether the control should display focus rectangles. Inherited from Control. | | ShowKeyboardCues protected | Gets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control. | | Site | Gets or sets the site of the control. Inherited from Control. | | Size | Gets or sets the dock panel’s size. | | State | Gets the dock panel’s current state. | | Tabbed | Gets or sets whether the current panel represents a tab container. | | TabIndex | Gets or sets the tab order of the control within its container. Inherited from ZIndexControl. | | TabsPosition | Gets or sets the position of tabs. | | TabsScroll | Specifies whether tab navigation buttons are displayed when tabs don’t fit into the tab container‘s width/height. | | TabStop | Gets or sets a value indicating whether the user can give the focus to this control using the TAB key. Inherited from Control. | | TabText | Gets or sets the panel’s short caption. | | Tag | Gets or sets the object that contains data about the control. Inherited from Control. | | Text | Gets or sets the dock panel’s caption. | | Top | Gets 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. | | TopLevelControl | Gets 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. | | UseWaitCursor | Gets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control. | | VerticalScroll | Gets the characteristics associated with the vertical scroll bar. Inherited from ScrollableControl. | | Visibility | Gets or sets the panel’s visible state. | | Visible | Gets or sets whether the dock panel is visible. | | VScroll protected | Gets or sets a value indicating whether the vertical scroll bar is visible. Inherited from ScrollableControl. | | Width | Gets or sets the width of the control. Inherited from Control. | | WindowTarget | This property is not relevant for this class. Inherited from Control. | | XtraActiveChildID | Gets the index of the currently active child dock panel. | | XtraAutoHideContainerDock | Gets a value specifying how the auto hide container is aligned within its parent control. | | XtraBounds | Gets or sets the dock panel’s bounds. | | XtraID | Gets the dock panel’s index. | | XtraParentID | Gets the index of the dock panel’s parent panel. | | XtraSavedParentID | Gets the index of the panel’s parent before it’s made to float or is hidden. | | XtraZIndex | Gets or sets the index of the control within its parent control’s collection. Inherited from ZIndexControl. |

Methods

NameDescription
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.
AddPanel()Creates a new dock panel and docks it to the current dock panel.
AdjustFormScrollbars(Boolean) protectedAdjusts the scroll bars on the container based on the current control positions and the control currently selected. Inherited from ContainerControl.
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.
BringToFront()Brings the control to the front of the z-order. Inherited from Control.
Close()Imitates a click on the panel’s close button.
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.
CreateHandle() protectedCreates a handle 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.
DockAsMdiDocument()Docks the panel to a DocumentManager located in the same form as the current DockManager.
DockAsMdiDocument(Boolean)Docks the panel to a DocumentManager located in the same form as the current DockManager and optionally activates this panel.
DockAsTab(DockPanel, Int32)Creates a tab which contains the current panel at the specified position within the target tab container. The target tab container is created if required.
DockAsTab(DockPanel)Appends a tab containing the current panel to the target tab container. The target tab container is created if necessary.
DockTo(DockingStyle, Int32)Docks the current panel to the form (user control) at the specified position using the specified style.
DockTo(DockingStyle)Docks the current panel to the form (or user control) using the specified style.
DockTo(DockManager, DockingStyle, Int32)Obsolete. This method is not supported.
DockTo(DockManager, DockingStyle)Obsolete. This method is not supported.
DockTo(DockPanel, DockingStyle, Int32)Docks the current panel on the form (user control) to the specified panel at the specified position using the specified style.
DockTo(DockPanel, DockingStyle)Docks the current panel to the specified panel using the specified style.
DockTo(DockPanel, Int32)Docks the current panel to the specified panel in the specified position.
DockTo(DockPanel)Docks the current panel to the specified panel.
DoDragDrop(Object, DragDropEffects)Begins a drag-and-drop operation. Inherited from Control.
DrawToBitmap(Bitmap, Rectangle)Supports rendering to the specified bitmap. Inherited from Control.
EndInvoke(IAsyncResult)Retrieves the return value of the asynchronous operation represented by the IAsyncResult passed. Inherited from Control.
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.
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.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetHitInfo(Point)Returns information about the panel’s element located at the specified point.
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.
GetScrollState(Int32) protectedDetermines whether the specified flag has been set. Inherited from ScrollableControl.
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.
GetTopLevel() protectedDetermines if the control is a top-level control. Inherited from Control.
GetType()Gets the Type of the current instance. Inherited from Object.
HasAsChild(DockPanel)Indicates whether the dock panel contains the specified child panel.
HasAsParent(DockPanel)Indicates whether the current panel has the specified panel as its parent.
Hide()Hides the panel.
HideImmediately()Hides the current auto-hidden panel immediately without a sliding animation effect.
HideSliding()Hides the current auto-hidden dock panel using a sliding animation effect.
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.
MakeFloat()Floats the current dock panel.
MakeFloat(Point)Floats the current dock panel at the specified position.
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.
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.
OnAutoValidateChanged(EventArgs) protectedRaises the AutoValidateChanged event. Inherited from ContainerControl.
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.
OnCursorChanged(EventArgs) protectedRaises the CursorChanged event. Inherited from Control.
OnDockChanged(EventArgs) protectedRaises the DockChanged event. Inherited from Control.
OnDragEnter(DragEventArgs) protectedRaises the DragEnter event. Inherited from Control.
OnDragLeave(EventArgs) protectedRaises the DragLeave 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 ContainerControl.
OnForeColorChanged(EventArgs) protectedRaises the ForeColorChanged event. Inherited from Control.
OnGiveFeedback(GiveFeedbackEventArgs) protectedRaises the GiveFeedback 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.
OnLayout(LayoutEventArgs) protectedRaises the Layout event. Inherited from ContainerControl.
OnLocationChanged(EventArgs) protectedRaises the LocationChanged 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.
OnMouseWheel(MouseEventArgs) protectedRaises the MouseWheel event. Inherited from ScrollableControl.
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 ScrollableControl.
OnPaintBackground(PaintEventArgs) protectedPaints the background of the control. Inherited from ScrollableControl.
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.
OnScroll(ScrollEventArgs) protectedRaises the Scroll event. Inherited from ScrollableControl.
OnSizeChanged(EventArgs) protectedRaises the SizeChanged event. Inherited from Control.
OnStyleChanged(EventArgs) protectedRaises the StyleChanged event. Inherited from Control.
OnSystemColorsChanged(EventArgs) protectedRaises the SystemColorsChanged event. Inherited from Control.
OnTabIndexChanged(EventArgs) protectedRaises the TabIndexChanged event. Inherited from Control.
OnTabStopChanged(EventArgs) protectedRaises the TabStopChanged event. Inherited from Control.
OnValidated(EventArgs) protectedRaises the Validated event. Inherited from Control.
OnValidating(CancelEventArgs) protectedRaises the Validating event. Inherited from Control.
PerformAutoScale()Performs scaling of the container control and its children. Inherited from ContainerControl.
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 ContainerControl.
ProcessDialogChar(Char) protectedProcesses a dialog character. Inherited from ContainerControl.
ProcessDialogKey(Keys) protectedProcesses a dialog key. Inherited from ContainerControl.
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 ContainerControl.
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.
Register(DockManager)Registers the dock panel.
RemovePanel(DockPanel)Destroys the specified child panel.
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.
ResetText()Resets the Text property to its default value (Empty). Inherited from Control.
Restore()Restores the panel to its previous docking position.
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.
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.
ScrollControlIntoView(Control)Scrolls the specified child control into view on an auto-scroll enabled control. Inherited from ScrollableControl.
ScrollToControl(Control) protectedCalculates the scroll offset to the specified child control. Inherited from ScrollableControl.
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 ContainerControl.
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.
SetAutoScrollMargin(Int32, Int32)Sets the size of the auto-scroll margins. Inherited from ScrollableControl.
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.
SetDisplayRectLocation(Int32, Int32) protectedPositions the display window to the specified value. Inherited from ScrollableControl.
SetScrollState(Int32, Boolean) protectedSets the specified scroll state flag. Inherited from ScrollableControl.
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 and activates the panel.
ShowSliding()Shows the auto-hidden dock panel using a sliding animation effect.
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.
IContainerControl.ActivateControl(Control)Activates the specified control. Inherited from ContainerControl.
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.
UpdateDefaultButton() protectedWhen overridden by a derived class, updates which button is the default button. Inherited from ContainerControl.
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.
Validate()Verifies the value of the control losing focus by causing the Validating and Validated events to occur, in that order. Inherited from ContainerControl.
Validate(Boolean)Verifies the value of the control that is losing focus; conditionally dependent on whether automatic validation is turned on. Inherited from ContainerControl.
ValidateChildren()Causes all of the child controls within a control that support validation to validate their data. Inherited from ContainerControl.
ValidateChildren(ValidationConstraints)Causes all of the child controls within a control that support validation to validate their data. Inherited from ContainerControl.

Events

NameDescription
ActiveChildChangedFires after the panel’s active child has been changed.
AutoSizeChangedThis event is not relevant for this class. Inherited from Control.
AutoValidateChangedOccurs when the AutoValidate property changes. Inherited from ContainerControl.
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.
BindingContextChangedOccurs when the value of the BindingContext property changes. Inherited from Control.
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.
ClosedPanelOccurs after the current panel has been closed.
ClosingPanelOccurs before the current panel is closed.
CollapsedOccurs when the current auto-hidden DockPanel is hidden.
CollapsingOccurs when the current auto-hidden DockPanel is about to hide.
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.
CreateResizeZoneAllows you to prevent the current dock panel form being resized using the mouse at specific borders and corners.
CursorChangedOccurs when the value of the Cursor property changes. Inherited from Control.
CustomButtonCheckedFires when a custom header button is checked.
CustomButtonClickFires on a regular (push) custom header button click.
CustomButtonUncheckedFires when a custom header button is unchecked.
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.
ExpandedOccurs when the current auto-hide DockPanel is completely displayed.
ExpandingOccurs when the current auto-hide DockPanel is about to be displayed.
FontChangedOccurs when the Font property value changes. Inherited from Control.
ForeColorChangedOccurs when the ForeColor property value changes. Inherited from Control.
GiveFeedbackOccurs during a drag operation. Inherited from Control.
GotFocusOccurs when the control receives focus. Inherited from Control.
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.
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.
LeaveOccurs when the input focus leaves the control. Inherited from Control.
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.
PaddingChangedOccurs when the control’s padding changes. Inherited from Control.
PaintOccurs when the control is redrawn. Inherited from Control.
PaintExA DirectX-compatible event that replaces the standard Control.Paint event. Occurs when the control is redrawn. Inherited from ZIndexControl.
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.
ScrollOccurs when the user or code scrolls through the client area. Inherited from ScrollableControl.
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.
TabbedChangedOccurs when the panel’s DockPanel.Tabbed property is changed.
TabIndexChangedOccurs when the TabIndex property value changes. Inherited from Control.
TabsPositionChangedFires after the dock panel’s DockPanel.TabsPosition property has been changed.
TabsScrollChangedOccurs when the panel’s DockPanel.TabsScroll property is changed.
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.
VisibilityChangedFires after the dock panel’s visible state has been changed.
VisibleChangedFires after the visible state of any dock panel owned by the dock manager has been changed.

See Also

DockPanel Class

DevExpress.XtraBars.Docking Namespace