RepositoryItemSparklineEdit Class

Contains settings specific to a SparklineEdit control.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public class RepositoryItemSparklineEdit :
    RepositoryItem,
    ISparklineSettings,
    ISparklineInfoContainer

VB.NET

Public Class RepositoryItemSparklineEdit
    Inherits RepositoryItem
    Implements ISparklineSettings,
               ISparklineInfoContainer

Related API Members

The following members return RepositoryItemSparklineEdit objects:

• SparklineEdit.Properties

Remarks

The sparkline type is defined by the RepositoryItemSparklineEdit.View property, which can contain of the following SparklineViewBase class descendants:

• Area (AreaSparklineView)
• Line (LineSparklineView)
• Bar (BarSparklineView)
• Win/Loss (WinLossSparklineView)

Below is a grid control with Line sparklines displayed in its second column.

Example

The following example demonstrates how to show sparklines in a grid column.

To do this, it’s necessary to create a RepositoryItemSparklineEdit object, assign it to an unbound column and then provide necessary values in the ColumnView.CustomUnboundColumnData event handler.

Form1.cs

using System;
using System.Collections.Generic;
using System.Data;
using System.Windows.Forms;
using DevExpress.Data;
using DevExpress.Sparkline;
using DevExpress.XtraEditors.Repository;
using DevExpress.XtraGrid.Columns;
using DevExpress.XtraGrid.Views.Base;

namespace SparklineInGrid {

    public partial class Form1 : Form {

        public Form1() {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e) {
            // Fill a grid's data source.
            this.customersPaymentTableAdapter.Fill(this.contactsDataSet.CustomersPayment);

            // Create a Sparkline repository item, adjust it and add it to the grid's repository.
            RepositoryItemSparklineEdit repositoryItemSparklineEdit1 = new RepositoryItemSparklineEdit();
            LineSparklineView lineSparklineView1 = repositoryItemSparklineEdit1.View as LineSparklineView;
            lineSparklineView1.HighlightEndPoint = true;
            lineSparklineView1.HighlightMaxPoint = true;
            lineSparklineView1.HighlightMinPoint = true;
            lineSparklineView1.HighlightStartPoint = true;
            this.gridControl1.RepositoryItems.Add(repositoryItemSparklineEdit1);

            // Create an unbound column, adjust it and add it to the grid view.
            GridColumn colPayments = new GridColumn();
            colPayments.Visible = true;
            colPayments.Caption = "Payments";
            colPayments.UnboundDataType = typeof(object);
            colPayments.ColumnEdit = repositoryItemSparklineEdit1;
            colPayments.FieldName = "gridColumn1";
            colPayments.MaxWidth = 300;
            colPayments.MinWidth = 50;
            colPayments.Width = 255;
            this.gridView1.Columns.Add(colPayments);

            // Expand all groups for better initial navigation.
            this.gridView1.ExpandAllGroups();
        }

        private void gridView1_CustomUnboundColumnData(object sender, CustomColumnDataEventArgs e) {
            // Obtaining data for the sparkline editor.
            if (e.IsGetData) {
                List<double> values = new List<double>();
                DataRowView row = (DataRowView)e.Row;

                values.Add((double)row["January"]);
                values.Add((double)row["February"]);
                values.Add((double)row["March"]);
                values.Add((double)row["April"]);
                values.Add((double)row["May"]);
                values.Add((double)row["June"]);
                values.Add((double)row["July"]);
                values.Add((double)row["August"]);
                values.Add((double)row["September"]);
                values.Add((double)row["October"]);
                values.Add((double)row["November"]);
                values.Add((double)row["December"]);

                e.Value = values;
            }
        }

    }
}

Form1.vb

Imports System
Imports System.Collections.Generic
Imports System.Data
Imports System.Windows.Forms
Imports DevExpress.Data
Imports DevExpress.Sparkline
Imports DevExpress.XtraEditors.Repository
Imports DevExpress.XtraGrid.Columns
Imports DevExpress.XtraGrid.Views.Base
' ...

Public Class Form1

    Private Sub Form1_Load(sender As System.Object, e As System.EventArgs) _
    Handles MyBase.Load
        ' Fill a grid's data source.
        Me.CustomersPaymentTableAdapter.Fill(Me.ContactsDataSet.CustomersPayment)

        ' Create a Sparkline repository item, adjust it and add it to the grid's repository.
        Dim repositoryItemSparklineEdit1 As New RepositoryItemSparklineEdit()
        Dim sparklineView As SparklineViewBase = repositoryItemSparklineEdit1.View
        sparklineView.HighlightEndPoint = True
        sparklineView.HighlightMaxPoint = True
        sparklineView.HighlightMinPoint = True
        sparklineView.HighlightStartPoint = True
        Me.GridControl1.RepositoryItems.Add(repositoryItemSparklineEdit1)

        ' Create an unbound column, adjust it and add it to the grid view.
        Dim colPayments As New GridColumn()
        colPayments.Visible = True
        colPayments.Caption = "Payments"
        colPayments.UnboundDataType = GetType(Object)
        colPayments.ColumnEdit = repositoryItemSparklineEdit1
        colPayments.FieldName = "gridColumn1"
        colPayments.MaxWidth = 300
        colPayments.MinWidth = 50
        colPayments.Width = 255
        Me.GridView1.Columns.Add(colPayments)


        ' Expand all groups for better initial navigation.
        Me.GridView1.ExpandAllGroups()
    End Sub

    Private Sub gridView1_CustomUnboundColumnData(ByVal sender As Object, ByVal e As CustomColumnDataEventArgs) _
    Handles GridView1.CustomUnboundColumnData
        'Obtaining data for the sparkline editor.
        If e.IsGetData Then
            Dim values As New List(Of Double)()
            Dim row As DataRowView = CType(e.Row, DataRowView)

            values.Add(CDbl(row("January")))
            values.Add(CDbl(row("February")))
            values.Add(CDbl(row("March")))
            values.Add(CDbl(row("April")))
            values.Add(CDbl(row("May")))
            values.Add(CDbl(row("June")))
            values.Add(CDbl(row("July")))
            values.Add(CDbl(row("August")))
            values.Add(CDbl(row("September")))
            values.Add(CDbl(row("October")))
            values.Add(CDbl(row("November")))
            values.Add(CDbl(row("December")))

            e.Value = values
        End If
    End Sub


End Class

Inheritance

Object

MarshalByRefObject

Component

DevExpress.XtraEditors.ComponentBase

RepositoryItem

RepositoryItemSparklineEdit