Newer Version Available

This content describes an older version of this product. View Latest

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

1<apex:page>
2    <apex:includeScript value="/support/console/51.0/integration.js"/>
3    <script type="text/javascript">
4        var callback = function (result) {} 
5            if (result.success) {
6              alert('Successful');
7            } else {
8              alert('something is wrong!');
9            }
10        };
11        sforce.console.setSelectedNavigationTab(callback,'nav-tab-4');
12    </script>
13</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.