Auto Light Dark

Workspace ManagerAPI Reference

Choose documentation 3

latest

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

.mobile-toolbar, .documentation-context-navigation, #mobile-sidebar, #mobile-toc { display: none !important; }

Browse documentation

Workspace ManagerAPI Reference

LibTmux.Workspace.WorkspaceWindow

API reference · Markdown

class LibTmux.Workspace.WorkspaceWindow class [source] ¶

Describes one window in a supported tmuxp workspace.

Discussed in C# workspace builder API

Members

WorkspaceWindow

WorkspaceWindow ( windowName : string? , startDirectory : string? , layout : string? , focus : bool , options : IReadOnlyDictionary<string, string>? , panes : IReadOnlyList<WorkspacePane>? , windowIndex : int? , optionsAfter : IReadOnlyDictionary<string, string>? ) method [source] ¶

Initializes a window description.

Parameters

windowName ( string? ) – The window name.
startDirectory ( string? ) – The directory its panes start in.
layout ( string? ) – The layout to apply after creating its panes.
focus ( bool ) – Whether the window is left selected.
options ( IReadOnlyDictionary<string, string>? ) – The window options to set before pane commands and splits.
panes ( IReadOnlyList<WorkspacePane>? ) – The panes to create, in order.
windowIndex ( int? ) – The session-relative window index, or null for the next free index.
optionsAfter ( IReadOnlyDictionary<string, string>? ) – The window options to set after pane commands and the final layout.

Environment : IReadOnlyDictionary<string, string> property [source] ¶: Gets the environment entries contributed by this declaration.

ShellCommandsBefore

ShellCommandsBefore : IReadOnlyList<string> property [source] ¶: Gets the commands prepended at this declaration level.

BeforeCommands

BeforeCommands : IReadOnlyList<WorkspaceCommand> property [source] ¶: Gets the typed commands prepended at this declaration level.

WithDefaults ( environment : IReadOnlyDictionary<string, string>? , shellCommandsBefore : IReadOnlyList<string>? , beforeCommands : IReadOnlyList<WorkspaceCommand>? ) → WorkspaceWindow method [source] ¶

Returns a declaration with replacement environment and pre-command defaults.

Parameters

environment ( IReadOnlyDictionary<string, string>? ) – The local entries to copy, or null to preserve the existing entries.
shellCommandsBefore ( IReadOnlyList<string>? ) – The local commands to copy, or null to preserve the existing commands.
beforeCommands ( IReadOnlyList<WorkspaceCommand>? ) – Typed local commands; use instead of shellCommandsBefore.

Returns

A new declaration; empty collections clear the corresponding defaults.

Raises

ArgumentException – An environment name is empty or contains '=' or NUL, or a value contains NUL.

WindowName : string? property [source] ¶: Gets the window name.

WindowIndex : int? property [source] ¶: Gets the requested session-relative window index, or null for the next free index.

StartDirectory

StartDirectory : string? property [source] ¶: Gets the directory its panes start in.

Layout : string? property [source] ¶: Gets the layout to apply after creating its panes.

Focus : bool property [source] ¶: Gets whether the window is left selected.

Options : IReadOnlyDictionary<string, string> property [source] ¶: Gets the window options to set before pane commands and splits.

OptionsAfter : IReadOnlyDictionary<string, string> property [source] ¶: Gets the window options to set after pane commands and the final layout.

Panes : IReadOnlyList<WorkspacePane> property [source] ¶: Gets the panes to create, in order.