Salesforce Console Integration Toolkit Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

setTabStyle()

Usage

Sets a cascading style sheet (CSS) on the specified tab. If a tab is not specified, the CSS is set on the enclosing tab. Use this method to customize a tab’s look and feel. This method is only available in API version 28.0 or later.

Syntax

Arguments

Name Type Description
style string A CSS specification string used to style the tab. If null or undefined, the tab’s default style is used.
tabId string The ID of the tab on which to set the style. If null or undefined, the enclosing tab’s ID is used.
callback function JavaScript method called upon completion of the method.

Sample Code–Visualforce

Response

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 style was successful, false if setting the tab’s style 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.

Note