QueryHierarchy Class

  • Article

Represents the top-level folder in a project.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.WorkItemTracking.Client.QueryItem
    Microsoft.TeamFoundation.WorkItemTracking.Client.QueryFolder
      Microsoft.TeamFoundation.WorkItemTracking.Client.QueryHierarchy

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

Syntax

'Declaration
Public NotInheritable Class QueryHierarchy _
    Inherits QueryFolder

public sealed class QueryHierarchy : QueryFolder

public ref class QueryHierarchy sealed : public QueryFolder

[<Sealed>]
type QueryHierarchy =  
    class 
        inherit QueryFolder 
    end

public final class QueryHierarchy extends QueryFolder

The QueryHierarchy type exposes the following members.

Properties

  Name Description
Public property AccessControlList Gets the access control list for the query item. (Inherited from QueryItem.)
Public property Count Gets the number of items in this folder. This count is not recursive. (Inherited from QueryFolder.)
Public property Id Gets the identifier of this query item. (Inherited from QueryItem.)
Public property IsDeleted Gets a flag describing whether this item is a personal query or folder. (Inherited from QueryItem.)
Public property IsDirty Gets a flag describing whether this query item needs to be saved. (Inherited from QueryItem.)
Public property IsNew Returns 'true' if this query item is stored on the server, 'false' if it is a 'new' query item that has not been saved. (Inherited from QueryItem.)
Public property IsPersonal Gets a flag describing whether this item is a personal query or folder. (Inherited from QueryItem.)
Public property Item[Guid] Gets the query item in this folder with the specified GUID. (Inherited from QueryFolder.)
Public property Item[String] Gets the query item in this folder with the specified name. (Inherited from QueryFolder.)
Public property Name Gets or sets the name of this query item. (Inherited from QueryItem.)
Public property OwnerDescriptor Gets or sets the identity descriptor of the owner of the query item. (Inherited from QueryItem.)
Public property Parent Gets the parent query folder. (Inherited from QueryItem.)
Public property Path Gets the fully qualified path of this query item. (Inherited from QueryItem.)
Public property Project Gets the project to which this query item is associated. (Inherited from QueryItem.)
Public property SupportsFolders Gets a flag describing whether the server supports creating query folders.
Public property SupportsPermissions Gets a flag describing whether the server supports setting permissions on queries and query folders.

Top

Methods

  Name Description
Public method Add Adds the specified query item to this folder. (Inherited from QueryFolder.)
Public method Contains(Guid) Checks whether the specified query item exists in this query folder. (Inherited from QueryFolder.)
Public method Contains(String) Checks whether the specified query item exists in this query folder. (Inherited from QueryFolder.)
Public method Contains(QueryItem) Checks whether the specified query item exists in this query folder. (Inherited from QueryFolder.)
Public method Delete Removes this item from the collection. (Inherited from QueryItem.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Find Gets the query item with the specified GUID.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Refresh Resets all changes to the hierarchy and updates the hierarchy from the server.
Public method Reset Undoes all changes to the hierarchy.
Public method Save Saves all changes to the hierarchy.
Public method ToString Returns the fully qualified path to this query item. (Inherited from QueryItem.)

Top

Events

  Name Description
Public event ChangesCommitted This event is fired when the content change of the folder is committed to the server. (Inherited from QueryFolder.)
Public event ContentsChanged This event is fired when the contents of the folder change. (Inherited from QueryFolder.)
Public event HierarchyRefreshed This event is fired after the hierarchy is successfully refreshed from the server.
Public event HierarchyReset This event is fired after the hierarchy is reset (all changes are undone).
Public event HierarchySaved Fired after updates to the hierarchy are successfully saved to the server.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IEnumerable<QueryItem>.GetEnumerator (Inherited from QueryFolder.)
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator (Inherited from QueryFolder.)

Top

Remarks

Contains the Team Queries and My Queries folders. Provides operations for finding items, resetting changes to the tree, and saving changes to the tree.

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.

See Also

Reference

Microsoft.TeamFoundation.WorkItemTracking.Client Namespace