SubDocument.CancelUpdateRangePermissions(RangePermissionCollection) Method

Finalizes the update process, leaving range permissions intact.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

void CancelUpdateRangePermissions(
    RangePermissionCollection permissions
)

VB.NET

Sub CancelUpdateRangePermissions(
    permissions As RangePermissionCollection
)

Parameters

Name	Type	Description
permissions	RangePermissionCollection	A RangePermissionCollection containing range permissions being updated.

Remarks

Use the CancelUpdateRangePermissions method after a call to the SubDocument.BeginUpdateRangePermissions to finalize the update and discard the changes.

If you do not plan to modify range permissions, use the SubDocument.BeginUpdateRangePermissions method to obtain them, and the CancelUpdateRangePermissions method to indicate that no modifications will occur. To modify permissions, finalize the process with the SubDocument.EndUpdateRangePermissions method instead.

Tip

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=T445222.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CancelUpdateRangePermissions(RangePermissionCollection) 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#L89

RangePermissionCollection rangePermissions = richEditControl1.Document.BeginUpdateRangePermissions();
richEditControl1.Document.CancelUpdateRangePermissions(rangePermissions);
List<String> users = new List<string>();