DesignerActionItem

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

DesignerActionItem クラス

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

スマート タグ パネルのパネル項目を表す型の基本クラスを提供します。

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

Visual Basic (宣言)

Public MustInherit Class
 DesignerActionItem

Visual Basic (使用法)

Dim instance As DesignerActionItem

C#

public abstract class DesignerActionItem

C++

public ref class DesignerActionItem abstract

J#

public abstract class DesignerActionItem

JScript

public abstract class DesignerActionItem

解説

DesignerActionItem クラスは、スマート タグのメニューに似たユーザー インターフェイス (UI) を表すスマート タグ パネル内の個々のパネル項目を表すクラスの抽象基本クラスとして機能します。.NET Framework は、スマート タグ パネル内のさまざまな共通エントリ (関連付けられた DesignerActionList クラスのプレーン テキスト、ヘッダー テキスト、プロパティ、およびメソッドと、デザイナ動詞など) を表す派生クラスを提供します。

通常、DesignerAction 機能は、個々のパネル項目をグループ化してスマート タグ パネルを構成する GetSortedActionItems メソッドを格納する DesignerActionList から派生した、プログラマ指定のクラスで定義されます。DesignerActionPropertyItem 型および DesignerActionMethodItem 型は、DesignerActionList から派生したクラスのメンバに関連付けられ、DesignerActionMethodItem オブジェクトは、関連付けられたパネル エントリをユーザーが選択するとアクティブ化されます。

メモ
フォームとダイアログ ボックスは、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;
}

継承階層

System.Object
  System.ComponentModel.Design.DesignerActionItem
     System.ComponentModel.Design.DesignerActionMethodItem
     System.ComponentModel.Design.DesignerActionPropertyItem
     System.ComponentModel.Design.DesignerActionTextItem

スレッド セーフ

この型の 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

参照

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

DesignerActionItem コンストラクタ

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

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

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

Visual Basic (宣言)

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

Visual Basic (使用法)

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

Dim instance As New DesignerActionItem(displayName,
 category, description)

C#

public DesignerActionItem (
    string displayName,
    string category,
    string description
)

C++

public:
DesignerActionItem (
    String^ displayName, 
    String^ category, 
    String^ description
)

J#

public DesignerActionItem (
    String displayName, 
    String category, 
    String description
)

JScript

public function DesignerActionItem (
    displayName : String, 
    category : String, 
    description : String
)

パラメータ

displayName

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

category

パネル エントリのグループ化を定義する、大文字と小文字が区別される String。

description

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

解説

DesignerActionItem は抽象クラスであるため、DesignerActionItem コンストラクタは派生クラスからのみ呼び出されます。

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

.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

参照

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

DesignerActionItem プロパティ

パブリック プロパティ

	名前	説明
	AllowAssociate	この項目を同じ Category プロパティ値を持つ項目のグループに配置できるかどうかを示す値を取得または設定します。
	Category	項目のグループ名を取得します。
	Description	項目の補足テキストを取得します。
	DisplayName	この項目のテキストを取得します。
	Properties	プログラマ定義のキーと値のペアを格納するために使用できるコレクションへの参照を取得します。

参照

関連項目

DesignerActionItem クラス
System.ComponentModel.Design 名前空間
DesignerActionList
GetSortedActionItems
DesignerVerb

その他の技術情報

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

DesignerActionItem メソッド

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

DesignerActionItem クラス
System.ComponentModel.Design 名前空間
DesignerActionList
GetSortedActionItems
DesignerVerb

その他の技術情報

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

DesignerActionItem メンバ

スマート タグ パネルのパネル項目を表す型の基本クラスを提供します。

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

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

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

パブリック プロパティ

	名前	説明
	AllowAssociate	この項目を同じ Category プロパティ値を持つ項目のグループに配置できるかどうかを示す値を取得または設定します。
	Category	項目のグループ名を取得します。
	Description	項目の補足テキストを取得します。
	DisplayName	この項目のテキストを取得します。
	Properties	プログラマ定義のキーと値のペアを格納するために使用できるコレクションへの参照を取得します。

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

DesignerActionItem クラス
System.ComponentModel.Design 名前空間
DesignerActionList
GetSortedActionItems
DesignerVerb

その他の技術情報

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