Use Custom Icons for Field List Items

• Aug 18, 2023
• 2 minutes to read

View Example: Reporting for WinForms - Custom Icons for Field List Items in the End-User Designer

The following code snippet implements and registers a DevExpress.Data.Browsing.Design.ColumnImageProvider descendant that returns a custom SVG image to be displayed as an icon for the CategoryName field in the Field List:

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

Form1.vb

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraReports.UI

' ...
Namespace FieldListCustomIcons

    Public Partial 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)
            Dim report As XtraReport1 = New XtraReport1()
            Dim designTool As ReportDesignTool = New ReportDesignTool(report)
            designTool.ShowDesignerDialog()
        End Sub
    End Class
End Namespace

CustomFieldListService.cs

using System.ComponentModel;
using DevExpress.Utils;
using DevExpress.Utils.Svg;

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 SvgImageCollection CreateSvgImageCollection() {
            SvgImageCollection result = base.CreateSvgImageCollection();
            SvgImage image = new SvgImage(typeof(CustomColumnImageProvider), "FieldListCustomIcons.StarIcon.svg");

            result.Add(image);
            categoryNameIndex = result.Count - 1;

            return result;
        }

    }
}

CustomFieldListService.vb

Imports System.ComponentModel
Imports DevExpress.Utils
Imports DevExpress.Utils.Svg

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
            Return MyBase.GetColumnImageIndex([property], specifics)
        End Function

        Public Overrides Function CreateSvgImageCollection() As SvgImageCollection
            Dim result As SvgImageCollection = MyBase.CreateSvgImageCollection()
            Dim image As SvgImage = New SvgImage(GetType(CustomColumnImageProvider), "FieldListCustomIcons.StarIcon.svg")
            result.Add(image)
            categoryNameIndex = result.Count - 1
            Return result
        End Function
    End Class
End Namespace

The result is shown in the following image: