C# Class Microsoft.VisualStudio.Project.FolderNode

Inheritance: HierarchyNode

Datei anzeigen Open project: tunnelvisionlabs/MPFProj10 Class Usage Examples

Private Properties

Property	Type	Description
CreateDirectory	void
CreateDirectory	void
GetSccSpecialFiles	void
IProjectSourceNode	int
IProjectSourceNode	int

Public Methods

Method	Description
CollapseFolder ( ) : void	Collapses the folder.
DeleteFolder ( string path ) : void	Override if your node is not a file system folder so that it does nothing or it deletes it from your storage location.
DeleteFromStorage ( string path ) : void
ExpandFolder ( ) : void	Expands the folder.
FolderNode ( ProjectNode root, string relativePath, ProjectElement element ) : System	Constructor for the FolderNode
GetAutomationObject ( ) : object	Get the automation object for the FolderNode
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.
GetSccFiles ( System files, System flags ) : void	Enumerate the files associated with this node. A folder node is not a file and as such no file to enumerate.
RenameDirectory ( string newPath ) : void	Rename the physical directory for a folder node Override if your node does not use file system folder
SetEditLabel ( string label ) : int	Rename Folder
SetProperty ( int propid, object value ) : int	Sets the node property.
UpdateSccStateIcons ( ) : void	Recursevily walks the folder nodes and redraws the state icons

Protected Methods

Method	Description
AddToMSBuild ( bool recursive ) : void	Adds the this node to the build system.
CanDeleteItem ( __VSDELETEITEMOPERATION deleteOperation ) : bool
CreatePropertiesObject ( ) : NodeProperties
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
RenameFolder ( string newName ) : void
SetExpanded ( bool expanded ) : void	Sets the expanded state of the folder.
ShowFileOrFolderAlreadExistsErrorMessage ( string newPath ) : int	Show error message if not in automation mode, otherwise throw exception

Private Methods

Method	Description
CreateDirectory ( ) : void
CreateDirectory ( string newName ) : void
GetSccSpecialFiles ( string sccFile, IList files, IList flags ) : void
IProjectSourceNode ( ) : int
IProjectSourceNode ( bool recursive ) : int

Method Details

AddToMSBuild() protected method

Adds the this node to the build system.

protected AddToMSBuild ( bool recursive ) : void
recursive	bool	Flag to indicate if the addition should be recursive.
return	void

CanDeleteItem() protected method

protected CanDeleteItem ( __VSDELETEITEMOPERATION deleteOperation ) : bool
deleteOperation	__VSDELETEITEMOPERATION
return	bool

CollapseFolder() public method

Collapses the folder.

public CollapseFolder ( ) : void
return	void

CreatePropertiesObject() protected method

protected CreatePropertiesObject ( ) : NodeProperties
return	NodeProperties

DeleteFolder() public method

Override if your node is not a file system folder so that it does nothing or it deletes it from your storage location.

public DeleteFolder ( string path ) : void
path	string	Path to the folder to delete
return	void

DeleteFromStorage() public method

public DeleteFromStorage ( string path ) : void
path	string
return	void

ExecCommandOnNode() protected method

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
return	int

ExpandFolder() public method

Expands the folder.

public ExpandFolder ( ) : void
return	void

FolderNode() public method

Constructor for the FolderNode

public FolderNode ( ProjectNode root, string relativePath, ProjectElement element ) : System
root	ProjectNode	Root node of the hierarchy
relativePath	string	relative path from root i.e.: "NewFolder1\\NewFolder2\\NewFolder3
element	ProjectElement	Associated project element
return	System

GetAutomationObject() public method

Get the automation object for the FolderNode

public GetAutomationObject ( ) : object
return	object

GetEditLabel() public method

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

public GetEditLabel ( ) : string
return	string

GetIconHandle() public method

public GetIconHandle ( bool open ) : object
open	bool
return	object

GetMKDocument() public method

public GetMKDocument ( ) : string
return	string

GetProperty() public method

Gets the node property.

public GetProperty ( int propId ) : object
propId	int	Property id.
return	object

GetSccFiles() public method

Enumerate the files associated with this node. A folder node is not a file and as such no file to enumerate.

public GetSccFiles ( System files, System flags ) : void
files	System	The list of files to be placed under source control.
flags	System	The flags that are associated to the files.
return	void

QueryStatusOnNode() protected method

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

RenameDirectory() public method

Rename the physical directory for a folder node Override if your node does not use file system folder

public RenameDirectory ( string newPath ) : void
newPath	string
return	void

RenameFolder() protected method

protected RenameFolder ( string newName ) : void
newName	string
return	void

SetEditLabel() public method

Rename Folder

public SetEditLabel ( string label ) : int
label	string	new Name of Folder
return	int

SetExpanded() protected method

Sets the expanded state of the folder.

protected SetExpanded ( bool expanded ) : void
expanded	bool	Flag that indicates the expanded state of the folder. /// This should be 'true' for expanded and 'false' for collapsed state.
return	void

SetProperty() public method

Sets the node property.

public SetProperty ( int propid, object value ) : int
propid	int	Property id.
value	object	Property value.
return	int

ShowFileOrFolderAlreadExistsErrorMessage() protected method

Show error message if not in automation mode, otherwise throw exception

protected ShowFileOrFolderAlreadExistsErrorMessage ( string newPath ) : int
newPath	string	path of file or folder already existing on disk
return	int

UpdateSccStateIcons() public method

Recursevily walks the folder nodes and redraws the state icons

public UpdateSccStateIcons ( ) : void
return	void