Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription Interface Reference

Describe the information displayed about a field and its values. More...

Inheritance diagram for Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription:

Public Member Functions

IEnumerable< string > Terms (object value)
 Given a value return terms that can be used in a dialog to match the object. More...
 
DescribeAttribute ValueDescription (object value)
 Return the description of a specific value. More...
 

Properties

bool AllowDefault [get]
 Allow the default value as an option. More...
 
bool AllowNumbers [get]
 Allow user input to match numbers shown with enumerated choices. More...
 
bool AllowsMultiple [get]
 Are multiple matches allowed. More...
 
DescribeAttribute FieldDescription [get]
 Description of the field itself. More...
 
IEnumerable< string > FieldTerms [get]
 Terms for matching this field. More...
 
FieldRole Role [get]
 Role field plays in a form. More...
 
IEnumerable< DescribeAttributeValueDescriptions [get]
 Return all possible value descriptions in order to support enumeration. More...
 
IEnumerable< object > Values [get]
 All possible values or null if it is a data type like number. More...
 

Detailed Description

Describe the information displayed about a field and its values.

Throughout this class Description refers to the name of a field or a value whereas "terms" tell what people can type to match the field or terms in it. When generating terms it is a good idea to include anything that might be reasonable for someone to type. The form dialog itself will help clarify any ambiguity. One way to do this is to use TermsAttribute.MaxPhrase which ensures that Language.GenerateTerms is called on your base terms.

Definition at line 157 of file IField.cs.

Member Function Documentation

IEnumerable<string> Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription.Terms ( object  value)

Given a value return terms that can be used in a dialog to match the object.

Parameters
valueValue that would result from a match.
Returns
Enumeration of regex.

Implemented in Microsoft.Bot.Builder.FormFlow.Advanced.Field< T >.

DescribeAttribute Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription.ValueDescription ( object  value)

Return the description of a specific value.

Parameters
valueValue being described.
Returns
Description of value.

Implemented in Microsoft.Bot.Builder.FormFlow.Advanced.Field< T >.

Property Documentation

bool Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription.AllowDefault
get

Allow the default value as an option.

Returns
True if default values are allowed.

Definition at line 217 of file IField.cs.

bool Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription.AllowNumbers
get

Allow user input to match numbers shown with enumerated choices.

Returns
True if numbers are allowed as input.

Definition at line 223 of file IField.cs.

bool Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription.AllowsMultiple
get

Are multiple matches allowed.

Returns
True if more than one value is allowed.

This is true is you have a list of enumerated values.

Definition at line 211 of file IField.cs.

DescribeAttribute Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription.FieldDescription
get

Description of the field itself.

Returns
Field description.

This is the value that will be used in Pattern Language by {&}, choices with {||} or buttons.

Definition at line 172 of file IField.cs.

IEnumerable<string> Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription.FieldTerms
get

Terms for matching this field.

Returns
List of term regex for matching the field name.

Definition at line 178 of file IField.cs.

FieldRole Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription.Role
get

Role field plays in a form.

Returns
Role field plays in form.

Definition at line 163 of file IField.cs.

IEnumerable<DescribeAttribute> Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription.ValueDescriptions
get

Return all possible value descriptions in order to support enumeration.

Returns
All possible value descriptions.

Definition at line 191 of file IField.cs.

IEnumerable<object> Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription.Values
get

All possible values or null if it is a data type like number.

Returns
All possible values.

Definition at line 204 of file IField.cs.


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