Filter Event

Raised for each item in the data source that has not already been excluded by a filter expression to determine if it passes a filter.

Syntax

Visual Basic
C#

'Declaration
 
Public Event Filter As EventHandler(Of DataGridFilterEventArgs)

'Usage
 
Dim instance As DataGridControl
Dim handler As EventHandler(Of DataGridFilterEventArgs)
 
AddHandler instance.Filter, handler

public event EventHandler<DataGridFilterEventArgs> Filter

Event Data

The event handler receives an argument of type DataGridFilterEventArgs containing data related to this event. The following DataGridFilterEventArgs properties provide information specific to this event.

Property	Description
Accepted	true if the item passes the filter; false otherwise., By default, true.

Remarks

The Filter event is executed locally, meaning that all items will be retrieved from the server in order to determine those that pass the filter. In a virtualized environment, it is not recommended to use the Filter event unless dealing with a very limited number of items.

Example

VB.NET

Private Sub DataGridControl_Filter( ByVal sender As Object, ByVal e As DataGridFilterEventArgs )
   Dim order As Order = CType( e.Item, Order )
 
   If order Is Nothing Then
      e.Accepted = False
   Else
      e.Accepted = ( order.ShippedDate > order.RequiredDate )
   End If
End Sub

private void DataGridControl_Filter( object sender, DataGridFilterEventArgs e )
{
   Order order = e.Item as Order;
 
   if( order == null )
   {
      e.Accepted = false;
   }
   else
   {
      e.Accepted = ( order.ShippedDate > order.RequiredDate );
   }
}

Requirements

Target Platforms: Windows 7, Windows Vista, Windows XP SP3, Windows Server 2008 family

Reference

DataGridControl Class
DataGridControl Members

Manipulating Data

Filtering Data