StyledElement Class

Extends an Animatable with the following features: - An inherited DataContext. - Implements IStyleable to allow styling to work on the styled element. - Implements ILogical to form part of a logical tree. - A collection of class strings for custom styling.

Definition

Namespace: Avalonia
Assembly: Avalonia.Base (in Avalonia.Base.dll)

C#

public class StyledElement : Animatable, 
	IDataContextProvider, ILogical, IThemeVariantHost, IResourceHost, IResourceNode, 
	IStyleHost, ISetLogicalParent, ISetInheritanceParent, ISupportInitialize, INamed, 
	IStyleable

VB

Public Class StyledElement
	Inherits Animatable
	Implements IDataContextProvider, ILogical, IThemeVariantHost, IResourceHost, 
	IResourceNode, IStyleHost, ISetLogicalParent, ISetInheritanceParent, ISupportInitialize, 
	INamed, IStyleable

F#

type StyledElement = 
    class
        inherit Animatable
        interface IDataContextProvider
        interface ILogical
        interface IThemeVariantHost
        interface IResourceHost
        interface IResourceNode
        interface IStyleHost
        interface ISetLogicalParent
        interface ISetInheritanceParent
        interface ISupportInitialize
        interface INamed
        interface IStyleable
    end

View Source

Inheritance	Object → AvaloniaObject → Animatable → StyledElement
Derived	Avalonia.Controls.Documents.TextElement Avalonia.Input.GestureRecognizers.GestureRecognizer Avalonia.Visual
Implements	IResourceHost, IResourceNode, ISetInheritanceParent, ISetLogicalParent, IDataContextProvider, INamed, ILogical, IStyleable, IStyleHost, IThemeVariantHost, ISupportInitialize

Constructors

StyledElement()

Initializes a new instance of the StyledElement class.

Properties

ActualThemeVariant	Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty.
Classes	Gets or sets the styled element's classes.
DataContext	Gets or sets the control's data context.
InheritanceParent	Gets or sets the parent object that inherited AvaloniaProperty values are inherited from. (Inherited from AvaloniaObject)
IsInitialized	Gets a value that indicates whether the element has finished initialization.
Item(AvaloniaProperty)	Gets or sets the value of a AvaloniaProperty. (Inherited from AvaloniaObject)
Item(IndexerDescriptor)	Gets or sets a binding for a AvaloniaProperty. (Inherited from AvaloniaObject)
LogicalChildren	Gets the styled element's logical children.
Name	Gets or sets the name of the styled element.
Parent	Gets the styled element's logical parent.
PseudoClasses	Gets the Classes collection in a form that allows adding and removing pseudoclasses.
Resources	Gets or sets the styled element's resource dictionary.
StyleKey	Gets the type by which the element is styled.
StyleKeyOverride	Gets the type by which the element is styled.
Styles	Gets the styles for the styled element.
TemplatedParent	Gets the styled element whose lookless template this styled element is part of.
Theme	Gets or sets the theme to be applied to the element.
Transitions	Gets or sets the property transitions for the control. (Inherited from Animatable)

Methods

