BoundImageDashboardItem.ImageDimension Property

Gets or sets the dimension that provides data for the BoundImageDashboardItem.

Namespace: DevExpress.DashboardCommon

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

Declaration

[DefaultValue(null)]
public Dimension ImageDimension { get; set; }

Property Value

Type Default Description
Dimension

null

A Dimension object that provides data for the BoundImageDashboardItem.

Remarks

Note that the ImageDimension dimension can provide images in two ways, depending on the data binding mode (BoundImageDashboardItem.DataBindingMode).

  • The ImageDimension provides images as byte arrays.
  • The ImageDimension provides parts of URIs used to locate images. For instance, the URI pattern below specifies the path to the folder containing required images.

    C:\Users\Public\Documents\DevExpress Demos 21.1\Components\Data\ProductDetailsImages{0}.jpg

    Dimension values will be inserted at the position of the {0} placeholder.

To learn more, see Providing Images.

Example

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

View Example

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;
        }
    }
}
See Also