List Class
Definition
A block element that displays a bulleted or numbered list.
public class List
Constructors
| Name | Description |
|---|---|
| List | Initializes a new instance of Avalonia.Controls.Documents.List. |
List Constructor
Initializes a new instance of Avalonia.Controls.Documents.List.
public List()
Methods
| Name | Description |
|---|---|
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| BeginInit | 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. |
| EndInit | Inherited from StyledElement. |
| 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. |
| TryGetResource | Inherited from StyledElement. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
Properties
| Name | Description |
|---|---|
| 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 the brush used to fill the background of the control. Inherited from RichTextElement. |
| BorderBrush | Gets or sets the brush used to paint the block border. Inherited from Block. |
| BorderThickness | Gets or sets the thickness of the block border. Inherited from Block. |
| BreakPageBefore | Gets or sets whether paginated output (print/PDF export) starts a new page before this block. The continuous on-screen flow ignores it. Inherited from Block. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| ContentEnd | Gets a text pointer to the end of the content in the document. Inherited from RichTextElement. |
| ContentLength | Gets the length, in characters, that is covered by this element. Inherited from RichTextElement. |
| ContentRange | Gets the range of text that represents the entire content, or null if the content is empty or unavailable. Inherited from RichTextElement. |
| ContentStart | Gets a text pointer to the start of the content in the document. Inherited from RichTextElement. |
| CornerRadius | Gets or sets the corner radius of the block border. Inherited from Block. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| FirstChildElement | Gets the first direct child element in the document tree, or if none exists. Inherited from RichTextElement. |
| FlowDirection | Gets or sets the flow direction for text within the block. Inherited from Block. |
| FontFamily | Gets or sets the font family used to display text. Inherited from RichTextElement. |
| FontFeatures | Gets or sets the collection of font features to apply to the text. Inherited from RichTextElement. |
| FontSize | Gets or sets the size of the font used to display text. Inherited from RichTextElement. |
| FontStretch | Gets or sets the degree to which the font is stretched horizontally. Inherited from RichTextElement. |
| FontStyle | Gets or sets the font style used to display the text. Inherited from RichTextElement. |
| FontWeight | Gets or sets the weight or thickness of the font used to display text. Inherited from RichTextElement. |
| Foreground | Gets or sets the brush used to paint the foreground of the control. Inherited from RichTextElement. |
| IsAttachedToDocument | Gets a value indicating whether this element is currently attached to a Avalonia.Controls.Documents.TextModel.TextDocument. Inherited from RichTextElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| Item | Inherited from AvaloniaObject. |
| KeepTogether | Gets or sets whether paginated output (print/PDF export) avoids splitting this block across pages. Best effort: a block taller than one page still splits. The continuous on-screen flow ignores it. Inherited from Block. |
| KeepWithNext | Gets or sets whether paginated output keeps this block's end on the same page as the start of the following block. Consecutive flagged blocks move as one chain, giving up when the chain exceeds a page. The continuous on-screen flow ignores it. Inherited from Block. |
| LastChildElement | Gets the last direct child element in the document tree, or if none exists. Inherited from RichTextElement. |
| LetterSpacing | Gets or sets the letter spacing. Inherited from RichTextElement. |
| LineHeight | Gets or sets the minimum line height for text lines in the block. Inherited from Block. |
| ListItems | Gets the list item collection. |
| Margin | Gets or sets the margin applied outside the block. Inherited from Block. |
| MarkerAlignment | Gets or sets how the marker is aligned within its column (Word's w:lvlJc). Avalonia.Media.TextAlignment.Left starts every marker at the same x; Avalonia.Media.TextAlignment.Right ends every marker at the same x with a consistent gap to the content, matching how Word aligns e.g. roman-numeral markers. The property default is Avalonia.Media.TextAlignment.Left, but a list that never sets it renders numbered markers right-aligned and bullets left-aligned by convention. |
| MarkerOffset | Gets or sets the offset between the list marker and the item content. |
| MarkerStyle | Gets or sets the marker style for list items. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| NextElement | Gets the next sibling element in the document tree, or if none exists. Inherited from RichTextElement. |
| Padding | Gets or sets the padding applied inside the block border. Inherited from Block. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| PreviousElement | Gets the previous sibling element in the document tree, or if none exists. Inherited from RichTextElement. |
| Resources | Gets or sets the styled element's resource dictionary. Inherited from StyledElement. |
| StartIndex | Gets or sets the starting index for numbered list items. |
| StyleKey | Gets the type by which the element is styled. Inherited from StyledElement. |
| Styles | Gets the styles for the styled element. Inherited from StyledElement. |
| TabStopPositions | Gets or sets the block's custom tab stop positions in device-independent pixels, measured from the content edge. Null (the default) means the block uses the default tab interval. Maps to Word's w:tabs and RTF \tx. Inherited from Block. |
| TemplatedParent | Gets the styled element whose lookless template this styled element is part of. Inherited from StyledElement. |
| TextAlignment | Gets or sets the horizontal alignment of text within the block. Inherited from Block. |
| TextDocument | Gets the Avalonia.Controls.Documents.TextModel.TextDocument this element is attached to, or if not attached. Inherited from RichTextElement. |
| TextIndent | Gets or sets the first-line indent in device-independent pixels; a negative value is a hanging indent. double.NaN (the default) means not set. Maps to Word's w:ind w:firstLine/w:hanging and RTF \fi. Inherited from Block. |
| 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. |
ListItems Property
Gets the list item collection.
public Avalonia.Controls.Documents.RichTextElementCollection<T><Avalonia.Controls.Documents.ListItem> ListItems { get; set; }
MarkerAlignment Property
Gets or sets how the marker is aligned within its column (Word's w:lvlJc).
Avalonia.Media.TextAlignment.Left starts every marker at the same x;
Avalonia.Media.TextAlignment.Right ends every marker at the same x with a consistent
gap to the content, matching how Word aligns e.g. roman-numeral markers. The
property default is Avalonia.Media.TextAlignment.Left, but a list that never sets it
renders numbered markers right-aligned and bullets left-aligned by convention.
public Avalonia.Media.TextAlignment MarkerAlignment { get; set; }
MarkerOffset Property
Gets or sets the offset between the list marker and the item content.
public double MarkerOffset { get; set; }
MarkerStyle Property
Gets or sets the marker style for list items.
public Avalonia.Controls.Documents.Primitives.DocumentNodes.TextMarkerStyle MarkerStyle { get; set; }
StartIndex Property
Gets or sets the starting index for numbered list items.
public int StartIndex { get; set; }
Fields
MarkerAlignmentProperty Field
Defines the Avalonia.Controls.Documents.List.MarkerAlignment property.
public Avalonia.StyledProperty<Avalonia.Media.TextAlignment> MarkerAlignmentProperty
MarkerOffsetProperty Field
Defines the Avalonia.Controls.Documents.List.MarkerStyle property.
public Avalonia.StyledProperty<double> MarkerOffsetProperty
MarkerStyleProperty Field
Defines the Avalonia.Controls.Documents.List.MarkerStyle property.
public Avalonia.StyledProperty<Avalonia.Controls.Documents.Primitives.DocumentNodes.TextMarkerStyle> MarkerStyleProperty
StartIndexProperty Field
Defines the Avalonia.Controls.Documents.List.StartIndex property.
public Avalonia.StyledProperty<int> StartIndexProperty
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. |
| PropertyChanged | Raised when a Avalonia.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. |