Back to Devexpress

IWorkspaceManager.CaptureWorkspace(String) Method

wpf-devexpress-dot-xpf-dot-core-dot-iworkspacemanager-dot-captureworkspace-x28-system-dot-string-x29.md

latest3.2 KB
Original Source

IWorkspaceManager.CaptureWorkspace(String) Method

Creates a new workspace by capturing the current layout of the target control and its child controls.

Namespace : DevExpress.Xpf.Core

Assembly : DevExpress.Xpf.Core.v25.2.dll

NuGet Package : DevExpress.Wpf.Core

Declaration

csharp
void CaptureWorkspace(
    string name
)
vb
Sub CaptureWorkspace(
    name As String
)

Parameters

NameTypeDescription
nameString

A String that specifies the name of the created workspace.

|

Remarks

The target control associated with the WorkspaceManager can be obtained via the IWorkspaceManager.TargetControl property.

To apply a workspace, captured by the CaptureWorkspace method, to the target control, use the IWorkspaceManager.ApplyWorkspace method.

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

wpf-dock-layout-manager-upgrade-layouts-between-versions/CS/MainWindow.xaml.cs#L26

csharp
var manager = WorkspaceManager.GetWorkspaceManager(dockLayoutManager);
manager.CaptureWorkspace(workspaceName);
manager.SaveWorkspace(workspaceName, layoutPath);

wpf-dock-layout-manager-upgrade-layouts-between-versions/VB/MainWindow.xaml.vb#L34

vb
Dim manager = WorkspaceManager.GetWorkspaceManager(Me.dockLayoutManager)
manager.CaptureWorkspace(workspaceName)
manager.SaveWorkspace(workspaceName, layoutPath)

See Also

TargetControl

ApplyWorkspace(String)

Workspaces

IWorkspaceManager Interface

IWorkspaceManager Members

DevExpress.Xpf.Core Namespace