Click here to Skip to main content
15,867,832 members
Articles / Programming Languages / C#

A Generic List and Dictionary Debugger Visualizer for VS.NET

Rate me:
Please Sign up or sign in to vote.
4.91/5 (36 votes)
27 Aug 2011CPOL2 min read 159.5K   3.8K   103   52
A cool List and Dictionary debugger visualizer for VS.NET 2005, 2008 and 2010
ListVisualizer2008

Introduction

This is a simple List<T> and Dictionary<T,T> debugger visualizer for Visual Studio .NET 2005, 2008 and 2010. The only requirement for it to work is that the classes inside the lists or dictionaries should be marked as [Serializable].

Background

I used the nice article Create a Debugger Visualizer in 10 Lines of Code as a starting point. I recommend this article for further details on how to implement a custom debugger visualizer.

Using the Code

For installing the visualizer only, download the List Visualizer 2005, 2008 or 2010 according to the Visual Studio .NET version you would like to use. Run install_vs2005.cmd, install_vs2008.cmd or install_vs2010.cmd in a Visual Studio Command Prompt window. For Windows Vista, make sure to run the command prompt as Administrator.

Note that the Visual Studio path in the cmd files uses the default installation path, c:\Program Files\Microsoft Visual Studio 8 (for VS.NET 2005), c:\Program Files\Microsoft Visual Studio 9.0 (for VS.NET 2008) and c:\Program Files\Microsoft Visual Studio 10.0 (for VS.NET 2010). If you installed it in a different location, you might need to change the bat file and the post build events in the projects.

The default path for visualizers in 2005 is C:\Program Files\Microsoft Visual Studio 8\Common7\Packages\Debugger\Visualizers, in 2008 is c:\Program Files\Microsoft Visual Studio 9.0\Common7\Packages\Debugger\Visualizers and in 2010 is c:\Program Files\Microsoft Visual Studio 10.0\Common7\Packages\Debugger\Visualizers. Just copy the assemblies there for a manual installation.

The source code contains both VS.NET 2005 (ListVisualizer.sln) and VS.NET 2008 solutions (ListVisualizer2008.sln). The post build event automatically deploys the visualizer for testing. Note that ListVisualizer2008.sln also contains the VS.NET 2005 projects that may be removed in case 2005 is not installed.

The source code for VS.NET 2010 can be found in a different zip file.

Points of Interest

I had to cast the generic types to non-generic interfaces to work with the variable that is being debugged:

C#
// Get the list
IList list = (IList)objectProvider.GetObject();
 
// Get the dictionary
IDictionary dict = (IDictionary)objectProvider.GetObject();

After that, I used Reflection to retrieve object properties and fields to be displayed in the grid view:

C#
// Retrieve the properties
PropertyInfo[] properties = singleObj.GetType().GetProperties();
foreach (PropertyInfo property in properties)
{
    dgvList.Columns.Add(property.Name, property.Name);
    columns.Add(property.Name, "P");
}
// Retrieve the fields
FieldInfo[] fields = singleObj.GetType().GetFields();
foreach (FieldInfo field in fields)
{
    dgvList.Columns.Add(field.Name, field.Name);
    columns.Add(field.Name, "F");
}

The solution contains six projects - the Dictionary Visualizer for 2005 and 2008, the List Visualizer for 2005 and 2008, the testing project ListVisualizerTest, and the class library that does most of the work, VisualizerLib. ListVisualizerTest is used to debug different types of Lists and Dictionaries and is also used to create the UI for the visualizers.

History

  • 15th April, 2008: Initial post
  • 3rd July, 2010: Article updated - created the new visualizer for Visual Studio 2010
  • 26th August, 2011: Article updated - visualizer for all Visual Studio versions can now be resized

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Architect
Brazil Brazil
I started development 37 years from now, since MSX basic. Started Windows programming with VB 2.0 and Web programming with ASP 3.0. Then I built Windows Forms, Web Applications, NT services and WPF applications using Microsoft.NET. I am MCP in Visual Basic 6.0, MCAD and MCSD.NET in Framework 1.1, MCPD Web in Framework 2.0, MCTS in .NET 3.5 workflow, MCTS in .NET 3.5 communication foundation, windows presentation foundation and MVC applications. Built MVC Web Application and WCF services using Micro Services architecture proposed by me. Working with AI projects to improve the business performance and customer experience. Besides programming I love running, swimming, reading and movies.

