WinForms Workspace Manager - Save and load runtime app layouts

C#
// Developer Express Code Central Example:
// WorkspaceManager - How to use WorkspaceManager for capturing, applying, saving and loading workspaces
// 
// This example demonstrates how to use the Workspace Manager
// (https://documentation.devexpress.com/WindowsForms/CustomDocument17674.aspx) for
// capturing, applying, saving and loading workspaces and shows different
// Transition Types in action. You can find the general information about the
// WorkspaceManager in our documentation: Workspace Manager
// (https://documentation.devexpress.com/WindowsForms/CustomDocument17674.aspx).
// 
// You can find sample updates and versions for different programming languages here:
// http://www.devexpress.com/example=T190543

using DevExpress.Utils.Animation;
using DevExpress.XtraEditors;
using System;
using System.Linq;
using System.Windows.Forms;

namespace T190543 {
    public partial class Form1 : DevExpress.XtraBars.Ribbon.RibbonForm {
        public Form1() {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e) {
            DevExpress.LookAndFeel.UserLookAndFeel.Default.SetSkinStyle("Office 2013");
            Init();
        }

        private void Init() {
            this.repositoryItemLookUpEdit1.DataSource = this.workspaceManager1.Workspaces;
            this.repositoryItemLookUpEdit1.DisplayMember = "Name";
            this.repositoryItemLookUpEdit1.ValueMember = "Name";

            this.repositoryItemLookUpEdit1.PopulateColumns();
            this.repositoryItemLookUpEdit1.Columns[1].Visible = false;
            this.repositoryItemLookUpEdit1.Columns[2].Visible = false;

            this.selectWorkSpaceItem.EditValue = "Default";

            this.workspaceManager1.CloseStreamOnWorkspaceSaving = DevExpress.Utils.DefaultBoolean.True;
            this.workspaceManager1.CloseStreamOnWorkspaceLoading = DevExpress.Utils.DefaultBoolean.True;
            this.workspaceManager1.CaptureWorkspace("Default");

            this.repositoryItemComboBox1.Items.AddRange(Enum.GetValues(typeof(TransitionType)));
            this.repositoryItemComboBox1.EditValueChanged += repositoryItemComboBox1_EditValueChanged;

            this.transitionItem.EditValue = TransitionType.Push;
        }

        #region Events
        private void tabbedView1_QueryControl(object sender, DevExpress.XtraBars.Docking2010.Views.QueryControlEventArgs e) {
            e.Control = new Control();
        }

        void repositoryItemComboBox1_EditValueChanged(object sender, EventArgs e) {
            ComboBoxEdit edit = sender as ComboBoxEdit;
            if (edit != null) {
                TransitionType value = (TransitionType)edit.EditValue;
                BaseTransition transition = null;
                switch (value) {
                    case TransitionType.Clock:
                        transition = new DevExpress.Utils.Animation.ClockTransition();
                        break;
                    case TransitionType.Comb:
                        transition = new DevExpress.Utils.Animation.CombTransition();
                        break;
                    case TransitionType.Cover:
                        transition = new DevExpress.Utils.Animation.CoverTransition();
                        break;
                    case TransitionType.Dissolve:
                        transition = new DevExpress.Utils.Animation.DissolveTransition();
                        break;
                    case TransitionType.Fade:
                        transition = new DevExpress.Utils.Animation.FadeTransition();
                        break;
                    case TransitionType.Push:
                        transition = new DevExpress.Utils.Animation.PushTransition();
                        break;
                    case TransitionType.Shape:
                        transition = new DevExpress.Utils.Animation.ShapeTransition();
                        break;
                    case TransitionType.SlideFade:
                        transition = new DevExpress.Utils.Animation.SlideFadeTransition();
                        break;
                }
                this.workspaceManager1.TransitionType = transition;
            }
        }

        private void captureItem_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
            if (this.workspaceNameItem.EditValue != null) {
                string workspaceName = this.workspaceNameItem.EditValue.ToString();
                var item = this.workspaceManager1.Workspaces.Where(i => i.Name == workspaceName).FirstOrDefault();
                if (!string.IsNullOrEmpty(workspaceName) && item == null)
                    this.workspaceManager1.CaptureWorkspace(workspaceName);
            }
        }

