Newer Version Available

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

closeTab()

Closes a specified primary tab or subtab. Note that closing the first tab in a primary tab closes the primary tab itself. This method is only available in API version 20.0 or later.

Syntax

1sforce.console.closeTab(id:String)

Arguments

Name Type Description
id string ID of the primary tab or subtab to close.

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    <A HREF="#" onClick="testCloseTab();return false">
19           Click here to close this tab</A> 
20
21    <apex:includeScript value="/support/console/20.0/integration.js"/>
22    <script type="text/javascript">
23        function testCloseTab() {
24            //First find the ID of the current tab to close it
25            sforce.console.getEnclosingTabId(closeSubtab);
26        }
27        
28        var closeSubtab = function closeSubtab(result) {
29            //Now that we have the tab ID, we can close it
30            var tabId = result.id;
31            sforce.console.closeTab(tabId);
32        };
33    </script>
34</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

None

When using Firefox, we recommend that you don't call closeTab() on a tab with an active alert box because the browser may not load properly.

Tip