DesignerActionList.GetSortedActionItems メソッド

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

DesignerActionList.GetSortedActionItems メソッド

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

リストに含まれる DesignerActionItem オブジェクトのコレクションを返します。

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

Visual Basic (宣言)

Public Overridable Function
 GetSortedActionItems As DesignerActionItemCollection

Visual Basic (使用法)

Dim instance As DesignerActionList
Dim returnValue As DesignerActionItemCollection

returnValue = instance.GetSortedActionItems

C#

public virtual DesignerActionItemCollection GetSortedActionItems
 ()

C++

public:
virtual DesignerActionItemCollection^ GetSortedActionItems ()

J#

public DesignerActionItemCollection GetSortedActionItems ()

JScript

public function GetSortedActionItems () : DesignerActionItemCollection

戻り値
このリスト内の項目を含む DesignerActionItem 配列。

解説

virtual GetSortedActionItems メソッドは、DesignerActionItem クラスから派生したオブジェクトのコレクションを予測した表示順序で返すために実装されます。これらの項目には、次の特定の型を指定できます。

型	説明
DesignerActionHeaderItem	グループ ラベル。太字で表示されます。
DesignerActionTextItem	ラベル。プレーン フォントで表示されます。
DesignerActionPropertyItem	プロパティに関連付けられたパネル項目。チェック マークまたは基になるプロパティに関連付けられたプロパティ エディタも表示できます。
DesignerActionMethodItem	ハイパーリンクとして表示され、メソッドに関連付けられたパネル項目。

すべての DesignerActionMethodItem および DesignerActionPropertyItem では、対応するメソッドまたはプロパティを、DesignerActionList クラスから派生したプログラマ指定のクラスに追加する必要があります。各メソッド アイテムとプロパティ項目は、アクティブ エントリとして表示されます。ユーザー インターフェイス (UI) を介してアクティブ エントリと対話することによって、それぞれ対応するメソッドまたはプロパティが呼び出されます。

プロパティ項目には、対応するプロパティ値を表示し、操作できるようにする特別なパネル項目インターフェイスがあります。詳細については、DesignerActionPropertyItem クラスのトピックを参照してください。

返される配列内の項目の順序は、パネルに表示される順序を反映します。項目は、次の規則を使用して、Category プロパティに従ってグループ化されます。

• 出現する最初の項目のカテゴリは、最初のグループの開始を示します。後続する各項目が同じカテゴリである限り、そのグループが続きます。別の新しいカテゴリの項目が出現すると、新しいグループが作成され、その項目はこの新しいグループに配置されます。

• 項目が現在のグループとは異なる型を持っており、そのカテゴリが既に使用されている場合、その項目は一致する既存のカテゴリに配置されます。

• 項目がカテゴリを持たない場合、パネルの最後にあるその他のグループに配置されます。このグループには、AllowAssociate プロパティに false が設定されている項目も格納されます。

GetSortedActionItems メソッドは、パネルが初めて作成されたときに呼び出されます。Refresh メソッドを呼び出して、パネルに表示される項目のリストを更新する必要があります。

使用例

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

参照

関連項目
DesignerActionList クラス
DesignerActionList メンバ
System.ComponentModel.Design 名前空間
DesignerActionItem クラス
DesignerActionItem.Category プロパティ
DesignerActionItem.AllowAssociate プロパティ
PropertyDescriptor クラス