TagBoxBuilder Methods
A TagBox control.Name | Description |
---|---|
AcceptCustomValue(JS) | Specifies whether the UI component allows a user to enter a custom value. Requires the onCustomItemCreating handler implementation. Mirrors the client-side acceptCustomValue option. |
AcceptCustomValue(Boolean) | Specifies whether the UI component allows a user to enter a custom value. Requires the onCustomItemCreating handler implementation. Mirrors the client-side acceptCustomValue option. |
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. |
ApplyValueMode(EditorApplyValueMode) | Specifies how the UI component applies values. Mirrors the client-side applyValueMode option. |
Buttons(Action<CollectionFactory<TextEditorButtonBuilder>>) | Provides access to the client-side buttons option that represents an editor button collection. |
Buttons(IEnumerable<DropDownEditorButtonName>) | Mirrors the client-side buttons option. |
CustomItemCreateEvent(JS) | Specifies the DOM event after which the custom item should be created. Applies only if acceptCustomValue is enabled. Mirrors the client-side customItemCreateEvent option. |
CustomItemCreateEvent(String) | Specifies the DOM event after which the custom item should be created. Applies only if acceptCustomValue is enabled. Mirrors the client-side customItemCreateEvent option. |
DataSource(JS) | Mirrors the client-side dataSource option. |
DataSource(IEnumerable, String[]) |
Binds a TagBox control to a collection: Array , List , or IEnumerable .
|
DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) | Binds a TagBox 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 TagBox 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) | Mirrors the client-side disabled option. |
Disabled(Boolean) | Mirrors the client-side disabled option. |
DisplayExpr(JS) | Mirrors the client-side displayExpr option. |
DisplayExpr(String) | Mirrors the client-side displayExpr option. |
DropDownButtonTemplate(JS) | Specifies the client-side dropDownButtonTemplate. |
DropDownButtonTemplate(RazorBlock) | Specifies the client-side dropDownButtonTemplate. |
DropDownButtonTemplate(TemplateName) | Specifies the client-side dropDownButtonTemplate. |
DropDownButtonTemplate(String) | Specifies the client-side dropDownButtonTemplate. |
DropDownOptions(Action<PopupBuilder>) | Mirrors the client-side dropDownOptions option. |
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. |
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. |
HideSelectedItems(JS) | A Boolean value specifying whether or not to hide selected items. Mirrors the client-side hideSelectedItems option. |
HideSelectedItems(Boolean) | A Boolean value specifying whether or not to hide selected items. Mirrors the client-side hideSelectedItems 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<TagBoxItemBuilder>>) | Provides access to the client-side items option that represents a TagBox item collection. |
Items(IEnumerable<String>) | 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) | |
MaxDisplayedTags(JS) | Specifies the limit on displayed tags. On exceeding it, the UI component replaces all tags with a single multi-tag that displays the number of selected items. Mirrors the client-side maxDisplayedTags option. |
MaxDisplayedTags(Int32) | Specifies the limit on displayed tags. On exceeding it, the UI component replaces all tags with a single multi-tag that displays the number of selected items. Mirrors the client-side maxDisplayedTags option. |
MaxFilterQueryLength(JS) | Specifies the maximum filter query length in characters. Mirrors the client-side maxFilterQueryLength option. |
MaxFilterQueryLength(Int32) | Specifies the maximum filter query length in characters. Mirrors the client-side maxFilterQueryLength option. |
MaxLength(JS) | Specifies the maximum number of characters you can enter into the textbox. Mirrors the client-side maxLength option. |
MaxLength(Double) | Specifies the maximum number of characters you can enter into the textbox. Mirrors the client-side maxLength option. |
MaxLength(String) | Specifies the maximum number of characters you can enter into the textbox. Mirrors the client-side maxLength option. |
MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
MinSearchLength(JS) | Mirrors the client-side minSearchLength option. |
MinSearchLength(Int32) | Mirrors the client-side minSearchLength option. |
Multiline(JS) | A Boolean value specifying whether or not the UI component is multiline. Mirrors the client-side multiline option. |
Multiline(Boolean) | A Boolean value specifying whether or not the UI component is multiline. Mirrors the client-side multiline option. |
Name(JS) | Mirrors the client-side name option. |
Name(String) | Mirrors the client-side name 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. |
OnChange(RazorBlock) | A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard. Mirrors the client-side onChange option. |
OnChange(String) | A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard. Mirrors the client-side onChange 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. |
OnCustomItemCreating(RazorBlock) | A function that is executed when a user adds a custom item. Requires acceptCustomValue to be set to true. Mirrors the client-side onCustomItemCreating option. |
OnCustomItemCreating(String) | A function that is executed when a user adds a custom item. Requires acceptCustomValue to be set to true. Mirrors the client-side onCustomItemCreating 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. |
OnEnterKey(RazorBlock) | A function that is executed when the Enter key has been pressed while the UI component is focused. Mirrors the client-side onEnterKey option. |
OnEnterKey(String) | A function that is executed when the Enter key has been pressed while the UI component is focused. Mirrors the client-side onEnterKey option. |
OnFocusIn(RazorBlock) | A function that is executed when the UI component gets focus. Mirrors the client-side onFocusIn option. |
OnFocusIn(String) | A function that is executed when the UI component gets focus. Mirrors the client-side onFocusIn option. |
OnFocusOut(RazorBlock) | A function that is executed when the UI component loses focus. Mirrors the client-side onFocusOut option. |
OnFocusOut(String) | A function that is executed when the UI component loses focus. Mirrors the client-side onFocusOut 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. |
OnInput(RazorBlock) | A function that is executed each time the UI component's input is changed while the UI component is focused. Mirrors the client-side onInput option. |
OnInput(String) | A function that is executed each time the UI component's input is changed while the UI component is focused. Mirrors the client-side onInput 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. |
OnKeyDown(RazorBlock) | A function that is executed when a user is pressing a key on the keyboard. Mirrors the client-side onKeyDown option. |
OnKeyDown(String) | A function that is executed when a user is pressing a key on the keyboard. Mirrors the client-side onKeyDown option. |
OnKeyUp(RazorBlock) | A function that is executed when a user releases a key on the keyboard. Mirrors the client-side onKeyUp option. |
OnKeyUp(String) | A function that is executed when a user releases a key on the keyboard. Mirrors the client-side onKeyUp option. |
OnMultiTagPreparing(RazorBlock) | A function that is executed before the multi-tag is rendered. Mirrors the client-side onMultiTagPreparing option. |
OnMultiTagPreparing(String) | A function that is executed before the multi-tag is rendered. Mirrors the client-side onMultiTagPreparing 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. |
OnSelectAllValueChanged(RazorBlock) | A function that is executed when the 'Select All' check box value is changed. Applies only if showSelectionControls is true. Mirrors the client-side onSelectAllValueChanged option. |
OnSelectAllValueChanged(String) | A function that is executed when the 'Select All' check box value is changed. Applies only if showSelectionControls is true. Mirrors the client-side onSelectAllValueChanged 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. |
OpenOnFieldClick(JS) | Mirrors the client-side openOnFieldClick option. |
OpenOnFieldClick(Boolean) | Mirrors the client-side openOnFieldClick option. |
Option(String, Object) | Specifies an option by its name. |
Placeholder(JS) | The text that is provided as a hint in the select box editor. Mirrors the client-side placeholder option. |
Placeholder(String) | The text that is provided as a hint in the select box editor. Mirrors the client-side placeholder option. |
ReadOnly(JS) | Mirrors the client-side readOnly option. |
ReadOnly(Boolean) | Mirrors the client-side readOnly option. |
ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
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) | Mirrors the client-side searchEnabled option. |
SearchEnabled(Boolean) | Mirrors the client-side searchEnabled option. |
SearchExpr(JS) | Mirrors the client-side searchExpr option. |
SearchExpr(IEnumerable<String>) | Mirrors the client-side searchExpr option. |
SearchExpr(String[]) | Mirrors the client-side searchExpr option. |
SearchMode(DropDownSearchMode) | Mirrors the client-side searchMode option. |
SearchTimeout(JS) | Mirrors the client-side searchTimeout option. |
SearchTimeout(Double) | Mirrors the client-side searchTimeout option. |
SelectAllMode(SelectAllMode) | Specifies the mode in which all items are selected. Mirrors the client-side selectAllMode option. |
SelectAllText(JS) | |
SelectAllText(String) | |
ShowClearButton(JS) | Specifies whether to display the Clear button in the UI component. Mirrors the client-side showClearButton option. |
ShowClearButton(Boolean) | Specifies whether to display the Clear button in the UI component. Mirrors the client-side showClearButton option. |
ShowDataBeforeSearch(JS) | Mirrors the client-side showDataBeforeSearch option. |
ShowDataBeforeSearch(Boolean) | Mirrors the client-side showDataBeforeSearch option. |
ShowDropDownButton(JS) | Mirrors the client-side showDropDownButton option. |
ShowDropDownButton(Boolean) | Mirrors the client-side showDropDownButton option. |
ShowMultiTagOnly(JS) | Specifies whether the multi-tag is shown without ordinary tags. Mirrors the client-side showMultiTagOnly option. |
ShowMultiTagOnly(Boolean) | Specifies whether the multi-tag is shown without ordinary tags. Mirrors the client-side showMultiTagOnly option. |
ShowSelectionControls(JS) | Specifies whether or not to display selection controls. Mirrors the client-side showSelectionControls option. |
ShowSelectionControls(Boolean) | Specifies whether or not to display selection controls. Mirrors the client-side showSelectionControls 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. |
TagTemplate(JS) | Specifies the client-side tagTemplate. |
TagTemplate(RazorBlock) | Specifies the client-side tagTemplate. |
TagTemplate(TemplateName) | Specifies the client-side tagTemplate. |
TagTemplate(String) | Specifies the client-side tagTemplate. |
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. |
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(JS) | Specifies the selected items. Mirrors the client-side value option. |
Value(IEnumerable) | Specifies the selected items. Mirrors the client-side value option. |
ValueChangeEvent(JS) | Obsolete. This API is obsolete now. |
ValueChangeEvent(String) | Obsolete. This API is obsolete now. |
ValueExpr(JS) | Mirrors the client-side valueExpr option. |
ValueExpr(String) | 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