IVsProvideColorableItems - интерфейс

Статья
05/17/2015

Информирует редактор кода о пользовательских элементах proffered цветного службой языка.

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

Синтаксис

'Декларация
<GuidAttribute("100B9A33-905C-4312-B2A2-452189F19AB9")> _
<InterfaceTypeAttribute()> _
Public Interface IVsProvideColorableItems

[GuidAttribute("100B9A33-905C-4312-B2A2-452189F19AB9")]
[InterfaceTypeAttribute()]
public interface IVsProvideColorableItems

[GuidAttribute(L"100B9A33-905C-4312-B2A2-452189F19AB9")]
[InterfaceTypeAttribute()]
public interface class IVsProvideColorableItems

[<GuidAttribute("100B9A33-905C-4312-B2A2-452189F19AB9")>]
[<InterfaceTypeAttribute()>]
type IVsProvideColorableItems =  interface end

public interface IVsProvideColorableItems

Тип IVsProvideColorableItems предоставляет следующие члены.

Методы

	Имя	Описание
	GetColorableItem	Задает данные элементов для каждого настраиваемого цветного элемента proffered службой языка.
	GetItemCount	Указывает число настраиваемых элементов языка proffered цветного службой.

В начало страницы

Заметки

Путем реализации IVsProvideColorableItemsможно proffer пользовательские цветного основные элементы к редактору и " редактор цветного основные числа указанных элементов и их смелейшие по умолчанию цвет/параметры. Редактор цвета основной управляет выделения пользователя текущие для цветного (например, набор элементов Параметры диалоговое окно в Сервис меню). Например, по умолчанию цветного элементы, язык не имеет физическая организация над визуальными просмотреть его цветного элементов, указав их значения по умолчанию.

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

Примечания для разработчиков

Для поддержки пользовательских цветного элементы в службе языка необходимо реализовать этот интерфейс на одном и том же классе, который реализует IVsLanguageInfo интерфейс и обеспечивает поддержку получить доступ через интерфейс QueryInterface метод. Реализовать методы IVsProvideColorableItems интерфейс, необходим список IVsColorableItems, который необходимо предложить вверх по требованию (см. IVsColorableItem интерфейс пример создания список настраиваемых цветного элементов).

Примечания к вызывающим объектам

Редактор получает этот интерфейс путем вызова QueryInterface метод IVsLanguageInfo интерфейс, представляющий службу языка.

Примеры

Ниже приведен пример того, как этот интерфейс может быть реализован на службу языка. Пример в IVsColorableItem интерфейс показано, как реализовать MyColorableItem класс.

using Microsoft.VisualStudio;
using Microsoft.VisualStudio.TextManager.Interop;

namespace MyLanguagePackage
{
    class MyLanguageService : IVsLanguageInfo, IVsProvideColorableItems
    {
        private MyColorableItems colorableItemsList[];
        public MyLanguageService()
        {
            // populate the colorableItemsList here.
        }

        public int GetItemCount(out int piCount)
        {
            piCount = 0;
            if (this.colorableItemsList != null)
            {
                 if (this.colorableItemsList.Length > 0)
                 {
                     // The first color is a placeholder and is
                     // never counted.
                     piCount = this.colorableItemsList.Length - 1;
                 }
            }
            return VSConstants.S_OK;
        }

        public int GetColorableItem(int iIndex, out IVsColorableItem ppItem)
        {
            int retval = VsConstants.E_INVALIDARG;

            ppItem = null;
            if (this.colorableItemList != null &&
                iIndex >= 0 && iIndex < this.colorableItemList.Length)
            {
                 ppItem = this.colorableItemsList[iIndex];
                 retval = VSConstants.S_OK;
            }
            return retval;
        }
    }
}

См. также

Ссылки

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

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