DesignerActionPropertyItem

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

DesignerActionPropertyItem クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

DesignerActionList から派生したクラスのプロパティに関連付けられているパネル項目を表します。このクラスは継承できません。

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

Visual Basic (宣言)

Public NotInheritable Class
 DesignerActionPropertyItem
    Inherits DesignerActionItem

Visual Basic (使用法)

Dim instance As DesignerActionPropertyItem

C#

public sealed class DesignerActionPropertyItem
 : DesignerActionItem

C++

public ref class DesignerActionPropertyItem
 sealed : public DesignerActionItem

J#

public final class DesignerActionPropertyItem
 extends DesignerActionItem

JScript

public final class DesignerActionPropertyItem
 extends DesignerActionItem

解説

DesignerActionPropertyItem クラスは、スマート タグ パネル内の個別の項目を表します。各項目は通常、DesignerActionList クラスから派生したクラスのプロパティに関連付けられており、コンポーネント作成者によって提供されます。この関連付けは、MemberName プロパティに格納されたプロパティの名前をとおして保持されます。

個々のパネル項目は、DesignerActionList クラスの GetSortedActionItems メソッドへの呼び出しによってまとめて関連付けられ、パネルを形成します。

関連付けられたプロパティの値を表示するには、そのプロパティが get アクセサ メソッドを持っている必要があります。また、編集を行うには、そのプロパティが set アクセサ メソッドを持っている必要があります。ユーザーがパネルでプロパティ項目を直接編集できるようにする方法は、関連付けられているプロパティのデータ型のサポートされている型情報によって異なります。該当する方法を次の表に示します。

プロパティの型情報	プロパティ項目を編集するユーザー インターフェイス (UI)
関連付けられている型エディタ (UITypeEditor) を持つ。	プロパティの値を編集するために、基になるプロパティに関連付けられている型エディタが表示されます。
関連付けられている、既知の型への型コンバータ (TypeConverter) を持つ。	プロパティの値を編集するために、既知の型の型エディタが表示されます。たとえば、String への型コンバータは、TextBox を表示します。
Boolean 値。	項目は、チェック マークなどのバイナリ UI を使用して表示されます。
上記以外。	項目は、データ型の ToString メソッドを使用して、編集不可能なテキスト文字列として表示されます。

すべての基本型 (System.Boolean など) および一般的な .NET Framework データ型 (System.String など) は、標準の型コンバータと型エディタを提供します。型コンバータの詳細については、方法 : 型コンバータを実装する または 一般的な型変換 のトピックを参照してください。型エディタの詳細については、「方法 : UI 型エディタを実装する」を参照してください。

使用例

DesignerActionItem オブジェクトのコレクションを作成する方法を次のコード例に示します。スマート タグを実装するコード例の全体については、「方法 : Windows フォーム コンポーネントにスマート タグを追加する」を参照してください。

Visual Basic

Public Overrides Function
 GetSortedActionItems() _
