Adobe ColdFusion 8

ColdFusion.Grid.refresh

説明

表示されているグリッドを手動で更新します。

関数のシンタックス

ColdFusion.Grid.refresh(name[, preservePage])

参照項目

<c code>cfgrid<c code>ColdFusion.Grid.getGridObject<c code>ColdFusion.Grid.sort、『ColdFusion 開発ガイド』の"HTML 形式のグリッドの使用"

履歴

ColdFusion 8: この関数が追加されました。

パラメータ

パラメータ

説明

name

更新する cfgrid タグの name 属性の値です。

preservePage

現在のページを再表示するか (true)、最初のページを表示するか (false、デフォルト) を指定するブール値です。この属性は、グリッドデータの表示に複数のグリッドページが必要になる場合にのみ適用されます。

戻り値

この関数は値を返しません。

使用方法

この関数は、基盤となるデータを変更するが、通常、グリッドの更新を実行しないイベントが発生したときに、グリッドを更新するのに役立ちます。

次のコードは、ユーザーがグリッドから行を削除できる例です。ユーザーがグリッドの行を選択して削除ボタンをクリックすると、AJAX プロキシによって mycfc.deleteRow 関数が呼び出され、該当する行がデータベースから削除されます。この関数が正常に返されると、プロキシによって ColdFusion.Grid.refresh が呼び出され、グリッドの更新と行の削除が実行されます。

<cfajaxproxy bind="cfc:mycfc.deleteRow({deletebutton@click},{mygrid.id@none}"
    onSuccess="ColdFusion.Grid.refresh('mygrid', true)">