SparklineEditSettings Class

Contains settings specific to the SparklineEdit editor.

Namespace: DevExpress.Xpf.Editors.Settings

Assembly: DevExpress.Xpf.Core.v20.1.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Core, DevExpress.Wpf.Core

Declaration

C#

public class SparklineEditSettings :
    BaseEditSettings

VB.NET

Public Class SparklineEditSettings
    Inherits BaseEditSettings

Remarks

DevExpress container controls (e.g. GridControl, TreeListControl, etc.) use DevExpress WPF Editors to edit data they display. Each editor has a helper class (the BaseEditSettings descendant), responsible for the editor’s functionality. When the same editor is used in multiple locations, a container control uses this helper class to paint its cells. The actual editors are only created when end-users start to edit, and are automatically destroyed when editing is completed. To learn more about in-place editing, see Inplace Editors.

For detailed information on sparkline editors, see SparklineEdit.

Example

This example demonstrates how to show sparklines in a grid column. Note that in this sample an Area sparkline is displayed. To change Area to another sparkline view, replace AreaSparklineStyleSettings with either BarSparklineStyleSettings, LineSparklineStyleSettings or WinLossSparklineStyleSettings.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-show-sparklines-in-a-grid-e4986.

MainWindow.xaml

<Window
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors"
        xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid"
        x:Class="SparklineInGrid.MainWindow"
        Title="MainWindow" Height="562" Width="665" >
    <Grid>
        <dxg:GridControl x:Name="grid" ItemsSource="{Binding SalesData}" >
            <dxg:GridControl.Columns>
                <dxg:GridColumn FieldName="Title" Header="Order" ReadOnly="True" Width="200"/>
                <dxg:GridColumn FieldName="SparklineData" Header="Sales" Width="200">
                    <dxg:GridColumn.EditSettings>
                        <dxe:SparklineEditSettings PointArgumentMember="ArgumentColumn" PointValueMember="ValueColumn">
                            <dxe:SparklineEditSettings.PointArgumentRange>
                                <dxe:Range Auto="False" Limit1="07/17/2013" Limit2="08/15/2013" />
                            </dxe:SparklineEditSettings.PointArgumentRange>
                            <dxe:SparklineEditSettings.StyleSettings>
                                <dxe:AreaSparklineStyleSettings Brush="BlueViolet"
                                    HighlightMaxPoint="True" HighlightMinPoint="True" 
                                    MaxPointBrush="Red" MinPointBrush="Blue" />
                            </dxe:SparklineEditSettings.StyleSettings>
                        </dxe:SparklineEditSettings>
                    </dxg:GridColumn.EditSettings>
                </dxg:GridColumn>
            </dxg:GridControl.Columns>
        </dxg:GridControl>
    </Grid>
</Window>

MainWindow.xaml.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Collections.ObjectModel
Imports System.Threading
Imports System.Windows
Imports DevExpress.Xpf.Utils

Namespace SparklineInGrid

    Partial Public Class MainWindow
        Inherits Window

        Private privateSalesData As List(Of SalesDataRow)
        Public Property SalesData() As List(Of SalesDataRow)
            Get
                Return privateSalesData
            End Get
            Set(ByVal value As List(Of SalesDataRow))
                privateSalesData = value
            End Set
        End Property

        Public Sub New()
            InitializeComponent()

            grid.DataContext = Me

            SalesData = New List(Of SalesDataRow)()

            Dim rowsCount As Integer = 20

            For i As Integer = 0 To rowsCount - 1
                SalesData.Add(New SalesDataRow() With {.Title = String.Format("Index: {0}", i+1), .SparklineData = GenerateSparklineData()})
            Next i

        End Sub

        Private random As New Random()

        Private Function GenerateSparklineData() As IList
            Dim sparklineData As New ObservableCollection(Of SalesItem)()

            Dim dateTime As New DateTime(2013, 07, 17)

            For i As Integer = 0 To 29
                sparklineData.Add(New SalesItem() With {.ValueColumn = random.Next(-20, 20), .ArgumentColumn = dateTime.AddDays(i)})
            Next i

            Return sparklineData
        End Function

    End Class

    Public Class SalesDataRow
        Private privateTitle As Object
        Public Property Title() As Object
            Get
                Return privateTitle
            End Get
            Set(ByVal value As Object)
                privateTitle = value
            End Set
        End Property
        Private privateSparklineData As IList
        Public Property SparklineData() As IList
            Get
                Return privateSparklineData
            End Get
            Set(ByVal value As IList)
                privateSparklineData = value
            End Set
        End Property
    End Class

    Public Class SalesItem
        Private privateArgumentColumn As Object
        Public Property ArgumentColumn() As Object
            Get
                Return privateArgumentColumn
            End Get
            Set(ByVal value As Object)
                privateArgumentColumn = value
            End Set
        End Property
        Private privateValueColumn As Integer
        Public Property ValueColumn() As Integer
            Get
                Return privateValueColumn
            End Get
            Set(ByVal value As Integer)
                privateValueColumn = value
            End Set
        End Property
    End Class
End Namespace

MainWindow.xaml.cs

using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Threading;
using System.Windows;
using DevExpress.Xpf.Utils;

namespace SparklineInGrid {

    public partial class MainWindow : Window {

        public List<SalesDataRow> SalesData { get; set; }

        public MainWindow() {
            InitializeComponent();

            grid.DataContext = this;

            SalesData = new List<SalesDataRow>();

            int rowsCount = 20;

            for (int i = 0; i < rowsCount; i++)
                SalesData.Add(new SalesDataRow() { Title = String.Format("Index: {0}", i+1), 
                    SparklineData = GenerateSparklineData() });

        }

        Random random = new Random();

        IList GenerateSparklineData() {
            ObservableCollection<SalesItem> sparklineData = new ObservableCollection<SalesItem>();

            DateTime dateTime = new DateTime(2013, 07, 17);

            for (int i=0; i < 30; i++)
                sparklineData.Add(new SalesItem() { ValueColumn = random.Next(-20, 20), ArgumentColumn = dateTime.AddDays(i) });

            return sparklineData;
        }

    }

    public class SalesDataRow {
        public object Title { get; set; }
        public IList SparklineData { get; set; }
    }

    public class SalesItem {
        public object ArgumentColumn { get; set; }
        public int ValueColumn { get; set; }
    }
}

Inheritance

Object

DispatcherObject

DependencyObject

ContentElement

FrameworkContentElement

DXFrameworkContentElement

BaseEditSettings

SparklineEditSettings