New to Telerik UI for WinFormsStart a free 30-day trial

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public abstract class UISparkElement : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISparkElementPresenter, IStylableElement, IStylableNode, IShapedElement

Inheritance: objectDisposableObjectRadObjectUISparkElement

Derived Classes: SparkAnnotationSparkAreaSparkSeriesSparkViewSparkAxis

Implements: ICustomTypeDescriptorIDisposableINotifyPropertyChangedIShapedElementISparkElementPresenterIStylableElementIStylableNode...

Inherited Members RadObject.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

Initialized a new instance of the UISparkElement class.

C#
public UISparkElement()

Fields

C#
public static RadProperty BackColorProperty
C#
public static RadProperty BorderColorProperty
C#
public static RadProperty BorderDashStyleProperty
C#
public static RadProperty BorderWidthProperty
C#
public static RadProperty ClassProperty
C#
public static RadProperty CustomFontProperty
C#
public static RadProperty CustomFontSizeProperty
C#
public static RadProperty CustomFontStyleProperty
C#
public static RadProperty FontProperty
C#
public static RadProperty ForeColorProperty
C#
public static RadProperty IsMouseDownProperty
C#
public static RadProperty IsMouseOverProperty
C#
public static RadProperty IsVisibleProperty
C#
public static RadProperty ShapeProperty
C#
public static RadProperty SmoothingModeProperty
C#
public static RadProperty VisualStateProperty

Properties

Gets or sets the back color.

C#
[TypeConverter(typeof(RadColorEditorConverter))]
public Color BackColor { get; set; }
Property Value:

The color of the back.

Gets or sets the color of the border.

C#
[TypeConverter(typeof(RadColorEditorConverter))]
public Color BorderColor { get; set; }
Property Value:

The color of the border.

Specifies the style of dashed lines drawn with a border.

C#
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.

C#
public float BorderWidth { get; set; }
C#
[Browsable(false)]
public SparkElementCollection Children { get; }

Gets the children hierarchy.

C#
[Browsable(false)]
public IEnumerable<RadObject> ChildrenHierarchy { get; }
Property Value:

The children hierarchy.

Implements: IStylableNode.ChildrenHierarchy

Gets the class.

C#
[Browsable(false)]
public string Class { get; }
Property Value:

The class.

Implements: IStylableNode.Class

Gets or sets the dpi scale factor.

C#
public SizeF DpiScaleFactor { get; protected set; }
Property Value:

The dpi scale factor.

Gets whether to fallback to default theme.

C#
[Browsable(false)]
public virtual bool FallbackToDefaultTheme { get; }
Property Value:

The fallback to default theme.

Implements: IStylableElement.FallbackToDefaultTheme

Gets or sets the font.

C#
public Font Font { get; set; }
Property Value:

The font.

Gets or sets the fore color.

C#
[TypeConverter(typeof(RadColorEditorConverter))]
public Color ForeColor { get; set; }
Property Value:

The color of the fore.

Gets if it is attached.

C#
[Browsable(false)]
public bool IsAttached { get; }
Property Value:

The is attached.

Gets if the mouse is down.

C#
[Browsable(false)]
public bool IsMouseDown { get; }
Property Value:

The is mouse down.

Gets if the mouse is over.

C#
[Browsable(false)]
public bool IsMouseOver { get; }
Property Value:

The is mouse over.

Gets or sets whether the element is visible.

C#
public virtual bool IsVisible { get; set; }

Implements: ISparkElementPresenter.IsVisible

Gets the level.

C#
[Browsable(false)]
public int Level { get; }
Property Value:

The level.

C#
[Browsable(false)]
public virtual RadObject Parent { get; set; }

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.

C#
[TypeConverter(typeof(ElementShapeConverter))]
public ElementShape Shape { get; set; }
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.

Gets or sets the SmoothingMode of the element.

C#
public SmoothingMode SmoothingMode { get; set; }

StateManager

ItemStateManagerBase

Gets or sets the state manager.

C#
[Browsable(false)]
public virtual ItemStateManagerBase StateManager { get; set; }
Property Value:

The state manager.

Implements: IStylableElement.StateManager

Gets or sets the style.

C#
[Browsable(false)]
public virtual StyleSheet Style { get; set; }
Property Value:

The style.

Implements: IStylableNode.Style

Gets or sets the theme role.

C#
[Browsable(false)]
public virtual string ThemeRole { get; set; }
Property Value:

The theme role.

Implements: IStylableElement.ThemeRole

Gets the view.

C#
[Browsable(false)]
public SparkView View { get; }
Property Value:

The view.

Gets or sets the state of the visual.

C#
[Browsable(false)]
public virtual string VisualState { get; set; }
Property Value:

The state of the visual.

Implements: IStylableElement.VisualState

Methods

Registers a style setting for this instance.

C#
protected override ValueUpdateResult AddStylePropertySetting(IPropertySetting setting)
Parameters:settingIPropertySettingReturns:

ValueUpdateResult

Overrides: RadObject.AddStylePropertySetting(IPropertySetting)

Applies the style.

C#
protected virtual void ApplyStyle()

Applies the style by the index.

C#
protected virtual void ApplyStyleByIndex(PropertySettingGroup group, int index)
Parameters:groupPropertySettingGroup

The group.

indexint

The index.

Applies the style settings.

C#
protected virtual void ApplyStyleSettingsCore(PropertySettingGroup group)
Parameters:groupPropertySettingGroup

The group.

Attaches the specified parent.

C#
public void Attach(UISparkElement parent)
Parameters:parentUISparkElement

The parent.

Builds the visual state.

C#
protected virtual void BuildVisualState()

Dettaches this instance.

C#
public void Dettach()

Called when DPI scale is changed.

C#
protected virtual void DpiScaleChanged(SizeF scaleFactor)
Parameters:scaleFactorSizeF

The scale factor.

Gets the current shape.

C#
public ElementShape GetCurrentShape()
Returns:

ElementShape

Implements: IShapedElement.GetCurrentShape()

Gets the scaled font.

C#
protected virtual Font GetScaledFont(float scale)
Parameters:scalefloat

The scale.

Returns:

Font

Gets the type of the theme effective.

C#
public virtual Type GetThemeEffectiveType()
Returns:

Type

Implements: IStylableNode.GetThemeEffectiveType()

Retrieves the current value for the specified property.

C#
public override object GetValue(RadProperty property)
Parameters:propertyRadPropertyReturns:

object

Overrides: RadObject.GetValue(RadProperty)

Invalidates the UISparkElement.

C#
public virtual void Invalidate()

Measures the content override.

C#
protected virtual RadSize MeasureContentOverride(SparkNode owner, object content)
Parameters:ownerSparkNode

The owner.

contentobject

The content.

Returns:

RadSize

Called when [attached].

C#
protected virtual void OnAttached(UISparkElement parent)
Parameters:parentUISparkElement

The parent.

Called when [dettached].

C#
protected virtual void OnDettached()

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

C#
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters:eRadPropertyChangedEventArgs

The RadPropertyChangedEventArgs containing information about the property change.

Overrides: RadObject.OnPropertyChanged(RadPropertyChangedEventArgs)

Refreshes the UISparkElement.

C#
public virtual void Refresh()