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