Recolor Class
Definition
Section titled “Definition”Recors the foreground or the background of a cell.
[DataContract]public class Recolor : CellEffectBase, ICellEffectInheritance object → CellEffectBase
Implements ICellEffect
Constructors
Section titled “Constructors”Recolor()
Section titled “Recolor()”Creates a new instance of the effect.
public Recolor()Properties
Section titled “Properties”Foreground
Section titled “Foreground”The foreground color applied to a cell.
[DataMember]public Color Foreground { get; set; }Background
Section titled “Background”The background color applied to a cell.
[DataMember]public Color Background { get; set; }DoForeground
Section titled “DoForeground”When true, the Foreground color will be applied to the cell.
[DataMember]public bool DoForeground { get; set; }DoBackground
Section titled “DoBackground”/// When true, the Background color will be applied to the cell.
[DataMember]public bool DoBackground { get; set; }Methods
Section titled “Methods”ApplyToCell(ColoredGlyphBase, ColoredGlyphBase)
Section titled “ApplyToCell(ColoredGlyphBase, ColoredGlyphBase)”Applies the state of the effect to a cell.
public override bool ApplyToCell(ColoredGlyphBase cell, ColoredGlyphBase originalState)Parameters
Section titled “Parameters”cell ColoredGlyphBase
The surface cell using this effect.
originalState ColoredGlyphBase
The state of the cell prior to the effect being applied.
Returns
Section titled “Returns”bool
true when this method modified the cell; otherwise false.
Clone()
Section titled “Clone()”Returns a duplicate of this effect.
public override ICellEffect Clone()Returns
Section titled “Returns”ICellEffect
A new copy of this effect.
ToString()
Section titled “ToString()”public override string ToString()