TextViewBase Class

Definition

Namespace:Avalonia.Controls.Documents.Primitives

Assembly:Avalonia.Controls.Documents

Package:Avalonia.Controls.Documents

A virtualizing text view that only realizes document blocks overlapping the viewport. Implements Avalonia.Controls.Documents.Primitives.ITextView for coordinate mapping and Avalonia.Controls.Primitives.ILogicalScrollable to drive a parent Avalonia.Controls.ScrollViewer.

public class TextViewBase

Inheritance: object -> AvaloniaObject -> Animatable -> StyledElement -> Visual -> Layoutable -> Interactive -> InputElement -> Control -> TemplatedControl -> TextViewBase

Derived types:InteractiveTextView

Implements: ITextView, ILogicalScrollable, IScrollable

Remarks

This control manages Avalonia.Controls.Documents.Primitives.DocumentNodes.DocumentNode instances inside a PART_ContentHost panel and only keeps nodes in the viewport (plus a configurable buffer) alive. Scrolling is block-anchored: the authoritative vertical scroll state is (anchor block, offset within it), the realized band is laid out outward from the anchor using measured heights, and the pixel offset reported through Avalonia.Controls.Primitives.ILogicalScrollable is a projection into an estimated address space used only by the scrollbar. No layout state is retained for off-screen blocks, so memory stays proportional to the viewport rather than to the blocks visited.

Because this is a Avalonia.Controls.Primitives.TemplatedControl, consumers can supply a custom template that places additional overlays (caret, highlights, etc.) as siblings of the content host.

The layout strategy is closed: the placement seams below are visible only to the views in this assembly. A view is extended with an Avalonia.Controls.Documents.Primitives.Components.ITextViewComponent or a Avalonia.Controls.Documents.Primitives.Highlighting.IHighlightLayer, not by deriving from it. Use Avalonia.Controls.Documents.Primitives.InteractiveTextView where a concrete view is needed.

Constructors

Name	Description
TextViewBase	No summary available.

TextViewBase Constructor

public TextViewBase()

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 TemplatedControl.
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.
EnsurePositionVisible	Ensures the block containing position is in the viewport. After the next layout pass the block will be realized and Avalonia.Controls.Documents.Primitives.TextViewBase.GetRectangleFromTextPosition(Avalonia.Controls.Documents.TextModel.TextPointer,Avalonia.Controls.Documents.TextModel.LogicalDirection) will return a valid rect.
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.
GetIsTemplateFocusTarget	Gets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
GetLineFromPosition	Gets the line containing the specified position.
GetNextLine	Gets the next line after the specified line.
GetPositionAtLineEnd	Gets the position at the end of the line containing the specified position.
GetPositionAtLineStart	Gets the position at the start of the line containing the specified position.
GetPositionAtLineX	Returns the text position on line closest to the specified X coordinate. The result is guaranteed to stay on line; it never crosses into a neighbouring line or block, regardless of how far x lies outside the line's horizontal bounds.
GetPreviousLine	Gets the previous line before the specified line.
GetRectangleFromTextPosition	Gets the bounding rectangle for a character at the specified position.
GetTextPositionFromPoint	Gets the text position from a screen point.
GetValue (3 overloads)	Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
GetVisibleLineAtOrAfter	Gets the first visible line at or after the specified position.
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.
SetIsTemplateFocusTarget	Sets the value of the IsTemplateFocusTargetProperty attached property on a control. Inherited from TemplatedControl.
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.

EnsurePositionVisible Method

Ensures the block containing position is in the viewport. After the next layout pass the block will be realized and Avalonia.Controls.Documents.Primitives.TextViewBase.GetRectangleFromTextPosition(Avalonia.Controls.Documents.TextModel.TextPointer,Avalonia.Controls.Documents.TextModel.LogicalDirection) will return a valid rect.

public void EnsurePositionVisible(Avalonia.Controls.Documents.TextModel.TextPointer position)

Parameters

position Avalonia.Controls.Documents.TextModel.TextPointer

GetLineFromPosition Method

Gets the line containing the specified position.

public Avalonia.Controls.Documents.Primitives.ITextLine GetLineFromPosition(Avalonia.Controls.Documents.TextModel.TextPointer position)

Parameters

