Back to Devexpress

ComboBoxEditBase.IsFilterEnabled Property

maui-devexpress-dot-maui-dot-editors-dot-comboboxeditbase-3bb29e79.md

latest4.1 KB
Original Source

ComboBoxEditBase.IsFilterEnabled Property

Gets or sets whether the user input and item filtering is enabled. This is a bindable property.

Namespace : DevExpress.Maui.Editors

Assembly : DevExpress.Maui.Editors.dll

NuGet Package : DevExpress.Maui.Editors

Declaration

csharp
public bool IsFilterEnabled { get; set; }

Property Value

TypeDefaultDescription
Booleanfalse

true to enable filtering; otherwise, false.

|

Remarks

When the filter functionality is enabled in a combo box, you can specify the PlaceholderText property to display a text prompt. The combo box displays this prompt in the edit box before a user enters a filter query.

If the IsFilterEnabled property is set to true, the ComboBoxEdit control ignores the ContentPage.HideSoftInputOnTapped property.

Example

The following example shows how to customize combo box appearance and set up item filtering.

|

State

|

Appearance

| | --- | --- | |

Unfocused

|

| |

Focused

|

| |

Filtered

|

|

xml
<dxe:ComboBoxEdit ItemsSource="{Binding}"

                  LabelText="Employee"
                  IsLabelFloating="True"
                  HelpText="Select an e-mail"
                  BorderColor="Black"
                  FocusedBorderColor="DarkOrange"
                  BackgroundColor="Beige"
                  LabelColor="Black"
                  FocusedLabelColor="DarkOrange"
                  CornerRadius="10"
                  CornerMode="Cut"
                  DropDownBackgroundColor="Beige"
                  DropDownSelectedItemBackgroundColor="Brown"
                  DropDownSelectedItemTextColor="White"

                  IsFilterEnabled="True"
                  FilterCondition="StartsWith"
                  FilterComparisonType="CurrentCultureIgnoreCase">

  <dxe:ComboBoxEdit.ItemTemplate>
    <DataTemplate>
      <Grid>
        <Label Margin="10,15,0,15" Text="{Binding Name}" FontAttributes="Bold"/>
        <Label Margin="0,15,0,15" Grid.Column="1" Text="{Binding Age}"/>
        <Label Margin="0,15,10,15" Grid.Column="2" Text="{Binding Location}" HorizontalTextAlignment="End"/>
      </Grid>
    </DataTemplate>
  </dxe:ComboBoxEdit.ItemTemplate>
</dxe:ComboBoxEdit>
cs
using System.Collections.Generic;
using System.ComponentModel;
using Microsoft.Maui.Controls;

namespace ComboBoxExample {
    public partial class MainPage : ContentPage {
        public MainPage() {
            InitializeComponent();
            this.BindingContext = new List<Person>() {
                new Person {Name = "Jane", Age = 43, Location = "Atlanta"},
                new Person {Name = "Margaret", Age = 25, Location = "Memphis"},
                new Person {Name = "Debbie", Age = 28, Location = "New-York"},
                new Person {Name = "John", Age = 19, Location = "Detroit"},
                new Person {Name = "Derek", Age = 36, Location = "Houston"}
            };
        }
    }

    public class Person {
        public string Name { get; set; }
        public int Age { get; set; }
        public string Location { get; set; }
    }
}

See Also

ComboBoxEditBase Class

ComboBoxEditBase Members

DevExpress.Maui.Editors Namespace