ActionBase.CustomizeControl Event

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

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v22.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.v22.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

The SimpleAction returns the following 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

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

The ShowNavigationItem Action returned by the ShowNavigationItemController.ShowNavigationItemAction property have the following returned value’s type:

• 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

The ParametrizedAction returns the ParametrizedActionMenuActionItem value type.

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

The (xref:DevExpress.ExpressApp.Actions.PopupWindowShowAction) returns the following value’s 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

The SimpleAction returns the following value’s 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

Single Choice Actions

The SingleChoiceAction returns the following value 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

The ShowNavigationItem Action returned by the ShowNavigationItemController.ShowNavigationItemAction property have the following returned value type:

• 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

The ParametrizedAction returns the following value 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

The (xref:DevExpress.ExpressApp.Actions.PopupWindowShowAction) returns the following value 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

Simple Actions

The SimpleAction returns the DxToolbarItemSimpleActionControl value type.

C#

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

Single Choice Actions

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

• DxToolbarComboBoxItemSingleChoiceActionControl
• DxToolbarItemSingleChoiceActionControl

C#

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

ShowNavigationItem Actions

The ShowNavigationItemAction returns the ShowNavigationItemActionControl value type. 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.

The both component adapter types expose the following API:

• The Component property contains a reference to the underlying navigation control (DxTreeView or DxAccordion). You can 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.

Parametrized Actions

The ParametrizedAction returns the DxToolbarItemParametrizedActionControl value type.

C#

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

PopupWindowShow Actions

The PopupWindowShowAction returns the DxToolbarItemSimpleActionControl value type.

C#

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

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