IBaseViewController.RemoveDocument(BaseDocument) Method

Removes the specified document from the BaseView.Documents collection.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v24.2.dll

Declaration

C#

bool RemoveDocument(
    BaseDocument document
)

VB.NET

Function RemoveDocument(
    document As BaseDocument
) As Boolean

Parameters

Name	Type	Description
document	BaseDocument	A BaseDocument object to be removed.

Returns

Type	Description
Boolean	true if the operation was successful; otherwise, false.

Remarks

Documents displayed within a View are stored in the BaseView.Documents collection. The RemoveDocument method removes a document from this collection, and therefore from the current View. When a document is removed, it is hidden from the View. It is not destroyed. The BaseView.DocumentRemoved event fires after a document has been removed.

To destroy a document, use the IBaseViewController.Close method.