ParametrizedAction.ShortCaption Property

Specifies a caption of the button attached to a Parametrized Action’s editor.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v24.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
String	String.Empty	A string value representing a caption of the button displayed for the current Parametrized Action.

Remarks

A Parametrized Action is displayed via an editor and a button. The editor is used to enter a value, the button - for validating this value. Use the ShortCaption property to specify a caption for the button. The images below demonstrate the Filter by Text Action, displayed via a button with the GO! caption.

In a Windows Forms application:

In an ASP.NET Web Forms application:

The value of this property is assigned to the IModelAction.ShortCaption property of the Application Model‘s ActionDesign | Actions | <Action> node. You can change this property’s value using the Model Editor.

The default value of this property is the value that is assigned to the ShortCaption property of the Application Model’s Action node. If this property’s value is not specified, its value is set to the Caption property value.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShortCaption 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-create-a-custom-action-with-a-custom-control-in-xaf-aspnet-application/CS/Solution28.Module.Web/ParametrizedRangeActionMenuActionItem.cs#L63

if (Control != null) {
    Control.SetImage(imageInfo, Action.ShortCaption);
}

VB.NET

xaf-how-to-create-a-custom-action-with-a-custom-control-in-xaf-aspnet-application/VB/Solution28.Module.Web/ParametrizedRangeActionMenuActionItem.vb#L65

If Control IsNot Nothing Then
    Control.SetImage(imageInfo, Action.ShortCaption)
End If