Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeNumber< T > Class Template Reference

Recognize a numeric field. More...

Inheritance diagram for Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeNumber< T >:

Public Member Functions

 RecognizeNumber (IField< T > field)
 Construct a numeric recognizer for a field. More...
 
override string Help (T state, object defaultValue)
 Return the help string describing what are valid inputs to the recognizer. More...
 
virtual IEnumerable< TermMatchMatches (string input, object defaultValue=null)
 Return the matches found in the input. More...
 
override TermMatch Parse (string input)
 Abstract method for parsing input. More...
 
override object[] PromptArgs ()
 Return the arguments to pass to the prompt. More...
 
override IEnumerable< string > ValidInputs (object value)
 Return valid inputs to describe a particular value. More...
 
override DescribeAttribute ValueDescription (object value)
 Return the description of a specific value. More...
 
virtual IEnumerable< DescribeAttributeValueDescriptions ()
 Return all possible value descriptions in order to support enumeration. More...
 
virtual IEnumerable< object > Values ()
 Return all possible values or null if a primitive type. More...
 

Protected Member Functions

List< object > HelpArgs (T state, object defaultValue)
 Return the help template args for current choice and no preference. More...
 

Protected Attributes

IField< T > _field
 Field being filled information. More...
 

Detailed Description

Recognize a numeric field.

Template Parameters
TForm state.
Type Constraints
T :class 

Definition at line 570 of file FormFlow/Recognize.cs.

Constructor & Destructor Documentation

Construct a numeric recognizer for a field.

Parameters
fieldNumeric field.

Definition at line 577 of file FormFlow/Recognize.cs.

Member Function Documentation

override string Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeNumber< T >.Help ( state,
object  defaultValue 
)
inlinevirtual

Return the help string describing what are valid inputs to the recognizer.

Returns
Help on what the recognizer accepts.

Implements Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >.

Definition at line 615 of file FormFlow/Recognize.cs.

List<object> Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >.HelpArgs ( state,
object  defaultValue 
)
inlineprotectedinherited

Return the help template args for current choice and no preference.

Parameters
stateForm state.
defaultValueCurrent value of field.
Returns

Definition at line 424 of file FormFlow/Recognize.cs.

virtual IEnumerable<TermMatch> Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >.Matches ( string  input,
object  defaultValue = null 
)
inlinevirtualinherited

Return the matches found in the input.

Parameters
inputThe input string being matched.
defaultValueThe default value or null if none.
Returns
Match records.

Implements Microsoft.Bot.Builder.FormFlow.Advanced.IRecognize< T >.

Definition at line 381 of file FormFlow/Recognize.cs.

override TermMatch Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeNumber< T >.Parse ( string  input)
inlinevirtual

Abstract method for parsing input.

Parameters
inputInput to match.
Returns
TermMatch if input is a match.

Implements Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >.

Definition at line 601 of file FormFlow/Recognize.cs.

override object [] Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeNumber< T >.PromptArgs ( )
inlinevirtual

Return the arguments to pass to the prompt.

remarks>For example a numeric recognizer might pass min and max values.

Returns
An array of arguments.

Reimplemented from Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >.

Definition at line 586 of file FormFlow/Recognize.cs.

override IEnumerable<string> Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeNumber< T >.ValidInputs ( object  value)
inlinevirtual

Return valid inputs to describe a particular value.

Parameters
valueValue being checked.
Returns
Valid inputs for describing value.

Implements Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >.

Definition at line 596 of file FormFlow/Recognize.cs.

override DescribeAttribute Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeNumber< T >.ValueDescription ( object  value)
inlinevirtual

Return the description of a specific value.

Parameters
valueValue to get description of.
Returns
Description of the value.

Implements Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >.

Definition at line 591 of file FormFlow/Recognize.cs.

virtual IEnumerable<DescribeAttribute> Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >.ValueDescriptions ( )
inlinevirtualinherited

Return all possible value descriptions in order to support enumeration.

Returns
All possible value descriptions.

Implements Microsoft.Bot.Builder.FormFlow.Advanced.IRecognize< T >.

Reimplemented in Microsoft.Bot.Builder.FormFlow.Advanced.RecognizeBool< T >.

Definition at line 406 of file FormFlow/Recognize.cs.

virtual IEnumerable<object> Microsoft.Bot.Builder.FormFlow.Advanced.RecognizePrimitive< T >.Values ( )
inlinevirtualinherited

Return all possible values or null if a primitive type.

Returns
All possible values.

Implements Microsoft.Bot.Builder.FormFlow.Advanced.IRecognize< T >.

Definition at line 411 of file FormFlow/Recognize.cs.

Member Data Documentation

Field being filled information.

Definition at line 450 of file FormFlow/Recognize.cs.


The documentation for this class was generated from the following file: