Microsoft.Bot.Builder.Dialogs.PromptStyler Class Reference

Styles a prompt More...

Public Member Functions

 PromptStyler (PromptStyle promptStyle=PromptStyle.Auto)
 
virtual void Apply (ref IMessageActivity message, string prompt)
 Style a prompt and populate the IMessageActivity.Text. More...
 
virtual void Apply< T > (ref IMessageActivity message, string prompt, IReadOnlyList< T > options, IReadOnlyList< string > descriptions=null)
 Style a prompt and populate the message based on PromptStyler.PromptStyle. More...
 

Static Public Member Functions

static void Apply< T > (ref IMessageActivity message, string prompt, IReadOnlyList< T > options, PromptStyle promptStyle, IReadOnlyList< string > descriptions=null)
 PromptStyler.Apply(ref IMessageActivity, string). More...
 

Public Attributes

readonly PromptStyle PromptStyle
 Style of the prompt Dialogs.PromptStyle. More...
 

Detailed Description

Styles a prompt

Definition at line 178 of file PromptDialog.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.Dialogs.PromptStyler.PromptStyler ( PromptStyle  promptStyle = PromptStyle.Auto)
inline

Definition at line 185 of file PromptDialog.cs.

Member Function Documentation

virtual void Microsoft.Bot.Builder.Dialogs.PromptStyler.Apply ( ref IMessageActivity  message,
string  prompt 
)
inlinevirtual

Style a prompt and populate the IMessageActivity.Text.

Parameters
messageThe message that will contain the prompt.
promptThe prompt.

Definition at line 210 of file PromptDialog.cs.

static void Microsoft.Bot.Builder.Dialogs.PromptStyler.Apply< T > ( ref IMessageActivity  message,
string  prompt,
IReadOnlyList< T >  options,
PromptStyle  promptStyle,
IReadOnlyList< string >  descriptions = null 
)
inlinestatic

PromptStyler.Apply(ref IMessageActivity, string).

Template Parameters
TThe type of the options.
Parameters
messageThe message.
promptThe prompt.
optionsThe options.
promptStyleThe prompt style.
descriptionsDescriptions for each option.

Definition at line 199 of file PromptDialog.cs.

virtual void Microsoft.Bot.Builder.Dialogs.PromptStyler.Apply< T > ( ref IMessageActivity  message,
string  prompt,
IReadOnlyList< T >  options,
IReadOnlyList< string >  descriptions = null 
)
inlinevirtual

Style a prompt and populate the message based on PromptStyler.PromptStyle.

Template Parameters
TThe type of the options.
Parameters
messageThe message that will contain the prompt.
promptThe prompt.
optionsThe options.
descriptionsDescriptions to display for each option.

T should implement object.ToString unless descriptions are supplied.

Definition at line 227 of file PromptDialog.cs.

Member Data Documentation

readonly PromptStyle Microsoft.Bot.Builder.Dialogs.PromptStyler.PromptStyle

Style of the prompt Dialogs.PromptStyle.

Definition at line 183 of file PromptDialog.cs.


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