Class RadSparkline

Inheritance
System.Object
RadControl
RadSparkline
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Data Controls")]
public class RadSparkline : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider, IPrintable

Constructors

RadSparkline()

Declaration
public RadSparkline()

Properties

Annotations

Collection of the SparkAnnotations

Declaration
public SparkAnnotationCollection Annotations { get; }
Property Value
SparkAnnotationCollection

Area

Returns the current visible area.

Declaration
public SparkArea Area { get; }
Property Value
SparkArea

AutoSize

Gets or sets whether the edit control is auto-sized

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

Overrides

Axes

Collection of the Axes

Declaration
public SparkAxisCollection Axes { get; }
Property Value
SparkAxisCollection

AxisDrawMode

Gets or sets whether the horizontal axis will be painted on top of the series.

Declaration
public AxisDrawMode AxisDrawMode { get; set; }
Property Value
AxisDrawMode

Controllers

Collection of the Controllers

Declaration
public SparkViewControllerCollection Controllers { get; }
Property Value
SparkViewControllerCollection

DefaultSize

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

EmptyPointBehavior

Shows or hides ToolTip controller in RadSparkline.

Declaration
public EmptyPointBehavior EmptyPointBehavior { get; set; }
Property Value
EmptyPointBehavior

Series

Collection of the SparkSeries

Declaration
public SparkSeries Series { get; set; }
Property Value
SparkSeries

ShowAxis

Shows or hides the horizontal axis in the sparkline.

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

ShowFirstPointIndicator

Gets or sets whether the first point indicator will be painted.

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

ShowHighPointIndicator

Gets or sets whether the high point marker will be painted.

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

ShowLastPointIndicator

Gets or sets whether the last point indicator will be painted.

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

ShowLowPointIndicator

Gets or sets whether the low point indicator will be painted.

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

ShowNegativePointIndicators

Gets or sets whether the negative point markers will be painted.

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

ShowToolTip

Show or hide ToolTip controller in RadSparkline.

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

SparklineElement

Gets the sparkline element.

Declaration
public RadSparklineElement SparklineElement { get; }
Property Value
RadSparklineElement

View

Declaration
public SparkView View { get; }
Property Value
SparkView

Methods

BeginPrint(RadPrintDocument, PrintEventArgs)

Declaration
public int BeginPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

System.Drawing.Printing.PrintEventArgs args

Returns
System.Int32

Implements

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

CreateSparklineElement()

Declaration
protected virtual RadSparklineElement CreateSparklineElement()
Returns
RadSparklineElement

DeferRefresh()

Declaration
public IDisposable DeferRefresh()
Returns
System.IDisposable

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Overrides

EndPrint(RadPrintDocument, PrintEventArgs)

Declaration
public bool EndPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

System.Drawing.Printing.PrintEventArgs args

Returns
System.Boolean

Implements

ExportToImage(Stream, Size)

Exports the sparkline view into the specified stream using the PNG image format.

Declaration
public void ExportToImage(Stream stream, Size size)
Parameters
System.IO.Stream stream

The stream to which to write the chart image
System.Drawing.Size size

The size of the exported image.

ExportToImage(String, Size)

Exports the sparkline into the specified file using the PNG image format.

Declaration
public void ExportToImage(string filePath, Size size)
Parameters
System.String filePath

The file to which the chart will be exported.
System.Drawing.Size size

The size of the exported file.

ExportToImage(String, Size, ImageFormat)

Exports the sparkline view into the specified file.

Declaration
public void ExportToImage(string filePath, Size size, ImageFormat imageFormat)
Parameters
System.String filePath

The file to which the chart will be exported.
System.Drawing.Size size

The size of the exported file.
System.Drawing.Imaging.ImageFormat imageFormat

The image format in which to export the chart.

GetSettingsDialog(RadPrintDocument)

Declaration
public Form GetSettingsDialog(RadPrintDocument document)
Parameters
RadPrintDocument document

Returns
System.Windows.Forms.Form

Implements

OnLoad(Size)

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

Overrides

OnThemeChanged()

Called when the theme is changed.

Declaration
protected override void OnThemeChanged()
Overrides

Print()

Directly prints the RadSparkline to the default printer.

Declaration
public virtual void Print()

Print(Boolean)

Directly prints the RadSparkline to the default printer or shows printer settings and then prints the RadSparkline.

Declaration
public virtual void Print(bool showPrinterSettings)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.

Print(Boolean, RadPrintDocument)

Directly prints the RadSparkline to the default printer or shows printer settings and then prints the RadSparkline.

Declaration
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

PrintPage(Int32, RadPrintDocument, PrintPageEventArgs)

Declaration
public bool PrintPage(int pageNumber, RadPrintDocument sender, PrintPageEventArgs args)
Parameters
System.Int32 pageNumber

RadPrintDocument sender

System.Drawing.Printing.PrintPageEventArgs args

Returns
System.Boolean

Implements

PrintPreview()

Shows a RadPrintPreviewDialog for editing print settings.

Declaration
public virtual void PrintPreview()

PrintPreview(RadPrintDocument)

Shows a RadPrintPreviewDialog for editing print settings.

Declaration
public virtual void PrintPreview(RadPrintDocument document)
Parameters
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

Refresh()

Declaration
public override void Refresh()
Overrides

ResetBackColorThemeOverrides()

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

ResetForeColorThemeOverrides()

Declaration
protected override void ResetForeColorThemeOverrides()
Overrides

ResumeRefresh()

Declaration
public void ResumeRefresh()

ScaleControl(SizeF, BoundsSpecified)

Declaration
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
Parameters
System.Drawing.SizeF factor

System.Windows.Forms.BoundsSpecified specified

Overrides

SetBackColorThemeOverrides()

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

SetForeColorThemeOverrides()

Declaration
protected override void SetForeColorThemeOverrides()
Overrides

SuspendRefresh()

Declaration
public void SuspendRefresh()

Events

CreateRenderer

Fires when the area requies a renderer for the first time.

Declaration
public event SparklineCreateRendererEventHandler CreateRenderer
Event Type
SparklineCreateRendererEventHandler

PaintSparkFill

Fires when a spark fill will be painted using the System.Drawing.SolidBrushclass.

Declaration
public event PaintSparkFillEventHandler PaintSparkFill
Event Type
PaintSparkFillEventHandler

PaintSparkStroke

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

Declaration
public event PaintSparkStrokeEventHandler PaintSparkStroke
Event Type
PaintSparkStrokeEventHandler

Extension Methods