IWorkItemFilter.ShouldFilterItem Method

checks if a certain item should be filtered out in the CheckBoxResultGrid

Namespace:  Microsoft.TeamFoundation.WorkItemTracking.Controls
Assembly:  Microsoft.TeamFoundation.WorkItemTracking.Controls (in Microsoft.TeamFoundation.WorkItemTracking.Controls.dll)

Syntax

'Declaration
Function ShouldFilterItem ( _
    workItem As WorkItem, _
    <OutAttribute> ByRef reason As String, _
    <OutAttribute> ByRef icon As Bitmap _
) As FilterReason

FilterReason ShouldFilterItem(
    WorkItem workItem,
    out string reason,
    out Bitmap icon
)

FilterReason ShouldFilterItem(
    WorkItem^ workItem, 
    [OutAttribute] String^% reason, 
    [OutAttribute] Bitmap^% icon
)

abstract ShouldFilterItem : 
        workItem:WorkItem * 
        reason:string byref * 
        icon:Bitmap byref -> FilterReason

function ShouldFilterItem(
    workItem : WorkItem, 
    reason : String, 
    icon : Bitmap
) : FilterReason

Parameters

• workItem
  Type: Microsoft.TeamFoundation.WorkItemTracking.Client.WorkItem

  the workitem that we are interested in

• reason
  Type: System.String%

  the reason why the item is filtered, will be displayed in a tooltip

• icon
  Type: System.Drawing.Bitmap%

  (optional)the icon to show instead of a check box if the item is not Valid (for optimal visual appearance use 11x11 icon), if null will use default icons

Return Value

Type: Microsoft.TeamFoundation.WorkItemTracking.Controls.FilterReason
one of the FilterReason enum values.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IWorkItemFilter Interface

Microsoft.TeamFoundation.WorkItemTracking.Controls Namespace