Visualforce 開発者ガイド
japex:commandButton
<apex:commandButton> タグの指定値に応じて、submit、reset、または image に設定されている型属性を持つ HTML 入力要素として表示されるボタンです。このボタンはコントローラで定義されているアクションを実行してから、現在のページを更新するか、またはアクションで返される PageReference 変数に基づいて他のページに移動します。
<apex:commandButton> コンポーネントは必ず <apex:form> コンポーネントの子である必要があります。
<apex:commandLink> も参照してください。
このコンポーネントでは、「html-」プレフィックスを使用した HTML パススルー属性がサポートされています。パススルー属性は、生成された <input> タグに適用されます。
例
上述の例では次の HTML を表示します。
属性
| 属性名 | 属性型 | 説明 | 必須項目 | API バージョン | 通用範囲 |
|---|---|---|---|---|---|
| accesskey | String | コマンドボタンにフォーカスを置くキーボードのアクセスキー。コマンドボタンにフォーカスがあるときに Enter キーを押す操作は、ボタンをクリックする操作と同じです。 | 10.0 | グローバル | |
| action | ApexPages.Action | サーバに対する AJAX 要求によって呼び出される action メソッド。このメソッドを参照するには、差し込み項目の構文を使用します。たとえば、action="{!save}" ではコントローラの save メソッドを参照します。アクションが指定されていない場合、ページは単に更新されます。標準コントローラで save、edit、または delete アクションに関連付けられているコマンドボタンは、ユーザに適切な権限がある場合にのみ表示されます。同様に、edit アクションおよび delete アクションに関連付けられているコマンドボタンは、レコードがページに関連付けられている場合にのみ表示されます。 | 10.0 | グローバル | |
| alt | String | コマンドボタンの代替のテキストによる説明。 | 10.0 | グローバル | |
| dir | String | 生成された HTML コンポーネントの読み取り方向。使用可能な値には「RTL」(右から左) または「LTR」(左から右) があります。 | 10.0 | グローバル | |
| disabled | Boolean | このボタンを無効な状態で表示するかどうかを指定する boolean 値。true に設定されている場合、ボタンは無効な状態で表示されます。指定されていない場合、この値はデフォルトの false に設定されます。 | 10.0 | グローバル | |
| id | String | ページの他のコンポーネントが commandButton コンポーネントを参照できるようにする識別子。 | 10.0 | グローバル | |
| image | String | このボタンとして表示される画像の絶対または相対 URL。指定されている場合、生成された HTML 入力要素の型は「image」に設定されます。 | 10.0 | グローバル | |
| immediate | Boolean | ページの項目に関連付けられている入力規則を処理することなく、このコンポーネントに関連付けられているアクションをすぐに実行するかどうかを指定する boolean 値。true に設定すると、アクションがすぐに実行され、入力規則はスキップされます。指定されていない場合、この値はデフォルトの false に設定されます。 | 11.0 | グローバル | |
| lang | String | 「en」または「en-US」など、生成された HTML 出力の基本言語。この属性についての詳細は、W3C 仕様を参照してください。 | 10.0 | グローバル | |
| onblur | String | onblur イベントが発生した場合 (フォーカスがコマンドボタンから離れた場合) に呼び出される JavaScript。 | 10.0 | グローバル | |
| onclick | String | onclick イベントが発生した場合 (ユーザがコマンドボタンをクリックした場合) に呼び出される JavaScript。 | 10.0 | グローバル | |
| oncomplete | String | AJAX 更新要求の結果がクライアントで完了したときに呼び出される JavaScript。 | 10.0 | グローバル | |
| ondblclick | String | ondblclick イベントが発生した場合 (ユーザがコマンドボタンをダブルクリックした場合) に呼び出される JavaScript。 | 10.0 | グローバル | |
| onfocus | String | onfocus イベントが発生した場合 (フォーカスがコマンドボタンにある場合) に呼び出される JavaScript。 | 10.0 | グローバル | |
| onkeydown | String | onkeydown イベントが発生した場合 (ユーザがキーボードのキーを押した場合) に呼び出される JavaScript。 | 10.0 | グローバル | |
| onkeypress | String | onkeypress イベントが発生した場合 (ユーザがキーボードのキーを押したか、押したままにした場合) に呼び出される JavaScript。 | 10.0 | グローバル | |
| onkeyup | String | onkeyup イベントが発生した場合 (ユーザがキーボードのキーを放した場合) に呼び出される JavaScript。 | 10.0 | グローバル | |
| onmousedown | String | onmousedown イベントが発生した場合 (ユーザがマウスボタンをクリックした場合) に呼び出される JavaScript。 | 10.0 | グローバル | |
| onmousemove | String | onmousemove イベントが発生した場合 (ユーザがマウスポインタを移動した場合) に呼び出される JavaScript。 | 10.0 | グローバル | |
| onmouseout | String | onmouseout イベントが発生した場合 (ユーザがコマンドボタンからマウスポインタを移動した場合) に呼び出される JavaScript。 | 10.0 | グローバル | |
| onmouseover | String | onmouseover イベントが発生した場合 (ユーザがマウスポインタをコマンドボタンに重ねた場合) に呼び出される JavaScript。 | 10.0 | グローバル | |
| onmouseup | String | onmouseup イベントが発生した場合 (ユーザがマウスボタンを放した場合) に呼び出される JavaScript。 | 10.0 | グローバル | |
| rendered | Boolean | コンポーネントをページに表示するかどうかを指定する boolean 値。指定されていない場合、この値はデフォルトの true に設定されます。 | 10.0 | グローバル | |
| reRender | Object | AJAX 更新要求の結果がクライアントに返されるときに再作成される 1 つ以上のコンポーネントの ID。この値には、単一の ID、ID のカンマ区切りのリスト、または ID のリストまたはコレクションの差し込み項目の式を使用できます。 | 10.0 | グローバル | |
| status | String | AJAX 更新要求の状況を表示する関連付けられているコンポーネントの ID。「actionStatus コンポーネント」を参照してください。 | 10.0 | グローバル | |
| style | String | commandButton コンポーネントの表示に使用されるスタイル。主に、インライン CSS スタイルを追加するために使用されます。 | 10.0 | グローバル | |
| styleClass | String | commandButton コンポーネントの表示に使用されるスタイルクラス。主に、外部 CSS スタイルシートを使用するときに適用される CSS スタイルを指定するために使用されます。 | 10.0 | グローバル | |
| tabindex | String | ユーザが Tab キーを繰り返し押したときに、他のページコンポーネントと比較して、このボタンが選択される順序。この値は、ユーザが Tab キーを押したときに選択される最初のコンポーネントを 0 として、0 ～ 32767 の数値である必要があります。 | 10.0 | グローバル | |
| timeout | Integer | AJAX 更新要求がタイムアウトするまでの時間 (ミリ秒)。 | 10.0 | グローバル | |
| title | String | ユーザがコンポーネントにマウスポインタを重ねたときにツールチップとして表示されるテキスト。 | 10.0 | グローバル | |
| value | Object | commandButton にラベルとして表示されるテキスト。 | 10.0 | グローバル |