Visualforce 開発者ガイド
japex:commandLink
コントローラで定義されているアクションを実行してから、現在のページを更新するか、またはアクションで返される PageReference 変数に基づいて他のページに移動するリンクです。<apex:commandLink> コンポーネントは必ず <apex:form> コンポーネントの子である必要があります。
<apex:commandLink> に要求パラメータを追加するには、ネストされた <apex:param> コンポーネントを使用します。
<apex:commandButton>、<apex:outputLink> も参照してください。
このコンポーネントでは、「html-」プレフィックスを使用した HTML パススルー属性がサポートされています。パススルー属性は、生成された <a> タグに適用されます。
例
1<apex:commandLink action="{!save}" value="Save" id="theCommandLink"/>上述の例では次の HTML を表示します。
1<a id="thePage:theForm:theCommandLink" href="#" onclick="generatedJs()">Save</a>属性
| 属性名 | 属性型 | 説明 | 必須項目 | API バージョン | 通用範囲 |
|---|---|---|---|---|---|
| accesskey | String | コマンドリンクにフォーカスを置くキーボードのアクセスキー。コマンドリンクにフォーカスがあるときに Enter キーを押す操作は、リンクをクリックする操作と同じです。 | 10.0 | グローバル | |
| action | ApexPages.Action | サーバに対する AJAX 要求によって呼び出される action メソッド。このメソッドを参照するには、差し込み項目の構文を使用します。たとえば、action="{!save}" ではコントローラの save() メソッドを参照します。アクションが指定されていない場合、ページは単に更新されます。標準コントローラで save、edit、または delete アクションに関連付けられているコマンドリンクは、ユーザに適切な権限がある場合にのみ表示されます。同様に、edit アクションおよび delete アクションに関連付けられているコマンドリンクは、レコードがページに関連付けられている場合にのみ表示されます。 | 10.0 | グローバル | |
| charset | String | 指定 URL の符号化に使用される文字セット。指定されていない場合、この値はデフォルトの「ISO-8859-1」に設定されます。 | 10.0 | グローバル | |
| coords | String | コマンドリンクに使用される画面のホットスポットの位置と形状 (クライアント側の画像マップ用)。カンマ区切り値の数および順序は定義される形状に依存します。たとえば、長方形を定義するには、coords="left-x, top-y, right-x, bottom-y" を使用します。円形を定義するには、coords="center-x、center-y, radius" を使用します。多角形を定義するには、coords="x1, y1, x2, y2, ..., xN, yN" を使用します。ここで、x1 = nN および y1 = yN です。座標はピクセルまたはパーセントで表すことができます。また、座標は対応付けられる画像の左上からの距離を表します。「shape 属性」も参照してください。 | 10.0 | グローバル | |
| dir | String | 生成された HTML コンポーネントの読み取り方向。使用可能な値には「RTL」(右から左) または「LTR」(左から右) があります。 | 10.0 | グローバル | |
| hreflang | String | 「en」、「en-US」など、このコマンドリンクで参照されるリソースの基本言語。この属性についての詳細は、W3C 仕様を参照してください。 | 10.0 | グローバル | |
| id | String | ページの他のコンポーネントが commandLink コンポーネントを参照できるようにする識別子。 | 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 | グローバル | |
| rel | String | 現在のドキュメントからこのコマンドリンクで指定される URL へのリレーション。この属性の値は、リンクタイプのスペース区切りのリストです。この属性についての詳細は、W3C 仕様を参照してください。 | 10.0 | グローバル | |
| rendered | Boolean | コンポーネントをページに表示するかどうかを指定する boolean 値。指定されていない場合、この値はデフォルトの true に設定されます。 | 10.0 | グローバル | |
| reRender | Object | AJAX 更新要求の結果がクライアントに返されるときに再作成される 1 つ以上のコンポーネントの ID。この値には、単一の ID、ID のカンマ区切りのリスト、または ID のリストまたはコレクションの差し込み項目の式を使用できます。 | 10.0 | グローバル | |
| rev | String | 現在のドキュメントへのこのコマンドリンクで指定される URL からの逆リンク。この属性の値は、リンクタイプのスペース区切りのリストです。この属性についての詳細は、W3C 仕様を参照してください。 | 10.0 | グローバル | |
| shape | String | クライアント側の画像マップのホットスポットの形状。有効な値は、default、circle、rect、および poly です。「coords 属性」も参照してください。 | 10.0 | グローバル | |
| status | String | AJAX 更新要求の状況を表示する関連付けられているコンポーネントの ID。「actionStatus コンポーネント」を参照してください。 | 10.0 | グローバル | |
| style | String | commandLink コンポーネントの表示に使用されるスタイル。主に、インライン CSS スタイルを追加するために使用されます。 | 10.0 | グローバル | |
| styleClass | String | commandLink コンポーネントの表示に使用されるスタイルクラス。主に、外部 CSS スタイルシートを使用するときに適用される CSS スタイルを指定するために使用されます。 | 10.0 | グローバル | |
| tabindex | String | ユーザが Tab キーを繰り返し押したときに、他のページコンポーネントと比較して、このリンクが選択される順序。この値は、ユーザが Tab キーを押したときに選択される最初のコンポーネントを 0 として、0 ～ 32767 の整数である必要があります。 | 10.0 | グローバル | |
| target | String | このコマンドリンクによって取得されるリソースを表示するフレームの名前。この属性に使用できる値には、「_blank」、「_parent」、「_self」、「_top」があります。また、目的の移行先の name 属性に値を割り当てることにより、独自のターゲット名を指定することもできます。 | 10.0 | グローバル | |
| timeout | Integer | AJAX 更新要求がタイムアウトするまでの時間 (ミリ秒)。 | 10.0 | グローバル | |
| title | String | ユーザがコンポーネントにマウスポインタを重ねたときにツールチップとして表示されるテキスト。 | 10.0 | グローバル | |
| type | String | このコマンドリンクで指定されるリソースの MIME コンテンツタイプ。この属性の使用できる値には、「text/html」、「image/png」、「image/gif」、「video/mpeg」、「text/css」、および「audio/basic」があります。使用できる値の完全なリストなど、詳細は、W3C 仕様を参照してください。 | 10.0 | グローバル | |
| value | Object | commandLink ラベルとして表示されるテキスト。commandLink タグの本文にコンテンツを埋め込むことにより、コマンドリンクとして表示するテキストまたは画像を指定することもできます。value 属性および埋め込みコンテンツの両方が指定されると、これらは一緒に表示されます。 | 10.0 | グローバル |