IBaseViewController.CloseAll() Method

Closes all currently opened documents within the IBaseViewController.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v24.2.dll

Declaration

C#

bool CloseAll()

VB.NET

Function CloseAll As Boolean

Returns

Type	Description
Boolean	true if one or more documents have been closed; otherwise, false.

Remarks

The CloseAll method calls the IBaseViewController.Close method for all documents in a View.

The IBaseDocumentDefaultProperties.AllowClose and IBaseDocumentProperties.AllowClose options let you prevent specific documents from being closed.

You can also use the IBaseViewController.CloseAllButThis method to close all documents except the specified one.

The ITabbedViewController.CloseAllButPinned method, available in TabbedView only, closes all Documents except for pinned ones.

Related GitHub Examples

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

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#

winforms-tabbed-ui-control-based-document/CS/DcoumentManagerContentGenerator/Form1.cs#L50

private void closeAllDocs(object sender, ItemClickEventArgs e) {
    documentManager2.View.Controller.CloseAll();
    index = 1;

VB.NET

winforms-tabbed-ui-control-based-document/VB/DcoumentManagerContentGenerator/Form1.vb#L53

Private Sub closeAllDocs(ByVal sender As Object, ByVal e As ItemClickEventArgs) Handles barButtonItem2.ItemClick
    documentManager2.View.Controller.CloseAll()
    index = 1