Share via


View.OverScrollBy Method

Definition

Scroll the view with standard behavior for scrolling beyond the normal content boundaries.

[Android.Runtime.Register("overScrollBy", "(IIIIIIIIZ)Z", "GetOverScrollBy_IIIIIIIIZHandler")]
protected virtual bool OverScrollBy (int deltaX, int deltaY, int scrollX, int scrollY, int scrollRangeX, int scrollRangeY, int maxOverScrollX, int maxOverScrollY, bool isTouchEvent);
[<Android.Runtime.Register("overScrollBy", "(IIIIIIIIZ)Z", "GetOverScrollBy_IIIIIIIIZHandler")>]
abstract member OverScrollBy : int * int * int * int * int * int * int * int * bool -> bool
override this.OverScrollBy : int * int * int * int * int * int * int * int * bool -> bool

Parameters

deltaX
Int32

Change in X in pixels

deltaY
Int32

Change in Y in pixels

scrollX
Int32

Current X scroll value in pixels before applying deltaX

scrollY
Int32

Current Y scroll value in pixels before applying deltaY

scrollRangeX
Int32

Maximum content scroll range along the X axis

scrollRangeY
Int32

Maximum content scroll range along the Y axis

maxOverScrollX
Int32

Number of pixels to overscroll by in either direction along the X axis.

maxOverScrollY
Int32

Number of pixels to overscroll by in either direction along the Y axis.

isTouchEvent
Boolean

true if this scroll operation is the result of a touch event.

Returns

true if scrolling was clamped to an over-scroll boundary along either axis, false otherwise.

Attributes

Remarks

Scroll the view with standard behavior for scrolling beyond the normal content boundaries. Views that call this method should override #onOverScrolled(int, int, boolean, boolean) to respond to the results of an over-scroll operation.

Views can use this method to handle any touch or fling-based scrolling.

Java documentation for android.view.View.overScrollBy(int, int, int, int, int, int, int, int, boolean).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to