Compartir vía

Escritura en la ventana de salida de Visual Studio

  • Artículo

La ventana Salida del IDE de Visual Studio es una ventana de herramientas que se puede usar para entregar el estado, el diagnóstico o el registro, o cualquier otro texto informativo al usuario. A diferencia de los mensajes de usuario, que pueden mostrar un cuadro de mensaje, los mensajes escritos en la ventana Salida solo se muestran si el usuario tiene la ventana Salida visible en el IDE y el canal está seleccionado en la lista desplegable Mostrar salida de . La ventana Salida se vuelve visible cuando el usuario selecciona el menú Ver > salida en el menú principal.

Introducción

Importante

Las API de la ventana salida de extensibilidad de VisualStudio.Extensibility están actualmente en versión preliminar y están sujetas a cambios. Es posible que cualquier extensión que aproveche estas API no funcione en versiones futuras de Visual Studio y tendrá que actualizarse cuando se publique una versión más reciente de las API.

Para empezar, siga la sección Crear el proyecto en la sección Introducción.

Trabajar con la ventana Salida

Esta guía está diseñada para cubrir las cosas más comunes que puede hacer con la ventana Salida:

Obtención de un canal de ventana de salida

Para escribir en la ventana Salida, necesita un canal de ventana de salida, que se puede crear llamando a VisualStudioExtensibility.Views().Output.CreateOutputChannelAsync().

OutputWindowExtensibility.CreateOutputChannelAsync()

El CreateOutputChannelAsync() método tiene dos parámetros:

Parámetro Type Obligatorio Descripción
displayName string sí Nombre para mostrar de la ventana de salida. Esto es lo que estará visible en el menú desplegable "Mostrar salida de:" en el panel Salida. Este valor se marca como "Localizable" para localizar el nombre para mostrar.
cancellationToken CancellationToken sí El CancellationToken para la operación asíncrona.

Editar o agregar la clase Extension

Si el proyecto aún no contiene una clase que deriva de Extension, debe agregar una como la simple siguiente (en este caso denominada MyExtension.cs):

using System.Resources;
using Microsoft.VisualStudio.Extensibility;

namespace MyProject
{
    public class MyExtension : Extension
    {
        // Initiailzation code here
    }
}

Adición del código de inicialización

Este código puede estar en cualquier clase que quiera usar para mostrar los mensajes de salida (como un comando), pero lo importante es que CreateOutputChannelAsync() solo se puede llamar una vez para un nombre para mostrar del canal de ventana de salida determinado, si hay conflictos, se producirá una excepción, por lo que considere la posibilidad de llamarlo en un método de inicialización de un solo uso, como InitializeAsync().

public override async Task InitializeAsync(CancellationToken cancellationToken)
{
    string displayName = "My Output Window";

     // To use this Output window Channel elsewhere in the class, such as the ExecuteCommandAsync() method in a Command, save this result to a field in the class.
    OutputChannel? outputChannel = await this.Extensibility.Views().Output.CreateOutputChannelAsync(displayName, cancellationToken);
}

Escribir en el canal de salida

La OutputChannel instancia obtenida en Obtener un canal de ventana de salida tiene una System.IO.TextWriter propiedad denominada Writer, que admite operaciones conocidas para escribir texto, como:

Además, puede llamar a WriteAsync() o WriteLineAsync() directamente en OutputChannel, o acceder a a System.IO.Pipelines.PipeWriter través de la PipeWriter propiedad .

Ejemplo

Este fragmento de código se puede usar siempre que quiera mostrar un mensaje en la ventana Salida, como en el ExecuteCommandAsync() método de un comando.

if (this.outputChannel != null)
{
    await this.outputChannel.Writer.WriteLineAsync("This is a test of the output channel TextWriter.");
    
    await this.outputChannel.WriteLineAsync("This is a test of the output channel.");

    var rom = new ReadOnlyMemory<byte>(Encoding.UTF8.GetBytes("This is a test of the output channel PipeWriter."));
    await this.outputChannel.PipeWriter.WriteLineAsync(rom, new());
}

Pasos siguientes

Más información:

Vea el código de ejemplo:

  • Consulte el ejemplo OutputWindowSample para obtener un ejemplo completo de creación de una extensión que usa la ventana de salida.