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¶
Inherited Properties¶
Accessors¶
Class Accessors¶
Inherited Accessors¶
Methods¶
Class Methods¶
- getAllowDefaultValueIfOneItem
- getAllowEmptySelection
- getAllowMultipleSelection
- getDataPaging
- getFilterProperty
- getFilterValue
- getIsPickerDismissedOnSelection
- getIsSearchCancelledAfterSelection
- getIsSelectedSectionEnabled
- getPickerItems
- getPickerPrompt
- getSearch
- getTargetSpecifier
- setAllowDefaultValueIfOneItem
- setAllowEmptySelection
- setAllowMultipleSelection
- setDataPaging
- setFilterProperty
- setFilterValue
- setIsPickerDismissedOnSelection
- setIsSearchCancelledAfterSelection
- setIsSelectedSectionEnabled
- setPickerItems
- setPickerPrompt
- 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
Properties¶
Accessors¶
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
getSearch¶
▸ getSearch(): Object
Implementation of IListPickerFormCellProxy
Returns the Search property value defined for the FormCell's control.
Returns: Object
getTargetSpecifier¶
▸ getTargetSpecifier(): ListPickerFormCellTargetProxy
Implementation of IListPickerFormCellProxy
Overrides FormCellControlProxy.getTargetSpecifier
Returns: ListPickerFormCellTargetProxy
setAllowDefaultValueIfOneItem¶
▸ setAllowDefaultValueIfOneItem(allowDefaultValueIfOneItem: boolean): void
Implementation of IListPickerFormCellProxy
Sets the AllowDefaultValueIfOneItem property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
allowDefaultValueIfOneItem |
boolean | value to set. |
Returns: void
setAllowEmptySelection¶
▸ setAllowEmptySelection(allowEmptySelection: boolean): void
Implementation of IListPickerFormCellProxy
Returns the AllowEmptySelection property value defined for the FormCell's control.
Parameters:
| Name | Type |
|---|---|
allowEmptySelection |
boolean |
Returns: void
setAllowMultipleSelection¶
▸ setAllowMultipleSelection(allowMultipleSelection: boolean): any
Implementation of IListPickerFormCellProxy
Sets the AllowMultipleSelection property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
allowMultipleSelection |
boolean | value to set. |
Returns: any
setDataPaging¶
▸ setDataPaging(dataPaging: Object): void
Implementation of IListPickerFormCellProxy
Sets the DataPaging property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
dataPaging |
Object | value to set. |
Returns: void
setFilterProperty¶
▸ setFilterProperty(filterProperty: string): void
Implementation of IListPickerFormCellProxy
Sets the FilterProperty property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
filterProperty |
string | value to set. |
Returns: void
setFilterValue¶
▸ setFilterValue(filterValue: string[]): void
Implementation of IListPickerFormCellProxy
Sets the FilterValue property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
filterValue |
string[] | value to set. |
Returns: void
setIsPickerDismissedOnSelection¶
▸ setIsPickerDismissedOnSelection(isPickerDismissedOnSelection: boolean): void
Implementation of IListPickerFormCellProxy
Sets the IsPickerDismissedOnSelection property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
isPickerDismissedOnSelection |
boolean | value to set. |
Returns: void
setIsSearchCancelledAfterSelection¶
▸ setIsSearchCancelledAfterSelection(isSearchCancelledAfterSelection: boolean): void
Implementation of IListPickerFormCellProxy
Sets the IsSearchCancelledAfterSelection property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
isSearchCancelledAfterSelection |
boolean | value to set. |
Returns: void
setIsSelectedSectionEnabled¶
▸ setIsSelectedSectionEnabled(setIsSelectedSectionEnabled: boolean): void
Implementation of IListPickerFormCellProxy
Sets the IsSelectedSectionEnabled property of the FormCell's control.
Parameters:
| Name | Type |
|---|---|
setIsSelectedSectionEnabled |
boolean |
Returns: void
setPickerItems¶
▸ setPickerItems(pickerItems: any): void
Implementation of IListPickerFormCellProxy
Sets the PickerItems property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
pickerItems |
any | value to set. |
Returns: void
setPickerPrompt¶
▸ setPickerPrompt(pickerPrompt: string): void
Implementation of IListPickerFormCellProxy
Sets the PickerPrompt property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
pickerPrompt |
string | value to set. |
Returns: void
setSearch¶
▸ setSearch(search: Object): void
Implementation of IListPickerFormCellProxy
Sets the Search property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
search |
Object | value to set. |
Returns: void
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›