C# Class Microsoft.VisualStudio.Project.FileNode

Inheritance: HierarchyNode

Afficher le fichier Open project: tunnelvisionlabs/MPFProj10 Class Usage Examples

Protected Properties

Свойство	Type	Description
extensionIcons	int>.Dictionary

Private Properties

Свойство	Type	Description
GetSccSpecialFiles	void
IProjectSourceNode	int
IProjectSourceNode	int

Méthodes publiques

Méthode	Description
CreateSingleFileGenerator ( ) : ISingleFileGenerator	factory method for creating single file generators.
DeleteFromStorage ( string path ) : void	Delete the item corresponding to the specified path from storage.
FileNode ( ProjectNode root, ProjectElement element ) : System	Constructor for the FileNode
GetAutomationObject ( ) : object	Get an instance of the automation object for a FileNode
GetDocumentManager ( ) : DocumentManager	Returns a specific Document manager to handle files
GetDragTargetHandlerNode ( ) : HierarchyNode	Called by the drag&drop implementation to ask the node which is being dragged/droped over which nodes should process the operation. This allows for dragging to a node that cannot contain items to let its parent accept the drop, while a reference node delegate to the project and a folder/project node to itself.
GetEditLabel ( ) : string	Provides the node name for inline editing of caption. Overriden to diable this fuctionality for non member fodler node.
GetIconHandle ( bool open ) : object
GetMKDocument ( ) : string
GetProperty ( int propId ) : object	Gets the node property.
IsFileOnDisk ( bool showMessage ) : bool	Determine if this item is represented physical on disk and shows a messagebox in case that the file is not present and a UI is to be presented.
IsFileOnDisk ( string path ) : bool	Determine if the file represented by "path" exist in storage. Override this method if your files are not persisted on disk.
OnCustomToolChanged ( object sender, HierarchyNodeEventArgs e ) : void	Event handler for the Custom tool property changes
OnCustomToolNameSpaceChanged ( object sender, HierarchyNodeEventArgs e ) : void	Event handler for the Custom tool namespce property changes
RenameDocument ( string oldName, string newName ) : bool	Get's called to rename the eventually running document this hierarchyitem points to
RunGenerator ( ) : void	Runs a generator.
SetEditLabel ( string label ) : int	Renames a file node.
SetEditLabel ( string label, string relativePath ) : int	Rename the underlying document based on the change the user just made to the edit label.
SetProperty ( int propid, object value ) : int	Sets the node property.

Méthodes protégées

Méthode	Description
AfterSaveItemAs ( IntPtr docData, string newFilePath ) : int	Performs a SaveAs operation of an open document. Called from SaveItem after the running document table has been updated with the new doc data.
CanDeleteItem ( __VSDELETEITEMOPERATION deleteOperation ) : bool
CanShowDefaultIcon ( ) : bool	Determines if this is node a valid node for painting the default file icon.
CreatePropertiesObject ( ) : NodeProperties
DoDefaultAction ( ) : void
ExecCommandOnNode ( System.Guid cmdGroup, uint cmd, Microsoft.VisualStudio.OLE.Interop.OLECMDEXECOPT nCmdexecopt, IntPtr pvaIn, IntPtr pvaOut ) : int
QueryStatusOnNode ( System.Guid cmdGroup, uint cmd, IntPtr pCmdText, EnvDTE.vsCommandStatus &result ) : int
RecoverFromRenameFailure ( string fileThatFailed, string originalFileName ) : void	Tries recovering from a rename failure.
RenameCaseOnlyChange ( string newFileName ) : void	Renames the file node for a case only change.
RenameChildNodes ( FileNode parentNode ) : void	Rename all childnodes
RenameFileNode ( string oldFileName, string newFileName ) : FileNode
RenameFileNode ( string oldFileName, string newFileName, string linkPath, HierarchyNode newParent ) : FileNode	Renames the file in the hierarchy by removing old node and adding a new node in the hierarchy. While a new node will be used to represent the item, the underlying MSBuild item will be the same and as a result file properties saved in the project file will not be lost.
RenameInStorage ( string oldName, string newName ) : void	This should be overriden for node that are not saved on disk

Private Methods

Méthode	Description
GetSccSpecialFiles ( string sccFile, IList files, IList flags ) : void
IProjectSourceNode ( ) : int
IProjectSourceNode ( bool recursive ) : int

Method Details

AfterSaveItemAs() protected méthode

Performs a SaveAs operation of an open document. Called from SaveItem after the running document table has been updated with the new doc data.

protected AfterSaveItemAs ( IntPtr docData, string newFilePath ) : int
docData	System.IntPtr	A pointer to the document in the rdt
newFilePath	string	The new file path to the document
Résultat	int

CanDeleteItem() protected méthode

protected CanDeleteItem ( __VSDELETEITEMOPERATION deleteOperation ) : bool
deleteOperation	__VSDELETEITEMOPERATION
Résultat	bool

CanShowDefaultIcon() protected méthode

Determines if this is node a valid node for painting the default file icon.

protected CanShowDefaultIcon ( ) : bool
Résultat	bool

CreatePropertiesObject() protected méthode

protected CreatePropertiesObject ( ) : NodeProperties
Résultat	NodeProperties

CreateSingleFileGenerator() public méthode

factory method for creating single file generators.

public CreateSingleFileGenerator ( ) : ISingleFileGenerator
Résultat	ISingleFileGenerator

DeleteFromStorage() public méthode

Delete the item corresponding to the specified path from storage.

public DeleteFromStorage ( string path ) : void
path	string
Résultat	void

DoDefaultAction() protected méthode

protected DoDefaultAction ( ) : void
Résultat	void

ExecCommandOnNode() protected méthode

