ToolboxBrowsableAttribute 类

明确控件在设计器的工具箱浏览器中是否可见。

继承层次结构

System.Object
  System.Attribute
    Microsoft.Windows.Design.ToolboxBrowsableAttribute

命名空间：  Microsoft.Windows.Design
程序集：  Microsoft.Windows.Design.Interaction（在 Microsoft.Windows.Design.Interaction.dll 中）

语法

声明
<AttributeUsageAttribute(AttributeTargets.Class)> _
Public NotInheritable Class ToolboxBrowsableAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Class)]
public sealed class ToolboxBrowsableAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Class)]
public ref class ToolboxBrowsableAttribute sealed : public Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class)>]
type ToolboxBrowsableAttribute =  
    class
        inherit Attribute
    end

public final class ToolboxBrowsableAttribute extends Attribute

ToolboxBrowsableAttribute 类型公开以下成员。

构造函数

	名称	说明
	ToolboxBrowsableAttribute	初始化 ToolboxBrowsableAttribute 类的新实例。

页首

属性

	名称	说明
	Browsable	获取与该属性相关联的 Browsable 标志。
	No	获取 Browsable 设置为 false 的 ToolboxBrowsableAttribute。
	TypeId	当在派生类中实现时，获取该 Attribute 的唯一标识符。 （继承自 Attribute。）
	Yes	获取 Browsable 设置为 true 的 ToolboxBrowsableAttribute。

页首

方法

	名称	说明
	Equals	基础结构。返回一个值，该值指示此实例是否与指定的对象相等。 （继承自 Attribute。）
	Finalize	允许对象在“垃圾回收”回收之前尝试释放资源并执行其他清理操作。 （继承自 Object。）
	GetHashCode	返回此实例的哈希代码。 （继承自 Attribute。）
	GetType	获取当前实例的 Type。 （继承自 Object。）
	IsDefaultAttribute	当在派生类中重写时，指示此实例的值是否是派生类的默认值。 （继承自 Attribute。）
	Match	当在派生类中重写时，返回一个指示此实例是否等于指定对象的值。 （继承自 Attribute。）
	MemberwiseClone	创建当前 Object 的浅表副本。 （继承自 Object。）
	ToString	返回表示当前对象的字符串。 （继承自 Object。）

页首

显式接口实现

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

页首

备注

使用 ToolboxBrowsableAttribute 指定控件在“选择工具箱项”（对于 适用于 Visual Studio 的 WPF 设计器）对话框或“子集库”（对于 Microsoft Blend）中可见的时间。

示例

以下代码示例演示如何使用 ToolboxBrowsableAttribute 在自定义工具箱浏览器中启用自定义控件的可见性。

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports System.ComponentModel
Imports System.Windows.Media
Imports System.Windows.Controls
Imports System.Windows

Imports Microsoft.Windows.Design
Imports Microsoft.Windows.Design.Features
Imports Microsoft.Windows.Design.Metadata

' The ProvideMetadata assembly-level attribute indicates to designers
' that this assembly contains a class that provides an attribute table. 
<Assembly: ProvideMetadata(GetType(CustomControlLibrary.Design.Metadata))> 

Public Class ButtonWithDesignTime
    Inherits Button
End Class

' Container for any general design-time metadata to initialize.
' Designers look for a type in the design-time assembly that 
' implements IProvideAttributeTable. If found, designers instantiate
' this class and access its AttributeTable property automatically.
Friend Class Metadata
    Implements IProvideAttributeTable

    ' Accessed by the designer to register any design-time metadata.
    Public ReadOnly Property AttributeTable() As AttributeTable _
        Implements IProvideAttributeTable.AttributeTable
        Get
            Dim builder As New AttributeTableBuilder()

            builder.AddCustomAttributes( _
                GetType(ButtonWithDesignTime), _
                New ToolboxBrowsableAttribute(True))

            Return builder.CreateTable()
        End Get
    End Property

End Class

using System;
using System.Collections.Generic;
using System.Text;
using System.ComponentModel;
using System.Windows.Media;
using System.Windows.Controls;
using System.Windows;

using Microsoft.Windows.Design;
using Microsoft.Windows.Design.Features;
using Microsoft.Windows.Design.Metadata;

// The ProvideMetadata assembly-level attribute indicates to designers
// that this assembly contains a class that provides an attribute table. 
[assembly: ProvideMetadata(typeof(CustomControlLibrary.Design.Metadata))]

namespace CustomControlLibrary.Design
{
    public class ButtonWithDesignTime : Button
    {
    }

    // Container for any general design-time metadata to initialize.
    // Designers look for a type in the design-time assembly that 
    // implements IProvideAttributeTable. If found, designers instantiate 
    // this class and access its AttributeTable property automatically.
    internal class Metadata : IProvideAttributeTable
    {
        // Accessed by the designer to register any design-time metadata.
        public AttributeTable AttributeTable
        {
            get 
            {
                AttributeTableBuilder builder = new AttributeTableBuilder();

                builder.AddCustomAttributes(
                    typeof(ButtonWithDesignTime),
                    new ToolboxBrowsableAttribute(true));

                return builder.CreateTable();
            }
        }
    }
}

线程安全

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

请参见

参考

Microsoft.Windows.Design 命名空间

AttributeTableBuilder

其他资源

演练：创建设计时装饰器