Run Class

Definition

Namespace:Avalonia.Controls.Documents

Assembly:Avalonia.Controls

Package:Avalonia

Source:Run.cs

A terminal element in text flow hierarchy - contains a uniformatted run of unicode characters

public class Run

Inheritance: object -> AvaloniaObject -> Animatable -> StyledElement -> TextElement -> Inline -> Run

Constructors

Name	Description
Run (2 overloads)	Initializes an instance of Run class.

Run overloads

Run Constructor

Initializes an instance of Run class.

public Run()

Run Constructor

Initializes an instance of Run class specifying its text content.

public Run(string text)

Parameters

text string

Text content assigned to the Run.

Methods

Name	Description
GetTextDecorations	Gets the value of the attached Avalonia.Controls.Documents.Inline.TextDecorationsProperty on a control. Inherited from Inline.
SetTextDecorations	Sets the value of the attached Avalonia.Controls.Documents.Inline.TextDecorationsProperty on a control. Inherited from Inline.
GetFontFamily	Gets the value of the attached Avalonia.Controls.Documents.TextElement.FontFamilyProperty on a control. Inherited from TextElement.
GetFontFeatures	Gets the value of the attached Avalonia.Controls.Documents.TextElement.FontFeaturesProperty on a control. Inherited from TextElement.
GetFontSize	Gets the value of the attached Avalonia.Controls.Documents.TextElement.FontSizeProperty on a control. Inherited from TextElement.
GetFontStretch	Gets the value of the attached Avalonia.Controls.Documents.TextElement.FontStretchProperty on a control. Inherited from TextElement.
GetFontStyle	Gets the value of the attached Avalonia.Controls.Documents.TextElement.FontStyleProperty on a control. Inherited from TextElement.
GetFontWeight	Gets the value of the attached Avalonia.Controls.Documents.TextElement.FontWeightProperty on a control. Inherited from TextElement.
GetForeground	Gets the value of the attached Avalonia.Controls.Documents.TextElement.ForegroundProperty on a control. Inherited from TextElement.
GetLetterSpacing	Gets the value of the attached Avalonia.Controls.Documents.TextElement.LetterSpacingProperty on a control. Inherited from TextElement.
SetFontFamily	Sets the value of the attached Avalonia.Controls.Documents.TextElement.FontFamilyProperty on a control. Inherited from TextElement.
SetFontFeatures	Sets the value of the attached Avalonia.Controls.Documents.TextElement.FontFeaturesProperty on a control. Inherited from TextElement.
SetFontSize	Sets the value of the attached Avalonia.Controls.Documents.TextElement.FontSizeProperty on a control. Inherited from TextElement.
SetFontStretch	Sets the value of the attached Avalonia.Controls.Documents.TextElement.FontStretchProperty on a control. Inherited from TextElement.
SetFontStyle	Sets the value of the attached Avalonia.Controls.Documents.TextElement.FontStyleProperty on a control. Inherited from TextElement.
SetFontWeight	Sets the value of the attached Avalonia.Controls.Documents.TextElement.FontWeightProperty on a control. Inherited from TextElement.
SetForeground	Sets the value of the attached Avalonia.Controls.Documents.TextElement.ForegroundProperty on a control. Inherited from TextElement.
SetLetterSpacing	Sets the value of the attached Avalonia.Controls.Documents.TextElement.LetterSpacingProperty on a control. Inherited from TextElement.
ApplyStyling	Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement.
BeginInit	Inherited from StyledElement.
EndInit	Inherited from StyledElement.
TryGetResource	Inherited from StyledElement.
Bind (8 overloads)	Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
CheckAccess	Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject.
ClearValue (4 overloads)	Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject.
CoerceValue	Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
Equals	Compares two objects using reference equality. Inherited from AvaloniaObject.
GetBaseValue	Inherited from AvaloniaObject.
GetHashCode	Gets the hash code for the object. Inherited from AvaloniaObject.
GetValue (3 overloads)	Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
IsAnimating	Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSet	Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
SetCurrentValue (2 overloads)	Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetValue (3 overloads)	Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
VerifyAccess	Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