position Avalonia.Controls.Documents.TextModel.TextPointer

The text position.

Returns

Avalonia.Controls.Documents.Primitives.ITextLine

The line containing the position, or null if the position is not visible.

GetNextLine Method

Gets the next line after the specified line.

public Avalonia.Controls.Documents.Primitives.ITextLine GetNextLine(Avalonia.Controls.Documents.Primitives.ITextLine currentLine)

Parameters

currentLine Avalonia.Controls.Documents.Primitives.ITextLine

The current line.

Returns

Avalonia.Controls.Documents.Primitives.ITextLine

The next line, or null if at the last line.

GetPositionAtLineEnd Method

Gets the position at the end of the line containing the specified position.

public Avalonia.Controls.Documents.TextModel.TextPointer GetPositionAtLineEnd(Avalonia.Controls.Documents.TextModel.TextPointer position)

Parameters

position Avalonia.Controls.Documents.TextModel.TextPointer

The text position.

Returns

Avalonia.Controls.Documents.TextModel.TextPointer

The position at line end, or null if the position is not visible.

GetPositionAtLineStart Method

Gets the position at the start of the line containing the specified position.

public Avalonia.Controls.Documents.TextModel.TextPointer GetPositionAtLineStart(Avalonia.Controls.Documents.TextModel.TextPointer position)

Parameters

position Avalonia.Controls.Documents.TextModel.TextPointer

The text position.

Returns

Avalonia.Controls.Documents.TextModel.TextPointer

The position at line start, or null if the position is not visible.

GetPositionAtLineX Method

Returns the text position on line closest to the specified X coordinate. The result is guaranteed to stay on line; it never crosses into a neighbouring line or block, regardless of how far x lies outside the line's horizontal bounds.

public Avalonia.Controls.Documents.TextModel.TextPointer GetPositionAtLineX(Avalonia.Controls.Documents.Primitives.ITextLine line, double x)

Parameters

line Avalonia.Controls.Documents.Primitives.ITextLine

The target line.

x double

The desired X coordinate in view space.

Returns

Avalonia.Controls.Documents.TextModel.TextPointer

A node-aware pointer on line, or null when the line or its containing element cannot be resolved.

Remarks

This is the structure-first primitive used by vertical caret navigation. It avoids the offset collisions that affect empty paragraphs and prevents the hit test from leaking into adjacent blocks when x is near a block boundary.

GetPreviousLine Method

Gets the previous line before the specified line.

public Avalonia.Controls.Documents.Primitives.ITextLine GetPreviousLine(Avalonia.Controls.Documents.Primitives.ITextLine currentLine)

Parameters

currentLine Avalonia.Controls.Documents.Primitives.ITextLine

The current line.

Returns

Avalonia.Controls.Documents.Primitives.ITextLine

The previous line, or null if at the first line.

GetRectangleFromTextPosition Method

Gets the bounding rectangle for a character at the specified position.

