Class
SparkView

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

cs-api-definition
public class SparkView : UISparkElement, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, IStylableElement, IStylableNode, IShapedElement, ISparkView, ISparkElementPresenter

Inheritance: objectDisposableObjectRadObjectUISparkElementSparkView

Implements: ICustomTypeDescriptorIDisposableINotifyPropertyChangedIShapedElementISparkElementPresenterISparkViewIStylableElementIStylableNode

Inherited Members UISparkElement.IsVisiblePropertyUISparkElement.ClassPropertyUISparkElement.VisualStatePropertyUISparkElement.IsMouseDownPropertyUISparkElement.IsMouseOverPropertyUISparkElement.FontPropertyUISparkElement.CustomFontPropertyUISparkElement.CustomFontSizePropertyUISparkElement.CustomFontStylePropertyUISparkElement.ForeColorPropertyUISparkElement.BackColorPropertyUISparkElement.BorderWidthPropertyUISparkElement.BorderColorPropertyUISparkElement.BorderDashStylePropertyUISparkElement.ShapePropertyUISparkElement.SmoothingModePropertyUISparkElement.GetValue(RadProperty)UISparkElement.Attach(UISparkElement)UISparkElement.Dettach()UISparkElement.OnDettached()UISparkElement.Refresh()UISparkElement.Invalidate()UISparkElement.MeasureContentOverride(SparkNode, object)UISparkElement.DpiScaleChanged(SizeF)UISparkElement.GetScaledFont(float)UISparkElement.GetCurrentShape()UISparkElement.GetThemeEffectiveType()UISparkElement.ApplyStyleSettingsCore(PropertySettingGroup)UISparkElement.ApplyStyle()UISparkElement.BuildVisualState()UISparkElement.AddStylePropertySetting(IPropertySetting)UISparkElement.ApplyStyleByIndex(PropertySettingGroup, int)UISparkElement.ParentUISparkElement.LevelUISparkElement.ChildrenUISparkElement.IsMouseDownUISparkElement.IsMouseOverUISparkElement.ViewUISparkElement.IsVisibleUISparkElement.ForeColorUISparkElement.FontUISparkElement.BackColorUISparkElement.BorderWidthUISparkElement.BorderColorUISparkElement.BorderDashStyleUISparkElement.ShapeUISparkElement.SmoothingModeUISparkElement.IsAttachedUISparkElement.DpiScaleFactorUISparkElement.ClassUISparkElement.VisualStateUISparkElement.ThemeRoleUISparkElement.ChildrenHierarchyUISparkElement.StyleUISparkElement.StateManagerUISparkElement.FallbackToDefaultThemeRadObject.BindingContextPropertyRadObject.RadTypeRadObject.ReplaceDefaultDescriptors(PropertyDescriptorCollection)RadObject.DisposeManagedResources()RadObject.ClearPropertyStore()RadObject.SuspendPropertyNotifications()RadObject.ResumePropertyNotifications()RadObject.GetPropertyValue(RadProperty)RadObject.SetDefaultValueOverride(RadProperty, object)RadObject.SetValue(RadProperty, object)RadObject.ResetValue(RadProperty)RadObject.ResetLocalValue(RadProperty)RadObject.ResetValue(RadProperty, ValueResetFlags)RadObject.UpdateValue(RadProperty)RadObject.GetValueSource(RadProperty)RadObject.GetRegisteredRadProperty(string)RadObject.UpdateValueCore(RadPropertyValue)RadObject.SetValueCore(RadPropertyValue, object, object, ValueSource)RadObject.ResetValueCore(RadPropertyValue, ValueResetFlags)RadObject.GetDefaultValue(RadPropertyValue, object)RadObject.CoerceValue(RadPropertyValue, object)RadObject.ShouldSerializeProperty(RadProperty)RadObject.CanRaisePropertyChangeNotifications(RadPropertyValue)RadObject.BindProperty(RadProperty, RadObject, RadProperty, PropertyBindingOptions)RadObject.UnbindProperty(RadProperty)RadObject.GetInheritedValue(RadProperty)RadObject.OnPropertyChanging(RadPropertyChangingEventArgs)RadObject.OnNotifyPropertyChanged(string)RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadObject.OnShouldSerializeProperty(ShouldSerializePropertyEventArgs)RadObject.IsPropertyCancelable(RadPropertyMetadata)RadObject.PropertyValuesRadObject.PropertyFilterRadObject.RadObjectTypeRadObject.BindingContextRadObject.PropertyChangedRadObject.RadPropertyChangedRadObject.RadPropertyChangingDisposableObject.GetBitState(long)DisposableObject.SetBitState(long, bool)DisposableObject.OnBitStateChanged(long, bool, bool)DisposableObject.Dispose()DisposableObject.Dispose(bool)DisposableObject.PerformDispose(bool)DisposableObject.DisposeUnmanagedResources()DisposableObject.BitStateDisposableObject.EventsDisposableObject.IsDisposingDisposableObject.IsDisposedDisposableObject.DisposedDisposableObject.Disposing

