Class: SelectableSectionProxy¶
A IBindableSectionProxy can get/set the section's target. If a section doesn't have a section target, it doesn't support the interface
It is passed to rules to provide access to a section's target for application specific customizations.
Hierarchy¶
-
SelectableSectionProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Accessors¶
Class Accessors¶
Currently none in this class.
Inherited Accessors¶
- actionResults
- binding
- currentPage
- dataSubscriptions
- filterBarFilterQuery
- filterBarSorterQuery
- filters
- filterTypeEnum
- mdkWindows
- searchString
Methods¶
Class Methods¶
- deselectAllItems
- getSelectedItems
- getSelectedItemsCount
- getSelectionChangedItem
- getSelectionMode
- selectAllItems
- setSelectionMode
Inherited Methods¶
- _clientAPIProps
- _getExecuteSource
- base64StringToBinary
- binaryToBase64String
- callFunction
- convertFilterCriteriaArrayToJSONString
- convertJSONStringToFilterCriteriaArray
- count
- create
- createFilterCriteria
- createFilterSelection
- createLinkSpecifierProxy
- createSorterSelection
- deleteODataCacheImages
- dismissActivityIndicator
- downloadInProgressForPage
- downloadInProgressForReadLink
- evaluateTargetPath
- evaluateTargetPathForAPI
- executeAction
- formatBase64String
- formatCurrency
- formatDate
- formatDatetime
- formatNumber
- formatPercentage
- formatScientific
- formatTime
- getActionResult
- getAppClientData
- getAppearanceMode
- getAppEventData
- getAppName
- getAvailableThemes
- getBindingObject
- getCircularImage
- getClientData
- getControl
- getControls
- getDefinitionValue
- getEventData
- getExtensions
- getFilterBar
- getGlobalDefinition
- getGlobalSideDrawerControlProxy
- getGroupHeader
- getHeader
- getIconTextImage
- getLanguage
- getLoadedItemsCount
- getLogger
- getMobileServiceAppId
- getMobileServiceEndpointUrl
- getName
- getODataCacheImagePath
- getODataProvider
- getPageDefinition
- getPageProxy
- getParent
- getPasscodeSource
- getPendingDownload
- getProperty
- getReadLink
- getRegion
- getRegions
- getSAPPassportHeaderValue
- getSupportedLanguages
- getTargetSpecifier
- getTheme
- getType
- getUseInAppCamera
- getVersionInfo
- getVisible
- initializeLogger
- isAppInMultiUserMode
- isCurrentPage
- isDemoMode
- isDeviceCompliant
- isMediaLocal
- isStaticSection
- localizeText
- read
- redraw
- sendMobileServiceRequest
- sendRequest
- setApplicationIconBadgeNumber
- setDebugSettings
- setFilters
- setIndicatorState
- setLanguage
- setMdkWindows
- setRegion
- setTargetSpecifier
- setTheme
- setUseInAppCamera
- setVisible
- showActivityIndicator
- updateProgressBanner
Constructors¶
Constructor¶
+ new SelectableSectionProxy(context: IContext): SelectableSectionProxy
Overrides BindableSectionProxy.constructor
Parameters:
| Name | Type |
|---|---|
| context | IContext |
Returns: SelectableSectionProxy
Methods¶
deselectAllItems¶
▸ deselectAllItems(): void
Deselect all selected items of the section if it is in multiple selection mode.
Implementation of ISelectableSectionProxy.deselectAllItems
Returns: void
getSelectedItems¶
▸ getSelectedItems(): [SelectedItem]
Get the current section selected items when selection mode is active. Otherwise an empty array will be returned.
Implementation of ISelectableSectionProxy.getSelectedItems
Returns: [SelectedItem]
getSelectedItemsCount¶
▸ getSelectedItemsCount(): number
Returns the number of selected items in the section.
Implementation of ISelectableSectionProxy.getSelectedItemsCount
Returns: number
getSelectionChangedItem¶
▸ getSelectionChangedItem(): ChangedItem
Get the last selected or deselected item.
Implementation of ISelectableSectionProxy.getSelectionChangedItem
Returns: ChangedItem
getSelectionMode¶
▸ getSelectionMode(): string
Get selection mode for the current section. The return value is None or Multiple
Implementation of ISelectableSectionProxy.getSelectionMode
Returns: string
selectAllItems¶
▸ selectAllItems(): void
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.
Implementation of ISelectableSectionProxy.selectAllItems
Returns: void
setSelectionMode¶
▸ setSelectionMode(mode: string): any
Set the section selection mode
Implementation of ISelectableSectionProxy.setSelectionMode
Parameters:
| Name | Type |
|---|---|
| mode | string |
Returns: any