Class SfMultiColumnComboBox

Represents a combo box control that displays multiple columns in its drop-down view. The drop-down is rendered using a SfDataGrid control, allowing users to view and select data from a tabular structure.

Inheritance

System.Object

SfView

SfContentView

SfMultiColumnComboBox

Implements

IDrawableLayout

Microsoft.Maui.Graphics.IDrawable

Microsoft.Maui.IAbsoluteLayout

Microsoft.Maui.ILayout

Microsoft.Maui.IView

Microsoft.Maui.IElement

Microsoft.Maui.ITransform

Microsoft.Maui.IContainer

System.Collections.Generic.IList<Microsoft.Maui.IView>

System.Collections.Generic.ICollection<Microsoft.Maui.IView>

System.Collections.Generic.IEnumerable<Microsoft.Maui.IView>

System.Collections.IEnumerable

Microsoft.Maui.ISafeAreaView

Microsoft.Maui.IPadding

Microsoft.Maui.ICrossPlatformLayout

Microsoft.Maui.IVisualTreeElement

Inherited Members

SfContentView.Content

SfContentView.ContentProperty

SfContentView.OnContentChanged(Object, Object)

SfView.ArrangeContent(Rect)

SfView.ArrangeOverride(Rect)

SfView.Children

SfView.ClipToBounds

SfView.GetSemanticsNodesCore(Double, Double)

SfView.IDrawableLayout.DrawingOrder

SfView.IDrawableLayout.InvalidateDrawable()

SfView.MeasureContent(Double, Double)

SfView.MeasureOverride(Double, Double)

SfView.OnBindingContextChanged()

SfView.OnDraw(ICanvas, RectF)

SfView.OnHandlerChanged()

SfView.Padding

SfView.PaddingProperty

Namespace: Syncfusion.Maui.DataGrid

Assembly: Syncfusion.Maui.DataGrid.dll

Syntax

public class SfMultiColumnComboBox : SfContentView, IDrawableLayout, IDrawable, IAbsoluteLayout, ILayout, IView, IElement, ITransform, IContainer, IList<IView>, ICollection<IView>, IEnumerable<IView>, IEnumerable, ISafeAreaView, IPadding, ICrossPlatformLayout, IVisualTreeElement, ISemanticsProvider

Constructors

SfMultiColumnComboBox()

Initializes a new instance of the SfMultiColumnComboBox class.

Declaration

public SfMultiColumnComboBox()

Fields

AllowAutoCompleteProperty

Identifies the AllowAutoComplete bindable property.

Declaration

public static readonly BindableProperty AllowAutoCompleteProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the AllowAutoComplete bindable property.

AllowCaseSensitiveFilteringProperty

Identifies the AllowCaseSensitiveFiltering bindable property.

Declaration

public static readonly BindableProperty AllowCaseSensitiveFilteringProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the AllowCaseSensitiveFiltering bindable property.

AllowDiacriticSensitiveFilteringProperty

Identifies the AllowDiacriticSensitiveFiltering bindable dependency property.

Declaration

public static readonly BindableProperty AllowDiacriticSensitiveFilteringProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the AllowDiacriticSensitiveFiltering bindable property.

AllowImmediatePopupProperty

Identifies the AllowImmediatePopup bindable property.

Declaration

public static readonly BindableProperty AllowImmediatePopupProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the AllowImmediatePopup bindable property.

AllowIncrementalFilteringProperty

Identifies the AllowIncrementalFiltering bindable property.

Declaration

public static readonly BindableProperty AllowIncrementalFilteringProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the AllowIncrementalFiltering bindable property.

AllowNullValueProperty

Identifies the AllowNullValue bindable property.

Declaration

public static readonly BindableProperty AllowNullValueProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the AllowNullValue bindable property.

AutoGenerateColumnsModeProperty

Identifies the AutoGenerateColumnsMode bindable property.

Declaration

public static readonly BindableProperty AutoGenerateColumnsModeProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the AutoGenerateColumnsMode bindable property.

ColumnsProperty

Identifies the Columns bindable property.

Declaration

public static readonly BindableProperty ColumnsProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the Columns bindable property.

