HierarchyNode Members

Include Protected Members
Include Inherited Members

A parent node that has zero or more child nodes, each of which may itself be a hierarchy. This is the base class for hierarchy elements such as FileNode and FolderNode.

The HierarchyNode type exposes the following members.

Constructors

  Name Description
Protected method HierarchyNode Overloaded. Overloaded HierarchyNode constructor.

Top

Methods

  Name Description
Public method AddChild Adds a hierarchy node as a child node.
Protected method AddItemToHierarchy Adds a new item to the hierarchy.
Protected method AddNewFolder Adds a new folder to the project hierarchy.
Public method AdviseHierarchyEvents Establishes client notification of hierarchy events.
Protected method AfterSaveItemAs Saves an item after the SaveAs dialog box has been processed.
Protected method AllowPasteCommand Specifies whether a node can be pasted.
Protected method CanDeleteItem Checks whether the file can be deleted from storage or removed from the project.
Protected method CanShowDefaultIcon Checks whether this node can be displayed with the default item icon.
Public method Close Closes and cleans up a hierarchy after the environment determines that it is no longer used.
Protected method CloseDocumentWindow Closes an open document window for a specific node.
Protected method CopyToClipboard Copies a node to the clipboard.
Protected method CreatePropertiesObject Defines the properties attached to this node.
Protected method CutToClipboard Cuts a node and puts it on the clipboard.
Protected method DeleteFromStorage Deletes the file at the specified path from storage.
Public method DeleteItem Handles the deletion or removal of a hierarchy item.
Protected method DisableCmdInCurrentMode Disables commands when Visual Studio is in run or break mode.
Protected method DisableCommandOnNodesThatDoNotSupportMultiSelection Specifies commands for which multi-select does not work and should be disabled.
Protected method DisplayContextMenu Shows the shortcut menu for the specified nodes.
Protected method DoDefaultAction Performs the default event in the hierarchy. This is typically called when a user either presses ENTER or double-clicks the item.
Public method DragEnter Called when the mouse drags an item over a new hierarchy or hierarchy window.
Public method DragLeave Called when one or more items are dragged out of the hierarchy or hierarchy window, or when the drag-and-drop operation is canceled or completed.
Public method DragOver Called when one or more items are dragged over the target hierarchy or hierarchy window.
Public method Drop Called when one or more items are dropped into the target hierarchy or hierarchy window when the mouse button is released.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method ExcludeFromProject Removes this item from the project, but does not delete it from disk.
Public method Exec Executes the specified non-UI command or displays help for a command.
Public method ExecCommand Executes the specified command on the specified item in a UI hierarchy window, or on the hierarchy itself.
Protected method ExecCommandIndependentOfSelection Executes commands that do not depend on what is selected.
Protected method ExecCommandOnNode Handles execution of a given command on this node.
Protected method ExecCommandThatDependsOnSelectedNodes Handles execution of a command that is executed on a set of nodes.
Protected method Finalize Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method FindChildByProjectElement Finds a non-virtual hierarchy element (a node with a build item) by its project element.
Protected method GetAddFileFlags Gets flags that specify how files are added to a project.
Public method GetAutomationObject Gets an automation object for the current node.
Public method GetCanonicalName Overloaded. Gets the document moniker for the current node. In most cases, the moniker is the fully-qualified name of the document.
Protected method GetDocumentManager Gets the document manager for this node.
Protected method GetDragTargetHandlerNode Gets the node that should handle drag-and-drop operations.
Public method GetDropInfo Returns information about one or more of the items being dragged.
Public method GetEditLabel Gets a caption value for the editable node.
Public method GetGuidProperty Overloaded. Gets the GUID value of the hierarchy node.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetIconHandle Gets the icon handle.
Public method GetMkDocument Gets the name of the node.
Public method GetNestedHierarchy When overridden in a derived class, gets the nested hierarchy element that is specified by the item ID.
Public method GetProperty Overloaded. Gets properties of a given node or of the hierarchy.
Protected method GetQueryAddFileFlags Sets the flags to be used to add the specified set of files.
Protected method GetQueryRemoveFileFlags Sets the flags to be used to removed the specified files.
Public method GetRelationalName Gets the relational name.
Public method GetRelationNameExtension Gets the extension that is associated with a relational name.
Protected method GetRemoveFileFlags Gets flags that specify how files are added to a project.
Protected method GetSccFiles Provides a list of files and their associated flags for source code control.
Protected method GetSccSpecialFiles Provides a list of special files and their associated flags for source code control.
Public method GetService Gets the service of the specified type, if it is available.
Public method GetSite Gets the service provider from which to access the services.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IgnoreItemFileChanges Overloaded. Specifies whether a file change should be ignored.
Protected method InternalExecCommand The main entry point for command execution. It is called from the IVsUIHierarchy and IOleCommandTarget execution methods.
Public method IsItemDirty Determines whether the supplied item has changed.
Public method IsItemReloadable Overloaded. Specifies whether an item can be reloaded.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method OnBeforeDropNotify Notifies the source hierarchy that information dragged from it is about to be dropped on a target. This method is called immediately after the mouse button is released on a drop.
Public method OnDropNotify Notifies clients that the dragged item was dropped.
Public method OnInvalidateItems Notifies clients when changes are made to the item inventory of a hierarchy.
Public method OnItemAdded Notifies clients when an item is added to the hierarchy.
Public method OnItemDeleted Notifies clients when an item is deleted from the hierarchy.
Public method OnItemsAppended Notifies clients when items are appended to the end of the hierarchy.
Public method OnPropertyChanged Notifies clients when one or more properties of an item have changed.
Public method ParseCanonicalName Returns the identifier of the hierarchy item, given its canonical name.
Protected method PasteFromClipboard Pastes an item from the clipboard.
Protected method PrepareSelectedNodesForClipBoard Prepares selected nodes for the clipboard.
Public method QueryClose Determines whether the given hierarchy can be closed.
Public method QueryDeleteItem Called by the environment to determine whether the hierarchy supports item deletion, item removal, or both.
Public method QueryStatus Queries the object for the status of one or more commands that are generated by user interface events.
Public method QueryStatusCommand Queries the object for the command status.
Protected method QueryStatusCommandFromOleCommandTarget Handles menus that originate from IOleCommandTarget.
Protected method QueryStatusOnNode Handles command status on a node.
Protected method QueryStatusSelection Queries for the command status on the selected nodes.
Protected method QueryStatusSelectionOnNodes Queries the selected nodes for the command status.
Public method ReDraw Redraws the node.
Protected method RegisterClipboardNotifications Registers and un-registers clipboard events for the Solution Explorer.
Public method ReloadItem Overloaded. Reloads an item.
Public method Remove Removes items from the hierarchy.
Public method RemoveChild Removes a child node.
Public method SaveItem Saves the hierarchy item to disk.
Public method SetEditLabel Overloaded. Sets a caption value for the editable node.
Public method SetGuidProperty Overloaded. Sets properties whose values are GUIDs.
Public method SetProperty Overloaded. Sets properties of a specific node, or of the hierarchy.
Public method SetSite Sets the service provider from which to access the services.
Protected method ShowContextMenu Shows the specified shortcut menu at the specified location.
Protected method ShowInDesigner Handles the Show in Designer command.
Public method ToString Returns a String that represents the current Object. (Inherited from Object.)
Public method UnadviseHierarchyEvents Disables client notification of hierarchy events.
Public method Unused0 Adds new methods without recompiling or breaking binary compatibility.
Public method Unused1 Adds new methods without recompiling or breaking binary compatibility.
Public method Unused2 Adds new methods without recompiling or breaking binary compatibility.
Public method Unused3 Adds new methods without recompiling or breaking binary compatibility.
Public method Unused4 Adds new methods without recompiling or breaking binary compatibility.
Protected method UpdateSccStateIcons Redraws the source code control state icons of the node.

