closeTab()

指定された主タブまたはサブタブを閉じます。主タブの最初のタブを閉じると、主タブそのものが閉じるので注意してください。このメソッドは、API バージョン 20.0 以降でのみ使用できます。

構文

主タブが固定されているときの動作はユーザーインターフェースと API で異なります。UI では、主タブが固定されていても、マウスを使用してサブタブを閉じることができます。API では、主タブが固定されていると、サブタブを閉じることができません。

メモ

1sforce.console.closeTab(id:String, (optional) callback:Function)

引数

名前 型 説明
id string 閉じる主タブまたはサブタブの ID。
callback function API バージョン 35.0 以降の場合は、メソッドの完了時にコールされる JavaScript メソッド。

サンプルコード API 20.0 以降 – Visualforce

1<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/60.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>

この例を実際に確認するには、ケースのカスタムリンクをクリックします。詳細は、Salesforce ヘルプの「カスタムボタンとカスタムリンクの定義」を参照してください。

メモ

応答

なし

サンプルコード API バージョン 35.0 以降 – Visualforce

1<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/60.0/integration.js"/>
6    <script type="text/javascript">
7         var callback = function () {
8             if (result.error) {
9		        alert("Error message is " + result.error);
10             }
11         };
12        function testCloseTab() {
13            //First find the ID of the current tab to close it
14            sforce.console.getEnclosingTabId(closeSubtab);
15         }
16
17        var closeSubtab = function closeSubtab(result) {
18            //Now that we have the tab ID, we can close it
19            var tabId = result.id;
20            sforce.console.closeTab(tabId, callback);
21        };
22    </script>
23</apex:page>

この例を実際に確認するには、ケースのカスタムリンクをクリックします。詳細は、Salesforce ヘルプの「カスタムボタンとカスタムリンクの定義」を参照してください。

メモ

応答

このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次の項目が含まれます。

名前 型 説明
success boolean タブが再び開いた場合は true、そうでない場合は false。
error string タブを閉じることができなかった場合のエラーメッセージ。

Firefox を使用する場合、有効なアラートボックスのあるタブで closeTab() をコールしないことをお勧めします。ブラウザーで正しく読み込まれない可能性があります。

ヒント