ApplyStyling()	Applies styling to the control if the control is initialized and styling is not already applied.
BeginInit()	Signals the object that initialization is starting.
Bind(AvaloniaProperty, IBinding)	Binds a AvaloniaProperty to an IBinding. (Inherited from AvaloniaObject)
Bind(AvaloniaProperty, IObservable(Object), BindingPriority)	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
Bind(T)(DirectPropertyBase(T), IObservable(T))	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
Bind(T)(DirectPropertyBase(T), IObservable(BindingValue(T)))	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
Bind(T)(DirectPropertyBase(T), IObservable(Object))	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
Bind(T)(StyledProperty(T), IObservable(T), BindingPriority)	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
Bind(T)(StyledProperty(T), IObservable(BindingValue(T)), BindingPriority)	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
Bind(T)(StyledProperty(T), IObservable(Object), BindingPriority)	Binds a AvaloniaProperty to an observable. (Inherited from AvaloniaObject)
CheckAccess()	Returns a value indicating whether the current thread is the UI thread. (Inherited from AvaloniaObject)
ClearValue(AvaloniaProperty)	Clears a AvaloniaProperty's local value. (Inherited from AvaloniaObject)
ClearValue(T)(AvaloniaProperty(T))	Clears a AvaloniaProperty's local value. (Inherited from AvaloniaObject)
ClearValue(T)(DirectPropertyBase(T))	Clears a AvaloniaProperty's local value. (Inherited from AvaloniaObject)
ClearValue(T)(StyledProperty(T))	Clears a AvaloniaProperty's local value. (Inherited from AvaloniaObject)
CoerceValue(AvaloniaProperty)	Coerces the specified AvaloniaProperty. (Inherited from AvaloniaObject)
EndInit()	Signals the object that initialization is complete.
Equals(Object)	Compares two objects using reference equality. (Inherited from AvaloniaObject)
Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetBaseValue(T)(StyledProperty(T))	Gets an AvaloniaProperty base value. (Inherited from AvaloniaObject)
GetHashCode()	Gets the hash code for the object. (Inherited from AvaloniaObject)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValue(AvaloniaProperty)	Gets a AvaloniaProperty value. (Inherited from AvaloniaObject)
GetValue(T)(DirectPropertyBase(T))	Gets a AvaloniaProperty value. (Inherited from AvaloniaObject)
GetValue(T)(StyledProperty(T))	Gets a AvaloniaProperty value. (Inherited from AvaloniaObject)
InitializeIfNeeded()
IsAnimating(AvaloniaProperty)	Checks whether a AvaloniaProperty is animating. (Inherited from AvaloniaObject)
IsSet(AvaloniaProperty)	Checks whether a AvaloniaProperty is set on this object. (Inherited from AvaloniaObject)
LogicalChildrenCollectionChanged(Object, NotifyCollectionChangedEventArgs)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnAttachedToLogicalTree(LogicalTreeAttachmentEventArgs)	Called when the styled element is added to a rooted logical tree.
OnDataContextBeginUpdate()	Called when the DataContext begins updating.
OnDataContextChanged(EventArgs)	Called when the DataContext property changes.
OnDataContextEndUpdate()	Called when the DataContext finishes updating.
OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs)	Called when the styled element is removed from a rooted logical tree.
OnInitialized()	Called when the control finishes initialization.
OnPropertyChanged(AvaloniaPropertyChangedEventArgs)	(Overrides AvaloniaObject.OnPropertyChanged(AvaloniaPropertyChangedEventArgs))
OnPropertyChangedCore(AvaloniaPropertyChangedEventArgs)	(Inherited from Animatable)
RaisePropertyChanged(T)(DirectPropertyBase(T), T, T)	Raises the PropertyChanged event for a direct property. (Inherited from AvaloniaObject)
SetAndRaise(T)(DirectPropertyBase(T), T, T)	Sets the backing field for a direct avalonia property, raising the PropertyChanged event if the value has changed. (Inherited from AvaloniaObject)
SetCurrentValue(AvaloniaProperty, Object)	Sets the value of a dependency property without changing its value source. (Inherited from AvaloniaObject)
SetCurrentValue(T)(StyledProperty(T), T)	Sets the value of a dependency property without changing its value source. (Inherited from AvaloniaObject)
SetValue(AvaloniaProperty, Object, BindingPriority)	Sets a AvaloniaProperty value. (Inherited from AvaloniaObject)
SetValue(T)(DirectPropertyBase(T), T)	Sets a AvaloniaProperty value. (Inherited from AvaloniaObject)
SetValue(T)(StyledProperty(T), T, BindingPriority)	Sets a AvaloniaProperty value. (Inherited from AvaloniaObject)
ToString()	Returns a string that represents the current object. (Inherited from Object)
TryGetResource(Object, ThemeVariant, Object)	Tries to find a resource within the object.
UpdateDataValidation(AvaloniaProperty, BindingValueType, Exception)	Called to update the validation state for properties for which data validation is enabled. (Inherited from AvaloniaObject)
VerifyAccess()	Checks that the current thread is the UI thread and throws if not. (Inherited from AvaloniaObject)

Events

ActualThemeVariantChanged	Raised when the theme variant is changed on the element or an ancestor of the element.
AttachedToLogicalTree	Raised when the styled element is attached to a rooted logical tree.
DataContextChanged	Occurs when the DataContext property changes.
DetachedFromLogicalTree	Raised when the styled element is detached from a rooted logical tree.
Initialized	Occurs when the styled element has finished initialization.
PropertyChanged	Raised when a AvaloniaProperty value changes on this object. (Inherited from AvaloniaObject)
ResourcesChanged	Occurs when a resource in this styled element or a parent styled element has changed.

Fields

DataContextProperty	Defines the DataContext property.
NameProperty	Defines the Name property.
ParentProperty	Defines the Parent property.
TemplatedParentProperty	Defines the TemplatedParent property.
ThemeProperty	Defines the Theme property.

Extension Methods

