DesignerCategoryAttribute クラス

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

DesignerCategoryAttribute クラス

クラスのデザイナが特定のカテゴリに属していることを指定します。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple:=False, Inherited:=True)>
 _
Public NotInheritable Class
 DesignerCategoryAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As DesignerCategoryAttribute

C#

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple=false,
 Inherited=true)] 
public sealed class DesignerCategoryAttribute
 : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple=false,
 Inherited=true)] 
public ref class DesignerCategoryAttribute
 sealed : public Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple=false,
 Inherited=true) */ 
public final class DesignerCategoryAttribute
 extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple=false,
 Inherited=true) 
public final class DesignerCategoryAttribute
 extends Attribute

解説

ビジュアル デザイナは、デザイナ カテゴリを使用して、実装するデザイナの型を開発環境に通知できます。クラスにデザイナ カテゴリが提供されていない場合、開発環境では、そのクラスをデザインできる場合とできない場合があります。任意の名前のカテゴリを作成できます。

この属性でクラスをマークすると、属性は定数メンバに設定されます。コードでこの属性の値を確認するには、定数メンバを指定する必要があります。次の表の "説明" 列に、各値に設定される定数メンバを示します。

DesignerCategoryAttribute クラスは、次の共通カテゴリを定義します。

カテゴリ	説明
コンポーネント	コンポーネントで使用されるデザイナ。属性は定数メンバ DesignerCategoryAttribute.Component に設定されます。
フォーム	フォームで使用されるデザイナ。属性は定数メンバ DesignerCategoryAttribute.Form に設定されます。
デザイナ	デザイナで使用されるデザイナ。属性は定数メンバ DesignerCategoryAttribute.Generic に設定されます。
空の文字列 ("")。	これは既定のカテゴリです。

詳細については、属性の概要、属性を使用したメタデータの拡張 の各トピックを参照してください。

使用例

MyForm というクラスを作成する方法を次の例に示します。MyForm には、このクラスが DocumentDesigner を使用することを指定する DesignerAttribute と、Form カテゴリを指定する DesignerCategoryAttribute という 2 つの属性があります。

Visual Basic

<Designer("System.Windows.Forms.Design.DocumentDesigner, System.Windows.Forms.Design",
 _
    GetType(IRootDesigner)), DesignerCategory("Form")>
 _
Public Class MyForm
    
    Inherits ContainerControl
    ' Insert code here.
End Class 'MyForm

C#

[Designer("System.Windows.Forms.Design.DocumentDesigner, System.Windows.Forms.Design"
,
 
    typeof(IRootDesigner)),
    DesignerCategory("Form")]
    
 public class MyForm : ContainerControl {
    // Insert code here.
 }

C++

[Designer("System.Windows.Forms.Design.DocumentDesigner, System.Windows.Forms.Design"
,
IRootDesigner::typeid),
DesignerCategory("Form")]
ref class MyForm: public ContainerControl{
   // Insert code here.
};

J#

/** @attribute Designer("System.Windows.Forms.Design.DocumentDesigner, "
    + "System.Windows.Forms.Design", IRootDesigner.class)
    @attribute DesignerCategory("Form")
 */
public static class MyForm
 extends ContainerControl
{
    // Insert code here.
} //MyForm

MyForm のインスタンスを作成する例を次に示します。そのクラスの属性を取得し、DesignerCategoryAttribute を抽出してから、デザイナの名前を出力します。

Visual Basic

Public Shared Function Main()
 As Integer
    ' Creates a new form.
    Dim myNewForm As New
 MyForm()
    
    ' Gets the attributes for the collection.
    Dim attributes As AttributeCollection =
 TypeDescriptor.GetAttributes(myNewForm)
    
    ' Prints the name of the designer by retrieving the
    ' DesignerCategoryAttribute from the AttributeCollection. 
    Dim myAttribute As DesignerCategoryAttribute
 = _
        CType(attributes(GetType(DesignerCategoryAttribute)),
 DesignerCategoryAttribute)
    Console.WriteLine(("The category of the designer for this
 class is: " + myAttribute.Category))
    Return 0
End Function 'Main

C#

public static int Main()
 {
    // Creates a new form.
    MyForm myNewForm = new MyForm();
 
    // Gets the attributes for the collection.
    AttributeCollection attributes = TypeDescriptor.GetAttributes(myNewForm);
 
    /* Prints the name of the designer by retrieving the 
     * DesignerCategoryAttribute from the AttributeCollection. */
    DesignerCategoryAttribute myAttribute = 
       (DesignerCategoryAttribute)attributes[typeof(DesignerCategoryAttribute)];
    Console.WriteLine("The category of the designer for this
 class is: " + myAttribute.Category);
  
    return 0;
}

C++

int main()
{
   // Creates a new form.
   MyForm^ myNewForm = gcnew MyForm;

   // Gets the attributes for the collection.
   AttributeCollection^ attributes = TypeDescriptor::GetAttributes( myNewForm );

   /* Prints the name of the designer by retrieving the 
       * DesignerCategoryAttribute from the AttributeCollection. */
   DesignerCategoryAttribute^ myAttribute = dynamic_cast<DesignerCategoryAttribute^>(attributes[
 DesignerCategoryAttribute::typeid ]);
   Console::WriteLine( "The category of the designer for
 this class is: {0}", myAttribute->Category
 );
   return 0;
}

J#

public static void main(String[]
 args)
{
    // Creates a new form.
    MyForm myNewForm = new MyForm();

    // Gets the attributes for the collection.
    AttributeCollection attributes = 
        TypeDescriptor.GetAttributes(myNewForm);

    /* Prints the name of the designer by retrieving the 
       DesignerCategoryAttribute from the AttributeCollection. 
     */
    DesignerCategoryAttribute myAttribute = (DesignerCategoryAttribute)(
        attributes.get_Item(DesignerCategoryAttribute.class.ToType()));

    Console.WriteLine("The category of the designer " 
        + "for this class
 is: " + myAttribute.get_Category());
} //main

継承階層

System.Object
   System.Attribute
    System.ComponentModel.DesignerCategoryAttribute

スレッド セーフ

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
DesignerCategoryAttribute メンバ
System.ComponentModel 名前空間
Attribute
DesignerAttribute クラス