ClassUISparkElement
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public abstract class UISparkElement : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISparkElementPresenter, IStylableElement, IStylableNode, IShapedElementInheritance: objectDisposableObjectRadObjectUISparkElement
Derived Classes:
Implements:
Inherited Members
Constructors
UISparkElement()
Initialized a new instance of the UISparkElement class.
Declaration
public UISparkElement()Fields
BorderDashStyleProperty
Declaration
public static RadProperty BorderDashStylePropertyField Value
CustomFontSizeProperty
Declaration
public static RadProperty CustomFontSizePropertyField Value
CustomFontStyleProperty
Declaration
public static RadProperty CustomFontStylePropertyField Value
SmoothingModeProperty
Declaration
public static RadProperty SmoothingModePropertyField Value
Properties
BackColor
Gets or sets the back color.
Declaration
[TypeConverter(typeof(RadColorEditorConverter))]
public Color BackColor { get; set; }Property Value
The color of the back.
BorderColor
Gets or sets the color of the border.
Declaration
[TypeConverter(typeof(RadColorEditorConverter))]
public Color BorderColor { get; set; }Property Value
The color of the border.
BorderDashStyle
Specifies the style of dashed lines drawn with a border.
Declaration
public DashStyle BorderDashStyle { get; set; }Property Value
BorderWidth
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.
Children
Declaration
[Browsable(false)]
public SparkElementCollection Children { get; }Property Value
ChildrenHierarchy
Gets the children hierarchy.
Declaration
[Browsable(false)]
public IEnumerable<RadObject> ChildrenHierarchy { get; }Property Value
IEnumerable<RadObject>
The children hierarchy.
Implements
Class
Gets the class.
Declaration
[Browsable(false)]
public string Class { get; }Property Value
The class.
Implements
DpiScaleFactor
Gets or sets the dpi scale factor.
Declaration
public SizeF DpiScaleFactor { get; protected set; }Property Value
The dpi scale factor.
FallbackToDefaultTheme
Gets whether to fallback to default theme.
Declaration
[Browsable(false)]
public virtual bool FallbackToDefaultTheme { get; }Property Value
The fallback to default theme.
Implements
Font
Gets or sets the font.
ForeColor
Gets or sets the fore color.
Declaration
[TypeConverter(typeof(RadColorEditorConverter))]
public Color ForeColor { get; set; }Property Value
The color of the fore.
IsAttached
Gets if it is attached.
Declaration
[Browsable(false)]
public bool IsAttached { get; }Property Value
The is attached.
IsMouseDown
Gets if the mouse is down.
Declaration
[Browsable(false)]
public bool IsMouseDown { get; }Property Value
The is mouse down.
IsMouseOver
Gets if the mouse is over.
Declaration
[Browsable(false)]
public bool IsMouseOver { get; }Property Value
The is mouse over.
IsVisible
Gets or sets whether the element is visible.
Declaration
public virtual bool IsVisible { get; set; }Property Value
Implements
Level
Gets the level.
Declaration
[Browsable(false)]
public int Level { get; }Property Value
The level.
Parent
Declaration
[Browsable(false)]
public virtual RadObject Parent { get; set; }Property Value
Shape
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.
Declaration
[TypeConverter(typeof(ElementShapeConverter))]
public ElementShape Shape { get; set; }Property Value
Remarks
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 ElementShapeEditor UITypeEditor.
SmoothingMode
Gets or sets the SmoothingMode of the element.
Declaration
public SmoothingMode SmoothingMode { get; set; }Property Value
StateManager
Gets or sets the state manager.
Declaration
[Browsable(false)]
public virtual ItemStateManagerBase StateManager { get; set; }Property Value
ItemStateManagerBase
The state manager.
Implements
Style
Gets or sets the style.
Declaration
[Browsable(false)]
public virtual StyleSheet Style { get; set; }Property Value
The style.
Implements
ThemeRole
Gets or sets the theme role.
Declaration
[Browsable(false)]
public virtual string ThemeRole { get; set; }Property Value
The theme role.
Implements
View
Gets the view.
Declaration
[Browsable(false)]
public SparkView View { get; }Property Value
The view.
VisualState
Gets or sets the state of the visual.
Declaration
[Browsable(false)]
public virtual string VisualState { get; set; }Property Value
The state of the visual.
Implements
Methods
AddStylePropertySetting(IPropertySetting)
Registers a style setting for this instance.
Declaration
protected override ValueUpdateResult AddStylePropertySetting(IPropertySetting setting)Parameters
setting
Returns
Overrides
ApplyStyleByIndex(PropertySettingGroup, int)
Applies the style by the index.
Declaration
protected virtual void ApplyStyleByIndex(PropertySettingGroup group, int index)Parameters
group
The group.
index
The index.
ApplyStyleSettingsCore(PropertySettingGroup)
Applies the style settings.
Declaration
protected virtual void ApplyStyleSettingsCore(PropertySettingGroup group)Parameters
group
The group.
Attach(UISparkElement)
Attaches the specified parent.
Declaration
public void Attach(UISparkElement parent)Parameters
parent
The parent.
BuildVisualState()
Builds the visual state.
Declaration
protected virtual void BuildVisualState()DpiScaleChanged(SizeF)
Called when DPI scale is changed.
Declaration
protected virtual void DpiScaleChanged(SizeF scaleFactor)Parameters
scaleFactor
The scale factor.
GetCurrentShape()
Gets the current shape.
GetScaledFont(float)
Gets the scaled font.
GetThemeEffectiveType()
Gets the type of the theme effective.
GetValue(RadProperty)
Retrieves the current value for the specified property.
Declaration
public override object GetValue(RadProperty property)Parameters
property
Returns
Overrides
Invalidate()
Invalidates the UISparkElement.
Declaration
public virtual void Invalidate()MeasureContentOverride(SparkNode, object)
Measures the content override.
OnAttached(UISparkElement)
Called when [attached].
Declaration
protected virtual void OnAttached(UISparkElement parent)Parameters
parent
The parent.
OnDettached()
Called when [dettached].
Declaration
protected virtual void OnDettached()OnPropertyChanged(RadPropertyChangedEventArgs)
Raises the RadPropertyChanged event and the standard .NET PropertyChanged event to notify subscribers of property value changes.
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)Parameters
e
The RadPropertyChangedEventArgs containing information about the property change.
Overrides