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.WorkspacePane

API reference · Markdown

class LibTmux.Workspace.WorkspacePane class [source] ¶

Describes one pane in a supported tmuxp workspace.

Discussed in C# workspace builder API

Members

WorkspacePane

WorkspacePane ( shellCommands : IReadOnlyList<string>? , startDirectory : string? , focus : bool , options : IReadOnlyDictionary<string, string>? , commands : IReadOnlyList<WorkspaceCommand>? , enter : bool? ) method [source] ¶

Initializes a pane description.

Parameters

shellCommands ( IReadOnlyList<string>? ) – The commands to run, in order.
startDirectory ( string? ) – The directory the pane starts in.
focus ( bool ) – Whether the pane is left selected.
options ( IReadOnlyDictionary<string, string>? ) – The pane options to set.
commands ( IReadOnlyList<WorkspaceCommand>? ) – Typed commands; use instead of shellCommands to set Enter overrides.
enter ( bool? ) – The pane's initial Enter state, or null for the default.

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>? ) → WorkspacePane 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.

ShellCommands

ShellCommands : IReadOnlyList<string> property [source] ¶: Gets the commands to run, in order.

Commands : IReadOnlyList<WorkspaceCommand> property [source] ¶: Gets the typed pane commands in declaration order.

Enter : bool? property [source] ¶: Gets the pane's initial Enter state, or null for the default.

StartDirectory

StartDirectory : string? property [source] ¶: Gets the directory the pane starts in.

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

Options : IReadOnlyDictionary<string, string> property [source] ¶: Gets the pane options to set.