TreeNodeCollection::SyncRoot Property

 

Gets an object that can be used to synchronize access to the TreeNodeCollection object.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public:
property Object^ SyncRoot {
	virtual Object^ get() sealed;
}

Property Value

Type: System::Object^

A System::Object that can be used to synchronize access to the TreeNodeCollection.

The SyncRoot property provides a synchronized version of the TreeNodeCollection that can be used with synchronizing (threading) code.

System_CAPS_cautionCaution

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.

System_CAPS_noteNote

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.

.NET Framework
Available since 2.0
Return to top
Show: