External.NavigateTaskPaneURL method

Article
4/26/2023

[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 NavigateTaskPaneURL method opens a webpage in the specified task pane, and changes focus to the specified pane.

Syntax

External.NavigateTaskPaneURL(
  bstrKeyName,
  bstrTaskPane,
  bstrParams
)

Parameters

bstrKeyName [in]: String containing the key name for the online store. (required)
bstrTaskPane [in]: String containing the name of the task pane in which the webpage opens. (required)
bstrParams [in]: String containing the query string parameters to append to the URL specified by the Navigate element of the ServiceInfo document. (optional)

Return value

This method does not return a value.

Remarks

Navigating to a pane that your online store does not support may cause the current online store to change.

The value specified for bstrParams is valid only when NavigateTaskPaneURL is called from webpages provided by the online store.

The following table lists of valid values for bstrTaskPane and the associated task pane for each.

Value	Task Pane
ServiceTask1	First online store task pane.
ServiceTask2	Second online store task pane.
ServiceTask3	Third online store task pane.

Your webpage code should specify a value for External.SelectedTaskPane when loading to ensure that the correct task pane button is highlighted after navigation is completed.

Examples

The following example code shows how NavigateTaskPaneURL creates the URL of the webpage to display for ServiceTask1.

Example of the Navigate element:

<Navigate
    BaseURL = "https://www.proseware.com/online store/html/navigate.asp">
</Navigate>

Example call to the NavigateTaskPaneURL method:

external.NavigateTaskPaneURL("Proseware", "ServiceTask1", "Pane=Store");

Example of resulting URL used for the webpage displayed in ServiceTask1:

https://www.proseware.com/online store/html/navigate.asp?Pane=Store

Requirements

Requirement	Value
Version	Windows Media Player 10 or later
DLL	Wmp.dll

Share via