FlowDocumentPageViewer Class
Definition
A read-only viewer that displays a Avalonia.Controls.Documents.FlowDocument as discrete pages (Word's print layout), scrolled as a continuous vertical stack of sheets. Inherits the selection and copy behavior of Avalonia.Controls.FlowDocumentScrollViewer; the template hosts a Avalonia.Controls.Documents.Primitives.PagedTextView instead of the continuous view.
public class FlowDocumentPageViewer
Remarks
Avalonia.Controls.FlowDocumentPageViewer.PageCount is progressive: pagination runs at idle priority and the
count grows until Avalonia.Controls.FlowDocumentPageViewer.IsPaginationComplete. Bind a pager
control (e.g. PipsPager) to Avalonia.Controls.FlowDocumentPageViewer.PageCount and
Avalonia.Controls.FlowDocumentPageViewer.CurrentPageNumber for page navigation UI.
Constructors
| Name | Description |
|---|---|
| FlowDocumentPageViewer | No summary available. |
FlowDocumentPageViewer Constructor
public FlowDocumentPageViewer()
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. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| EndInit | Inherited from StyledElement. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| FirstPage | Scrolls to the first page. |
| Focus | Focuses the control. Inherited from InputElement. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetComponent | Inherited from FlowDocumentScrollViewer. |
| 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. |
| GoToPage | Scrolls the given 1-based page to the top of the viewport. |
| 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. |
| LastPage | Scrolls to the last paginated page. |
| Measure | Carries out a measure of the control. Inherited from Layoutable. |
| NextPage | Scrolls to the next page. |
| PreviousPage | Scrolls to the previous page. |
| RaiseEvent | Raises a routed event. Inherited from Interactive. |
| RegisterComponent | Registers a component with this host. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| 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. |
FirstPage Method
Scrolls to the first page.
public void FirstPage()
GoToPage Method
Scrolls the given 1-based page to the top of the viewport.
public void GoToPage(int pageNumber)
Parameters
pageNumber int
LastPage Method
Scrolls to the last paginated page.
public void LastPage()
NextPage Method
Scrolls to the next page.
public void NextPage()
PreviousPage Method
Scrolls to the previous page.
public void PreviousPage()
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. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| CaretBrush | Gets or sets the brush used to paint the caret. Inherited from FlowDocumentScrollViewer. |
| 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. |
| CurrentPageNumber | Gets the 1-based page number at the viewport center. |
| 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. Inherited from FlowDocumentScrollViewer. |
| Effect | Gets or sets the effect of the control. Inherited from Visual. |
| EffectiveZoom | Gets the zoom factor currently in effect: Avalonia.Controls.FlowDocumentPageViewer.Zoom clamped, or the fit-derived factor when Avalonia.Controls.FlowDocumentPageViewer.ZoomMode tracks the viewport. Bindable for zoom chrome (e.g. a percent label). |
| 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. Inherited from FlowDocumentScrollViewer. |
| 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. |
| IsPaginationComplete | Gets whether pagination has reached the end of the document, after which Avalonia.Controls.FlowDocumentPageViewer.PageCount is final. Pagination runs at idle priority and the count grows while it does, so a "page N of M" display shows a provisional M until this turns true. |
| 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. Inherited from FlowDocumentScrollViewer. |
| 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. |
| MaxZoom | Gets or sets the largest allowed effective zoom factor. |
| 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. |
| MinZoom | Gets or sets the smallest allowed effective zoom factor. |
| 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. |
| PageBackground | Gets or sets the brush filling a page sheet behind its content. |
| PageBorderBrush | Gets or sets the brush outlining a page sheet. |
| PageBoundsBrush | Gets or sets the brush used to render the background of the page bounds area. Inherited from FlowDocumentScrollViewer. |
| PageCount | Gets the number of pages paginated so far (progressive). |
| PageGap | Gets or sets the vertical gap between page sheets. |
| PageMargins | Gets or sets the page margins. When null, the document's page padding is used, falling back to 2 cm on every side. |
| PageSize | Gets or sets the page size in device-independent pixels. When null, the document's fixed page dimensions are used, falling back to A4 per dimension. |
| 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. Inherited from FlowDocumentScrollViewer. |
| SelectionBrush | Gets or sets the brush used to render the selection highlight. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| ShowPageBounds | Gets or sets whether page boundary indicators are rendered. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| 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. |
| Zoom | Gets or sets the zoom factor applied when Avalonia.Controls.FlowDocumentPageViewer.ZoomMode is Avalonia.Controls.PageZoomMode.Custom (1.0 = 100%). Zoom is a pure visual scale: text never re-wraps and pagination is unaffected. Ctrl+wheel over the pages zooms about the pointer and switches the mode back to custom. |
| ZoomMode | Gets or sets how the zoom factor is resolved: an explicit Avalonia.Controls.FlowDocumentPageViewer.Zoom, or tracking the viewport so a sheet fills its width or fits it whole. |
CurrentPageNumber Property
Gets the 1-based page number at the viewport center.
public int CurrentPageNumber { get; set; }
EffectiveZoom Property
Gets the zoom factor currently in effect: Avalonia.Controls.FlowDocumentPageViewer.Zoom clamped, or the fit-derived factor when Avalonia.Controls.FlowDocumentPageViewer.ZoomMode tracks the viewport. Bindable for zoom chrome (e.g. a percent label).
public double EffectiveZoom { get; set; }
IsPaginationComplete Property
Gets whether pagination has reached the end of the document, after which Avalonia.Controls.FlowDocumentPageViewer.PageCount is final. Pagination runs at idle priority and the count grows while it does, so a "page N of M" display shows a provisional M until this turns true.
public bool IsPaginationComplete { get; set; }
MaxZoom Property
Gets or sets the largest allowed effective zoom factor.
public double MaxZoom { get; set; }
MinZoom Property
Gets or sets the smallest allowed effective zoom factor.
public double MinZoom { get; set; }
PageBackground Property
Gets or sets the brush filling a page sheet behind its content.
public Avalonia.Media.IBrush PageBackground { get; set; }
PageBorderBrush Property
Gets or sets the brush outlining a page sheet.
public Avalonia.Media.IBrush PageBorderBrush { get; set; }
PageCount Property
Gets the number of pages paginated so far (progressive).
public int PageCount { get; set; }
PageGap Property
Gets or sets the vertical gap between page sheets.
public double PageGap { get; set; }
PageMargins Property
Gets or sets the page margins. When null, the document's page padding is used, falling back to 2 cm on every side.
public Nullable<Avalonia.Thickness> PageMargins { get; set; }
PageSize Property
Gets or sets the page size in device-independent pixels. When null, the document's fixed page dimensions are used, falling back to A4 per dimension.
public Nullable<Avalonia.Size> PageSize { get; set; }
Zoom Property
Gets or sets the zoom factor applied when Avalonia.Controls.FlowDocumentPageViewer.ZoomMode is Avalonia.Controls.PageZoomMode.Custom (1.0 = 100%). Zoom is a pure visual scale: text never re-wraps and pagination is unaffected. Ctrl+wheel over the pages zooms about the pointer and switches the mode back to custom.
public double Zoom { get; set; }
ZoomMode Property
Gets or sets how the zoom factor is resolved: an explicit Avalonia.Controls.FlowDocumentPageViewer.Zoom, or tracking the viewport so a sheet fills its width or fits it whole.
public Avalonia.Controls.PageZoomMode ZoomMode { get; set; }
Fields
CurrentPageNumberProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.CurrentPageNumber property.
public Avalonia.DirectProperty<Avalonia.Controls.FlowDocumentPageViewer, int> CurrentPageNumberProperty
EffectiveZoomProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.EffectiveZoom property.
public Avalonia.DirectProperty<Avalonia.Controls.FlowDocumentPageViewer, double> EffectiveZoomProperty
IsPaginationCompleteProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.IsPaginationComplete property.
public Avalonia.DirectProperty<Avalonia.Controls.FlowDocumentPageViewer, bool> IsPaginationCompleteProperty
MaxZoomProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.MaxZoom property.
public Avalonia.StyledProperty<double> MaxZoomProperty
MinZoomProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.MinZoom property.
public Avalonia.StyledProperty<double> MinZoomProperty
PageBackgroundProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.PageBackground property.
public Avalonia.StyledProperty<Avalonia.Media.IBrush> PageBackgroundProperty
PageBorderBrushProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.PageBorderBrush property.
public Avalonia.StyledProperty<Avalonia.Media.IBrush> PageBorderBrushProperty
PageCountProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.PageCount property.
public Avalonia.DirectProperty<Avalonia.Controls.FlowDocumentPageViewer, int> PageCountProperty
PageGapProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.PageGap property.
public Avalonia.StyledProperty<double> PageGapProperty
PageMarginsProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.PageMargins property.
public Avalonia.StyledProperty<Nullable<Avalonia.Thickness>> PageMarginsProperty
PageSizeProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.PageSize property.
public Avalonia.StyledProperty<Nullable<Avalonia.Size>> PageSizeProperty
ZoomModeProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.ZoomMode property.
public Avalonia.StyledProperty<Avalonia.Controls.PageZoomMode> ZoomModeProperty
ZoomProperty Field
Defines the Avalonia.Controls.FlowDocumentPageViewer.Zoom property.
public Avalonia.StyledProperty<double> ZoomProperty
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. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| 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. Inherited from FlowDocumentScrollViewer. |
| 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. |