Working with the ContentBody control
The user interacts with configuration data with the user controls provided in the ContentBody control for the configuration page. The ContentBody control, in turn, contains one or more ConfigurationPropertySection controls, a template control that, in turn, logically groups one or more template controls, such as the ConfigurationProperty control, into a single section.
For more information about the ContentBody control, see Creating configuration pages.
Working with template controls
The configuration page must have at least one ConfigurationPropertySection control, as the first child of the ContentBody control. The control renders its contents as an HTML table, with each template control in the TemplateRowsArea collection rendered as a set of rows and columns in that table.
Template controls provide a consistent rendering pattern within a configuration property section for the user controls that they contain. Once you have configured and registered a ConfigurationPropertySection control, you need to add appropriate template controls to both control how the rows and columns in the table are rendered by the ConfigurationPropertySection control, and to present the user controls contained by the template controls. For more information about working with template controls, see Implementing template controls.
Working with the DialogBody control
The DialogBody control renders common panels in the configuration page to edit the labels and common settings of a workflow action. For most custom workflow actions, no additional configuration is required. However, there are some options that can be configured, if needed, for a custom workflow action:
-
Set the AllowHistoryMessage property to true to display the Message to log on completion option in the Common section of the configuration settings dialog. For more information about the option, see the Nintex Workflow 2013 product documentation.
-
Set the AllowRunNow property to a RunNowMode enumeration value to indicate whether to display the Run Now button in the ribbon of the configuration settings dialog. If the custom workflow action can interact with external data, or perform operations involving external systems, and the custom workflow action supports the Run Now feature, set the value of this property to RunNowMode.EnableAdministratorControlled.
For more information about supporting the Run Now feature in a custom workflow action, see Supporting the Run Now feature.
-
Set the AllowUserContextConfig property to true to display the Run as workflow owner option in the Common section of the configuration settings dialog. For more information about the option, see the Nintex Workflow 2013 product documentation.
The following example demonstrates how to include the DialogBody control in the configuration page for a custom workflow action that supports the Run Now feature and accesses external data, and to display the Message to log on completion option in the Common section of the configuration settings dialog.
<%-- The DialogBody control must be the last child of the ContentBody control. --%> <Nintex:DialogBody runat="server" id="DialogBody" AllowHistoryMessage="True" AllowRunNow="EnableAdministratorControlled" />
See Also
Concepts
Operations
Working with configuration pages