Skip to main content

BoxBuilder Methods

A Box control.
Name Description
Align(BoxAlign) Specifies how UI component items are aligned along the main direction. Mirrors the client-side align option.
CrossAlign(BoxCrossAlign) Specifies how UI component items are aligned cross-wise. Mirrors the client-side crossAlign option.
DataSource(JS) Mirrors the client-side dataSource option.
DataSource(IEnumerable, String[]) Binds a Box control to a collection: Array, List, or IEnumerable.
DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) Binds a Box 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 Box control to read-only data in JSON format.
DataSourceOptions(Action<DataSourceOptionsBuilder>) Provides access to methods that mirror client-side data source options.
Direction(BoxDirection) Specifies the direction of item positioning in the UI component. Mirrors the client-side direction 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.
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.
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.
HoverStateEnabled(JS) Specifies whether the UI component changes its state when a user pauses on it. Mirrors the client-side hoverStateEnabled option.
HoverStateEnabled(Boolean) Specifies whether the UI component changes its state when a user pauses on it. 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.
ItemHoldTimeout(JS) The time period in milliseconds before the onItemHold event is raised. Mirrors the client-side itemHoldTimeout option.
ItemHoldTimeout(Double) The time period in milliseconds before the onItemHold event is raised. Mirrors the client-side itemHoldTimeout option.
Items(Action<CollectionFactory<BoxItemBuilder>>) Provides access to the client-side items option that represents a Box 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.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
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 collection item is clicked or tapped. Mirrors the client-side onItemClick option.
OnItemClick(String) A function that is executed when a collection item is clicked or tapped. Mirrors the client-side onItemClick option.
OnItemContextMenu(RazorBlock) A function that is executed when a collection item is right-clicked or pressed. Mirrors the client-side onItemContextMenu option.
OnItemContextMenu(String) A function that is executed when a collection item is right-clicked or pressed. Mirrors the client-side onItemContextMenu option.
OnItemHold(RazorBlock) A function that is executed when a collection item has been held for a specified period. Mirrors the client-side onItemHold option.
OnItemHold(String) A function that is executed when a collection item has been held for a specified period. Mirrors the client-side onItemHold option.
OnItemRendered(RazorBlock) A function that is executed after a collection item is rendered. Mirrors the client-side onItemRendered option.
OnItemRendered(String) A function that is executed after a collection item is rendered. Mirrors the client-side onItemRendered 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.
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.
ToString() Inherited from WidgetBuilder.
ToTemplate() Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder.
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.
See Also