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

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

public function get Roles () : IList

public function set Roles (value : IList)

Not applicable.

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 Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions