The requested page is not available for the requested platform. You are viewing the content for Default platform.
A newer version of this page is available. Switch to the current version.

SingleChoiceAction Class

Represents a Single Choice Action.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

[ToolboxTabName("DX.18.2: XAF Actions")]
public class SingleChoiceAction :
    ChoiceActionBase
<ToolboxTabName("DX.18.2: XAF Actions")>
Public Class SingleChoiceAction
    Inherits ChoiceActionBase

Remarks

The SingleChoiceAction class inherits both the basic functionality of Actions from the ActionBase class, and the functionality of Choice Actions - from the ChoiceActionBase class. Single Choice Actions are used to execute custom code when an end-user selects an item from the ChoiceActionBase.Items collection. You can populate this collection at design time via the Properties window. Select the Items property and click the ellipsis button provided for it. In the invoked ChoiceActionItems Collection Editor, add items and specify their settings.

Note

Each item within the ChoiceActionBase.Items collection can contain child items as well. So, you can form a tree of items for a Single Choice Action. You can specify the type of a Single Choice Action's items: they can represent either modes or operations. To do this, use the SingleChoiceAction.ItemType property.

To provide custom code to be executed when an end-user selects a single item within the Items collection, handle the SingleChoiceAction.Execute event. To access the selected item, use the handler's SingleChoiceActionExecuteEventArgs.SelectedChoiceActionItem parameter.

To add a Single Choice Action to a Controller, drag and drop the SingleChoiceAction item from the XAF Actions section on the Toolbox to the required Controller's Designer area (see Add an Action with Option Selection).

Implements

See Also