ChoiceActionItem.Data Property

Specifies the object which is associated with a Choice Action Item of a custom Action.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

[TypeConverter(typeof(StringConverter))]
[Bindable(true)]
[DefaultValue(null)]
public object Data { get; set; }

VB.NET

<TypeConverter(GetType(StringConverter))>
<Bindable(True)>
<DefaultValue(Nothing)>
Public Property Data As Object

Property Value

Type	Default	Description
Object	null	An Object which is associated with the current Choice Action Item of a custom Action.

Remarks

The Data property can be used to associate particular object with the Choice Action Item of a custom Action. Do not use this property to access or set an object for built-in Actions.

When setting a value to this property, the ChoiceActionBase.ItemsChanged event is raised.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Data 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-save-and-share-custom-view-settings/CS/ViewSettingsSolution.Module/Controllers/ViewVariantsController.cs#L73

private void UpdateActionsActive() {
    Boolean isActive = SelectViewVariantAction.Items.Count > 0 && SelectViewVariantAction.SelectedItem.Data != null;
    DeleteViewVariantAction.Active["HasVariants"] = isActive;

XAF_how-to-use-criteria-property-editors-e932/CS/HowToUseCriteriaPropertyEditors.Module/CriteriaController.cs#L39

   CriteriaEditorHelper.GetCriteriaOperator(
   e.SelectedChoiceActionItem.Data as string, View.ObjectTypeInfo.Type, ObjectSpace);
((ListView)View).CollectionSource.EndUpdateCriteria();

XAF_Non-Persistent-Objects-Edit-Linked-Persistent-Objects-Demo/CS/NonPersistentObjectsDemo.Module/Controllers/NonPersistentObjectActivatorController.cs#L32

var args = e.ActionArguments;
var shortcut = args.SelectedChoiceActionItem.Data as ViewShortcut;
if(shortcut != null) {

VB.NET

xaf-save-and-share-custom-view-settings/VB/ViewSettingsSolution.Module/Controllers/ViewVariantsController.vb#L92

Private Sub UpdateActionsActive()
    Dim isActive As Boolean = SelectViewVariantAction.Items.Count > 0 AndAlso SelectViewVariantAction.SelectedItem.Data IsNot Nothing
    DeleteViewVariantAction.Active("HasVariants") = isActive

XAF_how-to-use-criteria-property-editors-e932/VB/HowToUseCriteriaPropertyEditors.Module/CriteriaController.vb#L38

CType(View, ListView).CollectionSource.Criteria.Clear()
CType(View, ListView).CollectionSource.Criteria(e.SelectedChoiceActionItem.Caption) = CriteriaEditorHelper.GetCriteriaOperator(TryCast(e.SelectedChoiceActionItem.Data, String), View.ObjectTypeInfo.Type, ObjectSpace)
CType(View, ListView).CollectionSource.EndUpdateCriteria()

XAF_Non-Persistent-Objects-Edit-Linked-Persistent-Objects-Demo/VB/NonPersistentObjectsDemo.Module/Controllers/NonPersistentObjectActivatorController.vb#L34

Dim args = e.ActionArguments
Dim shortcut = TryCast(args.SelectedChoiceActionItem.Data, ViewShortcut)
If shortcut IsNot Nothing Then