Salesforce Console Integration Toolkit Developer's Guide
jNewer Version Available
focusPrimaryTabByName()
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 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="testFocusPrimaryTabByName();return false">
20 Click here to go to a primary tab by name</A>
21
22 <apex:includeScript value="/support/console/22.0/integration.js"/>
23 <script type="text/javascript">
24 function testFocusPrimaryTabByName() {
25 //Get the value for 'myPrimaryTab' from the openPrimaryTab method
26 //This value is for example purposes only
27 var primaryTabName = 'myPrimaryTab';
28 sforce.console.focusPrimaryTabByName(primaryTabName, focusSuccess);
29 }
30
31 var focusSuccess = function focusSuccess(result) {
32 //Report whether going to the primary tab was successful
33 if (result.success == true) {
34 alert('Going to the primary tab was successful');
35 } else {
36 alert('Going to the Primary tab was not successful');
37 }
38 };
39
40 </script>
41
42</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 going to the primary tab was successful; false if going to the primary tab wasn't successful. |