C# Class Microsoft.VisualStudio.Project.TrackDocumentsHelper

Used by a project to query the environment for permission to add, remove, or rename a file or directory in a solution
Show file Open project: tunnelvisionlabs/MPFProj10 Class Usage Examples

Public Methods

Method Description
CanAddItems ( string files, VSQUERYADDFILEFLAGS flags ) : bool

Asks the environment for permission to add files.
CanRemoveItems ( string files, VSQUERYREMOVEFILEFLAGS flags ) : bool

Asks the environment for permission to remove files.
CanRenameItem ( string oldFileName, string newFileName, VSRENAMEFILEFLAGS flag ) : bool

Asks the environment for permission to rename files.
OnItemAdded ( string file, VSADDFILEFLAGS flag ) : void

Notify the environment about a file just added
OnItemRemoved ( string file, VSREMOVEFILEFLAGS flag ) : void

Notify the environment about a file just removed
OnItemRenamed ( string strOldName, string strNewName, VSRENAMEFILEFLAGS flag ) : void

Get's called to tell the env that a file was renamed
TrackDocumentsHelper ( ProjectNode project ) : System

Protected Methods

Method Description
GetIVsTrackProjectDocuments2 ( ) : IVsTrackProjectDocuments2

Gets the IVsTrackProjectDocuments2 object by asking the service provider for it.

Method Details

CanAddItems() public method

Asks the environment for permission to add files.
public CanAddItems ( string files, VSQUERYADDFILEFLAGS flags ) : bool
files string The files to add.
flags VSQUERYADDFILEFLAGS The VSQUERYADDFILEFLAGS flags associated to the files added
return bool

CanRemoveItems() public method

Asks the environment for permission to remove files.
public CanRemoveItems ( string files, VSQUERYREMOVEFILEFLAGS flags ) : bool
files string an array of files to remove
flags VSQUERYREMOVEFILEFLAGS The VSQUERYREMOVEFILEFLAGS associated to the files to be removed.
return bool

CanRenameItem() public method

Asks the environment for permission to rename files.
public CanRenameItem ( string oldFileName, string newFileName, VSRENAMEFILEFLAGS flag ) : bool
oldFileName string Path to the file to be renamed.
newFileName string Path to the new file.
flag VSRENAMEFILEFLAGS The VSRENAMEFILEFLAGS associated with the file to be renamed.
return bool

GetIVsTrackProjectDocuments2() protected method

Gets the IVsTrackProjectDocuments2 object by asking the service provider for it.
protected GetIVsTrackProjectDocuments2 ( ) : IVsTrackProjectDocuments2
return IVsTrackProjectDocuments2

OnItemAdded() public method

Notify the environment about a file just added
public OnItemAdded ( string file, VSADDFILEFLAGS flag ) : void
file string
flag VSADDFILEFLAGS
return void

OnItemRemoved() public method

Notify the environment about a file just removed
public OnItemRemoved ( string file, VSREMOVEFILEFLAGS flag ) : void
file string
flag VSREMOVEFILEFLAGS
return void

OnItemRenamed() public method

Get's called to tell the env that a file was renamed
public OnItemRenamed ( string strOldName, string strNewName, VSRENAMEFILEFLAGS flag ) : void
strOldName string
strNewName string
flag VSRENAMEFILEFLAGS
return void

TrackDocumentsHelper() public method

public TrackDocumentsHelper ( ProjectNode project ) : System
project ProjectNode
return System