Share via


Role Element (DeploymentManifest)

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Represents an instance of a Windows SharePoint Services 3.0 deployment role (DeploymentRole) object.

DECLARATION
<xs:element name="Role" type="DeploymentRole" minOccurs="0" maxOccurs="unbounded" />

USAGE
<Roles>
        <Role
                RoleId="xs:string"
                Title="xs:string"
                Description="xs:string"
                PermMask="xs:string"
                Hidden="xs:boolean"
                RoleOrder="xs:string"
                Type="xs:string"
        />
</Roles>

Type

DeploymentRole (based on SPRole)

Attributes

Attribute

Type

Description

RoleId

xs:string

Required. Integer that specifies the member ID.

Title

xs:string

Required. Specifies the name for the role.

Description

xs:string

Optional. Provides a description of the role.

PermMask

xs:string

Required. Specifies a permission mask for the role.

Hidden

xs:boolean

Required. Specifies whether the role is hidden; true if the role is hidden, otherwise, false.

RoleOrder

xs:string

Optional. Specifies the order in which permission levels are displayed on the Permission Levels page of a site collection.

Type

xs:string

Optional. Specifies the role type, as listed in the Microsoft.SharePoint.SPRoleType enumeration.

Child Elements

None

Parent Elements

Roles Element (DeploymentManifest)

Remarks

The value of the RoleID property corresponds to the unique member ID for the role, which is specified in the SPMember.ID property of the SPMember class.

See Also

Reference

SPRole

SPMember

ID

SPRoleType

Concepts

DeploymentManifest Schema