UserPermissionCollection.Add Method (String, PermissionType) (Microsoft.Office.InfoPath)

Article
06/23/2010

Adds a new user with the specified permissions.

Namespace: Microsoft.Office.InfoPath
Assembly: Microsoft.Office.InfoPath (in microsoft.office.infopath.dll)

Syntax

'Declaration
Public MustOverride Function Add ( _
    userId As String, _
    permission As PermissionType _
) As UserPermission
'Usage
Dim instance As UserPermissionCollection
Dim userId As String
Dim permission As PermissionType
Dim returnValue As UserPermission

returnValue = instance.Add(userId, permission)

public abstract UserPermission Add (
    string userId,
    PermissionType permission
)

Parameters

userId
The e-mail address in the format user@domain.com of the user to whom permissions on the current form are being granted.

permission
The permissions on the current form that are being granted to the specified user as a combination of one or more PermissionType values.

Return Value

A UserPermission.object that represents the specified user.

Exceptions

Exception type	Condition
ArgumentNullException	The parameter passed to this method is null.
ArgumentException	The parameter passed to this method isnot valid. For example, it is of the wrong type or format.
SecurityException	The form template is not configured for Full Trust using the Security and Trust category of the Form Options dialog box.

Remarks

This member can be accessed only by forms opened from a form template that as been configured to run with full trust using the Security and Trust category of the Form Options dialog box. This member requires full trust for the immediate caller and cannot be used by partially trusted code. For more information, see "Using Libraries from Partially Trusted Code" on MSDN.

This type or member can be accessed only from code running in forms opened in Microsoft Office InfoPath 2007.

Example

In the following example, clicking the Button control gets the UserPermissionsCollection for the current form, and then adds and assigns a user to the Full Control access level.

public void CTRL1_Clicked(object sender, ClickedEventArgs e)
{
   this.Permission.UserPermissions.Add("someone@example.com", 
      PermissionType.FullControl);
}

Public Sub CTRL1_Clicked(ByVal sender As Object, _
   ByVal e As ClickedEventArgs)
   Me.Permission.UserPermissions.Add("someone@example.com", _
      PermissionType.FullControl)
End Sub