TreeView.BeforeCheck Event
Assembly: System.Windows.Forms (in system.windows.forms.dll)
'Declaration Public Event BeforeCheck As TreeViewCancelEventHandler 'Usage Dim instance As TreeView Dim handler As TreeViewCancelEventHandler AddHandler instance.BeforeCheck, handler
/** @event */ public void add_BeforeCheck (TreeViewCancelEventHandler value) /** @event */ public void remove_BeforeCheck (TreeViewCancelEventHandler value)
JScript supports the use of events, but not the declaration of new ones.
Note |
|---|
| Setting the TreeNode.Checked property from within the BeforeCheck or AfterCheck event causes the event to be raised multiple times and can result in unexpected behavior. For example, you might set the Checked property in the event handler when you are recursively updating the child nodes, so the user does not have to expand and check each one individually. To prevent the event from being raised multiple times, add logic to your event handler that only executes your recursive code if the Action property of the TreeViewEventArgs is not set to TreeViewAction.Unknown. |
For more information about handling events, see Consuming Events.
The following code example updates all the child tree nodes of a TreeNode when the user changes its checked state. This code requires that you have a Form with a TreeView that has TreeNode objects in its TreeNodeCollection. The TreeNodeCollection should have tree nodes with child nodes.
' 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
// 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
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
Note