Android.Views.View.StartNestedScroll Method
Begin a nestable scroll operation along the given axes.

Syntax

[Android.Runtime.Register("startNestedScroll", "(I)Z", "GetStartNestedScroll_IHandler")]
public virtual bool StartNestedScroll ([Android.Runtime.GeneratedEnum] ScrollAxis axes)

See Also

View.StopNestedScroll
View.DispatchNestedPreScroll(int, System.Int32, System.Int32, System.Int32)
View.DispatchNestedScroll(int, System.Int32, System.Int32, System.Int32, System.Int32)

Parameters

axes
Flags consisting of a combination of View.ScrollAxisHorizontal and/or View.ScrollAxisVertical.

Returns

Documentation for this section has not yet been entered.

Remarks

Begin a nestable scroll operation along the given axes.

A view starting a nested scroll promises to abide by the following contract:

The view will call startNestedScroll upon initiating a scroll operation. In the case of a touch scroll this corresponds to the initial MotionEvent.ACTION_DOWN. In the case of touch scrolling the nested scroll will be terminated automatically in the same manner as IViewParent.RequestDisallowInterceptTouchEvent(bool). In the event of programmatic scrolling the caller must explicitly call View.StopNestedScroll to indicate the end of the nested scroll.

If startNestedScroll returns true, a cooperative parent was found. If it returns false the caller may ignore the rest of this contract until the next scroll. Calling startNestedScroll while a nested scroll is already in progress will return true.

At each incremental step of the scroll the caller should invoke View.DispatchNestedPreScroll(int, System.Int32, System.Int32, System.Int32) once it has calculated the requested scrolling delta. If it returns true the nested scrolling parent at least partially consumed the scroll and the caller should adjust the amount it scrolls by.

After applying the remainder of the scroll delta the caller should invoke View.DispatchNestedScroll(int, System.Int32, System.Int32, System.Int32, System.Int32), passing both the delta consumed and the delta unconsumed. A nested scrolling parent may treat these values differently. See IViewParent.OnNestedScroll(View, System.Int32, System.Int32, System.Int32, System.Int32).

[Android Documentation]

Requirements

Namespace: Android.Views
Assembly: Mono.Android (in Mono.Android.dll)
Assembly Versions: 0.0.0.0
Since: Added in API level 1