FlowDocumentScrollViewer Class

Definition

Namespace:Avalonia.Controls

Assembly:Avalonia.Controls.Documents

Package:Avalonia.Controls.Documents

A read-only viewer that displays a Avalonia.Controls.Documents.FlowDocument inside a built-in Avalonia.Controls.ScrollViewer. Provides text selection and copy-to-clipboard support; no editing capabilities are exposed.

public class FlowDocumentScrollViewer

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

Derived types:FlowDocumentPageViewer

Implements: IInteractiveTextHost, ITextViewHost

Remarks

The architecture mirrors RichTextEditor and Markdown: a Avalonia.Controls.ScrollViewer wraps the inner Avalonia.Controls.Documents.Primitives.InteractiveTextView which implements Avalonia.Controls.Primitives.ILogicalScrollable for virtualized scrolling.

Selection is driven by Avalonia.Controls.Documents.Primitives.Components.TextViewMouse and Avalonia.Controls.Documents.Primitives.Components.TextViewKeyboard components; selection rendering is provided by a Avalonia.Controls.Documents.Primitives.Highlighting.SelectionHighlightLayer registered on the inner Avalonia.Controls.Documents.Primitives.Adorners.BlockAdornerLayer.

The document's page bands and footnotes are documents of their own, shown by the same view. One selection at a time covers one of them: a press into a note or a band moves the selection there (Avalonia.Controls.FlowDocumentScrollViewer.ActiveDocument), Escape or a press into the body brings it back, and each document keeps its own selection while it belongs to the body.

Constructors

Name	Description
FlowDocumentScrollViewer	Initializes a new instance of the Avalonia.Controls.FlowDocumentScrollViewer class.

FlowDocumentScrollViewer Constructor

Initializes a new instance of the Avalonia.Controls.FlowDocumentScrollViewer class.

public FlowDocumentScrollViewer()

Methods

Name	Description
ActivateDocument	Makes document the document the selection covers: one of the body's page bands or footnotes, or the body itself when null. A nested document's selection is created the first time it is entered and kept while the document belongs to the body; the body's selection stays where it was. The caret moves to position when one is given. Returns false while selection is disabled, and for a document that is neither the body nor nested in it.
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.
ClearSelection	Clears the current selection.
ClearValue (4 overloads)	Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject.
CoerceValue	Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
Copy	Copies the current selection to the clipboard without waiting for the clipboard write.
CopyAsync	Copies the current selection to the clipboard as plain text. The returned task completes once the clipboard write has, and faults with whatever the platform clipboard threw.
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.
GetComponent	No summary available.
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.
GetValue (3 overloads)	Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
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.
RegisterComponent	Registers a component with this host.
RemoveHandler (2 overloads)	Removes a handler for the specified routed event. Inherited from Interactive.
Render	Renders the visual to a Avalonia.Media.DrawingContext. Inherited from Visual.
SelectAll	Selects the entire document.
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.
UnregisterComponent	Unregisters a component from this host.
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.

ActivateDocument Method

Makes document the document the selection covers: one of the body's page bands or footnotes, or the body itself when null. A nested document's selection is created the first time it is entered and kept while the document belongs to the body; the body's selection stays where it was. The caret moves to position when one is given. Returns false while selection is disabled, and for a document that is neither the body nor nested in it.

public bool ActivateDocument(Avalonia.Controls.Documents.FlowDocument document, Avalonia.Controls.Documents.TextModel.TextPointer position)

Parameters

document Avalonia.Controls.Documents.FlowDocument

position Avalonia.Controls.Documents.TextModel.TextPointer

Returns

bool

ClearSelection Method

Clears the current selection.

public void ClearSelection()

Copy Method

Copies the current selection to the clipboard without waiting for the clipboard write.

public void Copy()

Remarks

Await Avalonia.Controls.FlowDocumentScrollViewer.CopyAsync(System.Threading.CancellationToken) instead. The clipboard is a platform resource another process can hold, so the write can fail after this method has already returned, and a caller here can neither see that nor sequence anything after it.

CopyAsync Method

Copies the current selection to the clipboard as plain text. The returned task completes once the clipboard write has, and faults with whatever the platform clipboard threw.

public System.Threading.Tasks.Task CopyAsync(System.Threading.CancellationToken cancellationToken)

Parameters

cancellationToken System.Threading.CancellationToken

Abandons the copy before the clipboard is written.

Returns

System.Threading.Tasks.Task

GetComponent Method

public T GetComponent<T>()

Type Parameters

T

Returns

T

RegisterComponent Method

Registers a component with this host.

