ChoiceActionItem.Caption Property

Specifies a Choice Action Item’s caption.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v23.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

[DefaultValue("")]
public string Caption { get; set; }

VB.NET

<DefaultValue("")>
Public Property Caption As String

Property Value

Type	Default	Description
String	String.Empty	A string value that represents the current Choice Action Item’s caption.

Remarks

If the Choice Action Item’s ChoiceActionItem.Model property is specified, the Caption property value is stored in the corresponding Application Model Node. You can use the Model Editor to set a localized version of the caption.

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

Note

The Choice Action Item can be displayed without a caption. It depends on the Action Container that displays this Action and the Action Container settings. Built-in Action Containers support caption display.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Caption 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-use-criteria-property-editors-e932/CS/HowToUseCriteriaPropertyEditors.Module/CriteriaController.cs#L37

((ListView)View).CollectionSource.Criteria.Clear();
((ListView)View).CollectionSource.Criteria[e.SelectedChoiceActionItem.Caption] =
   CriteriaEditorHelper.GetCriteriaOperator(

VB.NET

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()