ActionBase.CustomizeControl Event

Occurs after the control is initialized. Allows customizing the default control settings.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v19.1.dll

Declaration

C#

public event EventHandler<CustomizeControlEventArgs> CustomizeControl

VB.NET

Public Event CustomizeControl As EventHandler(Of CustomizeControlEventArgs)

Event Data

The CustomizeControl event's data class is CustomizeControlEventArgs. The following properties provide information specific to this event:

Property	Description
Control	Gets an object that allows you to access the control which is used to display an Action.

Remarks

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

C#

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;
        }
    }
}

VB.NET

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

Note

To run this code, add the DevExpress.ExpressApp.XtraBars.v19.1.dll assembly to References.

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 19.1\Components\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#

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

  VB.NET

  AddHandler myAction.CustomizeControl, Sub(s, e)
      Dim actionItem As SimpleActionMenuActionItem = TryCast(e.Control, SimpleActionMenuActionItem)
      ' or
      Dim initializer As ASPxGridViewCustomButtonInitializer = TryCast(e.Control, ASPxGridViewCustomButtonInitializer)
      '...
  End Sub
  

• SingleChoiceAction menu Actions.

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

  • SingleChoiceActionAsModeMenuActionItem;
  • SingleChoiceActionItemAsHierarchicalModeActionMenuItem;
  • SingleChoiceActionItemAsOperationActionMenuItem.
  C#

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

  VB.NET

  AddHandler myAction.CustomizeControl, Sub(s, e)
      Dim actionItem As SingleChoiceActionAsModeMenuActionItem = TryCast(e.Control, SingleChoiceActionAsModeMenuActionItem)
      ' or
      Dim actionItem As SingleChoiceActionItemAsHierarchicalModeActionMenuItem = TryCast(e.Control, SingleChoiceActionItemAsHierarchicalModeActionMenuItem)
      ' or
      Dim actionItem As SingleChoiceActionItemAsOperationActionMenuItem = TryCast(e.Control, SingleChoiceActionItemAsOperationActionMenuItem)
      '...
  End Sub
  

• 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#

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

  VB.NET

  AddHandler Frame.GetController(Of ShowNavigationItemController)().ShowNavigationItemAction.CustomizeControl, Sub(s, e)
      Dim navBar As ASPxNavBar = TryCast(e.Control, ASPxNavBar)
      ' or
      Dim treeView As ASPxTreeView = TryCast(e.Control, ASPxTreeView)
      '...
  End Sub
  

• ParametrizedAction.

  Returned value type is ParametrizedActionMenuActionItem.

  C#

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

  VB.NET

  AddHandler myAction.CustomizeControl, Sub(s, e)
      Dim actionItem As ParametrizedActionMenuActionItem = TryCast(e.Control, ParametrizedActionMenuActionItem)
      '...
  End Sub
  

• PopupWindowShowAction.

  Returned value type:

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

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

  VB.NET

  AddHandler myAction.CustomizeControl, Sub(s, e)
      Dim actionItem As PopupWindowActionMenuActionItem = TryCast(e.Control, PopupWindowActionMenuActionItem)
      ' or
      Dim initializer As ASPxGridViewCustomButtonInitializer = TryCast(e.Control, ASPxGridViewCustomButtonInitializer)
      '...
  End Sub
  

WinForms Specific Scenarios

• SimpleAction.

  Returned value type:

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

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

  VB.NET

  AddHandler myAction.CustomizeControl, Sub(s, e)
      Dim control As SimpleButton = TryCast(e.Control, SimpleButton)
      ' or
      Dim control As BarButtonItem = TryCast(e.Control, BarButtonItem)
      '...
  End Sub
  

• SingleChoiceAction.

  Returned value type:

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

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

  VB.NET

  AddHandler myAction.CustomizeControl, Sub(s, e)
      Dim control As ImageComboBoxEdit = TryCast(e.Control, ImageComboBoxEdit)
      ' or
      Dim control As BarEditItem = TryCast(e.Control, BarEditItem)
      '...
  End Sub
  

• 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#

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

  VB.NET

  AddHandler Frame.GetController(Of ShowNavigationItemController)().ShowNavigationItemAction.CustomizeControl, Sub(s, e)
      Dim navBar As NavBarControl = TryCast(e.Control, NavBarControl)
      ' or
      Dim treeListControl As TreeList = TryCast(e.Control, TreeList)
      '...
  End Sub
  

• ParametrizedAction.

  Returned value type:

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

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

  VB.NET

  AddHandler myAction.CustomizeControl, Sub(s, e)
      Dim control As DateEdit = TryCast(e.Control, DateEdit)
      ' or
      Dim control As BarEditItem = TryCast(e.Control, BarEditItem)
      '...
  End Sub
  

• PopupWindowShowAction.

  Returned value type:

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

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

  VB.NET

  AddHandler myAction.CustomizeControl, Sub(s, e)
      Dim control As SimpleButton = TryCast(e.Control, SimpleButton)
      ' or
      Dim control As BarButtonItem = TryCast(e.Control, BarButtonItem)
      '...
  End Sub
  

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomizeControl event.

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-change-navigation-control-appearance-e240/CS/CustomizeNavigationControl.Module.Win/Controllers/WinCustomizeNavBarController.cs#L12

if (navigationController != null) {
    Frame.GetController<ShowNavigationItemController>().ShowNavigationItemAction.CustomizeControl += ShowNavigationItemAction_CustomizeControl;
}

VB.NET

XAF_how-to-change-navigation-control-appearance-e240/VB/CustomizeNavigationControl.Module.Win/Controllers/WinCustomizeNavBarController.vb#L14

If navigationController IsNot Nothing Then
    AddHandler Frame.GetController(Of ShowNavigationItemController)().ShowNavigationItemAction.CustomizeControl, AddressOf ShowNavigationItemAction_CustomizeControl
End If