SiteMapNodeCollection::ReadOnly Method (SiteMapNodeCollection^)

 

Returns a read-only collection that contains the nodes in the specified SiteMapNodeCollection collection.

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

public:
static SiteMapNodeCollection^ ReadOnly(
	SiteMapNodeCollection^ collection
)

Parameters

collection
Type: System.Web::SiteMapNodeCollection^

The SiteMapNodeCollection that contains the SiteMapNode objects to add to the read-only SiteMapNodeCollection.

Return Value

Type: System.Web::SiteMapNodeCollection^

A read-only SiteMapNodeCollection with the same SiteMapNode elements and structure as the original SiteMapNodeCollection.

Exception Condition
ArgumentNullException

collection is null.

You can test whether a SiteMapNodeCollection collection is read-only by checking the IsReadOnly property. The IsFixedSize property also returns true when a SiteMapNodeCollection is read-only.

Notes to Implementers:

A read-only SiteMapNodeCollection collection supports read and search operations, but does not support the Add, AddRange, Clear, Insert, Remove, and RemoveAt methods, nor the setter on the default indexer property, Item.

The following code example demonstrates how to use the IsReadOnly property to test whether a SiteMapNodeCollection collection is read-only or modifiable. If siteNodes is modifiable, MoveNode is called on it; otherwise, a clone SiteMapNodeCollection is created, using siteNodes as a base.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: