TreeViewCancelEventArgs Class
Collapse the table of content
Expand the table of content

TreeViewCancelEventArgs Class


Provides data for the BeforeCheck, BeforeCollapse, BeforeExpand, and BeforeSelect events of a TreeView control.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)


public class TreeViewCancelEventArgs : CancelEventArgs

System_CAPS_pubmethodTreeViewCancelEventArgs(TreeNode, Boolean, TreeViewAction)

Initializes a new instance of the TreeViewCancelEventArgs class with the specified tree node, a value specifying whether the event is to be canceled, and the type of tree view action that raised the event.


Gets the type of TreeView action that raised the event.


Gets or sets a value indicating whether the event should be canceled.(Inherited from CancelEventArgs.)


Gets the tree node to be checked, expanded, collapsed, or selected.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

For more information about handling events, see Handling and Raising Events.

The following example demonstrates how to change the collapse state of a TreeView so that all the checked nodes are visible. First, all the nodes are collapsed, and a handler is added to the TreeView.BeforeExpand event. Next, all the nodes are expanded. The TreeView.BeforeExpand event handler determines whether a given node has child nodes that are checked. If a node does not have checked children, the expansion is canceled for that node. In order to allow normal node expansion when the plus sign next to a node is clicked, the TreeView.BeforeExpand event handler is then removed.

This behavior can also be implemented by handling the TreeView.BeforeCollapse event, as illustrated in the example for that topic.

For the complete example, see the TreeView.CheckBoxes reference topic.

private void showCheckedNodesButton_Click(object sender, EventArgs e)
    // Disable redrawing of treeView1 to prevent flickering 
    // while changes are made.

    // Collapse all nodes of treeView1.

    // Add the checkForCheckedChildren event handler to the BeforeExpand event.
    treeView1.BeforeExpand += checkForCheckedChildren;

    // Expand all nodes of treeView1. Nodes without checked children are 
    // prevented from expanding by the checkForCheckedChildren event handler.

    // Remove the checkForCheckedChildren event handler from the BeforeExpand 
    // event so manual node expansion will work correctly.
    treeView1.BeforeExpand -= checkForCheckedChildren;

    // Enable redrawing of treeView1.

// Prevent expansion of a node that does not have any checked child nodes.
private void CheckForCheckedChildrenHandler(object sender, 
    TreeViewCancelEventArgs e)
    if (!HasCheckedChildNodes(e.Node)) e.Cancel = true;

// Returns a value indicating whether the specified 
// TreeNode has checked child nodes.
private bool HasCheckedChildNodes(TreeNode node)
    if (node.Nodes.Count == 0) return false;
    foreach (TreeNode childNode in node.Nodes)
        if (childNode.Checked) return true;
        // Recursively check the children of the current child node.
        if (HasCheckedChildNodes(childNode)) return true;
    return false;

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
© 2015 Microsoft