RoleServiceManager Class

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.Extensions.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Configures the location of a custom implementation of the role service.

public ref class RoleServiceManager

[System.ComponentModel.TypeConverter(typeof(System.Web.UI.EmptyStringExpandableObjectConverter))]
public class RoleServiceManager

[<System.ComponentModel.TypeConverter(typeof(System.Web.UI.EmptyStringExpandableObjectConverter))>]
type RoleServiceManager = class

Public Class RoleServiceManager

Inheritance: Object
RoleServiceManager

Attributes: TypeConverterAttribute

Remarks

The RoleServiceManager class corresponds to the RoleService property of the ScriptManager or ScriptManagerProxy control.

The role Web service is used by AJAX-enabled applications to retrieve role information for the current authenticated user by using an asynchronous Web service call. You can use RoleServiceManager to provide the path of an alternative implementation of the role Web service instead of using the built-in Web service.

To use the role service in your application, you must enable it in the configuration file and declare it in the page. If you use the built-in role Web service, you have to enable it, but you do not have to explicitly declare the role service manager in the page.

To create a custom role service, you must implement a Web service that has two methods: GetRolesForCurrentUser and IsCurrentUserInRole. These methods must have the same signature as the corresponding methods of the built-in role Web service.

The following example shows the basic class structure that must be implemented in a custom role Web service class.

To use a custom role Web service, you can add the service declaratively in markup by putting a RoleService element inside the ScriptManager control, as shown in the following example.

<asp:ScriptManager ID="SM1" runat="server">  
  <RoleService Path="MyRoleService.asmx" LoadRoles="true" />  
</asp:ScriptManager>

You can also programmatically set the Path property to use a custom role Web service.

Constructors

RoleServiceManager()

Initializes a new instance of the RoleServiceManager class.

Properties

LoadRoles	Gets or sets a value that indicates whether the list of roles for the currently logged-on user must be retrieved.
Path	Gets or sets the path of the role service.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to