SyncRoot Property
Collapse the table of content
Expand the table of content

MenuItemCollection.SyncRoot Property

 

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

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

public object SyncRoot { get; }

Property Value

Type: System.Object

An Object that can be used to synchronize access to the MenuItemCollection.

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

System_CAPS_cautionCaution

The IsSynchronized property of this class always returns false, which indicates that the MenuItemCollection class is not synchronized (not thread safe).

Synchronizing code must perform operations on the SyncRoot object of the MenuItemCollection collection, not directly on the MenuItemCollection object 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 MenuItemCollection object.

System_CAPS_noteNote

The object returned in this implementation is the ArrayList object used to store the MenuItem 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, causing 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 SyncRoot property of the ICollection interface.

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft