ProvideToolboxItemsAttribute Classe

Referência

Definição

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Pacote:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Aplique esse atributo a classes que implementam VSPackages para declarar se oferecem um conjunto de itens à Caixa de Ferramentas do 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

Herança: Attribute

RegistrationAttribute
ProvideToolboxItemsAttribute

Atributos: AttributeUsageAttribute

Exemplos

No exemplo a seguir, os atributos aplicados à classe MyPackage indicam que ela dá suporte à versão 1 dos itens da Caixa de Ferramentas do com dois formatos de área de transferência "CF_XMLCODE" e "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

Comentários

Contexto do atributo


Aplica-se a	Classes que fornecem VSPackages implementando IVsPackage, Package.
Repetível	No
Atributos obrigatórios	ProvideToolboxFormatAttribute
Atributos inválidos	Nenhum

Aplique esse atributo a uma Packageclasse derivada de ou a uma classe que implementa IVsPackage que é necessária para habilitar o suporte para que os usuários arrastem objetos de dados desse formato, fornecidos pela classe , para a Caixa de Ferramentas. Essa classe de implementação deve lidar com as próprias notificações de remoção.

Esse atributo é usado apenas para fins de registro e não afeta como o código se comporta em runtime.

Dependendo dos argumentos especificados em seu construtor, esse atributo pode indicar que um VSPackage não fornece nenhum item da Caixa de Ferramentas . Se o atributo ProvideToolboxFormatAttribute for adicionado a uma classe para indicar que ele fornece itens da Caixa de Ferramentas , uma ou mais instâncias de ProvideToolboxFormatAttribute também deverão ser adicionadas.

Esse atributo usa ProvideToolboxFormatAttribute para registrar um VSPackage como fornecendo itens de caixa de ferramentas de um determinado formato.

Se esse atributo especificar que os itens da Caixa de Ferramentas são fornecidos, o VSPackage deve manipular os ToolboxInitialized eventos e ToolboxUpgraded .

Qualquer VSPackage que use esse atributo deve fornecer um manipulador para os ToolboxInitialized eventos e ToolboxUpgraded .

Construtores

ProvideToolboxItemsAttribute(Int32)	Cria uma nova instância do ProvideToolboxItemsAttribute que indica se uma classe que implementa um VSPackage está fornecendo itens da Caixa de Ferramentas.
ProvideToolboxItemsAttribute(Int32, Boolean)	Inicializa uma nova instância do ProvideToolboxItemsAttribute para a versão especificada.

Propriedades

NeedsCallBackAfterReset	Definir isso como true forçará um evento ToolboxInitialized após cada redefinição de caixa de ferramentas. Isso pode ser usado ao desenvolver seu pacote para forçar a caixa de ferramentas a solicitar a lista de itens ao pacote toda vez (caso ele tenha sido alterado). Para produtos enviados, é melhor deixá-lo como falso para que o cache possa ser usado para melhores desempenhos. Alguns cenários (como lista de itens que não podem ser persistidos no cache) podem precisar ter esse sinalizador definido como true
TypeId	Substitua a propriedade TypeID para permitir que as classes derivadas de RegistrationAttribute funcionem com System.ComponentModel.TypeDescriptor.GetAttributes(...). Um atributo derivado deste terá que substituir essa propriedade somente se precisar de um controle melhor nas instâncias que podem ser aplicadas a uma classe. (Herdado de RegistrationAttribute)
Version	Propriedade que retorna a versão dos itens da Caixa de Ferramentas que um VSPackage fornece.

Métodos

GetPackageRegKeyPath(Guid)	Obtém o caminho do Registro (em relação à raiz do Registro do aplicativo) do VSPackage. (Herdado de RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Registra um VSPackage como um provedor de itens da Caixa de Ferramentas para formatos especificados quando chamado por uma ferramenta de registro externa, como regpkg.exe. Para obter mais informações, consulte Registrando VSPackages.
Unregister(RegistrationAttribute+RegistrationContext)	Inverte as alterações que o Register(RegistrationAttribute+RegistrationContext) método aplicou ao registro.

Aplica-se a

Partilhar via