setTabTextStyle()

Usage

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

Syntax

1sforce.console. setTabTextStyle(style:String, tabID:String, (optional)callback:Function))

Arguments

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

Sample Code–Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");<apex:page>
2    <A HREF="#" onClick="testSetTabTextStyle();return false">
3         Click here to change the enclosing tab’s text style</A> <BR/>
4    <A HREF="#" onClick="testResetTabTextStyle(); return false;">
5         Click here to reset the enclosing tab’s text style</A>
6
7    <apex:includeScript value="/support/console/28.0/integration.js"/>
8    <script type="text/javascript">
9        function checkResult(result) { 
10            if (result.success) {
11               alert('Tab text style set successfully!');
12            } else {
13               alert('Tab text style cannot be set!');
14            }
15    }
16        function testSetTabTextStyle() {
17            sforce.console.setTabTextStyle('color:blue;font-style:italic;', null, checkResult);
18    }
19        function testResetTabTextStyle() {
20            sforce.console.setTabTextStyle(null, null, checkResult);
21    }
22    </script>
23</apex:page>

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

Salesforce Console Integration Toolkit Developer's Guide