getEnclosingTabId()

Usage

Returns the ID of the tab that contains the current Visualforce page, which may be a primary tab or subtab. This method will work if the call is made within a component enclosed within a subtab. This method is only available in API version 20.0 or later.

Syntax

1sforce.console.getEnclosingTabId()

Arguments

Name	Type	Description
callback	function	JavaScript method called upon completion of the method.

Sample Code–Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");<apex:page standardController="Case">
2    <A HREF="#" onClick="testCloseTab();return false">
3        Click here to close this tab</A> 
4
5    <apex:includeScript value="/support/console/20.0/integration.js"/>
6    <script type="text/javascript">
7        function testCloseTab() {
8            //First find the ID of the current tab to close it
9            sforce.console.getEnclosingTabId(closeSubtab);
10        }
11        
12        var closeSubtab = function closeSubtab(result) {
13            //Now that we have the tab ID, we can close it
14            var tabId = result.id;
15            sforce.console.closeTab(tabId);
16        };
17    </script>
18</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
id	string	The ID of the current primary tab or subtab.

Salesforce Console Integration Toolkit Developer's Guide