TreeNodeCollection.Find(String, Boolean) Method

Definition

Finds the tree nodes with specified key, optionally searching subnodes.

public:
 cli::array <System::Windows::Forms::TreeNode ^> ^ Find(System::String ^ key, bool searchAllChildren);
public System.Windows.Forms.TreeNode[] Find (string key, bool searchAllChildren);
member this.Find : string * bool -> System.Windows.Forms.TreeNode[]
Public Function Find (key As String, searchAllChildren As Boolean) As TreeNode()

Parameters

key
String

The name of the tree node to search for.

searchAllChildren
Boolean

true to search child nodes of tree nodes; otherwise, false.

Returns

An array of TreeNode objects whose Name property matches the specified key.

Exceptions

.NET 5 and later: key is null or empty.

Remarks

The Name property corresponds to the key for a TreeNode in the TreeNodeCollection.

The key comparison is not case-sensitive. If the key parameter is null or an empty string, or there are no matches, the Item[] property returns an empty array.

Applies to