Class IgbMultiColumnComboBox
Inheritance
System.Object
IgbMultiColumnComboBox
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbMultiColumnComboBox : BaseRendererControl, JsonSerializable
Constructors
IgbMultiColumnComboBox()
Declaration
public IgbMultiColumnComboBox()
Properties
ActualBackgroundColor
Gets the actual opacity to use for the underline ripple element.
Declaration
public string ActualBackgroundColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualBaseTheme
Gets the actual display baseTheme to use for the component.
Declaration
public BaseControlTheme ActualBaseTheme { get; set; }
Property Value
ActualBorderColor
Gets the actual item background color.
Declaration
public string ActualBorderColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualBorderWidth
Gets the actual item border width.
Declaration
public double ActualBorderWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualContentPaddingBottom
Declaration
public double ActualContentPaddingBottom { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualContentPaddingLeft
Declaration
public double ActualContentPaddingLeft { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualContentPaddingRight
Declaration
public double ActualContentPaddingRight { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualContentPaddingTop
Declaration
public double ActualContentPaddingTop { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualCornerRadiusBottomLeft
Declaration
public double ActualCornerRadiusBottomLeft { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualCornerRadiusBottomRight
Declaration
public double ActualCornerRadiusBottomRight { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualCornerRadiusTopLeft
Declaration
public double ActualCornerRadiusTopLeft { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualCornerRadiusTopRight
Declaration
public double ActualCornerRadiusTopRight { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualDensity
Gets the actual display Density to use for the component.
Declaration
public ControlDisplayDensity ActualDensity { get; set; }
Property Value
ActualFocusBorderColor
Gets the actual item border color.
Declaration
public string ActualFocusBorderColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualFocusBorderWidth
Gets the actual item border width.
Declaration
public double ActualFocusBorderWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualFocusUnderlineColor
Gets the actual color to use for the underline element when focused.
Declaration
public string ActualFocusUnderlineColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualFocusUnderlineOpacity
Gets the actual opacity to use for the underline element when focused.
Declaration
public double ActualFocusUnderlineOpacity { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualFocusUnderlineRippleOpacity
Gets the actual opacity to use for the underline ripple element when focused.
Declaration
public double ActualFocusUnderlineRippleOpacity { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualHoverUnderlineColor
Gets the actual color to use for the underline element.
Declaration
public string ActualHoverUnderlineColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualHoverUnderlineOpacity
Gets the actual opacity to use for the underline element when hovered.
Declaration
public double ActualHoverUnderlineOpacity { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualHoverUnderlineWidth
Gets the width to use for the underline element when hovered.
Declaration
public double ActualHoverUnderlineWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualLabelTextColor
Gets the actual color to use for the text color.
Declaration
public string ActualLabelTextColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualLabelVisible
Gets or sets the visibility of the label.
Declaration
public bool ActualLabelVisible { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ActualNoMatchesFoundLabel
Gets the actual text to display on the list when no suggested matches are found.
Declaration
public string ActualNoMatchesFoundLabel { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualNoMatchesFoundLabelBackgroundColor
Gets the actual color to use for the "no matches found" label.
Declaration
public string ActualNoMatchesFoundLabelBackgroundColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualNoMatchesFoundLabelTextColor
Gets the actual color to use for the "no matches found" label.
Declaration
public string ActualNoMatchesFoundLabelTextColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualTextColor
Gets the actual color to use for the text color.
Declaration
public string ActualTextColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualUnderlineColor
Gets the actual color to use for the underline element.
Declaration
public string ActualUnderlineColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualUnderlineOpacity
Gets the actual opacity to use for the underline element.
Declaration
public double ActualUnderlineOpacity { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualUnderlineRippleColor
Gets the actual color to use for the underline ripple element.
Declaration
public string ActualUnderlineRippleColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualUnderlineRippleOpacity
Gets the actual opacity to use for the underline ripple element.
Declaration
public double ActualUnderlineRippleOpacity { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualUnderlineRippleWidth
Gets the actual width to use for the underline element.
Declaration
public double ActualUnderlineRippleWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualUnderlineWidth
Gets the actual width to use for the underline element.
Declaration
public double ActualUnderlineWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
ActualValueField
Gets the actual name of the field in the data source will be used as the Value of the MultiColumnComboBox.
Declaration
public string[] ActualValueField { get; set; }
Property Value
Type |
Description |
System.String[] |
|
AllowFilter
Whether to allow filtering of the combo
Declaration
public bool AllowFilter { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
BackgroundColor
Gets or sets the background color to use for the input group.
Declaration
public string BackgroundColor { get; set; }
Property Value
Type |
Description |
System.String |
|
BaseTheme
Gets or sets the base built in theme to use for the component.
Declaration
public BaseControlTheme BaseTheme { get; set; }
Property Value
BorderColor
Gets or sets the color to use the border of the input group.
Declaration
public string BorderColor { get; set; }
Property Value
Type |
Description |
System.String |
|
BorderWidth
Gets or sets the border width to use for the border of the item group.
Declaration
public double BorderWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
Change
Declaration
public EventCallback<IgbInputChangeEventArgs> Change { get; set; }
Property Value
ChangeScript
Declaration
public string ChangeScript { get; set; }
Property Value
Type |
Description |
System.String |
|
Changing
Declaration
public EventCallback<IgbInputChangeEventArgs> Changing { get; set; }
Property Value
ChangingScript
Declaration
public string ChangingScript { get; set; }
Property Value
Type |
Description |
System.String |
|
ColumnHeadersVisible
Gets or sets the visibility of the drop down button.
Declaration
public bool ColumnHeadersVisible { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ContentPaddingBottom
Declaration
public double ContentPaddingBottom { get; set; }
Property Value
Type |
Description |
System.Double |
|
ContentPaddingLeft
Declaration
public double ContentPaddingLeft { get; set; }
Property Value
Type |
Description |
System.Double |
|
ContentPaddingRight
Declaration
public double ContentPaddingRight { get; set; }
Property Value
Type |
Description |
System.Double |
|
ContentPaddingTop
Declaration
public double ContentPaddingTop { get; set; }
Property Value
Type |
Description |
System.Double |
|
CornerRadiusBottomLeft
Declaration
public double CornerRadiusBottomLeft { get; set; }
Property Value
Type |
Description |
System.Double |
|
CornerRadiusBottomRight
Declaration
public double CornerRadiusBottomRight { get; set; }
Property Value
Type |
Description |
System.Double |
|
CornerRadiusTopLeft
Declaration
public double CornerRadiusTopLeft { get; set; }
Property Value
Type |
Description |
System.Double |
|
CornerRadiusTopRight
Declaration
public double CornerRadiusTopRight { get; set; }
Property Value
Type |
Description |
System.Double |
|
DataSource
Gets or sets the data to which to bind the combo box list. This can be some type of array or list, or it can
be an IDataSource instance.
Declaration
public object DataSource { get; set; }
Property Value
Type |
Description |
System.Object |
|
DataSourceDesiredProperties
Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source.
Declaration
public string[] DataSourceDesiredProperties { get; set; }
Property Value
Type |
Description |
System.String[] |
|
DataSourceScript
Provides a means of setting DataSource in the JavaScript environment.
Declaration
public string DataSourceScript { get; set; }
Property Value
Type |
Description |
System.String |
|
DefaultColumnWidth
Declaration
public double DefaultColumnWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
Density
Gets or sets the display Density to use for the buttons and dropdown grid.
Declaration
public ControlDisplayDensity Density { get; set; }
Property Value
Gets or sets the visibility of the drop down button.
Declaration
public bool DropDownButtonVisible { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Fields
Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source.
Declaration
public string[] Fields { get; set; }
Property Value
Type |
Description |
System.String[] |
|
FocusBorderColor
Gets or sets the color to use the hovered background of the inputs in the group.
Declaration
public string FocusBorderColor { get; set; }
Property Value
Type |
Description |
System.String |
|
FocusBorderWidth
Gets or sets the border width to use for the border of the item group when focused.
Declaration
public double FocusBorderWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
FocusUnderlineColor
Gets or sets the color to use for the underline element.
Declaration
public string FocusUnderlineColor { get; set; }
Property Value
Type |
Description |
System.String |
|
FocusUnderlineOpacity
Gets or sets the color to use for the underline element.
Declaration
public double FocusUnderlineOpacity { get; set; }
Property Value
Type |
Description |
System.Double |
|
FocusUnderlineRippleOpacity
Gets or sets the opacity to use for the underline ripple element when focused.
Declaration
public double FocusUnderlineRippleOpacity { get; set; }
Property Value
Type |
Description |
System.Double |
|
FontFamily
Declaration
public string FontFamily { get; set; }
Property Value
Type |
Description |
System.String |
|
FontSize
Declaration
public double FontSize { get; set; }
Property Value
Type |
Description |
System.Double |
|
FontStyle
Declaration
public string FontStyle { get; set; }
Property Value
Type |
Description |
System.String |
|
FontWeight
Declaration
public string FontWeight { get; set; }
Property Value
Type |
Description |
System.String |
|
GotFocus
Declaration
public EventCallback<IgbGotFocusEventArgs> GotFocus { get; set; }
Property Value
GotFocusScript
Declaration
public string GotFocusScript { get; set; }
Property Value
Type |
Description |
System.String |
|
HoverUnderlineColor
Gets or sets the color to use for the underline element.
Declaration
public string HoverUnderlineColor { get; set; }
Property Value
Type |
Description |
System.String |
|
HoverUnderlineOpacity
Gets or sets the color to use for the underline element.
Declaration
public double HoverUnderlineOpacity { get; set; }
Property Value
Type |
Description |
System.Double |
|
HoverUnderlineWidth
Gets or sets the width to use for the underline element when hovered.
Declaration
public double HoverUnderlineWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
KeyDown
Declaration
public EventCallback<IgbKeyEventArgs> KeyDown { get; set; }
Property Value
Type |
Description |
Microsoft.AspNetCore.Components.EventCallback<IgbKeyEventArgs> |
|
KeyDownScript
Declaration
public string KeyDownScript { get; set; }
Property Value
Type |
Description |
System.String |
|
Label
The text displayed in the label portion of the control.
Declaration
public string Label { get; set; }
Property Value
Type |
Description |
System.String |
|
LabelFontFamily
Declaration
public string LabelFontFamily { get; set; }
Property Value
Type |
Description |
System.String |
|
LabelFontSize
Declaration
public double LabelFontSize { get; set; }
Property Value
Type |
Description |
System.Double |
|
LabelFontStyle
Declaration
public string LabelFontStyle { get; set; }
Property Value
Type |
Description |
System.String |
|
LabelFontWeight
Declaration
public string LabelFontWeight { get; set; }
Property Value
Type |
Description |
System.String |
|
LabelTextColor
Gets or sets the color to use for the text.
Declaration
public string LabelTextColor { get; set; }
Property Value
Type |
Description |
System.String |
|
LostFocus
Declaration
public EventCallback<IgbLostFocusEventArgs> LostFocus { get; set; }
Property Value
LostFocusScript
Declaration
public string LostFocusScript { get; set; }
Property Value
Type |
Description |
System.String |
|
NoMatchesFoundLabel
Gets or sets the text to display on the list when no suggested matches are found.
Declaration
public string NoMatchesFoundLabel { get; set; }
Property Value
Type |
Description |
System.String |
|
NoMatchesFoundLabelBackgroundColor
Gets or sets the color to use for the "no matches found" label.
Declaration
public string NoMatchesFoundLabelBackgroundColor { get; set; }
Property Value
Type |
Description |
System.String |
|
NoMatchesFoundLabelFontFamily
Declaration
public string NoMatchesFoundLabelFontFamily { get; set; }
Property Value
Type |
Description |
System.String |
|
NoMatchesFoundLabelFontSize
Declaration
public double NoMatchesFoundLabelFontSize { get; set; }
Property Value
Type |
Description |
System.Double |
|
NoMatchesFoundLabelFontStyle
Declaration
public string NoMatchesFoundLabelFontStyle { get; set; }
Property Value
Type |
Description |
System.String |
|
NoMatchesFoundLabelFontWeight
Declaration
public string NoMatchesFoundLabelFontWeight { get; set; }
Property Value
Type |
Description |
System.String |
|
NoMatchesFoundLabelTextColor
Gets or sets the color to use for the "no matches found" label.
Declaration
public string NoMatchesFoundLabelTextColor { get; set; }
Property Value
Type |
Description |
System.String |
|
Placeholder
Placeholder text which gives the user a hint about what kind of text is expected.
Declaration
public string Placeholder { get; set; }
Property Value
Type |
Description |
System.String |
|
RowSeparatorsVisible
Gets or sets the visibility of the row separators in the drop down.
Declaration
public bool RowSeparatorsVisible { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
SelectedValueChanged
Declaration
public EventCallback<IgbMultiColumnComboBoxValueChangedEventArgs> SelectedValueChanged { get; set; }
Property Value
SelectedValueChangedScript
Declaration
public string SelectedValueChangedScript { get; set; }
Property Value
Type |
Description |
System.String |
|
Gets or sets the ShowClearButton property to detirmine if the clear button is shown
Declaration
public bool ShowClearButton { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
SortMode
Returns/sets the action to take when a column header is clicked.
Declaration
public SortMode SortMode { get; set; }
Property Value
Text
The text displayed in the edit portion of the control.
Declaration
public string Text { get; set; }
Property Value
Type |
Description |
System.String |
|
TextChanged
Declaration
public EventCallback<string> TextChanged { get; set; }
Property Value
Type |
Description |
Microsoft.AspNetCore.Components.EventCallback<System.String> |
|
TextChangedScript
Declaration
public string TextChangedScript { get; set; }
Property Value
Type |
Description |
System.String |
|
TextColor
Gets or sets the color to use for the text.
Declaration
public string TextColor { get; set; }
Property Value
Type |
Description |
System.String |
|
TextField
Determines the name of the field in the data source will be used as the Text of the MultiColumnComboBox.
Declaration
public string TextField { get; set; }
Property Value
Type |
Description |
System.String |
|
TextValueChanged
Declaration
public EventCallback<IgbMultiColumnComboBoxTextChangedEventArgs> TextValueChanged { get; set; }
Property Value
TextValueChangedScript
Declaration
public string TextValueChangedScript { get; set; }
Property Value
Type |
Description |
System.String |
|
Type
Declaration
public override string Type { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
UnderlineColor
Gets or sets the color to use for the underline element.
Declaration
public string UnderlineColor { get; set; }
Property Value
Type |
Description |
System.String |
|
UnderlineOpacity
Gets or sets the color to use for the underline element.
Declaration
public double UnderlineOpacity { get; set; }
Property Value
Type |
Description |
System.Double |
|
UnderlineRippleColor
Gets or sets the color to use for the underline ripple element.
Declaration
public string UnderlineRippleColor { get; set; }
Property Value
Type |
Description |
System.String |
|
UnderlineRippleOpacity
Gets or sets the opacity to use for the underline ripple element.
Declaration
public double UnderlineRippleOpacity { get; set; }
Property Value
Type |
Description |
System.Double |
|
UnderlineRippleWidth
Gets or sets the width to use for the underline element.
Declaration
public double UnderlineRippleWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
UnderlineWidth
Gets or sets the width to use for the underline element.
Declaration
public double UnderlineWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
Value
Gets or sets the Value of the combo.
Declaration
public object Value { get; set; }
Property Value
Type |
Description |
System.Object |
|
Remarks
ValueChanged
Declaration
public EventCallback<object> ValueChanged { get; set; }
Property Value
Type |
Description |
Microsoft.AspNetCore.Components.EventCallback<System.Object> |
|
ValueChangedScript
Declaration
public string ValueChangedScript { get; set; }
Property Value
Type |
Description |
System.String |
|
ValueField
Sets or gets the user provided primary key to assume for the data. Certain functionality of the combo (such as the the current Value) requires
a way to uniquely identify items in order to work correctly.
If a primary key cannot be inferred from the data source, you may need to provide one here.
Declaration
public string[] ValueField { get; set; }
Property Value
Type |
Description |
System.String[] |
|
Methods
CloseUp()
Declaration
CloseUpAsync()
Programmatically closes the list.
Declaration
public Task CloseUpAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
DropDown()
Declaration
DropDownAsync()
Programmatically drops down the list.
Declaration
public Task DropDownAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
EnsureModulesLoaded()
Declaration
protected override void EnsureModulesLoaded()
Overrides
ExportSerializedVisualModel()
Declaration
public string ExportSerializedVisualModel()
Returns
Type |
Description |
System.String |
|
ExportSerializedVisualModelAsync()
Returns a serialized copy of the exported visual model
Declaration
public Task<string> ExportSerializedVisualModelAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task<System.String> |
|
ExportVisualModel()
Declaration
public object ExportVisualModel()
Returns
Type |
Description |
System.Object |
|
ExportVisualModelAsync()
Exports visual information about the current state of the grid.
Declaration
public Task<object> ExportVisualModelAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Object> |
|
FindByName(String)
Declaration
public override object FindByName(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
Type |
Description |
System.Object |
|
Overrides
GetCurrentText()
Declaration
public string GetCurrentText()
Returns
Type |
Description |
System.String |
|
GetCurrentTextAsync()
Declaration
public Task<string> GetCurrentTextAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task<System.String> |
|
GetCurrentValue()
Declaration
public object GetCurrentValue()
Returns
Type |
Description |
System.Object |
|
GetCurrentValueAsync()
Declaration
public Task<object> GetCurrentValueAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Object> |
|
Select()
Declaration
SelectAsync()
Selects all the text in the combo input area.
Declaration
public Task SelectAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Implements
System.IDisposable