UserPermissionCollection.Add method (String, PermissionType, DateTime)

Article
06/02/2015

Creates a new set of permissions on the current form for the specified user with the specified permissions and an expiration date.

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, _
    expirationDate As DateTime _
) As UserPermission
'Usage
Dim instance As UserPermissionCollection
Dim userId As String
Dim permission As PermissionType
Dim expirationDate As DateTime
Dim returnValue As UserPermission

returnValue = instance.Add(userId, permission, _
    expirationDate)

public abstract UserPermission Add(
    string userId,
    PermissionType permission,
    DateTime expirationDate
)

Parameters

userId
Type: System.String

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

permission
Type: Microsoft.Office.InfoPath.PermissionType

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

expirationDate
Type: System.DateTime

The expiration date for the permissions that are being granted as a System.DateTime value.

Return value

Type: Microsoft.Office.InfoPath.UserPermission
A UserPermission that represents the specified user.

Exceptions

Exception	Condition
FormatException	The DateTime value provided is invalid.
ArgumentNullException	The parameters passed to this method are a null reference (Nothing in Visual Basic).
ArgumentException	The parameters passed to this method are not valid. For example, they are 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 has 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 InfoPath Filler.

Examples

In the following example, clicking the Button control gets the UserPermissionsCollection for the current form, adds and assigns a user to the Full Control access level, and sets an expiration date of two days from the current date.

public void CTRL1_Clicked(object sender, ClickedEventArgs e)
{
   string strExpirationDate = DateTime.Today.AddDays(2).ToString();
   DateTime dtExpirationDate = DateTime.Parse(strExpirationDate);

   this.Permission.UserPermissions.Add("someone@example.com", 
      PermissionType.FullControl, dtExpirationDate);
}

Public Sub CTRL1_Clicked(ByVal sender As Object, _
   ByVal e As ClickedEventArgs)
   Dim strExpirationDate As String = _
      DateTime.Today.AddDays(2).ToString()
   dtExpirationDate As DateTime = DateTime.Parse(strExpirationDate)

   Me.Permission.UserPermissions.Add("someone@example.com", _
      PermissionType.FullControl, dtExpirationDate)
End Sub

Share via