ActionBase.SelectionDependencyType Property

Specifies a context for enabling an Action.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v20.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

[DefaultValue(SelectionDependencyType.Independent)]
public SelectionDependencyType SelectionDependencyType { get; set; }

VB.NET

<DefaultValue(SelectionDependencyType.Independent)>
Public Property SelectionDependencyType As SelectionDependencyType

Property Value

Type	Default	Description
SelectionDependencyType	**Independent**	A SelectionDependencyType enumeration value identifying a context type.

Available values:

Name	Description
Independent	An Action does not require objects to be selected.
RequireSingleObject	An Action is available when a single object is selected.
RequireMultipleObjects	An Action is available when one or more objects are selected.

Remarks

Use this property to make the current Action dependent on whether a single object or multiple objects are selected in the current View. The following values are available:

• Independent

  WinForms and ASP.NET WebForms: the Action availability does not depend on the current selection. Blazor: the Action is visible only when a List View has no selected objects.

• RequireSingleObject

  WinForms and ASP.NET WebForms: the Action is enabled when a single object is selected. Blazor: the Action is visible when a single object is selected.

  Set the ActionBase.Category property to “RecordEdit”, to display the Action in an additional cell for each object in the ASP.NET Web application’s List Views.

  Note

  The Action is hidden if the selection context is not available (e.g., when the Controller is not derived from ViewController).

• RequireMultipleObjects

  WinForms and ASP.NET WebForms: the Action is enabled when one or more objects are selected. Blazor: the Action is visible when one or more objects are selected.

By default, this property is set to Independent. Set another value if your Action is targeted for the currently selected object(s). This is definitely required if your Action takes part in an ASP.NET WebForms UI, because it will be disabled until an object is selected.

You can set another value in the Controller’s constructor or Designer. This value will be saved to the Application Model‘s ActionDesign | Actions | <Action> node. You can change this value in the Model Editor. In a UI, the value which is specified in the Application Model’s .xafml file that was loaded last, will be displayed. For information on the order of Application Model differences loading, refer to the Application Model Basics topic.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SelectionDependencyType property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-replace-a-list-views-default-action-e3275/CS/ReplaceDefaultActionInListView.Module.Win/EditAddressBookRecordController.cs#L14

editAddressBookRecordAction.ImageName = "Action_Edit";
editAddressBookRecordAction.SelectionDependencyType =
    SelectionDependencyType.RequireSingleObject;

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/CS/ShowDetailViewFromDashboard.Module.Win/Controllers/WinShowDetailViewFromDashboardController.cs#L20

openDetailViewAction.Caption = "OpenDetailView";
openDetailViewAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject;
openDetailViewAction.Execute += OpenDetailViewAction_Execute;

XAF_how-to-show-a-complex-dialog-e5067/CS/ComplexDialogSample.Module/Controllers/MyController.cs#L30

PopupWindowShowAction action = new PopupWindowShowAction(this, "AssignJobs", PredefinedCategory.RecordEdit);
action.SelectionDependencyType = SelectionDependencyType.RequireMultipleObjects;
action.CustomizePopupWindowParams += new CustomizePopupWindowParamsEventHandler(action_CustomizePopupWindowParams);

XAF_how-to-access-objects-selected-in-the-current-view-e3016/CS/SelectedObjects.Module/MyNotesController.cs#L11

SimpleAction myAction = new SimpleAction(this, "Salary Info", "Edit");
myAction.SelectionDependencyType = SelectionDependencyType.RequireMultipleObjects;
myAction.TargetObjectType = typeof(Contact);

VB.NET

XAF_how-to-replace-a-list-views-default-action-e3275/VB/ReplaceDefaultActionInListView.Module.Win/EditAddressBookRecordController.vb#L15

editAddressBookRecordAction.ImageName = "Action_Edit"
editAddressBookRecordAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject
AddHandler editAddressBookRecordAction.Execute, AddressOf editAddressBookRecordAction_Execute

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/VB/ShowDetailViewFromDashboard.Module.Win/Controllers/WinShowDetailViewFromDashboardController.vb#L22

openDetailViewAction.Caption = "OpenDetailView"
openDetailViewAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject
AddHandler openDetailViewAction.Execute, AddressOf OpenDetailViewAction_Execute

XAF_how-to-show-a-complex-dialog-e5067/VB/ComplexDialogSample.Module/Controllers/MyController.vb#L36

Dim action As New PopupWindowShowAction(Me, "AssignJobs", PredefinedCategory.RecordEdit)
action.SelectionDependencyType = SelectionDependencyType.RequireMultipleObjects
AddHandler action.CustomizePopupWindowParams, AddressOf action_CustomizePopupWindowParams

XAF_how-to-access-objects-selected-in-the-current-view-e3016/VB/SelectedObjects.Module/MyNotesController.vb#L13

Dim myAction As New SimpleAction(Me, "Salary Info", "Edit")
myAction.SelectionDependencyType = SelectionDependencyType.RequireMultipleObjects
myAction.TargetObjectType = GetType(Contact)