Class Button
Simple button control with a height of 1.
Inherited Members
Namespace: SadConsole.UI.Controls
Assembly: SadConsole.dll
Syntax
[DataContract]
public class Button : ButtonBase
Constructors
Button(int, int)
Creates an instance of the button control with the specified width and height.
Declaration
public Button(int width, int height = 1)
Parameters
Type | Name | Description |
---|---|---|
int | width | Width of the control. |
int | height | Height of the control (default is 1). |
Button(string)
Creates an auto sizing button with the specified text.
Declaration
public Button(string text)
Parameters
Type | Name | Description |
---|---|---|
string | text | The text to display on the button. |
Properties
EndsThemeState
The theme state used with the left end of the button.
Declaration
public ThemeStates EndsThemeState { get; protected set; }
Property Value
Type | Description |
---|---|
ThemeStates |
LeftEndGlyph
The theme state used with the left end of the button.Defaults to '<'.
Declaration
[DataMember]
public int LeftEndGlyph { get; set; }
Property Value
Type | Description |
---|---|
int |
RightEndGlyph
The theme state used with the right end of the button. Defaults to '>'.
Declaration
[DataMember]
public int RightEndGlyph { get; set; }
Property Value
Type | Description |
---|---|
int |
ShowEnds
When true, renders the "end" glyphs on the button.
Declaration
[DataMember]
public bool ShowEnds { get; set; }
Property Value
Type | Description |
---|---|
bool |
Methods
CreateControlSurface()
Declaration
protected override ICellSurface CreateControlSurface()
Returns
Type | Description |
---|---|
ICellSurface | The control's surface. |
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. |