DockPanel Properties
Represents a dock panel.| Name | Description |
|---|---|
| AccessibilityObject | Gets the AccessibleObject assigned to the control. Inherited from Control. |
| AccessibleDefaultActionDescription | Gets or sets the default action description of the control for use by accessibility client applications. Inherited from Control. |
| AccessibleDescription | Gets or sets the description of the control used by accessibility client applications. Inherited from Control. |
| AccessibleName | Gets or sets the name of the control used by accessibility client applications. Inherited from Control. |
| AccessibleRole | Gets or sets the accessible role of the control. Inherited from Control. |
| ActivateOnContentFocusWhenAutoHidden | Gets or sets whether this auto-hide DockPanel should be activated when an end-user focuses its content. |
| ActiveChild | Gets or sets the currently active child dock panel. |
| ActiveChildIndex | Gets or sets the index of the currently active child dock panel. |
| ActiveControl | Gets or sets the active control on the container control. Inherited from ContainerControl. |
| ActualImage | Returns the image this panel currently shows. |
| AllowBorderColorBlending |
Gets 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).
|
| AllowCustomHeaderButtonsGlyphSkinning |
Gets 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.
|
| AllowDrop | Gets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control. |
| AllowGlyphSkinning |
Gets 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. |
See Also