FilterEventArgs Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides information and event data that is associated with the Filter event.
public ref class FilterEventArgs : EventArgs
public class FilterEventArgs : EventArgs
type FilterEventArgs = class
inherit EventArgs
Public Class FilterEventArgs
Inherits EventArgs
- Inheritance
Examples
The following example shows how to set an event handler for the CollectionViewSource.Filter event. In this example, listingDataView
is an instance of CollectionViewSource.
listingDataView.Filter += new FilterEventHandler(ShowOnlyBargainsFilter);
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 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;
}
}
}
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.
Properties
Accepted |
Gets or sets a value that indicates whether the item passes the filter. |
Item |
Gets the object that the filter should test. |
Methods
Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
GetType() |
Gets the Type of the current instance. (Inherited from Object) |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
ToString() |
Returns a string that represents the current object. (Inherited from Object) |