NodeLabelEditEventArgs

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

NodeLabelEditEventArgs クラス

BeforeLabelEdit イベントと AfterLabelEdit イベントのデータを提供します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Class NodeLabelEditEventArgs
    Inherits EventArgs

Visual Basic (使用法)

Dim instance As NodeLabelEditEventArgs

C#

public class NodeLabelEditEventArgs : EventArgs

C++

public ref class NodeLabelEditEventArgs : public
 EventArgs

J#

public class NodeLabelEditEventArgs extends
 EventArgs

JScript

public class NodeLabelEditEventArgs extends
 EventArgs

解説

AfterLabelEdit イベントは、ユーザーがツリー ノードのテキストを編集し終わったときに発生します。BeforeLabelEdit イベントは、ユーザーがツリー ノードのテキストを編集し始めたときに発生します。NodeLabelEditEventArgs オブジェクトは、ツリー ノードに関連付ける新しいテキスト、編集するラベルを保持しているツリー ノード、および編集操作がキャンセルされたかどうかを指定します。

イベント処理の詳細については、「イベントの利用」を参照してください。

使用例

ContextMenu を使用して、ユーザーがルート以外のツリー ノードを編集できるようにする例を次に示します。ユーザーがマウスを右クリックすると、ポインタ位置にある TreeNode が判断され、mySelectedNode という名前の変数に格納されます。ルート以外のツリー ノードが選択された場合、そのツリー ノードはユーザーが編集できる状態になります。ユーザーがツリー ノードのラベル編集を停止すると、新しいラベル テキストが評価され、保存されます。この例では、いくつかの文字がラベル テキストとして無効であると判断されます。ラベル文字列に無効な文字が 1 文字でも含まれている場合、または文字列が空の場合は、ユーザーにエラーが通知され、ラベル テキストは前の状態に戻されます。

Visual Basic

' Get the tree node under the mouse pointer and
' save it in the mySelectedNode variable. 
Private Sub treeView1_MouseDown(sender As
 Object, _
  e As System.Windows.Forms.MouseEventArgs)
        
   mySelectedNode = treeView1.GetNodeAt(e.X, e.Y)
End Sub    
    
