Skip to content

Class: SelectableSectionProxy

Hierarchy

Implements

Summary

Constructors

Properties

Class Properties

Inherited Properties

Accessors

Class Accessors

Inherited Accessors

Methods

Class Methods

Inherited Methods

Constructors

constructor

+ new SelectableSectionProxy(context: IContext): SelectableSectionProxy

Overrides BindableSectionProxy.constructor

Parameters:

Name Type
context IContext

Returns: SelectableSectionProxy

Properties

Accessors

Methods

deselectAllItems

deselectAllItems(): void

Implementation of ISelectableSectionProxy

Deselect all selected items of the section if it is in multiple selection mode.

Returns: void


getSelectedItems

getSelectedItems(): [SelectedItem]

Implementation of ISelectableSectionProxy

Get the current section selected items when selection mode is active. Otherwise an empty array will be returned.

Returns: [SelectedItem]


getSelectedItemsCount

getSelectedItemsCount(): number

Implementation of ISelectableSectionProxy

Returns the number of selected items in the section.

Returns: number


getSelectionChangedItem

getSelectionChangedItem(): ChangedItem

Implementation of ISelectableSectionProxy

Get the last selected or deselected item.

Returns: ChangedItem


getSelectionMode

getSelectionMode(): string

Implementation of ISelectableSectionProxy

Get selection mode for the current section. The return value is None or Multiple

Returns: string


selectAllItems

selectAllItems(): void

Implementation of ISelectableSectionProxy

Select all unselected items of the section if it is in multiple selection mode. Only items that are loaded and rendered will be selected. Items that are subsequently loaded via data paging will not be selected.

Returns: void


setSelectionMode

setSelectionMode(mode: string): any

Implementation of ISelectableSectionProxy

Set the section selection mode

Parameters:

Name Type
mode string

Returns: any