setTabIcon()
Sets an icon on the specified tab. If a tab is not specified, the icon is set on the enclosing tab. Use this method to customize a tab’s icon. This method is only available in API version 28.0 or later.
| Name | Type | Description |
|---|---|---|
iconUrl | string | A URL pointing to an image, which is used as the tab’s icon. If null or undefined, the tab’s default icon is used. |
tabId | string | The ID of the tab on which to set the icon. If null or undefined, the enclosing tab’s ID is used. |
callback | function | JavaScript method that’s called upon completion of the method. |
This method is asynchronous, so it returns its response in an object in a callback method. The response object contains the following field:
| Name | Type | Description |
|---|---|---|
success | boolean | true if setting the tab’s icon was successful, false if setting the tab’s icon wasn’t successful. |
If this method is called without passing in a tab ID, the tab in which the Visualforce page is enclosed is used. If there isn’t an enclosing tab, the error message Cannot get a workspace or view tab from the given ID displays in the browser’s developer console.