Private Sub menuItem1_Click(sender As
 Object, e As System.EventArgs)
   If Not (mySelectedNode Is
 Nothing) And _
     Not (mySelectedNode.Parent Is Nothing)
 Then
      treeView1.SelectedNode = mySelectedNode
      treeView1.LabelEdit = True
      If Not mySelectedNode.IsEditing Then
         mySelectedNode.BeginEdit()
      End If
   Else
      MessageBox.Show("No tree node selected or selected node
 is a root node." & _
        Microsoft.VisualBasic.ControlChars.Cr & _
        "Editing of root nodes is not allowed.", "Invalid
 selection")
   End If
End Sub    
    
Private Sub treeView1_AfterLabelEdit(sender
 As Object, _
  e As System.Windows.Forms.NodeLabelEditEventArgs)
   If Not (e.Label Is Nothing)
 Then
      If e.Label.Length > 0 Then
         If e.Label.IndexOfAny(New Char()
 {"@"c, "."c, ","c,
 "!"c}) = -1 Then
            ' Stop editing without canceling the label change.
            e.Node.EndEdit(False)
         Else
            ' Cancel the label edit action, inform the user, and
            ' place the node in edit mode again. 
            e.CancelEdit = True
            MessageBox.Show("Invalid tree node label."
 & _
              Microsoft.VisualBasic.ControlChars.Cr & _
              "The invalid characters are: '@','.', ',', '!'",
 _
              "Node Label Edit")
            e.Node.BeginEdit()
         End If
      Else
         ' Cancel the label edit action, inform the user, and
         ' place the node in edit mode again. 
         e.CancelEdit = True
         MessageBox.Show("Invalid tree node label."
 & _
           Microsoft.VisualBasic.ControlChars.Cr & _
           "The label cannot be blank", "Node
 Label Edit")
           e.Node.BeginEdit()
      End If
         Me.treeView1.LabelEdit = False
   End If
End Sub 

C#

/* Get the tree node under the mouse pointer and 
   save it in the mySelectedNode variable. */
private void treeView1_MouseDown(object sender,
 
  System.Windows.Forms.MouseEventArgs e)
{
   mySelectedNode = treeView1.GetNodeAt(e.X, e.Y);
}

private void menuItem1_Click(object sender,
 System.EventArgs e)
{
   if (mySelectedNode != null && mySelectedNode.Parent
 != null)
   {
      treeView1.SelectedNode = mySelectedNode;
      treeView1.LabelEdit = true;
      if(!mySelectedNode.IsEditing)
      {
         mySelectedNode.BeginEdit();
      }
   }
   else
   {
      MessageBox.Show("No tree node selected or selected node is a root node.\n"
 + 
         "Editing of root nodes is not allowed.", "Invalid selection");
   }
}

private void treeView1_AfterLabelEdit(object
 sender, 
         System.Windows.Forms.NodeLabelEditEventArgs e)
{
   if (e.Label != null)
   {
     if(e.Label.Length > 0)
     {
        if (e.Label.IndexOfAny(new char[]{'@',
 '.', ',', '!'}) == -1)
        {
           // Stop editing without canceling the label change.
           e.Node.EndEdit(false);
        }
        else
        {
           /* Cancel the label edit action, inform the user, and 
              place the node in edit mode again. */
           e.CancelEdit = true;
           MessageBox.Show("Invalid tree node label.\n" + 
              "The invalid characters are: '@','.', ',', '!'", 
              "Node Label Edit");
           e.Node.BeginEdit();
        }
     }
     else
     {
        /* Cancel the label edit action, inform the user, and 
           place the node in edit mode again. */
        e.CancelEdit = true;
        MessageBox.Show("Invalid tree node label.\nThe label cannot be blank",
 
           "Node Label Edit");
        e.Node.BeginEdit();
     }
     this.treeView1.LabelEdit = false;
   }
}

C++

   /* Get the tree node under the mouse pointer and 
      save it in the mySelectedNode variable. */
private:
   void treeView1_MouseDown( Object^ /*sender*/, System::Windows::Forms::MouseEventArgs^
 e )
   {
      mySelectedNode = treeView1->GetNodeAt( e->X, e->Y );
   }

   void menuItem1_Click( Object^ /*sender*/, System::EventArgs^
 /*e*/ )
   {
      if ( mySelectedNode != nullptr && mySelectedNode->Parent
 != nullptr )
      {
         treeView1->SelectedNode = mySelectedNode;
         treeView1->LabelEdit = true;
         if (  !mySelectedNode->IsEditing )
         {
            mySelectedNode->BeginEdit();
         }
      }
      else
      {
         MessageBox::Show( String::Concat( "No tree node selected or selected
 node is a root node.\n",
            "Editing of root nodes is not allowed." ), "Invalid selection"
 );
      }
   }

   void treeView1_AfterLabelEdit( Object^ /*sender*/,
      System::Windows::Forms::NodeLabelEditEventArgs^ e )
   {
      if ( e->Label != nullptr )
      {
         if ( e->Label->Length > 0 )
         {
            array<Char>^ temp0 = {'@','.',',','!'};
            if ( e->Label->IndexOfAny( temp0 ) == -1 )
            {
               
               // Stop editing without canceling the label change.
               e->Node->EndEdit( false );
            }
            else
            {
               /* Cancel the label edit action, inform the user, and 
                  place the node in edit mode again. */
               e->CancelEdit = true;
               MessageBox::Show( String::Concat( "Invalid tree node label.\n"
,
                  "The invalid characters are: '@','.', ',', '!'" ),
                  "Node Label Edit" );
               e->Node->BeginEdit();
            }
         }
         else
         {
            /* Cancel the label edit action, inform the user, and 
               place the node in edit mode again. */
            e->CancelEdit = true;
            MessageBox::Show( "Invalid tree node label.\nThe label cannot be
 blank",
               "Node Label Edit" );
            e->Node->BeginEdit();
         }
         this->treeView1->LabelEdit = false;
      }
   }

J#

/* Get the tree node under the mouse pointer and 
   save it in the mySelectedNode variable. 
 */
private void treeView1_MouseDown(Object sender,
 
                                 System.Windows.Forms.MouseEventArgs e)
{
    mySelectedNode = treeView1.GetNodeAt(e.get_X(), e.get_Y());
} //treeView1_MouseDown

private void menuItem1_Click(Object sender,
 System.EventArgs e)
{
    if (mySelectedNode != null && mySelectedNode.get_Parent()
 != null) {
        treeView1.set_SelectedNode(mySelectedNode);
        treeView1.set_LabelEdit(true);
        if (!(mySelectedNode.get_IsEditing())) {
            mySelectedNode.BeginEdit();
        }
    }
    else {
        MessageBox.Show("No tree node selected or selected node"
            + "is a root node.\n" 
            + "Editing of root nodes is not allowed.", "Invalid selection");
    }
} //menuItem1_Click

private void treeView1_AfterLabelEdit(Object
 sender, 
                            System.Windows.Forms.NodeLabelEditEventArgs e)
{
    if (e.get_Label()!= null) {
        if (e.get_Label().length() > 0) {
            if (e.get_Label().IndexOfAny((new
 char[]{ '@', '.', ',', '!' }))
                == -1) {
                // Stop editing without canceling the label change.
                e.get_Node().EndEdit(false);
            }
            else {
                /* Cancel the label edit action, inform the user, and 
                   place the node in edit mode again. 
                 */
                e.set_CancelEdit(true);
                MessageBox.Show("Invalid tree node label.\n" 
                    + "The invalid characters are: "
                    + "'@','.', ',', '!'", "Node Label Edit");
                e.get_Node().BeginEdit();
            }
        }
        else {
            /* Cancel the label edit action, inform the user, and 
               place the node in edit mode again.
             */
            e.set_CancelEdit(true);
            MessageBox.Show("Invalid tree node label.\n"
                + "The label cannot be blank", "Node Label Edit");
            e.get_Node().BeginEdit();
        }
        this.treeView1.set_LabelEdit(false);
    }
} //treeView1_AfterLabelEdit

継承階層

System.Object
   System.EventArgs
    System.Windows.Forms.NodeLabelEditEventArgs

スレッド セーフ

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

参照

関連項目
NodeLabelEditEventArgs メンバ
System.Windows.Forms 名前空間
NodeLabelEditEventHandler
BeforeLabelEdit
AfterLabelEdit

NodeLabelEditEventArgs コンストラクタ (TreeNode, String)

指定した TreeNode と、ツリー ノード ラベルを更新するために指定したテキストの NodeLabelEditEventArgs クラスの新しいインスタンスを初期化します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    node As TreeNode, _
    label As String _
)

Visual Basic (使用法)

Dim node As TreeNode
Dim label As String

Dim instance As New NodeLabelEditEventArgs(node,
 label)

C#

public NodeLabelEditEventArgs (
    TreeNode node,
    string label
)

C++

public:
NodeLabelEditEventArgs (
    TreeNode^ node, 
    String^ label
)

J#

public NodeLabelEditEventArgs (
    TreeNode node, 
    String label
)

JScript

public function NodeLabelEditEventArgs (
    node : TreeNode, 
    label : String
)

パラメータ

node

編集するテキストを保持しているツリー ノード。

label

ツリー ノードに関連付けられる新しいテキスト。

解説

Node プロパティには node パラメータの値、Label プロパティには label パラメータの値が代入されます。

プラットフォーム

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

参照

関連項目
NodeLabelEditEventArgs クラス
NodeLabelEditEventArgs メンバ
System.Windows.Forms 名前空間
TreeNode
Text

NodeLabelEditEventArgs コンストラクタ

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

名前	説明
NodeLabelEditEventArgs (TreeNode)	指定した TreeNode の NodeLabelEditEventArgs クラスの新しいインスタンスを初期化します。
NodeLabelEditEventArgs (TreeNode, String)	指定した TreeNode と、ツリー ノード ラベルを更新するために指定したテキストの NodeLabelEditEventArgs クラスの新しいインスタンスを初期化します。

参照

関連項目

NodeLabelEditEventArgs クラス
NodeLabelEditEventArgs メンバ
System.Windows.Forms 名前空間
TreeNode

NodeLabelEditEventArgs コンストラクタ (TreeNode)

指定した TreeNode の NodeLabelEditEventArgs クラスの新しいインスタンスを初期化します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    node As TreeNode _
)

