TextElement Class

TextElement is an base class for content in text based controls. TextElements span other content, applying property values or providing structural information.

Definition

Namespace: Avalonia.Controls.Documents
Assembly: Avalonia.Controls (in Avalonia.Controls.dll)

C#

public abstract class TextElement : StyledElement

VB

Public MustInherit Class TextElement
	Inherits StyledElement

F#

[<AbstractClassAttribute>]
type TextElement = 
    class
        inherit StyledElement
    end

View Source

Inheritance	Object → AvaloniaObject → Animatable → StyledElement → TextElement
Derived	Avalonia.Controls.Documents.Inline

Constructors

TextElement()

Initializes a new instance of the TextElement class

Properties

ActualThemeVariant	Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. (Inherited from StyledElement)
Background	Gets or sets a brush used to paint the control's background.
Classes	Gets or sets the styled element's classes. (Inherited from StyledElement)
DataContext	Gets or sets the control's data context. (Inherited from StyledElement)
FontFamily	Gets or sets the font family.
FontFeatures	Gets or sets the font features.
FontSize	Gets or sets the font size.
FontStretch	Gets or sets the font stretch.
FontStyle	Gets or sets the font style.
FontWeight	Gets or sets the font weight.
Foreground	Gets or sets a brush used to paint the text.
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. (Inherited from StyledElement)
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. (Inherited from StyledElement)
Name	Gets or sets the name of the styled element. (Inherited from StyledElement)
Parent	Gets the styled element's logical parent. (Inherited from StyledElement)
PseudoClasses	Gets the Classes collection in a form that allows adding and removing pseudoclasses. (Inherited from StyledElement)
Resources	Gets or sets the styled element's resource dictionary. (Inherited from StyledElement)
StyleKey	Gets the type by which the element is styled. (Inherited from StyledElement)
StyleKeyOverride	Gets the type by which the element is styled. (Inherited from StyledElement)
Styles	Gets the styles for the styled element. (Inherited from StyledElement)
TemplatedParent	Gets the styled element whose lookless template this styled element is part of. (Inherited from StyledElement)
Theme	Gets or sets the theme to be applied to the element. (Inherited from StyledElement)
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. (Inherited from StyledElement)
BeginInit()	Signals the object that initialization is starting. (Inherited from StyledElement)
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. (Inherited from StyledElement)
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)
GetFontFamily(Control)	Gets the value of the attached FontFamilyProperty on a control.
GetFontFeatures(Control)	Gets the value of the attached FontFeaturesProperty on a control.
GetFontSize(Control)	Gets the value of the attached FontSizeProperty on a control.
GetFontStretch(Control)	Gets the value of the attached FontStretchProperty on a control.
GetFontStyle(Control)	Gets the value of the attached FontStyleProperty on a control.
GetFontWeight(Control)	Gets the value of the attached FontWeightProperty on a control.
GetForeground(Control)	Gets the value of the attached ForegroundProperty on a control.
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()	(Inherited from StyledElement)
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)	(Inherited from StyledElement)
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. (Inherited from StyledElement)
OnDataContextBeginUpdate()	Called when the DataContext begins updating. (Inherited from StyledElement)
OnDataContextChanged(EventArgs)	Called when the DataContext property changes. (Inherited from StyledElement)
OnDataContextEndUpdate()	Called when the DataContext finishes updating. (Inherited from StyledElement)
OnDetachedFromLogicalTree(LogicalTreeAttachmentEventArgs)	Called when the styled element is removed from a rooted logical tree. (Inherited from StyledElement)
OnInitialized()	Called when the control finishes initialization. (Inherited from StyledElement)
OnPropertyChanged(AvaloniaPropertyChangedEventArgs)	(Overrides StyledElement.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)
SetFontFamily(Control, FontFamily)	Sets the value of the attached FontFamilyProperty on a control.
SetFontFeatures(Control, FontFeatureCollection)	Sets the value of the attached FontFeaturesProperty on a control.
SetFontSize(Control, Double)	Sets the value of the attached FontSizeProperty on a control.
SetFontStretch(Control, FontStretch)	Sets the value of the attached FontStretchProperty on a control.
SetFontStyle(Control, FontStyle)	Sets the value of the attached FontStyleProperty on a control.
SetFontWeight(Control, FontWeight)	Sets the value of the attached FontWeightProperty on a control.
SetForeground(Control, IBrush)	Sets the value of the attached ForegroundProperty on a control.
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. (Inherited from StyledElement)
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. (Inherited from StyledElement)
AttachedToLogicalTree	Raised when the styled element is attached to a rooted logical tree. (Inherited from StyledElement)
DataContextChanged	Occurs when the DataContext property changes. (Inherited from StyledElement)
DetachedFromLogicalTree	Raised when the styled element is detached from a rooted logical tree. (Inherited from StyledElement)
Initialized	Occurs when the styled element has finished initialization. (Inherited from StyledElement)
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. (Inherited from StyledElement)

Fields

BackgroundProperty	Defines the Background property.
FontFamilyProperty	Defines the FontFamily property.
FontFeaturesProperty	Defines the FontFeatures property.
FontSizeProperty	Defines the FontSize property.
FontStretchProperty	Defines the FontStretch property.
FontStyleProperty	Defines the FontStyle property.
FontWeightProperty	Defines the FontWeight property.
ForegroundProperty	Defines the Foreground 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)
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)
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)
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)

See Also

Reference

Avalonia.Controls.Documents Namespace