Constructors

SparkView(ISparkViewHost)

Initializes a new instance of the SparkView class.

Declaration

cs-api-definition
public SparkView(ISparkViewHost owner)

Parameters

owner

ISparkViewHost

The owner.

SparkView(RadSparkline)

Initializes a new instance of the SparkView class.

Declaration

cs-api-definition
public SparkView(RadSparkline owner)

Parameters

owner

RadSparkline

The owner.

SparkView(RadSparklineElement)

Initializes a new instance of the SparkView class.

Declaration

cs-api-definition
public SparkView(RadSparklineElement owner)

Parameters

owner

RadSparklineElement

The owner.

Fields

MarginProperty

Declaration

cs-api-definition
public static RadProperty MarginProperty

Field Value

RadProperty

MinSizeProperty

Declaration

cs-api-definition
public static RadProperty MinSizeProperty

Field Value

RadProperty

Properties

Annotations

Gets the annotations.

Declaration

cs-api-definition
public SparkAnnotationCollection Annotations { get; }

Property Value

SparkAnnotationCollection

The annotations.

Area

Gets the area.

Declaration

cs-api-definition
[Browsable(false)]
public SparkArea Area { get; }

Property Value

SparkArea

The area.

Axes

Gets the axes.

Declaration

cs-api-definition
public SparkAxisCollection Axes { get; }

Property Value

SparkAxisCollection

The axes.

AxisDrawMode

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

Declaration

cs-api-definition
public AxisDrawMode AxisDrawMode { get; set; }

Property Value

AxisDrawMode

ClientRectangle

Gets the client rectangle.

Declaration

cs-api-definition
public RectangleF ClientRectangle { get; }

Property Value

RectangleF

The client rectangle.

Controllers

Gets the controllers.

Declaration

cs-api-definition
public SparkViewControllerCollection Controllers { get; }

Property Value

SparkViewControllerCollection

The controllers.

DataMember

Gets or sets the name of the list or table in the data source for which the SparkSeries is bound.

Declaration

cs-api-definition
[Browsable(true)]
public string DataMember { get; set; }

Property Value

string

DataSource

Gets or sets the data source of the SparkSeries.

Declaration

cs-api-definition
public object DataSource { get; set; }

Property Value

object

EmptyPointBehavior

Declaration

cs-api-definition
public EmptyPointBehavior EmptyPointBehavior { get; set; }

Property Value

EmptyPointBehavior

Margin

Gets or sets the margin.

Declaration

cs-api-definition
public Padding Margin { get; set; }

Property Value

Padding

The margin.

MinSize

Gets or sets the minimum size.

Declaration

cs-api-definition
public SizeF MinSize { get; set; }

Property Value

SizeF

The size of the min.

Owner

Gets or sets the owner.

Declaration

cs-api-definition
public ISparkViewHost Owner { get; set; }

Property Value

ISparkViewHost

The owner.

Renderer

Gets the renderer.

Declaration

cs-api-definition
public ISparkRenderer Renderer { get; }

