dotnet-api

C1.Web.Mvc.Fluent.ListBoxBuilder-1

ListBoxBuilder<T> Class

Defines a builder to configurate ListBox<T>.

Inheritance

object

HideObjectMembers

BaseBuilder<ListBox<T>, ListBoxBuilder<T>>

ComponentBuilder<ListBox<T>, ListBoxBuilder<T>>

ControlBuilder<ListBox<T>, ListBoxBuilder<T>>

ItemsBoundControlBuilder<T, ListBox<T>, ListBoxBuilder<T>>

ListBoxBuilder<T>

Implements

IHtmlString

Namespace: C1.Web.Mvc.Fluent

Assembly: C1.Web.Mvc.dll

Syntax

public class ListBoxBuilder<T> : ItemsBoundControlBuilder<T, ListBox<T>, ListBoxBuilder<T>>, IHtmlString

Type Parameters

Name	Description
T

Constructors

Name	Description
ListBoxBuilder(ListBox<T>)	Creates one ListBoxBuilder<T> instance to configurate `component`.

Methods

Name	Description
CaseSensitiveSearch(bool)	Configurates CaseSensitiveSearch. Sets a value that determines whether searches performed while the user types should case-sensitive.
CheckedIndexes(IList<int>)	Configurates CheckedIndexes. Sets a list containing the indexes of checked items.
CheckedIndexes(params int[])	Sets the CheckedIndexes property.
CheckedMemberPath(string)	Configurates CheckedMemberPath. Sets the name of the property used to control checkboxes placed next to each item.
CheckedValues(IEnumerable<object>)	Configurates CheckedValues. Sets a list containing the item-values that are currently checked.
CheckedValues(params object[])	Sets the CheckedValues property.
DisplayMemberPath(string)	Configurates DisplayMemberPath. Sets the name of the property to use as the visual representation of the items.
IsContentHtml(bool)	Configurates IsContentHtml. Sets a value indicating whether the list displays items as plain text or as HTML.
ItemFormatter(string)	Configurates ItemFormatter. Sets a function used to customize the values shown in the list.
ItemRole(string)	Configurates ItemRole. Sets the value of the "role" attribute added to the list items.
ItemTemplateContent(string)	Configurates ItemTemplateContent. Sets the id of the template used to generate each list item.
ItemTemplateId(string)	Configurates ItemTemplateId. Sets the id of the template used to generate each list item.
MaxHeight(double)	Configurates MaxHeight. Sets the maximum height of the list.
OnClientCheckedItemsChanged(string)	Configurates the OnClientCheckedItemsChanged client event. Occurs when the value of the @see:checkedItems property changes.
OnClientFormatItem(string)	Configurates the OnClientFormatItem client event. Occurs when an element representing a list item has been created.
OnClientItemChecked(string)	Configurates the OnClientItemChecked client event. Occurs when the current item is checked or unchecked.
OnClientItemsChanged(string)	Configurates the OnClientItemsChanged client event. Occurs when the list of items changes.
OnClientLoadedItems(string)	Configurates the OnClientLoadedItems client event. Occurs after the list items are generated.
OnClientLoadingItems(string)	Configurates the OnClientLoadingItems client event. Occurs before the list items are generated.
OnClientSelectedIndexChanged(string)	Configurates the OnClientSelectedIndexChanged client event. Occurs when the value of the SelectedIndex property changes.
SelectedIndex(int)	Configurates SelectedIndex. Sets the index of the currently selected item in the list.
SelectedItem(T)	Configurates SelectedItem. Sets the item that is currently selected in the list.
SelectedValue(object)	Configurates SelectedValue. Sets the value of the SelectedItem, obtained using the SelectedValuePath.
SelectedValuePath(string)	Configurates SelectedValuePath. Sets the name of the property used to get the SelectedValue from the SelectedItem.
ShowGroups(bool)	Configurates ShowGroups. Sets a value that determines whether the drop-down should include group header items to delimit data groups.
VirtualizationThreshold(int)	Configurates VirtualizationThreshold. Sets the minimum number of rows and/or columns required to enable virtualization in the ListBox.

Extension Methods

IHtmlStringExtension.ToTemplate(IHtmlString)