ProvideToolboxItemsAttribute Класс

Ссылка

Определение

Пространство имен:: Microsoft.VisualStudio.Shell

Сборка:: Microsoft.VisualStudio.Shell.14.0.dll

Сборка:: Microsoft.VisualStudio.Shell.15.0.dll

Пакет:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Примените этот атрибут к классам, реализующим пакеты VSPackage, чтобы объявить, предлагают ли они набор элементов для панели элементов Visual Studio.

public ref class ProvideToolboxItemsAttribute : Microsoft::VisualStudio::Shell::RegistrationAttribute

[System.AttributeUsage(System.AttributeTargets.Class, Inherited=true)]
public class ProvideToolboxItemsAttribute : Microsoft.VisualStudio.Shell.RegistrationAttribute

[<System.AttributeUsage(System.AttributeTargets.Class, Inherited=true)>]
type ProvideToolboxItemsAttribute = class
    inherit RegistrationAttribute

Public Class ProvideToolboxItemsAttribute
Inherits RegistrationAttribute

Наследование: Attribute

RegistrationAttribute
ProvideToolboxItemsAttribute

Атрибуты: AttributeUsageAttribute

Примеры

В приведенном ниже примере атрибуты, применяемые к классу MyPackage , указывают на то, что он поддерживает версию 1 элементов панели элементов с двумя форматами буфера обмена "CF_XMLCODE" и "InPlaceMenuEditorMenu".

[DefaultRegistryRoot("Software\\Microsoft\\VisualStudio\\8.0")]  
[ProvideToolboxItems(true, 1)]  
[ProvideToolboxFormat("CF_XMLCODE")]  
[ProvideToolboxFormat("InPlaceMenuEditorMenu")]  
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]  
internal sealed class MyPackage : Package


Применяется к	Классы, предоставляющие пакеты VSPackage путем реализации IVsPackage, . Package
Повторяемый	Нет
Требуемые атрибуты	ProvideToolboxFormatAttribute
Недопустимые атрибуты	None

Примените этот атрибут к классу, производном Packageот класса, или к классу, который реализует IVsPackage , необходимый для поддержки перетаскивания пользователями объектов данных этого формата, предоставляемых классом , на панель элементов. Этот реализующий класс должен самостоятельно обрабатывать уведомления об удалении.

Этот атрибут используется только в целях регистрации и не влияет на поведение кода во время выполнения.

В зависимости от аргументов, указанных в конструкторе, этот атрибут может указывать на то, что VSPackage не предоставляет никаких элементов панели элементов . Если атрибут ProvideToolboxFormatAttribute добавляется в класс, чтобы указать, что он предоставляет элементы панели элементов , необходимо также добавить один или несколько экземпляров ProvideToolboxFormatAttribute .

Этот атрибут использует ProvideToolboxFormatAttribute для регистрации VSPackage как предоставляющего элементы панели элементов заданного формата.

Если этот атрибут указывает, что предоставляются элементы панели элементов , VSPackage должен обрабатывать ToolboxInitialized события и ToolboxUpgraded .

Любой пакет VSPackage, использующий этот атрибут, должен предоставлять обработчик для ToolboxInitialized событий и ToolboxUpgraded .

Конструкторы

ProvideToolboxItemsAttribute(Int32)	Создает новый экземпляр ProvideToolboxItemsAttribute , который указывает, предоставляет ли класс, реализующий VSPackage, элементы панели элементов.
ProvideToolboxItemsAttribute(Int32, Boolean)	Инициализирует новый экземпляр ProvideToolboxItemsAttribute для указанной версии.

Свойства

NeedsCallBackAfterReset	Если задать значение true, событие ToolboxInitialized будет принудительно выполняться после каждого сброса панели элементов. Это можно использовать при разработке пакета, чтобы принудить панель элементов запрашивать список элементов в пакете каждый раз (в случае его изменения). Для отгруженных продуктов лучше оставить значение false, чтобы кэш можно было использовать для повышения производительности. В некоторых сценариях (например, списке элементов, который не удается сохранить в кэше) может потребоваться установить для этого флага значение true.
TypeId	Переопределите свойство TypeID, чтобы разрешить производным классам RegistrationAttribute работать с System.ComponentModel.TypeDescriptor.GetAttributes(...). Атрибут, производный от этого , должен переопределять это свойство только в том случае, если ему требуется более качественный контроль над экземплярами, которые можно применить к классу. (Унаследовано от RegistrationAttribute)
Version	Свойство, возвращающее версию элементов панели элементов, которые предоставляет VSPackage.

Методы

GetPackageRegKeyPath(Guid)	Получает путь в реестре (относительно корня реестра приложения) VSPackage. (Унаследовано от RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Регистрирует VSPackage в качестве поставщика элементов панели элементов для указанных форматов при вызове внешним средством регистрации, таким как regpkg.exe. Дополнительные сведения см. в разделе Регистрация пакетов VSPackage.
Unregister(RegistrationAttribute+RegistrationContext)	отменяет изменения, которые метод Register(RegistrationAttribute+RegistrationContext) применил к реестру.

Применяется к

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