Class Recolor
Recors the foreground or the background of a cell.
Implements
Inherited Members
Namespace: SadConsole.Effects
Assembly: SadConsole.dll
Syntax
[DataContract]
public class Recolor : CellEffectBase, ICellEffectConstructors
Recolor()
Creates a new instance of the effect.
Declaration
public Recolor()Properties
Background
The background color applied to a cell.
Declaration
[DataMember]
public Color Background { get; set; }Property Value
| Type | Description |
|---|---|
| Color |
DoBackground
/// When true, the Background color will be applied to the cell.
Declaration
[DataMember]
public bool DoBackground { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
DoForeground
When true, the Foreground color will be applied to the cell.
Declaration
[DataMember]
public bool DoForeground { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Foreground
The foreground color applied to a cell.
Declaration
[DataMember]
public Color Foreground { get; set; }Property Value
| Type | Description |
|---|---|
| Color |
Methods
ApplyToCell(ColoredGlyphBase, ColoredGlyphBase)
Applies the state of the effect to a cell.
Declaration
public override bool ApplyToCell(ColoredGlyphBase cell, ColoredGlyphBase originalState)Parameters
| Type | Name | Description |
|---|---|---|
| ColoredGlyphBase | cell | The surface cell using this effect. |
| ColoredGlyphBase | originalState | The state of the cell prior to the effect being applied. |
Returns
| Type | Description |
|---|---|
| bool |
Overrides
Clone()
Returns a duplicate of this effect.
Declaration
public override ICellEffect Clone()Returns
| Type | Description |
|---|---|
| ICellEffect | A new copy of this effect. |
Overrides
ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string |