IVisualizerObjectProvider Interface (Microsoft.VisualStudio.DebuggerVisualizers)

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

IVisualizerObjectProvider Interface

Namespace: Microsoft.VisualStudio.DebuggerVisualizers
Assembly: Microsoft.VisualStudio.DebuggerVisualizers (in microsoft.visualstudio.debuggervisualizers.dll)

Syntax

Visual Basic (Declaration)

Public Interface IVisualizerObjectProvider

Visual Basic (Usage)

Dim instance As IVisualizerObjectProvider

public interface IVisualizerObjectProvider

C++

public interface class IVisualizerObjectProvider

public interface IVisualizerObjectProvider

JScript

public interface IVisualizerObjectProvider

Remarks

A visualizer is a small program the Visual Studio debugger uses to display, that is, visualize, an object of a specific data type in meaningful fashion. To visualize an object, a visualizer uses code that runs in the debugger process (the debugger side) and code in the process being debugged (the debuggee side).

The debugger side and debuggee side communicate with each other using VisualizerObjectSource and IVisualizerObjectProvider.

The debuggee side uses VisualizerObjectSource to specify a VisualizerObjectSource object for the debugger side. The debugger side requests and receives this information by calling methods on the IVisualizerObjectProvider interface.

A visualizer can edit, as well as display, data. If your visualizer supports editing data, you must replace the data entirely by calling ReplaceData or ReplaceObject or transfer data back to the debuggee using TransferData or TransferObject. If you want to save data back, you also need to create your own object source.

Remarks

A visualizer is a small program the Visual Studio debugger uses to display (visualize) an object of a specific data type in meaningful manner. To visualize an object, a visualizer uses code that runs in the debugger process (the debugger side) and code in the process being debugged (the debuggee side).

The debugger side and debuggee side communicate with each other by using VisualizerObjectSource and IVisualizerObjectProvider.

A visualizer can edit, as well as display, data. If your visualizer supports editing data, you must replace the data entirely by calling ReplaceData or ReplaceObject or transfer data back to the debuggee using TransferData or TransferObject. If you want to save data back, you also need to create your own object source.

Example

public class DebuggerSide : DialogDebuggerVisualizer
{
   override protected void Show(IDialogVisualizerService windowService, IVisualizerObjectProvider objectProvider)
   {
      MessageBox.Show(objectProvider.GetObject().ToString());
   }
// . . . Other methods omitted for clarity.
}

Example

public class DebuggerSide : DialogDebuggerVisualizer
{
   override protected void Show(IDialogVisualizerService windowService, IVisualizerObjectProvider objectProvider)
   {
      MessageBox.Show(objectProvider.GetObject().ToString());
   }
// . . . Other methods omitted for clarity.
}

Reference

IVisualizerObjectProvider Members
Microsoft.VisualStudio.DebuggerVisualizers Namespace

Concepts

Visualizer Architecture