Class AddWorkspaceTransform

Namespace

Whim

Assembly

Whim.dll

Create a workspace with the given Name and layout engines. If this transform is called prior to initialization, then IWorkspace creation is deferred. null is returned by the transform if the workspace creation was deferred.

public record AddWorkspaceTransform : Transform<Guid>, IEquatable<Transform<Guid>>, IEquatable<AddWorkspaceTransform>

Inheritance

object

Transform<Guid>

AddWorkspaceTransform

Implements

IEquatable<Transform<Guid>>

IEquatable<AddWorkspaceTransform>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AddWorkspaceTransform(string?, IEnumerable<CreateLeafLayoutEngine>?, Guid, IEnumerable<int>?)

Create a workspace with the given Name and layout engines. If this transform is called prior to initialization, then IWorkspace creation is deferred. null is returned by the transform if the workspace creation was deferred.

public AddWorkspaceTransform(string? Name = null, IEnumerable<CreateLeafLayoutEngine>? CreateLeafLayoutEngines = null, Guid WorkspaceId = default, IEnumerable<int>? MonitorIndices = null)

Parameters

Name string

The name of the workspace. Defaults to null, which will generate the name Workspace {n}.

CreateLeafLayoutEngines IEnumerable<CreateLeafLayoutEngine>

The layout engines to add to the workspace. Defaults to null, which will use the Whim.WorkspaceSector.CreateLayoutEngines function.

WorkspaceId Guid

The ID of the workspace. Defaults to NewGuid().

MonitorIndices IEnumerable<int>

The indices of the monitors the workspace is allowed to be on. Defaults to null, which will allow the workspace to be on all monitors.

Properties

CreateLeafLayoutEngines

The layout engines to add to the workspace. Defaults to null, which will use the Whim.WorkspaceSector.CreateLayoutEngines function.

public IEnumerable<CreateLeafLayoutEngine>? CreateLeafLayoutEngines { get; init; }

Property Value

IEnumerable<CreateLeafLayoutEngine>

MonitorIndices

The indices of the monitors the workspace is allowed to be on. Defaults to null, which will allow the workspace to be on all monitors.

public IEnumerable<int>? MonitorIndices { get; init; }

Property Value

IEnumerable<int>

Name

The name of the workspace. Defaults to null, which will generate the name Workspace {n}.

public string? Name { get; init; }

Property Value

string

WorkspaceId

The ID of the workspace. Defaults to NewGuid().

public Guid WorkspaceId { get; init; }

Property Value

Guid