        private void applyItem_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
            if (this.selectWorkSpaceItem.EditValue != null) {
                string selectWorkSpaceItem = this.selectWorkSpaceItem.EditValue.ToString();
                if (!string.IsNullOrEmpty(selectWorkSpaceItem))
                    this.workspaceManager1.ApplyWorkspace(selectWorkSpaceItem);
            }
        }

        private void saveItem_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
            string workspaceName = string.Empty;
            this.saveFileDialog1.InitialDirectory = @"C:\Users\Public\Documents\";
            if (XtraMessageBox.Show("Capture a new workspace or use an existing one? Click 'Yes' to capture a new workspace or 'No' to save the selected workspace.", "Create new workspace?", MessageBoxButtons.YesNo) == System.Windows.Forms.DialogResult.Yes) {
                if (this.saveFileDialog1.ShowDialog() == System.Windows.Forms.DialogResult.OK) {
                    workspaceName = System.IO.Path.GetFileNameWithoutExtension(this.saveFileDialog1.FileName);
                    this.workspaceManager1.CaptureWorkspace(workspaceName);
                    this.workspaceManager1.SaveWorkspace(this.workspaceManager1.Workspaces[0].Name, this.saveFileDialog1.FileName);
                }
            }
            else {
                workspaceName = this.selectWorkSpaceItem.EditValue.ToString();
            }
            if (!string.IsNullOrEmpty(workspaceName))
                this.workspaceManager1.SaveWorkspace(workspaceName, this.saveFileDialog1.InitialDirectory + workspaceName + ".xml");
        }

        private void loadItem_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
            this.saveFileDialog1.InitialDirectory = @"C:\Users\Public\Documents\";
            if (this.openFileDialog1.ShowDialog() == System.Windows.Forms.DialogResult.OK) {
                string workspaceName = System.IO.Path.GetFileNameWithoutExtension(this.openFileDialog1.FileName);
                if (this.workspaceManager1.LoadWorkspace(System.IO.Path.GetFileNameWithoutExtension(this.openFileDialog1.FileName), openFileDialog1.FileName)) {
                    this.workspaceManager1.ApplyWorkspace(workspaceName);
                }
            }
        }
        #endregion
    }
    public enum TransitionType {
        Push,
        Shape,
        Fade,
        Clock,
        Dissolve,
        SlideFade,
        Cover,
        Comb
    }
}

Visual Basic
' Developer Express Code Central Example:
' WorkspaceManager - How to use WorkspaceManager for capturing, applying, saving and loading workspaces
' 
' This example demonstrates how to use the Workspace Manager
' (https://documentation.devexpress.com/WindowsForms/CustomDocument17674.aspx) for
' capturing, applying, saving and loading workspaces and shows different
' Transition Types in action. You can find the general information about the
' WorkspaceManager in our documentation: Workspace Manager
' (https://documentation.devexpress.com/WindowsForms/CustomDocument17674.aspx).
' 
' You can find sample updates and versions for different programming languages here:
' http://www.devexpress.com/example=T190543
Imports DevExpress.Utils.Animation
Imports DevExpress.XtraEditors
Imports System
Imports System.Linq
Imports System.Windows.Forms

Namespace T190543

    Public Partial Class Form1
        Inherits DevExpress.XtraBars.Ribbon.RibbonForm

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
            DevExpress.LookAndFeel.UserLookAndFeel.Default.SetSkinStyle("Office 2013")
            Init()
        End Sub

        Private Sub Init()
            repositoryItemLookUpEdit1.DataSource = workspaceManager1.Workspaces
            repositoryItemLookUpEdit1.DisplayMember = "Name"
            repositoryItemLookUpEdit1.ValueMember = "Name"
            repositoryItemLookUpEdit1.PopulateColumns()
            repositoryItemLookUpEdit1.Columns(1).Visible = False
            repositoryItemLookUpEdit1.Columns(2).Visible = False
            selectWorkSpaceItem.EditValue = "Default"
            workspaceManager1.CloseStreamOnWorkspaceSaving = DevExpress.Utils.DefaultBoolean.True
            workspaceManager1.CloseStreamOnWorkspaceLoading = DevExpress.Utils.DefaultBoolean.True
            workspaceManager1.CaptureWorkspace("Default")
            repositoryItemComboBox1.Items.AddRange([Enum].GetValues(GetType(TransitionType)))
            AddHandler repositoryItemComboBox1.EditValueChanged, AddressOf repositoryItemComboBox1_EditValueChanged
            transitionItem.EditValue = TransitionType.Push
        End Sub

