BaseView.AddDocument(Control) Method

Adds a Document containing the specific control as content to the current BaseView.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v18.2.dll

Declaration

C#

public BaseDocument AddDocument(
    Control control
)

VB.NET

Public Function AddDocument(
    control As Control
) As BaseDocument

Parameters

Name	Type	Description
control	Control	A Control object, stored within the newly added document as its content.

Returns

Type	Description
BaseDocument	A Document added to the current BaseView.

Remarks

The AddDocument method does nothing if the specified control has already been added to an existing document in the current View.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AddDocument(Control) 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#

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

Size size = (Parent as ucSlideWizard).WizardControl.Size;
metroUIView1.AddDocument(new Control());
metroUIView1.Documents[i].Control.Parent.Size = size;

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

void AddDocuments() {
    Document document = view.AddDocument(new ucPreview()) as Document;
    document.MaximizedControl = new ucMaximizedContent();

how-to-add-a-control-based-document-e3912/CS/DcoumentManagerContentGenerator/Form1.cs#L34

if (tabbed == true) {
    documentManager2.View.AddDocument(newTB);
}

how-to-merge-bars-within-the-documentmanager-control-e4950/CS/DocumentManagerBarMerging/Form1.cs#L53

private void barButtonItem8_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
    DevExpress.XtraBars.Docking2010.Views.Tabbed.Document newDoc = tabbedView1.AddDocument(new ucContent()) as DevExpress.XtraBars.Docking2010.Views.Tabbed.Document;
    newDoc.Caption = "New Document " + (tabbedView1.Documents.Count).ToString();

Reporting_how-to-display-multiple-print-preview-forms-as-tabs-within-a-ribbon-form-t231222/CS/WindowsFormsApplication1/Form_DocumentManager.cs#L20

private void AddDocument() {
    DevExpress.XtraBars.Docking2010.Views.BaseDocument document = tabbedView1.AddDocument(new WordProcessingForm());
    document.Caption = string.Format("Word Processing Doc # {0}", tabbedView1.Documents.Count);

VB.NET

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

Dim size As Size = (TryCast(Parent, ucSlideWizard)).WizardControl.Size
metroUIView1.AddDocument(New Control())
metroUIView1.Documents(i).Control.Parent.Size = size

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

Dim document As Document = TryCast(view.AddDocument("Document " & count.ToString(), "ucPreview"), Document)
view.AddDocument(New ucPreview())
document.MaximizedControl = New ucMaximizedContent()

how-to-add-a-control-based-document-e3912/VB/DcoumentManagerContentGenerator/Form1.vb#L36

If tabbed = True Then
    documentManager2.View.AddDocument(newTB)
Else

how-to-merge-bars-within-the-documentmanager-control-e4950/VB/DocumentManagerBarMerging/Form1.vb#L62

Private Sub barButtonItem8_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs) Handles barButtonItem8.ItemClick
    Dim newDoc As DevExpress.XtraBars.Docking2010.Views.Tabbed.Document = TryCast(tabbedView1.AddDocument(New ucContent()), DevExpress.XtraBars.Docking2010.Views.Tabbed.Document)
    newDoc.Caption = "New Document " & (tabbedView1.Documents.Count).ToString()

Reporting_how-to-display-multiple-print-preview-forms-as-tabs-within-a-ribbon-form-t231222/VB/WindowsFormsApplication1/Form_DocumentManager.vb#L22

Private Sub AddDocument()
    Dim document As DevExpress.XtraBars.Docking2010.Views.BaseDocument = tabbedView1.AddDocument(New WordProcessingForm())
    document.Caption = String.Format("Word Processing Doc # {0}", tabbedView1.Documents.Count)