ParagraphNode Class
Definition
A Avalonia.Controls.Documents.Primitives.DocumentNodes.DocumentNode that renders a single Avalonia.Controls.Documents.Primitives.DocumentNodes.ParagraphNode.Paragraph using Avalonia's Avalonia.Controls.Documents.Primitives.DocumentNodes.ParagraphNode.TextLayout engine. Handles text shaping, selection geometry, caret positioning, hyperlink hit testing, and embedded control arrangement.
public class ParagraphNode
Remarks
Custom block handlers for Avalonia.Controls.Documents.Primitives.DocumentNodes.ParagraphNode.Paragraph-derived elements can return
new ParagraphNode(paragraph) from
Avalonia.Controls.Documents.TextModel.Handlers.BlockNodeKindHandler.CreateDocumentNode(Avalonia.Controls.Documents.RichTextElement) to reuse
the built-in paragraph rendering pipeline.
Constructors
| Name | Description |
|---|---|
| ParagraphNode | Initializes a new instance of Avalonia.Controls.Documents.Primitives.DocumentNodes.ParagraphNode for the given paragraph. |
ParagraphNode Constructor
Initializes a new instance of Avalonia.Controls.Documents.Primitives.DocumentNodes.ParagraphNode for the given paragraph.
public ParagraphNode(Avalonia.Controls.Documents.Paragraph paragraph)
Parameters
paragraph Avalonia.Controls.Documents.Paragraph
Methods
| Name | Description |
|---|---|
| AddHandler (2 overloads) | Adds a handler for the specified routed event. Inherited from Interactive. |
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| ApplyTemplate | Creates the visual children of the control, if necessary Inherited from Layoutable. |
| Arrange | Arranges the control and its children. Inherited from Layoutable. |
| 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. |
| Focus | Focuses the control. Inherited from InputElement. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetFlowDirection | Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetIsHoldingEnabled | Inherited from InputElement. |
| GetIsHoldWithMouseEnabled | Inherited from InputElement. |
| GetLineFromPosition | Gets line information for the line containing the specified position. |
| GetLines | Gets all lines in this paragraph. |
| GetRectFromTextPointer | Gets the caret rectangle for the specified text position. |
| GetSelectionRects | Returns selection rectangles within the node's content area. |
| GetSelectionText | Returns selected text segments within the node's content area. Inherited from DocumentNode. |
| GetTextRunProperties | Creates text run properties from a RichTextElement. When BaselineAlignment is RichSuperscript or RichSubscript the font size is scaled down so the glyphs are visually smaller, matching standard rich-text-editor behaviour regardless of OpenType feature support. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| HitTestPoint | Returns the text pointer at the given point, or if outside bounds. Inherited from DocumentNode. |
| InvalidateArrange | Invalidates the arrangement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateMeasure | Invalidates the measurement of the control and queues a new layout pass. Inherited from Layoutable. |
| InvalidateVisual | Invalidates the visual and queues a repaint. Inherited from Visual. |
| 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. |
| Measure | Carries out a measure of the control. Inherited from Layoutable. |
| RaiseEvent | Raises a routed event. Inherited from Interactive. |
| RemoveHandler (2 overloads) | Removes a handler for the specified routed event. Inherited from Interactive. |
| Render | Renders the visual to a Avalonia.Media.DrawingContext. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetFlowDirection | Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| SetIsHoldingEnabled | Inherited from InputElement. |
| SetIsHoldWithMouseEnabled | Inherited from InputElement. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| TryGetResource | Inherited from StyledElement. |
| UpdateLayout | Executes a layout pass. Inherited from Layoutable. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
GetLineFromPosition Method
Gets line information for the line containing the specified position.
public Nullable<Avalonia.Controls.Documents.Primitives.TextLineInfo> GetLineFromPosition(Avalonia.Controls.Documents.TextModel.TextPointer position)
Parameters
position Avalonia.Controls.Documents.TextModel.TextPointer
Returns
Nullable<Avalonia.Controls.Documents.Primitives.TextLineInfo>
GetLines Method
Gets all lines in this paragraph.
public System.Collections.Generic.IEnumerable<Avalonia.Controls.Documents.Primitives.TextLineInfo> GetLines()
Returns
System.Collections.Generic.IEnumerable<Avalonia.Controls.Documents.Primitives.TextLineInfo>
GetRectFromTextPointer Method
Gets the caret rectangle for the specified text position.
public Nullable<Avalonia.Rect> GetRectFromTextPointer(Avalonia.Controls.Documents.TextModel.TextPointer position, Avalonia.Controls.Documents.TextModel.LogicalDirection direction)
Parameters
position Avalonia.Controls.Documents.TextModel.TextPointer
The text position.
direction Avalonia.Controls.Documents.TextModel.LogicalDirection
The logical direction - affects line wrap boundaries within this paragraph.
Returns
Nullable<Avalonia.Rect>
A rectangle representing the caret position, or null if position is outside this paragraph.
Remarks
LogicalDirection affects how positions at line wrap boundaries are interpreted:
- Forward: Position at line end is treated as start of next line (if wrapped)
- Backward: Position at line start is treated as end of previous line (if wrapped)
Paragraph boundaries (start/end of paragraph) should be handled by the parent (TextViewBase).
GetSelectionRects Method
Returns selection rectangles within the node's content area.
public System.Collections.Generic.IEnumerable<Avalonia.Rect> GetSelectionRects(Avalonia.Controls.Documents.TextModel.TextRange selection)
Parameters
selection Avalonia.Controls.Documents.TextModel.TextRange
Returns
System.Collections.Generic.IEnumerable<Avalonia.Rect>
GetTextRunProperties Method
Creates text run properties from a RichTextElement. When BaselineAlignment is RichSuperscript or RichSubscript the font size is scaled down so the glyphs are visually smaller, matching standard rich-text-editor behaviour regardless of OpenType feature support.
public Avalonia.Media.TextFormatting.TextRunProperties GetTextRunProperties(Avalonia.Controls.Documents.RichTextElement element)
Parameters
element Avalonia.Controls.Documents.RichTextElement
Returns
Render Method
Renders the visual to a Avalonia.Media.DrawingContext.
public void Render(Avalonia.Media.DrawingContext context)
Parameters
context Avalonia.Media.DrawingContext
The drawing context.
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. |
| BackgroundSize | Gets the size used for rendering the background and border. Inherited from DocumentNode. |
| BorderBrush | Gets the current border brush applied to this node. Inherited from DocumentNode. |
| BorderThickness | Gets the current border thickness applied to this node. Inherited from DocumentNode. |
| Bounds | Gets the bounds of the control relative to its parent. Inherited from Visual. |
| CacheMode | Gets or sets the cache mode of the visual. Inherited from Visual. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| Clip | Gets or sets the geometry clip for this visual. Inherited from Visual. |
| ClipToBounds | Gets or sets a value indicating whether the control should be clipped to its bounds. Inherited from Visual. |
| ContentEnd | Gets the text pointer to the end of content covered by this node. Inherited from DocumentNode. |
| ContentLength | Gets the character length of this node's content. Inherited from DocumentNode. |
| ContentRange | Gets the text range covering the full content of this node. Inherited from DocumentNode. |
| ContentStart | Gets the text pointer to the start of content covered by this node. Inherited from DocumentNode. |
| CornerRadius | Gets the current corner radius applied to this node's border. Inherited from DocumentNode. |
| Cursor | Gets or sets associated mouse cursor. Inherited from InputElement. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| DesiredSize | Gets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Effect | Gets or sets the effect of the control. Inherited from Visual. |
| Element | Gets the element this node renders, or for the nested-document container (Avalonia.Controls.Documents.Primitives.DocumentNodes.NestedDocumentNode), whose content lives on Avalonia.Controls.Documents.Primitives.DocumentNodes.NestedDocumentNode.Document instead. Inherited from DocumentNode. |
| FlowDirection | Gets or sets the text flow direction. Inherited from Visual. |
| Focusable | Gets or sets a value indicating whether the control can receive focus. Inherited from InputElement. |
| GestureRecognizers | Inherited from InputElement. |
| HasMirrorTransform | Gets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual. |
| Height | Gets or sets the height of the element. Inherited from Layoutable. |
| HorizontalAlignment | Gets or sets the element's preferred horizontal alignment in its parent. Inherited from Layoutable. |
| IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable. |
| IsEffectivelyEnabled | Gets a value indicating whether this control and all its parents are enabled. Inherited from InputElement. |
| IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. Inherited from Visual. |
| IsEnabled | Gets or sets a value indicating whether the control is enabled for user interaction. Inherited from InputElement. |
| IsFocused | Gets a value indicating whether the control is focused. Inherited from InputElement. |
| IsHitTestVisible | Gets or sets a value indicating whether the control is considered for hit testing. Inherited from InputElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| IsKeyboardFocusWithin | Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement. |
| IsMeasureValid | Gets a value indicating whether the control's layout measure is valid. Inherited from Layoutable. |
| IsPointerOver | Gets a value indicating whether the pointer is currently over the control. Inherited from InputElement. |
| IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement. |
| IsVisible | Gets or sets a value indicating whether this control is visible. Inherited from Visual. |
| Item | Inherited from AvaloniaObject. |
| KeyBindings | Inherited from InputElement. |
| Margin | Gets or sets the margin around the element. Inherited from Layoutable. |
| MaxHeight | Gets or sets the maximum height of the element. Inherited from Layoutable. |
| MaxWidth | Gets or sets the maximum width of the element. Inherited from Layoutable. |
| MinHeight | Gets or sets the minimum height of the element. Inherited from Layoutable. |
| MinWidth | Gets or sets the minimum width of the element. Inherited from Layoutable. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| Opacity | Gets or sets the opacity of the control. Inherited from Visual. |
| OpacityMask | Gets or sets the opacity mask of the control. Inherited from Visual. |
| Padding | Gets the current padding applied to this node's content area. Inherited from DocumentNode. |
| Paragraph | Gets the Avalonia.Controls.Documents.Paragraph element rendered by this node. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| ParentNode | Gets the parent document node, or if this is the root. Inherited from DocumentNode. |
| RenderTransform | Gets or sets the render transform of the control. Inherited from Visual. |
| RenderTransformOrigin | Gets or sets the transform origin of the control. Inherited from Visual. |
| 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. |
| TabIndex | Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. Inherited from InputElement. |
| TemplatedParent | Gets the styled element whose lookless template this styled element is part of. Inherited from StyledElement. |
| TextLayout | Gets the current Avalonia.Media.TextFormatting.TextLayout used to render this paragraph, or if not yet measured. |
| TextView | Gets or sets the text view this node belongs to. Inherited from DocumentNode. |
| 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. |
| UseLayoutRounding | Gets or sets a value that determines whether the element should be snapped to pixel boundaries at layout time. Inherited from Layoutable. |
| VerticalAlignment | Gets or sets the element's preferred vertical alignment in its parent. Inherited from Layoutable. |
| Width | Gets or sets the width of the element. Inherited from Layoutable. |
| ZIndex | Gets or sets the Z index of the control. Inherited from Visual. |
Paragraph Property
Gets the Avalonia.Controls.Documents.Paragraph element rendered by this node.
public Avalonia.Controls.Documents.Paragraph Paragraph { get; set; }
TextLayout Property
Gets the current Avalonia.Media.TextFormatting.TextLayout used to render this paragraph, or if not yet measured.
public Avalonia.Media.TextFormatting.TextLayout TextLayout { get; set; }
Fields
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. |
| AttachedToVisualTree | Raised when the control is attached to a rooted visual tree. Inherited from Visual. |
| ContextCanceled | Occurs when the context input gesture continues into another gesture, to notify the element that the context flyout should not be opened. Inherited from InputElement. |
| ContextRequested | Occurs when the user has completed a context input gesture, such as a right-click. Inherited from InputElement. |
| 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. |
| DetachedFromVisualTree | Raised when the control is detached from a rooted visual tree. Inherited from Visual. |
| DoubleTapped | Occurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement. |
| EffectiveViewportChanged | Occurs when the element's effective viewport changes. Inherited from Layoutable. |
| GettingFocus | Occurs before the control receives focus. Inherited from InputElement. |
| GotFocus | Occurs when the control receives focus. Inherited from InputElement. |
| Holding | Occurs when the user makes a single contact, then maintains contact beyond a given time threshold without releasing or making another contact. Inherited from InputElement. |
| Initialized | Occurs when the styled element has finished initialization. Inherited from StyledElement. |
| KeyDown | Occurs when a key is pressed while the control has focus. Inherited from InputElement. |
| KeyUp | Occurs when a key is released while the control has focus. Inherited from InputElement. |
| LayoutUpdated | Occurs when a layout pass completes for the control. Inherited from Layoutable. |
| LosingFocus | Occurs before the control loses focus. Inherited from InputElement. |
| LostFocus | Occurs when the control loses focus. Inherited from InputElement. |
| Pinch | Occurs when the user moves two contact points closer together. Inherited from InputElement. |
| PinchEnded | Occurs when the user releases both contact points used in a pinch gesture. Inherited from InputElement. |
| PointerCaptureLost | Occurs when the control or its child control loses the pointer capture for any reason, event will not be triggered for a parent control if capture was transferred to another child of that parent control. Inherited from InputElement. |
| PointerEntered | Occurs when the pointer enters the control. Inherited from InputElement. |
| PointerExited | Occurs when the pointer leaves the control. Inherited from InputElement. |
| PointerMoved | Occurs when the pointer moves over the control. Inherited from InputElement. |
| PointerPressed | Occurs when the pointer is pressed over the control. Inherited from InputElement. |
| PointerReleased | Occurs when the pointer is released over the control. Inherited from InputElement. |
| PointerTouchPadGestureMagnify | Occurs when the user moves two contact points away from each other on a touchpad. Inherited from InputElement. |
| PointerTouchPadGestureRotate | Occurs when the user places two contact points and moves them in a circular motion on a touchpad. Inherited from InputElement. |
| PointerTouchPadGestureSwipe | Occurs when the user performs a rapid dragging motion in a single direction on a touchpad. Inherited from InputElement. |
| PointerWheelChanged | Occurs when the mouse is scrolled over the control. Inherited from InputElement. |
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |
| PullGesture | Occurs when the user drags from the edge of a control. Inherited from InputElement. |
| PullGestureEnded | Occurs when the user releases the pointer after a pull gesture. Inherited from InputElement. |
| ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement. |
| RightTapped | Occurs when the user briefly contacts and releases a single point, without significant movement, using a mechanism on the input device recognized as a right button or equivalent. Inherited from InputElement. |
| ScrollGesture | Occurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement. |
| ScrollGestureEnded | Occurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer. Inherited from InputElement. |
| ScrollGestureInertiaStarting | Occurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement. |
| SwipeGesture | Occurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement. |
| SwipeGestureEnded | Occurs when a swipe gesture ends on the control. Inherited from InputElement. |
| Tapped | Occurs when the user briefly contacts and releases a single point, without significant movement. Inherited from InputElement. |
| TextInput | Occurs when a user typed some text while the control has focus. Inherited from InputElement. |
| TextInputMethodClientRequested | Occurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement. |