BaseView.Documents Property

Stores all documents displayed within the View.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v19.2.dll

Declaration

C#

[Browsable(false)]
public BaseDocumentCollection Documents { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property Documents As BaseDocumentCollection

Property Value

Type	Description
DevExpress.XtraBars.Docking2010.Views.BaseDocumentCollection	A BaseDocumentCollection object that stores all documents displayed within the View.

Remarks

Do not modify the Documents collection to add and\or remove Documents to\from this View. Instead, use methods provided by the BaseView and BaseView.Controller objects. To add documents, use the BaseView.AddDocument or IBaseViewController.AddDocument method. To remove documents, use the BaseView.RemoveDocument or IBaseViewController.RemoveDocument method.

The IBaseViewController.Close, IBaseViewController.CloseAll and IBaseViewController.CloseAllButThis methods close documents by destroying them.

See the Documents article to learn more.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Documents property.

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#

tabbedview-how-to-convert-the-default-layout-to-a-table-one-t323423/CS/FreeLayoutModeExample/Form1.cs#L22

{
    foreach (Document doc in tabbedView.Documents)
        doc.Appearance.HeaderActive.BackColor = ExampleHelper.GetRandomColor();

how-to-implement-page-switching-animation-with-a-slide-effect-in-wizardcontrol-e4346/CS/ucDocMetro.cs#L31

wizard.SelectedPageIndex = numPage;
pageGroup1.SetSelected(metroUIView1.Documents[numPage] as Document);
metroUIView1.Controller.Activate(pageGroup1);

how-to-create-widgetview-at-runtime-e5003/CS/WidgetViewExample/Form1.cs#L34

//Adding Documents to group1 is not necessary, since all newly created Documents are automatically placed in the first StackGroup.
group1.Items.AddRange(new Document[] { view.Documents[0] as Document, view.Documents[1] as Document });
view.Controller.Dock(view.Documents[2] as Document, group2);

Reporting_how-to-suppress-the-report-has-been-changed-do-you-want-to-save-changes-message-t424864/CS/WindowsFormsApplication1/Form2.cs#L45

{
    BaseDocument document = controller.XtraTabbedMdiManager.View.Documents[i];

VB.NET

tabbedview-how-to-convert-the-default-layout-to-a-table-one-t323423/VB/FreeLayoutModeExample/Form1.vb#L21

Private Sub SetDocumentsAppearance()
    For Each doc As Document In tabbedView.Documents
        doc.Appearance.HeaderActive.BackColor = ExampleHelper.GetRandomColor()

how-to-implement-page-switching-animation-with-a-slide-effect-in-wizardcontrol-e4346/VB/ucDocMetro.vb#L29

wizard.SelectedPageIndex = numPage
pageGroup1.SetSelected(TryCast(metroUIView1.Documents(numPage), Document))
metroUIView1.Controller.Activate(pageGroup1)

how-to-create-widgetview-at-runtime-e5003/VB/Form1.vb#L27

                                    'Adding Documents to group1 is not necessary, since all newly created Documents are automatically placed in the first StackGroup.
group1.Items.AddRange(New Document() { TryCast(view.Documents(0), Document), TryCast(view.Documents(1), Document) })
view.Controller.Dock(TryCast(view.Documents(2), Document), group2)

Reporting_how-to-suppress-the-report-has-been-changed-do-you-want-to-save-changes-message-t424864/VB/WindowsFormsApplication1/Form2.vb#L41

For i As Integer = 0 To controller.XtraTabbedMdiManager.View.Documents.Count - 1
    Dim document As BaseDocument = controller.XtraTabbedMdiManager.View.Documents(i)