DisplayMemberProperty

Identifies the DisplayMember bindable property.

Declaration

public static readonly BindableProperty DisplayMemberProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the DisplayMember bindable property.

FilterDelayProperty

Identifies FilterDelay bindable property.

Declaration

public static readonly BindableProperty FilterDelayProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the FilterDelay bindable property.

FilteredItemsProperty

Identifies the FilteredItems bindable property.

Declaration

public static readonly BindableProperty FilteredItemsProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the FilteredItems bindable property.

IsAutoPopupSizeProperty

Identifies the IsAutoPopupSize bindable property.

Declaration

public static readonly BindableProperty IsAutoPopupSizeProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the IsAutoPopupSize bindable property.

IsDropDownOpenProperty

Identifies the IsDropDownOpen bindable property.

Declaration

public static readonly BindableProperty IsDropDownOpenProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the IsDropDownOpen bindable property.

ItemsSourceProperty

Identifies the ItemsSource bindable property.

Declaration

public static readonly BindableProperty ItemsSourceProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the ItemsSource bindable property.

PopupColumnWidthModeProperty

Identifies the PopupColumnWidthMode bindable property.

Declaration

public static readonly BindableProperty PopupColumnWidthModeProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the PopupColumnWidthMode bindable property.

PopupHeightProperty

Identifies the PopupHeight bindable property.

Declaration

public static readonly BindableProperty PopupHeightProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the PopupHeight bindable property.

PopupMinHeightProperty

Identifies the PopupMinHeight bindable property.

Declaration

public static readonly BindableProperty PopupMinHeightProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the PopupMinHeight bindable property.

PopupMinWidthProperty

Identifies the PopupMinWidth bindable property.

Declaration

public static readonly BindableProperty PopupMinWidthProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the PopupMinWidth bindable property.

PopupWidthProperty

Identifies the PopupWidth bindable property.

Declaration

public static readonly BindableProperty PopupWidthProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the PopupWidth bindable property.

ReadOnlyProperty

Identifies the ReadOnly bindable property.

Declaration

public static readonly BindableProperty ReadOnlyProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the ReadOnly bindable property.

SearchConditionProperty

Identifies the SearchCondition bindable property.

Declaration

public static readonly BindableProperty SearchConditionProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the SearchCondition bindable property.

SearchTextProperty

Identifies the SearchText bindable property.

Declaration

public static readonly BindableProperty SearchTextProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the SearchText bindable property.

SelectedIndexProperty

Identifies the SelectedIndex bindable property.

Declaration

public static readonly BindableProperty SelectedIndexProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the SelectedIndex bindable property.

SelectedItemProperty

Identifies the SelectedItem bindable property.

Declaration

public static readonly BindableProperty SelectedItemProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the SelectedItem bindable property.

SelectedItemsProperty

Identifies the SelectedItems bindable property.

Declaration

public static readonly BindableProperty SelectedItemsProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the SelectedItems bindable property.

SelectedValueProperty

Identifies the SelectedValue bindable property.

Declaration

public static readonly BindableProperty SelectedValueProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the SelectedValue bindable property.

TextAlignmentProperty

Identifies the TextAlignment bindable property.

Declaration

public static readonly BindableProperty TextAlignmentProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the TextAlignment bindable property.

TextProperty

Identifies the Text bindable property.

Declaration

public static readonly BindableProperty TextProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the Text bindable property.

ValueMemberProperty

Identifies the ValueMember bindable property.

Declaration

public static readonly BindableProperty ValueMemberProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The identifier for the ValueMember bindable property.

Properties

AllowAutoComplete

Gets or sets a value that indicates whether the Entry text is need to auto append rather than typing the entire text in SfDataGridEntry.

Declaration

public bool AllowAutoComplete { get; set; }

Property Value

Type	Description
System.Boolean	true if the auto completion is enabled; otherwise, false. The default value is true.

AllowCaseSensitiveFiltering

Gets or sets a value that indicates the case-sensitive when AllowIncrementalFiltering bindable and AllowAutoComplete is enabled.

Declaration

