focusSubtabByNameAndPrimaryTabName()

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

Syntax

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

Arguments

Name	Type	Description
name	string	Name of the subtab to go to.
primaryTabName	string	Name of the primary tab in which the subtab opened.
callback	function	JavaScript method that’s called upon completion of the method.

Sample Code–Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page standardController="Case">
18
19     <A HREF="#" onClick="testFocusSubtabByNameAndPrimaryTabName();return false">
20         Click here to go to a subtab by name and primary tab name</A> 
21
22    <apex:includeScript value="/support/console/22.0/integration.js"/>
23    <script type="text/javascript">
24        function testFocusSubtabByNameAndPrimaryTabName() {
25            //Get the value for 'mySubtab' and 'myPrimaryTab' from the openSubtab method
26            //These values are for example purposes only
27            var subtabName = 'mySubtab';
28            var primaryTabName = 'myPrimaryTab';
29            sforce.console.focusSubtabByNameAndPrimaryTabName(subtabName, primaryTabName, focusSuccess);
30        }
31        
32        var focusSuccess = function focusSuccess(result) {
33            //Report whether going to the subtab was successful
34            if (result.success == true) {
35                alert('Going to the subtab was successful');
36            } else {
37                alert('Going to the subtab was not successful');
38            }
39        };
40        
41  </script>
42
43</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 subtab was successful; `false` if going to the subtab wasn't successful.

Salesforce Console Integration Toolkit Developer's Guide

focusSubtabByNameAndPrimaryTabName()

Syntax

Arguments

Sample Code–Visualforce

Response