#Region "Events"
        Private Sub tabbedView1_QueryControl(ByVal sender As Object, ByVal e As DevExpress.XtraBars.Docking2010.Views.QueryControlEventArgs)
            e.Control = New Control()
        End Sub

        Private Sub repositoryItemComboBox1_EditValueChanged(ByVal sender As Object, ByVal e As EventArgs)
            Dim edit As ComboBoxEdit = TryCast(sender, ComboBoxEdit)
            If edit IsNot Nothing Then
                Dim value As TransitionType = CType(edit.EditValue, TransitionType)
                Dim transition As BaseTransition = Nothing
                Select Case value
                    Case TransitionType.Clock
                        transition = New ClockTransition()
                    Case TransitionType.Comb
                        transition = New CombTransition()
                    Case TransitionType.Cover
                        transition = New CoverTransition()
                    Case TransitionType.Dissolve
                        transition = New DissolveTransition()
                    Case TransitionType.Fade
                        transition = New FadeTransition()
                    Case TransitionType.Push
                        transition = New PushTransition()
                    Case TransitionType.Shape
                        transition = New ShapeTransition()
                    Case TransitionType.SlideFade
                        transition = New SlideFadeTransition()
                End Select

                workspaceManager1.TransitionType = transition
            End If
        End Sub

        Private Sub captureItem_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs)
            If workspaceNameItem.EditValue IsNot Nothing Then
                Dim workspaceName As String = workspaceNameItem.EditValue.ToString()
                Dim item = workspaceManager1.Workspaces.Where(Function(i) Equals(i.Name, workspaceName)).FirstOrDefault()
                If Not String.IsNullOrEmpty(workspaceName) AndAlso item Is Nothing Then workspaceManager1.CaptureWorkspace(workspaceName)
            End If
        End Sub

        Private Sub applyItem_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs)
            If selectWorkSpaceItem.EditValue IsNot Nothing Then
                Dim selectWorkSpaceItem As String = Me.selectWorkSpaceItem.EditValue.ToString()
                If Not String.IsNullOrEmpty(selectWorkSpaceItem) Then workspaceManager1.ApplyWorkspace(selectWorkSpaceItem)
            End If
        End Sub

        Private Sub saveItem_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs)
            Dim workspaceName As String = String.Empty
            saveFileDialog1.InitialDirectory = "C:\Users\Public\Documents\"
            If XtraMessageBox.Show("Capture a new workspace or use an existing one? Click 'Yes' to capture a new workspace or 'No' to save the selected workspace.", "Create new workspace?", MessageBoxButtons.YesNo) = DialogResult.Yes Then
                If saveFileDialog1.ShowDialog() = DialogResult.OK Then
                    workspaceName = IO.Path.GetFileNameWithoutExtension(saveFileDialog1.FileName)
                    workspaceManager1.CaptureWorkspace(workspaceName)
                    workspaceManager1.SaveWorkspace(workspaceManager1.Workspaces(0).Name, saveFileDialog1.FileName)
                End If
            Else
                workspaceName = selectWorkSpaceItem.EditValue.ToString()
            End If

            If Not String.IsNullOrEmpty(workspaceName) Then workspaceManager1.SaveWorkspace(workspaceName, saveFileDialog1.InitialDirectory & workspaceName & ".xml")
        End Sub

        Private Sub loadItem_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs)
            saveFileDialog1.InitialDirectory = "C:\Users\Public\Documents\"
            If openFileDialog1.ShowDialog() = DialogResult.OK Then
                Dim workspaceName As String = IO.Path.GetFileNameWithoutExtension(openFileDialog1.FileName)
                If workspaceManager1.LoadWorkspace(IO.Path.GetFileNameWithoutExtension(openFileDialog1.FileName), openFileDialog1.FileName) Then
                    workspaceManager1.ApplyWorkspace(workspaceName)
                End If
            End If
        End Sub
#End Region
    End Class

    Public Enum TransitionType
        Push
        Shape
        Fade
        Clock
        Dissolve
        SlideFade
        Cover
        Comb
    End Enum
End Namespace