Documentation

Class GridViewSparklineColumn

Inheritance
System.Object
DisposableObject
RadObject
GridViewColumn
GridViewDataColumn
GridViewSparklineColumn
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

public class GridViewSparklineColumn : GridViewDataColumn, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, IEditorProvider, INotifyPropertyChangingEx, IDataConversionInfoProvider, IGridViewEventListener, ITypeDescriptorContext, IServiceProvider

Constructors

GridViewSparklineColumn()

Initializes a new instance of the GridViewSparklineColumn.

Declaration
public GridViewSparklineColumn()
See Also

GridViewSparklineColumn(String)

Initializes a new instance of the GridViewSparklineColumn.

Declaration
public GridViewSparklineColumn(string fieldName)
Parameters
System.String fieldName

A string value referring to the unique name of the column.
See Also

GridViewSparklineColumn(String, String)

Initializes a new instance of the GridViewSparklineColumn.

Declaration
public GridViewSparklineColumn(string uniqueName, string fieldName)
Parameters
System.String uniqueName

A string value referring to the unique name of the column.
System.String fieldName

A string value referring to the field name to which the column is bound.

Properties

AllowFiltering

Gets or sets a value indicating whether the user can filter by this column.

Declaration
public override bool AllowFiltering { get; set; }
Property Value
System.Boolean

Overrides

AllowGroup

Declaration
public override bool AllowGroup { get; set; }
Property Value
System.Boolean

Overrides
Remarks

This property is overridden to always return false since grouping by this column is not allowed.

See Also

AllowSearching

Gets or sets a value indicating whether the user can search by this column.

Declaration
public override bool AllowSearching { get; set; }
Property Value
System.Boolean

Overrides

DataType

Gets or sets the data type of the column.

Declaration
public override Type DataType { get; set; }
Property Value
System.Type

Overrides

SeriesType

Gets or sets a value indicating what is the type of the generated series.

Declaration
public SparkSeriesType SeriesType { get; set; }
Property Value
SparkSeriesType

ShowFirstPointIndicator

Gets or sets a value indicating whether the first point marker will be shown.

Declaration
public bool ShowFirstPointIndicator { get; set; }
Property Value
System.Boolean

ShowHighPointIndicator

Gets or sets a value indicating whether the high point marker will be shown.

Declaration
public bool ShowHighPointIndicator { get; set; }
Property Value
System.Boolean

ShowLastPointIndicator

Gets or sets a value indicating whether the last point marker will be shown.

Declaration
public bool ShowLastPointIndicator { get; set; }
Property Value
System.Boolean

ShowLowPointIndicator

Gets or sets a value indicating whether the low point marker will be shown.

Declaration
public bool ShowLowPointIndicator { get; set; }
Property Value
System.Boolean

ShowMarkers

Gets or sets a value indicating whether the point markers will be shown.

Declaration
public bool ShowMarkers { get; set; }
Property Value
System.Boolean

ShowNegativePointIndicators

Gets or sets a value indicating whether the negative points marker will be shown.

Declaration
public bool ShowNegativePointIndicators { get; set; }
Property Value
System.Boolean

ShowTooltip

Gets or sets a value whether tooltips on the point markers will be shown.

Declaration
public bool ShowTooltip { get; set; }
Property Value
System.Boolean

Methods

CreateSparkSeries(SparkSeriesType)

Creates a SparkSeries based on the SeriesType property of the column.

Declaration
public static SparkSeries CreateSparkSeries(SparkSeriesType seriesType)
Parameters
SparkSeriesType seriesType

Returns
SparkSeries

GetCellType(GridViewRowInfo)

Declaration
public override Type GetCellType(GridViewRowInfo row)
Parameters
GridViewRowInfo row

Returns
System.Type

Overrides

RaiseOnSparklineElementExporting(Object, SparklineElementExportingEventArgs)

Fires while exporting or printing the sparkline cell element, allows customization of the series.

Declaration
public virtual void RaiseOnSparklineElementExporting(object sender, SparklineElementExportingEventArgs args)
Parameters
System.Object sender

The sender which is raising the event on the column.
SparklineElementExportingEventArgs args

The SparklineElementExportingEventArgs instance containing the event data.

Events

PaintSparkFill

Fires when a spark line will be painted using the System.Drawing.SolidBrush class.

Declaration
public event PaintSparkFillEventHandler PaintSparkFill
Event Type
PaintSparkFillEventHandler

PaintSparkStroke

Fires when a spark line will be painted using the System.Drawing.Pen class.

Declaration
public event PaintSparkStrokeEventHandler PaintSparkStroke
Event Type
PaintSparkStrokeEventHandler

SparkDataNeeded

Fires before adding data points to the SparkSeriesobject. It is possible to cancel the event and bind the series.

Declaration
public event SparkDataNeededEventHandler SparkDataNeeded
Event Type
SparkDataNeededEventHandler

SparklineElementExporting

Fires while exporting or printing the sparkline cell element, allows customization of the series.

Declaration
public event SparklineElementExportingEventHandler SparklineElementExporting
Event Type
SparklineElementExportingEventHandler

Extension Methods