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¶
Constructors¶
constructor¶
+ new ListPickerFormCellProxy(context: IContext): ListPickerFormCellProxy
Inherited from FormCellControlProxy.constructor
Overrides ControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
context |
IContext |
Returns: ListPickerFormCellProxy
Methods¶
getAllowDefaultValueIfOneItem¶
▸ getAllowDefaultValueIfOneItem(): boolean
Implementation of IListPickerFormCellProxy
Returns the AllowDefaultValueIfOneItem property value defined for the FormCell's control.
Returns: boolean
getAllowEmptySelection¶
▸ getAllowEmptySelection(): any
Implementation of IListPickerFormCellProxy
Returns the AllowEmptySelection property value defined for the FormCell's control.
Returns: any
getAllowMultipleSelection¶
▸ getAllowMultipleSelection(): boolean
Implementation of IListPickerFormCellProxy
Returns the AllowMultipleSelection property value defined for the FormCell's control.
Returns: boolean
getDataPaging¶
▸ getDataPaging(): Object
Implementation of IListPickerFormCellProxy
Returns the DataPaging property value defined for the FormCell's control.
Returns: Object
getFilterProperty¶
▸ getFilterProperty(): string
Implementation of IListPickerFormCellProxy
Returns the FilterProperty property value defined for the FormCell's control.
Returns: string
getFilterValue¶
▸ getFilterValue(): string[]
Implementation of IListPickerFormCellProxy
Returns the FilterValue property value defined for the FormCell's control.
Returns: string[]
getIsPickerDismissedOnSelection¶
▸ getIsPickerDismissedOnSelection(): boolean
Implementation of IListPickerFormCellProxy
Returns the IsPickerDismissedOnSelection property value defined for the FormCell's control.
Returns: boolean
getIsSearchCancelledAfterSelection¶
▸ getIsSearchCancelledAfterSelection(): boolean
Implementation of IListPickerFormCellProxy
Returns the IsSearchCancelledAfterSelection property value defined for the FormCell's control.
Returns: boolean
getIsSelectedSectionEnabled¶
▸ getIsSelectedSectionEnabled(): boolean
Implementation of IListPickerFormCellProxy
Returns the IsSelectedSectionEnabled property value defined for the FormCell's control.
Returns: boolean
getPickerItems¶
▸ getPickerItems(): any
Implementation of IListPickerFormCellProxy
Returns the PickerItems property value defined for the FormCell's control.
Returns: any
getPickerPrompt¶
▸ getPickerPrompt(): string
Implementation of IListPickerFormCellProxy
Returns the PickerPrompt property value defined for the FormCell's control.
Returns: string
getPlaceHolder¶
▸ getPlaceHolder(): string
Implementation of IListPickerFormCellProxy
Returns the PlaceHolder property value defined for the FormCell's control.
Returns: string
getSearch¶
▸ getSearch(): ISearch
Implementation of IListPickerFormCellProxy
Returns the Search property value defined for the FormCell's control.
Returns: ISearch
getTargetSpecifier¶
▸ getTargetSpecifier(): ListPickerFormCellTargetProxy
Implementation of IListPickerFormCellProxy
Overrides FormCellControlProxy.getTargetSpecifier
Returns: ListPickerFormCellTargetProxy
getValue¶
▸ getValue(): Object[]
Implementation of IListPickerFormCellProxy
Overrides ControlProxy.getValue
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.
Returns: Object[]
setAllowDefaultValueIfOneItem¶
▸ setAllowDefaultValueIfOneItem(allowDefaultValueIfOneItem: boolean): Promise‹any›
Implementation of IListPickerFormCellProxy
Sets the AllowDefaultValueIfOneItem property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
allowDefaultValueIfOneItem |
boolean | value to set. |
Returns: Promise‹any›
setAllowEmptySelection¶
▸ setAllowEmptySelection(allowEmptySelection: boolean): Promise‹any›
Implementation of IListPickerFormCellProxy
Sets the AllowEmptySelection property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
allowEmptySelection |
boolean | value to set. |
Returns: Promise‹any›
setAllowMultipleSelection¶
▸ setAllowMultipleSelection(allowMultipleSelection: boolean): Promise‹any›
Implementation of IListPickerFormCellProxy
Sets the AllowMultipleSelection property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
allowMultipleSelection |
boolean | value to set. |
Returns: Promise‹any›
setDataPaging¶
▸ setDataPaging(dataPaging: Object): Promise‹any›
Implementation of IListPickerFormCellProxy
Sets the DataPaging property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
dataPaging |
Object | value to set. |
Returns: Promise‹any›
setFilterProperty¶
▸ setFilterProperty(filterProperty: string): Promise‹any›
Implementation of IListPickerFormCellProxy
Sets the FilterProperty property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
filterProperty |
string | value to set. |
Returns: Promise‹any›
setFilterValue¶
▸ setFilterValue(filterValue: string[]): Promise‹any›
Implementation of IListPickerFormCellProxy
Sets the FilterValue property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
filterValue |
string[] | value to set. |
Returns: Promise‹any›
setIsPickerDismissedOnSelection¶
▸ setIsPickerDismissedOnSelection(isPickerDismissedOnSelection: boolean): Promise‹any›
Implementation of IListPickerFormCellProxy
Sets the IsPickerDismissedOnSelection property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
isPickerDismissedOnSelection |
boolean | value to set. |
Returns: Promise‹any›
setIsSearchCancelledAfterSelection¶
▸ setIsSearchCancelledAfterSelection(isSearchCancelledAfterSelection: boolean): Promise‹any›
Implementation of IListPickerFormCellProxy
Sets the IsSearchCancelledAfterSelection property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
isSearchCancelledAfterSelection |
boolean | value to set. |
Returns: Promise‹any›
setIsSelectedSectionEnabled¶
▸ setIsSelectedSectionEnabled(setIsSelectedSectionEnabled: boolean): Promise‹any›
Implementation of IListPickerFormCellProxy
Sets the IsSelectedSectionEnabled property of the FormCell's control.
Parameters:
| Name | Type |
|---|---|
setIsSelectedSectionEnabled |
boolean |
Returns: Promise‹any›
setPickerItems¶
▸ setPickerItems(pickerItems: any): Promise‹any›
Implementation of IListPickerFormCellProxy
Sets the PickerItems property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
pickerItems |
any | value to set. |
Returns: Promise‹any›
setPickerPrompt¶
▸ setPickerPrompt(pickerPrompt: string): Promise‹any›
Implementation of IListPickerFormCellProxy
Sets the PickerPrompt property of the FormCell's control.
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.
Parameters:
| Name | Type | Description |
|---|---|---|
placeHolder |
string | value to set. |
Returns: Promise‹any›
setSearch¶
▸ setSearch(search: ISearch): Promise‹any›
Implementation of IListPickerFormCellProxy
Sets the Search property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
search |
ISearch | value to set. |
Returns: Promise‹any›
setTargetSpecifier¶
▸ setTargetSpecifier(specifier: IFormCellTargetProxy, redraw?: boolean): Promise‹any›
Implementation of IListPickerFormCellProxy
Overrides FormCellControlProxy.setTargetSpecifier
Set the list picker
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›