BaseView.BeginDocumentsHostDocking Event

Occurs whenever a Floating Documents Container starts docking to this BaseView.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

public event DocumentCancelEventHandler BeginDocumentsHostDocking
Public Event BeginDocumentsHostDocking As DocumentCancelEventHandler

Event Data

The BeginDocumentsHostDocking event's data class is DocumentCancelEventArgs. The following properties provide information specific to this event:

Property Description
Cancel Gets or sets a value indicating whether the event should be canceled. Inherited from CancelEventArgs.
Document The Document related to the current event.

Remarks

If the BaseView.FloatingDocumentContainer property equals DocumentsHost, tabbed Documents can be undocked from their parent View and docked to Floating Document Containers. These Containers with all their child Documents can be dragged back into the View. When this happens, the BeginDocumentsHostDocking event occurs. To cancel Floating Document Container docking, handle this event and set the e.Cancel property to true. If the BeginDocumentsHostDocking event was not canceled, the BaseView.EndDocumentsHostDocking event is raised afterwards.

See Also