UISparkElement
Base node for sparkline visuals, providing the parent-child tree, theme state, and drawing properties used by a SparkView.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public abstract class UISparkElement : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISparkElementPresenter, IStylableElement, IStylableNode, IShapedElement
Inheritance: objectDisposableObjectRadObjectUISparkElement
Derived Classes:
Implements:
Inherited Members
Constructors
Initialized a new instance of the UISparkElement class.
public UISparkElement()
Fields
Identifies the background color used to fill the element.
public static RadProperty BackColorProperty
Identifies the color of the element's border.
public static RadProperty BorderColorProperty
Identifies the dash pattern used to draw the element's border.
public static RadProperty BorderDashStyleProperty
Identifies the width of the element's border.
public static RadProperty BorderWidthProperty
Identifies the property that stores the element's theme class name.
public static RadProperty ClassProperty
Identifies the custom theme font family property; None selects the regular font.
public static RadProperty CustomFontProperty
Identifies the size used when a custom theme font is selected.
public static RadProperty CustomFontSizeProperty
Identifies the style used when a custom theme font is selected.
public static RadProperty CustomFontStyleProperty
Identifies the font property used to draw the element's text.
public static RadProperty FontProperty
Identifies the foreground color used for element content.
public static RadProperty ForeColorProperty
Identifies the property that tracks whether the element is pressed.
public static RadProperty IsMouseDownProperty
Identifies the property that tracks whether the pointer is over the element.
public static RadProperty IsMouseOverProperty
Identifies the property that controls whether the spark element is rendered.
public static RadProperty IsVisibleProperty
Identifies the shape used to clip or outline the element.
public static RadProperty ShapeProperty
Identifies the graphics smoothing mode used when drawing the element.
public static RadProperty SmoothingModeProperty
Identifies the property that selects the visual-state style applied to the element.
public static RadProperty VisualStateProperty
Properties
Gets or sets the back color.
[TypeConverter(typeof(RadColorEditorConverter))]
public Color BackColor { get; set; }
The color of the back.
Gets or sets the color of the border.
[TypeConverter(typeof(RadColorEditorConverter))]
public Color BorderColor { get; set; }
The color of the border.
Specifies the style of dashed lines drawn with a border.
public DashStyle BorderDashStyle { get; set; }
Gets or sets a float value width of the left border. This property has effect only if FourBorders style is used in BoxStyle property and affects only the width of the left border.
public float BorderWidth { get; set; }
[Browsable(false)]
public SparkElementCollection Children { get; }
ChildrenHierarchy
IEnumerable<RadObject>
Gets the children hierarchy.
[Browsable(false)]
public IEnumerable<RadObject> ChildrenHierarchy { get; }
The children hierarchy.
Implements:
Gets the class.
[Browsable(false)]
public string Class { get; }
The class.
Implements:
Gets or sets the dpi scale factor.
public SizeF DpiScaleFactor { get; protected set; }
The dpi scale factor.
Gets whether to fallback to default theme.
[Browsable(false)]
public virtual bool FallbackToDefaultTheme { get; }
The fallback to default theme.
Implements:
Gets or sets the fore color.
[TypeConverter(typeof(RadColorEditorConverter))]
public Color ForeColor { get; set; }
The color of the fore.
Gets if it is attached.
[Browsable(false)]
public bool IsAttached { get; }
The is attached.
Gets if the mouse is down.
[Browsable(false)]
public bool IsMouseDown { get; }
The is mouse down.
Gets if the mouse is over.
[Browsable(false)]
public bool IsMouseOver { get; }
The is mouse over.
Gets or sets whether the element is visible.
public virtual bool IsVisible { get; set; }
Implements:
Gets or sets an instance of the Shape object of an element. The shape of the element is both responsible for clipping the element's children and for providing its' border(s) with custom shape.
[TypeConverter(typeof(ElementShapeConverter))]
public ElementShape Shape { get; set; }
Value of null (or Nothing in VisualBasic.Net) indicates that element has rectangular (or no) shape. Shape is an object that defines the bounding graphics path of an element. Graphics clip is always applied when an element has shape. Shape is considered when painting the border element, and when hit-testing an element. Some predefined shapes are available, like RoundRectShape or EllipseShape. CustomShape offers a way to specify element's shape with a sequance of points and curves using code or the design time ElementShapeEditorUITypeEditor.
Gets or sets the SmoothingMode of the element.
public SmoothingMode SmoothingMode { get; set; }
StateManager
ItemStateManagerBase
Gets or sets the state manager.
[Browsable(false)]
public virtual ItemStateManagerBase StateManager { get; set; }
The state manager.
Implements:
Gets or sets the style.
[Browsable(false)]
public virtual StyleSheet Style { get; set; }
The style.
Implements:
Gets or sets the theme role.
[Browsable(false)]
public virtual string ThemeRole { get; set; }
The theme role.
Implements:
Gets the view.
[Browsable(false)]
public SparkView View { get; }
The view.
Gets or sets the state of the visual.
[Browsable(false)]
public virtual string VisualState { get; set; }
The state of the visual.
Implements:
Methods
Registers a style setting for this instance.
protected override ValueUpdateResult AddStylePropertySetting(IPropertySetting setting)
Overrides:
Applies the style.
protected virtual void ApplyStyle()
Applies the style by the index.
protected virtual void ApplyStyleByIndex(PropertySettingGroup group, int index)
The group.
indexintThe index.
Applies the style settings.
protected virtual void ApplyStyleSettingsCore(PropertySettingGroup group)
The group.
Attaches the specified parent.
Builds the visual state.
protected virtual void BuildVisualState()
Dettaches this instance.
public void Dettach()
Called when DPI scale is changed.
protected virtual void DpiScaleChanged(SizeF scaleFactor)
The scale factor.
Gets the current shape.
Gets the type of the theme effective.
Retrieves the current value for the specified property.
public override object GetValue(RadProperty property)
Overrides:
Invalidates the UISparkElement.
public virtual void Invalidate()
Called when [attached].
protected virtual void OnAttached(UISparkElement parent)
The parent.
Called when [dettached].
protected virtual void OnDettached()
Applies visual-state and custom-font changes and updates cached drawing properties.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
The property change notification.
Overrides:
Refreshes the UISparkElement.
public virtual void Refresh()