Top

Fields

  Name Description
Public fieldStatic member NoImage The constant for a missing image.
Public fieldStatic member SolutionExplorer The GUID of the Solution Explorer.

Top

Properties

  Name Description
Public property CanExecuteCommand Checks whether a node can execute a command if it is in a selection.
Public property Caption Gets the caption of the hierarchy node.
Public property DocCookie Gets or sets the ID of the associated file.
Public property ExcludeNodeFromScc Gets or sets whether a node should be excluded from source code control.
Public property FirstChild Gets or sets the first child hierarchy node.
Public property HasDesigner Gets or sets whether the hierarchy node has a designer associated with it.
Public property HasParentNodeNameRelation Defines whether a node has a name relation to its parent node.
Public property ID Gets the hierarchy node ID.
Public property ImageIndex Gets the index of the associated image.
Public property IsExpanded Gets or sets whether the hierarchy node is in the expanded state.
Public property ItemNode Gets or sets the associated project element node, which represents the build item.
Protected property ItemsDraggedOrCutOrCopied Gets the list of nodes that are selected for a drag, cut, or copy operation.
Public property ItemTypeGuid Gets the GUID of the item type of the node.
Public property LastChild Gets and sets the last child node.
Public property MenuCommandId Gets the menu command ID that is associated with the node.
Public property NameRelationSeparator Gets the name relation separator.
Public property NextSibling Gets or sets the next sibling node.
Public property NodeProperties Gets and sets the node properties of this node.
Public property OleServiceProvider Gets the OLE service provider for this node.
Public property Parent Gets or sets the parent node of this element.
Public property PreviousSibling Gets or sets the node that immediately precedes this hierarchy node element.
Public property ProjectMgr Gets or sets the root element for this hierarchy node.
Public property SortPriority Gets the default sort priority of this node.
Protected property SourceDraggedOrCutOrCopied Gets and sets whether there are items to be dragged, cut, or copied.
Public property StateIconIndex Gets the source code control state icon for a file.
Public property Url Gets the absolute path for this node.
Public property VirtualNodeName The name of a virtual node.

Top

See Also

Reference

HierarchyNode Class

Microsoft.VisualStudio.Package Namespace

  • Last updated on