This topic has not yet been rated - Rate this topic

msSiteModeShowButtonStyle method

[This documentation is preliminary and is subject to change.]

Changes the icon image and tooltip of a Thumbnail Toolbar button.

This method is not supported for Metro style apps using JavaScript.

Syntax

object.msSiteModeShowButtonStyle(uiButtonID, uiStyleID)

Standards information

There are no standards that apply here.

Parameters

uiButtonID [in]

Type: VARIANT

The ID of a button that is previously installed with msSiteModeAddThumbBarButton.

uiStyleID [in]

Type: VARIANT

The style ID that msSiteModeAddButtonStyle returns.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The original icon and tooltip are assigned to Style 0; you can reset to the original button style by passing 0 in the uiStyleID parameter. Applying a button style will also reset the button state to active and visible.

Examples

The following script changes the Thumbnail Toolbar button style depending on whether an audio control is playing or paused. The value of stylePlay and stylePause are set by a prior call to the msSiteModeAddButtonStyle method.

Copy



function playPause() {
    var audio = document.getElementById("myAudioElement");
    if (audio.paused) {
        audio.play();
    }
    else {
        audio.pause();
    }
    try {
        if (window.external.msIsSiteMode()) {
            if (audio.paused) {
                window.external.msSiteModeShowButtonStyle(btnPlayPause, stylePlay);
            }
            else {
                window.external.msSiteModeShowButtonStyle(btnPlayPause, stylePause);
            }
        }
    }
    catch (e) {
        // Fail silently.
    }
}