ToolboxDataAttribute

.NET Framework クラス ライブラリ リファレンス

ToolboxDataAttribute クラス

Microsoft Visual Studio などのツールでツールボックスからドラッグされるときに、カスタム コントロールに生成される既定のタグを指定します。

名前空間: System.Web.UI
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Class)> _
Public NotInheritable Class
 ToolboxDataAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As ToolboxDataAttribute

C#

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

C++

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

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Class) */ 
public final class ToolboxDataAttribute extends
 Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Class) 
public final class ToolboxDataAttribute extends
 Attribute

解説

既定では、Visual Studio などのツールのビジュアル デザイナで、空のタグが作成されます。このタグは、コントロールをビジュアル デザイナのツールボックスからデザイン サーフェイスにドロップするときの、既定の状態のコントロールを表すタグです。初期既定値を指定する場合、コントロールはこの属性を利用できます。この属性を使用すると、コントロールがツールボックスからフォームにドラッグされるときにデザイナに配置される初期の HTML の内容をカスタマイズできます。

Topic	Location
チュートリアル : カスタム サーバー コントロールの開発と使用	ASP.NET コントロールの作成

使用例

[ ToolboxData("<{0}:MyLabel runat= server Text= 
       MyLabel><{0}:MyLabel>") ]public class MyLabel : Label {...}

上記のコードによって MyLabel に固有のプロパティをいくつか設定する例を次に示します。すべての {0} が、デザイナによって、MyLabel クラスに関連付けられているタグ プリフィックスに置換されます。

Visual Basic

Imports System
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls


Namespace CustomControls
  <ToolboxData("<{0}:MyLabel Text='MyLabel' BorderColor='Yellow'
 BackColor='Magenta' BorderWidth = '10'  runat='server'></{0}:MyLabel>")>
  _
  Public Class MyLabel
    Inherits Label
     
    Public Sub New()
      'Your code goes here.
    End Sub 'New
    
  End Class 'MyLabel
  
End Namespace 'CustomControls

C#

using System;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;


namespace CustomControls
{

  [ ToolboxData("<{0}:MyLabel Text='MyLabel' BorderColor='Yellow' BackColor='Magenta'
 BorderWidth = '10'  runat='server'></{0}:MyLabel>") ]    
  public class MyLabel : Label 
  {
    public  MyLabel()
    { 
      // Your code goes here.
    } 
  }

}

J#

import System.*;
import System.Web.*;
import System.Web.UI.*;
import System.Web.UI.WebControls.*;

/** @attribute ToolboxData("<{0}:MyLabel Text='MyLabel' BorderColor='Yellow'"
    + "BackColor='Magenta' BorderWidth = '10'  runat='server'></{0}:MyLabel>")
 */
public class MyLabel extends Label
{
    public MyLabel()
    {
        // Your code goes here.
    } //MyLabel
} //MyLabel

継承階層

System.Object
   System.Attribute
    System.Web.UI.ToolboxDataAttribute

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
ToolboxDataAttribute メンバ
System.Web.UI 名前空間
Attribute
その他の技術情報
属性を使用したメタデータの拡張

ToolboxDataAttribute コンストラクタ

このコンストラクタは、.NET Framework インフラストラクチャをサポートします。独自に作成したコードから直接使用するためのものではありません。

ToolboxDataAttribute クラスの新しいインスタンスを初期化します。

名前空間: System.Web.UI
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    data As String _
)

Visual Basic (使用法)

Dim data As String

Dim instance As New ToolboxDataAttribute(data)

C#

public ToolboxDataAttribute (
    string data
)

C++

public:
ToolboxDataAttribute (
    String^ data
)

J#

public ToolboxDataAttribute (
    String data
)

JScript

public function ToolboxDataAttribute (
    data : String
)

パラメータ

data

Data として設定する文字列。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
ToolboxDataAttribute クラス
ToolboxDataAttribute メンバ
System.Web.UI 名前空間

ToolboxDataAttribute フィールド

パブリック フィールド

	名前	説明
	Default	カスタム コントロールの既定の ToolboxDataAttribute 値を表します。

参照

関連項目

ToolboxDataAttribute クラス
System.Web.UI 名前空間
Attribute

その他の技術情報

属性を使用したメタデータの拡張

ToolboxDataAttribute プロパティ

パブリック プロパティ

	名前	説明
	Data	コントロールのプロパティの初期値を表す文字列を取得します。この文字列は、コントロールのインスタンスを作成するときにビジュアル デザイナで使用されます。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

参照

関連項目

ToolboxDataAttribute クラス
System.Web.UI 名前空間
Attribute

その他の技術情報

属性を使用したメタデータの拡張

ToolboxDataAttribute メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。 ToolboxDataAttribute オブジェクトが、指定したオブジェクトと等しいかどうかをテストします。
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。)
	GetHashCode	オーバーライドされます。 カスタム コントロールのハッシュ コードを返します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsDefaultAttribute	オーバーライドされます。 ToolboxDataAttribute オブジェクトが Data プロパティの既定値を格納しているかどうかをテストします。
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

ToolboxDataAttribute クラス
System.Web.UI 名前空間
Attribute

その他の技術情報

属性を使用したメタデータの拡張

ToolboxDataAttribute メンバ

Microsoft Visual Studio などのツールでツールボックスからドラッグされるときに、カスタム コントロールに生成される既定のタグを指定します。

ToolboxDataAttribute データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	ToolboxDataAttribute	ToolboxDataAttribute クラスの新しいインスタンスを初期化します。

パブリック フィールド

	名前	説明
	Default	カスタム コントロールの既定の ToolboxDataAttribute 値を表します。

パブリック プロパティ

	名前	説明
	Data	コントロールのプロパティの初期値を表す文字列を取得します。この文字列は、コントロールのインスタンスを作成するときにビジュアル デザイナで使用されます。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。 ToolboxDataAttribute オブジェクトが、指定したオブジェクトと等しいかどうかをテストします。
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。)
	GetHashCode	オーバーライドされます。 カスタム コントロールのハッシュ コードを返します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsDefaultAttribute	オーバーライドされます。 ToolboxDataAttribute オブジェクトが Data プロパティの既定値を格納しているかどうかをテストします。
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 (Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

ToolboxDataAttribute クラス
System.Web.UI 名前空間
Attribute

その他の技術情報

属性を使用したメタデータの拡張