C# Class PowerArgs.Cli.KeywordHighlighter

A highlighter that is used to highlight a specific keyword

Inheritance: FixedHighlightTokenHighlighter

Show file Open project: adamabdelhamed/PowerArgs

Protected Properties

Property	Type	Description
keyword	string

Public Methods

Method	Description
KeywordHighlighter ( string keyword, ConsoleColor fg = null, ConsoleColor bg = null, System.StringComparison comparison = StringComparison.InvariantCulture ) : System	Creates the highlighter.
ShouldBeHighlighted ( RichCommandLineContext readerContext, HighlighterContext highlighterContext ) : bool	Returns true if the keyword is matched, false otherwise

Method Details

KeywordHighlighter() public method

Creates the highlighter.

public KeywordHighlighter ( string keyword, ConsoleColor fg = null, ConsoleColor bg = null, System.StringComparison comparison = StringComparison.InvariantCulture ) : System
keyword	string	The keyword to highlight whenever it is found
fg	ConsoleColor	The foreground color of this highlighter. If null, the console default is used.
bg	ConsoleColor	The background color of this highlighter. If null, the console default is used.
comparison	System.StringComparison	determines how strings are compared. By default the comparison is case sensitive
return	System

ShouldBeHighlighted() public method

Returns true if the keyword is matched, false otherwise

public ShouldBeHighlighted ( RichCommandLineContext readerContext, HighlighterContext highlighterContext ) : bool
readerContext	RichCommandLineContext	context from the reader
highlighterContext	HighlighterContext	context about the current token
return	bool

Property Details

keyword protected property

The keyword to highlight whenever it is found

protected string keyword
return	string