ActionBase.Caption Property

Specifies an Action‘s caption.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v24.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 property that represents the current Action’s caption.

Remarks

By default, this property is set to the ActionBase.Id property value. 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 via the Model Editor. In a UI, the value which is specified in the Application Model’s .xafml file, loaded last, will be displayed. For information on the order of Application Model differences loading, refer to the Application Model Basics topic.

When setting a value to this property, the View.CaptionChanged event is raised.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/CS/ShowDetailViewFromDashboard.Module.Win/Controllers/WinShowDetailViewFromDashboardController.cs#L19

openDetailViewAction = new ParametrizedAction(this, "Dashboard_OpenDetailView", "Dashboard", typeof(string));
openDetailViewAction.Caption = "OpenDetailView";
openDetailViewAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject;

XAF_how-to-create-a-custom-action-type-with-a-custom-control-barcheckitem-associated-with-it-e1977/CS/CustomActionControl.Module.Win/Controllers/SampleController.cs#L9

CheckableSimpleAction activeFilterAction = new CheckableSimpleAction(this, "ActiveFilterAction", PredefinedCategory.Filters);
activeFilterAction.Caption = "Active";
activeFilterAction.Execute += activeFilterAction_Execute;

xaf-web-forms-use-oauth2-authentication-providers/CS/MySolution.Module.Web/Controllers/LogonAuthController.cs#L20

    microsoftAction.Execute += microsoftAccountAction_Execute;
    microsoftAction.Caption = "Microsoft";
}

VB.NET

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

openDetailViewAction = New ParametrizedAction(Me, "Dashboard_OpenDetailView", "Dashboard", GetType(String))
openDetailViewAction.Caption = "OpenDetailView"
openDetailViewAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject

XAF_how-to-create-a-custom-action-type-with-a-custom-control-barcheckitem-associated-with-it-e1977/VB/CustomActionControl.Module.Win/Controllers/SampleController.vb#L11

Dim activeFilterAction As New CheckableSimpleAction(Me, "ActiveFilterAction", PredefinedCategory.Filters)
activeFilterAction.Caption = "Active"
AddHandler activeFilterAction.Execute, AddressOf activeFilterAction_Execute

xaf-web-forms-use-oauth2-authentication-providers/VB/MySolution.Module.Web/Controllers/LogonAuthController.vb#L22

    AddHandler microsoftAction.Execute, AddressOf microsoftAccountAction_Execute
    microsoftAction.Caption = "Microsoft"
End Sub