Class Attribute
Attributes are used as elements that contain both a foreground and a background or platform specific features
Inheritance
System.Object
Attribute
Remarks
Attributes are needed to map colors to terminal capabilities that might lack colors, on color
scenarios, they encode both the foreground and the background color and are used in the ColorScheme
class to define color schemes that can be used in your application.
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public sealed class Attribute : ValueTypeConstructors
Attribute(Int32)
Initializes a new instance of the Attribute struct with only the value passed to
and trying to get the colors if defined.
Declaration
public Attribute(int value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | value | Value. |
Attribute(Int32, Color, Color)
Initializes a new instance of the Attribute struct.
Declaration
public Attribute(int value, Color foreground, Color background)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | value | Value. |
| Color | foreground | Foreground |
| Color | background | Background |
Attribute(Color)
Initializes a new instance of the Attribute struct
with the same colors for the foreground and background.
Declaration
public Attribute(Color color)Parameters
| Type | Name | Description |
|---|---|---|
| Color | color | The color. |
Attribute(Color, Color)
Initializes a new instance of the Attribute struct.
Declaration
public Attribute(Color foreground, Color background)Parameters
| Type | Name | Description |
|---|---|---|
| Color | foreground | Foreground |
| Color | background | Background |
Properties
Background
The background color.
Declaration
public Color Background { get; }Property Value
| Type | Description |
|---|---|
| Color |
Foreground
The foreground color.
Declaration
public Color Foreground { get; }Property Value
| Type | Description |
|---|---|
| Color |
Value
The color attribute value.
Declaration
public int Value { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
Get()
Gets the current Attribute from the driver.
Declaration
public static Attribute Get()Returns
| Type | Description |
|---|---|
| Attribute | The current attribute. |
Make(Color, Color)
Creates an Attribute from the specified foreground and background.
Declaration
public static Attribute Make(Color foreground, Color background)Parameters
| Type | Name | Description |
|---|---|---|
| Color | foreground | Foreground color to use. |
| Color | background | Background color to use. |
Returns
| Type | Description |
|---|---|
| Attribute | The make. |
Operators
Implicit(Int32 to Attribute)
Implicitly convert an integer value into an Attribute
Declaration
public static implicit operator Attribute(int v)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | v | value |
Returns
| Type | Description |
|---|---|
| Attribute | An attribute with the specified integer value. |
Implicit(Attribute to Int32)
Implicit conversion from an Attribute to the underlying Int32 representation
Declaration
public static implicit operator int (Attribute c)Parameters
| Type | Name | Description |
|---|---|---|
| Attribute | c | The attribute to convert |
Returns
| Type | Description |
|---|---|
| System.Int32 | The integer value stored in the attribute. |