Back to Devexpress

DocumentManager.ClientControl Property

windowsforms-devexpress-dot-xtrabars-dot-docking2010-dot-documentmanager.md

latest3.9 KB
Original Source

DocumentManager.ClientControl Property

Gets or sets a client control to the current DocumentManager, switching it to the Non-Document Mode.

Namespace : DevExpress.XtraBars.Docking2010

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[DefaultValue(null)]
[DXCategory("Behavior")]
public Control ClientControl { get; set; }
vb
<DefaultValue(Nothing)>
<DXCategory("Behavior")>
Public Property ClientControl As Control

Property Value

TypeDefaultDescription
Controlnull

A Control assigned to the current DocumentManager as a client control.

|

Remarks

A control assigned to the ClientControl property is the only DocumentManager control displayed. The DocumentManager has no other documents objects to display. This mode is called the Non-Document Mode and is generally designed to interact with the DockManager component. The figure below shows an example of such interplay: the central application area is occupied by the DocumentManager in the Non-Document Mode with the GridControl assigned to its ClientControl property.

To set a specific control as a DocumentManager‘s ClientControl at runtime, you must first add this control’s instance to the form’s Controls collection. See the Non-Document Mode topic to learn more.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ClientControl 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.

xaf-how-to-create-information-panels/CS/EFCore/InfoPanelEF/InfoPanelEF.Win/LightStyleMainRibbonForm1.cs#L51

csharp
viewSitePanel.Visible = true;
documentManager.ClientControl = viewSitePanel;
barMdiChildrenListItem.Visibility = BarItemVisibility.Never;

See Also

Non-Document Mode

DocumentManager Class

DocumentManager Members

DevExpress.XtraBars.Docking2010 Namespace