Share via


IVsDataExplorerNode Interface

Represents any node in the Visual Studio Server Explorer that appears as a child to the Data Connections node.

This API is not CLS-compliant. 

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Interface IVsDataExplorerNode
[CLSCompliantAttribute(false)]
public interface IVsDataExplorerNode
[CLSCompliantAttribute(false)]
public interface class IVsDataExplorerNode
[<CLSCompliantAttribute(false)>]
type IVsDataExplorerNode =  interface end
public interface IVsDataExplorerNode

The IVsDataExplorerNode type exposes the following members.

Properties

  Name Description
Public property CanCopy Gets a value indicating whether the copy command is supported on the node.
Public property CanCut Gets a value indicating whether the cut command is supported on the node.
Public property CanDelete Gets a value indicating whether the delete command is supported on the node.
Public property CanOpen Gets a value indicating whether the open command is supported on the node.
Public property CanPaste Gets a value indicating whether the paste command is supported on the node.
Public property CanRename Gets a value indicating whether the rename command is supported on the node.
Public property Caption Gets the caption of the node.
Public property Children Gets a collection of all child nodes that appear under this node in Server Explorer.
Public property DocumentMoniker Gets the document moniker for this node through the data view hierarchy.
Public property ExplorerConnection Gets the data explorer connection that is currently being used.
Public property FullName Gets the full name of the node.
Public property HasBeenExpanded Gets a value indicating whether the current node has been expanded.
Public property IsDiscarded Gets a value indicating whether the current node is discarded.
Public property IsExpandable Gets a value indicating whether the current node can be expanded to show lower-level child nodes.
Public property IsExpanded Gets a value indicating whether the current node is expanded.
Public property IsExpanding Gets a value indicating whether the current node is in the process of being expanded.
Public property IsPlaced Gets a value indicating whether the current node has been inserted into the Server Explorer tree.
Public property IsRefreshing Gets a value indicating whether the current node is in the process of being refreshed.
Public property IsVisible Gets a value indicating whether the current node is visible in the Server Explorer window.
Public property ItemId Gets a numerical value that identifies the current node.
Public property Name Gets the name of the current node.
Public property NextSibling Gets the next node that is a sibling to the current node in Server Explorer.
Public property Object Gets the data object associated with the current Server Explorer node.
Public property Parent The parent node of the current node in Server Explorer.
Public property PreviousSibling Gets a node that is a sibling to the current node and that is immediately before the current node.

Top

Methods

  Name Description
Public method AddToSelection Adds the current node to a group of selected nodes.
Public method CanOpenSpecificDocumentView Indicates whether a document view window can be opened for the current node.
Public method Collapse Collapses the current node in order to hide its child nodes in Server Explorer.
Public method Copy Creates a copy of the current node.
Public method Cut Creates a copy of the current node and then deletes the node.
Public method Delete Deletes the current node from Server Explorer.
Public method DoDefaultAction Executes the default command, if any, on the current node.
Public method Expand Expands the current node in Server Explorer.
Public method ExpandToShow Expands the parent nodes in order to show the current node in Server Explorer.
Public method ExtendSelectionToNode Extends the selected items in the UI up to the current node, resulting in multiple node selection.
Public method FullNameEquals Verifies the full name of the current node.
Public method GetChildren Retrieves a collection of all child nodes for the current node.
Public method GetCommand Gets a menu command corresponding to the specified CommandID value.
Public method NameEquals Verifies the name of the current node.
Public method OpenDocument Opens the current node as a document window frame in the Visual Studio environment.
Public method OpenSpecificDocumentView(Guid) Opens the current node as a document window frame in the Visual Studio environment.
Public method OpenSpecificDocumentView(Guid, Object) Opens the current node as a document window frame in the Visual Studio environment.
Public method OpenSpecificDocumentView(Guid, Object, Boolean) Opens the current node as a document window frame in the Visual Studio environment.
Public method Paste Pastes the node from the Clipboard to Server Explorer.
Public method Refresh() Refreshes the current node and its child nodes asynchronously, if any are expanded in Server Explorer.
Public method Refresh(Boolean) Refreshes the current node and its child nodes, if any are expanded in Server Explorer.
Public method Rename Replaces the caption of the current node with a new name.
Public method Select Selects the current node in Server Explorer.
Public method Unselect Deselects the current node in Server Explorer.

Top

Remarks

This interface is implemented as a built-in DDEX service.

See Also

Reference

Microsoft.VisualStudio.Data.Services Namespace