Skip to content

Repo sync for protected branch #9790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Nov 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .openpublishing.redirection.json
Original file line number Diff line number Diff line change
Expand Up @@ -1875,6 +1875,11 @@
"redirect_url": "/troubleshoot/developer/visualstudio/project-build/troubleshoot-resource-editor-errors",
"redirect_document_id": false
},
{
"source_path": "docs/vsto/configuring-a-computer-to-develop-office-solutions.md",
"redirect_url": "/visualstudio/vsto/how-to-configure-a-computer-to-develop-office-solutions",
"redirect_document_id": false
},
{
"source_path": "docs/vsto/troubleshooting-office-solution-deployment.md",
"redirect_url": "/troubleshoot/developer/visualstudio/tools-utilities/troubleshooting-office-solution-deployment",
Expand Down
18 changes: 11 additions & 7 deletions docs/ide/reference/error-list-window.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ms.author: ghogen
manager: jmartens
ms.technology: vs-ide-general
---
# Error List Window
# Error List window

[!INCLUDE [Visual Studio](~/includes/applies-to-version/vs-windows-only.md)]

Expand Down Expand Up @@ -69,26 +69,30 @@ You can copy the error list and save it to a file. Select the errors you want to

## UI Element List

Severity
**Severity**

Displays the different types of **Error List** entry (**Error**, **Message**, **Warning**, **Warning (active)**, **Warning (inactive)**.

Code
**Code**

Displays the error code.

Description
**Description**

Displays the text of the entry.

Project
**Project**

Displays the name of the current project.

File
**File**

Displays the file name.

Line
**Line**

Displays the line where the problem occurs.

**Details**

Displays a clickable icon to open the [Problem Details window](../../ide/reference/problem-details-window.md) if this entry has additional details.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/ide/reference/output-window.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ In C++, you can create custom build steps and build events whose warnings and er

If you use autoscrolling in the **Output** window and then navigate by using the mouse or arrow keys, autoscrolling stops. To resume autoscrolling, press **Ctrl**+**End**.

## Structured Diagnostics

C++ MSBuild projects might emit structured diagnostics. The level of indentation of a diagnostic in the **Output** window represents the nested structure of the information. Enable or disable indentation with the **Project** > **Properties** > **Advanced** > **Enable MSVC Structured Output** option. You can affect several projects by creating a [Directory.Build.props](/visualstudio/msbuild/customize-by-directory) file with the **UseStructuredOutput** property defined to true or false.

## See also

- [Diagnostic messages in the Output window](../../debugger/diagnostic-messages-in-the-output-window.md)
Expand Down
53 changes: 53 additions & 0 deletions docs/ide/reference/problem-details-window.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Problem Details Window
description: Learn about the Problem Details window and how to use it to navigate structured diagnostics.
ms.date: 10/24/2023
ms.topic: reference
helpviewer_keywords:
- Problem Details window
- build errors
- Error List window../
author: tartanllama
ms.author: sybrand
manager: mluparu
ms.technology: vs-ide-general
---

# Problem Details window

[!INCLUDE [Visual Studio](~/includes/applies-to-version/vs-windows-only.md)]

The **Problem Details** window shows structured diagnostics issued by the MSVC compiler or [code analysis for C/C++](/cpp/code-quality/code-analysis-for-c-cpp-overview).

Select entries in the [**Error List** window](error-list-window.md) that show an icon in the **Details** column to open the **Problem Details** window. The **Problem Details** window shows the structured diagnostics for the selected entry.

:::image type="complex" source="media/error-list-details-column.png" alt-text="Screenshot of the Visual Studio Error List with one entry that has an icon in its details column.":::
Screenshot of the Visual Studio Error List. It shows a table with a single row. The row represents a compiler error and contains the error code C2665, the description "pet: no overloaded function could convert all the argument types", and an icon of a square with the corner magnified in the column named Details. This icon is highlighted.
:::image-end:::

Two scenarios produce these diagnostics:

- C++ compilations using [**MSBuild**](/cpp/build/creating-and-managing-visual-cpp-projects) and the MSVC compiler may emit structured diagnostics.
- Code analysis warnings that support [**Key Event**](https://devblogs.microsoft.com/cppblog/microsoft-cpp-code-analysis-warnings-with-key-events) data emit structured diagnostics.

Open the **Problem Details** window by doing one of the following:

- While the entry is highlighted, double-click it or press **Enter**. Disable this behavior with **Tools** > **Options** > **Text Editor** > **C/C++** > **Advanced** > **Show Problem Details on Double Click**.
- Select the icon in the **Details** column.
- Open the shortcut menu for the entry and select the **Open Problem Details** option.

By default, the **Problem Details** window opens in the same location as the **Error List** window. Change where the **Problem Details** window opens by moving it to the desired position.

The **Problem Details** window displays structured information that may be nested. When the window opens, all entries that have nested children begin collapsed.

:::image type="complex" source="media/problem-details-collapsed.png" alt-text="Screenshot of the Visual Studio Problem Details window with all children collapsed.":::
Screenshot of the Visual Studio Problem Details window. There is a header showing the same error code and description as the Error List entry from before. There is also a selectable link with the text cppcon-diag.cpp (Line 23). Below this header there are entries explaining that the potential overloads are void pet(cat), void pet(dog), or void pet(_T0). The final entry states "while trying to match the argument list (lizard)." To the right of each line is grey text showing the file and line numbers for each entry. All of them belong to cppcon-diag.cpp and the line numbers are 7, 6, 18, and 23, respectively. To the left of the first three entries are small hollow arrows pointing right that signify that these entries can be expanded, but are currently not.
:::image-end:::

Expand an entry to view its children by either selecting the arrow at the left-hand side of an entry, or by pressing **Right** with the entry highlighted.

:::image type="complex" source="media/problem-details-expanded.png" alt-text="Screenshot of the Visual Studio Problem Details window with some children expanded.":::
Screenshot of the Visual Studio Problem Details window. The contents are mostly the same as the previous screenshot, however some of the entries are expanded so their child entries are visible. The first entry is expanded. There is a nested entry with the text "void pet(cat) cannot convert argument 1 from lizard to cat." This entry is indented and can be expanded. The second line from before is expanded, revealing an unexpanded entry reading "void pet(dog) cannot convert argument 1 from lizard to dog." The third entry is expanded, revealing an entry reading "the associated constraints are not satisfied." This entry has an expanded child reading "the concept pettable lizard evaluated to false." This entry has two children. The first is unexpanded and reads "the concept has_member_pet lizard evaluated to false." The second is expanded and reads "the concept has_default_pet lizard evaluated to false." This second child has two children, neither of which is expandable. They read "is_pettable is not a member of lizard" and "see declaration of lizard."
:::image-end:::

Enable or disable structured diagnostics with the **Project** > **Properties** > **Advanced** > **Enable MSVC Structured Output** option. You can affect several projects by creating a [Directory.Build.props](/visualstudio/msbuild/customize-by-directory) file with the **UseStructuredOutput** property defined to true or false.
2 changes: 2 additions & 0 deletions docs/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -991,6 +991,8 @@
href: ide/reference/xaml-designer.md
- name: Output window
href: ide/reference/output-window.md
- name: Problem Details window
href: ide/reference/problem-details-window.md
- name: Project Designer & project properties
items:
- name: Project Designer reference
Expand Down
51 changes: 0 additions & 51 deletions docs/vsto/configuring-a-computer-to-develop-office-solutions.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ ms.technology: office-development
Not all applications can use every project type. For example, document-level projects are available only for Microsoft Office Word and Microsoft Office Excel. Similarly, some features are available only for certain types of projects or applications. For example, the actions pane is available only in document-level projects, and Ribbon extensions are available only for some applications. For more information about the different project types, see [Office solutions development overview (VSTO)](../vsto/office-solutions-development-overview-vsto.md).

> [!NOTE]
> Office project templates are available only in some editions of Visual Studio. For more information, see [Configure a computer to develop Office solutions](../vsto/configuring-a-computer-to-develop-office-solutions.md).
> Office project templates are available only in some editions of Visual Studio. For more information, see [Configure a computer to develop Office solutions](../vsto/how-to-configure-a-computer-to-develop-office-solutions.md).

## Project types available for different Microsoft Office applications
The following table shows the applications that you can use with each project type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ ms.technology: office-development

Describes which applications and projects are required to use Office development features such as Ribbon extensibility, custom task panes, actions panes, and form regions.

- [Configure a computer to develop Office solutions](../vsto/configuring-a-computer-to-develop-office-solutions.md)
- [Configure a computer to develop Office solutions](../vsto/how-to-configure-a-computer-to-develop-office-solutions.md)

Provides information and steps for installing the Office development tools, the runtime that enables Office solutions to run on end-user computers, and the Office primary interop assemblies.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,48 @@ ms.technology: office-development
# Configure a computer to develop Office solutions

[!INCLUDE [Visual Studio](~/includes/applies-to-version/vs-windows-only.md)]
To configure a development computer so that you can use the Microsoft Office developer tools in Visual Studio, follow the instructions in this topic. You must have administrative privileges on the development computer to perform these steps.

### To configure the development computer
To configure a development computer so that you can use the Microsoft Office developer tools in Visual Studio, follow the instructions in this topic. You must have administrative privileges on the development computer to perform these steps.

1. Install a version of Visual Studio that includes the Office developer tools. The Office developer tools are installed by default. If you customize the Visual Studio installation by selecting which features to install, make sure that **Microsoft Office Developer Tools** is selected during setup. For more information about the versions of Visual Studio that include the Office developer tools, see [Configure a computer to develop Office solutions](../vsto/configuring-a-computer-to-develop-office-solutions.md).
## Requirements

2. Install a version of Office that is supported by the Office developer tools in Visual Studio. For more information, see [Configure a computer to develop Office solutions](../vsto/configuring-a-computer-to-develop-office-solutions.md).
The following versions of Visual Studio, the .NET Framework, and Microsoft Office are supported.

Make sure that you also install the PIAs for the version of Office that you install. The PIAs are installed with Office by default. If you modify Office setup, make sure that the **.NET Programmability Support** feature is selected for the applications you want to target.
|Software|Supported versions|
|--------------|------------------------|
|Visual Studio 2017| Any edition with the **Office/SharePoint development** workload.|
|.NET Framework|- The .NET Framework 4 or later.|
|Microsoft Office|<ul><li>Any suite edition of Office including Microsoft 365 apps for enterprise.</li><li>Any of the following standalone applications:<br /><br /> <ul><li>Excel</li><li>InfoPath (Office 2013 and Office 2010 only)</li><li>Outlook</li><li>PowerPoint</li><li>Project</li><li>Visio</li><li>Word</li></ul></li></ul><br /> Visual Basic for Applications (VBA) must be installed as part of Office. **Important:** Click-to-Run versions of Office 2010 applications are not supported.|

3. If you have an English version of Visual Studio but use non-English settings for Windows, you can install the Visual Studio Tools for Office runtime language pack to see Visual Studio Tools for Office runtime messages in the same language as Windows. Non-English versions of Visual Studio automatically install the language pack.
## Configure the development computer

1. Install a version of Visual Studio that includes the Office developer tools. The Office developer tools are installed by default. If you customize the Visual Studio installation by selecting which features to install, make sure that **Microsoft Office Developer Tools** is selected during setup.

2. Install a version of Office that is supported by the Office developer tools in Visual Studio.

Make sure that you also install the PIAs for the version of Office that you install. The PIAs are installed with Office by default. If you modify Office setup, make sure that the **.NET Programmability Support** feature is selected for the applications you want to target.

3. If you have an English version of Visual Studio but use non-English settings for Windows, you can install the [Visual Studio Tools for Office runtime language pack](https://www.microsoft.com/en-us/download/details.aspx?id=105672) to see Visual Studio Tools for Office runtime messages in the same language as Windows. Non-English versions of Visual Studio automatically install the language pack. The language pack is available from the [Microsoft download center](https://www.microsoft.com/en-us/download/).

## If project templates don't appear or they don't work in Visual Studio

If you install a supported version of Visual Studio, the .NET Framework, and Microsoft Office, but Office project templates either don't appear in the Visual Studio **New Project** dialog box, or you receive an error when you try to use one, check the following:

- Ensure that you have the Microsoft Office developer tools installed on your computer.

Office developer tools are an optional component of Visual Studio, but they are installed automatically along with Visual Studio. If you customize the Visual Studio installation by specifying which features to install, make sure that you choose **Microsoft Office Developer Tools** during setup to install the tools.

To make sure that these tools are installed, start the Visual Studio setup program, and choose the **Modify** button. Select the **Microsoft Office Developer Tools** check box, and then choose the **Update** button.

- Make sure that you're not running a version of Office that was delivered by Click-to-Run. See [How to: Verify whether Outlook is a Click-to-Run application on a computer](/previous-versions/office/developer/office-2010/ff864733(v=office.14)).

- Ensure that you're running only one version of Microsoft Office.

If you continue to experience problems, see [Additional support for errors in Office solutions](../vsto/additional-support-for-errors-in-office-solutions.md).

## See also

- [Get started &#40;Office development in Visual Studio&#41;](../vsto/getting-started-office-development-in-visual-studio.md)
- [How to: Install the Visual Studio Tools for Office runtime redistributable](../vsto/how-to-install-the-visual-studio-tools-for-office-runtime-redistributable.md)
- [How to: Install Office primary interop assemblies](../vsto/how-to-install-office-primary-interop-assemblies.md)
- [Features available by Office application and project type](../vsto/features-available-by-office-application-and-project-type.md)
Loading