Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

FilterEventArgs Class

.NET Framework 4.5

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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)
C#
C++
F#
VB
Copy 

public class FilterEventArgs : EventArgs

The FilterEventArgs type exposes the following members.

  Name Description
Public property Accepted Gets or sets a value that indicates whether the item passes the filter.
Public property Item Gets the object that the filter should test.
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns 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.

C#
Copy 

listingDataView.Filter += new FilterEventHandler(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.

C#
Copy 

private void ShowOnlyBargainsFilter(object sender, FilterEventArgs e)
{
    AuctionItem product = e.Item as AuctionItem;
    if (product != null)
    {
        // Filter out products with price 25 or above
        if (product.CurrentPrice < 25)
        {
            e.Accepted = true;
        }
        else
        {
            e.Accepted = false;
        }
    }
}

For the complete example, see Data Binding Demo.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, 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.
Did you find this helpful?
(1500 characters remaining)