Class: ListPickerFormCellProxy¶
ListPickerFormCellProxy is a developer-facing interface that provides access to a ListPicker control and allows customizations. In addition it provides access to the IFormCellProxy interface.
Hierarchy¶
-
ListPickerFormCellProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Accessors¶
Class Accessors¶
Currently none in this class.
Inherited Accessors¶
Methods¶
Class Methods¶
- getAllowDefaultValueIfOneItem
- getAllowEmptySelection
- getAllowMultipleSelection
- getDataPaging
- getFilterProperty
- getFilterValue
- getIsPickerDismissedOnSelection
- getIsSearchCancelledAfterSelection
- getIsSelectedSectionEnabled
- getPickerItems
- getPickerPrompt
- getPlaceHolder
- getSearch
- getTargetSpecifier
- getValue
- setAllowDefaultValueIfOneItem
- setAllowEmptySelection
- setAllowMultipleSelection
- setDataPaging
- setFilterProperty
- setFilterValue
- setIsPickerDismissedOnSelection
- setIsSearchCancelledAfterSelection
- setIsSelectedSectionEnabled
- setPickerItems
- setPickerPrompt
- setPlaceHolder
- setSearch
- setTargetSpecifier
Inherited Methods¶
- _clientAPIProps
- _getExecuteSource
- applyValidation
- base64StringToBinary
- binaryToBase64String
- callFunction
- clearFocus
- clearValidation
- clearValidationOnValueChange
- convertFilterCriteriaArrayToJSONString
- convertJSONStringToFilterCriteriaArray
- count
- create
- createAttachmentEntry
- createFilterCriteria
- createFilterSelection
- createLinkSpecifierProxy
- createSorterSelection
- dataQueryBuilder
- deleteODataCacheImages
- dismissActivityIndicator
- downloadInProgressForPage
- downloadInProgressForReadLink
- evaluateTargetPath
- evaluateTargetPathForAPI
- executeAction
- formatBase64String
- formatCurrency
- formatDate
- formatDatetime
- formatNumber
- formatPercentage
- formatScientific
- formatTime
- getActionResult
- getAppClientData
- getAppearanceMode
- getAppEventData
- getAppName
- getAvailableThemes
- getBindingObject
- getCaption
- getCircularImage
- getClientData
- getCollection
- getDefinitionValue
- getEditable
- getEnable
- getEnabled
- getEventData
- getGlobalDefinition
- getGlobalSideDrawerControlProxy
- getHelperText
- getIconTextImage
- getLanguage
- getLogger
- getMobileServiceAppId
- getMobileServiceEndpointUrl
- getName
- getODataCacheImagePath
- getODataProvider
- getPageDefinition
- getPageProxy
- getParent
- getPasscodeSource
- getPendingDownload
- getReadLink
- getRegion
- getRegions
- getRequiredIndicator
- getRequiredIndicatorStyle
- getSAPPassportHeaderValue
- getSupportedLanguages
- getTargetSpecifier
- getTheme
- getType
- getUseInAppCamera
- getValidation
- getValue
- getVersionInfo
- getVisible
- initializeLogger
- isAppInMultiUserMode
- isContainer
- isCrashReportingEnabled
- isCurrentCrashConsentAllowed
- isCurrentPage
- isDemoMode
- isDeviceCompliant
- isMediaLocal
- localizeText
- read
- redraw
- reset
- sendMobileServiceRequest
- sendRequest
- setApplicationIconBadgeNumber
- setCaption
- setDebugSettings
- setEditable
- setEnable
- setEnabled
- setFocus
- setHelperText
- setLanguage
- setMdkWindows
- setRegion
- setRequiredIndicator
- setRequiredIndicatorStyle
- setStyle
- setTargetSpecifier
- setTheme
- setUseInAppCamera
- setValidationProperty
- setValue
- setVisible
- showActivityIndicator
- showCrashConsentDialog
- updateProgressBanner
Constructors¶
Constructor¶
+ new ListPickerFormCellProxy(context: IContext): ListPickerFormCellProxy
Inherited from FormCellControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
| context | IContext |
Returns: ListPickerFormCellProxy
Methods¶
getAllowDefaultValueIfOneItem¶
▸ getAllowDefaultValueIfOneItem(): boolean
Returns the AllowDefaultValueIfOneItem property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getAllowDefaultValueIfOneItem
Returns: boolean
getAllowEmptySelection¶
▸ getAllowEmptySelection(): any
Returns the AllowEmptySelection property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getAllowEmptySelection
Returns: any
getAllowMultipleSelection¶
▸ getAllowMultipleSelection(): boolean
Returns the AllowMultipleSelection property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getAllowMultipleSelection
Returns: boolean
getDataPaging¶
▸ getDataPaging(): Object
Returns the DataPaging property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getDataPaging
Returns: Object
getFilterProperty¶
▸ getFilterProperty(): string
Returns the FilterProperty property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getFilterProperty
Returns: string
getFilterValue¶
▸ getFilterValue(): string[]
Returns the FilterValue property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getFilterValue
Returns: string[]
getIsPickerDismissedOnSelection¶
▸ getIsPickerDismissedOnSelection(): boolean
Returns the IsPickerDismissedOnSelection property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getIsPickerDismissedOnSelection
Returns: boolean
getIsSearchCancelledAfterSelection¶
▸ getIsSearchCancelledAfterSelection(): boolean
Returns the IsSearchCancelledAfterSelection property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getIsSearchCancelledAfterSelection
Returns: boolean
getIsSelectedSectionEnabled¶
▸ getIsSelectedSectionEnabled(): boolean
Returns the IsSelectedSectionEnabled property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getIsSelectedSectionEnabled
Returns: boolean
getPickerItems¶
▸ getPickerItems(): any
Returns the PickerItems property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getPickerItems
Returns: any
getPickerPrompt¶
▸ getPickerPrompt(): string
Returns the PickerPrompt property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getPickerPrompt
Returns: string
getPlaceHolder¶
▸ getPlaceHolder(): string
Returns the PlaceHolder property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getPlaceHolder
Returns: string
getSearch¶
▸ getSearch(): ISearch
Returns the Search property value defined for the FormCell's control.
Implementation of IListPickerFormCellProxy.getSearch
Returns: ISearch
getTargetSpecifier¶
▸ getTargetSpecifier(): ListPickerFormCellTargetProxy
Get target specifier for this FormCell control
Implementation of IListPickerFormCellProxy.getTargetSpecifier Overrides FormCellControlProxy.getTargetSpecifier
Returns: ListPickerFormCellTargetProxy
getValue¶
▸ getValue(): Object[]
Returns the list of selected items as JavaScript Objects, each with ReturnValue and DisplayValue properties. If the ListPicker is bound to an entity set, each item will have a BindingObject property containing the full associated binding object.
Implementation of IListPickerFormCellProxy.getValue Overrides FormCellControlProxy.getValue
Returns: Object[]
setAllowDefaultValueIfOneItem¶
▸ setAllowDefaultValueIfOneItem(allowDefaultValueIfOneItem: boolean): Promise<any>
Sets the AllowDefaultValueIfOneItem property of the FormCell's control.
Implementation of IListPickerFormCellProxy.setAllowDefaultValueIfOneItem
Parameters:
| Name | Type | Description |
|---|---|---|
| allowDefaultValueIfOneItem | boolean | value to set. |
Returns: Promise<any>
setAllowEmptySelection¶
▸ setAllowEmptySelection(allowEmptySelection: boolean): Promise<any>
Sets the AllowEmptySelection property of the FormCell's control.
Implementation of IListPickerFormCellProxy.setAllowEmptySelection
Parameters:
| Name | Type | Description |
|---|---|---|
| allowEmptySelection | boolean | value to set. |
Returns: Promise<any>
setAllowMultipleSelection¶
▸ setAllowMultipleSelection(allowMultipleSelection: boolean): Promise<any>
Sets the AllowMultipleSelection property of the FormCell's control.
Implementation of IListPickerFormCellProxy.setAllowMultipleSelection
Parameters:
| Name | Type | Description |
|---|---|---|
| allowMultipleSelection | boolean | value to set. |
Returns: Promise<any>
setDataPaging¶
▸ setDataPaging(dataPaging: Object): Promise<any>
Sets the DataPaging property of the FormCell's control.
Implementation of IListPickerFormCellProxy.setDataPaging
Parameters:
| Name | Type | Description |
|---|---|---|
| dataPaging | Object | value to set. |
Returns: Promise<any>
setFilterProperty¶
▸ setFilterProperty(filterProperty: string): Promise<any>
Sets the FilterProperty property of the FormCell's control.
Implementation of IListPickerFormCellProxy.setFilterProperty
Parameters:
| Name | Type | Description |
|---|---|---|
| filterProperty | string | value to set. |
Returns: Promise<any>
setFilterValue¶
▸ setFilterValue(filterValue: string[]): Promise<any>
Sets the FilterValue property of the FormCell's control.
Implementation of IListPickerFormCellProxy.setFilterValue
Parameters:
| Name | Type | Description |
|---|---|---|
| filterValue | string[] | value to set. |
Returns: Promise<any>
setIsPickerDismissedOnSelection¶
▸ setIsPickerDismissedOnSelection(isPickerDismissedOnSelection: boolean): Promise<any>
Sets the IsPickerDismissedOnSelection property of the FormCell's control.
Implementation of IListPickerFormCellProxy.setIsPickerDismissedOnSelection
Parameters:
| Name | Type | Description |
|---|---|---|
| isPickerDismissedOnSelection | boolean | value to set. |
Returns: Promise<any>
setIsSearchCancelledAfterSelection¶
▸ setIsSearchCancelledAfterSelection(isSearchCancelledAfterSelection: boolean): Promise<any>
Sets the IsSearchCancelledAfterSelection property of the FormCell's control.
Implementation of IListPickerFormCellProxy.setIsSearchCancelledAfterSelection
Parameters:
| Name | Type | Description |
|---|---|---|
| isSearchCancelledAfterSelection | boolean | value to set. |
Returns: Promise<any>
setIsSelectedSectionEnabled¶
▸ setIsSelectedSectionEnabled(setIsSelectedSectionEnabled: boolean): Promise<any>
Sets the IsSelectedSectionEnabled property of the FormCell's control.
Implementation of IListPickerFormCellProxy.setIsSelectedSectionEnabled
Parameters:
| Name | Type |
|---|---|
| setIsSelectedSectionEnabled | boolean |
Returns: Promise<any>
setPickerItems¶
▸ setPickerItems(pickerItems: any): Promise<any>
Sets the PickerItems property of the FormCell's control.
Implementation of IListPickerFormCellProxy.setPickerItems
Parameters:
| Name | Type | Description |
|---|---|---|
| pickerItems | any | value to set. |
Returns: Promise<any>
setPickerPrompt¶
▸ setPickerPrompt(pickerPrompt: string): Promise<any>
Sets the PickerPrompt property of the FormCell's control.
Implementation of IListPickerFormCellProxy.setPickerPrompt
Parameters:
| Name | Type | Description |
|---|---|---|
| pickerPrompt | string | value to set. |
Returns: Promise<any>
setPlaceHolder¶
▸ setPlaceHolder(placeHolder: string): Promise<any>
Sets the PlaceHolder property of the FormCell's FormCell's control.
Implementation of IListPickerFormCellProxy.setPlaceHolder
Parameters:
| Name | Type | Description |
|---|---|---|
| placeHolder | string | value to set. |
Returns: Promise<any>
setSearch¶
▸ setSearch(search: ISearch): Promise<any>
Sets the Search property of the FormCell's control.
Implementation of IListPickerFormCellProxy.setSearch
Parameters:
| Name | Type | Description |
|---|---|---|
| search | ISearch | value to set. |
Returns: Promise<any>
setTargetSpecifier¶
▸ setTargetSpecifier(specifier: IFormCellTargetProxy, redraw?: boolean): Promise<any>
Set the list picker
Implementation of IListPickerFormCellProxy.setTargetSpecifier Overrides FormCellControlProxy.setTargetSpecifier
Parameters:
| Name | Type | Description |
|---|---|---|
| specifier | IFormCellTargetProxy | specifier for the listpicker |
| redraw? | boolean | whether to redraw formcell If the specifier is an instance of ListPickerFormCellTargetProxy, then set it to the FormCell control. Otherwise, set it to the parent control |
Returns: Promise<any>