setSelectedNavigationTab()

Sets the navigation tab with a specific ID or URL. This method is only available in API version 31.0 or later.

Syntax

1sforce.console.setSelectedNavigationTab((optional)callback, navigatorTabId:(optional)string, url:(optional)string)

Arguments

Name	Type	Description
callback	function	JavaScript method that’s called upon completion of the method.
navigatorTabId	string	The ID of the navigation tab to be selected.
url	string	The URL of the navigation tab to be selected.

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>
18    <apex:includeScript value="/support/console/31.0/integration.js"/>
19    <script type="text/javascript">
20        var callback = function (result) {} 
21            if (result.success) {
22              alert('Successful');
23            } else {
24              alert('something is wrong!');
25            }
26        };
27        sforce.console.setSelectedNavigationTab(callback,'nav-tab-4');
28    </script>
29</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 navigation tab with a specific ID or URL was successful, `false` otherwise.

Salesforce Console Integration Toolkit Developer's Guide

setSelectedNavigationTab()

Syntax

Arguments

Sample Code–Visualforce

Response