ToolboxBrowsableAttribute クラス

更新 : 2007 年 11 月

コントロールがデザイナのツールボックスブラウザに表示されるがどうかを指定します。

名前空間 : Microsoft.Windows.Design
アセンブリ : Microsoft.Windows.Design (Microsoft.Windows.Design.dll 内)

構文

'宣言
<AttributeUsageAttribute(AttributeTargets.Class)> _
Public NotInheritable Class ToolboxBrowsableAttribute _
    Inherits Attribute
'使用
Dim instance As ToolboxBrowsableAttribute

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

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

public final class ToolboxBrowsableAttribute extends Attribute

解説

ToolboxBrowsableAttribute は、Windows Presentation Foundation (WPF) Designer for Visual Studio の [ツールボックスアイテムの選択] ダイアログボックスや 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

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 IRegisterMetadata. If found, designers instantiate 
' this class and call its Register() method automatically.
Friend Class Metadata
    Implements IRegisterMetadata

    ' Called by the designer to register any design-time metadata.
    Public Sub Register() Implements IRegisterMetadata.Register
        Dim builder As New AttributeTableBuilder()

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

        MetadataStore.AddAttributeTable(builder.CreateTable())

    End Sub
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;

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 IRegisterMetadata. If found, designers instantiate 
    // this class and call its Register() method automatically.
    internal class Metadata : IRegisterMetadata
    {
        // Called by the designer to register any design-time metadata.
        public void Register()
        {
            AttributeTableBuilder builder = new AttributeTableBuilder();

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

            MetadataStore.AddAttributeTable(builder.CreateTable());
        }
    }
}