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

apex:canvasApp コンポーネント

このコンポーネントを使用して、Visualforce ページにキャンバスアプリケーションを表示します。次の表に、コンポーネントの属性を示します。

引用符やアポストロフィーなどの英数字以外の文字が含まれるパラメーターは、JavaScript で安全に使用できるオブジェクトとして渡します。これを行うには、Apex JSONGenerator クラスのメソッドを使用する Apex クラスを記述し、JSON 文字列を作成します。parameters 値から Apex クラスをコールします。

1<apex:page controller="JSONGeneratorSample">
2 <apex:canvasApp developerName="mycanvas" parameters="{!generateJSON}" />
3</apex:page>

また、JSENCODE 関数を使用して文字列をエスケープすることもできます。

1<apex:page standardController="Account">
2 <apex:canvasApp developerName="mycanvas" parameters="{!JSENCODE(Account.Description)}" />
3</apex:page>

属性	型	説明
applicationName	String	キャンバスアプリケーションの名前。`applicationName` または `developerName` のいずれかが必要です。
border	String	キャンバスアプリケーションの境界線の幅 (ピクセル単位)。指定されていない場合、デフォルトの 0 ピクセルに設定されます。
canvasId	String	キャンバスアプリケーションウィンドウの一意の ID。この属性を使用して、イベントをキャンバスアプリケーションの対象にします。
containerId	String	キャンバスアプリケーションのレンダリングに使用される HTML 要素の ID。指定されていない場合、デフォルトの null に設定されます。この属性によって指定されるコンテナは、`<apex:canvasApp>` コンポーネントの後には表示されません。次のコード例に、`<div>` コンテナと `containerId` 属性の有効な使用法を示します。 `1<apex:page> 2 <div id="container1"></div> 3 <apex:canvasApp applicationName="myApp" containerId="container1"/> 4</apex:page> 5 6<apex:page> 7 <div id="container1"> 8 <apex:canvasApp applicationName="myApp" containerId="container1"/> 9 </div> 10</apex:page>` 次のコード例に、`<div>` コンテナと `containerId` 属性の無効な使用法を示します。 `1<apex:page> 2 <apex:canvasApp applicationName="myApp" containerId="container1"/> 3 <div id="container1"> 4 </div> 5</apex:page>`
developerName	String	キャンバスアプリケーションの内部名。接続アプリケーションを作成してキャンバスアプリケーションを公開するときは、[API 名] 項目にこの値を指定します。`developerName` または `applicationName` のいずれかが必要です。
entityFields	String	オブジェクトに配置された Visualforce ページにコンポーネントが表示されるときに、署名付き要求 Record オブジェクトで返される項目を指定します。この属性が指定されていないか空白の場合、ID 項目のみが返されます。有効な属性値は次のとおりです。項目名のカンマ区切りのリスト。たとえば、[取引先電話] 項目と [Fax] 項目を返すには、`entityFields="Phone,Fax"` という属性を指定します。アスタリスク「*」。関連付けられたオブジェクトのすべての項目を返します。
height	String	キャンバスアプリケーションウィンドウの高さ (ピクセル単位)。指定されていない場合、デフォルトの 900 ピクセルに設定されます。
id	String	ページの他のコンポーネントが `<apex:canvasApp>` コンポーネントを参照できるようにする一意の識別子。
maxHeight	String	キャンバスアプリケーションウィンドウの高さの最大値 (ピクセル)。デフォルトは 2000 ピクセルで、「infinite」も有効な値です。
maxWidth	String	キャンバスアプリケーションウィンドウの幅の最大値 (ピクセル)。デフォルトは 1000 ピクセルで、「infinite」も有効な値です。
namespacePrefix	String	キャンバスアプリケーションが作成された Developer Edition 組織の名前空間の値。名前空間を設定できるのは Developer Edition 組織のみであるため、キャンバスアプリケーションが別の種別の組織で作成された場合、これは省略可能です。指定されていない場合、デフォルトの null に設定されます。
onCanvasAppError	String	キャンバスアプリケーションがレンダリングできないときにコールされる JavaScript 関数の名前。
onCanvasAppLoad	String	キャンバスアプリケーションがロードした後にコールされる JavaScript 関数の名前。
parameters	String	キャンバスアプリケーションに渡されるパラメーターのオブジェクト表現。JSON 形式または JavaScript JSON オブジェクトリテラルへの式として指定します。指定されていない場合、デフォルトの null に設定されます。
rendered	Boolean	コンポーネントをページに表示するかどうかを指定する。指定されていない場合、デフォルトの true に設定されます。
scrolling	String	キャンバスアプリケーションのウィンドウでスクロールバーが使用されるか��うかを指定します。有効な値は、次のとおりです。 `auto` `no` `yes` 指定されていない場合、デフォルトの `no` に設定されます。この属性に無効な値が含まれていると、ブラウザーエラーを回避するために `no` と同様に扱われます。
width	String	キャンバスアプリケーションウィンドウの幅 (ピクセル単位)。指定されていない場合、デフォルトの 800 ピクセルに設定されます。

Canvas 開発者ガイド

apex:canvasApp コンポーネント

関連項目: