メタデータ API 開発者ガイド
jHomePageComponent
ホームページコンポーネントに関連付けられたメタデータを表します。[ホーム] タブにサイドバーリンク、会社のロゴ、ダッシュボードのスナップショット、作成したカスタムコンポーネントなどのコンポーネントを含めるようにカスタマイズできます。詳細は、Salesforce オンラインヘルプの「[ホーム] タブのページレイアウトのカスタマイズ」を参照してください。Metadata メタデータ型を拡張し、その fullName 項目を継承します。ホームページコンポーネントの定義を作成、更新または削除するために使用します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
ホームページコンポーネントのファイルのサフィックスは .homePageComponent で、コンポーネントは対応するパッケージディレクトリの homepagecomponents ディレクトリに保存されます。
バージョン
ホームページコンポーネントは、API バージョン 12.0 以降で使用できます。
HomePageComponent
このメタデータ型はホームページコンポーネントを定義する有効な値を表します。
| 項目名 | データ型 | 説明 |
|---|---|---|
| body | string | これが HTML ページコンポーネントである場合、これは HTML の本文です。 |
| fullName | string |
名前には、英数字、およびアンダースコア (_) 文字のみを使用できます。また、最初は文字とし、最後にアンダースコアを使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。 この項目はMetadata コンポーネントから継承するため、この項目はこのコンポーネントの WSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。 |
| height | int |
Visualforce エリアコンポーネントで必須。コンポーネントの高さ (ピクセル単位) を示します。 この項目は API バージョン 31.0 以降で使用できます。 |
| links | string[] |
pageComponentType が links の場合は、カスタムページリンクの 0 個以上の名前を指定できます。
|
| page | string | この項目は Visualforce エリアコンポーネントでのみ使用可能で、コンポーネントに関連付けられている Visualforce ページの API 名を示します。 この項目は API バージョン 31.0 以降で使用できます。 |
| pageComponentType | PageComponentType (string 型の列挙) | 必須。有効な値は、次のとおりです。
|
| showLabel | boolean | この項目は Visualforce エリアコンポーネントでのみ使用可能で、コンポーネントがラベル付きで表示されるか (true)、否か (false) を指定します。 この項目は API バージョン 31.0 以降で使用できます。 |
| showScrollbars | boolean | この項目は Visualforce エリアコンポーネントでのみ使用可能で、コンポーネントがスクロールバー付きで表示されるか (true)、否か (false) を指定します。 この項目は API バージョン 31.0 以降で使用できます。 |
| width | PageComponentWidth (string 型の enumeration) | この項目は HTML および Visualforce エリアコンポーネントでのみ使用可能で、これが幅の狭いまたは広いホームページコンポーネントであるかどうかを示します。有効な値は、次のとおりです。
|
宣言的なメタデータの定義のサンプル
ホームページコンポーネントの定義を次に示します。関連するサンプルについては、「HomePageLayout」の「宣言的なメタデータの定義のサンプル」および「Weblink」の「宣言的なメタデータの定義のサンプル」を参照してください。
1<?xml version="1.0" encoding="UTF-8"?>
2<HomePageComponent xmlns="http://soap.sforce.com/2006/04/metadata">
3 <height>200</height>
4 <page>MyVisualforcePage</page>
5 <pageComponentType>visualforcePage</pageComponentType>
6 <showLabel>true</showLabel>
7 <showScrollbars>true</showScrollbars>
8 <width>wideComponents</width>
9</HomePageComponent>