A newer version of this page is available. Switch to the current version.

WorkspaceManager Members

Manages layouts of all DevExpress controls in the application as one global workspace. Workspaces can be saved and restored to (from) a local storage or stream.

Constructors

Name Description
WorkspaceManager() Initializes a new instance of the WorkspaceManager class with the default settings.
WorkspaceManager(IContainer) Initializes a new instance of the WorkspaceManager class with the specified settings.

Properties

Name Description
AllowTransitionAnimation Gets or sets whether or not changing workspaces within this WorkspaceManager should be followed by animation effects.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
CloseStreamOnWorkspaceLoading Gets or sets whether this WorkspaceManager should automatically close streams opened when loading workspaces.
CloseStreamOnWorkspaceSaving Gets or sets whether this WorkspaceManager should automatically close streams opened when saving workspaces.
Container Gets the IContainer that contains the Component. Inherited from Component.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
RecentWorkspaces Provides access to the recently used workspaces collection.
SaveTargetControlSettings Gets or sets whether the WorkspaceManager should store settings like "Bounds" or "State" for the form assigned to the WorkspaceManager.TargetControl property.
ShowPathColumnInWorkspacesDialog Gets or sets whether the "Workspaces" dialog should display the column that shows paths to workspace files.
Site Gets or sets the ISite of the Component. Inherited from Component.
TargetControl Gets or sets a control whose layout is managed by this WorkspaceManager.
TransitionType Gets or sets the transition animation that follows applying workspaces.
Workspaces Provides access to all currently active workspaces.

Methods

Name Description
ApplyWorkspace(String) Locates a workspace with the target name within the WorkspaceManager.Workspaces collection and applies it to the application.
CaptureWorkspace(String, Boolean) Captures the current form layout and places it to the WorkspaceManager.Workspaces collection under the specific name.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose() Releases all resources used by the Component. Inherited from Component.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
FromControl(Control) static Gets a WorkspaceManager stored within the target control.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType() Gets the Type of the current instance. Inherited from Object.
GetWorkspace(Int32) Returns a workspace with a specific index from the WorkspaceManager.Workspaces collection.
GetWorkspace(String) Returns a workspace with a specific name from the WorkspaceManager.Workspaces collection.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
LoadWorkspace(String, Stream) Loads a workspace from the target stream and places it in the WorkspaceManager.Workspaces collection under the specific name.
LoadWorkspace(String, Stream, Boolean) Loads a workspace from the target stream and places this workspace in the WorkspaceManager.Workspaces collection under the specific name.
LoadWorkspace(String, Object) Loads a workspace from the target local file and places it in the WorkspaceManager.Workspaces collection under the specific name.
LoadWorkspace(String, Object, Boolean) Loads a workspace from the target file and places this workspace in the WorkspaceManager.Workspaces collection under the specific name.
LoadWorkspaces(Stream) Loads all workspaces in the target stream into the WorkspaceManager.Workspaces collection.
LoadWorkspaces(Object) Loads all workspaces in the target file into the WorkspaceManager.Workspaces collection.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemoveWorkspace(String) Removes a workspace with the target name from the WorkspaceManager.Workspaces collection.
RenameWorkspace(String, String) Renames the target workspace.
RestoreLayout(Control, Stream) static Retrieves the stored layout version of the root control from a stream.
RestoreLayout(Control, String) static Retrieves the stored layout version of the root control from a file.
SaveLayout(Control, Stream) static Saves the layout of one specific control to a target stream.
SaveLayout(Control, String) static Saves the layout of one specific control to a target local storage location.
SaveWorkspace(String, Stream, Boolean) Saves a workspace from the WorkspaceManager.Workspaces collection to a stream.
SaveWorkspace(String, Object, Boolean) Saves a workspace from the WorkspaceManager.Workspaces collection to a local file.
SaveWorkspaces(Stream) Saves all workspaces in the WorkspaceManager.Workspaces collection to the target stream.
SaveWorkspaces(Object) Saves all workspaces in the WorkspaceManager.Workspaces collection to the target file.
SetSerializationEnabled(Component, Boolean) static Allows you to exclude a specific control from the global application workspace.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

Name Description
AfterApplyWorkspace Occurs after a workspace was applied.
BeforeApplyWorkspace Occurs immediately after the WorkspaceManager.ApplyWorkspace method is called.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
PropertyDeserializing Occurs whenever a property is about to be restored from a workspace.
PropertySerializing Occurs whenever a property is about to be written into a workspace.
WorkspaceAdded Occurs whenever a new workspace was added to the WorkspaceManager.Workspaces collection.
WorkspaceCollectionChanged Occurs whenever the WorkspaceManager.Workspaces collection of the current Workspace Manager component changes.
WorkspaceRemoved Fires when a workspace was removed from the WorkspaceManager.Workspaces collection.
WorkspaceSaved Occurs after the WorkspaceManager.SaveWorkspace method was called.
See Also