DockPanelCancelEventArgs Class

Provides data for the DockManager.ClosingPanel event.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v18.1.dll

Declaration

C#

public class DockPanelCancelEventArgs :
    DockPanelEventArgs

VB.NET

Public Class DockPanelCancelEventArgs
    Inherits DockPanelEventArgs

Related API Members

DockPanelCancelEventArgs is the data class for the following events:

• DockManager.ClosingPanel
• DockManager.Expanding
• DockManager.StartDocking
• DockPanel.ClosingPanel
• DockPanel.Expanding

Remarks

The DockManager.ClosingPanel event is fired when a panel is about to be closed. The DockPanelCancelEventArgs class provides the DockPanelCancelEventArgs.Cancel property which specifies whether the dock panel must be closed. It can be used to prevent a dock panel from being closed.

DockPanelCancelEventArgs objects are automatically created and passed to DockManager.ClosingPanel event handlers.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DockPanelCancelEventArgs 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.

C#

how-to-prevent-a-dockpanel-from-being-closed-e1105/CS/WindowsFormsApplication1/Form1.cs#L24

private void dockPanel1_ClosingPanel(object sender, DevExpress.XtraBars.Docking.DockPanelCancelEventArgs e)
{

VB.NET

how-to-prevent-a-dockpanel-from-being-closed-e1105/VB/WindowsFormsApplication1/Form1.vb#L22

Private Sub dockPanel1_ClosingPanel(ByVal sender As Object, ByVal e As DevExpress.XtraBars.Docking.DockPanelCancelEventArgs) Handles dockPanel1.ClosingPanel
    e.Cancel = e.Panel Is dockPanel1

Inheritance

Object

EventArgs

DockPanelEventArgs

DockPanelCancelEventArgs

DockingEventArgs

StartSizingEventArgs

SizingEventArgs