VisualizerDevelopmentHost Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.DebuggerVisualizers

Assembly:: Microsoft.VisualStudio.DebuggerVisualizers.dll

Package:: Microsoft.VisualStudio.DebuggerVisualizers v17.6.1032901

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Host class for testing during development of the Managed custom visualizer.

public ref class VisualizerDevelopmentHost

[Windows::Foundation::Metadata::WebHostHidden]
class VisualizerDevelopmentHost

public class VisualizerDevelopmentHost

type VisualizerDevelopmentHost = class

Public Class VisualizerDevelopmentHost

Inheritance: Object
VisualizerDevelopmentHost

Examples

The following example code creates a visualizer development host and calls the host to show the visualizer. MyDataObject is the data object you want to show in the visualizer. MyVisualizer is the visualizer itself.

public static void TestShowVisualizer(object MyDataObject)
{
    VisualizerDevelopmentHost visualizerHost = new VisualizerDevelopmentHost(MyDataObject, typeof(MyVisualizer);
    visualizerHost.ShowVisualizer();
}

The calling code looks as follows:

String myString = "Hello, World!";  // Create an object to visualize  
Visualizer1.TestShowVisualizer(myString);  // Call the host to visualize it

Remarks

You can use this class to create a harness for testing and debugging a debugger visualizer. Custom Visualizers are small custom applications called from the Visual Studio debugger to display data objects in a manner appropriate to their data type. This class enables you to run a visualizer for testing and debugging purposes without installing the visualizer into Visual Studio. Using the harness makes debugging a visualizer much easier.

Constructors

VisualizerDevelopmentHost(Object, Type, Type, Boolean)	Constructor to create a visualizer development hostby using a data object that you want to test the visualizer on and a type that identifies the visualizer class.
VisualizerDevelopmentHost(Object, Type, Type)	Constructor to create a visualizer development hostby using a data object that you want to test the visualizer on and a type that identifies the visualizer class.
VisualizerDevelopmentHost(Object, Type)	Constructor to create a visualizer development hostby using a data object that you want to test the visualizer on and a type that identifies the visualizer class.

Properties

DebuggeeObject

Methods

ShowVisualizer()	Calls the visualizer development host to show the visualizer, without parameters.
ShowVisualizer(Control)	Calls the visualizer development host to show the visualizer, passing a control that you want the visualizer parented to.
ShowVisualizer(IWin32Window)	Calls the visualizer development host to show the visualizer, passing a window that you want the visualizer parented to.

Applies to

Share via