DropDownButtonBuilder Methods
A DropDownButton 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) | Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option. |
| ActiveStateEnabled(Boolean) | Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option. |
| DataSource(JS) | Provides data for the drop-down menu. Mirrors the client-side dataSource option. |
| DataSource(IEnumerable, String[]) |
Binds a DropDownButton control to a collection: Array, List, or IEnumerable.
|
| DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) | Binds a DropDownButton 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 DropDownButton 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 wait until the drop-down menu is opened the first time to render its content. Specifies whether to render the view's content when it is displayed. If false, the content is rendered immediately. Mirrors the client-side deferRendering option. |
| DeferRendering(Boolean) | Specifies whether to wait until the drop-down menu is opened the first time to render its content. Specifies whether to render the view'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 in the drop-down menu. Mirrors the client-side displayExpr option. |
| DisplayExpr(String) | Specifies the data field whose values should be displayed in the drop-down menu. Mirrors the client-side displayExpr option. |
| DropDownContentTemplate(JS) | Specifies the client-side dropDownContentTemplate. |
| DropDownContentTemplate(RazorBlock) | Specifies the client-side dropDownContentTemplate. |
| DropDownContentTemplate(TemplateName) | Specifies the client-side dropDownContentTemplate. |
| DropDownContentTemplate(String) | Specifies the client-side dropDownContentTemplate. |
| DropDownOptions(Action<PopupBuilder>) | 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. |
| FocusStateEnabled(JS) | Specifies whether users can use keyboard to focus the UI component. Mirrors the client-side focusStateEnabled option. |
| FocusStateEnabled(Boolean) | Specifies whether users can use keyboard to focus the UI component. 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. |
| 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) | Specifies whether the UI component changes its state when a user hovers the mouse pointer over it. Mirrors the client-side hoverStateEnabled option. |
| HoverStateEnabled(Boolean) | Specifies whether the UI component changes its state when a user hovers the mouse pointer over it. Mirrors the client-side hoverStateEnabled option. |
| Icon(JS) | Specifies the button's icon. Mirrors the client-side icon option. |
| Icon(String) | Specifies the button's icon. Mirrors the client-side icon 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.
|
| Items(Action<CollectionFactory<DropDownButtonItemBuilder>>) | Provides access to the client-side items option that represents a DropDownButton item collection. |
| 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. |
| KeyExpr(JS) | Specifies which data field provides keys used to distinguish between the selected drop-down menu items. Mirrors the client-side keyExpr option. |
| KeyExpr(String) | Specifies which data field provides keys used to distinguish between the selected drop-down menu items. Mirrors the client-side keyExpr option. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| NoDataText(JS) | Specifies the text or HTML markup displayed in the drop-down menu when it does not contain any items. Mirrors the client-side noDataText option. |
| NoDataText(String) | Specifies the text or HTML markup displayed in the drop-down menu when it does not contain any items. Mirrors the client-side noDataText option. |
| OnButtonClick(RazorBlock) | A function that is executed when the button is clicked or tapped. If splitButton is true, this function is executed for the action button only. Mirrors the client-side onButtonClick option. |
| OnButtonClick(String) | A function that is executed when the button is clicked or tapped. If splitButton is true, this function is executed for the action button only. Mirrors the client-side onButtonClick 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 drop-down menu item is clicked. Mirrors the client-side onItemClick option. |
| OnItemClick(String) | A function that is executed when a drop-down menu item is clicked. Mirrors the client-side onItemClick 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. |
| OnSelectionChanged(RazorBlock) | A function that is executed when an item is selected or selection is canceled. In effect when useSelectMode is true. Mirrors the client-side onSelectionChanged option. |
| OnSelectionChanged(String) | A function that is executed when an item is selected or selection is canceled. In effect when useSelectMode is true. Mirrors the client-side onSelectionChanged option. |
| Opened(JS) | Specifies whether the drop-down menu is opened. Mirrors the client-side opened option. |
| Opened(Boolean) | Specifies whether the drop-down menu is opened. Mirrors the client-side opened option. |
| Option(String, Object) | Specifies an option by its name. |
| 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. |
| SelectedItemKey(JS) | Contains the selected item's key and allows you to specify the initially selected item. Applies when useSelectMode is true. Mirrors the client-side selectedItemKey option. |
| SelectedItemKey(Double) | Contains the selected item's key and allows you to specify the initially selected item. Applies when useSelectMode is true. Mirrors the client-side selectedItemKey option. |
| SelectedItemKey(String) | Contains the selected item's key and allows you to specify the initially selected item. Applies when useSelectMode is true. Mirrors the client-side selectedItemKey option. |
| ShowArrowIcon(JS) | Specifies whether the arrow icon should be displayed. Mirrors the client-side showArrowIcon option. |
| ShowArrowIcon(Boolean) | Specifies whether the arrow icon should be displayed. Mirrors the client-side showArrowIcon option. |
| SplitButton(JS) | Specifies whether to split the button in two: one executes an action, the other opens and closes the drop-down menu. Mirrors the client-side splitButton option. |
| SplitButton(Boolean) | Specifies whether to split the button in two: one executes an action, the other opens and closes the drop-down menu. Mirrors the client-side splitButton option. |
| StylingMode(ButtonStylingMode) | Specifies how the button 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. |
| Template(JS) | |
| Template(RazorBlock) | |
| Template(TemplateName) | |
| Template(String) | |
| Text(JS) | Specifies the button's text. Applies only if useSelectMode is false. Mirrors the client-side text option. |
| Text(String) | Specifies the button's text. Applies only if useSelectMode is false. Mirrors the client-side text option. |
| ToString() | Inherited from WidgetBuilder. |
| ToTemplate() | Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder. |
| Type(ButtonType) | |
| UseItemTextAsTitle(JS) | Mirrors the client-side useItemTextAsTitle option. |
| UseItemTextAsTitle(Boolean) | Mirrors the client-side useItemTextAsTitle option. |
| UseSelectMode(JS) | Specifies whether the UI component stores the selected drop-down menu item. Mirrors the client-side useSelectMode option. |
| UseSelectMode(Boolean) | Specifies whether the UI component stores the selected drop-down menu item. Mirrors the client-side useSelectMode 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