Expand Minimize

WinJS.UI.disableAnimations function

Applies to Windows and Windows Phone

Disables all Animations Library and ListView animations. Calling this function does not guarantee that the animations will be disabled, as the determination is made based on several factors.

Syntax


WinJS.UI.disableAnimations();

Parameters

This method has no parameters.

Return value

This function does not return a value.

Remarks

The enableAnimations and disableAnimations functions allow apps to keep their custom animations in sync with the system accessibility setting used by the Animations Library. (The system accessibility setting is the "Turn off all unneccesary animations (when possible)" option found in the Ease of Access Center in Control Panel, and can be retrieved through the Windows.UI.ViewManagement.UISettings.animationsEnabled property.) This function also allows apps that run in the web context to enable or disable animations to respect the system accessibility setting. Normally, this is done automatically, but the system accessibility setting cannot be accessed by the web context, so the app must enable or disable animations manually.

See isAnimationEnabled for a full discussion of how the disableAnimations function is used with the system accessibility setting to determine whether animations should be enabled or disabled.

Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1

Namespace

WinJS.UI

Library

Base.js

See also

enableAnimations
isAnimationEnabled
HTML animation library sample
HTML ListView essentials sample

 

 

Show:
© 2014 Microsoft