AuthenticationOptions Class
Represents a set of credentials used to identify editable ranges in a protected document.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.RichEdit.v18.2.Core.dll
Declaration
Related API Members
The following members return AuthenticationOptions objects:
Remarks
This code snippet demonstrates how you can fetch usernames assigned to protected ranges in a document and identify the current user as being one of the particular users. It allows you to edit the range with editing permissions granted to that user.
The SubDocument.BeginUpdateRangePermissions method is used to get all permissions for document ranges. Call the SubDocument.CancelUpdateRangePermissions if you do not intend to modify them.
Then, we traverse the collection of range permissions and obtain user names via the RangePermission.UserName property. The ComboBoxEdit control is filled with the names, so an existing name can be selected to log in.
To log in (i.e. to specify the user whose permissions will be in effect), the RichEditControlOptionsBase.Authentication options are used.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/protection-how-to-programmatically-create-a-protected-document-and-apply-range-permissions-e3017
Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
Imports DevExpress.XtraRichEdit.Services
Private Sub richEditControl1_DocumentLoaded(ByVal sender As Object, ByVal e As EventArgs)
UpdateUserNameLoginCombo()
richEditControl1.Options.Authentication.UserName = String.Empty
End Sub
Private Sub UpdateUserNameLoginCombo()
RemoveHandler cmbUserName.SelectedValueChanged, AddressOf cmbUserName_SelectedValueChanged
Dim rangePermissions As RangePermissionCollection = richEditControl1.Document.BeginUpdateRangePermissions()
richEditControl1.Document.CancelUpdateRangePermissions(rangePermissions)
Dim users As New List(Of String)()
For Each rangePermission As RangePermission In rangePermissions
Dim userName As String = rangePermission.UserName
If users.Contains(userName) Then
Continue For
End If
If Not String.IsNullOrEmpty(userName) Then
users.Add(userName)
End If
Next rangePermission
cmbUserName.Properties.BeginUpdate()
cmbUserName.Properties.Items.Clear()
cmbUserName.Properties.Items.Add(String.Empty)
cmbUserName.Properties.Items.AddRange(users)
For Each user As MyUser In myUserList
If Not users.Contains(user.UserName) Then
cmbUserName.Properties.Items.Add(user.UserName)
End If
Next user
cmbUserName.SelectedIndex = 0
cmbUserName.Properties.EndUpdate()
AddHandler cmbUserName.SelectedValueChanged, AddressOf cmbUserName_SelectedValueChanged
End Sub
Private Sub cmbUserName_SelectedValueChanged(ByVal sender As Object, ByVal e As EventArgs) Handles cmbUserName.SelectedValueChanged
Dim username As String = cmbUserName.SelectedItem.ToString()
richEditControl1.Options.Authentication.UserName = username
Dim myuser As MyUser = myUserList.Find(Function(s) s.UserName = username)
richEditControl1.Options.Authentication.Group = If(myuser IsNot Nothing, myuser.Group, String.Empty)
End Sub