メタデータ API 開発者ガイド
jWebLink
カスタムオブジェクト���定義されたカスタムボタンまたはリンクを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
バージョン
WebLink は、API バージョン 12.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| availability | WebLinkAvailability (string 型の列挙) | 必須。ボタンまたはリンクをオンラインでのみ使用できるか (online)、オフラインでも使用できるか (offline) を示します。 |
| description | string | ボタンまたはリンクの説明。 |
| displayType | WebLinkDisplayType (string 型の列挙) |
ボタンまたはリンクの表示方法を表します。有効な値は、次のとおりです。
|
| encodingKey | Encoding (string 型の列挙) |
必須。デフォルトの文字コード設定は Unicode (UTF-8) です。テンプレートが別形式のデータを必要とする場合は、この設定を変更します。この指定は、コンテンツソースが URL の場合に使用できます。
使用できる値は次のとおりです。
|
| fullName | string | 有効性のために空白と特殊文字がエスケープされたカスタムボタンまたはリンクの名前。名前には、英数字、およびアンダースコア (_) 文字のみを使用できます。また、最初は英字とし、アンダースコア文字を連続して使用したり、最後に使用したりすることはできません。 この項目はMetadata コンポーネントから継承するため、この項目はこのコンポーネントの WSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。 |
| 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 である場合、この項目はウィンドウにブラウザのロケーションバーを表示するか (true)、否か (false) を示します。それ以外の場合は、この項目を空のままにします。 |
| showsStatus | boolean | openType が newWindow である場合、この項目はウィンドウにブラウザのステータスバーを表示するかどうかを示します。それ以外の場合は、この項目を空のままにします。 |
| url | string |
linkType が url である場合、これは URL 値です。linkType の値が javascript である場合、これは JavaScript コンテンツです。値がこのいずれでもない場合、この項目を空のままにします。 コンテンツは、XML 解析ルールと同じ方法でエスケープする必要があります。 |
| width | int | ボタンまたはリンクによって開かれたウィンドウの幅 (ピクセル単位)。 openType が newWindow である場合は必須です。それ以外の場合は、この項目を空のままにします。 |
宣言的なメタデータの定義のサンプル
カスタムオブジェクト内の WebLink の定義を次に示します。関連するサンプルについては、「HomePageComponent」「宣言的なメタデータの定義のサンプル」および「HomePageLayout」の「宣言的なメタデータの定義のサンプル」を参照してください。