ActionBase.CustomizeControl Event

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v20.1.dll

Declaration

public event EventHandler<CustomizeControlEventArgs> CustomizeControl

Public Event CustomizeControl As EventHandler(Of CustomizeControlEventArgs)

Event Data

Remarks

The example below demonstrates how to change a SimpleAction color in WinForms applications.

using System.Drawing;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.Persistent.Base;
using DevExpress.XtraBars;
// ...
public class ChangeActionColorController : WindowController {
    public ChangeActionColorController() {
        SimpleAction simpleAction = new SimpleAction(this, "Action", PredefinedCategory.Edit);
        simpleAction.CustomizeControl += SimpleAction_CustomizeControl;
    }
    private void SimpleAction_CustomizeControl(object sender, CustomizeControlEventArgs e) {
        BarButtonItem button = e.Control as BarButtonItem;
        if(button != null) {
            button.ItemAppearance.Normal.BackColor = Color.LightBlue;
        }
    }
}

Imports System.Drawing
Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Actions
Imports DevExpress.Persistent.Base
Imports DevExpress.XtraBars

Public Class ChangeActionColorController
    Inherits WindowController
    Public Sub New()
        Dim simpleAction As New SimpleAction(Me, "Action", PredefinedCategory.Edit)
        AddHandler simpleAction.CustomizeControl, AddressOf SimpleAction_CustomizeControl
    End Sub
    Private Sub SimpleAction_CustomizeControl(ByVal sender As Object, ByVal e As CustomizeControlEventArgs)
        Dim button As BarButtonItem = TryCast(e.Control, BarButtonItem)
        If button IsNot Nothing Then
            button.ItemAppearance.Normal.BackColor = Color.LightBlue
        End If
    End Sub
End Class

Do not handle this event for a built-in Action in a View or Window Controller's OnActivated method because this method is called after the Action controls creation. Use the OnFrameAssigned method instead.

The CustomizeControlEventArgs.Control event parameter returns the Action Item object which provides access to the control settings. See all of the possible scenarios in the Action section of the Feature Center demo that is installed in the %PUBLIC%\Documents\DevExpress Demos 20.1\Components.NET Core Desktop Libraries\eXpressApp Framework\FeatureCenter folder by default, or refer to the Feature Center demo online. The lists below show which type of Action Item is returned for different Action types.

ASP.NET Specific Scenarios

• SimpleAction

  Returned value type:

  • SimpleActionMenuActionItem - for menu Actions;
  • ASPxGridViewCustomButtonInitializer - for Inline Grid Actions.
  • C#
  • VB.NET

  myAction.CustomizeControl += (s, e) => {
      SimpleActionMenuActionItem actionItem = e.Control as SimpleActionMenuActionItem;
      // or 
      ASPxGridViewCustomButtonInitializer initializer = e.Control as ASPxGridViewCustomButtonInitializer;
      //...
  }
  

• SingleChoiceAction menu Actions.

  The returned value type depends on the SingleChoiceAction.ItemType property value and ChoiceActionItems sub items:

  • SingleChoiceActionAsModeMenuActionItem;
  • SingleChoiceActionItemAsHierarchicalModeActionMenuItem;
  • SingleChoiceActionItemAsOperationActionMenuItem.
  • C#
  • VB.NET

  myAction.CustomizeControl += (s, e) => {
      SingleChoiceActionAsModeMenuActionItem actionItem = e.Control as SingleChoiceActionAsModeMenuActionItem;
      // or
      SingleChoiceActionItemAsHierarchicalModeActionMenuItem actionItem = e.Control as SingleChoiceActionItemAsHierarchicalModeActionMenuItem;
      // or
      SingleChoiceActionItemAsOperationActionMenuItem actionItem = e.Control as SingleChoiceActionItemAsOperationActionMenuItem;
      //...
  }
  

• ShowNavigationItem Action returned by the ShowNavigationItemController.ShowNavigationItemAction property.

  Returned value type:

  • ASPxNavBar - if the IModelRootNavigationItems.NavigationStyle property is set to NavigationStyle.NavBar;
  • ASPxTreeView - if the IModelRootNavigationItems.NavigationStyle property is set to NavigationStyle.TreeList.
  • C#
  • VB.NET

  Frame.GetController<ShowNavigationItemController>().ShowNavigationItemAction.CustomizeControl += (s, e) => {
      ASPxNavBar navBar = e.Control as ASPxNavBar;
      // or
      ASPxTreeView treeView = e.Control as ASPxTreeView;
      //...
  }
  

• ParametrizedAction.

  Returned value type is ParametrizedActionMenuActionItem.

  • C#
  • VB.NET

  myAction.CustomizeControl += (s, e) => {
      ParametrizedActionMenuActionItem actionItem = e.Control as ParametrizedActionMenuActionItem;
      //...
  }
  

• PopupWindowShowAction.

  Returned value type:

  • PopupWindowActionMenuActionItem - for menu Actions;
  • ASPxGridViewCustomButtonInitializer - for Inline Grid Actions.
  • C#
  • VB.NET

  myAction.CustomizeControl += (s, e) => {
      PopupWindowActionMenuActionItem actionItem = e.Control as PopupWindowActionMenuActionItem;
      // or
      ASPxGridViewCustomButtonInitializer actionItem = e.Control as ASPxGridViewCustomButtonInitializer;
      //...
  }
  

WinForms Specific Scenarios

• SimpleAction.

  Returned value type:

  • SimpleButton - for Layout Actions;
  • BarButtonItem - for BarManager Actions.
  • C#
  • VB.NET

  myAction.CustomizeControl += (s, e) => {
      SimpleButton control = e.Control as SimpleButton;
      // or
      BarButtonItem control = e.Control as BarButtonItem;
      //...
  }
  

• SingleChoiceAction.

  Returned value type:

  • ImageComboBoxEdit - for Layout Actions;
  • BarEditItem, BarButtonItem, RibbonGalleryBarItem - for BarManager Actions.
  • C#
  • VB.NET

  myAction.CustomizeControl += (s, e) => {
      ImageComboBoxEdit control = e.Control as ImageComboBoxEdit;
      // or
      BarEditItem control = e.Control as BarEditItem;
      //...
  }
  

• ShowNavigationItem Action returned by the ShowNavigationItemController.ShowNavigationItemAction property.

  Returned value type:

  • NavBarControl - if the IModelRootNavigationItems.NavigationStyle property is set to NavigationStyle.NavBar;
  • TreeList - if the IModelRootNavigationItems.NavigationStyle property is set to NavigationStyle.TreeList.
  • C#
  • VB.NET

  Frame.GetController<ShowNavigationItemController>().ShowNavigationItemAction.CustomizeControl += (s, e) => {
      NavBarControl navBar = e.Control as NavBarControl;
      // or
      TreeList treeList = e.Control as TreeList;
      //...
  }
  

• ParametrizedAction.

  Returned value type:

  • Descendants of ButtonEdit (SpinEdit, ButtonEditWithClearButton, DateEdit) - for Layout Actions;
  • BarEditItem - for BarManager Actions.
  • C#
  • VB.NET

  myAction.CustomizeControl += (s, e) => {
      DateEdit control = e.Control as DateEdit;
      // or
      BarEditItem control = e.Control as BarEditItem;
      //...
  }
  

• PopupWindowShowAction.

  Returned value type:

  • SimpleButton - for Layout Actions;
  • BarButtonItem - for BarManager Actions.
  • C#
  • VB.NET

  myAction.CustomizeControl += (s, e) => {
      SimpleButton control = e.Control as SimpleButton;
      // or
      BarButtonItem control = e.Control as BarButtonItem;
      //...
  }