Skip to main content
A newer version of this page is available. .

DockingEventArgs Class

Provides data for the DockManager.Docking event.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v18.1.dll

Declaration

public class DockingEventArgs :
    DockPanelCancelEventArgs

Remarks

The DockManager.Docking event is fired repeatedly while an end-user is docking a panel. The DockingEventArgs class provides properties that identify the target control that the panel will be docked to (if it is dragged to the control it’s currently over), how the panel will be docked, whether the panel will represent a tab within the tab container if dropped ,etc.

The current docking operation can also be canceled by setting the DockPanelCancelEventArgs.Cancel property to true. This property is inherited from the DockPanelCancelEventArgs class.

DockingEventArgs objects are automatically created, initialized and passed to appropriate event handlers.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DockingEventArgs class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also