Class MultiColumnComboBox

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

MultiColumnComboBox

Namespace: Syncfusion.EJ2.MultiColumnComboBox

Assembly: Syncfusion.EJ2.dll

Syntax

public class MultiColumnComboBox : EJTagHelper

Constructors

MultiColumnComboBox()

Declaration

public MultiColumnComboBox()

Properties

ActionBegin

Triggers before fetching data from the remote server.

Declaration

public string ActionBegin { get; set; }

Property Value

Type	Description
System.String	The default value is null

ActionComplete

Triggers after data is fetched successfully from the remote server.

Declaration

public string ActionComplete { get; set; }

Property Value

Type	Description
System.String	The default value is null

ActionFailure

Triggers when the data fetch request from the remote server fails.

Declaration

public string ActionFailure { get; set; }

Property Value

Type	Description
System.String	The default value is null

ActionFailureTemplate

Accepts the template and assigns it to the popup content when the data fetch request from the remote server fails.

Declaration

public string ActionFailureTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is "Request Failed"

AllowFiltering

Specifies the filter action retrieves matched items through the filtering event based on the characters typed in the search TextBox. If no match is found, the value of the noRecordsTemplate property will be displayed.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

AllowSorting

Specifies whether sorting is allowed for the columns in the dropdown list.

Declaration

public bool AllowSorting { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Change

Triggers when an item in a popup is selected or when the model value is changed by the user.

Declaration

public string Change { get; set; }

Property Value

Type	Description
System.String	The default value is null

Close

Triggers when the popup is closed.

Declaration

public string Close { get; set; }

Property Value

Type	Description
System.String	The default value is null

Columns

Specifies the number of columns and its respective fields to be displayed in the dropdown popup.

Declaration

public List<Column> Columns { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<Column>	The default value is null

Created

Event callback that is raised after rendering the control.

Declaration

public string Created { get; set; }

Property Value

Type	Description
System.String	The default value is null

CssClass

Sets CSS classes to the root element of the component that allows customization of appearance.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The default value is ""

DataSource

Accepts the list items either through local or remote service and binds it to the component. It can be an array of JSON Objects or an instance of DataManager.

Declaration

public object DataSource { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Disabled

Specifies a value that indicates whether the component is disabled or not.

Declaration

public bool Disabled { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnablePersistence

Specifies the component’s state between page reloads. If enabled, the list of states for the value will be persisted.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableVirtualization

Defines whether to enable virtual scrolling in the component.

Declaration

public bool EnableVirtualization { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Fields

The fields property maps the columns of the data table and binds the data to the component. text - Maps the text column from data table for each list item. value - Maps the value column from data table for each list item. groupBy - Group the list items with it's related items by mapping groupBy field.

Declaration

public MultiColumnComboBoxFieldSettings Fields { get; set; }

Property Value

Type	Description
MultiColumnComboBoxFieldSettings	The default value is null

Filtering

Triggers on typing a character in the component.

Declaration

public string Filtering { get; set; }

Property Value

Type	Description
System.String	The default value is null

FilterType

Determines on which filter type, the component needs to be considered on search action. The FilterType and its supported data types are

Declaration

public FilterType FilterType { get; set; }

Property Value

Type	Description
FilterType	The default value is FilterType.StartsWith

FloatLabelType

Specifies whether to display the floating label above the input element. Possible values are: Never - The label will never float in the input when the placeholder is available. Always - The floating label will always float above the input. Auto - The floating label will float above the input after focusing or entering a value in the input.

Declaration

public FloatLabelType FloatLabelType { get; set; }

Property Value

Type	Description
FloatLabelType	The default value is FloatLabelType.Never

FooterTemplate

Accepts the template design and assigns it to the footer container of the popup.

Declaration

public string FooterTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

For

Declaration

public override ModelExpression For { get; set; }

Property Value

Type
Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExpression

Overrides

Syncfusion.EJ2.EJTagHelper.For

GridSettings

Specifies the configuration of the columns in the popup content.

Declaration

public MultiColumnComboBoxGridSettings GridSettings { get; set; }

Property Value

Type	Description
MultiColumnComboBoxGridSettings	The default value is null

GroupTemplate

Accepts the template design and assigns it to the group headers present in the popup list.

Declaration

public string GroupTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public object HtmlAttributes { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Index

Gets or sets the index of the selected item in the component.

Declaration

public object Index { get; set; }

Property Value

Type	Description
System.Object	The default value is null

ItemTemplate

Accepts the template design and assigns it to each items present in the popup.

Declaration

public string ItemTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String	The default value is ""

NoRecordsTemplate

Accepts the template design and assigns it to popup list of component when no data is available on the component.

Declaration

public string NoRecordsTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is "No records found"

Open

Triggers when the popup opens.

Declaration

public string Open { get; set; }

Property Value

Type	Description
System.String	The default value is null

Placeholder

Specifies a short hint that describes the expected value of the multicolumn combobox component.

Declaration

public string Placeholder { get; set; }

Property Value

Type	Description
System.String	The default value is null

PopupHeight

Specifies the height of the popup list.

Declaration

public string PopupHeight { get; set; }

Property Value

Type	Description
System.String	The default value is "300px"

PopupWidth

Specifies the width of the popup list. By default, the popup width sets based on the width of the component.

Declaration

public string PopupWidth { get; set; }

Property Value

Type	Description
System.String	The default value is "100%"

Query

Accepts the external Query that execute along with data processing.

Declaration

public string Query { get; set; }

Property Value

Type	Description
System.String	The default value is null

Readonly

Specifies the user interactions on the component are disabled.

Declaration

public bool Readonly { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Select

Triggers when an item in the popup is selected by the user either with mouse/tap or with keyboard navigation.

Declaration

public string Select { get; set; }

Property Value

Type	Description
System.String	The default value is null

ShowClearButton

Declaration

public bool ShowClearButton { get; set; }

Property Value

Type
System.Boolean

SortOrder

Specifies the sortOrder to sort the data source. The available type of sort orders are, None - The datasource is not sorting. Default value is None. Ascending - The datasource is sorting with ascending order. Descending - The data source is sorting with descending order.

Declaration

public SortOrder SortOrder { get; set; }

Property Value

Type	Description
SortOrder	The default value is SortOrder.None

SortType

Specifies the type of sorting to be applied for the columns. OneColumn - Allow sorting only one column. MultipleColumns - Allow sorting multiple columns.

Declaration

public SortType SortType { get; set; }

Property Value

Type	Description
SortType	The default value is SortType.OneColumn

Text

Gets or sets the display text of the selected item.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	The default value is null

Value

Gets or sets the value of the selected item.

Declaration

public string Value { get; set; }

Property Value

Type	Description
System.String	The default value is null

Width

Specifies the width of the component. By default, the component width sets based on the width of its parent container.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is "100%"