focusPrimaryTabByName()

Usage

Focuses the browser on a primary tab that is already open with the specified name. This method is only available in API version 22.0 or later.

Syntax

1sforce.console.focusPrimaryTabByName(name:String, (optional)callback:Function)

Arguments

Name	Type	Description
name	string	Name of the primary tab to go to.
callback	function	JavaScript method called upon completion of the method.

Sample Code–Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");<apex:page standardController="Case">
2
3     <A HREF="#" onClick="testFocusPrimaryTabByName();return false">
4         Click here to go to a primary tab by name</A> 
5
6    <apex:includeScript value="/support/console/22.0/integration.js"/>
7    <script type="text/javascript">
8        function testFocusPrimaryTabByName() {
9            //Get the value for 'myPrimaryTab' from the openPrimaryTab method
10            //This value is for example purposes only
11            var primaryTabName = 'myPrimaryTab';
12            sforce.console.focusPrimaryTabByName(primaryTabName, focusSuccess);
13        }
14        
15        var focusSuccess = function focusSuccess(result) {
16            //Report whether going to the primary tab was successful
17            if (result.success == true) {
18                alert('Going to the primary tab was successful');
19            } else {
20                alert('Going to the Primary tab was not successful');
21            }
22        };
23        
24  </script>
25
26</apex:page>

This example is set to run by clicking a custom link on a case. For more information, see “Defining Custom Buttons and Links” in the Salesforce online help.

Note

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 going to the primary tab was successful; `false` if going to the primary tab wasn't successful.

Salesforce Console Integration Toolkit Developer's Guide