protected ExecCommandOnNode ( System.Guid cmdGroup, uint cmd, Microsoft.VisualStudio.OLE.Interop.OLECMDEXECOPT nCmdexecopt, IntPtr pvaIn, IntPtr pvaOut ) : int
cmdGroup	System.Guid
cmd	uint
nCmdexecopt	Microsoft.VisualStudio.OLE.Interop.OLECMDEXECOPT
pvaIn	System.IntPtr
pvaOut	System.IntPtr
Résultat	int

FileNode() public méthode

Constructor for the FileNode

public FileNode ( ProjectNode root, ProjectElement element ) : System
root	ProjectNode	Root of the hierarchy
element	ProjectElement	Associated project element
Résultat	System

GetAutomationObject() public méthode

Get an instance of the automation object for a FileNode

public GetAutomationObject ( ) : object
Résultat	object

GetDocumentManager() public méthode

Returns a specific Document manager to handle files

public GetDocumentManager ( ) : DocumentManager
Résultat	DocumentManager

GetDragTargetHandlerNode() public méthode

Called by the drag&drop implementation to ask the node which is being dragged/droped over which nodes should process the operation. This allows for dragging to a node that cannot contain items to let its parent accept the drop, while a reference node delegate to the project and a folder/project node to itself.

public GetDragTargetHandlerNode ( ) : HierarchyNode
Résultat	HierarchyNode

GetEditLabel() public méthode

Provides the node name for inline editing of caption. Overriden to diable this fuctionality for non member fodler node.

public GetEditLabel ( ) : string
Résultat	string

GetIconHandle() public méthode

public GetIconHandle ( bool open ) : object
open	bool
Résultat	object

GetMKDocument() public méthode

public GetMKDocument ( ) : string
Résultat	string

GetProperty() public méthode

Gets the node property.

public GetProperty ( int propId ) : object
propId	int	Property id.
Résultat	object

IsFileOnDisk() public méthode

Determine if this item is represented physical on disk and shows a messagebox in case that the file is not present and a UI is to be presented.

public IsFileOnDisk ( bool showMessage ) : bool
showMessage	bool	true if user should be presented for UI in case the file is not present
Résultat	bool

IsFileOnDisk() public méthode

Determine if the file represented by "path" exist in storage. Override this method if your files are not persisted on disk.

public IsFileOnDisk ( string path ) : bool
path	string	Url representing the file
Résultat	bool

OnCustomToolChanged() public méthode

Event handler for the Custom tool property changes

public OnCustomToolChanged ( object sender, HierarchyNodeEventArgs e ) : void
sender	object	FileNode sending it
e	HierarchyNodeEventArgs	Node event args
Résultat	void

OnCustomToolNameSpaceChanged() public méthode

Event handler for the Custom tool namespce property changes

public OnCustomToolNameSpaceChanged ( object sender, HierarchyNodeEventArgs e ) : void
sender	object	FileNode sending it
e	HierarchyNodeEventArgs	Node event args
Résultat	void

QueryStatusOnNode() protected méthode

protected QueryStatusOnNode ( System.Guid cmdGroup, uint cmd, IntPtr pCmdText, EnvDTE.vsCommandStatus &result ) : int
cmdGroup	System.Guid
cmd	uint
pCmdText	System.IntPtr
result	EnvDTE.vsCommandStatus
Résultat	int

RecoverFromRenameFailure() protected méthode

Tries recovering from a rename failure.

protected RecoverFromRenameFailure ( string fileThatFailed, string originalFileName ) : void
fileThatFailed	string	The file that failed to be renamed.
originalFileName	string	The original filenamee
Résultat	void

RenameCaseOnlyChange() protected méthode

Renames the file node for a case only change.

protected RenameCaseOnlyChange ( string newFileName ) : void
newFileName	string	The new file name.
Résultat	void

RenameChildNodes() protected méthode

Rename all childnodes

protected RenameChildNodes ( FileNode parentNode ) : void
parentNode	FileNode	The newly added Parent node.
Résultat	void

RenameDocument() public méthode

Get's called to rename the eventually running document this hierarchyitem points to

public RenameDocument ( string oldName, string newName ) : bool
oldName	string
newName	string
Résultat	bool

RenameFileNode() protected méthode

protected RenameFileNode ( string oldFileName, string newFileName ) : FileNode
oldFileName	string
newFileName	string
Résultat	FileNode

RenameFileNode() protected méthode

Renames the file in the hierarchy by removing old node and adding a new node in the hierarchy.

While a new node will be used to represent the item, the underlying MSBuild item will be the same and as a result file properties saved in the project file will not be lost.

protected RenameFileNode ( string oldFileName, string newFileName, string linkPath, HierarchyNode newParent ) : FileNode
oldFileName	string	The old file name.
newFileName	string	The new file name
linkPath	string
newParent	HierarchyNode	The new parent of the item.
Résultat	FileNode

RenameInStorage() protected méthode

This should be overriden for node that are not saved on disk

protected RenameInStorage ( string oldName, string newName ) : void
oldName	string	Previous name in storage
newName	string	New name in storage
Résultat	void

RunGenerator() public méthode

Runs a generator.

public RunGenerator ( ) : void
Résultat	void

SetEditLabel() public méthode

Renames a file node.

if the file cannot be validated

public SetEditLabel ( string label ) : int
label	string	The new name.
Résultat	int

SetEditLabel() public méthode

Rename the underlying document based on the change the user just made to the edit label.

public SetEditLabel ( string label, string relativePath ) : int
label	string
relativePath	string
Résultat	int

SetProperty() public méthode

Sets the node property.

public SetProperty ( int propid, object value ) : int
propid	int	Property id.
value	object	Property value.
Résultat	int

Property Details

extensionIcons protected_oe static_oe property

protected static Dictionary extensionIcons
Résultat	int>.Dictionary