C# Class SILUBS.ScriptureChecks.PunctuationCheck

Checks sequences of punctuation (in relation to their positions in surrounding text).

Inheritance: IScrCheckInventory

Mostrar archivo Open project: sillsdev/FieldWorks Class Usage Examples

Public Methods

Method	Description
Check ( IEnumerable toks, RecordErrorHandler record ) : void	Execute the check. Call 'RecordError' for every error found.
GetReferences ( IEnumerable tokens, string desiredKey ) : List	Return a TextTokenSubstring for all occurances of the desiredKey.
PunctuationCheck ( IChecksDataSource checksDataSource ) : System	Initializes a new instance of the PunctuationCheck class.
Save ( ) : void	Update the parameter values for storing Paratext's valid and invalid lists in CheckDataSource and then save them. This is here because the Paratext inventory form does not know the names of the parameters that need to be saved for a given check, only the check knows this.

Private Methods

Method	Description
Localize ( string strToLocalize ) : string	Returns a localized version of the specified string.

Method Details

Check() public method

Execute the check. Call 'RecordError' for every error found.

public Check ( IEnumerable toks, RecordErrorHandler record ) : void
toks	IEnumerable	ITextToken's corresponding to the text to be checked. /// Typically this is one books worth.
record	RecordErrorHandler	Call this delegate to report each error found.
return	void

GetReferences() public method

Return a TextTokenSubstring for all occurances of the desiredKey.

public GetReferences ( IEnumerable tokens, string desiredKey ) : List
tokens	IEnumerable
desiredKey	string	e.g., _[_ or empty string to look for all patterns
return	List

PunctuationCheck() public method

Initializes a new instance of the PunctuationCheck class.

public PunctuationCheck ( IChecksDataSource checksDataSource ) : System
checksDataSource	IChecksDataSource	The checks data source.
return	System

Save() public method

Update the parameter values for storing Paratext's valid and invalid lists in CheckDataSource and then save them. This is here because the Paratext inventory form does not know the names of the parameters that need to be saved for a given check, only the check knows this.

public Save ( ) : void
return	void