Class Strikethrough

Inheritance
object
ParseCommandBase
BBCodeCommandBase
Strikethrough
Inherited Members
Namespace: SadConsole.StringParser.BBCode
Assembly: SadConsole.dll
Syntax
public class Strikethrough : BBCodeCommandBase

Constructors

Strikethrough()

Declaration
public Strikethrough()

Fields

Glyph

The glyph used for the strikethrough decorator.

Declaration
public static int Glyph
Field Value
Type Description
int

Methods

Build(ref ColoredGlyphAndEffect, ColoredGlyphAndEffect[], int, ICellSurface?, ref int, ReadOnlySpan<char>, ParseCommandStacks)

Builds a glyph.

Declaration
public override void Build(ref ColoredGlyphAndEffect glyphState, ColoredGlyphAndEffect[] glyphString, int surfaceIndex, ICellSurface? surface, ref int stringIndex, ReadOnlySpan<char> processedString, ParseCommandStacks commandStack)
Parameters
Type Name Description
ColoredGlyphAndEffect glyphState

The current glyph being built.
ColoredGlyphAndEffect[] glyphString

The current string of glyphs that has been processed until now.
int surfaceIndex

Where on the surface this glyph will appear.
ICellSurface surface

The surface associated with the glyph.
int stringIndex

Where in the original string this glyph is from.
ReadOnlySpan<char> processedString

The entire string being processed.
ParseCommandStacks commandStack

The state of commands.
Overrides

SetBBCode(string, string?, Dictionary<string, string>?)

Provides the information about the tag that triggered this command.

Declaration
public override void SetBBCode(string tag, string? value, Dictionary<string, string>? parameters)
Parameters
Type Name Description
string tag

The BBCode tag condition that triggered the command.
string value

Optional value provided by the BBCode.
Dictionary<string, string> parameters

Optional parameters provided by the BBCode.
Overrides

Extension Methods