This documentation is archived and is not being maintained.

SiteMapNode.Roles Property

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.

ExceptionCondition
InvalidOperationException

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 #ctor(SiteMapProvider, String, String, String, String, IList, NameValueCollection, NameValueCollection) constructor to supply a list of roles to the SiteMapNode object when it is first created.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: