External.templateBeingDisplayedInLocalLibrary

[The feature associated with this page, Windows Media Player SDK, is a legacy feature. It has been superseded by MediaPlayer. MediaPlayer has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer instead of Windows Media Player SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Note

This topic describes functionality designed for use by online stores. Use of this functionality outside the context of an online store is not supported.

The templateBeingDisplayedInLocalLibrary property indicates whether the feed represented by the current discovery page is being displayed in the local library tree-view control.

Syntax

window.external.templateBeingDisplayedInLocalLibrary

Possible Values

This property is a read-only Boolean. TRUE indicates that the feed is being displayed in the local library tree-view control.

Remarks

A discovery page that represents a feed for a dynamic playlist can display a button that allows the user to "save" the feed in his or her local library. Saving the feed, in this context, means that some metadata is saved on the user's computer, and the feed is listed under the Playlists node in the local library tree-view control. Script on the discovery page can inspect the templateBeingDisplayedInLocalLibrary property to determine whether the user has already saved the feed in the local library. If the user has already saved the feed, the discovery page should not display the save button.

A discovery page that represents a radio feed should inspect the templateBeingDisplayedInLocalLibrary property for the same reason.

Requirements

Requirement	Value
Version	Windows Media Player 11
DLL	Wmp.dll

See also

External Object for Type 1 Online Stores