Skip to content

Commit 67c12bb

Browse files
Merge pull request #14039 from Mikejo5000/mikejo-br24
Clarify notes regarding debugger visualizer extension development
2 parents f14ba50 + 1f23ac5 commit 67c12bb

5 files changed

+14
-11
lines changed

docs/debugger/create-custom-visualizers-of-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ ms.subservice: debug-diagnostics
2323
# Custom data visualizers for the Visual Studio debugger (.NET)
2424

2525
> [!IMPORTANT]
26-
> Starting with Visual Studio 2022 version 17.9, visualizers can now be written in .NET 6.0+ that run out-of-process using the new VisualStudio.Extensibility model. We encourage visualizer authors to reference the new documentation at [Create Visual Studio debugger visualizers](../extensibility/visualstudio.extensibility/debugger-visualizer/debugger-visualizers.md) unless they want to support older versions of Visual Studio or want to ship their custom visualizers as part of a library DLL.
26+
> Starting with Visual Studio 2022 version 17.9, visualizers can now be written in .NET 6.0+ that run out-of-process using the new VisualStudio.Extensibility model. For extensions created using the new model, see the documentation at [Create Visual Studio debugger visualizers](../extensibility/visualstudio.extensibility/debugger-visualizer/debugger-visualizers.md) instead. If you need to support older versions of Visual Studio or want to ship your custom visualizers as part of a library DLL, then use the information in this article, which applies only to the older model of extension development (VSSDK).
2727
2828
A *visualizer* is part of the Visual Studio debugger user interface that displays a variable or object in a manner appropriate to its data type. For example, a [bitmap visualizer](/previous-versions/visualstudio/visual-studio-2015/debugger/image-watch/image-watch) interprets a bitmap structure and displays the graphic it represents. Some visualizers let you modify as well as view the data. In the debugger, a visualizer is represented by a magnifying glass icon ![VisualizerIcon](../debugger/media/dbg-tips-visualizer-icon.png "Visualizer icon"). You can select the icon in a **DataTip**, debugger **Watch** window, or **QuickWatch** dialog box, and then select the appropriate visualizer for the corresponding object.
2929

docs/debugger/how-to-install-a-visualizer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Install a Visualizer for use in debugging
33
description: Install a newly created visualizer to make it available to use for debugging your projects and solution in Visual Studio.
4-
ms.date: 07/02/2021
4+
ms.date: 06/26/2025
55
ms.topic: how-to
66
dev_langs:
77
- CSharp
@@ -20,7 +20,7 @@ ms.subservice: debug-diagnostics
2020
# Install a Visualizer
2121

2222
> [!IMPORTANT]
23-
> Starting with Visual Studio 2022 version 17.9, visualizers can now be written in .NET 6.0+ that run out-of-process using the new VisualStudio.Extensibility model. We encourage visualizer authors to reference the new documentation at [Create Visual Studio debugger visualizers](../extensibility/visualstudio.extensibility/debugger-visualizer/debugger-visualizers.md) unless they want to support older versions of Visual Studio or want to ship their custom visualizers as part of a library DLL.
23+
> Starting with Visual Studio 2022 version 17.9, visualizers can now be written in .NET 6.0+ that run out-of-process using the new VisualStudio.Extensibility model. For extensions created using the new model, see the documentation at [Create Visual Studio debugger visualizers](../extensibility/visualstudio.extensibility/debugger-visualizer/debugger-visualizers.md) instead. If you need to support older versions of Visual Studio or want to ship your custom visualizers as part of a library DLL, then use the information in this article, which applies only to the older model of extension development (VSSDK).
2424
2525
After you have created a visualizer, you must install the visualizer so that it will be available in Visual Studio. Installing a visualizer is a simple process.
2626

docs/debugger/how-to-test-and-debug-a-visualizer.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Test and Debug a Visualizer
33
description: Test and debug a visualizer by running it from a test driver (visualizer development host) or by installing in Visual Studio and calling it from a debugger window.
4-
ms.date: 07/02/2021
4+
ms.date: 06/26/2025
55
ms.topic: how-to
66
dev_langs:
77
- CSharp
@@ -19,9 +19,12 @@ ms.subservice: debug-diagnostics
1919
---
2020
# Test and Debug a Visualizer
2121

22-
Once you have written a visualizer, you need to debug and test it.
22+
> [!IMPORTANT]
23+
> Starting with Visual Studio 2022 version 17.9, visualizers can now be written in .NET 6.0+ that run out-of-process using the new VisualStudio.Extensibility model. For extensions created using the new model, see the documentation at [Create Visual Studio debugger visualizers](../extensibility/visualstudio.extensibility/debugger-visualizer/debugger-visualizers.md) instead. If you need to support older versions of Visual Studio or want to ship your custom visualizers as part of a library DLL, then use the information in this article, which applies only to the older model of extension development (VSSDK).
2324
24-
One way to test a visualizer is by installing it in Visual Studio and calling it from a debugger window. (See [How to: Install a Visualizer](../debugger/how-to-install-a-visualizer.md).) If you do that, you will need to use a second instance of Visual Studio to attach and debug the visualizer, which is running in the first instance of the debugger.
25+
Once you write a visualizer, debug and test it.
26+
27+
One way to test a visualizer is by installing it in Visual Studio and calling it from a debugger window. (See [How to: Install a Visualizer](../debugger/how-to-install-a-visualizer.md).) If you do that, then use a second instance of Visual Studio to attach and debug the visualizer, which is running in the first instance of the debugger.
2528

