TreeView.BeforeCheck イベント

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

TreeView.BeforeCheck イベント

ツリー ノードのチェック ボックスがオンにされる前に発生します。

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

Visual Basic (宣言)

Public Event BeforeCheck As
 TreeViewCancelEventHandler

Visual Basic (使用法)

Dim instance As TreeView
Dim handler As TreeViewCancelEventHandler

AddHandler instance.BeforeCheck, handler

C#

public event TreeViewCancelEventHandler BeforeCheck

C++

public:
event TreeViewCancelEventHandler^ BeforeCheck {
    void add (TreeViewCancelEventHandler^ value);
    void remove (TreeViewCancelEventHandler^ value);
}

J#

/** @event */
public void add_BeforeCheck (TreeViewCancelEventHandler
 value)

/** @event */
public void remove_BeforeCheck (TreeViewCancelEventHandler
 value)

JScript

JScript では、イベントは使用できますが、新規に宣言することはできません。

解説

メモ
TreeNode.Checked プロパティを BeforeCheck イベント内または AfterCheck イベント内から設定すると、イベントが複数回発生することになり、予期できない動作を引き起こす可能性があります。たとえば、子ノードを再帰的に更新するときは、イベント ハンドラで Checked プロパティを設定することによって、ユーザーは各ノードを展開してチェックする必要がなくなります。イベントが複数回発生することを防ぐためには、TreeViewEventArgs の Action プロパティが TreeViewAction.Unknown に設定されていない場合に、再帰コードだけを実行するロジックをイベント ハンドラに追加します。

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

使用例

ユーザーがチェック状態を変更したときに TreeNode のすべての子ツリー ノードを更新するコード例を次に示します。このコードは、TreeNode オブジェクトの TreeNodeCollection を持つ TreeView が、Form に配置されていることを前提としています。TreeNodeCollection は、子ノードを持つツリー ノードを持っている必要があります。

Visual Basic

' Updates all child tree nodes recursively.
Private Sub CheckAllChildNodes(treeNode As
 TreeNode, nodeChecked As Boolean)
   Dim node As TreeNode
   For Each node In  treeNode.Nodes
 
      node.Checked = nodeChecked
      If node.Nodes.Count > 0 Then
         ' If the current node has child nodes, call the CheckAllChildsNodes
 method recursively.
         Me.CheckAllChildNodes(node, nodeChecked)
      End If
   Next node
End Sub
      
' NOTE   This code can be added to the BeforeCheck event handler instead
 of the AfterCheck event.
' After a tree node's Checked property is changed, all its child nodes
 are updated to the same value.
Private Sub node_AfterCheck(sender As
 Object, e As TreeViewEventArgs) Handles
 treeView1.AfterCheck
   ' The code only executes if the user caused the checked state to
 change.
   If e.Action <> TreeViewAction.Unknown Then
 
      If e.Node.Nodes.Count > 0 Then
         ' Calls the CheckAllChildNodes method, passing in the current
 
         ' Checked value of the TreeNode whose checked state changed.
 
         Me.CheckAllChildNodes(e.Node, e.Node.Checked)
      End If
   End If
End Sub 

C#

// Updates all child tree nodes recursively.
private void CheckAllChildNodes(TreeNode treeNode,
 bool nodeChecked)
{
   foreach(TreeNode node in treeNode.Nodes)
   {
      node.Checked = nodeChecked;
      if(node.Nodes.Count > 0)
      {
         // If the current node has child nodes, call the CheckAllChildsNodes
 method recursively.
         this.CheckAllChildNodes(node, nodeChecked);
      }
   }
}

// NOTE   This code can be added to the BeforeCheck event handler instead
 of the AfterCheck event.
// After a tree node's Checked property is changed, all its child nodes
 are updated to the same value.
private void node_AfterCheck(object sender,
 TreeViewEventArgs e)
{
   // The code only executes if the user caused the checked state to
 change.
   if(e.Action != TreeViewAction.Unknown)
   {
      if(e.Node.Nodes.Count > 0)
      {
         /* Calls the CheckAllChildNodes method, passing in the
 current 
         Checked value of the TreeNode whose checked state changed. */
         this.CheckAllChildNodes(e.Node, e.Node.Checked);
      }
   }
}

C++

// Updates all child tree nodes recursively.
void CheckAllChildNodes( TreeNode^ treeNode, bool
 nodeChecked )
{
   IEnumerator^ myEnum = treeNode->Nodes->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      TreeNode^ node = safe_cast<TreeNode^>(myEnum->Current);
      node->Checked = nodeChecked;
      if ( node->Nodes->Count > 0 )
      {
         
         // If the current node has child nodes, call the CheckAllChildsNodes
 method recursively.
         this->CheckAllChildNodes( node, nodeChecked );
      }
   }
}

// NOTE   This code can be added to the BeforeCheck event handler instead
 of the AfterCheck event.
// After a tree node's Checked property is changed, all its child nodes
 are updated to the same value.
void node_AfterCheck( Object^ /*sender*/, TreeViewEventArgs^ e
 )
{
   // The code only executes if the user caused the checked state to
 change.
   if ( e->Action != TreeViewAction::Unknown )
   {
      if ( e->Node->Nodes->Count > 0 )
      {
         /* Calls the CheckAllChildNodes method, passing in the
 current
             Checked value of the TreeNode whose checked state changed. */
         this->CheckAllChildNodes( e->Node, e->Node->Checked
 );
      }
   }
}

J#

// Updates all child tree nodes recursively.
private void CheckAllChildNodes(TreeNode treeNode,
 boolean nodeChecked)
{
    for (int iCtr = 0; iCtr < treeNode.get_Nodes().get_Count();
 iCtr++) {
        TreeNode node = treeNode.get_Nodes().get_Item(iCtr);
        node.set_Checked(nodeChecked);
        if (node.get_Nodes().get_Count() > 0) {
            // If the current node has child nodes, call the
            // CheckAllChildsNodes method recursively.
            this.CheckAllChildNodes(node, nodeChecked);
        }
    }
} //CheckAllChildNodes

// NOTE This code can be added to the BeforeCheck event handler instead
 
// of the AfterCheck event. After a tree node's Checked property is
 
// changed, all its child nodes are updated to the same value.
private void Node_AfterCheck(Object sender,
 TreeViewEventArgs e)
{
    // The code only executes if the user caused the checked state to
 change.
    if (!(e.get_Action().Equals(TreeViewAction.Unknown))) {
        if (e.get_Node().get_Nodes().get_Count() > 0) {
            /* Calls the CheckAllChildNodes method, passing in the
 current 
               Checked value of the TreeNode whose checked state changed. */
            this.CheckAllChildNodes(e.get_Node(), e.get_Node().get_Checked());
        }
    }
} //Node_AfterCheck

プラットフォーム

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

参照

関連項目
TreeView クラス
TreeView メンバ
System.Windows.Forms 名前空間
TreeView.CheckBoxes プロパティ
OnBeforeCheck
TreeView.AfterCheck イベント
OnAfterCheck