This documentation is archived and is not being maintained.

LoginView.RoleGroups Property

Gets a collection of role groups that associate content templates with particular roles.

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

abstract RoleGroups : RoleGroupCollection
override RoleGroups : RoleGroupCollection

Property Value

Type: System.Web.UI.WebControls.RoleGroupCollection
A RoleGroupCollection object that contains the defined role-group templates.

The RoleGroups property contains the content templates associated with various roles on the Web site. The collection in the RoleGroups property is searched in the order in which templates are defined in the source. The first matching role-group template is displayed to the user. If a user is a member of more than one role, the first role-group template that matches any of the user's roles is used. If more than one template is associated with a single role, only the first defined template will be used.

If a logged-in user does not belong to any role contained in the role-group collection, the site displays the content template specified in the LoggedInTemplate property. Anonymous users are never shown any template contained in the RoleGroups collection.

You must configure role management to use the RoleGroups property to define templates based on the user's role on the Web site. For more information, see Understanding Role Management.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

The following code example demonstrates using the RoleGroups collection. Because the AnonymousTemplate and LoggedInTemplate properties are not set, the content is displayed only to users who belong to roles with a defined content template.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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