Comments and Discussions

 
AnswerRe: Silverlight Support? Pin
Daniel Liedke25-Jan-11 7:53
professionalDaniel Liedke25-Jan-11 7:53 
GeneralError message Pin
awstam6-Jan-11 0:15
awstam6-Jan-11 0:15 
GeneralRe: Error message Pin
Daniel Liedke6-Jan-11 1:38
professionalDaniel Liedke6-Jan-11 1:38 
Generalx64 Runtime Support Pin
CitizenDC30-Dec-10 22:43
CitizenDC30-Dec-10 22:43 
GeneralRe: x64 Runtime Support Pin
Daniel Liedke6-Jan-11 1:40
professionalDaniel Liedke6-Jan-11 1:40 
GeneralVisualizer not showing up Pin
ooglee10-Nov-10 2:39
ooglee10-Nov-10 2:39 
GeneralRe: Visualizer not showing up Pin
Daniel Liedke10-Nov-10 3:46
professionalDaniel Liedke10-Nov-10 3:46 
GeneralRe: Visualizer not showing up Pin
ooglee10-Nov-10 18:38
ooglee10-Nov-10 18:38 
Yes, I had copied the three files into that exact directory before posting. It does not show up Frown | :(
GeneralRe: Visualizer not showing up Pin
Daniel Liedke6-Jan-11 1:41
professionalDaniel Liedke6-Jan-11 1:41 
GeneralFunny, I had the same issue Pin
Norman-Timo10-Jul-10 15:14
Norman-Timo10-Jul-10 15:14 
GeneralMy vote of 4 Pin
Norman-Timo10-Jul-10 15:06
Norman-Timo10-Jul-10 15:06 
GeneralRe: My vote of 4 Pin
Daniel Liedke6-Jan-11 1:41
professionalDaniel Liedke6-Jan-11 1:41 
GeneralVisual Studio 2010 Pin
Darvon4u2-Jul-10 3:19
Darvon4u2-Jul-10 3:19 
GeneralRe: Visual Studio 2010 Pin
Daniel Liedke3-Jul-10 4:41
professionalDaniel Liedke3-Jul-10 4:41 
GeneralRe: Visual Studio 2010 Pin
Daniel Liedke3-Jul-10 7:28
professionalDaniel Liedke3-Jul-10 7:28 
GeneralReflection Exception "Parameter count mismatch" Pin
Ivan Mitev15-Mar-10 23:06
Ivan Mitev15-Mar-10 23:06 
GeneralRe: Reflection Exception "Parameter count mismatch" Pin
Daniel Liedke16-Mar-10 13:23
professionalDaniel Liedke16-Mar-10 13:23 
GeneralNot working for me Pin
timojojones2-Jan-09 10:50
timojojones2-Jan-09 10:50 
GeneralRe: Not working for me Pin
Daniel Liedke2-Jan-09 15:47
professionalDaniel Liedke2-Jan-09 15:47 
GeneralRe: Not working for me Pin
slowram17-Sep-10 13:50
slowram17-Sep-10 13:50 
GeneralRe: Not working for me Pin
Daniel Liedke18-Sep-10 1:50
professionalDaniel Liedke18-Sep-10 1:50 
QuestionWhat about custom lists? Pin
Qwertie18-Jul-08 12:09
Qwertie18-Jul-08 12:09 
AnswerRe: What about custom lists? Pin
Daniel Liedke19-Jul-08 4:42
professionalDaniel Liedke19-Jul-08 4:42 
GeneralRe: What about custom lists? Pin
Qwertie19-Jul-08 5:33
Qwertie19-Jul-08 5:33 
GeneralRe: What about custom lists? Pin
Daniel Liedke19-Jul-08 16:32
professionalDaniel Liedke19-Jul-08 16:32 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.