When I use the Visual Studio environment, sometimes I have to open 'Windows Explorer' in the folder of the solution to do some tasks as copy files, rename files, launch application by double clicking on the executable.
Because my projects aren't at the root of my hard disk, I lose a lot of time. So, one day, I decided to create the 'Explorer' add-in for Visual Studio 2005.
To install the 'Explorer' add-in:
That's all...
To open 'Windows Explorer' in a specific folder:
To launch the application as if you double clicked on an '.exe' file in 'Windows Explorer'.
To collapse all nodes of the solution explorer window
To search help on the web for the current selected source code
This part is done by the MenuManager.CreatePopupMenu
method.
In Visual Studio, the CommandBar
interface is used to manage menus. So, first, I have to retrieve the CommandBar
object corresponding to the item (of the 'Solution Explorer' window) where I want to add the popup menu. To do it, I use the CommandBars
property of the DTE
interface like this:
private CommandBar GetCommandBar(string commandBarName)
{
return ((CommandBars)application.DTE.CommandBars)[commandBarName];
}
where commandBarName
is the string "Solution", "Project", "Folder", ... Then, I add the CommandBarPopup
corresponding to the 'Explorer' menu to this CommandBar
.
CommandBarPopup menu = GetCommandBar(commandBarName).Controls.Add(
MsoControlType.msoControlPopup,
Missing.Value, Missing.Value, 1, true)
as CommandBarPopup;
This part is done by the MenuManager.AddCommand
method. This method takes a CommandBarPopup
, a CommandBase
, and a position
as parameters, and does the following:
CommandBarPopup
menu at the specified position
.Click
event.CommandBase
to an internal dictionary to be able to retrieve it in the handler method and call the Perform
method of this CommandBase
. When creating the menu items, the MenuItem_Click
is added to the list of the handlers of the Click
event. In this handler, I get the ID of the menu ('OpenFolder' or 'Execute') and retrieve the right CommandBase
object which is contained in the internal dictionary. Then, I call the 'Perform
' method to do the work.
private void MenuItem_Click(object commandBarControl,
ref bool handled, ref bool cancelDefault)
{
CommandBarControl menuItem =
(CommandBarControl)commandBarControl;
if (cmdList.ContainsKey(menuItem.Tag))
{
cmdList[menuItem.Tag].Perform();
}
}
This command is used to open your file manager in a folder corresponding to the selected item in the 'Solution Explorer' window. To do it, I call the Process.Start
with the following parameters:
Configuration appConfig =
ConfigurationManager.OpenExeConfiguration(
Assembly.GetExecutingAssembly().Location);
System.Diagnostics.Process.Start(GetFileManagerPath(appConfig),
GetParameter(appConfig) + folderPath);
where
GetFileManagerPath()
and GetParameter()
are used to retrieve (from the app.config file) respectively the full path of the file manager to use (by default 'explorer.exe' => 'Windows Explorer') and parameter (by default "/n,/e" => folder view)private string GetFilePath(object o)
{
if (o is EnvDTE.Solution)
{
EnvDTE.Solution solution = (EnvDTE.Solution)o;
_logger.DebugFormat("The selected item is the '{0}'" +
" solution.", solution.FullName);
return solution.FullName;
}
else if (o is EnvDTE.Project)
{
EnvDTE.Project project = (EnvDTE.Project)o;
_logger.DebugFormat("The selected item is the" +
" '{0}'project.", project.FullName);
if (IsWebProject(project))
{
return
project.Properties.Item("FullPath").Value.ToString() +
"\\";
}
else
{
return project.FullName;
}
}
else if (o is EnvDTE.ProjectItem)
{
EnvDTE.ProjectItem projectItem = (EnvDTE.ProjectItem)o;
// A 'ProjectItem' can be a sub project, a folder (or a file)
if (projectItem.SubProject != null)
{
return GetFilePath(projectItem.SubProject);
}
else
{
// we return the full path of the folder (or the file)
_logger.DebugFormat("The selected item is a '{0}' " +
"folder or a file : ", projectItem.get_FileNames(0));
return projectItem.get_FileNames(0);
}
}
else
{
throw new System.NullReferenceException("Full path" +
" not found for the selected item");
}
}
This command is used to launch the application corresponding to the selected project as if you double click on the ".exe" file in the 'Windows Explorer'. To do it, I call the Process.Start
with the name of the assembly as parameter:
System.Diagnostics.Process.Start(assemblyPath);
The assembly path is found by using the following code:
private string GetAssemblyPath(EnvDTE.Project project)
{
Property outputPath =
project.ConfigurationManager.ActiveConfiguration.
Properties.Item("OutputPath");
Property assemblyName = project.Properties.Item("OutputFileName");
return GetFolderPath(project.FullName) + "\\" +
(string)outputPath.Value + (string)assemblyName.Value;
}
This command is used to collapse al the nodes of the Solution Explorer window. To do it, I search (recursively) for all child nodes (of the root node) and then loop on to set their 'Expanded
' property to false
using the following code:
private void Collapse(UIHierarchyItem item, ref UIHierarchy solutionExplorer)
{
foreach (UIHierarchyItem innerItem in item.UIHierarchyItems)
{
if (innerItem.UIHierarchyItems.Count > 0)
{
// Recursive call
Collapse(innerItem, ref solutionExplorer);
// Collapse
if (innerItem.UIHierarchyItems.Expanded)
{
innerItem.UIHierarchyItems.Expanded = false;
if (innerItem.UIHierarchyItems.Expanded)
{
// Bug in VS 2005
innerItem.Select(vsUISelectionType.vsUISelectionTypeSelect);
solutionExplorer.DoDefaultAction();
}
}
}
}
}
This command is used to search help for the currently selected source code on web sites which are defined in the 'SearchEngineEurls.xml' file. For each SearchEngineUrl
you define in this file, a menu item is added to the 'Search help' menu (see image at the top of this article). As you can see below, by default, the 'Search help' menu will contain two menu items called 'Google' and 'MSDN', but you can define as many entries as you want.
<?xml version="1.0" encoding="utf-8"?>
<SearchEngineUrlsFile
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SearchEngineUrls>
<SearchEngineUrl Name="Google"
Url="www.google.fr/search?q=" />
<SearchEngineUrl Name="Msdn"
Url="http://search.microsoft.com/search/
results.aspx?view=msdn&q="/>
</SearchEngineUrls>
</SearchEngineUrlsFile>
To do it, I get the current 'Selection' using the following code :
selection = ((TextSelection)Application.DTE.ActiveWindow.Selection)
If no text is selected, I programmatically select the nearest word of the cursor. Then, I concatenate the 'search engine URL' which corresponds to the selected menu item (MSDN or Google or ...) and the selected text => this gives me the complete search URL. Finally, I just open this URL in a new tab in the Visual Studio Environment like this :
Application.DTE.ItemOperations.Navigate(
SearchEngineUrl + HttpUtility.UrlEncode(selectedText),
vsNavigateOptions.vsNavigateOptionsNewWindow);
To develop this add-in, I had to:
CommandBar
s corresponding to the 'Solution', 'Project', 'Folder',... nodes to be able to add commands => LogCommandBarsCommand
logs in the Log4Net file all the CommandBar
names (and the associated commands).LogItemPropertiesCommand
logs in the Log4Net file, the name and value of all properties of the selected item. Log4Net is a port of the excellent Log4J logging framework (see this website for more explanations). Here, I use it to log in a file all the commands selection by the user. To do it, I configure Log4Net in the app.config file like this:
<log4net>
<!-- Define level and appender to use for root logger -->
<root>
<level value="ALL" /> <!-- can be one of the following : ALL, DEBUG, INFO, WARN, ERROR, FATAL, OFF -->
<appender-ref ref="FileAppender" />
</root>
<!-- Define appender -->
<appender name="FileAppender" type="log4net.Appender.FileAppender">
<param name="File" value="C:\ExplorerAddin.log.txt" />
<param name="AppendToFile" value="true" />
<layout type="log4net.Layout.PatternLayout">
<param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" />
</layout>
</appender>
</log4net>
Then, I only have to declare a logger:
protected static readonly ILog _logger =
LogManager.GetLogger((MethodBase.GetCurrentMethod().DeclaringType));
and use it:
_logger.DebugFormat("Starting to open " +
"the following folder : '{0}'", folderPath);
出处:http://www.codeproject.com/KB/cs/Explorer.aspx