IVsLanguageTextOps.Format - метод

Статья
05/17/2015

Форматирует выделенный текст.

Пространство имен: Microsoft.VisualStudio.TextManager.Interop
Сборка: Microsoft.VisualStudio.TextManager.Interop (в Microsoft.VisualStudio.TextManager.Interop.dll)

Синтаксис

'Декларация
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

Параметры

pTextLayer
Тип: Microsoft.VisualStudio.TextManager.Interop.IVsTextLayer

[in] IVsTextLayer объект, содержащий текст в формат.

ptsSel
Тип: array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[]

[in] диапазон текста, который необходимо отформатировать в указанный уровень. Дополнительные сведения см. в разделе TextSpan.

Возвращаемое значение

Тип: Int32
Если метод завершается успешно, возвращается S_OK.Если происходит сбой, возвращается код ошибки.

Заметки

Модель COM подписи

Из textmgr.idl:

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

Эта функция вызывается, когда пользователь выбирает Форматировать документ OR Форматировать выделенный фрагмент от изменить - > Дополнительно меню и запросы, что служба языка предоставляет форматирования для указанного диапазона текста. Форматирования обычно означает к обработке линию отступы добавление пробелов, запятых или даже после перемещения фигурные скобки в новую линии с правильным отступом.

Этот метод можно также вызвать когда пользователь вводит символ, который может активироваться переформатировать (что этот символ зависит от службы языка, но обычно заключительная фигурная скобка или точка с запятой).

Примечание

Настоятельно рекомендуется при реализации этого метода, вы создаете программу-оболочку все изменения, внесенные в документ в IVsCompoundAction объект поэтому пользователь может отменить всей операции формата в одной операции.

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Для получения дополнительной информации см. Использование библиотек из не вполне надежного кода.

См. также

Ссылки

IVsLanguageTextOps Интерфейс

Microsoft.VisualStudio.TextManager.Interop - пространство имен

Поделиться через