ColoredGlyphAndEffect Class
Definition
Section titled “Definition”A ColoredGlyphBase with a ICellEffect.
public sealed class ColoredGlyphAndEffect : ColoredGlyph, IMatchable<ColoredGlyphBase>, IMatchable<ColoredGlyph>, IMatchable<ColoredGlyphAndEffect>Inheritance object → ColoredGlyphBase → ColoredGlyph
Implements IMatchable<ColoredGlyphBase>, IMatchable<ColoredGlyph>, IMatchable<ColoredGlyphAndEffect>
Constructors
Section titled “Constructors”ColoredGlyphAndEffect()
Section titled “ColoredGlyphAndEffect()”public ColoredGlyphAndEffect()Properties
Section titled “Properties”Effect
Section titled “Effect”The effect of this cell.
public ICellEffect? Effect { get; set; }Methods
Section titled “Methods”FromColoredGlyph(ColoredGlyphBase, ICellEffect?)
Section titled “FromColoredGlyph(ColoredGlyphBase, ICellEffect?)”Creates a new ColoredGlyphAndEffect from a ColoredGlyphBase with the specified effect.
public static ColoredGlyphAndEffect FromColoredGlyph(ColoredGlyphBase glyph, ICellEffect? effect = null)Parameters
Section titled “Parameters”glyph ColoredGlyphBase
The glyph.
effect ICellEffect
When provided, sets the Effect.
Returns
Section titled “Returns”CopyAppearanceTo(ColoredGlyphAndEffect, bool)
Section titled “CopyAppearanceTo(ColoredGlyphAndEffect, bool)”Copies the visual appearance to the specified cell. This includes foreground, background, glyph, mirror effect and decorators.
public void CopyAppearanceTo(ColoredGlyphAndEffect cell, bool deepCopy = true)Parameters
Section titled “Parameters”cell ColoredGlyphAndEffect
The target cell to copy to.
deepCopy bool
Whether to perform a deep copy. Decorators are copied to a new array when true; when false, the old decorator array reference is moved directly.
CopyAppearanceFrom(ColoredGlyphAndEffect, bool)
Section titled “CopyAppearanceFrom(ColoredGlyphAndEffect, bool)”Sets the foreground, background, glyph, mirror effect and decorators to the same as the specified cell.
public void CopyAppearanceFrom(ColoredGlyphAndEffect cell, bool deepCopy = true)Parameters
Section titled “Parameters”cell ColoredGlyphAndEffect
The target cell to copy from.
deepCopy bool
Whether to perform a deep copy. Decorators are copied to a new array when true; when false, the old decorator array reference is moved directly.
Clear()
Section titled “Clear()”Resets the foreground, background, glyph, mirror effect and decorators.
public override void Clear()Clone()
Section titled “Clone()”Returns a new cell with the same properties as this one.
public override ColoredGlyphBase Clone()Returns
Section titled “Returns”ColoredGlyphBase
The new cell.
Matches(ColoredGlyphAndEffect?)
Section titled “Matches(ColoredGlyphAndEffect?)”Checks if this ColoredGlyphAndEffect object’s properties match another’s.
public bool Matches(ColoredGlyphAndEffect? other)Parameters
Section titled “Parameters”other ColoredGlyphAndEffect
The other object to check.
Returns
Section titled “Returns”bool
Returns true when the object’s properties match; otherwise false.