Specifies descriptive text for a custom workflow action.
<NintexWorkflowActivity> <Description>string</Description> </NintexWorkflowActivity>
Characteristic | Description |
Data type and length | String |
Default value | None |
Cardinality | 1..1: Required element that occurs only once. |
Relationship | Element |
Parent elements | NintexWorkflowActivity |
Child elements | None |
The description of an action is used to display a tooltip about the action in the Controls Toolbox of the Nintex Workflow designer. Workflow designer attempts to retrieve a value that matches the current locale, determined by the locale ID of the current culture for the current thread. If a matching value cannot be retrieved, Workflow designer uses the value that matches the default locale ID, 1033 (English - United States).
When the action definition file is imported in Nintex Workflow Management, the Description field is set to the value of this element.
The following example contains the description for the custom action included in the ExecuteSqlScalar sample. For more information about the ExecuteSqlScalar sample, see ExecuteSqlScalar sample.
<Description>Executes a scalar query by using the ExecuteScalar method.</Description>