ActionBase.CustomizeControl Event

Fires after the control is initialized. Allows you to customize the control.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

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. To run this code, add the DevExpress.ExpressApp.XtraBars.v23.2.dll assembly to References.

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

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 control is created - call the OnFrameAssigned method instead.

The CustomizeControlEventArgs.Control event parameter returns the Action Item object that contains control settings.

Run Demo: Actions - Simple Action

ASP.NET Web Forms Specific Scenarios

Simple Actions

If you customize a SimpleAction, the e.Control argument can return the following types:

• 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

Single Choice Menu Actions

The type of the value the SingleChoiceAction returns depends on the SingleChoiceAction.ItemType property value and ChoiceActionItem child 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 Actions

If you customize a ShowNavigationItemController.ShowNavigationItemAction, the e.Control argument can return the following types:

• ASPxNavBar if the IModelRootNavigationItems.NavigationStyle property value is NavigationStyle.NavBar
• ASPxTreeView if the IModelRootNavigationItems.NavigationStyle property is 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

Parametrized Actions

If you customize a ParametrizedAction, the e.Control argument returns a ParametrizedActionMenuActionItem object.

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

PopupWindowShow Actions

If you customize a PopupWindowShowAction, the e.Control argument can return the following types:

• 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

Simple Actions

If you customize a SimpleAction, the e.Control argument can return the following types:

• 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

Single Choice Actions

If you customize a SingleChoiceAction, the e.Control argument can return the following types:

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

If you customize a ShowNavigationItemController.ShowNavigationItemAction, the e.Control argument can return the following types:

• NavBarControl if the IModelRootNavigationItems.NavigationStyle property value is NavigationStyle.NavBar
• TreeList if the IModelRootNavigationItems.NavigationStyle property is 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

Parametrized Actions

If you customize a ParametrizedAction, the e.Control argument can return the following types:

• ButtonEdit descendants (SpinEdit, ButtonEditWithClearButton, and 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

PopupWindowShow Actions

If you customize a PopupWindowShowAction, the e.Control argument can return the following types:

• 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

ASP.NET Core Blazor Specific Scenarios

For detailed information on how to add Actions to Context Menu or Command Column of a List View grid, refer to the following topic: ActionBase.Category.

Simple and PopupWindowShow Actions

If you customize a SimpleAction or a PopupWindowShowAction, the e.Control argument can return the following types:

• DxToolbarItemSimpleActionControl for Toolbar Actions
• DxContextMenuItemSimpleActionControl for DxGrid Context Menu Actions
• ListEditorInlineActionControl for DxGrid Inline Actions

myAction.CustomizeControl += (s, e) => {
    DxToolbarItemSimpleActionControl actionControl = e.Control as DxToolbarItemSimpleActionControl;
    // or
    DxContextMenuItemSimpleActionControl actionControl = e.Control as DxContextMenuItemSimpleActionControl;  
    // or
    ListEditorInlineActionControl actionControl = e.Control as ListEditorInlineActionControl;  
    //...
}

For information on how to customize an Inline Action in a DxGrid row, refer to the following topic: Customize Inline Action Control (ASP.NET Core Blazor).

Single Choice Actions

If you customize a SingleChoiceAction, the e.Control argument can return the following types:

• DxToolbarComboBoxItemSingleChoiceActionControl for non-hierarchical Toolbar Actions with SingleChoiceAction.ItemType.ItemIsMode
• DxToolbarItemSingleChoiceActionControl for other Toolbar Actions
• DxContextMenuItemSingleChoiceActionControl for Context Menu Actions

myAction.CustomizeControl += (s, e) => {
    DxToolbarComboBoxItemSingleChoiceActionControl actionControl = e.Control as DxToolbarComboBoxItemSingleChoiceActionControl;
    // or
    DxToolbarItemSingleChoiceActionControl actionControl = e.Control as DxToolbarItemSingleChoiceActionControl;
    // or
    DxContextMenuItemSingleChoiceActionControl actionControl = e.Control as DxContextMenuItemSingleChoiceActionControl;  
    //...
}

Parametrized Actions

If you customize a ParametrizedAction, the e.Control argument returns a DxToolbarItemParametrizedActionControl object.

C#

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

ShowNavigationItem Actions

If you customize a ShowNavigationItemAction, the e.Control argument returns a ShowNavigationItemActionControl object. You can use ShowNavigationItemActionControl.NavigationComponentAdapter to customize the navigation control. The following adapter types are available:

• DxAccordionAdapter if the IModelRootNavigationItems.NavigationStyle property value is Accordion or NavBar
• DxTreeViewAdapter if the IModelRootNavigationItems.NavigationStyle property value is TreeList.

Both component adapter types have the following members:

• The Component property contains a reference to the underlying navigation control (DxTreeView or DxAccordion). Use this reference to expand or collapse navigation items.
• The ComponentModel property contains the component model that you can use to modify properties of the navigation control.
• The ComponentCaptured event fires when the Component property is initialized with a reference to a navigation control.

C#

Frame.GetController<ShowNavigationItemController>().ShowNavigationItemAction.CustomizeControl += (s, e) => {
    var navigationComponentAdapter = (e.Control as ShowNavigationItemActionControl)?.NavigationComponentAdapter;
    if(navigationComponentAdapter is DxTreeViewAdapter treeViewAdapter) {
        // ...
    }
    else if(navigationComponentAdapter is DxAccordionAdapter accordionAdapter) {
        // ...
    }
}

Refer to the following topic for more information on how to access control properties: How to: Access the Navigation Control.