ActionBase.PaintStyle Property

Specifies the Action‘s paint style.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

[DefaultValue(ActionItemPaintStyle.Default)]
public ActionItemPaintStyle PaintStyle { get; set; }

VB.NET

<DefaultValue(ActionItemPaintStyle.Default)>
Public Property PaintStyle As ActionItemPaintStyle

Property Value

Type	Default	Description
ActionItemPaintStyle	Default	An ActionItemPaintStyle enumeration value that specifies the Action’s paint style.

Available values:

Name	Description	Image
Default	The default value is Image for WinForms and ASP.NET Web Forms applications, and CaptionAndImage for ASP.NET Core Blazor applications.
Caption	An Action is displayed in the UI as a caption.
CaptionAndImage	An Action is displayed in the UI as an image and a caption.
Image	An Action is displayed in the UI as an image.

Remarks

Use one of the following approaches to specify this property:

• In code

  C#

  using DevExpress.ExpressApp;
  using DevExpress.ExpressApp.Actions;
  using DevExpress.ExpressApp.Templates;
  using DevExpress.Persistent.Base;
  // ...
  public class MyController : ObjectViewController<ListView, Contact> {
      public MyController() {
          SimpleAction customAction = new SimpleAction(this, "CustomAction", PredefinedCategory.View) {
              Caption = "Custom Action",
              ImageName = "ModelEditor_Application"
          };
          customAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject;
          customAction.PaintStyle = ActionItemPaintStyle.Caption;
      }
  }
  

  VB.NET

  Imports DevExpress.ExpressApp
  Imports DevExpress.ExpressApp.Actions
  Imports DevExpress.ExpressApp.Templates
  Imports DevExpress.Persistent.Base
  ' ...
  Public Class MyController
      Inherits ObjectViewController(Of ListView, Contact)
      Public Sub New()
          Dim customAction As New SimpleAction(Me, "CustomAction", PredefinedCategory.View) With {
              .Caption = "Custom Action",
              .ImageName = "ModelEditor_Application"
          }
          customAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject
          customAction.PaintStyle = ActionItemPaintStyle.Caption
      End Sub
  End Class
  

• In the Model Editor
  Navigate to an ActionDesign | Actions | <Action> node and specify the IModelAction.PaintStyle property.

  

Note that the value specified in the Model Editor has a higher priority than the value specified in code. For more information, refer to the following topic: Application Model Basics.

The following table shows the available paint styles:

Enumeration Value	Illustration
Caption
CaptionAndImage
Image
Default	in WinForms applications: Image in ASP.NET Web Forms applications: Image in ASP.NET Core Blazor applications: CaptionAndImage

Note

WinForms applications with the Ribbon FormStyle ignore this property. In these applications, Actions always show both image and caption.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PaintStyle 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#L156

this.SelectViewVariantAction = new SingleChoiceAction(this, "SelectViewVariant", "Edit");
this.SelectViewVariantAction.PaintStyle = ActionItemPaintStyle.Caption;
this.SelectViewVariantAction.Execute += new SingleChoiceActionExecuteEventHandler(this.SelectViewVariantAction_Execute);

VB.NET

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

SelectViewVariantAction = New SingleChoiceAction(Me, "SelectViewVariant", "Edit")
SelectViewVariantAction.PaintStyle = ActionItemPaintStyle.Caption
AddHandler SelectViewVariantAction.Execute, New SingleChoiceActionExecuteEventHandler(AddressOf SelectViewVariantAction_Execute)