TextDecoration Class

Definition

Namespace:Avalonia.Media

Assembly:Avalonia.Base

Package:Avalonia

Source:TextDecoration.cs

Represents a text decoration, which is a visual ornamentation that is added to text (such as an underline).

public class TextDecoration

Inheritance: object -> AvaloniaObject -> TextDecoration

Constructors

Name	Description
TextDecoration	No summary available.

TextDecoration Constructor

public TextDecoration()

Methods

Name	Description
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
Location	Gets or sets the location.
Stroke	Gets or sets the Avalonia.Media.IBrush that specifies how the Avalonia.Media.TextDecoration is painted.
StrokeDashArray	Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to draw the Avalonia.Media.TextDecoration.
StrokeDashOffset	Gets or sets a value that specifies the distance within the dash pattern where a dash begins.
StrokeLineCap	Gets or sets a Avalonia.Media.PenLineCap enumeration value that describes the shape at the ends of a line.
StrokeOffset	The stroke's offset.
StrokeOffsetUnit	Gets the units in which the Avalonia.Media.TextDecoration.StrokeOffset value is expressed.
StrokeThickness	Gets or sets the thickness of the Avalonia.Media.TextDecoration.
StrokeThicknessUnit	Gets the units in which the thickness of the Avalonia.Media.TextDecoration is expressed.
Dispatcher	Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
Item	Inherited from AvaloniaObject.

Location Property

Gets or sets the location.

public Avalonia.Media.TextDecorationLocation Location { get; set; }

Value

The location.

Stroke Property

Gets or sets the Avalonia.Media.IBrush that specifies how the Avalonia.Media.TextDecoration is painted.

public Avalonia.Media.IBrush Stroke { get; set; }

StrokeDashArray Property

Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to draw the Avalonia.Media.TextDecoration.

public Avalonia.Collections.AvaloniaList<T><double> StrokeDashArray { get; set; }

StrokeDashOffset Property

Gets or sets a value that specifies the distance within the dash pattern where a dash begins.

public double StrokeDashOffset { get; set; }

StrokeLineCap Property

Gets or sets a Avalonia.Media.PenLineCap enumeration value that describes the shape at the ends of a line.

public Avalonia.Media.PenLineCap StrokeLineCap { get; set; }

StrokeOffset Property

The stroke's offset.

public double StrokeOffset { get; set; }

Value

The pen offset.

StrokeOffsetUnit Property

Gets the units in which the Avalonia.Media.TextDecoration.StrokeOffset value is expressed.

public Avalonia.Media.TextDecorationUnit StrokeOffsetUnit { get; set; }

StrokeThickness Property

Gets or sets the thickness of the Avalonia.Media.TextDecoration.

public double StrokeThickness { get; set; }

StrokeThicknessUnit Property

Gets the units in which the thickness of the Avalonia.Media.TextDecoration is expressed.

public Avalonia.Media.TextDecorationUnit StrokeThicknessUnit { get; set; }

Fields

Name	Description
LocationProperty	Defines the Avalonia.Media.TextDecoration.Location property.
StrokeDashArrayProperty	Defines the Avalonia.Media.TextDecoration.StrokeDashArray property.
StrokeDashOffsetProperty	Defines the Avalonia.Media.TextDecoration.StrokeDashOffset property.
StrokeLineCapProperty	Defines the Avalonia.Media.TextDecoration.StrokeLineCap property.
StrokeOffsetProperty	Defines the Avalonia.Media.TextDecoration.StrokeOffset property.
StrokeOffsetUnitProperty	Defines the Avalonia.Media.TextDecoration.StrokeOffsetUnit property.
StrokeProperty	Defines the Avalonia.Media.TextDecoration.Stroke property.
StrokeThicknessProperty	Defines the Avalonia.Media.TextDecoration.StrokeThickness property.
StrokeThicknessUnitProperty	Defines the Avalonia.Media.TextDecoration.StrokeThicknessUnit property.

LocationProperty Field

Defines the Avalonia.Media.TextDecoration.Location property.

public Avalonia.StyledProperty<TValue><Avalonia.Media.TextDecorationLocation> LocationProperty

StrokeDashArrayProperty Field

Defines the Avalonia.Media.TextDecoration.StrokeDashArray property.

public Avalonia.StyledProperty<TValue><Avalonia.Collections.AvaloniaList<T><double>> StrokeDashArrayProperty

StrokeDashOffsetProperty Field

Defines the Avalonia.Media.TextDecoration.StrokeDashOffset property.

public Avalonia.StyledProperty<TValue><double> StrokeDashOffsetProperty

StrokeLineCapProperty Field

Defines the Avalonia.Media.TextDecoration.StrokeLineCap property.

public Avalonia.StyledProperty<TValue><Avalonia.Media.PenLineCap> StrokeLineCapProperty

StrokeOffsetProperty Field

Defines the Avalonia.Media.TextDecoration.StrokeOffset property.

public Avalonia.StyledProperty<TValue><double> StrokeOffsetProperty

StrokeOffsetUnitProperty Field

Defines the Avalonia.Media.TextDecoration.StrokeOffsetUnit property.

public Avalonia.StyledProperty<TValue><Avalonia.Media.TextDecorationUnit> StrokeOffsetUnitProperty

StrokeProperty Field

Defines the Avalonia.Media.TextDecoration.Stroke property.

public Avalonia.StyledProperty<TValue><Avalonia.Media.IBrush> StrokeProperty

StrokeThicknessProperty Field

Defines the Avalonia.Media.TextDecoration.StrokeThickness property.

public Avalonia.StyledProperty<TValue><double> StrokeThicknessProperty

StrokeThicknessUnitProperty Field

Defines the Avalonia.Media.TextDecoration.StrokeThicknessUnit property.

public Avalonia.StyledProperty<TValue><Avalonia.Media.TextDecorationUnit> StrokeThicknessUnitProperty

Events

Name	Description
PropertyChanged	Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.