ScrollContentPresenter Class
Definition
Presents a scrolling view of content inside a Avalonia.Controls.ScrollViewer.
public class ScrollContentPresenter
Constructors
| Name | Description |
|---|---|
| ScrollContentPresenter | Initializes a new instance of the Avalonia.Controls.Presenters.ScrollContentPresenter class. |
ScrollContentPresenter Constructor
Initializes a new instance of the Avalonia.Controls.Presenters.ScrollContentPresenter class.
public ScrollContentPresenter()
Methods
| Name | Description |
|---|---|
| BringDescendantIntoView | Attempts to bring a portion of the target visual into view by scrolling the content. |
| ApplyTemplate | Creates the visual children of the control, if necessary Inherited from ContentPresenter. |
| Render | Renders the visual to a Avalonia.Media.DrawingContext. Inherited from ContentPresenter. |
| UpdateChild | Updates the Avalonia.Controls.Presenters.ContentPresenter.Child control based on the control's Avalonia.Controls.Presenters.ContentPresenter.Content. Inherited from ContentPresenter. |
| Focus | Focuses the control. Inherited from InputElement. |
| GetIsHoldWithMouseEnabled | Inherited from InputElement. |
| GetIsHoldingEnabled | Inherited from InputElement. |
| SetIsHoldWithMouseEnabled | Inherited from InputElement. |
| SetIsHoldingEnabled | Inherited from InputElement. |
| AddHandler (2 overloads) | Adds a handler for the specified routed event. Inherited from Interactive. |
| RaiseEvent | Raises a routed event. Inherited from Interactive. |
| RemoveHandler (2 overloads) | Removes a handler for the specified routed event. Inherited from Interactive. |
| Arrange | Arranges the control and its children. Inherited from Layoutable. |
| 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. |
| Measure | Carries out a measure of the control. Inherited from Layoutable. |
| UpdateLayout | Executes a layout pass. Inherited from Layoutable. |
| GetFlowDirection | Gets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| InvalidateVisual | Invalidates the visual and queues a repaint. Inherited from Visual. |
| SetFlowDirection | Sets the value of the attached Avalonia.Visual.FlowDirectionProperty on a control. Inherited from Visual. |
| ApplyStyling | Applies styling to the control if the control is initialized and styling is not already applied. Inherited from StyledElement. |
| BeginInit | Inherited from StyledElement. |
| EndInit | Inherited from StyledElement. |
| TryGetResource | 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. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| 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. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
BringDescendantIntoView Method
Attempts to bring a portion of the target visual into view by scrolling the content.
public bool BringDescendantIntoView(Avalonia.Visual target, Avalonia.Rect targetRect)
Parameters
target Avalonia.Visual
The target visual.
targetRect Avalonia.Rect
The portion of the target visual to bring into view.
Returns
bool
True if the scroll offset was changed; otherwise false.
Properties
| Name | Description |
|---|---|
| CanHorizontallyScroll | Gets or sets a value indicating whether the content can be scrolled horizontally. |
| CanVerticallyScroll | Gets or sets a value indicating whether the content can be scrolled horizontally. |
| Extent | Gets the extent of the scrollable content. |
| 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. |
| IsScrollChainingEnabled | Gets or sets if scroll chaining is enabled. The default value is true. |
| Offset | Gets or sets the current scroll offset. |
| 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. |
| Background | Gets or sets a brush with which to paint the background. Inherited from ContentPresenter. |
| BackgroundSizing | Gets or sets how the background is drawn relative to the border. Inherited from ContentPresenter. |
| BorderBrush | Gets or sets a brush with which to paint the border. Inherited from ContentPresenter. |
| BorderThickness | Gets or sets the thickness of the border. Inherited from ContentPresenter. |
| BoxShadow | Gets or sets the box shadow effect parameters Inherited from ContentPresenter. |
| Child | Gets the control displayed by the presenter. Inherited from ContentPresenter. |
| Content | Gets or sets the content to be displayed by the presenter. Inherited from ContentPresenter. |
| ContentTemplate | Gets or sets the data template used to display the content of the control. Inherited from ContentPresenter. |
| CornerRadius | Gets or sets the radius of the border rounded corners. Inherited from ContentPresenter. |
| FontFamily | Gets or sets the font family. Inherited from ContentPresenter. |
| FontSize | Gets or sets the font size. Inherited from ContentPresenter. |
| FontStretch | Gets or sets the font stretch. Inherited from ContentPresenter. |
| FontStyle | Gets or sets the font style. Inherited from ContentPresenter. |
| FontWeight | Gets or sets the font weight. Inherited from ContentPresenter. |
| Foreground | Gets or sets a brush used to paint the text. Inherited from ContentPresenter. |
| HorizontalContentAlignment | Gets or sets the horizontal alignment of the content within the border the control. Inherited from ContentPresenter. |
| LetterSpacing | Gets or sets the letter spacing Inherited from ContentPresenter. |
| LineHeight | Gets or sets the line height Inherited from ContentPresenter. |
| MaxLines | Gets or sets the max lines Inherited from ContentPresenter. |
| Padding | Gets or sets the space between the border and the Avalonia.Controls.Presenters.ContentPresenter.Child control. Inherited from ContentPresenter. |
| RecognizesAccessKey | Determine if Avalonia.Controls.Presenters.ContentPresenter should use Avalonia.Controls.Primitives.AccessText in its style Inherited from ContentPresenter. |
| TextAlignment | Gets or sets the text alignment Inherited from ContentPresenter. |
| TextTrimming | Gets or sets the text trimming Inherited from ContentPresenter. |
| TextWrapping | Gets or sets the text wrapping Inherited from ContentPresenter. |
| VerticalContentAlignment | Gets or sets the vertical alignment of the content within the border of the control. Inherited from ContentPresenter. |
| 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. |
| DataTemplates | Gets or sets the data templates for the control. Inherited from Control. |
| FocusAdorner | Gets or sets the control's focus adorner. Inherited from Control. |
| 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. |
| Tag | Gets or sets a user-defined object attached to the control. Inherited from Control. |
| Cursor | Gets or sets associated mouse cursor. Inherited from InputElement. |
| Focusable | Gets or sets a value indicating whether the control can receive focus. Inherited from InputElement. |
| GestureRecognizers | Inherited from InputElement. |
| IsEffectivelyEnabled | Gets a value indicating whether this control and all its parents are enabled. Inherited from InputElement. |
| 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. |
| IsKeyboardFocusWithin | Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. Inherited from InputElement. |
| IsPointerOver | Gets a value indicating whether the pointer is currently over the control. Inherited from InputElement. |
| IsTabStop | Gets or sets a value that indicates whether the control is included in tab navigation. Inherited from InputElement. |
| KeyBindings | Inherited from InputElement. |
| 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. |
| DesiredSize | Gets the size that this element computed during the measure pass of the layout process. Inherited from Layoutable. |
| 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. |
| IsMeasureValid | Gets a value indicating whether the control's layout measure is valid. Inherited from Layoutable. |
| 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. |
| 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. |
| 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. |
| 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. |
| Effect | Gets or sets the effect of the control. Inherited from Visual. |
| FlowDirection | Gets or sets the text flow direction. Inherited from Visual. |
| HasMirrorTransform | Gets or sets a value indicating whether to apply mirror transform on this control. Inherited from Visual. |
| IsEffectivelyVisible | Gets a value indicating whether this control and all its parents are visible. Inherited from Visual. |
| IsVisible | Gets or sets a value indicating whether this control is visible. Inherited from Visual. |
| 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. |
| 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. |
| ZIndex | Gets or sets the Z index of the control. Inherited from Visual. |
| ActualThemeVariant | Gets the UI theme that is currently used by the element, which might be different than the RequestedThemeVariantProperty. Inherited from StyledElement. |
| Classes | Gets or sets the styled element's classes. Inherited from StyledElement. |
| DataContext | Gets or sets the control's data context. Inherited from StyledElement. |
| IsInitialized | Gets a value that indicates whether the element has finished initialization. Inherited from StyledElement. |
| Name | Gets or sets the name of the styled element. Inherited from StyledElement. |
| Parent | Gets the styled element's logical parent. Inherited from StyledElement. |
| Resources | Gets or sets the styled element's resource dictionary. Inherited from StyledElement. |
| StyleKey | Gets the type by which the element is styled. Inherited from StyledElement. |
| Styles | Gets the styles for the styled element. Inherited from StyledElement. |
| 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. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Item | Inherited from AvaloniaObject. |
CanHorizontallyScroll Property
Gets or sets a value indicating whether the content can be scrolled horizontally.
public bool CanHorizontallyScroll { get; set; }
CanVerticallyScroll Property
Gets or sets a value indicating whether the content can be scrolled horizontally.
public bool CanVerticallyScroll { get; set; }
Extent Property
Gets the extent of the scrollable content.
public Avalonia.Size Extent { 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; }
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.
Offset Property
Gets or sets the current scroll offset.
public Avalonia.Vector Offset { 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
CanHorizontallyScrollProperty Field
Defines the Avalonia.Controls.Presenters.ScrollContentPresenter.CanHorizontallyScroll property.
public Avalonia.StyledProperty<bool> CanHorizontallyScrollProperty
CanVerticallyScrollProperty Field
Defines the Avalonia.Controls.Presenters.ScrollContentPresenter.CanVerticallyScroll property.
public Avalonia.StyledProperty<bool> CanVerticallyScrollProperty
ExtentProperty Field
Defines the Avalonia.Controls.Presenters.ScrollContentPresenter.Extent property.
public Avalonia.DirectProperty<Avalonia.Controls.Presenters.ScrollContentPresenter, Avalonia.Size> ExtentProperty
HorizontalSnapPointsAlignmentProperty Field
Defines the Avalonia.Controls.Presenters.ScrollContentPresenter.HorizontalSnapPointsAlignment property.
public Avalonia.StyledProperty<Avalonia.Controls.Primitives.SnapPointsAlignment> HorizontalSnapPointsAlignmentProperty
HorizontalSnapPointsTypeProperty Field
Defines the Avalonia.Controls.Presenters.ScrollContentPresenter.HorizontalSnapPointsType property.
public Avalonia.StyledProperty<Avalonia.Controls.Primitives.SnapPointsType> HorizontalSnapPointsTypeProperty
IsScrollChainingEnabledProperty Field
Defines the Avalonia.Controls.Presenters.ScrollContentPresenter.IsScrollChainingEnabled property.
public Avalonia.StyledProperty<bool> IsScrollChainingEnabledProperty
OffsetProperty Field
Defines the Avalonia.Controls.Presenters.ScrollContentPresenter.Offset property.
public Avalonia.StyledProperty<Avalonia.Vector> OffsetProperty
VerticalSnapPointsAlignmentProperty Field
Defines the Avalonia.Controls.Presenters.ScrollContentPresenter.VerticalSnapPointsAlignment property.
public Avalonia.StyledProperty<Avalonia.Controls.Primitives.SnapPointsAlignment> VerticalSnapPointsAlignmentProperty
VerticalSnapPointsTypeProperty Field
Defines the Avalonia.Controls.Presenters.ScrollContentPresenter.VerticalSnapPointsType property.
public Avalonia.StyledProperty<Avalonia.Controls.Primitives.SnapPointsType> VerticalSnapPointsTypeProperty
ViewportProperty Field
Defines the Avalonia.Controls.Presenters.ScrollContentPresenter.Viewport property.
public Avalonia.DirectProperty<Avalonia.Controls.Presenters.ScrollContentPresenter, Avalonia.Size> ViewportProperty
Events
| Name | Description |
|---|---|
| Loaded | Occurs when the control has been fully constructed in the visual tree and both layout and render are complete. Inherited from Control. |
| SizeChanged | Occurs when the bounds (actual size) of the control have changed. Inherited from Control. |
| Unloaded | Occurs when the control is removed from the visual tree. Inherited from Control. |
| 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. |
| DoubleTapped | Occurs when the user briefly contacts and releases twice on a single point, without significant movement. Inherited from InputElement. |
| 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. |
| 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. |
| 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. |
| 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. |
| RightTapped | Occurs when the user briefly contacts and releases a single point, without significant movement, using a mechanism on the input device recognized as a right button or equivalent. Inherited from InputElement. |
| ScrollGesture | Occurs when the user continuously moves the pointer in the same direction within the control’s boundaries. Inherited from InputElement. |
| ScrollGestureEnded | Occurs when a scroll gesture has fully stopped, taking into account any inertial movement that continues the scroll after the user has released the pointer. Inherited from InputElement. |
| ScrollGestureInertiaStarting | Occurs within a scroll gesture, when the user releases the pointer, and scrolling continues by transitioning to momentum-based gliding movement. Inherited from InputElement. |
| SwipeGesture | Occurs when the user rapidly drags the pointer in a single direction across the control. Inherited from InputElement. |
| SwipeGestureEnded | Occurs when a swipe gesture ends on the control. Inherited from InputElement. |
| Tapped | Occurs when the user briefly contacts and releases a single point, without significant movement. Inherited from InputElement. |
| TextInput | Occurs when a user typed some text while the control has focus. Inherited from InputElement. |
| TextInputMethodClientRequested | Occurs when an input element gains input focus and input method is looking for the corresponding client Inherited from InputElement. |
| EffectiveViewportChanged | Occurs when the element's effective viewport changes. Inherited from Layoutable. |
| LayoutUpdated | Occurs when a layout pass completes for the control. Inherited from Layoutable. |
| AttachedToVisualTree | Raised when the control is attached to a rooted visual tree. Inherited from Visual. |
| DetachedFromVisualTree | Raised when the control is detached from a rooted visual tree. Inherited from Visual. |
| 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. |
| 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. |
| Initialized | Occurs when the styled element has finished initialization. Inherited from StyledElement. |
| ResourcesChanged | Occurs when a resource in this styled element or a parent styled element has changed. Inherited from StyledElement. |
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |