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 オブジェクト モデル