FileNode Members

A node in the project hierarchy that represents a file.

The FileNode type exposes the following members.

Constructors

	Name	Description
	FileNode	Initializes a new instance of the FileNode class for a given project root (for example, the root node of a project in the Solution Explorer) and a given project element, which represents the build item for the file.

Top

Methods

	Name	Description
	AddChild	Adds a hierarchy node as a child node. (Inherited from HierarchyNode.)
	AddItemToHierarchy	Adds a new item to the hierarchy. (Inherited from HierarchyNode.)
	AddNewFolder	Adds a new folder to the project hierarchy. (Inherited from HierarchyNode.)
	AdviseHierarchyEvents	Establishes client notification of hierarchy events. (Inherited from HierarchyNode.)
	AfterSaveItemAs	Performs the SaveAs operation. Saves a file after the running document table has been updated, creating new folders if necessary. (Overrides HierarchyNode.AfterSaveItemAs(IntPtr, String).)
	AllowPasteCommand	Specifies whether a node can be pasted. (Inherited from HierarchyNode.)
	CanDeleteItem	Checks whether the file can be deleted from storage or removed from the project. (Overrides HierarchyNode.CanDeleteItem(__VSDELETEITEMOPERATION).)
	CanShowDefaultIcon	Checks whether the default item icon can be displayed for the given node. (Overrides HierarchyNode.CanShowDefaultIcon().)
	Close	Closes and cleans up a hierarchy after the environment determines that it is no longer used. (Inherited from HierarchyNode.)
	CloseDocumentWindow	Closes an open document window for a specific node. (Inherited from HierarchyNode.)
	CopyToClipboard	Copies a node to the clipboard. (Inherited from HierarchyNode.)
	CreatePropertiesObject	Creates an object to expose properties specific for this object to the property browser. (Overrides HierarchyNode.CreatePropertiesObject().)
	CreateSingleFileGenerator	Factory method for creating a single file generator.
	CutToClipboard	Cuts a node and puts it on the clipboard. (Inherited from HierarchyNode.)
	DeleteFromStorage	Deletes a file from the specified path. (Overrides HierarchyNode.DeleteFromStorage(String).)
	DeleteItem	Handles the deletion or removal of a hierarchy item. (Inherited from HierarchyNode.)
	DisableCmdInCurrentMode	Disables commands when Visual Studio is in run or break mode. (Inherited from HierarchyNode.)
	DisableCommandOnNodesThatDoNotSupportMultiSelection	Specifies commands for which multi-select does not work and should be disabled. (Inherited from HierarchyNode.)
	DisplayContextMenu	Shows the shortcut menu for the specified nodes. (Inherited from HierarchyNode.)
	DoDefaultAction	Opens the file in a document window with a standard editor. (Overrides HierarchyNode.DoDefaultAction().)
	DragEnter	Called when the mouse drags an item over a new hierarchy or hierarchy window. (Inherited from HierarchyNode.)
	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. (Inherited from HierarchyNode.)
	DragOver	Called when one or more items are dragged over the target hierarchy or hierarchy window. (Inherited from HierarchyNode.)
	Drop	Called when one or more items are dropped into the target hierarchy or hierarchy window when the mouse button is released. (Inherited from HierarchyNode.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	ExcludeFromProject	Removes this item from the project, but does not delete it from disk. (Inherited from HierarchyNode.)
	Exec	Executes the specified non-UI command or displays help for a command. (Inherited from HierarchyNode.)
	ExecCommand	Executes the specified command on the specified item in a UI hierarchy window, or on the hierarchy itself. (Inherited from HierarchyNode.)
	ExecCommandIndependentOfSelection	Executes commands that do not depend on what is selected. (Inherited from HierarchyNode.)
	ExecCommandOnNode	Executes the given command on the file node. (Overrides HierarchyNode.ExecCommandOnNode(Guid, UInt32, UInt32, IntPtr, IntPtr).)
	ExecCommandThatDependsOnSelectedNodes	Handles execution of a command that is executed on a set of nodes. (Inherited from HierarchyNode.)
	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.)
	FindChildByProjectElement	Finds a non-virtual hierarchy element (a node with a build item) by its project element. (Inherited from HierarchyNode.)
	GetAddFileFlags	Gets flags that specify how files are added to a project. (Inherited from HierarchyNode.)
	GetAutomationObject	Gets the automation object corresponding to this file node. (Overrides HierarchyNode.GetAutomationObject().)
	GetCanonicalName	Overloaded.
	GetDocumentManager	Gets a file document manager that handles opening, saving of file items in the hierarchy. (Overrides HierarchyNode.GetDocumentManager().)
	GetDragTargetHandlerNode	Returns a target node that processes a drop action after the user has dragged and dropped this node. (Overrides HierarchyNode.GetDragTargetHandlerNode().)
	GetDropInfo	Returns information about one or more of the items being dragged. (Inherited from HierarchyNode.)
	GetEditLabel	Gets a caption value for the editable node. (Inherited from HierarchyNode.)
	GetGuidProperty	Overloaded.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetIconHandle	Gets the handle of the icon that represents the file node. (Overrides HierarchyNode.GetIconHandle(Boolean).)
	GetMkDocument	Gets the absolute path of the file. (Overrides HierarchyNode.GetMkDocument().)
	GetNestedHierarchy	When overridden in a derived class, gets the nested hierarchy element that is specified by the item ID. (Inherited from HierarchyNode.)
	GetProperty	Overloaded.
	GetQueryAddFileFlags	Sets the flags to be used to add the specified set of files. (Inherited from HierarchyNode.)
	GetQueryRemoveFileFlags	Sets the flags to be used to removed the specified files. (Inherited from HierarchyNode.)
	GetRelationalName	Gets the relational name. (Inherited from HierarchyNode.)
	GetRelationNameExtension	Gets the extension that is associated with a relational name. (Inherited from HierarchyNode.)
	GetRemoveFileFlags	Gets flags that specify how files are added to a project. (Inherited from HierarchyNode.)
	GetSccFiles	Provides a list of files and their associated flags for source code control. (Inherited from HierarchyNode.)
	GetSccSpecialFiles	Provides a list of special files and their associated flags for source code control. (Inherited from HierarchyNode.)
	GetService	Gets the service of the specified type, if it is available. (Inherited from HierarchyNode.)
	GetSite	Gets the service provider from which to access the services. (Inherited from HierarchyNode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IgnoreItemFileChanges	Overloaded.
	InternalExecCommand	The main entry point for command execution. It is called from the IVsUIHierarchy and IOleCommandTarget execution methods. (Inherited from HierarchyNode.)
	IsFileOnDisk	Overloaded. Checks whether this file exists on disk.
	IsItemDirty	Determines whether the supplied item has changed. (Inherited from HierarchyNode.)
	IsItemReloadable	Overloaded.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	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. (Inherited from HierarchyNode.)
	OnDropNotify	Notifies clients that the dragged item was dropped. (Inherited from HierarchyNode.)
	OnInvalidateItems	Notifies clients when changes are made to the item inventory of a hierarchy. (Inherited from HierarchyNode.)
	OnItemAdded	Notifies clients when an item is added to the hierarchy. (Inherited from HierarchyNode.)
	OnItemDeleted	Notifies clients when an item is deleted from the hierarchy. (Inherited from HierarchyNode.)
	OnItemsAppended	Notifies clients when items are appended to the end of the hierarchy. (Inherited from HierarchyNode.)
	OnPropertyChanged	Notifies clients when one or more properties of an item have changed. (Inherited from HierarchyNode.)
	ParseCanonicalName	Returns the identifier of the hierarchy item, given its canonical name. (Inherited from HierarchyNode.)
	PasteFromClipboard	Pastes an item from the clipboard. (Inherited from HierarchyNode.)
	PrepareSelectedNodesForClipBoard	Prepares selected nodes for the clipboard. (Inherited from HierarchyNode.)
	QueryClose	Determines whether the given hierarchy can be closed. (Inherited from HierarchyNode.)
	QueryDeleteItem	Called by the environment to determine whether the hierarchy supports item deletion, item removal, or both. (Inherited from HierarchyNode.)
	QueryStatus	Queries the object for the status of one or more commands that are generated by user interface events. (Inherited from HierarchyNode.)
	QueryStatusCommand	Queries the object for the command status. (Inherited from HierarchyNode.)
	QueryStatusCommandFromOleCommandTarget	Handles menus that originate from IOleCommandTarget. (Inherited from HierarchyNode.)
	QueryStatusOnNode	Checks whether a given command is supported and enabled on the file node. (Overrides HierarchyNode.QueryStatusOnNode(Guid, UInt32, IntPtr, QueryStatusResult%).)
	QueryStatusSelection	Queries for the command status on the selected nodes. (Inherited from HierarchyNode.)
	QueryStatusSelectionOnNodes	Queries the selected nodes for the command status. (Inherited from HierarchyNode.)
	RecoverFromRenameFailure	Attempts to recover from a renaming failure.
	ReDraw	Redraws the node. (Inherited from HierarchyNode.)
	RegisterClipboardNotifications	Registers and un-registers clipboard events for the Solution Explorer. (Inherited from HierarchyNode.)
	ReloadItem	Overloaded.
	Remove	Removes items from the hierarchy. (Inherited from HierarchyNode.)
	RemoveChild	Removes a child node. (Inherited from HierarchyNode.)
	RenameChildNodes	Renames child nodes
	RenameFileNode	Renames the file and updates it in the hierarchy.
	RenameInStorage	Renames the file on disk. Should be overridden for files that are not saved to disk.
	SaveItem	Saves the hierarchy item to disk. (Inherited from HierarchyNode.)
	SetEditLabel	Overloaded. Sets the editable name of the file, for example the name that appears in the Solution Explorer.
	SetGuidProperty	Overloaded.
	SetProperty	Overloaded.
	SetSite	Sets the service provider from which to access the services. (Inherited from HierarchyNode.)
	ShowContextMenu	Shows the specified shortcut menu at the specified location. (Inherited from HierarchyNode.)
	ShowInDesigner	Handles the Show in Designer command. (Inherited from HierarchyNode.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)
	UnadviseHierarchyEvents	Disables client notification of hierarchy events. (Inherited from HierarchyNode.)
	Unused0	Adds new methods without recompiling or breaking binary compatibility. (Inherited from HierarchyNode.)
	Unused1	Adds new methods without recompiling or breaking binary compatibility. (Inherited from HierarchyNode.)
	Unused2	Adds new methods without recompiling or breaking binary compatibility. (Inherited from HierarchyNode.)
	Unused3	Adds new methods without recompiling or breaking binary compatibility. (Inherited from HierarchyNode.)
	Unused4	Adds new methods without recompiling or breaking binary compatibility. (Inherited from HierarchyNode.)
	UpdateSccStateIcons	Redraws the source code control state icons of the node. (Inherited from HierarchyNode.)

Top

Properties

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

Top

See Also

Reference

FileNode Class

Microsoft.VisualStudio.Package Namespace