この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

openSubtab()

指定された URL (相対または絶対) のコンテンツを表示する新しいサブタブ (主タブ内) を開きます。また、既存のサブタブを上書きすることもできます。主タブの ID を使用して主タブで新しいサブタブを開く場合に使用します。このメソッドは、API バージョン 20.0 以降でのみ使用できます。

タブを開くときにエラーが発生した場合、JavaScript コンソールでエラーコードがレポートされます。

構文

1sforce.console.openSubtab(primaryTabId:String, url:URL, active:Boolean, tabLabel:String, id:String, (optional)callback:Function, (optional)name:String)

引数

名前	型	説明
primaryTabId	string	サブタブが開いている主タブの ID。
url	URL	開いているサブタブの URL。 URL が Salesforce オブジェクトを対象としている場合、そのオブジェクトは、Salesforce コンソールアプリケーション設定で指定したように表示されます。たとえば、ケースを主タブとして開くように設定している場合、ケースで `openSubtab()` がコールされると、ケースは主タブとして開きます。ユーザーは、コンソールの許可リストに追加されている外部 URL を開くことができます。相対 URL を使用する場合は、URL の先頭に必ず「`/`」を含めてください。Visualforce ページを参照する場合は、URL の先頭で「`/apex/`」を使用してください。このように指定しない場合、URL が期待どおりに動作しない場合があります。メモ
active	boolean	`true` の場合、開いているサブタブがすぐに表示されます。`false` の場合、開いているサブタブがバックグラウンドで表示��れ、フォーカスは現在のタブに残ります。
tabLabel	string	開いているサブタブの表示ラベル (省略可能)。表示ラベルが指定されていないと、`外部ページ`が表示されます。表示ラベルをテキストとして追加します。HTML はサポートされていません。
id	string	上書きするサブタブの ID。新しいサブタブを作成するには、`null` を使用します。
callback	function	メソッドの完了時にコールされる JavaScript メソッド。
name	string	開いているサブタブの名前 (省略可能)。この引数は、API バージョン 22.0 以降でのみ使用できます。

サンプルコード – Visualforce

1<apex:page standardController="Case">
2
3    <A HREF="#" onClick="testOpenSubtab();return false">
4        Click here to open a new subtab</A> 
5
6    <apex:includeScript value="/support/console/60.0/integration.js"/>
7    <script type="text/javascript">
8        function testOpenSubtab() {
9            //First find the ID of the primary tab to put the new subtab in
10            sforce.console.getEnclosingPrimaryTabId(openSubtab);
11        }
12        
13        var openSubtab = function openSubtab(result) {
14            //Now that we have the primary tab ID, we can open a new subtab in it
15            var primaryTabId = result.id;
16            sforce.console.openSubtab(primaryTabId , 'https://salesforce.com', false, 
17                'salesforce', null, openSuccess, 'salesforceSubtab');
18        };
19        
20        var openSuccess = function openSuccess(result) {
21            //Report whether we succeeded in opening the subtab
22            if (result.success == true) {
23                alert('subtab successfully opened');
24            } else {
25                alert('subtab cannot be opened');
26            }
27        };
28    </script>
29</apex:page>

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

メモ

応答

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

名前	型	説明
success	boolean	サブタブが正常に開かれた場合は `true`、サブタブが開かれなかった場合は `false`。
id	string	サブタブの ID。ID はユーザーセッションの間のみ有効です。ユーザーが Salesforce コンソールから離れると ID は無効になります。

Salesforce コンソール開発者ガイド

openSubtab()

構文

引数

サンプルコード – Visualforce

応答