setTabTextStyle()

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

sforce.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

<apex:page>
    <A HREF="#" onClick="testSetTabTextStyle();return false">
         Click here to change the enclosing tab’s text style</A> <BR/>
    <A HREF="#" onClick="testResetTabTextStyle(); return false;">
         Click here to reset the enclosing tab’s text style</A>

    <apex:includeScript value="/support/console/68.0/integration.js"/>
    <script type="text/javascript">
        function checkResult(result) { 
            if (result.success) {
               alert('Tab text style set successfully!');
            } else {
               alert('Tab text style cannot be set!');
            }
    }
        function testSetTabTextStyle() {
            sforce.console.setTabTextStyle('color:blue;font-style:italic;', null, checkResult);
    }
        function testResetTabTextStyle() {
            sforce.console.setTabTextStyle(null, null, checkResult);
    }
    </script>
</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.

note: 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.