Represents a result from a word lookup operation. More...

Collaboration diagram for WordResult:

Properties
IList< string >	allWords `[get]`
	All words returned from the lookup operation. More...

static WordResult	empty `[get]`
	Represents an empty WordResult. More...

bool	hasValue `[get]`
	Whether or not the result is empty. More...

string	input `[get]`
	The input string for the lookup operation. More...

bool	isValid `[get]`
	Whether or not the result is valid (at least one word was found). More...

bool	wasOrdered `[get]`
	Whether or not the word lookup was an ordered search. More...

string	word `[get]`
	The first word found in the lookup operation. Included for convenience. More...

Detailed Description

Represents a result from a word lookup operation.

Note that this type is passed by value for performance reasons.

Property Documentation

IList<string> allWords

get

All words returned from the lookup operation.

staticget

Represents an empty WordResult.

This is only created as a result of an invalid word lookup operation. Assigning a WordResult to this value is useful to invalidate previous results.

bool hasValue

get

Whether or not the result is empty.

This only returns false as a result of an invalid word lookup operation.

string input

get

The input string for the lookup operation.

bool isValid

get

Whether or not the result is valid (at least one word was found).

bool wasOrdered

get

Whether or not the word lookup was an ordered search.

string word

get

The first word found in the lookup operation. Included for convenience.