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

メタデータ API 開発者ガイド

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Weblink

カスタムオブジェクトに定義された Web リンクを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

バージョン

Web リンクは、API バージョン 12.0 以降で使用できます。

項目

Web リンクの定義には次の項目が含まれます。

項目名 データ型 説明
availability WebLinkAvailability (string 型の列挙) 必須。Web リンクをオンラインでのみ使用できるか (online)、オフラインでも使用できるか (offline) を示します。
description string Web リンクの説明。
displayType WebLinkDisplayType (string 型の列挙) この Web リンクの表示方法を表します。

有効な値は次のとおりです。

  • ハイパーリンクの link。
  • ボタンの button。
  • 関連リストに添付されるボタンの massAction。
encodingKey Encoding (string 型の列挙) 必須。デフォルトの文字コード設定は Unicode (UTF-8) です。リンクの対象が異なる形式のデータを必要とする場合は、デフォルトの文字コード設定を変更します。この指定は、内容のソースが URL の場合に使用できます。

使用できる値は次のとおりです。

  • UTF-8: UI の「Unicode (UTF-8)」
  • ISO-8859-1: UI の「米国一般および西ヨーロッパ (ISO-8859-1, ISO-LATIN-1)」
  • Shift_JIS: UI の「日本語 (Shift-JIS)」
  • ISO-2022-JP: UI の「日本語 (JIS)」
  • EUC-JP: UI の「日本語 (EUC)」
  • ks_c_5601-1987: UI の韓国語 (ks_c_5601–1987)」
  • Big5: UI の「繁体字中国語 (Big5)」
  • GB2312: UI の「簡体字中国語 (GB2312)」
  • BIG5-HKSCS: UI の「繁体字中国語 香港(Big5–HKSCS)」
  • x-SJIS_0213: UI の「日本語 (Shift-JIS_2004)」
fullName string 有効性のために空白と特殊文字がエスケープされた Web リンクの名前。名前には、英数字、およびアンダースコア (_) 文字のみを使用できます。また、最初は文字とし、最後にアンダースコアを使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。

この項目はMetadata コンポーネントから継承するため、この項目はこのコンポーネントの WSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「create()」を参照してください。
hasMenubar boolean openType が newWindow である場合、ウィンドウにブラウザメニューを表示するか (true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。
hasScrollbars boolean openType が newWindow である場合、ウィンドウにスクロールバーを表示するか (true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。
hasToolbar boolean openType が newWindow である場合、ウィンドウにブラウザツールバーを表示するか (true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。
height int Web リンクによって開かれたウィンドウの高さ (ピクセル単位)。openType が newWindow である場合は必須です。そうでない場合は、指定できません。
isResizable boolean openType が newWindow である場合、ウィンドウのサイズを変更できるか (true)、否か (false) を示します。そうでない場合、この項目は指定しないでください。
linkType WebLinkType (string 型の列挙) 必須。この Web リンクのコンテンツが URL、Sコントロール、JavaScript コードブロック、または Visualforce ページによって指定されているかどうかを表します。
有効な値は次のとおりです。
  • url
  • sControl
  • javascript
  • page
  • flow — 今後の使用のために予約されています。
masterLabel string Web リンクのマスタラベル。
openType WebLinkWindowType (string 型の列挙) 必須。このボタンがクリックされたときのコンテンツの表示に使用されるウィンドウのスタイルを指定します。

有効な値は次のとおりです。

  • newWindow
  • sidebar
  • noSidebar
  • replace
  • onClickJavaScript
page string linkType の値が page である場合、この項目は Visualforce ページを表します。そうでない場合、この項目は指定しないでください。
position WebLinkPosition (string 型の列挙) openType が newWindow である場合、新規ウィンドウの表示方法を示します。そうでない場合、この項目は指定しないでください。

有効な値は次のとおりです。

  • fullScreen
  • none
  • topLeft
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 Web リンクによって開かれたウィンドウの幅 (ピクセル単位)。

openType が newWindow である場合は必須です。そうでない場合は、指定できません。

Java のサンプル

次の Java のサンプルは、Web リンクの項目のサンプル値を示します。

1swfobject.registerObject("clippy.codeblock-0", "9");public void webLinkSample(String name) throws Exception {
2    WebLink weblink = new WebLink();
3    // name variable represents the full name of the object 
4    // on which to create the weblink, for example, customObject__c
5    weblink.setFullName(name + ".googleButton");
6    weblink.setUrl("http://www.google.com");
7    weblink.setAvailability(WebLinkAvailability.online);
8    weblink.setLinkType(WebLinkType.url);
9    weblink.setEncodingKey(Encoding.fromString("UTF-8"));
10    weblink.setOpenType(WebLinkWindowType.newWindow);
11    weblink.setHeight(600);
12    weblink.setWidth(600);
13    weblink.setShowsLocation(false);
14    weblink.setHasScrollbars(true);
15    weblink.setHasToolbar(false);
16    weblink.setHasMenubar(false);
17    weblink.setShowsStatus(false);
18    weblink.setIsResizable(true);
19    weblink.setPosition(WebLinkPosition.none);
20    weblink.setMasterLabel("google");
21    weblink.setDisplayType(WebLinkDisplayType.link);
22
23    AsyncResult[] asyncResults = metadataConnection.create(new WebLink[]{weblink});
24    // After the create() call completes, we must poll the results of checkStatus() 
25    // 
26
27}

宣言的なメタデータの定義のサンプル

カスタムオブジェクト内の Web リンクの定義を次に示します。関連するサンプルについては、「HomePageComponent」「宣言的なメタデータの定義のサンプル」および「HomePageLayout」の「宣言的なメタデータの定義のサンプル」を参照してください。

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3....
4    <webLinks>
5        <fullName>googleButton</fullName>
6        <availability>online</availability>
7        <displayType>link</displayType>
8        <encodingKey>UTF-8</encodingKey>
9        <hasMenubar>false</hasMenubar>
10        <hasScrollbars>true</hasScrollbars>
11        <hasToolbar>false</hasToolbar>
12        <height>600</height>
13        <isResizable>true</isResizable>
14        <linkType>url</linkType>
15        <masterLabel>google</masterLabel>
16        <openType>newWindow</openType>
17        <position>none</position>
18        <protected>false</protected>
19        <showsLocation>false</showsLocation>
20        <showsStatus>false</showsStatus>
21        <url>http://www.google.com</url>
22        <width>600</width>
23    </webLinks>
24....
25</CustomObject>