Edit

Share via


SiteMapNode.Roles Property

Definition

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

public:
 property System::Collections::IList ^ Roles { System::Collections::IList ^ get(); void set(System::Collections::IList ^ value); };
public System.Collections.IList Roles { get; set; }
member this.Roles : System.Collections.IList with get, set
Public Property Roles As IList

Property Value

An IList of roles.

Exceptions

The node is read-only.

Remarks

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.

Applies to

See also