ScrollViewer Class
Definition
A control which scrolls its content if the content is bigger than the space available.
public class ScrollViewer
Constructors
| Name | Description |
|---|---|
| ScrollViewer | Initializes a new instance of the Avalonia.Controls.ScrollViewer class. |
ScrollViewer Constructor
Initializes a new instance of the Avalonia.Controls.ScrollViewer class.
public ScrollViewer()
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. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| Focus | Focuses the control. Inherited from InputElement. |
| GetAllowAutoHide | Gets the value of the AllowAutoHideProperty attached property. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetBringIntoViewOnFocusChange | Gets the value of the Avalonia.Controls.ScrollViewer.BringIntoViewOnFocusChange attached property. |
| 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. |
| GetHorizontalScrollBarVisibility | Gets the value of the HorizontalScrollBarVisibility attached property. |
| GetHorizontalSnapPointsAlignment | Gets the value of the HorizontalSnapPointsAlignment attached property. |
| GetHorizontalSnapPointsType | Gets the value of the HorizontalSnapPointsType attached property. |
| GetIsDeferredScrollingEnabled | Gets whether dragging of Avalonia.Controls.Primitives.Thumb elements should update the Avalonia.Controls.ScrollViewer only when the user releases the mouse. |
| GetIsHoldingEnabled | Inherited from InputElement. |
| GetIsHoldWithMouseEnabled | Inherited from InputElement. |
| GetIsScrollChainingEnabled | Gets the value of the IsScrollChainingEnabled attached property. |
| GetIsScrollInertiaEnabled | Gets whether scroll gestures should include inertia in their behavior and value. |
| 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. |
| GetVerticalScrollBarVisibility | Gets the value of the VerticalScrollBarVisibility attached property. |
| GetVerticalSnapPointsAlignment | Gets the value of the VerticalSnapPointsAlignment attached property. |
| GetVerticalSnapPointsType | Gets the value of the VerticalSnapPointsType attached property. |
| 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. |
| LineDown | Scrolls the content down one line. |
| LineLeft | Scrolls the content left one line. |
| LineRight | Scrolls the content right one line. |
| LineUp | Scrolls the content up one line. |
| Measure | Carries out a measure of the control. Inherited from Layoutable. |
| PageDown | Scrolls the content downward by one page. |
| PageLeft | Scrolls the content left by one page. |
| PageRight | Scrolls the content tight by one page. |
| PageUp | Scrolls the content upward by one page. |
| RaiseEvent | Raises a routed event. Inherited from Interactive. |
| RegisterAnchorCandidate | Registers a control as a potential scroll anchor candidate. |
| 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. |
| ScrollToEnd | Scrolls to the bottom-left corner of the content. |
| ScrollToHome | Scrolls to the top-left corner of the content. |
| SetAllowAutoHide | Gets the value of the AllowAutoHideProperty attached property. |
| SetBringIntoViewOnFocusChange | Gets the value of the Avalonia.Controls.ScrollViewer.BringIntoViewOnFocusChange attached property. |
| 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. |
| SetHorizontalScrollBarVisibility | Gets the value of the HorizontalScrollBarVisibility attached property. |
| SetHorizontalSnapPointsAlignment | Gets the value of the HorizontalSnapPointsAlignment attached property. |
| SetHorizontalSnapPointsType | Gets the value of the HorizontalSnapPointsType attached property. |
| SetIsDeferredScrollingEnabled | Sets whether dragging of Avalonia.Controls.Primitives.Thumb elements should update the Avalonia.Controls.ScrollViewer only when the user releases the mouse. |
| SetIsHoldingEnabled | Inherited from InputElement. |
| SetIsHoldWithMouseEnabled | Inherited from InputElement. |
| SetIsScrollChainingEnabled | Sets the value of the IsScrollChainingEnabled attached property. |
| SetIsScrollInertiaEnabled | Sets whether scroll gestures should include inertia in their behavior and value. |
| 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. |
| SetVerticalScrollBarVisibility | Gets the value of the VerticalScrollBarVisibility attached property. |
| SetVerticalSnapPointsAlignment | Gets the value of the VerticalSnapPointsAlignment attached property. |
| SetVerticalSnapPointsType | Gets the value of the VerticalSnapPointsType attached property. |
| TryGetResource | Inherited from StyledElement. |
| UnregisterAnchorCandidate | Unregisters a control as a potential scroll anchor candidate. |
| 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. |
GetAllowAutoHide Method
Gets the value of the AllowAutoHideProperty attached property.
public bool GetAllowAutoHide(Avalonia.Controls.Control control)
Parameters
control Avalonia.Controls.Control
The control to read the value from.
Returns
bool
The value of the property.
GetBringIntoViewOnFocusChange Method
Gets the value of the Avalonia.Controls.ScrollViewer.BringIntoViewOnFocusChange attached property.
public bool GetBringIntoViewOnFocusChange(Avalonia.Controls.Control control)
Parameters
control Avalonia.Controls.Control
The control to read the value from.
Returns
bool
The value of the property.
GetHorizontalScrollBarVisibility Method
Gets the value of the HorizontalScrollBarVisibility attached property.
public Avalonia.Controls.Primitives.ScrollBarVisibility GetHorizontalScrollBarVisibility(Avalonia.Controls.Control control)
Parameters
control Avalonia.Controls.Control
The control to read the value from.
Returns
Avalonia.Controls.Primitives.ScrollBarVisibility
The value of the property.
GetHorizontalSnapPointsAlignment Method
Gets the value of the HorizontalSnapPointsAlignment attached property.
public Avalonia.Controls.Primitives.SnapPointsAlignment GetHorizontalSnapPointsAlignment(Avalonia.Controls.Control control)
Parameters
control Avalonia.Controls.Control
The control to read the value from.
Returns
Avalonia.Controls.Primitives.SnapPointsAlignment
The value of the property.
GetHorizontalSnapPointsType Method
Gets the value of the HorizontalSnapPointsType attached property.
public Avalonia.Controls.Primitives.SnapPointsType GetHorizontalSnapPointsType(Avalonia.Controls.Control control)
Parameters
control Avalonia.Controls.Control
The control to read the value from.
Returns
Avalonia.Controls.Primitives.SnapPointsType
The value of the property.
GetIsDeferredScrollingEnabled Method
Gets whether dragging of Avalonia.Controls.Primitives.Thumb elements should update the Avalonia.Controls.ScrollViewer only when the user releases the mouse.
public bool GetIsDeferredScrollingEnabled(Avalonia.Controls.Control control)
Parameters
control Avalonia.Controls.Control
Returns
bool
GetIsScrollChainingEnabled Method
Gets the value of the IsScrollChainingEnabled attached property.
public bool GetIsScrollChainingEnabled(Avalonia.Controls.Control control)
Parameters
control Avalonia.Controls.Control
The control to read the value from.
Returns
bool
The value of the property.
Remarks
After a user hits a scroll limit on an element that has been nested within another scrollable element, you can specify whether that parent element should continue the scrolling operation begun in its child element. This is called scroll chaining.
GetIsScrollInertiaEnabled Method
Gets whether scroll gestures should include inertia in their behavior and value.
public bool GetIsScrollInertiaEnabled(Avalonia.Controls.Control control)
Parameters
control Avalonia.Controls.Control
Returns
bool
GetVerticalScrollBarVisibility Method
Gets the value of the VerticalScrollBarVisibility attached property.
public Avalonia.Controls.Primitives.ScrollBarVisibility GetVerticalScrollBarVisibility(Avalonia.Controls.Control control)
Parameters
control Avalonia.Controls.Control
The control to read the value from.
Returns
Avalonia.Controls.Primitives.ScrollBarVisibility
The value of the property.
GetVerticalSnapPointsAlignment Method
Gets the value of the VerticalSnapPointsAlignment attached property.
public Avalonia.Controls.Primitives.SnapPointsAlignment GetVerticalSnapPointsAlignment(Avalonia.Controls.Control control)
Parameters
control Avalonia.Controls.Control
The control to read the value from.
Returns
Avalonia.Controls.Primitives.SnapPointsAlignment
The value of the property.
GetVerticalSnapPointsType Method
Gets the value of the VerticalSnapPointsType attached property.
public Avalonia.Controls.Primitives.SnapPointsType GetVerticalSnapPointsType(Avalonia.Controls.Control control)
Parameters
control Avalonia.Controls.Control
The control to read the value from.
Returns
Avalonia.Controls.Primitives.SnapPointsType
The value of the property.
LineDown Method
Scrolls the content down one line.
public void LineDown()
LineLeft Method
Scrolls the content left one line.
public void LineLeft()
LineRight Method
Scrolls the content right one line.
public void LineRight()
LineUp Method
Scrolls the content up one line.
public void LineUp()
PageDown Method
Scrolls the content downward by one page.
public void PageDown()
PageLeft Method
Scrolls the content left by one page.
public void PageLeft()
PageRight Method
Scrolls the content tight by one page.
public void PageRight()
PageUp Method
Scrolls the content upward by one page.
public void PageUp()
RegisterAnchorCandidate Method
Registers a control as a potential scroll anchor candidate.
public void RegisterAnchorCandidate(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
A control within the subtree of the Avalonia.Controls.IScrollAnchorProvider.
ScrollToEnd Method
Scrolls to the bottom-left corner of the content.
public void ScrollToEnd()
ScrollToHome Method
Scrolls to the top-left corner of the content.
public void ScrollToHome()
SetAllowAutoHide Method
Gets the value of the AllowAutoHideProperty attached property.
public void SetAllowAutoHide(Avalonia.Controls.Control control, bool value)
Parameters
control Avalonia.Controls.Control
The control to set the value on.
value bool
The value of the property.
SetBringIntoViewOnFocusChange Method
Gets the value of the Avalonia.Controls.ScrollViewer.BringIntoViewOnFocusChange attached property.
public void SetBringIntoViewOnFocusChange(Avalonia.Controls.Control control, bool value)
Parameters
control Avalonia.Controls.Control
The control to set the value on.
value bool
The value of the property.
SetHorizontalScrollBarVisibility Method
Gets the value of the HorizontalScrollBarVisibility attached property.
public void SetHorizontalScrollBarVisibility(Avalonia.Controls.Control control, Avalonia.Controls.Primitives.ScrollBarVisibility value)
Parameters
control Avalonia.Controls.Control
The control to set the value on.
value Avalonia.Controls.Primitives.ScrollBarVisibility
The value of the property.
SetHorizontalSnapPointsAlignment Method
Gets the value of the HorizontalSnapPointsAlignment attached property.
public void SetHorizontalSnapPointsAlignment(Avalonia.Controls.Control control, Avalonia.Controls.Primitives.SnapPointsAlignment value)
Parameters
control Avalonia.Controls.Control
The control to set the value on.
value Avalonia.Controls.Primitives.SnapPointsAlignment
The value of the property.
SetHorizontalSnapPointsType Method
Gets the value of the HorizontalSnapPointsType attached property.
public void SetHorizontalSnapPointsType(Avalonia.Controls.Control control, Avalonia.Controls.Primitives.SnapPointsType value)
Parameters
control Avalonia.Controls.Control
The control to set the value on.
value Avalonia.Controls.Primitives.SnapPointsType
The value of the property.
SetIsDeferredScrollingEnabled Method
Sets whether dragging of Avalonia.Controls.Primitives.Thumb elements should update the Avalonia.Controls.ScrollViewer only when the user releases the mouse.
public void SetIsDeferredScrollingEnabled(Avalonia.Controls.Control control, bool value)
Parameters
control Avalonia.Controls.Control
value bool
SetIsScrollChainingEnabled Method
Sets the value of the IsScrollChainingEnabled attached property.
public void SetIsScrollChainingEnabled(Avalonia.Controls.Control control, bool value)
Parameters
control Avalonia.Controls.Control
The control to set the value on.
value bool
The value of the property.
Remarks
After a user hits a scroll limit on an element that has been nested within another scrollable element, you can specify whether that parent element should continue the scrolling operation begun in its child element. This is called scroll chaining.
SetIsScrollInertiaEnabled Method
Sets whether scroll gestures should include inertia in their behavior and value.
public void SetIsScrollInertiaEnabled(Avalonia.Controls.Control control, bool value)
Parameters
control Avalonia.Controls.Control
value bool
SetVerticalScrollBarVisibility Method
Gets the value of the VerticalScrollBarVisibility attached property.
public void SetVerticalScrollBarVisibility(Avalonia.Controls.Control control, Avalonia.Controls.Primitives.ScrollBarVisibility value)
Parameters
control Avalonia.Controls.Control
The control to set the value on.
value Avalonia.Controls.Primitives.ScrollBarVisibility
The value of the property.
SetVerticalSnapPointsAlignment Method
Gets the value of the VerticalSnapPointsAlignment attached property.
public void SetVerticalSnapPointsAlignment(Avalonia.Controls.Control control, Avalonia.Controls.Primitives.SnapPointsAlignment value)
Parameters
control Avalonia.Controls.Control
The control to set the value on.
value Avalonia.Controls.Primitives.SnapPointsAlignment
The value of the property.
SetVerticalSnapPointsType Method
Gets the value of the VerticalSnapPointsType attached property.
public void SetVerticalSnapPointsType(Avalonia.Controls.Control control, Avalonia.Controls.Primitives.SnapPointsType value)
Parameters
control Avalonia.Controls.Control
The control to set the value on.
value Avalonia.Controls.Primitives.SnapPointsType
The value of the property.
UnregisterAnchorCandidate Method
Unregisters a control as a potential scroll anchor candidate.
public void UnregisterAnchorCandidate(Avalonia.Controls.Control element)
Parameters
element Avalonia.Controls.Control
A control within the subtree of the Avalonia.Controls.IScrollAnchorProvider.
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. |
| AllowAutoHide | Gets a value that indicates whether scrollbars can hide itself when user is not interacting with it. |
| 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. |
| BringIntoViewOnFocusChange | Gets or sets a value that determines whether the Avalonia.Controls.ScrollViewer uses a bring-into-view scroll behavior when an item in the view gets focus. |
| 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. |
| Content | Gets or sets the content to display. Inherited from ContentControl. |
| ContentTemplate | Gets or sets the data template used to display the content of the control. Inherited from ContentControl. |
| 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. |
| CurrentAnchor | The currently chosen anchor element to use for scroll anchoring. |
| 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. |
| Effect | Gets or sets the effect of the control. Inherited from Visual. |
| Extent | Gets the extent of the scrollable content. |
| 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. |
| HorizontalContentAlignment | Gets or sets the horizontal alignment of the content within the control. Inherited from ContentControl. |
| HorizontalScrollBarVisibility | Gets or sets the horizontal scrollbar visibility. |
| HorizontalSnapPointsAlignment | Gets or sets how the existing snap points are horizontally aligned versus the initial viewport. |
| HorizontalSnapPointsType | Gets or sets how scroll gesture reacts to the snap points along the horizontal axis. |
| IsArrangeValid | Gets a value indicating whether the control's layouts arrange is valid. Inherited from Layoutable. |
| IsDeferredScrollingEnabled | Gets or sets whether dragging of Avalonia.Controls.Primitives.Thumb elements should update the Avalonia.Controls.ScrollViewer only when the user releases the mouse. |
| 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. |
| IsExpanded | Gets a value that indicates whether any scrollbar is expanded. |
| 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. |
| IsScrollChainingEnabled | Gets or sets if scroll chaining is enabled. The default value is true. |
| IsScrollInertiaEnabled | Gets or sets whether scroll gestures should include inertia in their behavior and value. |
| 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. |
| LargeChange | Gets the large (page) change value for the scroll viewer. |
| 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. |
| Offset | Gets or sets the current scroll offset. |
| 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. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| Presenter | Gets the presenter from the control's template. Inherited from ContentControl. |
| 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. |
| ScrollBarMaximum | Gets the maximum scrolling distance (which is Avalonia.Controls.ScrollViewer.Extent - Avalonia.Controls.ScrollViewer.Viewport). |
| SmallChange | Gets the small (line) change value for the scroll viewer. |
| 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. |
| VerticalContentAlignment | Gets or sets the vertical alignment of the content within the control. Inherited from ContentControl. |
| VerticalScrollBarVisibility | Gets or sets the vertical scrollbar visibility. |
| VerticalSnapPointsAlignment | Gets or sets how the existing snap points are vertically aligned versus the initial viewport. |
| VerticalSnapPointsType | Gets or sets how scroll gesture reacts to the snap points along the vertical axis. |
| Viewport | Gets the size of the viewport on the scrollable content. |
| 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. |
AllowAutoHide Property
Gets a value that indicates whether scrollbars can hide itself when user is not interacting with it.
public bool AllowAutoHide { get; set; }
BringIntoViewOnFocusChange Property
Gets or sets a value that determines whether the Avalonia.Controls.ScrollViewer uses a bring-into-view scroll behavior when an item in the view gets focus.
public bool BringIntoViewOnFocusChange { get; set; }
Value
true to use a behavior that brings focused items into view. false to use a behavior that focused items do not automatically scroll into view. The default is true.
Remarks
Avalonia.Controls.ScrollViewer.BringIntoViewOnFocusChange can either be set explicitly on a Avalonia.Controls.ScrollViewer, or a the attached
ScrollViewer.BringIntoViewOnFocusChange
property can be set on an element that hosts a Avalonia.Controls.ScrollViewer.
CurrentAnchor Property
The currently chosen anchor element to use for scroll anchoring.
public Avalonia.Controls.Control CurrentAnchor { get; set; }
Extent Property
Gets the extent of the scrollable content.
public Avalonia.Size Extent { get; set; }
HorizontalScrollBarVisibility Property
Gets or sets the horizontal scrollbar visibility.
public Avalonia.Controls.Primitives.ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }
HorizontalSnapPointsAlignment Property
Gets or sets how the existing snap points are horizontally aligned versus the initial viewport.
public Avalonia.Controls.Primitives.SnapPointsAlignment HorizontalSnapPointsAlignment { get; set; }
HorizontalSnapPointsType Property
Gets or sets how scroll gesture reacts to the snap points along the horizontal axis.
public Avalonia.Controls.Primitives.SnapPointsType HorizontalSnapPointsType { get; set; }
IsDeferredScrollingEnabled Property
Gets or sets whether dragging of Avalonia.Controls.Primitives.Thumb elements should update the Avalonia.Controls.ScrollViewer only when the user releases the mouse.
public bool IsDeferredScrollingEnabled { get; set; }
IsExpanded Property
Gets a value that indicates whether any scrollbar is expanded.
public bool IsExpanded { get; set; }
IsScrollChainingEnabled Property
Gets or sets if scroll chaining is enabled. The default value is true.
public bool IsScrollChainingEnabled { get; set; }
Remarks
After a user hits a scroll limit on an element that has been nested within another scrollable element, you can specify whether that parent element should continue the scrolling operation begun in its child element. This is called scroll chaining.
IsScrollInertiaEnabled Property
Gets or sets whether scroll gestures should include inertia in their behavior and value.
public bool IsScrollInertiaEnabled { get; set; }
LargeChange Property
Gets the large (page) change value for the scroll viewer.
public Avalonia.Size LargeChange { get; set; }
Offset Property
Gets or sets the current scroll offset.
public Avalonia.Vector Offset { get; set; }
ScrollBarMaximum Property
Gets the maximum scrolling distance (which is Avalonia.Controls.ScrollViewer.Extent - Avalonia.Controls.ScrollViewer.Viewport).
public Avalonia.Vector ScrollBarMaximum { get; set; }
SmallChange Property
Gets the small (line) change value for the scroll viewer.
public Avalonia.Size SmallChange { get; set; }
VerticalScrollBarVisibility Property
Gets or sets the vertical scrollbar visibility.
public Avalonia.Controls.Primitives.ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
VerticalSnapPointsAlignment Property
Gets or sets how the existing snap points are vertically aligned versus the initial viewport.
public Avalonia.Controls.Primitives.SnapPointsAlignment VerticalSnapPointsAlignment { get; set; }
VerticalSnapPointsType Property
Gets or sets how scroll gesture reacts to the snap points along the vertical axis.
public Avalonia.Controls.Primitives.SnapPointsType VerticalSnapPointsType { get; set; }
Viewport Property
Gets the size of the viewport on the scrollable content.
public Avalonia.Size Viewport { get; set; }
Fields
AllowAutoHideProperty Field
Defines the Avalonia.Controls.ScrollViewer.AllowAutoHide property.
public Avalonia.AttachedProperty<bool> AllowAutoHideProperty
BringIntoViewOnFocusChangeProperty Field
Defines the Avalonia.Controls.ScrollViewer.BringIntoViewOnFocusChange property.
public Avalonia.AttachedProperty<bool> BringIntoViewOnFocusChangeProperty
ExtentProperty Field
Defines the Avalonia.Controls.ScrollViewer.Extent property.
public Avalonia.DirectProperty<Avalonia.Controls.ScrollViewer, Avalonia.Size> ExtentProperty
HorizontalScrollBarVisibilityProperty Field
Defines the Avalonia.Controls.ScrollViewer.HorizontalScrollBarVisibility property.
public Avalonia.AttachedProperty<Avalonia.Controls.Primitives.ScrollBarVisibility> HorizontalScrollBarVisibilityProperty
HorizontalSnapPointsAlignmentProperty Field
Defines the Avalonia.Controls.ScrollViewer.HorizontalSnapPointsAlignment property.
public Avalonia.AttachedProperty<Avalonia.Controls.Primitives.SnapPointsAlignment> HorizontalSnapPointsAlignmentProperty
HorizontalSnapPointsTypeProperty Field
Defines the Avalonia.Controls.ScrollViewer.HorizontalSnapPointsType property.
public Avalonia.AttachedProperty<Avalonia.Controls.Primitives.SnapPointsType> HorizontalSnapPointsTypeProperty
IsDeferredScrollingEnabledProperty Field
Defines the Avalonia.Controls.ScrollViewer.IsDeferredScrollingEnabled property.
public Avalonia.AttachedProperty<bool> IsDeferredScrollingEnabledProperty
IsExpandedProperty Field
Defines the Avalonia.Controls.ScrollViewer.IsExpanded property.
public Avalonia.DirectProperty<Avalonia.Controls.ScrollViewer, bool> IsExpandedProperty
IsScrollChainingEnabledProperty Field
Defines the Avalonia.Controls.ScrollViewer.IsScrollChainingEnabled property.
public Avalonia.AttachedProperty<bool> IsScrollChainingEnabledProperty
IsScrollInertiaEnabledProperty Field
Defines the Avalonia.Controls.ScrollViewer.IsScrollInertiaEnabled property.
public Avalonia.AttachedProperty<bool> IsScrollInertiaEnabledProperty
LargeChangeProperty Field
Defines the Avalonia.Controls.ScrollViewer.LargeChange property.
public Avalonia.DirectProperty<Avalonia.Controls.ScrollViewer, Avalonia.Size> LargeChangeProperty
OffsetProperty Field
Defines the Avalonia.Controls.ScrollViewer.Offset property.
public Avalonia.StyledProperty<Avalonia.Vector> OffsetProperty
ScrollBarMaximumProperty Field
Defines the Avalonia.Controls.ScrollViewer.ScrollBarMaximum property.
public Avalonia.DirectProperty<Avalonia.Controls.ScrollViewer, Avalonia.Vector> ScrollBarMaximumProperty
ScrollChangedEvent Field
Defines the Avalonia.Controls.ScrollViewer.ScrollChanged event.
public Avalonia.Interactivity.RoutedEvent<Avalonia.Controls.ScrollChangedEventArgs> ScrollChangedEvent
SmallChangeProperty Field
Defines the Avalonia.Controls.ScrollViewer.SmallChange property.
public Avalonia.DirectProperty<Avalonia.Controls.ScrollViewer, Avalonia.Size> SmallChangeProperty
VerticalScrollBarVisibilityProperty Field
Defines the Avalonia.Controls.ScrollViewer.VerticalScrollBarVisibility property.
public Avalonia.AttachedProperty<Avalonia.Controls.Primitives.ScrollBarVisibility> VerticalScrollBarVisibilityProperty
VerticalSnapPointsAlignmentProperty Field
Defines the Avalonia.Controls.ScrollViewer.VerticalSnapPointsAlignment property.
public Avalonia.AttachedProperty<Avalonia.Controls.Primitives.SnapPointsAlignment> VerticalSnapPointsAlignmentProperty
VerticalSnapPointsTypeProperty Field
Defines the Avalonia.Controls.ScrollViewer.VerticalSnapPointsType property.
public Avalonia.AttachedProperty<Avalonia.Controls.Primitives.SnapPointsType> VerticalSnapPointsTypeProperty
ViewportProperty Field
Defines the Avalonia.Controls.ScrollViewer.Viewport property.
public Avalonia.DirectProperty<Avalonia.Controls.ScrollViewer, Avalonia.Size> ViewportProperty
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. |
| ScrollChanged | Occurs when changes are detected to the scroll position, extent, or viewport size. |
| 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. |
ScrollChanged Event
Occurs when changes are detected to the scroll position, extent, or viewport size.
public event EventHandler<Avalonia.Controls.ScrollChangedEventArgs> ScrollChanged