Properties

Name	Description
Text	The content spanned by this TextElement.
BaselineAlignment	Describes how the baseline for a text-based element is positioned on the vertical axis, relative to the established baseline for text. Inherited from Inline.
TextDecorations	The TextDecorations property specifies decorations that are added to the text of an element. Inherited from Inline.
Background	Gets or sets a brush used to paint the control's background. Inherited from TextElement.
FontFamily	Gets or sets the font family. Inherited from TextElement.
FontFeatures	Gets or sets the font features. Inherited from TextElement.
FontSize	Gets or sets the font size. Inherited from TextElement.
FontStretch	Gets or sets the font stretch. Inherited from TextElement.
FontStyle	Gets or sets the font style. Inherited from TextElement.
FontWeight	Gets or sets the font weight. Inherited from TextElement.
Foreground	Gets or sets a brush used to paint the text. Inherited from TextElement.
LetterSpacing	Gets or sets the letter spacing. Inherited from TextElement.
ActualThemeVariant	Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement.
Classes	Gets or sets the styled element's classes. Inherited from StyledElement.
DataContext	Gets or sets the control's data context. Inherited from StyledElement.
IsInitialized	Gets a value that indicates whether the element has finished initialization. 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.
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.
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.
Dispatcher	Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
Item	Inherited from AvaloniaObject.

Text Property

The content spanned by this TextElement.

public string Text { get; set; }

Fields

Name	Description
TextProperty	Dependency property backing Text.
BaselineAlignmentProperty	AvaloniaProperty for Avalonia.Controls.Documents.Inline.BaselineAlignment property. Inherited from Inline.
TextDecorationsProperty	AvaloniaProperty for Avalonia.Controls.Documents.Inline.TextDecorations property. Inherited from Inline.
BackgroundProperty	Defines the Avalonia.Controls.Documents.TextElement.Background property. Inherited from TextElement.
FontFamilyProperty	Defines the Avalonia.Controls.Documents.TextElement.FontFamily property. Inherited from TextElement.
FontFeaturesProperty	Defines the Avalonia.Controls.Documents.TextElement.FontFeatures property. Inherited from TextElement.
FontSizeProperty	Defines the Avalonia.Controls.Documents.TextElement.FontSize property. Inherited from TextElement.
FontStretchProperty	Defines the Avalonia.Controls.Documents.TextElement.FontStretch property. Inherited from TextElement.
FontStyleProperty	Defines the Avalonia.Controls.Documents.TextElement.FontStyle property. Inherited from TextElement.
FontWeightProperty	Defines the Avalonia.Controls.Documents.TextElement.FontWeight property. Inherited from TextElement.
ForegroundProperty	Defines the Avalonia.Controls.Documents.TextElement.Foreground property. Inherited from TextElement.
LetterSpacingProperty	Defines the Avalonia.Controls.Documents.TextElement.LetterSpacing property. Inherited from TextElement.
DataContextProperty	Defines the Avalonia.StyledElement.DataContext property. Inherited from StyledElement.
NameProperty	Defines the Avalonia.StyledElement.Name property. Inherited from StyledElement.
ParentProperty	Defines the Avalonia.StyledElement.Parent property. Inherited from StyledElement.
TemplatedParentProperty	Defines the Avalonia.StyledElement.TemplatedParent property. Inherited from StyledElement.
ThemeProperty	Defines the Avalonia.StyledElement.Theme property. Inherited from StyledElement.
TransitionsProperty	Defines the Avalonia.Animation.Animatable.Transitions property. Inherited from Animatable.

TextProperty Field

Dependency property backing Text.

public Avalonia.StyledProperty<string> TextProperty

Remarks

Note that when a TextRange that intersects with this Run gets modified (e.g. by editing a selection in RichTextBox), we will get two changes to this property since we delete and then insert when setting the content of a TextRange.

Events

Name	Description
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 Avalonia.StyledElement.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.
ResourcesChanged	Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement.
PropertyChanged	Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.