FilterEventArgs.Item Property

Definition

Namespace:

System.Windows.Data

Assembly:

PresentationFramework.dll

Gets the object that the filter should test.

public:
 property System::Object ^ Item { System::Object ^ get(); };

public object Item { get; }

member this.Item : obj

Public ReadOnly Property Item As Object

Property Value

Object

The object that the filter should test. The default is null.

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.

See also

• Filter