diff --git a/README.md b/README.md index a33da9b..b5b38ed 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ -# syncfusion-checked-listbox-examples-for-wpf -Syncfusion checked listbox examples for wpf +# Syncfusion CheckedListBox Examples for WPF + +This repository contains the samples that demonstrate the functionalities of **Syncfusion WPF CheckedListBox** control, including **Grouping** and **Sorting** features. + +## Samples in this Repository +1. **CheckListBox Grouping** + Demonstrates how to group items in a CheckedListBox based on a property (e.g., Category). + [View Sample](https://github.com/SyncfusionExamples/syncfusion-checked-listbox-examples-for-wpf/tree/master/CheckListBox_Grouping) + +2. **CheckListBox Sorting** + Demonstrates how to sort items in a CheckedListBox based on a property (e.g., Name) in ascending order. + [View Sample](https://github.com/SyncfusionExamples/syncfusion-checked-listbox-examples-for-wpf/tree/master/CheckListBox_Sorting) + +--- + +## About Syncfusion CheckedListBox +The **CheckedListBox** control in WPF is an advanced list box that allows users to select multiple items using checkboxes. It supports data binding, grouping, sorting, and MVVM pattern for building modern WPF applications. + +### Grouping +Grouping organizes items into logical groups based on a property, such as Category. This improves readability and user experience when dealing with large datasets. The control uses **CollectionViewSource** internally to group items, and you can define `GroupDescriptions` to specify grouping criteria. + +### Sorting +Sorting arranges items in ascending or descending order based on a property, such as Name. This feature helps users quickly locate items. Sorting is achieved by adding `SortDescriptions` to the underlying collection view, which updates the display order dynamically. + +## Key Features +- **Data Binding**: Bind items and selected items to ViewModel properties. +- **MVVM Support**: Fully compatible with MVVM architecture. +- **Customization**: Supports styling and templating for a modern UI. + +## Documentation +- [CheckedListBox Grouping](https://help.syncfusion.com/wpf/checkedlistbox/grouping) +- [CheckedListBox Sorting](https://help.syncfusion.com/wpf/checkedlistbox/sorting) + +--- +