public void RegisterComponent(Avalonia.Controls.Documents.Primitives.Components.ITextViewComponent component)

Parameters

component Avalonia.Controls.Documents.Primitives.Components.ITextViewComponent

The component to register.

Remarks

If the host is already in the attached state, the component receives an immediate Avalonia.Controls.Documents.Primitives.Components.ITextViewComponent.OnAttach(Avalonia.Controls.Documents.Primitives.IInteractiveTextHost) callback.

SelectAll Method

Selects the entire document.

public void SelectAll()

UnregisterComponent Method

Unregisters a component from this host.

public void UnregisterComponent(Avalonia.Controls.Documents.Primitives.Components.ITextViewComponent component)

Parameters

component Avalonia.Controls.Documents.Primitives.Components.ITextViewComponent

The component to unregister.

Remarks

If the component is currently attached, it receives an Avalonia.Controls.Documents.Primitives.Components.ITextViewComponent.OnDetach callback before removal.

Properties

Name	Description
ActiveDocument	Gets the nested document the selection is in: the page band or the footnote whose text the selection covers, or null while the selection is in the body.
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.
CanCopy	Gets a value indicating whether the current selection can be copied to the clipboard.
CaretBrush	Gets or sets the brush used to paint the caret.
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 viewer has none. A viewer with no document shows nothing and has no selection.
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.
IsCaretVisible	Gets or sets whether a blinking caret is shown while the viewer is focused. Defaults to false: a read-only viewer displays no insertion point, matching the WPF viewer.
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.
IsSelectionEnabled	Gets or sets whether the viewer supports text selection. When disabled, the inner text view is not focusable, so a viewer inside an items-control template leaves focus with its list, and the selection, caret, copy and context-menu interactions are turned off. Defaults to true.
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 the background of the page bounds area.
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.
Resources	Gets or sets the styled element's resource dictionary. Inherited from StyledElement.
Selection	Gets the current text selection, or null if no document is attached or the template has not been applied yet.
SelectionBrush	Gets or sets the brush used to render the selection highlight.
ShowPageBandsInContinuousLayout	Gets or sets whether the flow shows the document's running header above the first block and its running footer below the last. 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.
ShowPageBounds	Gets or sets whether page boundary indicators are rendered.
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.
TextDocument	Gets the text document the selection covers: a page band's or a footnote's while the selection is in one, the body's otherwise.
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.
UIScope	Gets the element components handle input on: the inner text view, or null before the template is applied.
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.

ActiveDocument Property

Gets the nested document the selection is in: the page band or the footnote whose text the selection covers, or null while the selection is in the body.

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

CanCopy Property

Gets a value indicating whether the current selection can be copied to the clipboard.

public bool CanCopy { get; set; }

CaretBrush Property

Gets or sets the brush used to paint the caret.

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

Document Property

Gets or sets the document to display, or when the viewer has none. A viewer with no document shows nothing and has no selection.

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

IsCaretVisible Property

Gets or sets whether a blinking caret is shown while the viewer is focused. Defaults to false: a read-only viewer displays no insertion point, matching the WPF viewer.

public bool IsCaretVisible { get; set; }

IsSelectionEnabled Property

Gets or sets whether the viewer supports text selection. When disabled, the inner text view is not focusable, so a viewer inside an items-control template leaves focus with its list, and the selection, caret, copy and context-menu interactions are turned off. Defaults to true.

public bool IsSelectionEnabled { get; set; }

PageBoundsBrush Property

Gets or sets the brush used to render the background of the page bounds area.

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

Remarks

Set this property to customize the appearance of the page bounds, such as changing the background color or applying a pattern. If set to null, the default brush will be used.

Selection Property

Gets the current text selection, or null if no document is attached or the template has not been applied yet.

public Avalonia.Controls.TextSelection Selection { get; set; }

SelectionBrush Property

Gets or sets the brush used to render the selection highlight.

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

ShowPageBandsInContinuousLayout Property

Gets or sets whether the flow shows the document's running header above the first block and its running footer below the last. 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.

public bool ShowPageBandsInContinuousLayout { get; set; }

ShowPageBounds Property

Gets or sets whether page boundary indicators are rendered.

public bool ShowPageBounds { get; set; }

TextDocument Property

Gets the text document the selection covers: a page band's or a footnote's while the selection is in one, the body's otherwise.

public Avalonia.Controls.Documents.TextModel.TextDocument TextDocument { get; set; }

UIScope Property

Gets the element components handle input on: the inner text view, or null before the template is applied.

