Watch Aspire live streamsDocsTry Aspire

TerminalLaunchOptions Properties

ClassProperties8 members
Describes the process, initial grid, and placement of a terminal created by TerminalService.
ArgumentsSection titled ArgumentsIList<string>
Gets or sets the arguments passed to TerminalLaunchOptions.Executable.
public IList<string> Arguments { get; set; }
ArgumentNullExceptionvalue is null.
Gets or sets the initial number of columns. Defaults to 80.
public int Columns { get; set; }
ArgumentOutOfRangeExceptionvalue is less than one.
The process starts with this grid and retains it while no viewer requests a resize. Dock and interaction dialog viewers resize the grid to fit their available space when shown.
EnvironmentVariablesSection titled EnvironmentVariablesIDictionary<string, string>
Gets environment variables applied to the process on top of the AppHost's own environment.
public IDictionary<string, string> EnvironmentVariables { get; }
The process inherits the AppHost's environment. Entries add or override variables without replacing the rest of that environment, so interactive workloads retain inherited PATH, HOME, and TERM values unless explicitly overridden.
Gets or sets the executable to run. Resolved against PATH when not fully qualified.
public string Executable { get; set; }
ArgumentNullExceptionvalue is null.
ArgumentExceptionvalue is empty.
Gets or sets where the terminal is displayed. Defaults to TerminalPlacement.Dock.
public TerminalPlacement Placement { get; set; }
AppHost-owned terminals support TerminalPlacement.Dock, TerminalPlacement.Dialog, and TerminalPlacement.None. TerminalPlacement.ResourceView is reserved for terminals owned by resources and cannot be used when creating an AppHost-owned terminal.
Gets or sets the initial number of rows. Defaults to 24.
public int Rows { get; set; }
ArgumentOutOfRangeExceptionvalue is less than one.
The process starts with this grid and retains it while no viewer requests a resize. Dock and interaction dialog viewers resize the grid to fit their available space when shown.
Gets or sets the title shown on the terminal's dock tab, and in the title bar when the terminal is detached into its own window.
public string Title { get; set; }
The title must not be empty or consist only of white-space characters.
WorkingDirectorySection titled WorkingDirectorynullablestring?
Gets or sets the working directory the process starts in. Defaults to the AppHost's working directory.
public string? WorkingDirectory { get; set; }