Microsoft.Bot.Builder.FormFlow.FormConfiguration Class Reference

Default values for the form. More...

Public Member Functions

 FormConfiguration ()
 Construct configuration. More...
 
TemplateAttribute Template (TemplateUsage usage)
 Look up a particular template. More...
 

Public Attributes

Dictionary< FormCommand, CommandDescriptionCommands
 Definitions of the built-in commands. More...
 
string Confirmation = Resources.Confirmation
 String for naming "Confirmation" fields. More...
 
string[] CurrentChoice = Resources.MatchCurrentChoice.SplitList()
 Enumeration of strings for interpreting a user response as asking for the current value. More...
 
PromptAttribute DefaultPrompt
 Default prompt and template format settings. More...
 
string Navigation = Resources.Navigation
 String for naming the "navigation" field. More...
 
string[] No = Resources.MatchNo.SplitList()
 Enumeration of values for a "no" response for boolean fields or confirmations. More...
 
string[] NoPreference = Resources.MatchNoPreference.SplitList()
 Enumeration of strings for interpreting a user response as setting an optional field to be unspecified. More...
 
List< TemplateAttributeTemplates
 Default templates to use if not override on the class or field level. More...
 
string[] Yes = Resources.MatchYes.SplitList()
 Enumeration of values for a "yes" response for boolean fields or confirmations. More...
 

Detailed Description

Default values for the form.

These defaults can all be overridden when you create a form and before you add steps.

Definition at line 245 of file IFormBuilder.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.FormFlow.FormConfiguration.FormConfiguration ( )
inline

Construct configuration.

Definition at line 250 of file IFormBuilder.cs.

Member Function Documentation

TemplateAttribute Microsoft.Bot.Builder.FormFlow.FormConfiguration.Template ( TemplateUsage  usage)
inline

Look up a particular template.

Parameters
usageDesired template.
Returns
Matching template.

Definition at line 424 of file IFormBuilder.cs.

Member Data Documentation

Dictionary<FormCommand, CommandDescription> Microsoft.Bot.Builder.FormFlow.FormConfiguration.Commands
Initial value:
= new Dictionary<FormCommand, CommandDescription>()
{
{FormCommand.Backup, new CommandDescription(
Resources.CommandBack,
Resources.CommandBackTerms.SplitList(),
Resources.CommandBackHelp) },
{FormCommand.Help, new CommandDescription(
Resources.CommandHelp,
Resources.CommandHelpTerms.SplitList(),
Resources.CommandHelpHelp) },
{FormCommand.Quit, new CommandDescription(
Resources.CommandQuit,
Resources.CommandQuitTerms.SplitList(),
Resources.CommandQuitHelp) },
{FormCommand.Reset, new CommandDescription(
Resources.CommandReset,
Resources.CommandResetTerms.SplitList(),
Resources.CommandResetHelp)},
{FormCommand.Status, new CommandDescription(
Resources.CommandStatus,
Resources.CommandStatusTerms.SplitList(),
Resources.CommandStatusHelp) }
}

Definitions of the built-in commands.

Definition at line 395 of file IFormBuilder.cs.

string Microsoft.Bot.Builder.FormFlow.FormConfiguration.Confirmation = Resources.Confirmation

String for naming "Confirmation" fields.

Definition at line 316 of file IFormBuilder.cs.

string [] Microsoft.Bot.Builder.FormFlow.FormConfiguration.CurrentChoice = Resources.MatchCurrentChoice.SplitList()

Enumeration of strings for interpreting a user response as asking for the current value.

The first value is also used to describe the option of keeping the current value.

Definition at line 296 of file IFormBuilder.cs.

PromptAttribute Microsoft.Bot.Builder.FormFlow.FormConfiguration.DefaultPrompt
Initial value:
= new PromptAttribute("")
{
AllowDefault = BoolDefault.True,
ChoiceCase = CaseNormalization.None,
ChoiceFormat = Resources.DefaultChoiceFormat,
ChoiceLastSeparator = Resources.DefaultChoiceLastSeparator,
ChoiceParens = BoolDefault.True,
ChoiceSeparator = Resources.DefaultChoiceSeparator,
ChoiceStyle = ChoiceStyleOptions.Auto,
FieldCase = CaseNormalization.Lower,
LastSeparator = Resources.DefaultLastSeparator,
Separator = Resources.DefaultSeparator,
ValueCase = CaseNormalization.InitialUpper
}

Default prompt and template format settings.

When you specify a PromptAttribute or TemplateAttribute, any format value you do not specify will come from this default.

Definition at line 266 of file IFormBuilder.cs.

string Microsoft.Bot.Builder.FormFlow.FormConfiguration.Navigation = Resources.Navigation

String for naming the "navigation" field.

Definition at line 311 of file IFormBuilder.cs.

string [] Microsoft.Bot.Builder.FormFlow.FormConfiguration.No = Resources.MatchNo.SplitList()

Enumeration of values for a "no" response for boolean fields or confirmations.

Definition at line 306 of file IFormBuilder.cs.

string [] Microsoft.Bot.Builder.FormFlow.FormConfiguration.NoPreference = Resources.MatchNoPreference.SplitList()

Enumeration of strings for interpreting a user response as setting an optional field to be unspecified.

The first string is also used to describe not having a preference for an optional field.

Definition at line 288 of file IFormBuilder.cs.

List<TemplateAttribute> Microsoft.Bot.Builder.FormFlow.FormConfiguration.Templates

Default templates to use if not override on the class or field level.

Definition at line 321 of file IFormBuilder.cs.

string [] Microsoft.Bot.Builder.FormFlow.FormConfiguration.Yes = Resources.MatchYes.SplitList()

Enumeration of values for a "yes" response for boolean fields or confirmations.

Definition at line 301 of file IFormBuilder.cs.


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