Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]Controls and Libraries
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Charts.Designer
  [Expand]DevExpress.Mvvm.UI
  [Expand]DevExpress.Mvvm.UI.Interactivity
  [Expand]DevExpress.Mvvm.UI.ModuleInjection
  [Expand]DevExpress.Xpf.Accordion
  [Expand]DevExpress.Xpf.Bars
  [Expand]DevExpress.Xpf.Carousel
  [Expand]DevExpress.Xpf.Charts
  [Expand]DevExpress.Xpf.Charts.Localization
  [Expand]DevExpress.Xpf.Charts.RangeControlClient
  [Expand]DevExpress.Xpf.ChunkList
  [Expand]DevExpress.Xpf.Controls
  [Expand]DevExpress.Xpf.Core
  [Expand]DevExpress.Xpf.Core.ConditionalFormatting
  [Expand]DevExpress.Xpf.Core.DataSources
  [Expand]DevExpress.Xpf.Core.ServerMode
  [Expand]DevExpress.Xpf.Data
  [Expand]DevExpress.Xpf.DataAccess
  [Expand]DevExpress.Xpf.DataAccess.DataSourceWizard
  [Expand]DevExpress.Xpf.Diagram
  [Collapse]DevExpress.Xpf.Docking
   [Expand]AutoHideGroup Class
   [Expand]AutoHideGroupCollection Class
    AutoHideType Enumeration
   [Expand]BaseLayoutItem Class
   [Expand]BaseLayoutItemCollection Class
    CaptionAlignMode Enumeration
    CaptionLocation Enumeration
   [Expand]ClosedPanelCollection Class
    ClosePageButtonShowMode Enumeration
    ClosingBehavior Enumeration
   [Expand]ContentItem Class
   [Expand]DockController Class
   [Expand]DockControllerBase Class
   [Expand]DockingDocumentUIService Class
    DockingStyle Enumeration
   [Collapse]DockLayoutManager Class
     DockLayoutManager Members
     DockLayoutManager Constructor
    [Expand]DockLayoutManager Properties
    [Collapse]DockLayoutManager Events
      BeforeItemAdded Event
      CustomizationFormVisibleChanged Event
      DockItemActivated Event
      DockItemActivating Event
      DockItemClosed Event
      DockItemClosing Event
      DockItemCollapsed Event
      DockItemDocking Event
      DockItemDragging Event
      DockItemEndDocking Event
      DockItemExpanded Event
      DockItemHidden Event
      DockItemHiding Event
      DockItemRestored Event
      DockItemRestoring Event
      DockItemStartDocking Event
      DockOperationCompleted Event
      DockOperationStarting Event
      IsCustomizationChanged Event
      ItemIsVisibleChanged Event
      LayoutItemActivated Event
      LayoutItemActivating Event
      LayoutItemEndRenaming Event
      LayoutItemHidden Event
      LayoutItemMoved Event
      LayoutItemRestored Event
      LayoutItemSelectionChanged Event
      LayoutItemSelectionChanging Event
      LayoutItemSizeChanged Event
      LayoutItemStartRenaming Event
      MDIItemActivated Event
      MDIItemActivating Event
      Merge Event
      RequestUniqueName Event
      ShowingDockHints Event
      ShowingMenu Event
      ShowInvisibleItemsChanged Event
      UnMerge Event
    [Expand]DockLayoutManager Methods
    DockOperation Enumeration
   [Expand]DocumentGroup Class
   [Expand]DocumentPanel Class
   [Expand]EmptySpaceItem Class
   [Expand]FixedItem Class
    FixedItemStyle Enumeration
   [Expand]FloatGroup Class
   [Expand]FloatGroupCollection Class
    FloatingMode Enumeration
    GroupBorderStyle Enumeration
    ImageLocation Enumeration
   [Expand]LabelItem Class
   [Expand]LayoutControlItem Class
   [Expand]LayoutController Class
   [Expand]LayoutGroup Class
   [Expand]LayoutPanel Class
   [Expand]LayoutSplitter Class
    MDIState Enumeration
    MDIStyle Enumeration
   [Expand]RestoreLayoutOptions Class
   [Expand]SeparatorItem Class
   [Expand]TabbedDocumentUIService Class
   [Expand]TabbedGroup Class
  [Expand]DevExpress.Xpf.Docking.Base
  [Expand]DevExpress.Xpf.DocumentViewer
  [Expand]DevExpress.Xpf.Editors
  [Expand]DevExpress.Xpf.Editors.DateNavigator
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor
  [Expand]DevExpress.Xpf.Editors.Filtering
  [Expand]DevExpress.Xpf.Editors.Flyout
  [Expand]DevExpress.Xpf.Editors.Flyout.Native
  [Expand]DevExpress.Xpf.Editors.Helpers
  [Expand]DevExpress.Xpf.Editors.Popups
  [Expand]DevExpress.Xpf.Editors.RangeControl
  [Expand]DevExpress.Xpf.Editors.Settings
  [Expand]DevExpress.Xpf.Editors.Validation
  [Expand]DevExpress.Xpf.Gauges
  [Expand]DevExpress.Xpf.Gauges.Localization
  [Expand]DevExpress.Xpf.Grid
  [Expand]DevExpress.Xpf.Grid.ConditionalFormatting
  [Expand]DevExpress.Xpf.Grid.LookUp
  [Expand]DevExpress.Xpf.Grid.TreeList
  [Expand]DevExpress.Xpf.Layout.Core
  [Expand]DevExpress.Xpf.LayoutControl
  [Expand]DevExpress.Xpf.Map
  [Expand]DevExpress.Xpf.NavBar
  [Expand]DevExpress.Xpf.Navigation
  [Expand]DevExpress.Xpf.PdfViewer
  [Expand]DevExpress.Xpf.PivotGrid
  [Expand]DevExpress.Xpf.PivotGrid.Printing
  [Expand]DevExpress.Xpf.Printing
  [Expand]DevExpress.Xpf.Printing.Parameters
  [Expand]DevExpress.Xpf.Printing.Parameters.Models
  [Expand]DevExpress.Xpf.Printing.PreviewControl.Bars
  [Expand]DevExpress.Xpf.Prism
  [Expand]DevExpress.Xpf.PropertyGrid
  [Expand]DevExpress.Xpf.Reports.UserDesigner
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Extensions
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Localization
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard.Pages
  [Expand]DevExpress.Xpf.Ribbon
  [Expand]DevExpress.Xpf.RichEdit
  [Expand]DevExpress.Xpf.Scheduler
  [Expand]DevExpress.Xpf.Scheduler.Drawing
  [Expand]DevExpress.Xpf.Scheduler.Menu
  [Expand]DevExpress.Xpf.Scheduler.Reporting
  [Expand]DevExpress.Xpf.Scheduler.UI
  [Expand]DevExpress.Xpf.SpellChecker
  [Expand]DevExpress.Xpf.Spreadsheet
  [Expand]DevExpress.Xpf.Spreadsheet.Menu
  [Expand]DevExpress.Xpf.TreeMap
  [Expand]DevExpress.Xpf.Utils.Themes
  [Expand]DevExpress.Xpf.WindowsUI
  [Expand]DevExpress.Xpf.WindowsUI.Navigation
  [Expand]DevExpress.XtraRichEdit
