Using the Custom Filter Dialog

Please note that this control has been retired and is now obsolete to the XamDataGrid control, and as such, we recommend migrating to that control. It will not be receiving any new features, bug fixes, or support going forward. For help or questions on migrating your codebase to the XamDataGrid, please contact support.

Topic Overview

Purpose

This topic explains the Custom Filter Dialog feature in the xamGrid™ and how the dialog interface can be used by the end user to create complex filters on data in a column.

Required background

The following table lists the topics required as a prerequisite to understanding this topic.

Topic	Purpose
Filtering	This topic explains how the end user can filter the data that is contained within the xamGrid control.

In this topic

This topic contains the following sections:

Control Configuration Summary
Enabling Custom Filter Dialog
User Interaction and Usability
Related Content

Control Configuration Summary

Control configuration overview

The following table lists the configurable aspects of the filtering and enabling the Custom Filter Dialog in the xamGrid control. Additional details are available after the summary table.

Configurable aspects	Details	Properties
Enabling the Custom Filter Dialog	Filtering has to be enabled through a FilterMenu so the end user can access the Custom Filter Dialog.	AllowFiltering

Enabling Custom Filter Dialog

Overview

The Custom Filter Dialog can be accessed by the end user if you enable the filtering and filter menu in the xamGrid control.

Property settings

The following table maps the desired configuration to the property setting.

In order to:	Use this property:	And set it to:
Enable the Custom Filter Dialog	AllowFiltering	FilterMenu

Example

The following screenshots demonstrate how the filter menu and custom filter dialog looks as a result of enabling the filtering with the following setting:

Property	Value
AllowFiltering	FilterMenu

xamGrid Using the Custom Filter Dialog 1.png

Figure 1 FilterMenu Icon

xamGrid Using the Custom Filter Dialog 2.png

Figure 2 Opening the filter menu

xamGrid Using the Custom Filter Dialog 3.png

Figure 3 Custom Filter Menu

User Interaction and Usability

User interactions summary

The following table summarizes the user interaction capabilities of the Custom Filter Dialog in the xamGrid control. Additional details are available after the table.

The user can…	Using…	Details
add a new filtering condition	the Add Condition button	Clicking on the button creates a new entry in the filtering conditions grid.
edit the filter operand	the combo box in the filter operand field	The Filter operand field contains an editable combo box that lists all operands applicable for the data type of the filtered column.
edit the filter value	the editor in the filter value field	The Filter value field contains a specific editor for the data type of the filtered column.
delete the selected conditions	the Remove Condition(s) button	Clicking the button deletes the selected condition(s).
combine two or more selected conditions in an And group	the And Group button	Clicking the button combines two or more selected conditions with AND operator and surrounds the group with brackets.
combine two or more selected conditions in an Or group	the Or Group button	Clicking the button combines two or more selected conditions with an OR operator and surrounds the group with brackets.
switch between logical operators AND and OR	the Toggle button	Clicking the button switches the logical operator between selected conditions
accept and apply the newly created complex filter	the Accept button	Clicking the button applies the newly created complex filter to the column data.
close the dialog without applying the created filter	the Cancel button	Clicking the button closes the dialog without applying the created filter to the column data.

Topic	Purpose
Filtering Events	This topic describes the filtering events in the xamGrid control.
Programmatically Create a Filter	This topic demonstrates how to create a filter programmatically.
Create a Custom Filter	This topic demonstrates how to add custom filters in the xamGrid control.
Filter Operands	This topic demonstrates how to change or remove certain filter operands from the filter row.

WPF | Help Topics