2629
An easier way to debug a visualizer is to run the visualizer from a test driver. The visualizer APIs make it easy to create such a driver, which is called the *visualizer development host*.
2730

@@ -42,7 +45,7 @@ An easier way to debug a visualizer is to run the visualizer from a test driver.
4245

4346
The parameters used to construct the host are the data object that will be shown in the visualizer (`objectToVisualize`) and the type of the debugger side class.
4447

45-
2. Add the following statement to call `TestShowVisualizer`. If you created your visualizer in a class library, you need to create an executable to call the class library and place this statement in your executable:
48+
2. To call `TestShowVisualizer`, add the following statement. If you created your visualizer in a class library, you need to create an executable to call the class library and place this statement in your executable:
4649

4750
```csharp
4851
DebuggerSide.TestShowVisualizer(myString);

docs/debugger/walkthrough-writing-a-visualizer-in-csharp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Write a visualizer in C#"
33
description: Follow a walkthrough to create a simple visualizer in C#. It shows the steps required both with and without using the Visualizer item template.
4-
ms.date: "10/24/2023"
4+
ms.date: "6/26/2025"
55
ms.topic: "conceptual"
66
dev_langs:
77
- "CSharp"
@@ -16,7 +16,7 @@ ms.subservice: debug-diagnostics
1616
# Walkthrough: Writing a Visualizer in C\#
1717

1818
> [!IMPORTANT]
19-
> Starting with Visual Studio 2022 version 17.9, visualizers can now be written in .NET 6.0+ that run out-of-process using the new VisualStudio.Extensibility model. We encourage visualizer authors to reference the new documentation at [Create Visual Studio debugger visualizers](../extensibility/visualstudio.extensibility/debugger-visualizer/debugger-visualizers.md) unless they want to support older versions of Visual Studio or want to ship their custom visualizers as part of a library DLL.
19+
> Starting with Visual Studio 2022 version 17.9, visualizers can now be written in .NET 6.0+ that run out-of-process using the new VisualStudio.Extensibility model. For extensions created using the new model, see the documentation at [Create Visual Studio debugger visualizers](../extensibility/visualstudio.extensibility/debugger-visualizer/debugger-visualizers.md) instead. If you need to support older versions of Visual Studio or want to ship your custom visualizers as part of a library DLL, then use the information in this article, which applies only to the older model of extension development (VSSDK).
2020
2121
This walkthrough shows how to write a simple visualizer by using C#. The visualizer you create in this walkthrough displays the contents of a string using a Windows Form. This simple string visualizer isn't especially useful in itself, but it shows the basic steps that you must follow to create more useful visualizers for other data types.
2222

docs/debugger/walkthrough-writing-a-visualizer-in-visual-basic.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Write a visualizer in Visual Basic"
33
description: Follow a walkthrough to create a simple visualizer in Visual Basic. You also create a test harness to test your visualizer.
4-
ms.date: "05/27/2020"
4+
ms.date: "06/26/2025"
55
ms.topic: "conceptual"
66
dev_langs:
77
- "CSharp"
@@ -19,7 +19,7 @@ ms.subservice: debug-diagnostics
1919
# Walkthrough: Writing a Visualizer in Visual Basic
2020

2121
> [!IMPORTANT]
22-
> Starting with Visual Studio 2022 version 17.9, visualizers can now be written in .NET 6.0+ that run out-of-process using the new VisualStudio.Extensibility model. We encourage visualizer authors to reference the new documentation at [Create Visual Studio debugger visualizers](../extensibility/visualstudio.extensibility/debugger-visualizer/debugger-visualizers.md) unless they want to support older versions of Visual Studio or want to ship their custom visualizers as part of a library DLL.
22+
> Starting with Visual Studio 2022 version 17.9, visualizers can now be written in .NET 6.0+ that run out-of-process using the new VisualStudio.Extensibility model. For extensions created using the new model, see the documentation at [Create Visual Studio debugger visualizers](../extensibility/visualstudio.extensibility/debugger-visualizer/debugger-visualizers.md) instead. If you need to support older versions of Visual Studio or want to ship your custom visualizers as part of a library DLL, then use the information in this article, which applies only to the older model of extension development (VSSDK).
2323
2424
This walkthrough shows how to write a simple visualizer by using Visual Basic. The visualizer you'll create in this walkthrough displays the contents of a string using a Windows Forms message box. This simple string visualizer is a basic example to show how you can create visualizers for other data types more applicable to your projects.
2525

0 commit comments

Comments
 (0)