As DesignerActionItemCollection
    Dim items As New DesignerActionItemCollection()

    'Define static section header entries.
    items.Add(New DesignerActionHeaderItem("Appearance"))
    items.Add(New DesignerActionHeaderItem("Information"))

    'Boolean property for locking color selections.
    items.Add(New DesignerActionPropertyItem( _
    "LockColors", _
    "Lock Colors", _
    "Appearance", _
    "Locks the color properties."))

    If Not LockColors Then
        items.Add( _
        New DesignerActionPropertyItem( _
        "BackColor", _
        "Back Color", _
        "Appearance", _
        "Selects the background color."))

        items.Add( _
        New DesignerActionPropertyItem( _
        "ForeColor", _
        "Fore Color", _
        "Appearance", _
        "Selects the foreground color."))

        'This next method item is also added to the context menu 
        ' (as a designer verb).
        items.Add( _
        New DesignerActionMethodItem( _
        Me, _
        "InvertColors", _
        "Invert Colors", _
        "Appearance", _
        "Inverts the fore and background colors.",
 _
        True))
    End If
    items.Add( _
    New DesignerActionPropertyItem( _
    "Text", _
    "Text String", _
    "Appearance", _
    "Sets the display text."))

    'Create entries for static Information section.
    Dim location As New
 StringBuilder("Location: ")
    location.Append(colLabel.Location)
    Dim size As New StringBuilder("Size:
 ")
    size.Append(colLabel.Size)

    items.Add( _
    New DesignerActionTextItem( _
    location.ToString(), _
    "Information"))

    items.Add( _
    New DesignerActionTextItem( _
    size.ToString(), _
    "Information"))

    Return items
End Function

C#

public override DesignerActionItemCollection GetSortedActionItems()
{
    DesignerActionItemCollection items = new DesignerActionItemCollection();

    //Define static section header entries.
    items.Add(new DesignerActionHeaderItem("Appearance"));
    items.Add(new DesignerActionHeaderItem("Information"));

    //Boolean property for locking color selections.
    items.Add(new DesignerActionPropertyItem("LockColors"
,
                     "Lock Colors", "Appearance",
                     "Locks the color properties."));
    if (!LockColors)
    {
        items.Add(new DesignerActionPropertyItem("BackColor"
,
                         "Back Color", "Appearance",
                         "Selects the background color."));
        items.Add(new DesignerActionPropertyItem("ForeColor"
,
                         "Fore Color", "Appearance",
                         "Selects the foreground color."));

        //This next method item is also added to the context menu 
        // (as a designer verb).
        items.Add(new DesignerActionMethodItem(this
,
                         "InvertColors", "Invert Colors",
                         "Appearance",
                         "Inverts the fore and background colors.",
                          true));
    }
    items.Add(new DesignerActionPropertyItem("Text"
,
                     "Text String", "Appearance",
                     "Sets the display text."));

    //Create entries for static Information section.
    StringBuilder location = new StringBuilder("Location:
 ");
    location.Append(colLabel.Location);
    StringBuilder size = new StringBuilder("Size: ");
    size.Append(colLabel.Size);
    items.Add(new DesignerActionTextItem(location.ToString(),
                     "Information"));
    items.Add(new DesignerActionTextItem(size.ToString(),
                     "Information"));

    return items;
}

継承階層

System.Object
   System.ComponentModel.Design.DesignerActionItem
    System.ComponentModel.Design.DesignerActionPropertyItem

スレッド セーフ

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
DesignerActionPropertyItem メンバ
System.ComponentModel.Design 名前空間
MemberName
DesignerActionList クラス
GetSortedActionItems
その他の技術情報
Windows フォームのデザイナ コマンドと DesignerAction オブジェクト モデル

DesignerActionPropertyItem コンストラクタ (String, String, String, String)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

指定したプロパティ名とカテゴリ名、および表示テキストと説明テキストを使用して、DesignerActionPropertyItem クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    memberName As String, _
    displayName As String, _
    category As String, _
    description As String _
)

Visual Basic (使用法)

Dim memberName As String
Dim displayName As String
Dim category As String
Dim description As String

Dim instance As New DesignerActionPropertyItem(memberName,
 displayName, category, description)

C#

public DesignerActionPropertyItem (
    string memberName,
    string displayName,
    string category,
    string description
)

C++

public:
DesignerActionPropertyItem (
    String^ memberName, 
    String^ displayName, 
    String^ category, 
    String^ description
)

J#

public DesignerActionPropertyItem (
    String memberName, 
    String displayName, 
    String category, 
    String description
)

JScript

public function DesignerActionPropertyItem
 (
    memberName : String, 
    displayName : String, 
    category : String, 
    description : String
)

パラメータ

memberName

このパネル項目に関連付けられているプロパティの、大文字と小文字が区別される名前。

displayName

この項目のパネル テキスト。

category

パネル上の同様の項目をグループ化するために使用する、大文字と小文字が区別される String。

description

ツールヒントやステータス バーで使用する、この項目の補足テキスト。

解説

category パラメータを使用してパネルの項目をグループ化する方法の詳細については、GetSortedActionItems メソッドのトピックを参照してください。

memberName パラメータは、DesignerActionList クラスから派生したプログラマ指定のクラスのメンバである、関連付けられているプロパティの名前を参照します。

使用例

DesignerActionItem オブジェクトのコレクションを作成する方法を次のコード例に示します。スマート タグを実装するコード例の全体については、「方法 : Windows フォーム コンポーネントにスマート タグを追加する」を参照してください。

Visual Basic

Public Overrides Function
 GetSortedActionItems() _
As DesignerActionItemCollection
    Dim items As New DesignerActionItemCollection()

    'Define static section header entries.
    items.Add(New DesignerActionHeaderItem("Appearance"))
    items.Add(New DesignerActionHeaderItem("Information"))

    'Boolean property for locking color selections.
    items.Add(New DesignerActionPropertyItem( _
    "LockColors", _
    "Lock Colors", _
    "Appearance", _
    "Locks the color properties."))

    If Not LockColors Then
        items.Add( _
        New DesignerActionPropertyItem( _
        "BackColor", _
        "Back Color", _
        "Appearance", _
        "Selects the background color."))

        items.Add( _
        New DesignerActionPropertyItem( _
        "ForeColor", _
        "Fore Color", _
        "Appearance", _
        "Selects the foreground color."))

        'This next method item is also added to the context menu 
        ' (as a designer verb).
        items.Add( _
        New DesignerActionMethodItem( _
        Me, _
        "InvertColors", _
        "Invert Colors", _
        "Appearance", _
        "Inverts the fore and background colors.",
 _
        True))
    End If
    items.Add( _
    New DesignerActionPropertyItem( _
    "Text", _
    "Text String", _
    "Appearance", _
    "Sets the display text."))

    'Create entries for static Information section.
    Dim location As New
 StringBuilder("Location: ")
    location.Append(colLabel.Location)
    Dim size As New StringBuilder("Size:
 ")
    size.Append(colLabel.Size)

    items.Add( _
    New DesignerActionTextItem( _
    location.ToString(), _
    "Information"))

    items.Add( _
    New DesignerActionTextItem( _
    size.ToString(), _
    "Information"))

    Return items
End Function

C#

public override DesignerActionItemCollection GetSortedActionItems()
{
    DesignerActionItemCollection items = new DesignerActionItemCollection();

    //Define static section header entries.
    items.Add(new DesignerActionHeaderItem("Appearance"));
    items.Add(new DesignerActionHeaderItem("Information"));

    //Boolean property for locking color selections.
    items.Add(new DesignerActionPropertyItem("LockColors"
,
                     "Lock Colors", "Appearance",
                     "Locks the color properties."));
    if (!LockColors)
    {
        items.Add(new DesignerActionPropertyItem("BackColor"
,
                         "Back Color", "Appearance",
                         "Selects the background color."));
        items.Add(new DesignerActionPropertyItem("ForeColor"
,
                         "Fore Color", "Appearance",
                         "Selects the foreground color."));

        //This next method item is also added to the context menu 
        // (as a designer verb).
        items.Add(new DesignerActionMethodItem(this
,
                         "InvertColors", "Invert Colors",
                         "Appearance",
                         "Inverts the fore and background colors.",
                          true));
    }
    items.Add(new DesignerActionPropertyItem("Text"
,
                     "Text String", "Appearance",
                     "Sets the display text."));

    //Create entries for static Information section.
    StringBuilder location = new StringBuilder("Location:
 ");
    location.Append(colLabel.Location);
    StringBuilder size = new StringBuilder("Size: ");
    size.Append(colLabel.Size);
    items.Add(new DesignerActionTextItem(location.ToString(),
                     "Information"));
    items.Add(new DesignerActionTextItem(size.ToString(),
                     "Information"));

    return items;
}

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
DesignerActionPropertyItem クラス
DesignerActionPropertyItem メンバ
System.ComponentModel.Design 名前空間
DesignerActionList クラス
GetSortedActionItems
その他の技術情報
Windows フォームのデザイナ コマンドと DesignerAction オブジェクト モデル

DesignerActionPropertyItem コンストラクタ (String, String)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

プロパティ名と表示名を指定して、DesignerActionPropertyItem クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    memberName As String, _
    displayName As String _
)

Visual Basic (使用法)

Dim memberName As String
Dim displayName As String

Dim instance As New DesignerActionPropertyItem(memberName,
 displayName)

C#

public DesignerActionPropertyItem (
    string memberName,
    string displayName
)

C++

public:
DesignerActionPropertyItem (
    String^ memberName, 
    String^ displayName
)

J#

public DesignerActionPropertyItem (
    String memberName, 
    String displayName
)

JScript

public function DesignerActionPropertyItem
 (
    memberName : String, 
    displayName : String
)

パラメータ

memberName

このパネル項目に関連付けられているプロパティの、大文字と小文字が区別される名前。

displayName

この項目のパネル テキスト。

解説

DesignerActionPropertyItem(String,String) コンストラクタは、Category プロパティと Description プロパティを null 参照 (Visual Basic では Nothing) に設定します。

memberName パラメータは、DesignerActionList クラスから派生したプログラマ指定のクラスのメンバである、関連付けられているプロパティの名前を参照します。

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
DesignerActionPropertyItem クラス
DesignerActionPropertyItem メンバ
System.ComponentModel.Design 名前空間
DesignerActionList クラス
その他の技術情報
Windows フォームのデザイナ コマンドと DesignerAction オブジェクト モデル

DesignerActionPropertyItem コンストラクタ

DesignerActionPropertyItem クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
DesignerActionPropertyItem (String, String)	プロパティ名と表示名を指定して、DesignerActionPropertyItem クラスの新しいインスタンスを初期化します。
DesignerActionPropertyItem (String, String, String)	指定したプロパティ名とカテゴリ名、および表示テキストを使用して、DesignerActionPropertyItem クラスの新しいインスタンスを初期化します。
DesignerActionPropertyItem (String, String, String, String)	指定したプロパティ名とカテゴリ名、および表示テキストと説明テキストを使用して、DesignerActionPropertyItem クラスの新しいインスタンスを初期化します。

参照

関連項目

DesignerActionPropertyItem クラス
DesignerActionPropertyItem メンバ
System.ComponentModel.Design 名前空間
DesignerActionList クラス

その他の技術情報

Windows フォームのデザイナ コマンドと DesignerAction オブジェクト モデル

DesignerActionPropertyItem コンストラクタ (String, String, String)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

指定したプロパティ名とカテゴリ名、および表示テキストを使用して、DesignerActionPropertyItem クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    memberName As String, _
    displayName As String, _
    category As String _
)

Visual Basic (使用法)

Dim memberName As String
Dim displayName As String
Dim category As String

Dim instance As New DesignerActionPropertyItem(memberName,
 displayName, category)

C#

public DesignerActionPropertyItem (
    string memberName,
    string displayName,
    string category
)

C++

public:
DesignerActionPropertyItem (
    String^ memberName, 
    String^ displayName, 
    String^ category
)

J#

public DesignerActionPropertyItem (
    String memberName, 
    String displayName, 
    String category
)

JScript

public function DesignerActionPropertyItem
 (
    memberName : String, 
    displayName : String, 
    category : String
)

パラメータ

memberName

このパネル項目に関連付けられているプロパティの、大文字と小文字が区別される名前。

displayName

この項目のパネル テキスト。

category

パネル上の同様の項目をグループ化するために使用する、大文字と小文字が区別される String。

解説

DesignerActionPropertyItem(String,String,String) コンストラクタは、Description プロパティを null 参照 (Visual Basic では Nothing) に設定します。

category パラメータを使用してパネルの項目をグループ化する方法の詳細については、GetSortedActionItems メソッドのトピックを参照してください。

memberName パラメータは、DesignerActionList から派生したプログラマ指定のクラスのメンバである、関連付けられているプロパティの名前を参照します。

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
DesignerActionPropertyItem クラス
DesignerActionPropertyItem メンバ
System.ComponentModel.Design 名前空間
DesignerActionList クラス
GetSortedActionItems
その他の技術情報
Windows フォームのデザイナ コマンドと DesignerAction オブジェクト モデル

DesignerActionPropertyItem プロパティ

パブリック プロパティ

	名前	説明
	AllowAssociate	この項目を同じ Category プロパティ値を持つ項目のグループに配置できるかどうかを示す値を取得または設定します。 ( DesignerActionItem から継承されます。)
	Category	項目のグループ名を取得します。 ( DesignerActionItem から継承されます。)
	Description	項目の補足テキストを取得します。 ( DesignerActionItem から継承されます。)
	DisplayName	この項目のテキストを取得します。 ( DesignerActionItem から継承されます。)
	MemberName	この項目が関連付けられているプロパティの名前を取得します。
	Properties	プログラマ定義のキーと値のペアを格納するために使用できるコレクションへの参照を取得します。 ( DesignerActionItem から継承されます。)
	RelatedComponent	現在のパネルに項目を提供するコンポーネントを取得または設定します。

参照

関連項目

DesignerActionPropertyItem クラス
System.ComponentModel.Design 名前空間
MemberName
DesignerActionList クラス
GetSortedActionItems

その他の技術情報

Windows フォームのデザイナ コマンドと DesignerAction オブジェクト モデル

DesignerActionPropertyItem メソッド

パブリック メソッド

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

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

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

参照

関連項目

DesignerActionPropertyItem クラス
System.ComponentModel.Design 名前空間
MemberName
DesignerActionList クラス
GetSortedActionItems

その他の技術情報

Windows フォームのデザイナ コマンドと DesignerAction オブジェクト モデル

DesignerActionPropertyItem メンバ

DesignerActionList から派生したクラスのプロパティに関連付けられているパネル項目を表します。このクラスは継承できません。

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

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

	名前	説明
	DesignerActionPropertyItem	オーバーロードされます。 DesignerActionPropertyItem クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	AllowAssociate	この項目を同じ Category プロパティ値を持つ項目のグループに配置できるかどうかを示す値を取得または設定します。(DesignerActionItem から継承されます。)
	Category	項目のグループ名を取得します。(DesignerActionItem から継承されます。)
	Description	項目の補足テキストを取得します。(DesignerActionItem から継承されます。)
	DisplayName	この項目のテキストを取得します。(DesignerActionItem から継承されます。)
	MemberName	この項目が関連付けられているプロパティの名前を取得します。
	Properties	プログラマ定義のキーと値のペアを格納するために使用できるコレクションへの参照を取得します。(DesignerActionItem から継承されます。)
	RelatedComponent	現在のパネルに項目を提供するコンポーネントを取得または設定します。

パブリック メソッド

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

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

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

参照

関連項目

DesignerActionPropertyItem クラス
System.ComponentModel.Design 名前空間
MemberName
DesignerActionList クラス
GetSortedActionItems

その他の技術情報

Windows フォームのデザイナ コマンドと DesignerAction オブジェクト モデル