Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Collapse]eXpressApp Framework
 [Expand]Fundamentals
 [Expand]Getting Started
 [Expand]Concepts
 [Expand]Design-Time Features
 [Expand]Functional Testing
 [Expand]Deployment
 [Collapse]Task-Based Help
  [Expand]Business Model Design
  [Expand]Application Model
  [Expand]Actions
  [Expand]Navigation
  [Expand]Views
  [Expand]List Editors
  [Expand]Property Editors
  [Expand]Templates
  [Expand]Filtering
  [Expand]Reporting
  [Expand]Dashboards
  [Expand]Scheduler and Notifications
  [Expand]Maps
  [Expand]Security
  [Expand]Workflow
  [Expand]Localization
  [Expand]Testing
  [Collapse]Miscellaneous UI Customizations
    How to: Add a button to a Form using Custom View Item
    How to: Adjust the Size and Style of Pop-up Dialogs (ASP.NET)
    How to: Adjust the Windows' Size and Style
    How to: Change an Application Logo and Info
    How to: Create a Custom Control Detail Item
    How to: Customize a Window Caption
    How to: Customize ASP.NET Layout Elements Using Custom CSS Classes
    How to: Customize Export Options of the Printing System
    How to: Customize the Conditional Appearance Module Behavior
    How to: Customize Window Status Messages
    How to: Enable High DPI Support in a WinForms Application
    How to: Implement a Custom Messaging Class
    How to: Include an Action to a Detail View Layout
    How to: Set Images and Captions for Enumeration Values
    How to: Show a Custom Confirmation Window
    How to: Show a Custom Window with an Embedded XAF View
    How to: Show a Custom Windows Form
    How to: Use a Custom Splash Screen
    How to: Use Custom Themes in ASP.NET Applications
 [Expand]Frequently Asked Questions
 [Expand]API Reference
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
[Expand]End-User Documentation

How to: Set Images and Captions for Enumeration Values

This topic describes how to associate custom images and display captions with enumeration values. For a thorough explanation of the entire concept of adding and overriding UI images, refer to the Add and Override Images help topic.

Expanded Enumeration as a Property Type

To set the image that will represent an enumeration value in a UI, use the ImageNameAttribute. Apply this attribute to the required enumeration values and specify the images to be used:

To set the display caption that will represent an enumeration value in a UI, use the XafDisplayNameAttribute. Apply this attribute to the required enumeration values and specify the caption to be used:

Expanded Enumeration as Options Source for a SingleChoiceAction

Note

You can see the code demonstrated here in the Main Demo installed with XAF.

Enumeration values can represent a Single Choice Action's items. The following code demonstrates how to populate the ChoiceActionBase.Items collection with enumeration values, and set images for these items:

The following image shows the SetPriorityAction in the Windows Forms application.

Expanded See Also

How would you rate this topic?​​​​​​​