v5.20191.603
|

IEditableCollectionView インターフェイス

ICollectionView を拡張して編集機能を提供するメソッドとプロパティを定義します。

階層

Implemented by

プロパティ

canAddNew

canAddNew: boolean

コレクションに新しい項目を追加できるかどうかを示す値を取得します。

canCancelEdit

canCancelEdit: boolean

適用前の変更を破棄して編集されたオブジェクトの元の値を復元できるかどうかを示す値を取得します。

canFilter

canFilter: boolean

このビューがfilter プロパティによってフィルタリングをサポートしているかどうかを示す値を取得します。

canGroup

canGroup: boolean

このビューがgroupDescriptions プロパティによってグループ化をサポートしているかどうかを示す値を取得します。

canRemove

canRemove: boolean

コレクションから項目を削除できるかどうかを示す値を取得します。

canSort

canSort: boolean

このビューがsortDescriptions プロパティによってソートをサポートしているかどうかを示す値を取得します。

currentAddItem

currentAddItem: any

現在の追加トランザクションの間に追加される項目を取得します。

currentEditItem

currentEditItem: any

現在の編集トランザクションの間に編集される項目を取得します。

currentItem

currentItem: any

ビューの現在の項目を取得します。

currentPosition

currentPosition: number

ビューの現在の項目の順序位置を取得します。

filter

filter: IPredicate

項目がビューに含める対象として適しているかどうかを判断するために使用されるコールバックを取得または設定します。

メモ: フィルタ関数でスコープ(すなわち、有効な'this'値)が必要な場合は、 'this'オブジェクトを指定した'bind'関数を使用してフィルタを設定します。以下に例を示しています。

  collectionView.filter = this._filter.bind(this);

groupDescriptions

groupDescriptions: ObservableArray

コレクションの項目をビューでどのようにグループ化するかを記述するGroupDescription オブジェクトのコレクションを取得します。

groups

groups: any[]

最上位レベルのグループを取得します。

isAddingNew

isAddingNew: boolean

追加トランザクションが進行中であるかどうかを示す値を取得します。

isEditingItem

isEditingItem: boolean

編集トランザクションが進行中であるかどうかを示す値を取得します。

isEmpty

isEmpty: boolean

このビューに項目が1つも含まれていないかどうかを示す値を取得します。

items

items: any[]

フィルタリング、ソート、グループ化が適用されたビューの項目を取得します。

sortDescriptions

sortDescriptions: ObservableArray

コレクションの項目をビューでどのようにソートするかを記述するSortDescription オブジェクトのコレクションを取得します。

sourceCollection

sourceCollection: any

このビューの作成元のコレクションオブジェクトを取得または設定します。

メソッド

addNew

  • addNew(): any
  • コレクションに新しい項目を追加します。

    戻り値 any

    The item that was added to the collection.

beginUpdate

  • beginUpdate(): any

cancelEdit

  • cancelEdit(): any
  • 現在の編集トランザクションを終了し、可能であれば項目を元の値に戻します。

    戻り値 any

cancelNew

  • cancelNew(): any
  • 現在の追加トランザクションを終了し、追加前の新しい項目を破棄します。

    戻り値 any

commitEdit

  • commitEdit(): any
  • 現在の編集トランザクションを終了し、適用前の変更を保存します。

    戻り値 any

commitNew

  • commitNew(): any
  • 現在の追加トランザクションを終了し、追加前の新しい項目を保存します。

    戻り値 any

contains

  • contains(item: any): boolean
  • 指定した項目がこのビューに属するかどうかを示す値を返します。

    引数

    • item: any

      コレクション内で検索する項目。

    戻り値 boolean

deferUpdate

  • deferUpdate(fn: Function): any
  • beginUpdate/endUpdateブロック内で関数を実行します。

    この関数の実行が完了するまでコレクションは更新されません。 このメソッドは、関数が例外を生成した場合でもendUpdate が呼び出されるようにします。

    引数

    • fn: Function

      beginUpdate/endUpdateブロック内で実行する関数。

    戻り値 any

editItem

  • editItem(item: any): any
  • 指定した項目の編集トランザクションを開始します。

    引数

    • item: any

      編集する項目。

    戻り値 any

endUpdate

  • endUpdate(): any

implementsInterface

  • implementsInterface(interfaceName: string): boolean
  • オブジェクトが指定したインタフェースを実装している場合、trueを返します。

    引数

    • interfaceName: string

      調べるインタフェースの名前。

    戻り値 boolean

moveCurrentTo

  • moveCurrentTo(item: any): boolean

moveCurrentToFirst

  • moveCurrentToFirst(): boolean

moveCurrentToLast

  • moveCurrentToLast(): boolean

moveCurrentToNext

  • moveCurrentToNext(): boolean

moveCurrentToPosition

  • moveCurrentToPosition(index: number): boolean
  • ビューの指定したインデックスにある項目を現在の項目として設定します。

    引数

    • index: number

      currentItem として設定する項目のインデックス。

    戻り値 boolean

moveCurrentToPrevious

  • moveCurrentToPrevious(): any

refresh

  • refresh(): any
  • 現在のソート、フィルタ、およびグループパラメーターを使用してビューを再作成します。

    戻り値 any

remove

  • remove(item: any): any
  • 指定した項目をコレクションから削除します。

    引数

    • item: any

      コレクションから削除する項目。

    戻り値 any

removeAt

  • removeAt(index: number): any
  • 指定したインデックスにある項目をコレクションから削除します。

    引数

    • index: number

      コレクションから削除する項目のインデックス。

    戻り値 any

イベント

collectionChanged

collectionChanged: Event

Occurs when the collection changes.

currentChanged

currentChanged: Event

Occurs after the current item changes.

currentChanging

currentChanging: Event

Occurs before the current item changes.