v5.20191.603
|

IPagedCollectionView インターフェイス

ICollectionView を拡張してページング機能を提供するメソッドとプロパティを定義します。

階層

Implemented by

プロパティ

canChangePage

canChangePage: boolean

pageIndex 値を変更できるかどうかを示す値を取得します。

canFilter

canFilter: boolean

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

canGroup

canGroup: boolean

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

canSort

canSort: boolean

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

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[]

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

isEmpty

isEmpty: boolean

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

isPageChanging

isPageChanging: boolean

インデックスが変更されているかどうかを示す値を取得します。

itemCount

itemCount: number

ページングを考慮してビューの項目数を取得します。

項目の合計数を取得するには、totalItemCount プロパティを使用します。

これは、.NET IPagedCollectionView とは異なります。.NETの itemCounttotalItemCount はどちらも、ページングを適用する前の数を返します。

items

items: any[]

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

pageIndex

pageIndex: number

現在のページの0から始まるインデックスを取得します。

pageSize

pageSize: number

各ページに表示する項目数を取得または設定します。

sortDescriptions

sortDescriptions: ObservableArray

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

sourceCollection

sourceCollection: any

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

totalItemCount

totalItemCount: number

ページングを適用する前のビュー内の項目の合計数を取得します。

ページングを考慮しない現在のビュー内のアイテム数を取得するには、 itemCount プロパティを使用します。

これは、.NETIPagedCollectionView とは異なります。.NETの itemCounttotalItemCount はどちらも、ページングを適用する 前の数を返します。

メソッド

beginUpdate

  • beginUpdate(): any

contains

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

    引数

    • item: any

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

    戻り値 boolean

deferUpdate

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

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

    引数

    • fn: Function

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

    戻り値 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

moveToFirstPage

  • moveToFirstPage(): boolean
  • 最初のページを現在のページとして設定します。

    戻り値 boolean

moveToLastPage

  • moveToLastPage(): boolean
  • 最後のページを現在のページとして設定します。

    戻り値 boolean

moveToNextPage

  • moveToNextPage(): boolean
  • 現在のページの後のページに移動します。

    戻り値 boolean

moveToPage

  • moveToPage(index: number): boolean
  • 指定したインデックスにあるページに移動します。

    引数

    • index: number

      移動先ページのインデックス。

    戻り値 boolean

moveToPreviousPage

  • moveToPreviousPage(): boolean
  • 現在のページの前のページに移動します。

    戻り値 boolean

refresh

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

    戻り値 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.

pageChanged

pageChanged: Event

Occurs after the page index changes.

pageChanging

pageChanging: Event

Occurs before the page index changes.