Class ToggleSwitch
Represents a button that can be toggled on/off within a group of other buttons.
Inherited Members
Namespace: SadConsole.UI.Controls
Assembly: SadConsole.dll
Syntax
[DataContract]
public class ToggleSwitch : ToggleButtonBaseConstructors
ToggleSwitch(int, int)
Creates a new checkbox control with the specified width and height.
Declaration
public ToggleSwitch(int width, int height)Parameters
| Type | Name | Description |
|---|---|---|
| int | width | The width of the control. |
| int | height | The height of the control. |
Properties
BackgroundGlyph
The background glyph of the switch.
Declaration
[DataMember]
public int BackgroundGlyph { get; set; }Property Value
| Type | Description |
|---|---|
| int |
OffGlyphColor
The color of the OnGlyph when the control is IsSelected is false.
Declaration
[DataMember]
public Color OffGlyphColor { get; set; }Property Value
| Type | Description |
|---|---|
| Color |
OnGlyph
The on glyph of the switch.
Declaration
[DataMember]
public int OnGlyph { get; set; }Property Value
| Type | Description |
|---|---|
| int |
OnGlyphColor
The color of the OnGlyph when the control is IsSelected is true.
Declaration
[DataMember]
public Color OnGlyphColor { get; set; }Property Value
| Type | Description |
|---|---|
| Color |
SwitchOrientation
The orientation of the toggle switch relative to the text.
Declaration
public HorizontalAlignment SwitchOrientation { get; set; }Property Value
| Type | Description |
|---|---|
| HorizontalAlignment |
Remarks
SwitchThemeState
The theme state used for the switch.
Declaration
public ThemeStates SwitchThemeState { get; protected set; }Property Value
| Type | Description |
|---|---|
| ThemeStates |
Methods
OnClick()
Perfroms a click on the base button and also toggles the IsSelected property.
Declaration
protected override void OnClick()Overrides
RefreshThemeStateColors(Colors)
Updates the ThemeState by calling RefreshTheme(Colors) with the provided colors. Override this method to adjust how colors are used by the ThemeState.
Declaration
protected override void RefreshThemeStateColors(Colors colors)Parameters
| Type | Name | Description |
|---|---|---|
| Colors | colors | The colors to apply to the theme state. |
Overrides
UpdateAndRedraw(TimeSpan)
Redraws the control if applicable.
Declaration
public override void UpdateAndRedraw(TimeSpan time)Parameters
| Type | Name | Description |
|---|---|---|
| TimeSpan | time | The duration of thecurrent frame. |