Property Value

ISparkRenderer

The renderer.

Series

Gets the series.

Declaration

cs-api-definition
public SparkSeries Series { get; set; }

Property Value

SparkSeries

The series.

ShowAxis

Shows or hides the horizontal axis in the sparkline.

Declaration

cs-api-definition
public bool ShowAxis { get; set; }

Property Value

bool

ShowFirstPointIndicator

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

Declaration

cs-api-definition
public bool ShowFirstPointIndicator { get; set; }

Property Value

bool

ShowHighPointIndicator

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

Declaration

cs-api-definition
public bool ShowHighPointIndicator { get; set; }

Property Value

bool

ShowLastPointIndicator

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

Declaration

cs-api-definition
public bool ShowLastPointIndicator { get; set; }

Property Value

bool

ShowLowPointIndicator

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

Declaration

cs-api-definition
public bool ShowLowPointIndicator { get; set; }

Property Value

bool

ShowNegativePointIndicators

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

Declaration

cs-api-definition
public bool ShowNegativePointIndicators { get; set; }

Property Value

bool

ShowToolTip

Gets or sets whether the tool tip will be shown.

Declaration

cs-api-definition
public bool ShowToolTip { get; set; }

Property Value

bool

The show tool tip.

ViewResult

Gets or sets the view result.

Declaration

cs-api-definition
public ViewResult ViewResult { get; set; }

Property Value

ViewResult

The view result.

Viewport

Gets or sets the viewport.

Declaration

cs-api-definition
public RadRect Viewport { get; set; }

Property Value

RadRect

The viewport.

Methods

DeferRefresh()

Defers the refresh.

Declaration

cs-api-definition
public virtual IDisposable DeferRefresh()

Returns

IDisposable

Draw(object)

Draws the specified context.

Declaration

cs-api-definition
public virtual void Draw(object context)

Parameters

context

object

The context.

GetArea<T>()

Gets the area.

Declaration

cs-api-definition
public T GetArea<T>() where T : SparkArea

Returns

T

Layout()

Layouts the sparkline.

Declaration

cs-api-definition
public void Layout()

Layout(RadRect)

Layouts in the specified rect.

Declaration

cs-api-definition
public void Layout(RadRect rect)

Parameters

rect

RadRect

The rect.

Layout(bool)

Layouts the sparkline indicating whether to invalidate.

Declaration

cs-api-definition
public void Layout(bool redraw)

Parameters

redraw

bool

The redraw.

OnAttached(UISparkElement)

Called when [attached].

Declaration

cs-api-definition
protected override void OnAttached(UISparkElement parent)

Parameters

parent

UISparkElement

The parent.

Overrides UISparkElement.OnAttached(UISparkElement)

