UserPermissionCollection.Add Method
Definition
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.
Overloads
Add(String) |
Adds a new user to the current form. |
Add(String, PermissionType) |
Adds a new user with the specified permissions. |
Add(String, DateTime) |
Add a new user to the current form with an expiration date. |
Add(String, PermissionType, DateTime) |
Creates a new set of permissions on the current form for the specified user with the specified permissions and an expiration date. |
Add(String)
Adds a new user to the current form.
public:
abstract Microsoft::Office::InfoPath::UserPermission ^ Add(System::String ^ userId);
public abstract Microsoft.Office.InfoPath.UserPermission Add (string userId);
abstract member Add : string -> Microsoft.Office.InfoPath.UserPermission
Public MustOverride Function Add (userId As String) As UserPermission
Parameters
- userId
- String
The e-mail address in the format user@domain.com of the user to whom permissions on the current form are being granted.
Returns
A UserPermission object that represents the specified user.
Exceptions
The parameter passed to this method is a null reference (Nothing in Visual Basic).
The parameter passed to this method is not valid. For example, it is of the wrong type or format.
The form template is not configured for Full Trust using the Security and Trust category of the Form Options dialog box.
Examples
In the following example, clicking the Button control gets the UserPermissionsCollection for the current form, and then adds a new user.
public void CTRL1_Clicked(object sender, ClickedEventArgs e)
{
this.Permission.UserPermissions.Add("someone@example.com");
}
Public Sub CTRL1_Clicked(ByVal sender As Object, _
ByVal e As ClickedEventArgs)
Me.Permission.UserPermissions.Add("someone@example.com")
End Sub
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.
Applies to
Add(String, PermissionType)
Adds a new user with the specified permissions.
public:
abstract Microsoft::Office::InfoPath::UserPermission ^ Add(System::String ^ userId, Microsoft::Office::InfoPath::PermissionType permission);
public abstract Microsoft.Office.InfoPath.UserPermission Add (string userId, Microsoft.Office.InfoPath.PermissionType permission);
abstract member Add : string * Microsoft.Office.InfoPath.PermissionType -> Microsoft.Office.InfoPath.UserPermission
Public MustOverride Function Add (userId As String, permission As PermissionType) As UserPermission
Parameters
- userId
- 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
- PermissionType
The permissions on the current form that are being granted to the specified user as a combination of one or more PermissionType values.
Returns
A UserPermission.object that represents the specified user.
Exceptions
The parameter passed to this method is a null reference (Nothing in Visual Basic).
The parameter passed to this method is not valid. For example, it is of the wrong type or format.
The form template is not configured for Full Trust using the Security and Trust category of the Form Options dialog box.
Examples
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
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.
Applies to
Add(String, DateTime)
Add a new user to the current form with an expiration date.
public:
abstract Microsoft::Office::InfoPath::UserPermission ^ Add(System::String ^ userId, DateTime expirationDate);
public abstract Microsoft.Office.InfoPath.UserPermission Add (string userId, DateTime expirationDate);
abstract member Add : string * DateTime -> Microsoft.Office.InfoPath.UserPermission
Public MustOverride Function Add (userId As String, expirationDate As DateTime) As UserPermission
Parameters
- userId
- String
The e-mail address in the format user@domain.com of the user to whom permissions on the current form are being granted.
- expirationDate
- DateTime
The expiration date for the permissions that are being granted as a System.DateTime value.
Returns
A UserPermission object that represents the specified user.
Exceptions
The parameter passed to this method is a null reference (Nothing in Visual Basic).
The parameter passed to this method is not valid. For example, it is of the wrong type or format.
The form template is not configured for Full Trust using the Security and Trust category of the Form Options dialog box.
Examples
In the following example, clicking the Button control gets the UserPermissionsCollection for the current form, adds a new user to the current form, 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",
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", _
dtExpirationDate)
End Sub
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.
Applies to
Add(String, PermissionType, DateTime)
Creates a new set of permissions on the current form for the specified user with the specified permissions and an expiration date.
public:
abstract Microsoft::Office::InfoPath::UserPermission ^ Add(System::String ^ userId, Microsoft::Office::InfoPath::PermissionType permission, DateTime expirationDate);
public abstract Microsoft.Office.InfoPath.UserPermission Add (string userId, Microsoft.Office.InfoPath.PermissionType permission, DateTime expirationDate);
abstract member Add : string * Microsoft.Office.InfoPath.PermissionType * DateTime -> Microsoft.Office.InfoPath.UserPermission
Public MustOverride Function Add (userId As String, permission As PermissionType, expirationDate As DateTime) As UserPermission
Parameters
- userId
- 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
- 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
- DateTime
The expiration date for the permissions that are being granted as a System.DateTime value.
Returns
A UserPermission that represents the specified user.
Exceptions
The DateTime value provided is invalid.
The parameters passed to this method are a null reference (Nothing in Visual Basic).
The parameters passed to this method are not valid. For example, they are of the wrong type or format.
The form template is not configured for Full Trust using the Security and Trust category of the Form Options dialog box.
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
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.