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.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
    [Collapse]DockPanel Properties
      ActivateOnContentFocusWhenAutoHidden Property
      ActiveChild Property
      ActiveChildIndex Property
      AllowBorderColorBlending Property
      AllowCustomHeaderButtonsGlyphSkinning Property
      AllowGlyphSkinning Property
      Appearance Property
      BackColor Property
      BindingContext Property
      Bounds Property
      CanActivate Property
      ControlContainer Property
      Count Property
      CustomHeaderButtons Property
      Dock Property
      DockedAsTabbedDocument Property
      DockLevel Property
      DockManager Property
      DockVertical Property
      FloatForm Property
      FloatLocation Property
      FloatSize Property
      FloatVertical Property
      Footer Property
      Header Property
      Hint Property
      ID Property
      Image Property
      ImageIndex Property
      Images Property
      ImageUri Property
      Index Property
      IsMdiDocument Property
      IsTab Property
      Item Property
      Location Property
      MaximumSize Property
      MinimumSize Property
      Options Property
      OriginalSize Property
      ParentAutoHideContainer Property
      ParentPanel Property
      RootPanel Property
      SavedDock Property
      SavedIndex Property
      SavedMdiDocument Property
      SavedParent Property
      SavedTabbed Property
      Size Property
      State Property
      Tabbed Property
      TabsPosition Property
      TabsScroll Property
      TabText Property
      Text Property
      Visibility Property
      Visible Property
      XtraActiveChildID Property
      XtraAutoHideContainerDock Property
      XtraBounds Property
      XtraID Property
      XtraParentID Property
      XtraSavedParentID Property
    [Expand]DockPanel Events
    [Expand]DockPanel Methods
   [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]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]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

DockPanel.Index Property

Gets or sets the position of the dock panel within the owning collection.

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

Expanded Syntax

Property value

Type: Int32
A zero-based integer specifying the position of the current panel within the owning collection.

Expanded Remarks

You can use the Index property to change the panel's position with respect to its sibling panels. Changing the Index property doesn't modify the panel's dock style (left, top, right or bottom). To dock a panel at a specific position using a specific dock style, the DockTo overload can be used which takes the index parameter.

Child panels within a tab container or split container are counted from top to bottom and from left to right. The number of child panels within the parent panel is specified by the Count property. A child panel's Index property reflects the position of the panel within its container.

Visible root panels specified by the DockManager.RootPanels collection are panels which aren't owned by any panels. These include the floating panels and panels docked to the form (or user control) which is referred to by the DockManager.Form property. For these panels the Index property reflects the position of the panel within the root panel collection and this also determines the panel's position amongst the other sibling panels.

Assuming that the root panel collection doesn't contain any floating panels the root panels docked to the form are indexed as follows. A panel which entirely occupies the form's edge has the smallest index (0). A second dock panel can be docked only within the region which is not occupied by the first panel. The second panel has an index of 1. The images below show two panels docked to the left and top, respectively. In the first image the panel docked on the left has an index of 0, the index of the top-docked panel is 1. In the second image the panels' indexes are reversed.

 

Another panel can be docked only within the region not occupied by the first and second panels. Its index is 2. Below are the possible variants on how the third panel can be docked.

When an end-user docks a panel at a specific position, its position in the DockManager.RootPanels collection and therefore its Index are changed to reflect the new layout.

Changing the panel's Index property will move the panel according to the described arrangement rules.

For hidden panels and panels which have their auto hide feature enabled, the Index property is always set to -1.

Expanded See Also

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