LookupBuilder Methods
A Lookup control.| Name | Description |
|---|---|
| AccessKey(JS) | Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option. |
| AccessKey(String) | Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option. |
| ActiveStateEnabled(JS) | Mirrors the client-side activeStateEnabled option. |
| ActiveStateEnabled(Boolean) | Mirrors the client-side activeStateEnabled option. |
| ApplyButtonText(JS) | The text displayed on the Apply button. Mirrors the client-side applyButtonText option. |
| ApplyButtonText(String) | The text displayed on the Apply button. Mirrors the client-side applyButtonText option. |
| ApplyValueMode(EditorApplyValueMode) | Mirrors the client-side applyValueMode option. |
| CancelButtonText(JS) | The text displayed on the Cancel button. Mirrors the client-side cancelButtonText option. |
| CancelButtonText(String) | The text displayed on the Cancel button. Mirrors the client-side cancelButtonText option. |
| CleanSearchOnOpening(JS) | Specifies whether or not the UI component cleans the search box when the popup window is displayed. Mirrors the client-side cleanSearchOnOpening option. |
| CleanSearchOnOpening(Boolean) | Specifies whether or not the UI component cleans the search box when the popup window is displayed. Mirrors the client-side cleanSearchOnOpening option. |
| ClearButtonText(JS) | The text displayed on the Clear button. Mirrors the client-side clearButtonText option. |
| ClearButtonText(String) | The text displayed on the Clear button. Mirrors the client-side clearButtonText option. |
| DataSource(JS) | Binds the UI component to data. Mirrors the client-side dataSource option. |
| DataSource(IEnumerable, String[]) |
Binds a Lookup control to a collection: Array, List, or IEnumerable.
|
| DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) | Binds a Lookup control to data, allows you to configure data access from different sources: API controllers, Razor page handlers, OData services, arrays, and more. |
| DataSource(String, String[]) | Binds a Lookup control to read-only data in JSON format. |
| DataSourceOptions(Action<DataSourceOptionsBuilder>) | Provides access to methods that mirror client-side data source options. |
| DeferRendering(JS) | Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately. Mirrors the client-side deferRendering option. |
| DeferRendering(Boolean) | Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately. Mirrors the client-side deferRendering option. |
| Disabled(JS) | Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option. |
| Disabled(Boolean) | Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option. |
| DisplayExpr(JS) | Specifies the data field whose values should be displayed. Mirrors the client-side displayExpr option. |
| DisplayExpr(String) | Specifies the data field whose values should be displayed. Mirrors the client-side displayExpr option. |
| DisplayValue(JS) | Obsolete. Returns the value currently displayed by the UI component. Mirrors the client-side displayValue option. |
| DisplayValue(String) | Obsolete. Returns the value currently displayed by the UI component. Mirrors the client-side displayValue option. |
| DropDownCentered(JS) | Specifies whether to vertically align the drop-down menu so that the selected item is in its center. Applies only in Material Design themes. Mirrors the client-side dropDownCentered option. |
| DropDownCentered(Boolean) | Specifies whether to vertically align the drop-down menu so that the selected item is in its center. Applies only in Material Design themes. Mirrors the client-side dropDownCentered option. |
| DropDownOptions(Action<PopoverBuilder>) | Configures the drop-down field. Mirrors the client-side dropDownOptions object. |
| ElementAttr(JS) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Dictionary<String, Object>) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Object) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(String, Object) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| FieldTemplate(JS) | Specifies the client-side fieldTemplate. |
| FieldTemplate(RazorBlock) | Specifies the client-side fieldTemplate. |
| FieldTemplate(TemplateName) | Specifies the client-side fieldTemplate. |
| FieldTemplate(String) | Specifies the client-side fieldTemplate. |
| FocusStateEnabled(JS) | Mirrors the client-side focusStateEnabled option. |
| FocusStateEnabled(Boolean) | Mirrors the client-side focusStateEnabled option. |
| FullScreen(JS) | Obsolete. A Boolean value specifying whether or not to display the lookup in full-screen mode. Mirrors the client-side fullScreen option. |
| FullScreen(Boolean) | Obsolete. A Boolean value specifying whether or not to display the lookup in full-screen mode. Mirrors the client-side fullScreen option. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| Grouped(JS) | Specifies whether data items should be grouped. Mirrors the client-side grouped option. |
| Grouped(Boolean) | Specifies whether data items should be grouped. Mirrors the client-side grouped option. |
| GroupTemplate(JS) | Specifies the client-side groupTemplate. |
| GroupTemplate(RazorBlock) | Specifies the client-side groupTemplate. |
| GroupTemplate(TemplateName) | Specifies the client-side groupTemplate. |
| GroupTemplate(String) | Specifies the client-side groupTemplate. |
| Height(JS) | Specifies the UI component's height. Mirrors the client-side height option. |
| Height(Double) | Specifies the UI component's height. Mirrors the client-side height option. |
| Height(String) | Specifies the UI component's height. Mirrors the client-side height option. |
| Hint(JS) | Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option. |
| Hint(String) | Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option. |
| HoverStateEnabled(JS) | Mirrors the client-side hoverStateEnabled option. |
| HoverStateEnabled(Boolean) | Mirrors the client-side hoverStateEnabled option. |
| ID(JS) |
Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
|
| ID(String) |
Specifies the id attribute for the control’s HTML element.
|
| InputAttr(JS) |
Mirrors the client-side inputAttr option, specifies attributes for the control’s underlying <input> HTML element.
|
| InputAttr(Dictionary<String, Object>) |
Mirrors the client-side inputAttr option, specifies attributes for the control’s underlying <input> HTML element.
|
| InputAttr(Object) |
Mirrors the client-side inputAttr option, specifies attributes for the control’s underlying <input> HTML element.
|
| InputAttr(String, Object) |
Mirrors the client-side inputAttr option, specifies attributes for the control’s underlying <input> HTML element.
|
| IsDirty(JS) | |
| IsDirty(Boolean) | |
| IsValid(JS) | Specifies or indicates whether the editor's value is valid. Mirrors the client-side isValid option. |
| IsValid(Boolean) | Specifies or indicates whether the editor's value is valid. Mirrors the client-side isValid option. |
| Items(Action<CollectionFactory<LookupItemBuilder>>) | Provides access to the client-side items option that represents a Lookup item collection. |
| Items(IEnumerable<String>) | An array of items displayed by the UI component. Mirrors the client-side items option. |
| ItemTemplate(JS) | Specifies the client-side itemTemplate. |
| ItemTemplate(RazorBlock) | Specifies the client-side itemTemplate. |
| ItemTemplate(TemplateName) | Specifies the client-side itemTemplate. |
| ItemTemplate(String) | Specifies the client-side itemTemplate. |
| Label(JS) | |
| Label(String) | |
| LabelMode(EditorLabelMode) | |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MinSearchLength(JS) | The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true. Mirrors the client-side minSearchLength option. |
| MinSearchLength(Int32) | The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true. Mirrors the client-side minSearchLength option. |
| Name(JS) | Mirrors the client-side name option. |
| Name(String) | Mirrors the client-side name option. |
| NextButtonText(JS) | The text displayed on the button used to load the next page from the data source. Mirrors the client-side nextButtonText option. |
| NextButtonText(String) | The text displayed on the button used to load the next page from the data source. Mirrors the client-side nextButtonText option. |
| NoDataText(JS) | Specifies the text or HTML markup displayed by the UI component if the item collection is empty. Mirrors the client-side noDataText option. |
| NoDataText(String) | Specifies the text or HTML markup displayed by the UI component if the item collection is empty. Mirrors the client-side noDataText option. |
| OnClosed(RazorBlock) | A function that is executed once the drop-down editor is closed. Mirrors the client-side onClosed option. |
| OnClosed(String) | A function that is executed once the drop-down editor is closed. Mirrors the client-side onClosed option. |
| OnContentReady(RazorBlock) | A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option. |
| OnContentReady(String) | A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option. |
| OnDisposing(RazorBlock) | A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option. |
| OnDisposing(String) | A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option. |
| OnInitialized(RazorBlock) | A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option. |
| OnInitialized(String) | A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option. |
| OnItemClick(RazorBlock) | A function that is executed when a list item is clicked or tapped. Mirrors the client-side onItemClick option. |
| OnItemClick(String) | A function that is executed when a list item is clicked or tapped. Mirrors the client-side onItemClick option. |
| OnOpened(RazorBlock) | A function that is executed once the drop-down editor is opened. Mirrors the client-side onOpened option. |
| OnOpened(String) | A function that is executed once the drop-down editor is opened. Mirrors the client-side onOpened option. |
| OnOptionChanged(RazorBlock) | A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option. |
| OnOptionChanged(String) | A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option. |
| OnPageLoading(RazorBlock) | A function that is executed before the next page is loaded. Mirrors the client-side onPageLoading option. |
| OnPageLoading(String) | A function that is executed before the next page is loaded. Mirrors the client-side onPageLoading option. |
| OnPullRefresh(RazorBlock) | A function that is executed when the 'pull to refresh' gesture is performed on the drop-down item list. Supported on mobile devices only. Mirrors the client-side onPullRefresh option. |
| OnPullRefresh(String) | A function that is executed when the 'pull to refresh' gesture is performed on the drop-down item list. Supported on mobile devices only. Mirrors the client-side onPullRefresh option. |
| OnScroll(RazorBlock) | A function that is executed on each scroll gesture performed on the drop-down item list. Mirrors the client-side onScroll option. |
| OnScroll(String) | A function that is executed on each scroll gesture performed on the drop-down item list. Mirrors the client-side onScroll option. |
| OnSelectionChanged(RazorBlock) | A function that is executed when a list item is selected or selection is canceled. Mirrors the client-side onSelectionChanged option. |
| OnSelectionChanged(String) | A function that is executed when a list item is selected or selection is canceled. Mirrors the client-side onSelectionChanged option. |
| OnValueChanged(RazorBlock) | A function that is executed after the UI component's value is changed. Mirrors the client-side onValueChanged option. |
| OnValueChanged(String) | A function that is executed after the UI component's value is changed. Mirrors the client-side onValueChanged option. |
| Opened(JS) | Specifies whether or not the drop-down editor is displayed. Mirrors the client-side opened option. |
| Opened(Boolean) | Specifies whether or not the drop-down editor is displayed. Mirrors the client-side opened option. |
| Option(String, Object) | Specifies an option by its name. |
| PageLoadingText(JS) | Specifies the text shown in the pullDown panel, which is displayed when the UI component is scrolled to the bottom. Mirrors the client-side pageLoadingText option. |
| PageLoadingText(String) | Specifies the text shown in the pullDown panel, which is displayed when the UI component is scrolled to the bottom. Mirrors the client-side pageLoadingText option. |
| PageLoadMode(ListPageLoadMode) | Specifies whether the next page is loaded when a user scrolls the UI component to the bottom or when the 'next' button is clicked. Mirrors the client-side pageLoadMode option. |
| Placeholder(JS) | The text displayed by the UI component when nothing is selected. Mirrors the client-side placeholder option. |
| Placeholder(String) | The text displayed by the UI component when nothing is selected. Mirrors the client-side placeholder option. |
| PulledDownText(JS) | Specifies the text displayed in the pullDown panel when the UI component is pulled below the refresh threshold. Mirrors the client-side pulledDownText option. |
| PulledDownText(String) | Specifies the text displayed in the pullDown panel when the UI component is pulled below the refresh threshold. Mirrors the client-side pulledDownText option. |
| PullingDownText(JS) | Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. Mirrors the client-side pullingDownText option. |
| PullingDownText(String) | Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold. Mirrors the client-side pullingDownText option. |
| PullRefreshEnabled(JS) | A Boolean value specifying whether or not the UI component supports the 'pull down to refresh' gesture. Mirrors the client-side pullRefreshEnabled option. |
| PullRefreshEnabled(Boolean) | A Boolean value specifying whether or not the UI component supports the 'pull down to refresh' gesture. Mirrors the client-side pullRefreshEnabled option. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RefreshingText(JS) | Specifies the text displayed in the pullDown panel while the UI component is being refreshed. Mirrors the client-side refreshingText option. |
| RefreshingText(String) | Specifies the text displayed in the pullDown panel while the UI component is being refreshed. Mirrors the client-side refreshingText option. |
| Render() | Inherited from WidgetBuilder. |
| RtlEnabled(JS) | Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option. |
| RtlEnabled(Boolean) | Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option. |
| SearchEnabled(JS) | Specifies whether the search box is visible. Mirrors the client-side searchEnabled option. |
| SearchEnabled(Boolean) | Specifies whether the search box is visible. Mirrors the client-side searchEnabled option. |
| SearchExpr(JS) | Specifies the name of a data source item field or an expression whose value is compared to the search criterion. Mirrors the client-side searchExpr option. |
| SearchExpr(IEnumerable<String>) | Specifies the name of a data source item field or an expression whose value is compared to the search criterion. Mirrors the client-side searchExpr option. |
| SearchExpr(String[]) | Specifies the name of a data source item field or an expression whose value is compared to the search criterion. Mirrors the client-side searchExpr option. |
| SearchMode(DropDownSearchMode) | Specifies a comparison operation used to search UI component items. Mirrors the client-side searchMode option. |
| SearchPlaceholder(JS) | The text that is provided as a hint in the lookup's search bar. Mirrors the client-side searchPlaceholder option. |
| SearchPlaceholder(String) | The text that is provided as a hint in the lookup's search bar. Mirrors the client-side searchPlaceholder option. |
| SearchStartEvent(JS) | Specifies the DOM events after which the UI component's search results should be updated. Mirrors the client-side searchStartEvent option. |
| SearchStartEvent(String) | Specifies the DOM events after which the UI component's search results should be updated. Mirrors the client-side searchStartEvent option. |
| SearchTimeout(JS) | Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. Mirrors the client-side searchTimeout option. |
| SearchTimeout(Double) | Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. Mirrors the client-side searchTimeout option. |
| ShowCancelButton(JS) | Specifies whether to display the Cancel button in the lookup window. Mirrors the client-side showCancelButton option. |
| ShowCancelButton(Boolean) | Specifies whether to display the Cancel button in the lookup window. Mirrors the client-side showCancelButton option. |
| ShowClearButton(JS) | Specifies whether to display the Clear button in the lookup window. Mirrors the client-side showClearButton option. |
| ShowClearButton(Boolean) | Specifies whether to display the Clear button in the lookup window. Mirrors the client-side showClearButton option. |
| ShowDataBeforeSearch(JS) | Specifies whether or not the UI component displays unfiltered values until a user types a number of characters exceeding the minSearchLength property value. Mirrors the client-side showDataBeforeSearch option. |
| ShowDataBeforeSearch(Boolean) | Specifies whether or not the UI component displays unfiltered values until a user types a number of characters exceeding the minSearchLength property value. Mirrors the client-side showDataBeforeSearch option. |
| StylingMode(EditorStylingMode) | Specifies how the UI component's text field is styled. Mirrors the client-side stylingMode option. |
| TabIndex(JS) | Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option. |
| TabIndex(Int32) | Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option. |
| ToString() | Inherited from WidgetBuilder. |
| ToTemplate() | Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder. |
| UseItemTextAsTitle(JS) | Specifies whether the widget uses item's text a title attribute. Mirrors the client-side useItemTextAsTitle option. |
| UseItemTextAsTitle(Boolean) | Specifies whether the widget uses item's text a title attribute. Mirrors the client-side useItemTextAsTitle option. |
| UseNativeScrolling(JS) | Specifies whether or not the UI component uses native scrolling. Mirrors the client-side useNativeScrolling option. |
| UseNativeScrolling(Boolean) | Specifies whether or not the UI component uses native scrolling. Mirrors the client-side useNativeScrolling option. |
| UsePopover(JS) | Specifies whether to show lookup contents in the Popover UI component. Mirrors the client-side usePopover option. |
| UsePopover(Boolean) | Specifies whether to show lookup contents in the Popover UI component. Mirrors the client-side usePopover option. |
| ValidationError(Object) | Information on the broken validation rule. Contains the first item from the validationErrors array. Mirrors the client-side validationError option. |
| ValidationErrors(JS) | An array of the validation rules that failed. Mirrors the client-side validationErrors option. |
| ValidationErrors(IEnumerable) | An array of the validation rules that failed. Mirrors the client-side validationErrors option. |
| ValidationMessageMode(ValidationMessageMode) | Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. Mirrors the client-side validationMessageMode option. |
| ValidationMessagePosition(Mode) | Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy. Mirrors the client-side validationMessagePosition option. |
| ValidationMessagePosition(Position) | Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy. Mirrors the client-side validationMessagePosition option. |
| ValidationRules(Action<ValidationRulesFactory>) | |
| ValidationStatus(ValidationStatus) | Indicates or specifies the current validation status. Mirrors the client-side validationStatus option. |
| Value(Object) | Mirrors the client-side value option. |
| ValueChangeEvent(JS) | Obsolete. Mirrors the client-side valueChangeEvent option. |
| ValueChangeEvent(String) | Obsolete. Mirrors the client-side valueChangeEvent option. |
| ValueExpr(JS) | Specifies which data field provides unique values to the UI component's value. Mirrors the client-side valueExpr option. |
| ValueExpr(String) | Specifies which data field provides unique values to the UI component's value. Mirrors the client-side valueExpr option. |
| Visible(JS) | Specifies whether the UI component is visible. Mirrors the client-side visible option. |
| Visible(Boolean) | Specifies whether the UI component is visible. Mirrors the client-side visible option. |
| Width(JS) | Specifies the UI component's width. Mirrors the client-side width option. |
| Width(Double) | Specifies the UI component's width. Mirrors the client-side width option. |
| Width(String) | Specifies the UI component's width. Mirrors the client-side width option. |
| WrapItemText(JS) | Specifies whether text that exceeds the drop-down list width should be wrapped. Mirrors the client-side wrapItemText option. |
| WrapItemText(Boolean) | Specifies whether text that exceeds the drop-down list width should be wrapped. Mirrors the client-side wrapItemText option. |
See Also