Export (0) Print
Expand All

FilterEventArgs Class

Provides information and event data that is associated with the CollectionViewSource.Filter event.

System.Object
  System.EventArgs
    System.Windows.Data.FilterEventArgs

Namespace:  System.Windows.Data
Assembly:  PresentationFramework (in PresentationFramework.dll)

'Declaration
Public Class FilterEventArgs _
	Inherits EventArgs

The FilterEventArgs type exposes the following members.

  NameDescription
Public propertyAcceptedGets or sets a value that indicates whether the item passes the filter.
Public propertyItemGets the object that the filter should test.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The following example shows how to set an event handler for the CollectionViewSource.Filter event. In this example, listingDataView is an instance of CollectionViewSource.

AddHandler listingDataView.Filter, AddressOf ShowOnlyBargainsFilter

The following example shows the implementation of the example ShowOnlyBargainsFilter filter event handler. This event handler uses the FilterEventArgs.Accepted property to filter out AuctionItem objects that have a CurrentPrice of $25.00 or greater.

Private Sub ShowOnlyBargainsFilter(ByVal sender As Object, ByVal e As FilterEventArgs)
    Dim product As AuctionItem = CType(e.Item, AuctionItem)
    If Not (product Is Nothing) Then 
        'Filter out products with price 25 or above 
        If product.CurrentPrice < 25 Then
            e.Accepted = True 
        Else
            e.Accepted = False 
        End If 
    End If 
End Sub

For the complete example, see Data Binding Demo.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft