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

setTabIcon()

指定されたタブにアイコンを設定します。タブが指定されていない場合、アイコンは囲んでいるタブに設定されます。このメソッドを使って、タブのアイコンをカスタマイズします。このメソッドは、API バージョン 28.0 以降でのみ使用できます。

構文

1sforce.console.setTabIcon(iconUrl:String, tabID:String, (optional)callback:Function)

引数

名前	型	説明
iconUrl	string	タブのアイコンとして使用される画像を指し示す URL。null または未定義の場合、タブのデフォルトアイコンが使用されます。
tabId	string	アイコンを設定するタブの ID。null または未定義の場合、囲んでいるタブの ID が使用されます。
callback	function	メソッドの完了時にコールされる JavaScript メソッド。

サンプルコード – Visualforce

1<apex:page>
2    <A HREF="#" onClick="testSetTabIcon();return false">
3         Click here to change the enclosing tab’s icon</A> <BR/>
4    <A HREF="#" onClick="testResetTabIcon(); return false;">
5         Click here to reset the enclosing tab’s icon</A>
6
7    <apex:includeScript value="/support/console/56.0/integration.js"/>
8    <script type="text/javascript">
9        function checkResult(result) { 
10            if (result.success) {
11               alert('Tab icon set successfully!');
12            } else {
13               alert('Tab icon cannot be set!');
14            }
15    }
16        function testSetTabIcon() {
17            sforce.console.setTabIcon('http://host/path/to/your/icon.png', null, checkResult);
18    }
19        function testResetTabIcon() {
20            sforce.console.setTabIcon(null, null, checkResult);
21    }
22    </script>
23</apex:page>

応答

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

名前	型	説明
success	boolean	タブのアイコンの設定に成功した場合は `true`、タブのアイコンの設定に失敗した場合は `false`。

タブ ID を渡さずにこのメソッドをコールすると、Visualforce ページを囲んでいるタブが使用されます。囲んでいるタブがない場合、ブラウザの開発者コンソールに Cannot get a workspace or view tab from the given ID (指定された ID で [ワークスペース] タブまたは [ビュー] タブを取得できません) というエラーメッセージが表示されます。

メモ

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

setTabIcon()

構文

引数

サンプルコード – Visualforce

応答