TreeNodeCollection.SyncRoot Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets an object that can be used to synchronize access to the TreeNodeCollection object.
public:
property System::Object ^ SyncRoot { System::Object ^ get(); };
public object SyncRoot { get; }
member this.SyncRoot : obj
Public ReadOnly Property SyncRoot As Object
Property Value
A Object that can be used to synchronize access to the TreeNodeCollection.
Implements
Remarks
The SyncRoot property provides a synchronized version of the TreeNodeCollection that can be used with synchronizing (threading) code.
Caution
The IsSynchronized property of this class always returns false
, which indicates that the TreeNodeCollection class is not synchronized (not thread safe).
Synchronizing code must perform operations on the SyncRoot object of the TreeNodeCollection, not directly on the TreeNodeCollection itself. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the TreeNodeCollection object.
Note
The object returned in this implementation is the System.Collections.ArrayList object used to store the TreeNode objects in the collection.
Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads.
For more information on the SyncRoot property, see the ICollection.SyncRoot property of the System.Collections.ICollection interface.