public bool AllowCaseSensitiveFiltering { get; set; }

Property Value

Type	Description
System.Boolean	true if the case-sensitive is enabled for AllowIncrementalFiltering, AllowAutoComplete; otherwise, false. The default value is false.

AllowDiacriticSensitiveFiltering

Gets or sets a value that indicates whether the diacritic is enabled or not in the SfMultiColumnComboBox control.

Declaration

public bool AllowDiacriticSensitiveFiltering { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true.

AllowImmediatePopup

Gets or sets a value that indicates whether the pop-up is open while typing the value in Entry itself.

Declaration

public bool AllowImmediatePopup { get; set; }

Property Value

Type	Description
System.Boolean	true if the pop-up is opened while typing the text in Entry; otherwise, false. The default value is false.

AllowIncrementalFiltering

Gets or sets a value that indicates whether the SfDataGrid records are filter while entering the text in Entry.

Declaration

public bool AllowIncrementalFiltering { get; set; }

Property Value

Type	Description
System.Boolean	true if the SfDataGrid records are filter based on the entered text; otherwise, false.

Remarks

The default value is true.

AllowNullValue

Gets or sets a value that indicates whether the null values are allowed in the Entry.

Declaration

public bool AllowNullValue { get; set; }

Property Value

Type	Description
System.Boolean	true if the null values are allowed; otherwise, false. The default value is false.

AutoGenerateColumnsMode

Gets or sets a value that indicates how the columns are generated when AutoGenerateColumns is enabled.

Declaration

public AutoGenerateColumnsMode AutoGenerateColumnsMode { get; set; }

Property Value

Type	Description
AutoGenerateColumnsMode	One of the AutoGenerateColumnsMode enumeration that specifies the mode of automatic column generation. The default value is None.

See Also

AutoGenerateColumnsMode

Columns

Gets or sets the collection that contains all the columns in SfMultiColumnComboBox.

Declaration

public ColumnCollection Columns { get; set; }

Property Value

Type	Description
ColumnCollection	The collection that contains all the columns in SfMultiColumnComboBox.

See Also

Columns

DisplayMember

Gets or sets the path in underlying data object which is used to display the visual presentation of the control.

Declaration

public string DisplayMember { get; set; }

Property Value

Type	Description
System.String	A string specifying the name of an object in underlying data object which is used to display the text in control. The default value is string.Empty.

FilterDelay

Gets or sets a value that indicates the time(milliseconds) delay to perform auto-completion while typing in editor.

Declaration

public int FilterDelay { get; set; }

Property Value

Type	Description
System.Int32	The default value is 500.

Remarks

Auto-completion operation will be delayed for a specified amount of time.

FilteredItems

Gets the filtered items from the SfDataGrid which is present in the pop-up.

Declaration

public IEnumerable FilteredItems { get; }

Property Value

Type	Description
System.Collections.IEnumerable	The filtered items. The default value is null.

IsAutoPopupSize

Gets or sets a value that indicates whether the pop-up height and width is automatically adjusted based on rows and columns count.

Declaration

public bool IsAutoPopupSize { get; set; }

Property Value

Type	Description
System.Boolean	true if the pop-up height and width is automatically adjusted based on rows and column count; otherwise, false. The default value is true.

Remarks

PopupHeight PopupWidth

IsDropDownOpen

Gets or sets a value that indicates whether the drop-down is need to open while loading itself.

Declaration

public bool IsDropDownOpen { get; set; }

Property Value

Type	Description
System.Boolean	true if the drop-down in opened state; otherwise, false. The default value is false.

ItemsSource

Gets or sets the collection that is used to generate the content of SfDataGrid which is present in the pop-up.

Declaration

public object ItemsSource { get; set; }

Property Value

Type	Description
System.Object	The collection that is used to generate the content of SfDataGrid in pop-up. The default value is null.

See Also

ItemsSource

PopupColumnWidthMode

Gets or sets a value that indicates how the columns widths are determined in SfDataGrid which is present in the pop-up.

Declaration

public ColumnWidthMode PopupColumnWidthMode { get; set; }

Property Value

Type	Description
ColumnWidthMode	One of the enumeration in ColumnWidthModethat adjust the column width. The default value is None.

See Also

ColumnWidthMode

PopupHeight

Gets or sets the height of pop-up.

Declaration

public double PopupHeight { get; set; }

Property Value

Type	Description
System.Double	The height of the pop-up. The PopupMinHeight is set as the default height of the pop-up.

Remarks

When IsAutoPopupSize is true, the given pop-up height won't considered. Pop-up height will be calculated based on number of rows in a pop-up. When IsAutoPopupSize is false, then the given Pop-up height will be considered. if the given pop-up height is greater than the available height, then the pop-up height will set based on the available maximum height by considering top and bottom side of the window. if the given pop-up height is less than the PopupMinHeight, then PopupMinHeight will set as Pop-up height by not considering IsAutoPopupSize.

PopupMinHeight

Gets or sets the minimum height constraint of the pop-up.

Declaration

public double PopupMinHeight { get; set; }

Property Value

Type	Description
System.Double	The minimum height of the pop-up. The default value is 300.0.

PopupMinWidth

Gets or sets the minimum width constraint of the pop-up.

Declaration

public double PopupMinWidth { get; set; }

Property Value

Type	Description
System.Double	The minimum width of the pop-up. The default value is 200.0.

PopupWidth

Gets or sets the width of the pop-up.

Declaration

public double PopupWidth { get; set; }

Property Value

Type	Description
System.Double	The width of the pop-up. The PopupMinWidth is set as the default width of the pop-up.

Remarks

When IsAutoPopupSize is true, the given Pop-up Width won't considered. Pop-up width will be calculated based on the number of columns in a SfDataGrid. When IsAutoPopupSize is false, then the given Pop-up width will be considered. if the given pop-up width is greater than the available width, then the pop-up width will be set based on the available maximum width by considering left and right side of the window. if the given pop-up width is less than the PopupMinWidth, then PopupMinWidth will set as Pop-up Width by not considering IsAutoPopupSize.

ReadOnly

Gets or sets a value that indicates whether the Entry is allowed to edit or not.

Declaration

public bool ReadOnly { get; set; }

Property Value

Type	Description
System.Boolean	true if the Entry is read-only; otherwise, false. The default value is false.

SearchCondition

Gets or sets a value that indicates how the records are filter when AllowIncrementalFiltering is enabled.

Declaration

public DataGridSearchType SearchCondition { get; set; }

Property Value

Type	Description
DataGridSearchType	One of the enumeration DataGridSearchType that denotes the filtering condition. The default value is StartsWith.

Remarks

Records are filtered based on DataGridSearchType when AllowIncrementalFiltering is enabled.

SearchText

Gets the text which is entered in the Entry.

Declaration

public string SearchText { get; }

Property Value

Type	Description
System.String	The text which is entered in the Entry. The default value is String.Empty.

SelectedIndex

Gets or sets the index of selected row in SfDataGrid which is present in pop-up.

Declaration

public int SelectedIndex { get; set; }

Property Value

Type	Description
System.Int32	Index of the The default value is -1.

SelectedItem

Gets or sets the value based on ValueMember from SelectedItem.

Declaration

public object SelectedItem { get; set; }

Property Value

Type	Description
System.Object	The selected value will be set based on ValueMember. The default value is null.

SelectedItems

Gets or sets the collection of object that contains the data item of corresponding selected rows.

Declaration

public ObservableCollection<object> SelectedItems { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<System.Object>	The collection of object that is currently selected in the drop-down grid.

SelectedValue

Gets or sets the value based on ValueMember from SelectedItem.

Declaration

public object SelectedValue { get; set; }

Property Value

Type	Description
System.Object	The selected value will be set based on ValueMember. The default value is null.

Text

Gets or sets a string that specifies the text displayed in the Entry.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	A string that specifies the text displayed in the Entry. The default value is string.Empty.

TextAlignment

Gets or sets the horizontal alignment of the text displayed in the SfDataGridEntry.

Declaration

public TextAlignment TextAlignment { get; set; }

Property Value

Type	Description
Microsoft.Maui.TextAlignment	One of the Microsoft.Maui.TextAlignment enumeration that specifies the horizontal alignment of the SfDataGridEntry text. The default value is TextAlignment.Left.

ValueMember

Gets or sets the path in underlying data object which is used to get the SelectedValue.

Declaration

public string ValueMember { get; set; }

Property Value

Type	Description
System.String	A string specifying the name of an object in underlying data object which is used to get the SelectedValue from the SelectedItem. The default value is string.Empty.

Methods

CommitValue(Boolean)

Commit the given value in the editor.

Declaration

protected virtual void CommitValue(bool autoCommit = false)

Parameters

Type	Name	Description
System.Boolean	autoCommit	If it is true, set the selected item directly otherwise set the selected item based on DisplayMember.

DropDownAutoSize()

Calculate the pop-up height and Width when IsAutoPopupSize is enabled.

Declaration

protected virtual void DropDownAutoSize()

Remarks

Based on maximum available height in Top and bottom of the window from control, the pop-up height will be calculated. Likewise, pop-up width also calculated based on available width in left and right of the control. PopupHeight PopupWidth

FilterRecord(Object)

Returns true if the given item contains in record lists, else returns FALSE

Declaration

protected virtual bool FilterRecord(object item)

Parameters

Type	Name	Description
System.Object	item	The item to be filter.

Returns

Type	Description
System.Boolean	true if the item is filtered; otherwise, false.

Remarks

The filtering operation are done based on SearchCondition.

OnSizeAllocated(Double, Double)

Arranges the content of the pop-up.

Declaration

protected override void OnSizeAllocated(double width, double height)

Parameters

Type	Name	Description
System.Double	width
System.Double	height

ProcessAppendStringList(Object, String)

Returns the new string list for the given value.

Declaration

protected virtual List<string> ProcessAppendStringList(object item, string _value)

Parameters

Type	Name	Description
System.Object	item	The record
System.String	_value	New string list will be created based on the value.

Returns

Type	Description
System.Collections.Generic.List<System.String>	Created string list

ProcessAppendText(Object, String, String)

Checks whether the given exact value is starts with the filter text.

Declaration

protected virtual bool ProcessAppendText(object item, string exactValue, string filterText)

Parameters

Type	Name	Description
System.Object	item	The record
System.String	exactValue	The original value
System.String	filterText	The entered text in the editor.

Returns

Type	Description
System.Boolean	true if the exactValue is begins with filterText; otherwise, false.

ProcessIncrementalFiltering()

Processes the immediate filtering when typing the text in editor.

Declaration

protected virtual void ProcessIncrementalFiltering()

ProcessOnEditorTextChanged(Object, TextChangedEventArgs)

Occurs when the editor text gets changed.

Declaration

protected virtual void ProcessOnEditorTextChanged(object sender, TextChangedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender of the event
Microsoft.Maui.Controls.TextChangedEventArgs	e	The event data

Remarks

This event is raised if the editor text has been changed by either a programmatic modification or user interaction.

SetDisplayText(Object)

Set the text to the Entry.

Declaration

protected virtual void SetDisplayText(object selectedItem = null)

Parameters

Type	Name	Description
System.Object	selectedItem	Selected item of the SfDataGrid.

SetSelectedValue(Object)

Set the selected value to the SfMultiColumnComboBox based on the selected item.

Declaration

protected virtual void SetSelectedValue(object selectedItem)

Parameters

Type	Name	Description
System.Object	selectedItem	SelectedItem of the SfDataGrid.

Implements

IDrawableLayout

Microsoft.Maui.Graphics.IDrawable

Microsoft.Maui.IAbsoluteLayout

Microsoft.Maui.ILayout

Microsoft.Maui.IView

Microsoft.Maui.IElement

Microsoft.Maui.ITransform

Microsoft.Maui.IContainer

System.Collections.Generic.IList<>

System.Collections.Generic.ICollection<>

System.Collections.Generic.IEnumerable<>

System.Collections.IEnumerable

Microsoft.Maui.ISafeAreaView

Microsoft.Maui.IPadding

Microsoft.Maui.ICrossPlatformLayout

Microsoft.Maui.IVisualTreeElement