Query Class
Represents a query to the work item tracking service.
Inheritance Hierarchy
System.Object
Microsoft.TeamFoundation.WorkItemTracking.Client.Query
Namespace: Microsoft.TeamFoundation.WorkItemTracking.Client
Assembly: Microsoft.TeamFoundation.WorkItemTracking.Client (in Microsoft.TeamFoundation.WorkItemTracking.Client.dll)
Syntax
'宣告
Public NotInheritable Class Query
public sealed class Query
public ref class Query sealed
[<Sealed>]
type Query = class end
public final class Query
The Query type exposes the following members.
Constructors
Name | Description | |
---|---|---|
Query(WorkItemStore, String) | Initializes a new instance of the Query class. | |
Query(WorkItemStore, String, BatchReadParameterCollection) | Initializes a new instance of the Query class. | |
Query(WorkItemStore, String, IDictionary) | Initializes a new instance of the Query class. | |
Query(WorkItemStore, String, array<Int32[]) | Initializes a new instance of the Query class. | |
Query(WorkItemStore, String, IDictionary, Boolean) | Initializes a new instance of the Query class. | |
Query(WorkItemStore, String, array<Int32[], array<Int32[]) | Initializes a new instance of the Query class. |
Top
Properties
Name | Description | |
---|---|---|
AsOf | Gets the date and time, in local time, to which query results are current. | |
AsOfUTC | Gets the date and time, in UTC, to which query results are current. | |
DisplayFieldList | Gets the list of Fields that will be paged from the server when this query executes. | |
IsBatchReadMode | Gets a flag that describes whether the query is reading a batch of parameters. | |
IsLinkQuery | Gets a flag that describes whether this query is for WorkItemLink objects. | |
IsTreeQuery | Gets a flag that describes whether this query is recursive on links. | |
QueryString | Gets the query string. | |
SortFieldList | Gets the SortFieldList that can be used to sort the results of this query. | |
WorkItemStore | Gets the WorkItemStore that is being queried. |
Top
Methods
Name | Description | |
---|---|---|
BeginCountOnlyQuery() | Initializes a cancelable asynchronous query that will return only the count of results. | |
BeginCountOnlyQuery(AsyncCallback) | Initializes a cancelable asynchronous query that will return only the count of results by using a callback function. | |
BeginLinkQuery() | Initializes a cancelable asynchronous query that will return a collection of WorkItemLinkInfo objects. | |
BeginLinkQuery(AsyncCallback) | Initializes a cancelable asynchronous query that will return a collection of WorkItemLinkInfo objects by using a callback function. | |
BeginQuery() | Initializes a cancelable asynchronous query of WorkItem objects. | |
BeginQuery(AsyncCallback) | Initializes a cancelable asynchronous query of WorkItem objects by using a callback function. | |
BeginRegularQuery() | Initializes a query for WorkItem IDs. | |
BeginRegularQuery(AsyncCallback) | Initializes a query of WorkItem IDs by using a callback function. | |
EndCountOnlyQuery | Finalizes a cancelable asynchronous query that will return only the count of results. | |
EndLinkQuery | Finalizes a cancelable asynchronous query that will return an array of WorkItemLinkInfo objects. | |
EndQuery | Gets the WorkItemCollection object that resulted from the query. | |
EndRegularQuery | Finalizes a cancelable asynchronous query that will return an array of WorkItem IDs that resulted from the query. | |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetLinkTypes | Gets the array of WorkItemLinkTypeEnd objects that are associated with this query. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
RunCountQuery | Executes a query that returns the number of results. | |
RunLinkQuery | Executes a query that gets an array of WorkItemLinkInfo objects. | |
RunQuery | Executes a query that gets a WorkItemCollection that contains WorkItem objects that satisfy the query. | |
RunRegularQuery | Executes a query that gets an array of WorkItem IDs that satisfy the query. | |
RunRevisionQuery | Executes a query that gets an enumerable collection of work item revisions. | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
Name | Description | |
---|---|---|
AsyncStateChanged | Occurs when the state of the asynchronous query changes. Calls the WorkItemAsyncEventHandler event handler. |
Top
Remarks
For a description of work item tracking queries, see Finding Bugs, Tasks, and Other Work Items by Using the Work Item Query Language and the Client Object Model for Team Foundation.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.