DataViewHierarchyAccessor Class

  • Article

Represents a set of properties and methods that interact with the data view hierarchy implementation of the IVsUIHierarchy interface.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.DataViewHierarchyAccessor

Namespace:  Microsoft.VisualStudio.Data
Assembly:  Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

'Declaration
Public Class DataViewHierarchyAccessor

public class DataViewHierarchyAccessor

public ref class DataViewHierarchyAccessor

type DataViewHierarchyAccessor =  class end

public class DataViewHierarchyAccessor

The DataViewHierarchyAccessor type exposes the following members.

Constructors

  Name Description
Public method DataViewHierarchyAccessor Class constructor. Initializes a new instance of the DataViewHierarchyAccessor class with an IVsUIHierarchy object instance.

Top

Properties

  Name Description
Public property Connection Retrieves a DataConnection object instance representing the data connection pertaining to the data view hierarchy.
Public property Hierarchy Retrieves an IVsUIHierarchy object instance representing the current hierarchy view.
Public property SelectedDataView Retrieves a string representing the currently selected data view.
Public property ServiceProvider Retrieves the Visual Studio global service provider being used by the data view hierarchy.

Top

Methods

  Name Description
Public method ActivateDocumentIfOpen(String) Activates a document with the specified moniker, if the document is open.
Public method ActivateDocumentIfOpen(String, Guid) Activates a document with the specified moniker and logical view, if the document is open.
Public method CreateObjectNode Creates a new node in the data view hierarchy, but one without context and that is not placed anywhere in the hierarchy tree.
Public method DropObjectNode Drops an existing node that represents an object from the data source from the data view hierarchy.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public method ExecuteCommand(Int32, OleCommand) Executes an OLE command without arguments directly on the data view hierarchy.
Public method ExecuteCommand(Int32, OleCommand, Object) Executes an OLE command on the data view hierarchy with arguments.
Public method ExecuteCommand(Int32, OleCommand, OleCommandExecutionOption, Object) Executes an OLE command directly on the data view hierarchy, with a specific execution option and arguments.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetChildSelectionTypes Retrieves an array of the object types enumerated when a parent node is expanded to show its child nodes.
Public method GetChildStaticNodeIds Retrieves an array of the static node IDs that are children of the specified item ID.
Public method GetCommandStatus(Int32, OleCommand) Retrieves the status of an OLE command.
Public method GetCommandStatus(Int32, OleCommand, OleCommandTextType) Retrieves the status of an OLE command with a request for a particular type of command text.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetItemIdFromNodePath Infers the item ID of a node in the data view hierarchy given a path to the node.
Public method GetNodeId Retrieves the node ID as specified in the data view support XML from an item ID.
Public method GetNodeName Retrieves the display name of a specified node.
Public method GetNodePath Infers a node path from the location of a node in the data view hierarchy.
Public method GetObjectIdentifier Retrieves the data-source-specific identifier of the object associated with the node matching the specified item ID.
Public method GetObjectProperty Retrieves a property of a data object associated with the node matching the specified item ID.
Public method GetObjectType Retrieves the type of the data object associated with the node matching the specified item ID.
Public method GetProperty Retrieves a hierarchy property.
Public method GetSelectedItems Retrieves an integer array representing item IDs for currently selected nodes in the tree.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDocumentOpen(String) Retrieves a Boolean value that indicates whether a document with a particular moniker is currently open.
Public method IsDocumentOpen(String, Guid) Retrieves a Boolean value that indicates whether a document with a particular moniker and logical view is currently open.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetNodePath Sets the node path for a node identified by a particular item ID.
Public method SetProperty Sets a specified hierarchy property.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Use this class to make communicating with the data view hierarchy object from managed code simpler. Using this class is preferred over talking directly to the IVsHierarchy or IVsUIHierarchy interfaces.

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.VisualStudio.Data Namespace