BoundImageDashboardItem.UriPattern Property

Gets or sets the URI pattern used to locate images in the ImageDataBindingMode.Uri binding mode.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[DefaultValue("")]
public string UriPattern { get; set; }

VB.NET

<DefaultValue("")>
Public Property UriPattern As String

Property Value

Type	Default	Description
String	String.Empty	A String that specifies the URI pattern used to locate images in the ImageDataBindingMode.Uri binding mode.

Example

The following code snippet shows how to use a Bound Image dashboard item to display a specified image accessible by a predefined URI.

Form1.cs

using System.Windows.Forms;
using DevExpress.DashboardCommon;
using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;
using DevExpress.XtraEditors;

namespace Dashboard_BoundImage {
    public partial class Form1 : XtraForm {
        public Form1() {
            InitializeComponent();
            Dashboard dashboard = new Dashboard();

            XmlFileConnectionParameters xmlParams = new XmlFileConnectionParameters();
            xmlParams.FileName = @"..\..\Data\DashboardProductDetails.xml";

            DashboardSqlDataSource xmlDataSource = new DashboardSqlDataSource("Data Source 1", xmlParams);
            SelectQuery selectQuery = SelectQueryFluentBuilder
                .AddTable("Products")
                .SelectColumns("Id", "Name", "Description")
                .Build("Query 1");
            xmlDataSource.Queries.Add(selectQuery);
            xmlDataSource.Fill();
            dashboard.DataSources.Add(xmlDataSource);

            BoundImageDashboardItem boundImage = new BoundImageDashboardItem();
            boundImage.DataSource = xmlDataSource; boundImage.DataMember = "Query 1";
            boundImage.DataBindingMode = ImageDataBindingMode.Uri;
            boundImage.ImageDimension = new Dimension("Name");
            boundImage.UriPattern = @"..\..\ProductDetailsImages\{0}.jpg";
            boundImage.SizeMode = ImageSizeMode.Stretch;

            ListBoxDashboardItem comboBox = new ListBoxDashboardItem();
            comboBox.ShowCaption = false;
            comboBox.DataSource = xmlDataSource; comboBox.DataMember = "Query 1";
            comboBox.FilterDimensions.Add(new Dimension("Name"));
            comboBox.ListBoxType = ListBoxDashboardItemType.Radio;
            comboBox.ShowAllValue = false;

            dashboard.Items.AddRange(comboBox, boundImage);
            dashboardViewer1.Dashboard = dashboard;
        }
    }
}

Form1.vb

Imports System.Windows.Forms
Imports DevExpress.DashboardCommon
Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql
Imports DevExpress.XtraEditors

Namespace Dashboard_BoundImage
    Partial Public Class Form1
        Inherits XtraForm

        Public Sub New()
            InitializeComponent()
            Dim dashboard As New Dashboard()

            Dim xmlParams As New XmlFileConnectionParameters()
            xmlParams.FileName = "..\..\Data\DashboardProductDetails.xml"

            Dim xmlDataSource As New DashboardSqlDataSource("Data Source 1", xmlParams)
            Dim selectQuery As SelectQuery = SelectQueryFluentBuilder.AddTable("Products").SelectColumns("Id", "Name", "Description").Build("Query 1")
            xmlDataSource.Queries.Add(selectQuery)
            xmlDataSource.Fill()
            dashboard.DataSources.Add(xmlDataSource)

            Dim boundImage As New BoundImageDashboardItem()
            boundImage.DataSource = xmlDataSource
            boundImage.DataMember = "Query 1"
            boundImage.DataBindingMode = ImageDataBindingMode.Uri
            boundImage.ImageDimension = New Dimension("Name")
            boundImage.UriPattern = "..\..\ProductDetailsImages\{0}.jpg"
            boundImage.SizeMode = ImageSizeMode.Stretch

            Dim comboBox As New ListBoxDashboardItem()
            comboBox.ShowCaption = False
            comboBox.DataSource = xmlDataSource
            comboBox.DataMember = "Query 1"
            comboBox.FilterDimensions.Add(New Dimension("Name"))
            comboBox.ListBoxType = ListBoxDashboardItemType.Radio
            comboBox.ShowAllValue = False

            dashboard.Items.AddRange(comboBox, boundImage)
            dashboardViewer1.Dashboard = dashboard
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the UriPattern property.

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#

asp-net-mvc-dashboard-custom-properties-sample/CS/AspMvcDashboardCustomPropertiesSample/App_Start/SessionDashboardStorage.cs#L55

if(primaryImage != null)
    primaryImage.UriPattern = applicationPath + "Content/ProductDetailsImages/{0}.jpg";
BoundImageDashboardItem secondaryImage = dashboard.Items["secondaryImage"] as BoundImageDashboardItem;

asp-net-web-forms-dashboard-custom-properties-sample/CS/WebFormsDashboardCustomPropertiesSample/SessionDashboardStorage.cs#L55

if(primaryImage != null)
    primaryImage.UriPattern = applicationPath + "Content/ProductDetailsImages/{0}.jpg";
BoundImageDashboardItem secondaryImage = dashboard.Items["secondaryImage"] as BoundImageDashboardItem;

VB.NET

asp-net-web-forms-dashboard-custom-properties-sample/VB/WebFormsDashboardCustomPropertiesSample/SessionDashboardStorage.vb#L59

If primaryImage IsNot Nothing Then
    primaryImage.UriPattern = applicationPath & "Content/ProductDetailsImages/{0}.jpg"
End If