AuthenticationOptions.Group Property

Gets or sets user group name used to authenticate a user if document protection is enabled.

Namespace: DevExpress.XtraRichEdit

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

Declaration

C#

[DefaultValue("")]
public virtual string Group { get; set; }

VB.NET

<DefaultValue("")>
Public Overridable Property Group As String

Property Value

Type	Default	Description
String	String.Empty	A string containing a user group name.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to Group
WinForms Controls	SnapControlOptions	.Authentication.Group
	RichEditControlOptions	.Authentication.Group
WPF Controls	RichEditControlOptions	.Authentication.Group
Office File API	RichEditControlOptionsBase	.Authentication.Group
ASP.NET Web Forms Controls	ASPxRichEditSettings	.Authentication.Group

Remarks

Information provided by the Group property is used to allow editing of ranges with permissions in a protected document.

View Example

Related GitHub Examples

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

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#L116

MyUser myuser = myUserList.Find(s => s.UserName == username);
richEditControl1.Options.Authentication.Group = (myuser != null) ? myuser.Group : String.Empty;

how-to-create-protected-ranges-in-a-document-depending-on-service-bookmarks-t466775/CS/WindowsFormsApplication1/Form1.cs#L55

richEditControl1.Options.Authentication.UserName = "User";
richEditControl1.Options.Authentication.Group = "User";
richEditControl1.Options.RangePermissions.Visibility = DevExpress.XtraRichEdit.RichEditRangePermissionVisibility.Hidden;

range-permissions-simple-example-t445222/CS/RangePermissionsSimpleExample/Form1.cs#L75

richEditControl1.Options.Authentication.UserName = "Nancy Skywalker";
richEditControl1.Options.Authentication.Group = "Skywalkers";
#endregion #Authentication

VB.NET

protection-how-to-programmatically-create-a-protected-document-and-apply-range-permissions-e3017/VB/ReadOnlyRangesInCodeExample/Form1.vb#L112

Dim myuser As MyUser = myUserList.Find(Function(s) s.UserName = username)
richEditControl1.Options.Authentication.Group = If(myuser IsNot Nothing, myuser.Group, String.Empty)

how-to-create-protected-ranges-in-a-document-depending-on-service-bookmarks-t466775/VB/WindowsFormsApplication1/Form1.vb#L57

richEditControl1.Options.Authentication.UserName = "User"
richEditControl1.Options.Authentication.Group = "User"
richEditControl1.Options.RangePermissions.Visibility = DevExpress.XtraRichEdit.RichEditRangePermissionVisibility.Hidden

range-permissions-simple-example-t445222/VB/RangePermissionsSimpleExample/Form1.vb#L71

richEditControl1.Options.Authentication.UserName = "Nancy Skywalker"
richEditControl1.Options.Authentication.Group = "Skywalkers"
'            #End Region '#Authentication