SiteMapNode.Roles Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Gets or sets a collection of roles that are associated with the SiteMapNode object, used during security trimming.

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

public IList Roles { get; set; }

Property Value

Type: System.Collections.IList

An IList of roles.

Exception Condition

The node is read-only.

If security trimming is enabled, a site map provider builds a node tree of nodes that the current user is able to view, based in part on whether the current user's assigned role is included in the Roles collection. URL authorization and file authorization are also used to determine whether a user has the rights to access a SiteMapNode object. For more information on authorization, see ASP.NET Authorization.

You can use the SiteMapNode constructor to supply a list of roles to the SiteMapNode object when it is first created.

.NET Framework
Available since 2.0
Return to top