View.DispatchNestedScroll(Int32, Int32, Int32, Int32, Int32[]) Method

Reference

Definition

Namespace:: Android.Views

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Dispatch one step of a nested scroll in progress.

[Android.Runtime.Register("dispatchNestedScroll", "(IIII[I)Z", "GetDispatchNestedScroll_IIIIarrayIHandler")]
public virtual bool DispatchNestedScroll (int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed, int[]? offsetInWindow);

[<Android.Runtime.Register("dispatchNestedScroll", "(IIII[I)Z", "GetDispatchNestedScroll_IIIIarrayIHandler")>]
abstract member DispatchNestedScroll : int * int * int * int * int[] -> bool
override this.DispatchNestedScroll : int * int * int * int * int[] -> bool

Parameters

dxConsumed: Int32

Horizontal distance in pixels consumed by this view during this scroll step

dyConsumed: Int32

Vertical distance in pixels consumed by this view during this scroll step

dxUnconsumed: Int32

Horizontal scroll distance in pixels not consumed by this view

dyUnconsumed: Int32

Horizontal scroll distance in pixels not consumed by this view

offsetInWindow: Int32[]

Optional. If not null, on return this will contain the offset in local view coordinates of this view from before this operation to after it completes. View implementations may use this to adjust expected input coordinate tracking.

Returns

Boolean

true if the event was dispatched, false if it could not be dispatched.

Attributes: RegisterAttribute

Remarks

Dispatch one step of a nested scroll in progress.

Implementations of views that support nested scrolling should call this to report info about a scroll in progress to the current nested scrolling parent. If a nested scroll is not currently in progress or nested scrolling is not #isNestedScrollingEnabled() enabled for this view this method does nothing.

Compatible View implementations should also call #dispatchNestedPreScroll(int, int, int[], int[]) dispatchNestedPreScroll before consuming a component of the scroll event themselves.

Java documentation for android.view.View.dispatchNestedScroll(int, int, int, int, int[]).

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