ListView.oncontentanimating event

Article
01/26/2017

Raised when the ListView is about to play an entrance or contentTransition animation.

Syntax

<div data-win-control="WinJS.UI.ListView" data-win-options="{oncontentanimating : handler}" />

function handler(eventInfo) { /* Your code */ }
 
// addEventListener syntax
listView.addEventListener("contentanimating", handler);
listView.removeEventListener("contentanimating", handler);
 
- or -

listView.oncontentanimating = handler;

Event information

Synchronous	No
Bubbles	Yes
Cancelable	Yes

Event handler parameters

eventInfo
Type: CustomEvent**

An object that contains info about the event. The detail property of this object contains the following sub-properties:

Property	Meaning
detail.type	A ListViewAnimationType value that specifies the type of animation that's about to play.
detail.setPromise	A function that takes a Promise as a parameter. The animation will be delayed until this Promise completes. This function is only available for the entrance animation type.

Remarks

ListView events execute synchronously, so avoid performing expensive operations in your event handler. Performing expensive operations in your event handler can make the ListView seem unresponsive to the user. If you need the event handler to perform an expensive operation, call setImmediate from your event handler and pass it a function that performs the operation or perform the operation as an asynchronous operation. For more info about asynchronous programming, see Asynchronous programming in JavaScript.

Setting event handlers declaratively (in HTML)

To set the event handler declaratively, it must be accessible to the global scope, and you must also call WinJS.Utilities.markSupportedForProcessing or WinJS.UI.eventHandler on the handler. You can make the handler accessible to the global scope by using WinJS.Namespace.define. For more info, see How to set event handlers declaratively.

Requirements

Minimum WinJS version	WinJS 3.0
Namespace	WinJS.UI

Share via