IField<T> Interface

Reference

Definition

Namespace:: Microsoft.Bot.Builder.FormFlow.Advanced

Assembly:: Microsoft.Bot.Builder.dll

Package:: Microsoft.Bot.Builder v3.30.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Interface for all the information about a specific field.

public interface IField<T> : Microsoft.Bot.Builder.FormFlow.Advanced.IFieldDescription, Microsoft.Bot.Builder.FormFlow.Advanced.IFieldPrompt<T>, Microsoft.Bot.Builder.FormFlow.Advanced.IFieldResources, Microsoft.Bot.Builder.FormFlow.Advanced.IFieldState<T> where T : class

type IField<'T (requires 'T : null)> = interface
    interface IFieldState<'T (requires 'T : null)>
    interface IFieldDescription
    interface IFieldPrompt<'T (requires 'T : null)>
    interface IFieldResources

Public Interface IField(Of T)
Implements IFieldDescription, IFieldPrompt(Of T), IFieldResources, IFieldState(Of T)

Type Parameters

T

Form state interface applies to.

Derived: Microsoft.Bot.Builder.FormFlow.Advanced.Field<T>

Implements: IFieldDescription IFieldPrompt<T> IFieldResources IFieldState<T>

Properties

AllowDefault	Allow the default value as an option. (Inherited from IFieldDescription)
AllowNumbers	Allow user input to match numbers shown with enumerated choices. (Inherited from IFieldDescription)
AllowsMultiple	Are multiple matches allowed. (Inherited from IFieldDescription)
Dependencies	Returns the other fields this one depends on. (Inherited from IFieldState<T>)
FieldDescription	Description of the field itself. (Inherited from IFieldDescription)
FieldTerms	Terms for matching this field. (Inherited from IFieldDescription)
Form	Form that owns this field
Help	Return the help description for this field. (Inherited from IFieldPrompt<T>)
IsNullable	Test to see if field is nullable. (Inherited from IFieldState<T>)
Name	Name of this field.
Optional	Test to see if field is optional which means that an unknown value is legal. (Inherited from IFieldState<T>)
Pattern	Regular expression for validating a string. (Inherited from IFieldState<T>)
Prompt	Returns the prompt description. (Inherited from IFieldPrompt<T>)
Role	Role field plays in a form. (Inherited from IFieldDescription)
Type	Gets the type of the field. (Inherited from IFieldState<T>)
ValueDescriptions	Return all possible value descriptions in order to support enumeration. (Inherited from IFieldDescription)
Values	All possible values or null if it is a data type like number. (Inherited from IFieldDescription)

Methods

Active(T)	Test to see if field is currently active based on the current state. (Inherited from IFieldPrompt<T>)
DefineAsync(T)	Build the prompt and recognizer for dynamically defined fields. (Inherited from IFieldPrompt<T>)
GetValue(T)	Get this field value from form state. (Inherited from IFieldState<T>)
IsUnknown(T)	Test to see if the field value form state has a value. (Inherited from IFieldState<T>)
Limits(Double, Double)	Limits of numeric values. (Inherited from IFieldState<T>)
Localize()	Loads any string resources from the form localizer. (Inherited from IFieldResources)
Next(Object, T)	Next step to execute. (Inherited from IFieldPrompt<T>)
SaveResources()	Adds any string resources to form localizer. (Inherited from IFieldResources)
SetUnknown(T)	Set this field value in form state to unknown. (Inherited from IFieldState<T>)
SetValue(T, Object)	Set this field value in form state. (Inherited from IFieldState<T>)
Template(TemplateUsage)	Return a template for building a prompt. (Inherited from IFieldPrompt<T>)
Terms(Object)	Given a value return terms that can be used in a dialog to match the object. (Inherited from IFieldDescription)
ValidateAsync(T, Object)	Validate value to be set on state and return feedback if not valid. (Inherited from IFieldPrompt<T>)
ValueDescription(Object)	Return the description of a specific value. (Inherited from IFieldDescription)

Applies to

Share via