Class UISparkElement
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll
Syntax
public abstract class UISparkElement : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISparkElementPresenter, IStylableElement, IStylableNode, IShapedElement
Constructors
UISparkElement()
Initialized a new instance of the UISparkElement class.
Declaration
public UISparkElement()
Fields
BackColorProperty
BorderColorProperty
BorderDashStyleProperty
BorderWidthProperty
ClassProperty
CustomFontProperty
CustomFontSizeProperty
CustomFontStyleProperty
FontProperty
ForeColorProperty
IsMouseDownProperty
IsMouseOverProperty
IsVisibleProperty
ShapeProperty
SmoothingModeProperty
VisualStateProperty
Properties
BackColor
Gets or sets the back color.
Declaration
[RadPropertyDefaultValue("BackColor", typeof(UISparkElement))]
public Color BackColor { get; set; }
Property Value
System.Drawing.Color
The color of the back. |
BorderColor
Gets or sets the color of the border.
Declaration
[RadPropertyDefaultValue("BorderColor", typeof(UISparkElement))]
public Color BorderColor { get; set; }
Property Value
System.Drawing.Color
The color of the border. |
BorderDashStyle
Specifies the style of dashed lines drawn with a border.
Declaration
[RadPropertyDefaultValue("BorderDashStyle", typeof(UISparkElement))]
public DashStyle BorderDashStyle { get; set; }
Property Value
System.Drawing.Drawing2D.DashStyle
|
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.
Declaration
[RadPropertyDefaultValue("BorderWidth", typeof(UISparkElement))]
public float BorderWidth { get; set; }
Property Value
System.Single
|
Children
ChildrenHierarchy
Gets the children hierarchy.
Declaration
public IEnumerable<RadObject> ChildrenHierarchy { get; }
Property Value
System.Collections.Generic.IEnumerable<RadObject>
The children hierarchy. |
Implements
Class
Gets the class.
Declaration
public string Class { get; }
Property Value
System.String
The class. |
Implements
CustomFont
Gets or sets the custom font.
Declaration
[VsbBrowsable(true)]
[RadPropertyDefaultValue("CustomFont", typeof(UISparkElement))]
public virtual string CustomFont { get; set; }
Property Value
System.String
The custom font. |
CustomFontSize
Gets or sets the size of the custom font.
Declaration
[VsbBrowsable(true)]
[RadPropertyDefaultValue("CustomFontSize", typeof(UISparkElement))]
public virtual float CustomFontSize { get; set; }
Property Value
System.Single
The size of the custom font. |
CustomFontStyle
Gets or sets the custom font style.
Declaration
[VsbBrowsable(true)]
[RadPropertyDefaultValue("CustomFontStyle", typeof(UISparkElement))]
public virtual FontStyle CustomFontStyle { get; set; }
Property Value
System.Drawing.FontStyle
The custom font style. |
DpiScaleFactor
Gets or sets the dpi scale factor.
Declaration
public SizeF DpiScaleFactor { get; protected set; }
Property Value
System.Drawing.SizeF
The dpi scale factor. |
FallbackToDefaultTheme
Gets whether to fallback to default theme.
Declaration
public virtual bool FallbackToDefaultTheme { get; }
Property Value
System.Boolean
The fallback to default theme. |
Implements
Font
Gets or sets the font.
Declaration
[RadPropertyDefaultValue("Font", typeof(UISparkElement))]
public Font Font { get; set; }
Property Value
System.Drawing.Font
The font. |
ForeColor
Gets or sets the fore color.
Declaration
[RadPropertyDefaultValue("ForeColor", typeof(UISparkElement))]
public Color ForeColor { get; set; }
Property Value
System.Drawing.Color
The color of the fore. |
IsAttached
Gets if it is attached.
Declaration
public bool IsAttached { get; }
Property Value
System.Boolean
The is attached. |
IsMouseDown
Gets if the mouse is down.
Declaration
public bool IsMouseDown { get; }
Property Value
System.Boolean
The is mouse down. |
IsMouseOver
Gets if the mouse is over.
Declaration
public bool IsMouseOver { get; }
Property Value
System.Boolean
The is mouse over. |
IsVisible
Gets or sets whether the element is visible.
Declaration
[RadPropertyDefaultValue("IsVisible", typeof(UISparkElement))]
public virtual bool IsVisible { get; set; }
Property Value
System.Boolean
|
Implements
Level
Gets the level.
Declaration
public int Level { get; }
Property Value
System.Int32
The level. |
Parent
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
[RadPropertyDefaultValue("Shape", typeof(UISparkElement))]
public ElementShape Shape { get; set; }
Property Value
ElementShape
|
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 System.Drawing.Design.UITypeEditor.
SmoothingMode
Gets or sets the SmoothingMode of the element.
Declaration
[RadPropertyDefaultValue("SmoothingMode", typeof(UISparkElement))]
public SmoothingMode SmoothingMode { get; set; }
Property Value
System.Drawing.Drawing2D.SmoothingMode
|
StateManager
Gets or sets the state manager.
Declaration
public virtual ItemStateManagerBase StateManager { get; set; }
Property Value
ItemStateManagerBase
The state manager. |
Implements
Style
Gets or sets the style.
Declaration
public virtual StyleSheet Style { get; set; }
Property Value
StyleSheet
The style. |
Implements
ThemeRole
Gets or sets the theme role.
Declaration
public virtual string ThemeRole { get; set; }
Property Value
System.String
The theme role. |
Implements
View
VisualState
Gets or sets the state of the visual.
Declaration
public virtual string VisualState { get; set; }
Property Value
System.String
The state of the visual. |
Implements
Methods
AddStylePropertySetting(IPropertySetting)
Registers a style setting for this instance.
Declaration
protected override ValueUpdateResult AddStylePropertySetting(IPropertySetting setting)
Parameters
IPropertySetting
setting
|
Returns
ValueUpdateResult
|
Overrides
ApplyStyle()
Applies the style.
Declaration
protected virtual void ApplyStyle()
ApplyStyleByIndex(PropertySettingGroup, Int32)
Applies the style by the index.
Declaration
protected virtual void ApplyStyleByIndex(PropertySettingGroup group, int index)
Parameters
PropertySettingGroup
group
The group. |
System.Int32
index
The index. |
ApplyStyleSettingsCore(PropertySettingGroup)
Applies the style settings.
Declaration
protected virtual void ApplyStyleSettingsCore(PropertySettingGroup group)
Parameters
PropertySettingGroup
group
The group. |
Attach(UISparkElement)
Attaches the specified parent.
Declaration
public void Attach(UISparkElement parent)
Parameters
UISparkElement
parent
The parent. |
BuildVisualState()
Builds the visual state.
Declaration
protected virtual void BuildVisualState()
Dettach()
Dettaches this instance.
Declaration
public void Dettach()
DpiScaleChanged(SizeF)
Called when DPI scale is changed.
Declaration
protected virtual void DpiScaleChanged(SizeF scaleFactor)
Parameters
System.Drawing.SizeF
scaleFactor
The scale factor. |
GetCurrentShape()
Gets the current shape.
Declaration
public ElementShape GetCurrentShape()
Returns
ElementShape
|
Implements
GetScaledFont(Single)
Gets the scaled font.
Declaration
protected virtual Font GetScaledFont(float scale)
Parameters
System.Single
scale
The scale. |
Returns
System.Drawing.Font
|
GetThemeEffectiveType()
Gets the type of the theme effective.
Declaration
public virtual Type GetThemeEffectiveType()
Returns
System.Type
|
Implements
GetValue(RadProperty)
Retrieves the current value for the specified property.
Declaration
public override object GetValue(RadProperty property)
Parameters
RadProperty
property
|
Returns
System.Object
|
Overrides
Invalidate()
Invalidates the UISparkElement.
Declaration
public virtual void Invalidate()
MeasureContentOverride(SparkNode, Object)
Measures the content override.
Declaration
protected virtual RadSize MeasureContentOverride(SparkNode owner, object content)
Parameters
SparkNode
owner
The owner. |
System.Object
content
The content. |
Returns
RadSize
|
OnAttached(UISparkElement)
Called when [attached].
Declaration
protected virtual void OnAttached(UISparkElement parent)
Parameters
UISparkElement
parent
The parent. |
OnDettached()
Called when [dettached].
Declaration
protected virtual void OnDettached()
OnPropertyChanged(RadPropertyChangedEventArgs)
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs
e
|
Overrides
Refresh()
Refreshes the UISparkElement.
Declaration
public virtual void Refresh()
Explicit Interface Implementations
IStylableNode.ApplySettings(PropertySettingGroup)
Declaration
void IStylableNode.ApplySettings(PropertySettingGroup group)
Parameters
PropertySettingGroup
group
|
Implements
IStylableNode.Children
Declaration
IEnumerable<RadObject> IStylableNode.Children { get; }
Returns
System.Collections.Generic.IEnumerable<RadObject>
|
Implements
IStylableNode.Parent
ISparkElementPresenter.MeasureContent(SparkNode, Object)
Declaration
RadSize ISparkElementPresenter.MeasureContent(SparkNode owner, object content)
Parameters
SparkNode
owner
|
System.Object
content
|
Returns
RadSize
|
Implements
ISparkElementPresenter.RefreshNode(SparkNode)
Declaration
void ISparkElementPresenter.RefreshNode(SparkNode node)
Parameters
SparkNode
node
|