Field<T> Class

Definition

Namespace:

Microsoft.Bot.Builder.FormFlow.Advanced

Assembly:

Microsoft.Bot.Builder.dll

Package:

Microsoft.Bot.Builder v3.30.0

Source:

Field.cs

Base class with declarative implementation of IField.

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

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

Public Class Field(Of T)
Implements IField(Of T), IFieldPrompt(Of T), IFieldState(Of T)

Type Parameters

T

Underlying form state.

Inheritance

Object

Field<T>

Derived

Microsoft.Bot.Builder.FormFlow.Advanced.Confirmation<T>

Microsoft.Bot.Builder.FormFlow.Advanced.FieldReflector<T>

Microsoft.Bot.Builder.FormFlow.Json.FieldJson

Implements

IField<T> IFieldDescription IFieldPrompt<T> IFieldResources IFieldState<T>

Constructors

Field<T>(String, FieldRole)

Construct field.

Fields

_allowsMultiple

_buildPrompts

_condition

_define

_dependencies

_description

_form

_help

_isNullable

_keepZero

_limited

_max

_min

_name

_next

_optional

_pattern

_prompt

_promptDefinition

_promptSet

_recognizer

_role

_templates

_terms

_type

_validate

_valueDescriptions

_valueTerms

Properties

AllowDefault

AllowNumbers

AllowsMultiple

Dependencies

FieldDescription

FieldTerms

Form

Help

IsNullable

Name

Optional

Pattern

Prompt

Role

Type

ValueDescriptions

Values

Methods

Active(T)
AddDescription(Object, DescribeAttribute)	Adds a full description for a value.
AddDescription(Object, String, String, String)	Adds a description for a value.
AddTemplate(TemplateAttribute)
AddTerms(Object, String[])	Adds terms for a value.
AddTerms(Object, TermsAttribute)	Adds terms for a value.
DefineAsync(T)
DefinePrompt()
DefineRecognizer()
GetValue(T)
IsUnknown(T)
Limits(Double, Double)
Localize()
Next(Object, T)
RemoveValue(Object)	Removes the description and terms associated with a value.
RemoveValues()	Removes all values and their associated descriptions and terms.
ReplaceTemplate(TemplateAttribute)	Replace a template in the field.
SaveResources()
SetActive(ActiveDelegate<T>)	Define a delegate for checking state to see if field applies.
SetAllowsMultiple(Boolean)	Sets whether or not multiple values are allowed.
SetDefine(DefineAsyncDelegate<T>)	Define a delegate for dynamically defining field.
SetDependencies(String[])	Define the fields this field depends on.
SetFieldDescription(DescribeAttribute)	Set the full field description.
SetFieldDescription(String)	Set the field description.
SetFieldTerms(String[])	Set the terms associated with the field.
SetIsNullable(Boolean)	Set whether or not field is nullable.
SetLimits(Double, Double, Boolean)
SetLimits(Double, Double)	Set numeric limits.
SetNext(NextDelegate<T>)	Delegate for deciding on the next form step to execute.
SetOptional(Boolean)	Set whether or not a field is optional.
SetPattern(String)	Regular expression for validating strings.
SetPrompt(PromptAttribute)	Sets the field prompt.
SetRecognizer(IRecognize<T>)	Sets the recognizer for the field.
SetType(Type)	Sets the type of the underlying field state.
SetUnknown(T)
SetValidate(ValidateAsyncDelegate<T>)	Set the field validation.
SetValue(T, Object)
Template(TemplateUsage)
Terms(Object)
ValidateAsync(T, Object)
ValueDescription(Object)

Applies to