SubDocument.BeginUpdateRangePermissions() Method

Gets the collection of all range permissions in the current document.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v18.2.Core.dll

Declaration

C#

RangePermissionCollection BeginUpdateRangePermissions()

VB.NET

Function BeginUpdateRangePermissions As RangePermissionCollection

Returns

Type	Description
RangePermissionCollection	A RangePermissionCollection containing range permissions for the document.

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

Form1.vb

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

Form1.cs

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
using DevExpress.XtraRichEdit.Services;
        void richEditControl1_DocumentLoaded(object sender, EventArgs e)
        {
            UpdateUserNameLoginCombo();
            richEditControl1.Options.Authentication.UserName = String.Empty;
        }
        private void UpdateUserNameLoginCombo()
        {
            cmbUserName.SelectedValueChanged-=cmbUserName_SelectedValueChanged;
            RangePermissionCollection rangePermissions = richEditControl1.Document.BeginUpdateRangePermissions();
            richEditControl1.Document.CancelUpdateRangePermissions(rangePermissions);
            List<String> users = new List<string>();
            foreach (RangePermission rangePermission in rangePermissions)
            {
                string userName = rangePermission.UserName;
                if (users.Contains(userName))
                    continue;
                if (!String.IsNullOrEmpty(userName))
                    users.Add(userName);
            }
            cmbUserName.Properties.BeginUpdate();
            cmbUserName.Properties.Items.Clear();
            cmbUserName.Properties.Items.Add(String.Empty);
            cmbUserName.Properties.Items.AddRange(users);
            foreach (MyUser user in myUserList) {
                if (!users.Contains(user.UserName)) cmbUserName.Properties.Items.Add(user.UserName);
            }
            cmbUserName.SelectedIndex = 0;
            cmbUserName.Properties.EndUpdate();
            cmbUserName.SelectedValueChanged += cmbUserName_SelectedValueChanged;
        }

        private void cmbUserName_SelectedValueChanged(object sender, EventArgs e)
        {
            string username = cmbUserName.SelectedItem.ToString();
            richEditControl1.Options.Authentication.UserName = username;
            MyUser myuser = myUserList.Find(s => s.UserName == username);
            richEditControl1.Options.Authentication.Group = (myuser != null) ? myuser.Group : String.Empty;

        }

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BeginUpdateRangePermissions() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

protection-how-to-programmatically-create-a-protected-document-and-apply-range-permissions-e3017/CS/ReadOnlyRangesInCodeExample/Form1.cs#L43

// Protect document ranges.
RangePermissionCollection rangePermissions = richEditControl1.Document.BeginUpdateRangePermissions();
rangePermissions.AddRange(CreateRangePermissions(rangeAdmin, String.Empty, "[e-mail]", "Nancy Skywalker"));

word-document-api-examples/CS/CodeExamples/ProtectionActions.cs#L59

// Protect document range
RangePermissionCollection rangePermissions = document.BeginUpdateRangePermissions();
RangePermission rp = rangePermissions.CreateRangePermission(document.Paragraphs[3].Range);

VB.NET

word-document-api-examples/VB/CodeExamples/ProtectionActions.vb#L54

' Protect document range
Dim rangePermissions As RangePermissionCollection = document.BeginUpdateRangePermissions()
Dim rp As RangePermission = rangePermissions.CreateRangePermission(document.Paragraphs(3).Range)