Provide Custom Icons to the Field List Items

• Jul 20, 2023
• 2 minutes to read

Tip

Online Example: How to provide custom icons for the Field List in the End-User Designer

This example demonstrates how to provide custom images to the Field List items.

Form1.cs

using System;
using System.Windows.Forms;
using DevExpress.XtraReports.UI;
// ...

namespace FieldListCustomIcons {
    public partial class Form1 : Form {

        public Form1() {
            InitializeComponent();
            DevExpress.Data.Browsing.Design.ColumnImageProvider.Instance = new CustomColumnImageProvider();
        }

        private void button1_Click(object sender, EventArgs e) {
            XtraReport1 report = new XtraReport1();
            ReportDesignTool designTool = new ReportDesignTool(report);
            designTool.ShowDesignerDialog();
        }
    }
}

CustomFieldListService.cs

using System.Drawing;
using System.ComponentModel;
using DevExpress.Utils;
using DevExpress.XtraReports.UserDesigner;

namespace FieldListCustomIcons {

    class CustomColumnImageProvider : DevExpress.Data.Browsing.Design.ColumnImageProvider {
        int categoryNameIndex;

        public override int GetColumnImageIndex(PropertyDescriptor property, 
            DevExpress.Data.Browsing.Design.TypeSpecifics specifics) {
            if (property.Name.Equals("CategoryName"))
                return categoryNameIndex;
            return base.GetColumnImageIndex(property, specifics);
        }
        public override DevExpress.Utils.ImageCollection CreateImageCollection() {
            ImageCollection result = base.CreateImageCollection();
            Image image =
                ResourceImageHelper.CreateBitmapFromResources("FieldListCustomIcons.DataPickerImage.png",
                typeof(CustomColumnImageProvider).Assembly);

            result.AddImage(image);
            categoryNameIndex = result.Images.Count - 1;

            return result;
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraReports.UI
' ...

Namespace FieldListCustomIcons
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
            DevExpress.Data.Browsing.Design.ColumnImageProvider.Instance = New CustomColumnImageProvider()
        End Sub

        Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles button1.Click
            Dim report As New XtraReport1()
            Dim designTool As New ReportDesignTool(report)
            designTool.ShowDesignerDialog()
        End Sub
    End Class
End Namespace

CustomFieldListService.vb

Imports Microsoft.VisualBasic
Imports System.Drawing
Imports System.ComponentModel
Imports DevExpress.Utils
Imports DevExpress.XtraReports.UserDesigner

Namespace FieldListCustomIcons

    Friend Class CustomColumnImageProvider
        Inherits DevExpress.Data.Browsing.Design.ColumnImageProvider
        Private categoryNameIndex As Integer

        Public Overrides Function GetColumnImageIndex(ByVal [property] As PropertyDescriptor, ByVal specifics As DevExpress.Data.Browsing.Design.TypeSpecifics) As Integer
            If [property].Name.Equals("CategoryName") Then
                Return categoryNameIndex
            End If
            Return MyBase.GetColumnImageIndex([property], specifics)
        End Function
        Public Overrides Function CreateImageCollection() As DevExpress.Utils.ImageCollection
            Dim result As ImageCollection = MyBase.CreateImageCollection()
            Dim image As Image = ResourceImageHelper.CreateBitmapFromResources("FieldListCustomIcons.DataPickerImage.png", GetType(CustomColumnImageProvider).Assembly)

            result.AddImage(image)
            categoryNameIndex = result.Images.Count - 1

            Return result
        End Function
    End Class
End Namespace

The result is shown in the following image.