Export (0) Print
Expand All

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)

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

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.

Show:
© 2014 Microsoft