[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

DockLayoutManager.DockItemDocking Event

Fires before a dock item is dragged over dock hints, and allows you to prevent dock zones from being displayed.

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

Expanded Syntax

Expanded Event Data

The event handler receives an argument of type DockItemDockingEventArgs containing data related to this event.

The following DockItemDockingEventArgs properties provide information specific to this event.
Property Description
Cancel Gets or sets whether the current operation must be canceled.
DockTarget Gets the item to which the current item is being docked.
DockType Gets or sets how an item is being docked to another item.
DragPoint Gets the point at which the item is being docked. The point is relative to the top left corner of the target item's root parent.
Handled Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route.
IsHiding Gets whether the item is being docked over a zone used to set the item to the auto-hide state.
Item Gets the currently processed item.
OriginalSource Gets the original reporting source as determined by pure hit testing, before any possible System.Windows.RoutedEventArgs.Source adjustment by a parent class.
RoutedEvent Gets or sets the System.Windows.RoutedEventArgs.RoutedEvent associated with this System.Windows.RoutedEventArgs instance.
Source Gets or sets a reference to the object that raised the event.

Expanded Remarks

When an end-user is dragging a panel, visual hints appear, helping an end-user to decide where to dock the panel. When hovering over a hint, the potential dock zone is painted in the background, and this indicates where the panel will be docked if dropped. The DockItemDocking event fires repeatedly when hovering over any visual marker. If the event's Cancel parameter is set to true, the potential dock zone is not painted. Note that this doesn't prevent the panel from being dropped at this position. To prevent a panel from being dropped at a specific position, handle the DockItemEndDocking event.

It's also possible to prevent an item from being docked by setting the BaseLayoutItem.AllowDock property to false.

Expanded See Also

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