Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Collapse]DevExpress.XtraBars.Docking
   [Expand]ActivePanelChangedEventArgs Class
    ActivePanelChangedEventHandler Delegate
    AutoHiddenPanelCaptionShowMode Enumeration
   [Expand]AutoHideContainer Class
   [Expand]AutoHideContainerCollection Class
   [Expand]BaseDockOptions Class
   [Expand]ControlContainer Class
   [Expand]DockingEventArgs Class
    DockingEventHandler Delegate
   [Expand]DockingOptions Class
    DockingStyle Enumeration
   [Expand]DockManager Class
   [Expand]DockManagerAppearances Class
   [Collapse]DockPanel Class
     DockPanel Members
     DockPanel Constructor
    [Expand]DockPanel Properties
    [Expand]DockPanel Events
    [Collapse]DockPanel Methods
      AddPanel Method
      Close Method
     [Expand]DockAsMdiDocument Method
     [Expand]DockAsTab Method
     [Collapse]DockTo Method
       DockTo(DockPanel) Method
       DockTo(DockingStyle) Method
       DockTo(DockingStyle, Int32) Method
       DockTo(DockPanel, DockingStyle) Method
       DockTo(DockManager, DockingStyle) Method
       DockTo(DockPanel, Int32) Method
       DockTo(DockManager, DockingStyle, Int32) Method
       DockTo(DockPanel, DockingStyle, Int32) Method
      GetHitInfo Method
      HasAsChild Method
      HasAsParent Method
      Hide Method
      HideImmediately Method
      HideSliding Method
     [Expand]MakeFloat Method
      Register Method
      RemovePanel Method
      Restore Method
      Show Method
      ShowSliding Method
   [Expand]DockPanelCancelEventArgs Class
    DockPanelCancelEventHandler Delegate
   [Expand]DockPanelCollection Class
   [Expand]DockPanelEventArgs Class
    DockPanelEventHandler Delegate
   [Expand]DockPanelOptions Class
    DockPanelState Enumeration
    DockVisibility Enumeration
   [Expand]EndDockingEventArgs Class
    EndDockingEventHandler Delegate
   [Expand]EndSizingEventArgs Class
    EndSizingEventHandler Delegate
   [Expand]FloatForm Class
   [Expand]HitInfo Class
    HitTest Enumeration
   [Expand]LayoutSerializationOptions Class
   [Expand]PopupMenuShowingEventArgs Class
    PopupMenuShowingEventHandler Delegate
   [Expand]ReadOnlyPanelCollection Class
   [Expand]SizingEventArgs Class
    SizingEventHandler Delegate
   [Expand]StartSizingEventArgs Class
    StartSizingEventHandler Delegate
    TabsPosition Enumeration
   [Expand]TabsPositionChangedEventArgs Class
    TabsPositionChangedEventHandler Delegate
   [Expand]VisibilityChangedEventArgs Class
    VisibilityChangedEventHandler Delegate
   [Expand]ZIndexControl Class
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

DockPanel.DockTo(DockingStyle, Int32) Method

Docks the current panel to the form (user control) at the specified position using the specified style.

Namespace:DevExpress.XtraBars.Docking
Assembly:DevExpress.XtraBars.v17.2.dll

Expanded Syntax

Parameters

dock
Type: DockingStyle
A DockingStyle value specifying how the panel is docked to the form (user control).
index
Type: Int32
A zero-based integer specifying the position at which to dock the current panel.

Expanded Remarks

The DockTo method docks the current panel to the form (user control) which is referred to by the DockManager.Form property.

The dock parameter specifies how the dock panel is docked. Set dock to DockingStyle.Top, DockingStyle.Left, DockingStyle.Bottom or DockingStyle.Right to dock the current panel to the corresponding edge of the form. Set dock to DockingStyle.Float to make the panel floating.

A dock panel's dock style cannot be set to Fill when it's residing within a form, that is a panel cannot occupy the form entirely. Consequently the DockTo method does nothing if the dock parameter is set to DockingStyle.Fill.

Panels are arranged within a form according to these panels' indexes. A panel's index matches the position of the panel in the DockManager.RootPanels collection. Panels with low indexes are placed nearer the form's edges. Panels with higher indexes are placed nearer the form's center.

The DockTo method moves the current panel within the DockManager.RootPanels collection to the position specified by the index parameter and this defines the panel's position amongst the other panels in the form.

If the index parameter is 0 and the form already contains panels, the current panel will be docked to the form's corresponding edge so that it occupies this edge entirely and the existing panels will then be placed within the form's remaining region. In the following image a panel is docked to the top by setting its index to 0.

If the index parameter is 1 the current panel is docked to the corresponding edge within the region not occupied by the panel whose index is 0. In the following image a panel is docked to the top by setting its index to 1.

If the index parameter is 2 the current panel is docked to the corresponding edge within the region not occupied by the panels whose indexes are 0 and 1, etc. In the following image a panel is docked to the right by setting its index to 2.

At any time a panel's position can be identified via the Index property. Refer to this topic for more information on how panels are arranged within the form.

Expanded Example

In the following code two panels are created and docked to the form's left and bottom edges respectively. Then a new floating panel is created, this is docked to the form's bottom edge so that it occupies this edge entirely. Panels are docked to the form via the DockTo method.

To dock a panel in a specific position amongst the existing panels, you need to use the DockTo overload which takes the index parameter. If index is set to 0, the panel will completely occupy the corresponding edge of the form.

The result is shown below:

Expanded See Also

How would you rate this topic?​​​​​​​