Microsoft.Bot.Builder.FormFlow.DescribeAttribute Class Reference

Attribute to override the default description of a field, property or enum value. More...

Inheritance diagram for Microsoft.Bot.Builder.FormFlow.DescribeAttribute:

Public Member Functions

 DescribeAttribute (string description=null, string image=null, string message=null, string title=null, string subTitle=null)
 Description for field, property or enum value. More...
 

Public Attributes

string Description
 Description of the field, property or enum to use in templates and choices. More...
 
string Image
 URL of image to use when creating cards or buttons. More...
 
string Message
 Message to return when a button is pressed in a card. More...
 
string SubTitle
 SubTitle when a card is generated from description. More...
 
string Title
 Title when a card is generated from description. More...
 

Properties

bool IsLocalizable [get, set]
 True if attribute is localizable. More...
 

Detailed Description

Attribute to override the default description of a field, property or enum value.

Definition at line 62 of file Attributes.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.FormFlow.DescribeAttribute.DescribeAttribute ( string  description = null,
string  image = null,
string  message = null,
string  title = null,
string  subTitle = null 
)
inline

Description for field, property or enum value.

Parameters
descriptionDescription of field, property or enum value.
imageURL of image to use when generating buttons.
messageMessage to return from button.
titleText if generating card.
subTitleSubTitle if generating card.

Definition at line 97 of file Attributes.cs.

Member Data Documentation

string Microsoft.Bot.Builder.FormFlow.DescribeAttribute.Description

Description of the field, property or enum to use in templates and choices.

Definition at line 67 of file Attributes.cs.

string Microsoft.Bot.Builder.FormFlow.DescribeAttribute.Image

URL of image to use when creating cards or buttons.

Definition at line 82 of file Attributes.cs.

string Microsoft.Bot.Builder.FormFlow.DescribeAttribute.Message

Message to return when a button is pressed in a card.

Definition at line 87 of file Attributes.cs.

string Microsoft.Bot.Builder.FormFlow.DescribeAttribute.SubTitle

SubTitle when a card is generated from description.

Definition at line 77 of file Attributes.cs.

string Microsoft.Bot.Builder.FormFlow.DescribeAttribute.Title

Title when a card is generated from description.

Definition at line 72 of file Attributes.cs.

Property Documentation

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.


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