Query Class

Represents a query to the work item tracking service.

System.Object
  Microsoft.TeamFoundation.WorkItemTracking.Client.Query

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

public sealed class Query

The Query type exposes the following members.

  NameDescription
Public methodQuery(WorkItemStore, String)Initializes a new instance of the Query class.
Public methodQuery(WorkItemStore, String, BatchReadParameterCollection)Initializes a new instance of the Query class.
Public methodQuery(WorkItemStore, String, IDictionary)Initializes a new instance of the Query class.
Public methodQuery(WorkItemStore, String, Int32[])Initializes a new instance of the Query class.
Public methodQuery(WorkItemStore, String, IDictionary, Boolean)Initializes a new instance of the Query class.
Public methodQuery(WorkItemStore, String, Int32[], Int32[])Initializes a new instance of the Query class.
Top

  NameDescription
Public propertyAsOfGets the date and time, in local time, to which query results are current.
Public propertyAsOfUTCGets the date and time, in UTC, to which query results are current.
Public propertyDisplayFieldListGets the list of Fields that will be paged from the server when this query executes.
Public propertyIsBatchReadModeGets a flag that describes whether the query is reading a batch of parameters.
Public propertyIsLinkQueryGets a flag that describes whether this query is for WorkItemLink objects.
Public propertyIsTreeQueryGets a flag that describes whether this query is recursive on links.
Public propertyQueryStringGets the query string.
Public propertySortFieldListGets the SortFieldList that can be used to sort the results of this query.
Public propertyWorkItemStoreGets the WorkItemStore that is being queried.
Top

  NameDescription
Public methodBeginCountOnlyQuery()Initializes a cancelable asynchronous query that will return only the count of results.
Public methodBeginCountOnlyQuery(AsyncCallback)Initializes a cancelable asynchronous query that will return only the count of results by using a callback function.
Public methodBeginLinkQuery()Initializes a cancelable asynchronous query that will return a collection of WorkItemLinkInfo objects.
Public methodBeginLinkQuery(AsyncCallback)Initializes a cancelable asynchronous query that will return a collection of WorkItemLinkInfo objects by using a callback function.
Public methodBeginQuery()Initializes a cancelable asynchronous query of WorkItem objects.
Public methodBeginQuery(AsyncCallback)Initializes a cancelable asynchronous query of WorkItem objects by using a callback function.
Public methodBeginRegularQuery()Initializes a query for WorkItem IDs.
Public methodBeginRegularQuery(AsyncCallback)Initializes a query of WorkItem IDs by using a callback function.
Public methodEndCountOnlyQueryFinalizes a cancelable asynchronous query that will return only the count of results.
Public methodEndLinkQueryFinalizes a cancelable asynchronous query that will return an array of WorkItemLinkInfo objects.
Public methodEndQueryGets the WorkItemCollection object that resulted from the query.
Public methodEndRegularQueryFinalizes a cancelable asynchronous query that will return an array of WorkItem IDs that resulted from the query.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLinkTypesGets the array of WorkItemLinkTypeEnd objects that are associated with this query.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodRunCountQueryExecutes a query that returns the number of results.
Public methodRunLinkQueryExecutes a query that gets an array of WorkItemLinkInfo objects.
Public methodRunQueryExecutes a query that gets a WorkItemCollection that contains WorkItem objects that satisfy the query.
Public methodRunRegularQueryExecutes a query that gets an array of WorkItem IDs that satisfy the query.
Public methodRunRevisionQueryExecutes a query that gets an enumerable collection of work item revisions.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventAsyncStateChangedOccurs when the state of the asynchronous query changes. Calls the WorkItemAsyncEventHandler event handler.
Top

For a description of work item tracking queries, see Query for Bugs, Tasks, and Other Work Items.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft