Partager via

msSiteModeAddButtonStyle method

  • Article

Defines an alternate icon image and tooltip for the specified button.

This method is not supported for Windows apps using JavaScript.

 

Syntax

VARIANT retVal = object.msSiteModeAddButtonStyle(uiButtonID, bstrIconUrl, pvarTooltip);

Parameters

  • uiButtonID [in]
    Type: VARIANT

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

  • bstrIconUrl [in]
    Type: BSTR

    An absolute or relative URI of an icon resource.

  • pvarTooltip [in, optional]
    Type: VARIANT

    A description of the button.

Standards information

There are no standards that apply here.

Remarks

A button style consists of an additional icon and tooltip for a button position. The IShellUIHelper4::msSiteModeAddButtonStyle method only creates button styles; to apply them, call IShellUIHelper4::msSiteModeShowButtonStyle. The original icon and tooltip are automatically saved as Style 0 and do not need to be added again.

The button returns the same button ID no matter which button style is displayed. To perform the correct action, your application will need to retain the button state internally.

The icon is downloaded asynchronously. If the download fails, a blank button is used instead.

See also

Reference

IShellUIHelper4::msSiteModeAddThumbBarButton

IShellUIHelper4::msSiteModeShowButtonStyle