msSiteModeShowJumpList method

Article
08/15/2017

Shows updates to the list of items in a Jump List.

Syntax

*object.*msSiteModeShowJumpList()

Parameters

This method has no parameters.

Return value

Type: HRESULT

This method can return one of these values.

Return code	Description
E_NOTIMPL	This method is not supported on Windows CE.

Remarks

The msSiteModeShowJumpList method displays the list of items that are queued up by msSiteModeAddJumpListItem. The update occurs instantly.

This method triggers the onmssitemodejumplistitemremoved event, which is raised once for each item that has been removed by the user since the last time the msSiteModeShowJumpList method was called. This event is not raised if you call msSiteModeClearJumpList first.

Note To view the Jump List, hover over the pinned site shortcut after you pin it to the Start menu, or right-click the pinned site button in the Windows taskbar.

Examples

The following code example creates two "pending approvals" and shows the Jump List. To alert the user to important action items, it also creates a icon overlay to display the number of pending actions. (See msSiteModeSetIconOverlay.)

function initApp() {
    if (window.external.msIsSiteMode()) {
        // Create empty jump list
        window.external.msSiteModeCreateJumpList("Pending Approvals");
        
        // Populate the dynamic jump list with the two pending approvals.
        window.external.msSiteModeAddJumpListItem("Omid Aziz",'/pending_approval_1.htm','Images/user1.ico');
        window.external.msSiteModeAddJumpListItem("Alex Malek",'pending_approval_2.htm','Images/user2.ico');
                                
        // Show the Jump List.
        window.external.msSiteModeShowJumplist();
        
        // Set the overlay icon to show 2 pending approvals.
        window.external.msSiteModeSetIconOverlay('Images/num_2.ico', "Pending Approvals");
    }
}
window.onload = initApp;