.NET MAUI ListPicker Commands

ListPicker Commands

List Picker for .NET MAUI exposes the following commands you can use to programmatically manipulate displaying the popup as well as clearing the selected item:

• ToggleCommand(ICommand)—Allows you to show/hide the popup used for selecting an item from a list of items.
• ClearCommand(ICommand)—Allows you to clear the displayed item.

PopupSelector Commands

Through the popup, users can pick an item. The date value can be confirmed or rejected through the OK and Cancel buttons placed on the popup.

The ListPicker allows you to add a custom logic for the Accept and Cancel commands which are executed when the OK and Cancel buttons, respectively, are pressed.

• AcceptCommand(ICommand)—Defines the command which confirms the current selection of the picker and closes the popup.
• CancelCommand(ICommand)—Defines the command which rejects the current selection of the picker and closes the popup.

The Accept and Cancel commands can be applied using the SelectorSettings property of ListPicker.

Example

1. Define the ListPicker.

   <StackLayout>
     <Button Text="Toggle Command" Command="{Binding Source={x:Reference listPicker}, Path=ToggleCommand}"/>
     <Button Text="Clear Command" Command="{Binding Source={x:Reference listPicker}, Path=ClearCommand}"/>
     <telerik:RadListPicker Placeholder="Pick a name!"
                                 x:Name="listPicker"
                                 ItemsSource="{Binding Items}"
                                 DisplayMemberPath="FullName">
         <telerik:RadListPicker.PopupSettings>
             <telerik:PickerPopupSettings AcceptCommand="{Binding Accept}"
                                          CancelCommand="{Binding Cancel}" />
         </telerik:RadListPicker.PopupSettings>
         <telerik:RadListPicker.BindingContext>
             <local:ViewModel/>
         </telerik:RadListPicker.BindingContext>
     </telerik:RadListPicker>
   </StackLayout>
   

2. Set the sample ViewModel:

   public class ViewModel
   {
   public ViewModel()
   {
       this.Items = new ObservableCollection<Person>()
       {
           new Person("Freda","Curtis"),
           new Person("Jeffery","Francis"),
           new Person("Ema","Lawson"),
           new Person("Niki","Samaniego"),
           new Person("Jenny","Santos"),
           new Person("Eric","Wheeler"),
           new Person("Emmett","Fuller"),
           new Person("Brian","Johnas"),
       };
   
       this.Accept = new Command(this.OnAccept);
       this.Accept = new Command(this.OnCancel);
   }
   
   private void OnAccept(object obj)
   {
       // implement your custom logic here
   }
   
   private void OnCancel(object obj)
   {
       // implement your custom logic here
   }
   
   public ObservableCollection<Person> Items { get; set; }
   public ICommand Accept { get; set; }
   public ICommand Cancel { get; set; }
   }
   

3. Add the Business model:

   public class Person
   {
   public Person(string name, string lastName)
   {
       this.Name = name;
       this.LastName = lastName;
   }
   
   public string Name { get; set; }
   
   public string LastName { get; set; }
   
   public string FullName
   {
       get
       {
           return $"{this.Name} {this.LastName}";
       }
   }
   }
   

   public class Person
   {
   public Person(string name, string lastName)
   {
       this.Name = name;
       this.LastName = lastName;
   }
   
   public string Name { get; set; }
   
   public string LastName { get; set; }
   
   public string FullName
   {
       get
       {
           return $"{this.Name} {this.LastName}";
       }
   }
   }
   

4. Add the following namespace:

xmlns:telerik="http://schemas.telerik.com/2022/xaml/maui"

See Also

• Selection
• Templates