public Avalonia.Rect GetRectangleFromTextPosition(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 for caret placement at element boundaries.

Returns

Avalonia.Rect

The bounding rectangle, or a default rect if the position is not visible or layout is invalid.

Remarks

Check Avalonia.Controls.Documents.Primitives.ITextView.IsLayoutValid before calling this method for accurate results.

GetTextPositionFromPoint Method

Gets the text position from a screen point.

public Avalonia.Controls.Documents.TextModel.TextPointer GetTextPositionFromPoint(Avalonia.Point point, bool snapToText)

Parameters

point Avalonia.Point

The point in view coordinates.

snapToText bool

If true, snaps to the nearest text position even if the point is outside text bounds.

Returns

Avalonia.Controls.Documents.TextModel.TextPointer

The text position, or null if no position could be determined.

GetVisibleLineAtOrAfter Method

Gets the first visible line at or after the specified position.

public Avalonia.Controls.Documents.Primitives.ITextLine GetVisibleLineAtOrAfter(Avalonia.Controls.Documents.TextModel.TextPointer position)

Parameters

position Avalonia.Controls.Documents.TextModel.TextPointer

The text position to search from.

Returns

Avalonia.Controls.Documents.Primitives.ITextLine

The first visible line at or after the position, or null if no visible line exists at or beyond position.

Remarks

In a virtualizing view, Avalonia.Controls.Documents.Primitives.ITextView.GetLineFromPosition(Avalonia.Controls.Documents.TextModel.TextPointer) returns null when the target block is not realized. This method skips over unrealized blocks and returns the first line that the view can resolve. Non-virtualizing implementations may simply delegate to Avalonia.Controls.Documents.Primitives.ITextView.GetLineFromPosition(Avalonia.Controls.Documents.TextModel.TextPointer).

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.
Background	Gets or sets the brush used to draw the control's background. Inherited from TemplatedControl.
BackgroundSizing	Gets or sets how the control's background is drawn relative to the control's border. Inherited from TemplatedControl.
BorderBrush	Gets or sets the brush used to draw the control's border. Inherited from TemplatedControl.
BorderThickness	Gets or sets the thickness of the control's border. Inherited from TemplatedControl.
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.
ContextFlyout	Gets or sets a context flyout to the control Inherited from Control.
ContextMenu	Gets or sets a context menu to the control. Inherited from Control.
CornerRadius	Gets or sets the radius of the border rounded corners. Inherited from TemplatedControl.
Cursor	Gets or sets associated mouse cursor. Inherited from InputElement.
DataContext	Gets or sets the control's data context. Inherited from StyledElement.
DataTemplates	Gets or sets the data templates for the control. Inherited from Control.
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.
Document	Gets or sets the document to display, or when the view has none. A view with no document renders empty and reports an empty extent.
Effect	Gets or sets the effect of the control. Inherited from Visual.
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.
FocusAdorner	Gets or sets the control's focus adorner. Inherited from Control.
FontFamily	Gets or sets the font family used to draw the control's text. Inherited from TemplatedControl.
FontFeatures	Gets or sets the font features turned on/off. Inherited from TemplatedControl.
FontSize	Gets or sets the size of the control's text in points. Inherited from TemplatedControl.
FontStretch	Gets or sets the font stretch used to draw the control's text. Inherited from TemplatedControl.
FontStyle	Gets or sets the font style used to draw the control's text. Inherited from TemplatedControl.
FontWeight	Gets or sets the font weight used to draw the control's text. Inherited from TemplatedControl.
Foreground	Gets or sets the brush used to draw the control's text and other foreground elements. Inherited from TemplatedControl.
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.
IsLoaded	Gets a value indicating whether the control is fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
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.
LetterSpacing	Gets or sets the letter spacing for the control's text content. Inherited from TemplatedControl.
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 or sets the padding placed between the border of the control and its content. Inherited from TemplatedControl.
PageBoundsBrush	Gets or sets the brush used to render page boundary indicators. Defaults to a faint gray when null.
PageBreakMarkerBrush	Gets or sets the brush of the dashed marker drawn across the top edge of a block with Avalonia.Controls.Documents.Block.BreakPageBefore, Word draft-view style. Paint only - the rule never affects layout. Whether markers show at all is Avalonia.Controls.Documents.Primitives.TextViewBase.ShowPageBreakMarkers; a null brush falls back to the theme's.
PagePadding	Gets the document-level page padding, synchronised from the current Avalonia.Controls.Documents.FlowDocument.PagePadding.
Parent	Gets the styled element's logical parent. Inherited from StyledElement.
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.
RequestedThemeVariant	Gets or sets the UI theme variant used by this text view and all document content rendered inside it. Setting this to Avalonia.Styling.ThemeVariant.Light prevents dark-theme resources from affecting the document rendering while the surrounding chrome (scrollbars, toolbar) continues to follow the application theme.
Resources	Gets or sets the styled element's resource dictionary. Inherited from StyledElement.
ShowPageBandsInContinuousLayout	Gets or sets whether the continuous flow shows the document's running header above the first block and its running footer below the last, as nested-document containers of this view (the same nodes the sheets show in page layout, realized while their edge of the flow is on screen). First-page and even-page bands and a section's own bands are page concepts and show in page layout only; a page-number field shows its cached result here. A paged view shows the bands on its sheets regardless of this property.
ShowPageBounds	Gets or sets whether page boundary indicators are rendered. Draws a subtle page border when Avalonia.Controls.Documents.FlowDocument.PageWidth is fixed and dotted lines at each page padding boundary edge.
ShowPageBreakMarkers	Gets or sets whether the view reserves the marker band below lines ending with an explicit page break and draws the dashed rule across it. True in the continuous flow, where the break is otherwise invisible; a paged view defaults it to false, because a break manifests as a real page transition there and its paragraph geometry must match the export paginators.
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.
Tag	Gets or sets a user-defined object attached to the control. Inherited from Control.
Template	Gets or sets the template that defines the control's appearance. Inherited from TemplatedControl.
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.
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.

Document Property

Gets or sets the document to display, or when the view has none. A view with no document renders empty and reports an empty extent.

public Avalonia.Controls.Documents.FlowDocument Document { get; set; }

PageBoundsBrush Property

Gets or sets the brush used to render page boundary indicators. Defaults to a faint gray when null.

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

PageBreakMarkerBrush Property

Gets or sets the brush of the dashed marker drawn across the top edge of a block with Avalonia.Controls.Documents.Block.BreakPageBefore, Word draft-view style. Paint only - the rule never affects layout. Whether markers show at all is Avalonia.Controls.Documents.Primitives.TextViewBase.ShowPageBreakMarkers; a null brush falls back to the theme's.

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

PagePadding Property

Gets the document-level page padding, synchronised from the current Avalonia.Controls.Documents.FlowDocument.PagePadding.

public Avalonia.Thickness PagePadding { get; set; }

RequestedThemeVariant Property

Gets or sets the UI theme variant used by this text view and all document content rendered inside it. Setting this to Avalonia.Styling.ThemeVariant.Light prevents dark-theme resources from affecting the document rendering while the surrounding chrome (scrollbars, toolbar) continues to follow the application theme.

public Avalonia.Styling.ThemeVariant RequestedThemeVariant { get; set; }

ShowPageBandsInContinuousLayout Property

Gets or sets whether the continuous flow shows the document's running header above the first block and its running footer below the last, as nested-document containers of this view (the same nodes the sheets show in page layout, realized while their edge of the flow is on screen). First-page and even-page bands and a section's own bands are page concepts and show in page layout only; a page-number field shows its cached result here. A paged view shows the bands on its sheets regardless of this property.

public bool ShowPageBandsInContinuousLayout { get; set; }

ShowPageBounds Property

Gets or sets whether page boundary indicators are rendered. Draws a subtle page border when Avalonia.Controls.Documents.FlowDocument.PageWidth is fixed and dotted lines at each page padding boundary edge.

public bool ShowPageBounds { get; set; }

ShowPageBreakMarkers Property

Gets or sets whether the view reserves the marker band below lines ending with an explicit page break and draws the dashed rule across it. True in the continuous flow, where the break is otherwise invisible; a paged view defaults it to false, because a break manifests as a real page transition there and its paragraph geometry must match the export paginators.

public bool ShowPageBreakMarkers { get; set; }

Fields

Name	Description
BackgroundProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.Background property. Inherited from TemplatedControl.
BackgroundSizingProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.BackgroundSizing property. Inherited from TemplatedControl.
BorderBrushProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.BorderBrush property. Inherited from TemplatedControl.
BorderThicknessProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.BorderThickness property. Inherited from TemplatedControl.
BoundsProperty	Defines the Avalonia.Visual.Bounds property. Inherited from Visual.
CacheModeProperty	Defines the Avalonia.Visual.CacheMode property. Inherited from Visual.
ClipProperty	Defines the Avalonia.Visual.Clip property. Inherited from Visual.
ClipToBoundsProperty	Defines the Avalonia.Visual.ClipToBounds property. Inherited from Visual.
ContextCanceledEvent	Provides event data for the Avalonia.Input.InputElement.ContextCanceled event. Inherited from InputElement.
ContextFlyoutProperty	Defines the Avalonia.Controls.Control.ContextFlyout property Inherited from Control.
ContextMenuProperty	Defines the Avalonia.Controls.Control.ContextMenu property. Inherited from Control.
ContextRequestedEvent	Provides event data for the Avalonia.Input.InputElement.ContextRequested event. Inherited from InputElement.
CornerRadiusProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.CornerRadius property. Inherited from TemplatedControl.
CursorProperty	Gets or sets associated mouse cursor. Inherited from InputElement.
DataContextProperty	Defines the Avalonia.StyledElement.DataContext property. Inherited from StyledElement.
DesiredSizeProperty	Defines the Avalonia.Layout.Layoutable.DesiredSize property. Inherited from Layoutable.
DocumentProperty	Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.Document property.
DoubleTappedEvent	Defines the Avalonia.Input.InputElement.DoubleTapped event. Inherited from InputElement.
EffectProperty	Defines the Avalonia.Visual.Effect property. Inherited from Visual.
FlowDirectionProperty	Defines the Avalonia.Visual.FlowDirection property. Inherited from Visual.
FocusableProperty	Defines the Avalonia.Input.InputElement.Focusable property. Inherited from InputElement.
FocusAdornerProperty	Defines the Avalonia.Controls.Control.FocusAdorner property. Inherited from Control.
FontFamilyProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontFamily property. Inherited from TemplatedControl.
FontFeaturesProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontFeaturesProperty property. Inherited from TemplatedControl.
FontSizeProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontSize property. Inherited from TemplatedControl.
FontStretchProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
FontStyleProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontStyle property. Inherited from TemplatedControl.
FontWeightProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.FontWeight property. Inherited from TemplatedControl.
ForegroundProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.Foreground property. Inherited from TemplatedControl.
GettingFocusEvent	Defines the Avalonia.Input.InputElement.GettingFocus event. Inherited from InputElement.
GotFocusEvent	Defines the Avalonia.Input.InputElement.GotFocus event. Inherited from InputElement.
HasMirrorTransformProperty	Defines the Avalonia.Visual.HasMirrorTransform property. Inherited from Visual.
HeightProperty	Defines the Avalonia.Layout.Layoutable.Height property. Inherited from Layoutable.
HoldingEvent	Defines the Avalonia.Input.InputElement.Holding event. Inherited from InputElement.
HorizontalAlignmentProperty	Defines the Avalonia.Layout.Layoutable.HorizontalAlignment property. Inherited from Layoutable.
IsEffectivelyEnabledProperty	Defines the Avalonia.Input.InputElement.IsEffectivelyEnabled property. Inherited from InputElement.
IsEnabledProperty	Defines the Avalonia.Input.InputElement.IsEnabled property. Inherited from InputElement.
IsFocusedProperty	Defines the Avalonia.Input.InputElement.IsFocused property. Inherited from InputElement.
IsHitTestVisibleProperty	Defines the Avalonia.Input.InputElement.IsHitTestVisible property. Inherited from InputElement.
IsHoldingEnabledProperty	Defines the IsHoldingEnabled attached property. Inherited from InputElement.
IsHoldWithMouseEnabledProperty	Defines the IsHoldWithMouseEnabled attached property. Inherited from InputElement.
IsKeyboardFocusWithinProperty	Defines the Avalonia.Input.InputElement.IsKeyboardFocusWithin property. Inherited from InputElement.
IsPointerOverProperty	Defines the Avalonia.Input.InputElement.IsPointerOver property. Inherited from InputElement.
IsTabStopProperty	Defines the Avalonia.Input.InputElement.IsTabStop property. Inherited from InputElement.
IsTemplateFocusTargetProperty	Defines the IsTemplateFocusTarget attached property. Inherited from TemplatedControl.
IsVisibleProperty	Defines the Avalonia.Visual.IsVisible property. Inherited from Visual.
KeyDownEvent	Defines the Avalonia.Input.InputElement.KeyDown event. Inherited from InputElement.
KeyUpEvent	Defines the Avalonia.Input.InputElement.KeyUp event. Inherited from InputElement.
LetterSpacingProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.LetterSpacing property. Inherited from TemplatedControl.
LoadedEvent	Defines the Avalonia.Controls.Control.Loaded event. Inherited from Control.
LosingFocusEvent	Defines the Avalonia.Input.InputElement.LosingFocus event. Inherited from InputElement.
LostFocusEvent	Defines the Avalonia.Input.InputElement.LostFocus event. Inherited from InputElement.
MarginProperty	Defines the Avalonia.Layout.Layoutable.Margin property. Inherited from Layoutable.
MaxHeightProperty	Defines the Avalonia.Layout.Layoutable.MaxHeight property. Inherited from Layoutable.
MaxWidthProperty	Defines the Avalonia.Layout.Layoutable.MaxWidth property. Inherited from Layoutable.
MinHeightProperty	Defines the Avalonia.Layout.Layoutable.MinHeight property. Inherited from Layoutable.
MinWidthProperty	Defines the Avalonia.Layout.Layoutable.MinWidth property. Inherited from Layoutable.
NameProperty	Defines the Avalonia.StyledElement.Name property. Inherited from StyledElement.
OpacityMaskProperty	Defines the Avalonia.Visual.OpacityMask property. Inherited from Visual.
OpacityProperty	Defines the Avalonia.Visual.Opacity property. Inherited from Visual.
PaddingProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.Padding property. Inherited from TemplatedControl.
PageBoundsBrushProperty	Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.PageBoundsBrush property.
PageBreakMarkerBrushProperty	Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.PageBreakMarkerBrush property.
PagePaddingProperty	Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.PagePadding property.
ParentProperty	Defines the Avalonia.StyledElement.Parent property. Inherited from StyledElement.
PinchEndedEvent	Defines the Avalonia.Input.InputElement.PinchEnded event. Inherited from InputElement.
PinchEvent	Defines the Avalonia.Input.InputElement.Pinch event. Inherited from InputElement.
PointerCaptureLostEvent	Defines the Avalonia.Input.InputElement.PointerCaptureLost routed event. Inherited from InputElement.
PointerEnteredEvent	Defines the Avalonia.Input.InputElement.PointerEntered event. Inherited from InputElement.
PointerExitedEvent	Defines the Avalonia.Input.InputElement.PointerExited event. Inherited from InputElement.
PointerMovedEvent	Defines the Avalonia.Input.InputElement.PointerMoved event. Inherited from InputElement.
PointerPressedEvent	Defines the Avalonia.Input.InputElement.PointerPressed event. Inherited from InputElement.
PointerReleasedEvent	Defines the Avalonia.Input.InputElement.PointerReleased event. Inherited from InputElement.
PointerTouchPadGestureMagnifyEvent	Defines the Avalonia.Input.InputElement.PointerTouchPadGestureMagnify event. Inherited from InputElement.
PointerTouchPadGestureRotateEvent	Defines the Avalonia.Input.InputElement.PointerTouchPadGestureRotate event. Inherited from InputElement.
PointerTouchPadGestureSwipeEvent	Defines the Avalonia.Input.InputElement.PointerTouchPadGestureSwipe event. Inherited from InputElement.
PointerWheelChangedEvent	Defines the Avalonia.Input.InputElement.PointerWheelChanged event. Inherited from InputElement.
PullGestureEndedEvent	Defines the Avalonia.Input.InputElement.PullGestureEnded event. Inherited from InputElement.
PullGestureEvent	Defines the Avalonia.Input.InputElement.PullGesture event. Inherited from InputElement.
RenderTransformOriginProperty	Defines the Avalonia.Visual.RenderTransformOrigin property. Inherited from Visual.
RenderTransformProperty	Defines the Avalonia.Visual.RenderTransform property. Inherited from Visual.
RequestBringIntoViewEvent	Event raised when an element wishes to be scrolled into view. Inherited from Control.
RequestedThemeVariantProperty	Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.RequestedThemeVariant property. When set to a non-default value the text view acts as a theme boundary, isolating document content from the application theme so that dark-theme resources do not leak into text rendering.
RightTappedEvent	Defines the Avalonia.Input.InputElement.RightTapped event. Inherited from InputElement.
ScrollGestureEndedEvent	Defines the Avalonia.Input.InputElement.ScrollGestureEnded event. Inherited from InputElement.
ScrollGestureEvent	Defines the Avalonia.Input.InputElement.ScrollGesture event. Inherited from InputElement.
ScrollGestureInertiaStartingEvent	Defines the Avalonia.Input.InputElement.ScrollGestureInertiaStarting event. Inherited from InputElement.
ShowPageBandsInContinuousLayoutProperty	Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.ShowPageBandsInContinuousLayout property.
ShowPageBoundsProperty	Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.ShowPageBounds property. When true, subtle visual indicators are drawn for the page content area.
ShowPageBreakMarkersProperty	Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.ShowPageBreakMarkers property.
SizeChangedEvent	Defines the Avalonia.Controls.Control.SizeChanged event. Inherited from Control.
SwipeGestureEndedEvent	Defines the Avalonia.Input.InputElement.SwipeGestureEnded event. Inherited from InputElement.
SwipeGestureEvent	Defines the Avalonia.Input.InputElement.SwipeGesture event. Inherited from InputElement.
TabIndexProperty	Defines the Avalonia.Input.InputElement.TabIndex property. Inherited from InputElement.
TagProperty	Defines the Avalonia.Controls.Control.Tag property. Inherited from Control.
TappedEvent	Defines the Avalonia.Input.InputElement.Tapped event. Inherited from InputElement.
TemplateAppliedEvent	Defines the Avalonia.Controls.Primitives.TemplatedControl.TemplateApplied routed event. Inherited from TemplatedControl.
TemplatedParentProperty	Defines the Avalonia.StyledElement.TemplatedParent property. Inherited from StyledElement.
TemplateProperty	Defines the Avalonia.Controls.Primitives.TemplatedControl.Template property. Inherited from TemplatedControl.
TextInputEvent	Defines the Avalonia.Input.InputElement.TextInput event. Inherited from InputElement.
TextInputMethodClientRequestedEvent	Defines the Avalonia.Input.InputElement.TextInputMethodClientRequested event. Inherited from InputElement.
ThemeProperty	Defines the Avalonia.StyledElement.Theme property. Inherited from StyledElement.
TransitionsProperty	Defines the Avalonia.Animation.Animatable.Transitions property. Inherited from Animatable.
UnloadedEvent	Defines the Avalonia.Controls.Control.Unloaded event. Inherited from Control.
UseLayoutRoundingProperty	Defines the Avalonia.Layout.Layoutable.UseLayoutRounding property. Inherited from Layoutable.
VerticalAlignmentProperty	Defines the Avalonia.Layout.Layoutable.VerticalAlignment property. Inherited from Layoutable.
VisualParentProperty	Defines the Avalonia.Visual.VisualParent property. Inherited from Visual.
WidthProperty	Defines the Avalonia.Layout.Layoutable.Width property. Inherited from Layoutable.
ZIndexProperty	Defines the Avalonia.Visual.ZIndex property. Inherited from Visual.

DocumentProperty Field

Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.Document property.

public Avalonia.StyledProperty<Avalonia.Controls.Documents.FlowDocument> DocumentProperty

PageBoundsBrushProperty Field

Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.PageBoundsBrush property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> PageBoundsBrushProperty

PageBreakMarkerBrushProperty Field

Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.PageBreakMarkerBrush property.

public Avalonia.StyledProperty<Avalonia.Media.IBrush> PageBreakMarkerBrushProperty

PagePaddingProperty Field

Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.PagePadding property.

public Avalonia.StyledProperty<Avalonia.Thickness> PagePaddingProperty

RequestedThemeVariantProperty Field

Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.RequestedThemeVariant property. When set to a non-default value the text view acts as a theme boundary, isolating document content from the application theme so that dark-theme resources do not leak into text rendering.

public Avalonia.StyledProperty<Avalonia.Styling.ThemeVariant> RequestedThemeVariantProperty

ShowPageBandsInContinuousLayoutProperty Field

Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.ShowPageBandsInContinuousLayout property.

public Avalonia.StyledProperty<bool> ShowPageBandsInContinuousLayoutProperty

ShowPageBoundsProperty Field

Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.ShowPageBounds property. When true, subtle visual indicators are drawn for the page content area.

public Avalonia.StyledProperty<bool> ShowPageBoundsProperty

ShowPageBreakMarkersProperty Field

Defines the Avalonia.Controls.Documents.Primitives.TextViewBase.ShowPageBreakMarkers property.

public Avalonia.StyledProperty<bool> ShowPageBreakMarkersProperty

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.
Loaded	Occurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control.
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.
SizeChanged	Occurs when the bounds (actual size) of the control have changed. Inherited from Control.
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.
TemplateApplied	Raised when the control's template is applied. Inherited from TemplatedControl.
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.
Unloaded	Occurs when the control is removed from the visual tree. Inherited from Control.