メタデータ API 開発者ガイド
jCustomPageWebLink
その他のすべてのカスタムリンクは、CustomObject に WebLink として保存されます。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
カスタムリンクの定義あたり 1 つのファイルがあり、対応するパッケージディレクトリの weblinks フォルダに保存されます。ファイルのサフィックスは、.weblink です。
バージョン
CustomPageWebLink は、API バージョン 13.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| availability | WebLinkAvailability (string 型の列挙) | 必須。リンクをオンラインでのみ使用できるか (online)、オフラインでも使用できるか (offline) を示します。 |
| description | string | リンクの説明。 |
| displayType | WebLinkDisplayType (string 型の列挙) | このリンクの表示方法を表します。 有効な値は次のとおりです。
|
| encodingKey | Encoding (string 型の列挙) | 必須。デフォルトの文字コード設定は Unicode (UTF-8) です。テンプレートが別形式のデータを必要とする場合は、この設定を変更します。この指定は、コンテンツソースが URL の場合に使用できます。使用できる値は次のとおりです。
|
| fullName | string | API アクセスの一意の識別子として使用される名前。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。 |
| hasMenubar | boolean | openType が newWindow である場合、この項目はウィンドウにブラウザメニューバーを表示するか (true)、否か (false) を示します。それ以外の場合は、この項目を空のままにします。 |
| hasScrollbars | boolean | openType が newWindow である場合、この項目はウィンドウにスクロールバーを表示するか (true)、否か (false) を示します。それ以外の場合は、この項目を空のままにします。 |
| hasToolbar | boolean | openType が newWindow である場合、この項目はウィンドウにブラウザツールバーを表示するか (true)、否か (false) を示します。それ以外の場合は、この項目を空のままにします。 |
| height | int | リンクによって開かれたウィンドウの高さ (ピクセル単位)。openType が newWindow である場合は必須です。それ以外の場合は、この項目を空のままにします。 |
| isResizable | boolean | openType が newWindow である場合、この項目はウィンドウのサイズを変更できるか (true)、否か (false) を示します。それ以外の場合は、この項目を空のままにします。 |
| linkType | WebLinkType (string 型の列挙) | 必須。ボタンまたはリンクのコンテンツが URL、Sコントロール、JavaScript コードブロック、または Visualforce ページによって指定されているかどうかを表します。
|
| masterLabel | string | リンクのマスタ表示ラベル。 |
| openType | WebLinkWindowType (string 型の列挙) | 必須。この項目は、リンクがクリックされたときのコンテンツの表示に使用されるウィンドウのスタイルを指定します。 有効な値は、次のとおりです。
|
| page | string | linkType の値が page である場合、この項目は Visualforce ページを表します。それ以外の場合は、この項目を空のままにします。 |
| position | WebLinkPosition (string 型の列挙) |
openType が newWindow である場合、この項目は新規ウィンドウの表示方法を示します。それ以外の場合は、この項目を空のままにします。 有効な値は、次のとおりです。
|
| protected | boolean | 必須。このコンポーネントが保護されるか (true)、否か (false) を示します。保護コンポーネントは、インストールする組織で作成されたコンポーネントによってリンク設定したり参照したりすることはできません。 |
| requireRowSelection | boolean | openType が massAction である場合、この項目はこのボタンのアクションを実行するために個々の行を選択する必要があるか (true)、否か (false) を示します。それ以外の場合は、この項目を空のままにします。 |
| scontrol | string | linkType の値が sControl である場合、この項目は Sコントロールの名前を表します。それ以外の場合は、この項目を空のままにします。 |
| showsLocation | boolean | openType が newWindow である場合、この項目はウィンドウにブラウザのロケーションバーを表示するかどうかを示します。それ以外の場合は、この項目を空のままにします。 |
| showsStatus | boolean | openType が newWindow である場合、この項目はウィンドウにブラウザのステータスバーを表示するかどうかを示します。それ以外の場合は、この項目を空のままにします。 |
| url | string |
linkType の値が url である場合、この項目は URL 値を表します。linkType の値が javascript である場合、この項目は JavaScript コンテンツを表します。値がこのいずれでもない場合、この項目を空のままにします。 コンテンツは、XML 解析ルールと同じ方法でエスケープする必要があります。 |
| width | int | リンクによって開かれたウィンドウの幅 (ピクセル単位)。 openType が newWindow である場合は必須です。それ以外の場合は、この項目を空のままにします。 |
宣言的なメタデータの定義のサンプル
Web リンクの定義を次に示します。関連するサンプルについては、「HomePageComponent」および「HomePageLayout」を参照してください。
1<?xml version="1.0" encoding="UTF-8"?>
2<CustomPageWebLink xmlns="http://soap.sforce.com/2006/04/metadata">
3 <availability>online</availability>
4 <displayType>button</displayType>
5 <encodingKey>UTF-8</encodingKey
6 <hasMenubar>false</hasMenubar>
7 <hasScrollbars>true</hasScrollbars>
8 <hasToolbar>false</hasToolbar>
9 <height>600</height>
10 <isResizable>true</isResizable>
11 <linkType>url</linkType>
12 <masterLabel>detailPageButon</masterLabel>
13 <openType>newWindow</openType>
14 <position>none</position>
15 <protected>false</protected>
16 <showsLocation>false</showsLocation>
17 <showsStatus>false</showsStatus>
18 <url>http://google.com</url>
19</CustomPageWebLink>