public Avalonia.Input.InputElement UIScope { 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.
CanCopyProperty	Defines the Avalonia.Controls.FlowDocumentScrollViewer.CanCopy property.
CaretBrushProperty	Defines the Avalonia.Controls.FlowDocumentScrollViewer.CaretBrush property.
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.
CopyingToClipboardEvent	Defines the Avalonia.Controls.FlowDocumentScrollViewer.CopyingToClipboard event.
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.FlowDocumentScrollViewer.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.
IsCaretVisibleProperty	Defines the Avalonia.Controls.FlowDocumentScrollViewer.IsCaretVisible property.
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.
IsSelectionEnabledProperty	Defines the Avalonia.Controls.FlowDocumentScrollViewer.IsSelectionEnabled property.
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.FlowDocumentScrollViewer.PageBoundsBrush 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.
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.
SelectionBrushProperty	Defines the Avalonia.Controls.FlowDocumentScrollViewer.SelectionBrush property.
ShowPageBandsInContinuousLayoutProperty	Defines the Avalonia.Controls.FlowDocumentScrollViewer.ShowPageBandsInContinuousLayout property.
ShowPageBoundsProperty	Defines the Avalonia.Controls.FlowDocumentScrollViewer.ShowPageBounds 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.

CanCopyProperty Field

Defines the Avalonia.Controls.FlowDocumentScrollViewer.CanCopy property.

public Avalonia.DirectProperty<Avalonia.Controls.FlowDocumentScrollViewer, bool> CanCopyProperty

CaretBrushProperty Field

Defines the Avalonia.Controls.FlowDocumentScrollViewer.CaretBrush property.

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

CopyingToClipboardEvent Field

Defines the Avalonia.Controls.FlowDocumentScrollViewer.CopyingToClipboard event.

public Avalonia.Interactivity.RoutedEvent<Avalonia.Interactivity.RoutedEventArgs> CopyingToClipboardEvent

DocumentProperty Field

Defines the Avalonia.Controls.FlowDocumentScrollViewer.Document property.

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

IsCaretVisibleProperty Field

Defines the Avalonia.Controls.FlowDocumentScrollViewer.IsCaretVisible property.

public Avalonia.StyledProperty<bool> IsCaretVisibleProperty

IsSelectionEnabledProperty Field

Defines the Avalonia.Controls.FlowDocumentScrollViewer.IsSelectionEnabled property.

public Avalonia.StyledProperty<bool> IsSelectionEnabledProperty

PageBoundsBrushProperty Field

Defines the Avalonia.Controls.FlowDocumentScrollViewer.PageBoundsBrush property.

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

SelectionBrushProperty Field

Defines the Avalonia.Controls.FlowDocumentScrollViewer.SelectionBrush property.

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

ShowPageBandsInContinuousLayoutProperty Field

Defines the Avalonia.Controls.FlowDocumentScrollViewer.ShowPageBandsInContinuousLayout property.

public Avalonia.StyledProperty<bool> ShowPageBandsInContinuousLayoutProperty

ShowPageBoundsProperty Field

Defines the Avalonia.Controls.FlowDocumentScrollViewer.ShowPageBounds property.

public Avalonia.StyledProperty<bool> ShowPageBoundsProperty

Events

Name	Description
ActiveDocumentChanged	Occurs when Avalonia.Controls.FlowDocumentScrollViewer.ActiveDocument changes: the selection entered a page band or a footnote, or returned to the body.
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.
ContentChanged	Raised when the content of the document the viewer shows changes.
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.
CopyingToClipboard	Raised when the selection is being copied to the clipboard. Set Avalonia.Interactivity.RoutedEventArgs.Handled to suppress the default copy.
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.
DocumentChanged	Raised when Avalonia.Controls.FlowDocumentScrollViewer.Document is replaced.
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.
SelectionChanged	Raised when the selection changes.
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.

ActiveDocumentChanged Event

Occurs when Avalonia.Controls.FlowDocumentScrollViewer.ActiveDocument changes: the selection entered a page band or a footnote, or returned to the body.

public event EventHandler ActiveDocumentChanged

ContentChanged Event

Raised when the content of the document the viewer shows changes.

public event EventHandler ContentChanged

CopyingToClipboard Event

Raised when the selection is being copied to the clipboard. Set Avalonia.Interactivity.RoutedEventArgs.Handled to suppress the default copy.

public event EventHandler<Avalonia.Interactivity.RoutedEventArgs> CopyingToClipboard

DocumentChanged Event

Raised when Avalonia.Controls.FlowDocumentScrollViewer.Document is replaced.

public event EventHandler DocumentChanged

SelectionChanged Event

Raised when the selection changes.

public event EventHandler SelectionChanged