# Wijmo.Ieditablecollectionview ## Content

IEditableCollectionView Interface

Defines methods and properties that extend ICollectionView to provide editing capabilities.

Type parameters

Heirarchy

Implemented by

Properties

Methods

Events

Properties

canAddNew

canAddNew: boolean

Gets a value that indicates whether a new item can be added to the collection.

canCancelEdit

canCancelEdit: boolean

Gets a value that indicates whether the collection view can discard pending changes and restore the original values of an edited object.

canFilter

canFilter: boolean

Gets a value that indicates whether this view supports filtering via the filter property.

canGroup

canGroup: boolean

Gets a value that indicates whether this view supports grouping via the groupDescriptions property.

canRemove

canRemove: boolean

Gets a value that indicates whether items can be removed from the collection.

canSort

canSort: boolean

Gets a value that indicates whether this view supports sorting via the sortDescriptions property.

currentAddItem

currentAddItem: T

Gets the item that is being added during the current add transaction.

currentEditItem

currentEditItem: T

Gets the item that is being edited during the current edit transaction.

currentItem

currentItem: T

Gets the current item in the view.

currentPosition

currentPosition: number

Gets the ordinal position of the current item in the view.

filter

filter: IPredicate<T> | null

Gets or sets a callback used to determine if an item is suitable for inclusion in the view.

NOTE: If the filter function needs a scope (i.e. a meaningful 'this' value), then remember to set the filter using the 'bind' function to specify the 'this' object. For example:

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

groupDescriptions

groupDescriptions: ObservableArray<GroupDescription>

Gets a collection of GroupDescription objects that describe how the items in the collection are grouped in the view.

groups

groups: any[]

Gets the top-level groups.

isAddingNew

isAddingNew: boolean

Gets a value that indicates whether an add transaction is in progress.

isEditingItem

isEditingItem: boolean

Gets a value that indicates whether an edit transaction is in progress.

isEmpty

isEmpty: boolean

Gets a value that indicates whether this view contains no items.

items

items: T[]

Gets the filtered, sorted, grouped items in the view.

newItemIndex

newItemIndex: number

Gets or sets the zero-based index that the new row template uses when inserting items.

When paging is enabled, values in the range 0..pageSize - 1 map to positions within the current page. Values less than zero or greater than or equal to the current page size keep the original add-new behavior and append items to the end of the source collection. When paging is disabled, non-negative values are treated as positions within the full source collection.

sortDescriptions

sortDescriptions: ObservableArray<SortDescription>

Gets a collection of SortDescription objects that describe how the items in the collection are sorted in the view.

sourceCollection

sourceCollection: T[]

Gets or sets the collection object from which to create this view.

Methods

addNew

  • addNew(): any

  • Adds a new item to the collection.

    Returns any

    The item that was added to the collection.

beginUpdate

  • beginUpdate(): void

cancelEdit

  • cancelEdit(): void

  • Ends the current edit transaction and, if possible, restores the original value to the item.

    Returns void

cancelNew

  • cancelNew(): void

  • Ends the current add transaction and discards the pending new item.

    Returns void

commitEdit

  • commitEdit(): void

  • Ends the current edit transaction and saves the pending changes.

    Returns void

commitNew

  • commitNew(): void

  • Ends the current add transaction and saves the pending new item.

    Returns void

contains

  • contains(item: T): boolean

  • Returns a value that indicates whether a given item belongs to this view.

    Parameters

    • item: T

      The item to locate in the collection.

    Returns boolean

deferUpdate

  • deferUpdate(fn: Function, force?: boolean): void

  • Executes a function within a beginUpdate/endUpdate block.

    The collection will not be refreshed until the function has been executed. This method ensures endUpdate is called even if the function throws.

    Parameters

    • fn: Function

      Function to be executed within the beginUpdate/endUpdate block.

    • Optional force: boolean

      Whether to force a refresh when ending the update.

    Returns void

editItem

  • editItem(item: T): void

  • Begins an edit transaction of the specified item.

    Parameters

    • item: T

      Item to edit.

    Returns void

endUpdate

  • endUpdate(force?: boolean): void

  • Resumes refreshes suspended by a call to beginUpdate.

    Parameters

    • Optional force: boolean

      Whether to force a refresh when ending the update.

    Returns void

implementsInterface

  • implementsInterface(interfaceName: string): boolean

  • Returns true if the object implements a given interface.

    Parameters

    • interfaceName: string

      Name of the interface to look for.

    Returns boolean

insertAt

  • insertAt(index: number, item?: any, commit?: boolean): any

  • Adds a new item to the collection at the specified position.

    Similar to removeAt, the index is relative to the view, not to the source collection. When paging is enabled, values in the range 0..pageSize - 1 map to positions within the current page. Values less than zero or greater than or equal to the current page size are ignored. When sorting , filtering or grouping is active, valid indexes fall back to the original add-new behavior and append items to the end of the source collection. When paging is disabled, non-negative values are treated as positions within the full source collection.

    Parameters

    • index: number

      Zero-based position where the new item should be inserted.

    • Optional item: any

      Optional item to add.

    • Optional commit: boolean

      Whether to commit the new item immediately.

    Returns any

    The item that was added to the collection, or null if the operation failed.

moveCurrentTo

  • moveCurrentTo(item: T): boolean

moveCurrentToFirst

  • moveCurrentToFirst(): boolean

moveCurrentToLast

  • moveCurrentToLast(): boolean

moveCurrentToNext

  • moveCurrentToNext(): boolean

moveCurrentToPosition

  • moveCurrentToPosition(index: number): boolean

moveCurrentToPrevious

  • moveCurrentToPrevious(): boolean

refresh

  • refresh(): void

  • Re-creates the view using the current sort, filter, and group parameters.

    Returns void

remove

  • remove(item: T): void

  • Removes the specified item from the collection.

    Parameters

    • item: T

      Item to remove from the collection.

    Returns void

removeAt

  • removeAt(index: number): void

  • Removes the item at the specified index from the collection.

    Parameters

    • index: number

      Index of the item to remove from the collection.

    Returns void

Events

collectionChanged

collectionChanged: Event<INotifyCollectionChanged, NotifyCollectionChangedEventArgs>

Occurs when the collection changes.

currentChanged

currentChanged: Event<ICollectionView, EventArgs>

Occurs after the current item changes.

currentChanging

currentChanging: Event<ICollectionView, EventArgs>

Occurs before the current item changes.