Visual Basic (使用法)

Dim node As TreeNode

Dim instance As New NodeLabelEditEventArgs(node)

C#

public NodeLabelEditEventArgs (
    TreeNode node
)

C++

public:
NodeLabelEditEventArgs (
    TreeNode^ node
)

J#

public NodeLabelEditEventArgs (
    TreeNode node
)

JScript

public function NodeLabelEditEventArgs (
    node : TreeNode
)

パラメータ

node

編集するテキストを保持しているツリー ノード。

解説

Node プロパティには、node パラメータの値が代入されます。

プラットフォーム

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

参照

関連項目
NodeLabelEditEventArgs クラス
NodeLabelEditEventArgs メンバ
System.Windows.Forms 名前空間
TreeNode

NodeLabelEditEventArgs プロパティ

パブリック プロパティ

	名前	説明
	CancelEdit	編集がキャンセルされたかどうかを示す値を取得または設定します。
	Label	ツリー ノードに関連付ける新しいテキストを取得します。
	Node	編集するテキストを保持しているツリー ノードを取得します。

参照

関連項目

NodeLabelEditEventArgs クラス
System.Windows.Forms 名前空間
NodeLabelEditEventHandler
BeforeLabelEdit
AfterLabelEdit

NodeLabelEditEventArgs メソッド

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

NodeLabelEditEventArgs クラス
System.Windows.Forms 名前空間
NodeLabelEditEventHandler
BeforeLabelEdit
AfterLabelEdit

NodeLabelEditEventArgs メンバ

BeforeLabelEdit イベントと AfterLabelEdit イベントのデータを提供します。

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

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

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

パブリック プロパティ

	名前	説明
	CancelEdit	編集がキャンセルされたかどうかを示す値を取得または設定します。
	Label	ツリー ノードに関連付ける新しいテキストを取得します。
	Node	編集するテキストを保持しているツリー ノードを取得します。

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

NodeLabelEditEventArgs クラス
System.Windows.Forms 名前空間
NodeLabelEditEventHandler
BeforeLabelEdit
AfterLabelEdit