Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute Class Reference

Abstract base class used by all attributes that use Pattern Language. More...

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

Public Member Functions

 TemplateBaseAttribute (params string[] patterns)
 Initialize with multiple patterns that will be chosen from randomly. More...
 
 TemplateBaseAttribute (TemplateBaseAttribute other)
 Initialize from another template. More...
 
void ApplyDefaults (TemplateBaseAttribute defaultTemplate)
 Any default values in this template will be overridden by the supplied defaultTemplate . More...
 
string Pattern ()
 The pattern to use when generating a string using Advanced.IPrompt<T>. More...
 

Properties

BoolDefault AllowDefault [get, set]
 When processing choices {||} in a Pattern Language string, provide a choice for the default value if present. More...
 
CaseNormalization ChoiceCase [get, set]
 Control case when showing choices in {||} references in a Pattern Language string. More...
 
string ChoiceFormat [get, set]
 Format string used for presenting each choice when showing {||} choices in a Pattern Language string. More...
 
string ChoiceLastSeparator [get, set]
 When constructing inline lists of choices using {||} in a Pattern Language string, the string used before the last choice. More...
 
BoolDefault ChoiceParens [get, set]
 When constructing inline choice lists for {||} in a Pattern Language string controls whether to include parentheses around choices. More...
 
string ChoiceSeparator [get, set]
 When constructing inline lists using {||} in a Pattern Language string, the string used between all choices except the last. More...
 
ChoiceStyleOptions ChoiceStyle [get, set]
 How to display choices {||} when processed in a Pattern Language string. More...
 
FeedbackOptions Feedback [get, set]
 Control what kind of feedback the user gets after each input. More...
 
CaseNormalization FieldCase [get, set]
 Control case when showing {&} field name references in a Pattern Language string. More...
 
bool IsLocalizable [get, set]
 True if attribute is localizable. More...
 
string LastSeparator [get, set]
 When constructing lists using {[]} in a Pattern Language string, the string used before the last value in the list. More...
 
string[] Patterns [get, set]
 All possible templates. More...
 
string Separator [get, set]
 When constructing lists using {[]} in a Pattern Language string, the string used between all values except the last. More...
 
CaseNormalization ValueCase [get, set]
 Control case when showing {} value references in a Pattern Language string. More...
 

Detailed Description

Abstract base class used by all attributes that use Pattern Language.

Definition at line 677 of file Attributes.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.TemplateBaseAttribute ( params string[]  patterns)
inline

Initialize with multiple patterns that will be chosen from randomly.

Parameters
patternsPossible patterns.

Definition at line 799 of file Attributes.cs.

Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.TemplateBaseAttribute ( TemplateBaseAttribute  other)
inline

Initialize from another template.

Parameters
otherThe template to copy from.

Definition at line 809 of file Attributes.cs.

Member Function Documentation

void Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.ApplyDefaults ( TemplateBaseAttribute  defaultTemplate)
inline

Any default values in this template will be overridden by the supplied defaultTemplate .

Parameters
defaultTemplateDefault template to use to override default values.

Definition at line 779 of file Attributes.cs.

string Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.Pattern ( )
inline

The pattern to use when generating a string using Advanced.IPrompt<T>.

If multiple patterns were specified, then each call to this function will return a random pattern.

Returns
Pattern to use.

Definition at line 756 of file Attributes.cs.

Property Documentation

BoolDefault Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.AllowDefault
getset

When processing choices {||} in a Pattern Language string, provide a choice for the default value if present.

Definition at line 684 of file Attributes.cs.

CaseNormalization Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.ChoiceCase
getset

Control case when showing choices in {||} references in a Pattern Language string.

Definition at line 689 of file Attributes.cs.

string Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.ChoiceFormat
getset

Format string used for presenting each choice when showing {||} choices in a Pattern Language string.

The choice format is passed two arguments, {0} is the number of the choice and {1} is the field name.

Definition at line 695 of file Attributes.cs.

string Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.ChoiceLastSeparator
getset

When constructing inline lists of choices using {||} in a Pattern Language string, the string used before the last choice.

Definition at line 700 of file Attributes.cs.

BoolDefault Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.ChoiceParens
getset

When constructing inline choice lists for {||} in a Pattern Language string controls whether to include parentheses around choices.

Definition at line 705 of file Attributes.cs.

string Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.ChoiceSeparator
getset

When constructing inline lists using {||} in a Pattern Language string, the string used between all choices except the last.

Definition at line 710 of file Attributes.cs.

ChoiceStyleOptions Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.ChoiceStyle
getset

How to display choices {||} when processed in a Pattern Language string.

Definition at line 715 of file Attributes.cs.

FeedbackOptions Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.Feedback
getset

Control what kind of feedback the user gets after each input.

Definition at line 720 of file Attributes.cs.

CaseNormalization Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.FieldCase
getset

Control case when showing {&} field name references in a Pattern Language string.

Definition at line 725 of file Attributes.cs.

bool Microsoft.Bot.Builder.FormFlow.FormFlowAttribute.IsLocalizable
getsetinherited

True if attribute is localizable.

Attributes that are used on classes, fields and properties should have this set. That way those attributes will be in the localization files that are generated.

Definition at line 54 of file Attributes.cs.

string Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.LastSeparator
getset

When constructing lists using {[]} in a Pattern Language string, the string used before the last value in the list.

Definition at line 730 of file Attributes.cs.

string [] Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.Patterns
getset

All possible templates.

Returns
The possible templates.

Definition at line 773 of file Attributes.cs.

string Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.Separator
getset

When constructing lists using {[]} in a Pattern Language string, the string used between all values except the last.

Definition at line 735 of file Attributes.cs.

CaseNormalization Microsoft.Bot.Builder.FormFlow.Advanced.TemplateBaseAttribute.ValueCase
getset

Control case when showing {} value references in a Pattern Language string.

Definition at line 740 of file Attributes.cs.


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