ProvideToolboxFormatAttribute 类

将此特性应用于实现 Vspackage 的类声明 VSPackage 提供 工具箱 项与指定的剪贴板格式,从而拖放支持。 Visual Studio 工具箱

继承层次结构

System.Object
  System.Attribute
    Microsoft.VisualStudio.Shell.ProvideToolboxFormatAttribute

命名空间:  Microsoft.VisualStudio.Shell
程序集:  Microsoft.VisualStudio.Shell.11.0(在 Microsoft.VisualStudio.Shell.11.0.dll 中)

语法

声明
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := True, AllowMultiple := True)> _
Public NotInheritable Class ProvideToolboxFormatAttribute _
    Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Class, Inherited = true, AllowMultiple = true)]
public sealed class ProvideToolboxFormatAttribute : Attribute

ProvideToolboxFormatAttribute 类型公开以下成员。

构造函数

  名称 说明
公共方法 ProvideToolboxFormatAttribute 初始化 ProvideToolboxFormatAttribute 新实例所指定的格式。

页首

属性

  名称 说明
公共属性 Format 获取一个支持的剪贴板格式的名称。
公共属性 TypeId 当在派生类中实现时,获取该 Attribute 的唯一标识符。 (继承自 Attribute。)

页首

方法

  名称 说明
公共方法 Equals 基础结构。返回一个值,该值指示此实例是否与指定的对象相等。 (继承自 Attribute。)
公共方法 GetHashCode 返回此实例的哈希代码。 (继承自 Attribute。)
公共方法 GetType 获取当前实例的 Type。 (继承自 Object。)
公共方法 IsDefaultAttribute 当在派生类中重写时,指示此实例的值是否是派生类的默认值。 (继承自 Attribute。)
公共方法 Match 当在派生类中重写时,返回一个指示此实例是否等于指定对象的值。 (继承自 Attribute。)
公共方法 ToString 返回表示当前对象的字符串。 (继承自 Object。)

页首

显式接口实现

  名称 说明
显式接口实现私有方法 _Attribute.GetIDsOfNames 将一组名称映射为对应的一组调度标识符。 (继承自 Attribute。)
显式接口实现私有方法 _Attribute.GetTypeInfo 检索对象的类型信息,然后可以使用该信息获取接口的类型信息。 (继承自 Attribute。)
显式接口实现私有方法 _Attribute.GetTypeInfoCount 检索对象提供的类型信息接口的数量(0 或 1)。 (继承自 Attribute。)
显式接口实现私有方法 _Attribute.Invoke 提供对某一对象公开的属性和方法的访问。 (继承自 Attribute。)

页首

备注

属性上下文

适用对象

提供 Vspackage 的类通过实现 IVsPackage 接口或 Package 接口。

可重复

必需的特性

ProvideToolboxItemsAttribute

无效的特性

此属性用于注册目的仅使用,并且不会影响运行时行为。

将此特性应用于实现 VSPackage 的类提供 工具箱 项目以非标准剪贴板格式或不支持一个或多个默认 工具箱 剪贴板格式。

如果没有此属性的 VSPackage 必须支持所有默认 工具箱 剪贴板类型。

有关 VSPackage 支持的默认 工具箱 剪贴板类型的列表,请参见 工具箱 (Visual Studio SDK)

此属性的单独使用未注册 VSPackage 为项目提供程序与特定的剪贴板。必须将特性应用于的实例注册 VSPackage,提供了将指定格式的对象。

只有一个剪贴板格式注册为支持此属性每个实例应用于类。若要指示多种格式支持,必须应用特性的多个实例于类。

说明 C# 自动追加单词 “属性”对任何特性类的名称。在 C# 代码,请参见此属性作为 ProvideToolboxFormat。

示例

在属性下面的示例中应用于 Mypackage::close() 类指示它支持 工具箱 项目的 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

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。但不保证所有实例成员都是线程安全的。

请参见

参考

Microsoft.VisualStudio.Shell 命名空间

ProvideToolboxFormatAttribute

其他资源

工具箱 (Visual Studio SDK)