Visualforce 開発者ガイド
japex:page
単一の Visualforce ページです。すべてのページは、単一の page コンポーネントタグ内でラップされている必要があります。
このコンポーネントでは、「html-」プレフィックスを使用した HTML パススルー属性がサポートされています。パススルー属性は、生成された <html> タグに適用されます。
例
1<!-- Page: -->
2<apex:page renderAs="pdf">
3 <style> body { font-family: 'Arial Unicode MS'; } </style>
4 <h1>Congratulations</h1>
5 <p>This is your new PDF</p>
6</apex:page>属性
| 属性名 | 属性型 | 説明 | 必須かどうか | API バージョン | 通用範囲 |
|---|---|---|---|---|---|
| action | ApexPages.Action | このページをサーバが要求したときに呼び出される action メソッド。式の言語を使用して action メソッドを参照します。たとえば、action="{!doAction}" はコントローラの doAction() メソッドを参照します。 アクションが指定されていない場合、ページは通常どおり読み込まれます。action メソッドが null を返す場合、ページは単に更新されます。 このメソッドは、ページが表示される前にコールされるため、ユーザを別のページにリダイレクトすることもできます。 重要: このアクションを初期化または DML で使用しないでください。 |
10.0 | グローバル | |
| apiVersion | double | ページの表示と実行に使用される API のバージョン。 | 10.0 | グローバル | |
| applyBodyTag | Boolean | 生成される HTML 出力に、<body> タグを Visualforce で自動的に追加するかどうかを指定する boolean 値。たとえば、<body> タグをマークアップで静的に設定する場合などのように、応答への <body> タグの追加を無効にするには、false に設定します。指定されていない場合、この値は applyHtmlTag 属性の値がデフォルトで適用されます。設定されているか true の場合、applyHtmlTag の値は適用されません。 | 27.0 | ||
| applyHtmlTag | Boolean | 生成される HTML 出力に、<html> タグを Visualforce で自動的に追加するかどうかを指定する boolean 値。たとえば、<html> タグをマークアップで静的に設定する場合などのように、応答への <html> タグの追加を無効にするには、false に設定します。指定されていない場合、この値はデフォルトの true に設定されます。 | 27.0 | ||
| cache | Boolean | ブラウザがこのページをキャッシュするかどうかを指定する boolean 値。true に設定すると、ブラウザはページをキャッシュします。指定されていない場合、この値はデフォルトの false に設定されます。 Force.com サイトのページについては、この値はデフォルトの true に設定されます。サイトページのキャッシュについての詳細は、Salesforce オンラインヘルプの「Force.com サイトページのキャッシュ」を参照してください。 |
10.0 | グローバル | |
| contentType | String | 表示されるページの形式に使用される MIME コンテンツタイプ。この属性の使用できる値には、「text/html」、「text/csv」、「image/png」、「image/gif」、「video/mpeg」、「text/css」、および「audio/basic」があります。使用できる値の完全なリストなど、詳細は、W3C 仕様を参照してください。 表示されるページのファイル名は、MIME タイプに「#」とファイル名を順に追加して定義できます。たとえば、「application/vnd.ms-excel#contacts.xls」とすることができます。 |
10.0 | グローバル | |
| controller | String | このページの動作を制御するために使用する、Apex で記述されたカスタムコントローラクラスの名前。standardController 属性も存在する場合、この属性は指定できません。 | 10.0 | グローバル | |
| deferLastCommandUntilReady | Boolean | ページの準備ができる前にコマンドボタンおよびリンクをクリックしないようにするかどうかを指定する boolean 値。true に設定すると、ボタンまたはリンクの最後のクリックがエンキューされ、ページの準備ができたときに処理されます。この値のデフォルトは false です。 | 26.0 | ||
| docType | String | 表示されるページの構造を記述する HTML 文書型定義 (DTD)、つまり doctype。この属性に使用できる値には、主に「html-4.01-strict」、「xhtml-1.0-transitional」、「xhtml-1.1-basic」、「html-5.0」があります。 指定されていない場合、この値はデフォルトの「html-4.01-transitional」に設定されるため、doctype は <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> になります。 HTML の文書型宣言についての詳細は、W3C 仕様を参照してください。 |
23.0 | ||
| expires | Integer | キャッシュ属性の有効期限 (秒)。キャッシュ属性が true に設定されており、属性が指定されていない場合、この値はデフォルトの 0 に設定されます。 Force.com サイトのページについては、キャッシュ属性が false に設定されていない場合、この値はデフォルトの 600 秒に設定されます。サイトページのキャッシュについての詳細は、Salesforce オンラインヘルプの「Force.com サイトページのキャッシュ」を参照してください。 |
14.0 | ||
| extensions | String | このページにロジックを追加する、Apex で記述された 1 つ以上のカスタムコントローラ拡張の名前。 | 11.0 | グローバル | |
| id | String | ページの他のコンポーネントが参照できるようにするページの識別子。 | 10.0 | グローバル | |
| label | String | Salesforce 設定ツールでページを参照するために使用される表示ラベル。 | 10.0 | グローバル | |
| language | String | 関連付けられている翻訳が Salesforce にあるラベルの表示に使用される言語。この値は、ページを表示しているユーザの言語より優先されます。この属性に使用できる値には、「en」、「en-US」などの Salesforce でサポートされている言語の言語キー���あります。 | 10.0 | グローバル | |
| lightningStylesheets | Boolean | Lightning Experience でページを表示するときに、一部の標準 Visualforce コンポーネントを Lightning Experience のようなスタイルに設定するかどうかを制御する boolean 値。すべての標準 Visualforce コンポーネントがこの属性をサポートしているわけではありません。 true に設定すると、Lightning Experience で表示するときは Lightning Experience スタイルシートがページに適用され、Salesforce Classic で表示するときは Classic スタイルシートが適用されます。 指定しないか、false に設定すると、Classic スタイルシートが常に使用されます。 注意: lightningStylesheets 属性が true の場合、この属性は standardStylesheets 属性を上書きします。 |
10.0 | グローバル | |
| manifest | String | 生成される <html> タグに、オフライン使用でキャッシュマニフェストファイルを参照するマニフェスト属性を追加します。マニフェスト属性を設定するには、docType="html-5.0" を設定し、applyHtmlTag を "false" に設定しない必要もあります。 | 27.0 | ||
| name | String | Force.com API でページを参照するために使用される一意の名前。 | 10.0 | グローバル | |
| pageStyle | String | pageStyle 属性は、Salesforce API バージョン 16.0 では使用できなくなりました。ページへの影響はありません。 | 10.0 | グローバル | |
| readOnly | Boolean | Visualforce ページで参照のみモードを有効化する boolean 値。参照のみモードの場合、ページの DML 操作は実行されませんが、取得されるレコード数の制限は、50,000 行から 1,000,000 行に増加します。反復コンポーネントによって処理されるコレクション内の項目数も、1,000 から 10,000 に増加します。指定されていない場合、この値はデフォルトの false に設定されます。 | 23.0 | ||
| recordSetName | String | recordSetName 属性は、Salesforce API バージョン 16.0 では使用できなくなりました。ページへの影響はありません。代わりに recordSetVar を使用してください。 | 14.0 | ||
| recordSetVar | String | この属性は、ページでセット指向の標準コントローラが使用されることを示します。属性の値は、ページに渡されるレコードのセットの名前を示します。このレコードセットを式で使用し、ページでの表示に使用する値を返したり、レコードのセットに対してアクションを実行したりできます。 たとえば、ページで標準取引先コントローラが使用されており、recordSetVar が "accounts" に設定されている場合、次のコードを使用して単純な pageBlockTable という取引先レコードを作成できます。 <apex:pageBlockTable value="{!accounts}" var="a"><apex:column value="{!a.name}"/></apex:pageBlockTable> |
14.0 | ||
| renderAs | String | サポートされるコンテンツコンバータの名前。現在、サポートされているコンテンツコンバータは PDF のみです。この属性を "pdf" に設定すると、ページが PDF として表示されます。 Visualforce ページを PDF として表示する機能は、印刷用にデザインされ、最適化されたページのためのものです。印刷用の書式設定が容易ではないか、入力やボタンなどのフォーム要素が含まれる標準コンポーネント、および書式設定に JavaScript が必要なコンポーネントは使用しないでください。これにはフォーム要素を必要とするコンポーネントなどが含まれますが、これに限定されません。リリースする前に、表示されるページの形式を確認してください。 PDF ですべての文字が表示されない場合は、CSS のフォントを調整して要件に対応するフォントを使用します。たとえば、次のスタイル定義をページのスタイルに追加します。 body { font-family: 'Arial Unicode MS'; } pageBlock と sectionHeader コンポーネントは、PDF に表示されるとき、ダブルバイトのフォントをサポートしません。 |
13.0 | グローバル | |
| rendered | Boolean | ページを表示するかどうかを指定する boolean 値。指定されていない場合、この値はデフォルトの true に設定されます。 | 10.0 | グローバル | |
| setup | Boolean | ページが標準の Salesforce 設定ページのスタイルを使用するかどうかを指定する boolean 値。true の場合、設定のスタイルが使用されます。指定されていない場合、この値はデフォルトの false に設定されます。 | 10.0 | グローバル | |
| showChat | Boolean | Chatter Messenger チャットウィジェットをページに含めるかどうかを指定する boolean 値。true の場合、チャットウィジェットが表示されます。指定されていない場合、値は、[設定] の [カスタマイズ] | [Chatter] | [チャットの設定] で選択された Visualforce 設定の値がデフォルトで適用されます。 | 10.0 | グローバル | |
| showHeader | Boolean | ページに Salesforce タブのヘッダーを含めるかどうかを指定する boolean 値。true の場合、タブのヘッダーは表示されます。指定されていない場合、この値はデフォルトの true に設定されます。 注意: Lightning Experience および Salesforce アプリケーションでは、この属性の値は上書きされ、常に false になります。 |
10.0 | グローバル | |
| showQuickActionVfHeader | Boolean | このページをコールするクイックアクションのヘッダーを表示するかどうかを示す boolean 値。true の場合、アクションヘッダーは表示されます。指定されていない場合、この値はデフォルトの true に設定されます。この属性は、コミュニティではサポートされていません。 | 34.0 | ||
| sidebar | Boolean | 標準の Salesforce サイドバーをページに含めるかどうかを指定する boolean 値。true の場合、サイドバーは表示されます。指定されていない場合、この値はデフォルトの true に設定されます。 注意: Lightning Experience および Salesforce アプリケーションでは、この属性の値は上書きされ、常に false になります。 |
10.0 | グローバル | |
| standardController | String | このページの動作を制御するために使用する Salesforce オブジェクトの名前。コントローラ属性も存在する場合、この属性は指定できません。 | 10.0 | グローバル | |
| standardStylesheets | Boolean | showHeader 属性が false に設定されている場合に、標準の Salesforce スタイルシートを生成されたページのヘッダーに追加するかどうかを指定する boolean 値。true に設定すると、生成されるページのヘッダーに標準のスタイルシートが追加されます。指定されていない場合、この値はデフォルトの true に設定されます。この設定を false にすると、Salesforce.com の CSS を必要とするコンポーネントは正しく表示されず、リリースごとに異なるスタイルが適用される場合があります。 | 11.0 | グローバル | |
| tabStyle | String | このページの色、スタイル、および選択されたタブを制御する Salesforce オブジェクトまたはカスタム Visualforce タブ。カスタムオブジェクトを使用している場合、属性にオブジェクトの開発者名を指定する必要があります。たとえば、MyCustomObject に関連付けられたスタイルを使用するには、tabStyle="MyCustomObject__c" を使用します。ページで標準コントローラを使用する場合、デフォルトで、関連付けられたコントローラのスタイルに設定されます。ページでカスタムコントローラを使用する場合、デフォルトで [ホーム] タブに設定されます。 カスタムの Visualforce タブを使用するには、属性をタブ名 (表示ラベルではない) + アンダースコア 2 個 (__) + 単語「tab」に設定します。たとえば、名前が Source で表示ラベルが Sources の Visualforce タブのスタイルを使用するには、tabStyle="Source__tab" を使用します。 |
10.0 | グローバル | |
| title | String | Visualforce によってページに追加された HTML < title > 要素のコンテンツを指定する文字列値。この属性を使用してページのウィンドウタイトルまたはタブタイトルを設定します。 API 30.0 以降に設定されたページで、<apex:page> title 属性は、Visualforce が生成した <head> 要素が 1 つでも存在すれば、その内部で <title> 要素を生成します。Visualforce は、<apex:page> の他の属性が、まったく生成されないように設定されていない限り、HTML <head> 要素を生成します。たとえば、applyHtmlTag または applyBodyTag が false の場合、title 属性の値が無視されます。ページによって生成された HTML を柔軟に制御するためにこれらのタグが使用され、ページが、必要な <title> 要素を含む完全な HTML マークアップで構成されていることが前提とされます。 API 29.0 以前に設定されたページで、<apex:page> の showHeader 属性が false に設定されている場合、<title> 要素は生成されません。 注意: 開発者モードでページを編集している場合、ページタイトルは表示されません。 |
10.0 | グローバル | |
| wizard | Boolean | ページが標準の Salesforce ウィザードページのスタイルを使用するかどうかを指定する boolean 値。true の場合、ウィザードのスタイルが使用されます。指定されていない場合、この値はデフォルトの false に設定されます。 | 10.0 | グローバル |