C# Class PowerArgs.Cli.ConditionalKeywordHighlighter

A keyword highlighter that highlights based on a condition

Inheritance: KeywordHighlighter

ファイルを表示 Open project: adamabdelhamed/PowerArgs

Public Methods

Method	Description
ConditionalKeywordHighlighter ( string keyword, Func conditionEval, 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 token matches the keyword and the given conditional evaluation returns true

Method Details

ConditionalKeywordHighlighter() public method

Creates the highlighter.

public ConditionalKeywordHighlighter ( string keyword, Func conditionEval, ConsoleColor fg = null, ConsoleColor bg = null, System.StringComparison comparison = StringComparison.InvariantCulture ) : System
keyword	string	The keyword to match
conditionEval	Func	The conditional match evaluation function
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 characters are compared
return	System

ShouldBeHighlighted() public method

Returns true if the token matches the keyword and the given conditional evaluation returns true

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