IVsLanguageTextOps.Format (Método)

Da formato al texto seleccionado.

Espacio de nombres:  Microsoft.VisualStudio.TextManager.Interop
Ensamblado:  Microsoft.VisualStudio.TextManager.Interop (en Microsoft.VisualStudio.TextManager.Interop.dll)

Sintaxis

'Declaración
Function Format ( _
    pTextLayer As IVsTextLayer, _
    ptsSel As TextSpan() _
) As Integer

int Format(
    IVsTextLayer pTextLayer,
    TextSpan[] ptsSel
)

int Format(
    [InAttribute] IVsTextLayer^ pTextLayer, 
    [InAttribute] array<TextSpan>^ ptsSel
)

abstract Format : 
        pTextLayer:IVsTextLayer * 
        ptsSel:TextSpan[] -> int

function Format(
    pTextLayer : IVsTextLayer, 
    ptsSel : TextSpan[]
) : int

Parámetros

• pTextLayer
  Tipo: Microsoft.VisualStudio.TextManager.Interop.IVsTextLayer

  [in] Un objeto de IVsTextLayer que contiene el texto al formato.

• ptsSel
  Tipo: array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[]

  [in] Intervalo de texto a dar formato dentro del nivel especificado. Para obtener más información, vea TextSpan.

Valor devuelto

Tipo: Int32
si el método tiene éxito, devuelve S_OK.Si se produce un error, devuelve un código de error.

Comentarios

Prototipo COM

de textmgr.idl:

HRESULT IVsLanguageTextOps::Format(
   [in] IVsTextLayer *pTextLayer,
   [in] const TextSpan *ptsSel
);

Se llama a esta función cuando el usuario selecciona Dar formato al documento o Dar formato a la selección de Editar - menú de > AVANZADAS , y las solicitudes que el servicio de lenguaje proporciona el formato para el intervalo hace referencia de texto. Formato normalmente significa a ajustar la sangría de la línea, espacios de suma después de comas, o incluso las llaves móviles en una nueva línea con sangría adecuada.

Este método también se puede llamar cada vez que el usuario escribe un carácter que pueden desencadenar un cambiar el formato (que ese carácter es depende del servicio de lenguaje pero es normalmente una llave de cierre o un punto y coma).

Nota

Se recomienda si implementa este método, se envuelve todos los cambios realizados al documento en un objeto de IVsCompoundAction para que pueda el usuario deshacer toda la operación de formato en una acción.

Seguridad de .NET Framework

• Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.

Vea también

Referencia

IVsLanguageTextOps Interfaz

Microsoft.VisualStudio.TextManager.Interop (Espacio de nombres)