JS グリッド イベント
最終更新日: 2015年3月9日
適用対象: SharePoint Foundation 2010
JS グリッド コントロールで特定のイベントが発生したときにクライアントで実行するコードを記述できます。このコードによるクライアント側のレンダリングでは、サーバーとのラウンド トリップが不要なため、より迅速なフィードバックがユーザーに提供されます。
JS グリッド コントロールには、以下のクライアント側のイベントがあります。
JS グリッド イベント
イベント |
説明 |
|---|---|
OnBeforeGridDispose |
グリッドが破棄される前に発生します。コントロールが有効な間に 1 回だけ発生します。 |
OnCellEditBegin |
編集コントロールまたはウィジェットでユーザーが編集を開始 (キーを押す、ダブルクリック) したとき、たとえば、編集ボックスに入力し始めたときに発生します。 |
OnCellEditCompleted |
編集コントロールまたはウィジェットでユーザーがセルの編集を終了した後に発生します。また、ページの更新時 (onLoad イベント時) にも発生します。 |
OnCellErrorStateChanged |
セルのエラーが追加または削除されたときに発生します。 |
OnCellFocusChanged |
セルのフォーカスが変更された後に発生します。 |
OnDoubleClick |
ユーザーがセルをダブルクリックしたときに発生します。 |
OnEntryRecordAdded |
新しいエントリ レコードが JS グリッド コントロールに表示されたときに発生します。 |
OnEntryRecordCommitted |
レコード エントリがコミットされたとき、つまり、エントリ レコードが正常に JS グリッド コントロール テーブル キャッシュに追加されたときに発生します。 |
OnEntryRecordPropertyChanged |
エントリ レコードのプロパティが変更されたときに発生します。これには、ユーザーの編集とプログラムによる編集すべてが含まれます。 |
OnGridErrorStateChanged |
1 つ以上のエラーがある状態からエラーがない状態、またはエラーがない状態から 1 つ以上のエラーがある状態にグリッドが変更されたときに発生します。 |
OnInitialChangesForChangeKeyComplete(changeKey) |
指定された変更キーに関連付けられているすべての変更が最初に検証されたときに発生します。つまり、非同期呼び出しは保留中です。 |
OnPropertyChanged |
レコードのプロパティが変更されたときに発生します。ユーザーの編集とプログラムによる編集すべてが含まれます。 |
OnRecordChecked |
レコードのインジケーター チェック ボックスを使用して、1 つ以上のレコードがオンまたはオフになったときに発生します。 |
OnRecordDeleted |
レコードが削除されたときに発生します。 |
OnRecordInserted |
レコードが挿入されたときに発生します。 |
OnRightClick |
ユーザーがセルを右クリックしたときに発生します。 |
OnRowErrorStateChanged |
行のエラー状態が変更されたときに発生します。 |
OnRowFocusChanged |
行のフォーカスが変更されたときに発生します。 |
OnSingleCellClick |
ユーザーがセルをシングル クリックしたときに発生します。 |
OnSingleCellKeyDown |
1 つのキーが押されたときに発生します。 |
OnVacateChange |
指定された変更をグリッドが追跡しなくなったときに発生します。たとえば、ユーザーが変更を行い、その変更を元に戻して、また別の変更を行うと、最初の変更は無効になります。 |
イベントへの添付
この例は、カスタム コードを OnCellEditComplete イベントに添付する方法を示しています。
<script type="text/javascript">
Type.registerNamespace("GridManager");
GridManager = function () {
this.Init = function (jsGridControl, initialData, props) {
control = jsGridControl;
var dataSource = new SP.JsGrid.StaticDataSource(initialData);
var jsGridParams = dataSource.InitJsGridParams();
// This event is triggered after the standard grid error checking.
jsGridControl.AttachEvent(SP.JsGrid.EventType.OnCellEditCompleted, GotHere);
jsGridControl.Init(jsGridParams);
}
};
function GotHere(obj) {
alert('Got Here, ' + obj.fieldKey);
}
</script>