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

apex:canvasApp

指定された developerName/namespacePrefix または applicationName/namespacePrefix 値のペアで識別されるキャンバスアプリケーションを表示します。developerName と applicationName の両方が設定されている場合は、developerName 属性が優先されます。

要件:

組織で Force.com Canvas が有効になっている必要があります。

<apex:canvasApp> コンポーネントを使用するときの考慮事項は、次のとおりです。

開発組織とは、キャンバスアプリケーションを開発し、パッケージ化する組織です。
インストール組織とは、パッケージ化されたキャンバスアプリケーションのインストール先の組織です。
Visualforce ページでの <apex:canvasApp> コンポーネントの使用状況は、キャンバスアプリケーションのアプリケーション名または開発者名が変更されても更新されません。
<apex:canvasApp> を使用してキャンバスアプリケーションを参照する Visualforce ページが存在しても、そのキャンバスアプリケーションを削除できます。

次の例では、開発者名のみを使用してキャンバスアプリケーションを表示します。組織に名前空間プレフィックスがない場合は、namespacePrefix 属性を使用しないでください。

1Note: The canvas app is rendered within a div element, the div element id can be retrieved by {!$Component.genContainer}.
2    <apex:page showHeader="false">
3      <apex:canvasApp developerName="canvasAppDeveloperName"/>
4    </apex:page>

次の例では、アプリケーション名のみを使用してキャンバスアプリケーションを表示します。

1<apex:page showHeader="false">
2      <apex:canvasApp applicationName="canvasAppName"/>
3    </apex:page>

次の例では、開発者名と、キャンバスアプリケーションが作成された組織の名前空間プレフィックスを使用して、キャンバスアプリケーションを表示します。

1<apex:page showHeader="false">
2      <apex:canvasApp developerName="canvasAppDeveloperName" namespacePrefix="fromDevOrgNamespacePrefix"/>
3    </apex:page>

次の例では、アプリケーション名と、キャンバスアプリケーションが作成された組織の名前空間プレフィックスを使用して、キャンバスアプリケーションを表示します。

1<apex:page showHeader="false">
2      <apex:canvasApp applicationName="canvasAppName" namespacePrefix="fromDevOrgNamespacePrefix"/>
3    </apex:page>

次の例では、特定の出力パネルでキャンバスアプリケーションを表示します。

1<apex:page showHeader="false">
2      <apex:outputPanel layout="block" id="myContainer">
3        <apex:canvasApp developerName="canvasAppName" namespacePrefix="fromDevOrgNamespacePrefix" containerId="{!$Component.myContainer}"/>
4      </apex:outputPanel>
5    </apex:page>

属性

属性名	属性型	説明	API バージョン	通用範囲
`applicationName`	String	キャンバスアプリケーションの名前。applicationName または developerName が必要です。	38.0
`border`	String	キャンバスアプリケーションの境界線の幅 (ピクセル)。指定されていない場合、デフォルトの 0 ピクセルに設定されます。	38.0
`canvasId`	String	キャンバスアプリケーションウィンドウの一意の ID。この属性を使用して、イベントをキャンバスアプリケーションの対象にします。	38.0
`containerId`	String	キャンバスアプリケーションが表示される HTML 要素 ID。指定されていない場合、デフォルトの null に設定されます。この属性で指定されるコンテナを <apex:canvasApp> コンポーネントの後に配置することはできません。	38.0
`developerName`	String	キャンバスアプリケーションの開発者名。この名前は、キャンバスアプリケーションが作成されたときに定義され、キャンバスアプリケーションのプレビューアで表示されます。developerName または applicationName が必要です。	38.0
`entityFields`	String	オブジェクトに配置された Visualforce ページにコンポーネントが表示されるときに、署名付き要求 Entity オブジェクトで返される項目を指定します。この属性が指定されていないか空白の場合、ID および種別情報が提供されます。有効な属性値は次のとおりです。項目名のカンマ区切りのリスト。たとえば、[取引先電話] 項目と [Fax] 項目を返すには、entityFields="Phone,Fax" という属性を指定します。アスタリスク「*」。関連付けられたオブジェクトのすべての項目を返します。	38.0
`height`	String	キャンバスアプリケーションウィンドウの高さ (ピクセル単位)。指定されていない場合、デフォルトの 900 ピクセルに設定されます。	38.0
`id`	String	ページの他のコンポーネントがコンポーネントを参照できるようにする識別子。	14.0	グローバル
`maxHeight`	String	キャンバスアプリケーションウィンドウの高さの最大値 (ピクセル)。デフォルトは 2000 ピクセルで、「infinite」も有効な値です。	38.0
`maxWidth`	String	キャンバスアプリケーションウィンドウの幅の最大値 (ピクセル)。デフォルトは 1000 ピクセルで、「infinite」も有効な値です。	38.0
`namespacePrefix`	String	キャンバスアプリケーションが作成された Developer Edition 組織の名前空間の値。キャンバスアプリケーションが Developer Edition 組織で作成されていない場合は省略できます。指定されていない場合、デフォルトの null に設定されます。	38.0
`onCanvasAppError`	String	キャンバスアプリケーションの表示に失敗した場合にコールされる JavaScript 関数の名前。	38.0
`onCanvasAppLoad`	String	キャンバスアプリケーションの読み込み後にコールされる JavaScript 関数の名前。	38.0
`parameters`	String	キャンバスアプリケーションに渡されるパラメータのオブジェクト表現。JSON 形式または JavaScript オブジェクトリテラルとして指定する必要があります。JavaScript オブジェクトリテラルとしてのパラメータの例: {param1:'value1',param2:'value2'}。指定されていない場合、デフォルトの null に設定されます。	38.0
`rendered`	Boolean	コンポーネントをページに表示するかどうかを指定する boolean 値。指定されていない場合、この値はデフォルトの true に設定されます。	14.0	グローバル
`scrolling`	String	キャンバスアプリケーションウィンドウでスクロールバーを使用するかどうかを指定します。有効な値は auto\|yes\|no です。指定されていない場合や、無効な値に設定されている場合、デフォルトの no に設定されます。	38.0
`width`	String	キャンバスアプリケーションウィンドウの幅 (ピクセル単位)。指定されていない場合、デフォルトの 800 ピクセルに設定されます。	38.0

Visualforce 開発者ガイド