BaseView.AddDocument(Control, String) Method

Creates a Document that wraps the target control, and adds this new Document to the current BaseView.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v24.2.dll

Declaration

C#

public BaseDocument AddDocument(
    Control control,
    string caption = null
)

VB.NET

Public Function AddDocument(
    control As Control,
    caption As String = Nothing
) As BaseDocument

Parameters

Name	Type	Description
control	Control	The control stored inside the newly added Document as its content.

Optional Parameters

Name	Type	Default	Description
caption	String	null	The Document caption.

Returns

Type	Description
BaseDocument	A Document added to the current BaseView

Remarks

This 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, String) 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#L34

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

winforms-create-widgetview-runtime/CS/WidgetViewExample/Form1.cs#L55

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

VB.NET

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

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

winforms-create-widgetview-runtime/VB/WidgetViewExample/Form1.vb#L56

Private Sub AddDocuments()
    Dim document As Document = TryCast(view.AddDocument(New ucPreview()), Document)
    document.MaximizedControl = New ucMaximizedContent()