OnCreatePoint(SparklineCreatePointEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnCreatePoint(SparklineCreatePointEventArgs e)

Parameters

e

SparklineCreatePointEventArgs

The SparklineCreatePointEventArgs instance containing the event data.

OnCreateRenderer(object, SparklineCreateRendererEventArgs)

Fires the CreateRenderer event.

Declaration

cs-api-definition
protected virtual void OnCreateRenderer(object sender, SparklineCreateRendererEventArgs e)

Parameters

sender

object

The sender.

e

SparklineCreateRendererEventArgs

The SparklineCreateRendererEventArgs instance containing the event data.

OnDataError(Exception)

Called when data error occurs.

Declaration

cs-api-definition
protected virtual void OnDataError(Exception exception)

Parameters

exception

Exception

The exception.

OnGesture(GestureEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnGesture(GestureEventArgs e)

Parameters

e

GestureEventArgs

The GestureEventArgs instance containing the event data.

OnKeyDown(KeyEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnKeyDown(KeyEventArgs e)

Parameters

e

KeyEventArgs

The KeyEventArgs instance containing the event data.

OnKeyPress(KeyPressEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnKeyPress(KeyPressEventArgs e)

Parameters

e

KeyPressEventArgs

The KeyPressEventArgs instance containing the event data.

OnKeyUp(KeyEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnKeyUp(KeyEventArgs e)

Parameters

e

KeyEventArgs

The KeyEventArgs instance containing the event data.

OnMouseCaptureChanged(EventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnMouseCaptureChanged(EventArgs e)

Parameters

e

EventArgs

The EventArgs instance containing the event data.

OnMouseClick(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnMouseClick(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

OnMouseDoubleClick(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnMouseDoubleClick(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

OnMouseDown(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnMouseDown(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

OnMouseEnter(EventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnMouseEnter(EventArgs e)

Parameters

e

EventArgs

The EventArgs instance containing the event data.

OnMouseHover(EventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnMouseHover(EventArgs e)

Parameters

e

EventArgs

The EventArgs instance containing the event data.

OnMouseLeave(EventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnMouseLeave(EventArgs e)

Parameters

e

EventArgs

The EventArgs instance containing the event data.

OnMouseMove(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnMouseMove(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

OnMouseUp(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnMouseUp(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

OnMouseWheel(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnMouseWheel(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

OnPanGesture(PanGestureEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnPanGesture(PanGestureEventArgs e)

Parameters

e

PanGestureEventArgs

The PanGestureEventArgs instance containing the event data.

OnPressAndTapGesture(PressAndTapGestureEventArgs)

Raises the event.

Declaration

cs-api-definition
protected void OnPressAndTapGesture(PressAndTapGestureEventArgs e)

Parameters

e

PressAndTapGestureEventArgs

The PressAndTapGestureEventArgs instance containing the event data.

OnPropertyChanged(RadPropertyChangedEventArgs)

Raises the RadPropertyChanged event and the standard .NET PropertyChanged event to notify subscribers of property value changes.

Declaration

cs-api-definition
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

e

RadPropertyChangedEventArgs

The RadPropertyChangedEventArgs containing information about the property change.

Overrides UISparkElement.OnPropertyChanged(RadPropertyChangedEventArgs)

OnRotateGesture(RotateGestureEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnRotateGesture(RotateGestureEventArgs e)

Parameters

e

RotateGestureEventArgs

The RotateGestureEventArgs instance containing the event data.

OnTwoFingerTapGesture(GestureEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnTwoFingerTapGesture(GestureEventArgs e)

Parameters

e

GestureEventArgs

The GestureEventArgs instance containing the event data.

OnZoomGesture(ZoomGestureEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual void OnZoomGesture(ZoomGestureEventArgs e)

Parameters

e

ZoomGestureEventArgs

The ZoomGestureEventArgs instance containing the event data.

PerformRefresh(UISparkElement, bool)

Performs refreshing the view.

Declaration

cs-api-definition
public void PerformRefresh(UISparkElement element, bool updateLayout)

Parameters

element

UISparkElement

The element.

updateLayout

bool

The update layout.

ProcessResult(ActionResult)

Processes the result.

Declaration

cs-api-definition
protected virtual bool ProcessResult(ActionResult actionResult)

Parameters

actionResult

ActionResult

The action result.

Returns

bool

Reset()

Resets the view.

Declaration

cs-api-definition
public void Reset()

ResumeRefresh()

Resumes refreshing the view.

Declaration

cs-api-definition
public void ResumeRefresh()

SuspendRefresh()

Suspends refreshing the view.

Declaration

cs-api-definition
public void SuspendRefresh()

SyncViewProperties()

Declaration

cs-api-definition
public virtual void SyncViewProperties()

Events

CreatePoint

Occurs when a new DataPoint is created.

Declaration

cs-api-definition
public event SparklineCreatePointEventHandler CreatePoint

Event Value

SparklineCreatePointEventHandler

CreateRenderer

Fired when the area requires an renderer for the first time.

Declaration

cs-api-definition
public event SparklineCreateRendererEventHandler CreateRenderer

Event Value

SparklineCreateRendererEventHandler

DataError

Occurs when a data error is detected.

Declaration

cs-api-definition
public event ChartViewDataErrorEventHandler DataError

Event Value

ChartViewDataErrorEventHandler