Bind(AvaloniaProperty, IBinding, Object)	Binds a property on an AvaloniaObject to an IBinding. (Defined by AvaloniaObjectExtensions)
Bind(T)(AvaloniaProperty(T), IObservable(BindingValue(T)), BindingPriority)	Binds an AvaloniaProperty to an observable. (Defined by AvaloniaObjectExtensions)
Bind(T)(AvaloniaProperty(T), IObservable(T), BindingPriority)	Binds an AvaloniaProperty to an observable. (Defined by AvaloniaObjectExtensions)
BindClass(String, IBinding, Object)	(Defined by StyledElementExtensions)
Find(T)(String)	Finds a named element in an INameScope. (Defined by NameScopeExtensions)
FindLogicalAncestorOfType(T)(Boolean)	Finds first ancestor of given type. (Defined by LogicalExtensions)
FindLogicalDescendantOfType(T)(Boolean)	Finds first descendant of given type. (Defined by LogicalExtensions)
FindNameScope()	(Defined by NameScopeExtensions)
FindResource(Object)	Finds the specified resource by searching up the logical tree and then global styles. (Defined by ResourceNodeExtensions)
FindResource(ThemeVariant, Object)	Finds the specified resource by searching up the logical tree and then global styles. (Defined by ResourceNodeExtensions)
Get(T)(String)	Gets a named element from an INameScope or throws if no element of the requested name was found. (Defined by NameScopeExtensions)
GetBaseValue(AvaloniaProperty)	Gets an AvaloniaProperty base value. (Defined by AvaloniaObjectExtensions)
GetBaseValue(T)(AvaloniaProperty(T))	Gets an AvaloniaProperty base value. (Defined by AvaloniaObjectExtensions)
GetBindingObservable(AvaloniaProperty)	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetBindingObservable(T)(AvaloniaProperty(T))	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetBindingObservable(TResult)(AvaloniaProperty, Func(Object, TResult))	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetBindingObservable(TSource, TResult)(AvaloniaProperty(TSource), Func(TSource, TResult))	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetBindingSubject(AvaloniaProperty, BindingPriority)	Gets a subject for a AvaloniaProperty. (Defined by AvaloniaObjectReactiveExtensions)
GetBindingSubject(T)(AvaloniaProperty(T), BindingPriority)	Gets a subject for a AvaloniaProperty. (Defined by AvaloniaObjectReactiveExtensions)
GetDiagnostic(AvaloniaProperty)	Gets a diagnostic for a AvaloniaProperty on a AvaloniaObject. (Defined by AvaloniaObjectExtensions)
GetLogicalAncestors()	Enumerates the ancestors of an ILogical in the logical tree. (Defined by LogicalExtensions)
GetLogicalChildren()	Enumerates the children of an ILogical in the logical tree. (Defined by LogicalExtensions)
GetLogicalDescendants()	Enumerates the descendants of an ILogical in the logical tree. (Defined by LogicalExtensions)
GetLogicalParent()	Gets the logical parent of an ILogical. (Defined by LogicalExtensions)
GetLogicalParent(T)()	Gets the logical parent of an ILogical. (Defined by LogicalExtensions)
GetLogicalSiblings()	Enumerates the siblings of an ILogical in the logical tree. (Defined by LogicalExtensions)
GetObservable(AvaloniaProperty)	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetObservable(T)(AvaloniaProperty(T))	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetObservable(TResult)(AvaloniaProperty, Func(Object, TResult))	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetObservable(TSource, TResult)(AvaloniaProperty(TSource), Func(TSource, TResult))	Gets an observable for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetPropertyChangedObservable(AvaloniaProperty)	Gets an observable that listens for property changed events for an AvaloniaProperty. (Defined by AvaloniaObjectExtensions)
GetResourceObservable(Object, Func(Object, Object))	(Defined by ResourceNodeExtensions)
GetSelfAndLogicalAncestors()	Enumerates an ILogical and its ancestors in the logical tree. (Defined by LogicalExtensions)
GetSelfAndLogicalDescendants()	Enumerates an ILogical and its descendants in the logical tree. (Defined by LogicalExtensions)
GetSubject(AvaloniaProperty, BindingPriority)	Gets a subject for an AvaloniaProperty. (Defined by AvaloniaObjectReactiveExtensions)
GetSubject(T)(AvaloniaProperty(T), BindingPriority)	Gets a subject for an AvaloniaProperty. (Defined by AvaloniaObjectReactiveExtensions)
GetValue(T)(AvaloniaProperty(T))	Gets a AvaloniaProperty value. (Defined by AvaloniaObjectExtensions)
GetValueStoreDiagnostic()	Gets a value store diagnostics for a AvaloniaObject. (Defined by AvaloniaObjectExtensions)
IsLogicalAncestorOf(ILogical)	Tests whether an ILogical is an ancestor of another logical. (Defined by LogicalExtensions)
TryFindResource(Object, Object)	Tries to the specified resource by searching up the logical tree and then global styles. (Defined by ResourceNodeExtensions)
TryFindResource(Object, ThemeVariant, Object)	Tries to the specified resource by searching up the logical tree and then global styles. (Defined by ResourceNodeExtensions)
TryGetResource(Object, Object)	Tries to find a resource within the object. (Defined by ResourceNodeExtensions)

See Also

Reference

Avalonia Namespace