Click here to Skip to main content
Click here to Skip to main content

A Generic List and Dictionary Debugger Visualizer for VS.NET

, 27 Aug 2011 CPOL
Rate this:
Please Sign up or sign in to vote.
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:

// 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:

// 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)

Share

About the Author

Daniel Carvalho Liedke
Software Developer (Senior)
Brazil Brazil
I started development 22 years from now, since MSX basic. Started Windows programming with VB 2.0 and Web programming with ASP 3.0. Now I build 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 and windows presentation foundation. Besides programming I love surfing.

Comments and Discussions

 
GeneralRe: Error message PinmemberDaniel Carvalho Liedke6-Jan-11 2:38 
Generalx64 Runtime Support PinmemberCitizenDC30-Dec-10 23:43 
GeneralRe: x64 Runtime Support PinmemberDaniel Carvalho Liedke6-Jan-11 2:40 
GeneralVisualizer not showing up Pinmemberooglee10-Nov-10 3:39 
GeneralRe: Visualizer not showing up PinmemberDaniel Carvalho Liedke10-Nov-10 4:46 
GeneralRe: Visualizer not showing up Pinmemberooglee10-Nov-10 19:38 
GeneralRe: Visualizer not showing up PinmemberDaniel Carvalho Liedke6-Jan-11 2:41 
GeneralFunny, I had the same issue PinmemberNorman-Timo10-Jul-10 16:14 
It is funny, I developed a dictionary visualizer too, and after finishing it, I found this article.
 
It would be great, if you can modify it, so that a user can edit the visualized data too. If you want to have a example for it, you could visit my visualizer implementation (german language, but code is international C# Smile | :)
Timo Rehl Blog - Dictionary Visualizer[Timo Rehl Blog - Dictionary Visualizer]
 
I limited it to dictionaries, but I have implemented a way to visualize different dictionary types with using IDictionary. And I have a solution implemented which makes it possible to pass edited values back to the original object.
 
Greetings from Germany
Timo
GeneralMy vote of 4 PinmemberNorman-Timo10-Jul-10 16:06 
GeneralRe: My vote of 4 PinmemberDaniel Carvalho Liedke6-Jan-11 2:41 
GeneralVisual Studio 2010 PinmemberDarvon4u2-Jul-10 4:19 
GeneralRe: Visual Studio 2010 PinmemberDaniel Carvalho Liedke3-Jul-10 5:41 
GeneralRe: Visual Studio 2010 PinmemberDaniel Carvalho Liedke3-Jul-10 8:28 
GeneralReflection Exception "Parameter count mismatch" PinmemberIvan Mitev16-Mar-10 0:06 
GeneralRe: Reflection Exception "Parameter count mismatch" PinmemberDaniel Carvalho Liedke16-Mar-10 14:23 
GeneralNot working for me PinmemberMember 25929352-Jan-09 11:50 
GeneralRe: Not working for me PinmemberDaniel Carvalho Liedke2-Jan-09 16:47 
GeneralRe: Not working for me Pinmemberslowram17-Sep-10 14:50 
GeneralRe: Not working for me PinmemberDaniel Carvalho Liedke18-Sep-10 2:50 
QuestionWhat about custom lists? PinmemberQwertie18-Jul-08 13:09 
AnswerRe: What about custom lists? PinmemberDaniel Carvalho Liedke19-Jul-08 5:42 
GeneralRe: What about custom lists? PinmemberQwertie19-Jul-08 6:33 
GeneralRe: What about custom lists? PinmemberDaniel Carvalho Liedke19-Jul-08 17:32 
GeneralGreat! Pinmembermerlin98116-Apr-08 4:57 
GeneralRe: Great! PinmemberDaniel Carvalho Liedke16-Apr-08 7:02 

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

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

| Advertise | Privacy | Terms of Use | Mobile
Web04 | 2.8.1411023.1 | Last Updated 27 Aug 2011
Article Copyright 2008 by Daniel Carvalho Liedke
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid