This documentation is archived and is not being maintained.

SiteMapNode.Roles Property

Note: This property is new in the .NET Framework version 2.0.

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 */
public IList get_Roles ()

/** @property */
public void set_Roles (IList value)

public function get Roles () : IList

public function set Roles (value : IList)

Property Value

An IList of roles.

Exception typeCondition


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.

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0