Método IVsLanguageTextOps.Format
Formata o texto selecionado.
Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (em Microsoft.VisualStudio.TextManager.Interop.dll)
Sintaxe
'Declaração
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] Um IVsTextLayer objeto que contém o texto a formatar.
ptsSel
Tipo: array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[][in] Texto variam formato dentro da camada especificada. Para obter mais informações, consulte TextSpan.
Valor de retorno
Tipo: Int32
Se o método for bem-sucedido, ele retorna S_OK.Se ele falhar, ele retorna um código de erro.
Comentários
COM assinatura
De textmgr.idl:
HRESULT IVsLanguageTextOps::Format(
[in] IVsTextLayer *pTextLayer,
[in] const TextSpan *ptsSel
);
Esta função é chamada quando o usuário seleciona Documento no formato ou Format Selection da Editar -> Advanced menu e as solicitações que o serviço de linguagem fornecer formatação para o intervalo de texto relacionado. Formatação normalmente significa para ajustar o recuo de linha, adicionando espaços depois de vírgulas ou até mesmo movendo chaves para uma nova linha com indentação adequada.
Esse método também pode ser chamado sempre que o usuário digita um caractere que pode disparar uma reformatar (esse caractere for depende do serviço idioma mas normalmente é uma chave de fechamento ou ponto e vírgula).
Dica
É altamente recomendável que, se você implementar esse método, você dispor todas as alterações feitas no documento em um IVsCompoundAction de objeto para que o usuário pode desfazer a operação de formatação de todo em uma ação.
Segurança do .NET Framework
- Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiável.