< Back

Namespace: Webmaster442.WindowsTerminal.Fragments

A profile is a set of settings that can be applied to a terminal window.

public class TerminalProfile : System.IEquatable`1[[Webmaster442.WindowsTerminal.Fragments.TerminalProfile, Webmaster442.WindowsTerminal, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]]

Inheritance Object → TerminalProfile
Implements IEquatable<TerminalProfile>
Attributes NullableContextAttribute, NullableAttribute, RequiredMemberAttribute

protected Type EqualityContract { get; }

Type

This is the name of the profile that will be displayed in the dropdown menu.

public string Name { get; set; }

String

This is the executable used in the profile.

public string CommandLine { get; set; }

String

This is the directory the shell starts in when it is loaded.

public string StartingDirectory { get; set; }

String

This sets the icon that displays within the tab, dropdown menu, jumplist, and tab switcher.

public string Icon { get; set; }

String

If set, this will replace the name as the title to pass to the shell on startup. Some shells (like bash) may choose to ignore this initial value, while others (Command Prompt, PowerShell) may use this value over the lifetime of the application.

public string TabTitle { get; set; }

String

If set, this profile will automatically open up in an "elevated" window (running as Administrator) by default.

public bool Elevate { get; set; }

Boolean

If hidden is set to true, the profile will not appear in the list of profiles. This can be used to hide default profiles and dynamically generated profiles

public bool Hidden { get; set; }

Boolean

This is the name of the color scheme used in the profile. Color schemes are defined in the schemes object.

public string ColorScheme { get; set; }

String

When this is set to true, the window will have an acrylic background. When it's set to false, the window will have a plain, untextured background.

public bool UseAcrylic { get; set; }

Boolean

This sets the file location of the image to draw over the window background. The background image can be a .jpg, .png, or .gif file. "desktopWallpaper" will set the background image to the desktop's wallpaper.

public string BackgroundImage { get; set; }

String

This sets the transparency of the background image.

public double BackgroundImageOpacity { get; set; }

Double

This sets how the background image aligns to the boundaries of the window.

public TerminalBackgroundImageAlignment BackgroundImageAlignment { get; set; }

TerminalBackgroundImageAlignment

This sets how the background image is resized to fill the window.

public TerminalBackgroundImageStretchMode BackgroundImageStretchMode { get; set; }

TerminalBackgroundImageStretchMode

This sets the transparency of the window for the profile. This accepts an integer value from 0-100, representing a "percent opaque". 100 is "fully opaque", 50 is semi-transparent, and 0 is fully transparent.

public int Opacity { get; set; }

Int32

Show marks on the scrollbar. Enable this option for shell integration.

public bool ShowMarksOnScrollbar { get; set; }

Boolean

Atuo mark prompts. Enable this option for shell integration.

public bool AutoMarkPrompts { get; set; }

Boolean

Font settings for the profile

public TerminalFont Font { get; set; }

TerminalFont

Constructors of types with required members are not supported in this version of your compiler.

Creates a new instance of the TerminalProfile class.

public TerminalProfile()

protected TerminalProfile(TerminalProfile original)

original TerminalProfile

Crates a Terminal profile for Anaconda3

public static TerminalProfile CreateAnaconda3(string installPath)

installPath String
Anaconda3 install path.

TerminalProfile
A terminal profile configured for Anaconda3.

Crates a Terminal profile for Cmder

public static TerminalProfile CreateCmder(string installPath)

installPath String
Cmder install path.

TerminalProfile
A terminal profile configured for Cmder

Creates a Terminal profile for Cygwin

public static TerminalProfile CreateCygwin(string installPath)

installPath String
Cygwin install path.

TerminalProfile
A terminal profile configured for Cygwin

Creates a Terminal profile for Far Manager

public static TerminalProfile CreateFarManager(string installPath)

installPath String
Far manager install path.

TerminalProfile
A terminal profile configured for Far

Creates a Terminal profile for Git Bash

public static TerminalProfile CreateGitBash(string installPath)

installPath String
Git bash install path

TerminalProfile
A terminal profile configured for git bash

public string ToString()

String

protected bool PrintMembers(StringBuilder builder)

builder StringBuilder

Boolean

public int GetHashCode()

Int32

public bool Equals(object obj)

obj Object

Boolean

public bool Equals(TerminalProfile other)

other TerminalProfile

Boolean

public TerminalProfile <Clone>$()

TerminalProfile

< Back