AuthenticationOptions.UserName Property

Gets or sets a 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 UserName { get; set; }

VB.NET

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

Property Value

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

Property Paths

You can access this nested property as listed below:

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

Remarks

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the UserName 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#L83

    UpdateUserNameLoginCombo();
    richEditControl1.Options.Authentication.UserName = String.Empty;
}

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

document.Protect("123");
richEditControl1.Options.Authentication.UserName = "User";
richEditControl1.Options.Authentication.Group = "User";

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

//Define the user credentials:
richEditControl1.Options.Authentication.UserName = "Nancy Skywalker";
richEditControl1.Options.Authentication.Group = "Skywalkers";

VB.NET

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

    UpdateUserNameLoginCombo()
    richEditControl1.Options.Authentication.UserName = String.Empty
End Sub

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

document.Protect("123")
richEditControl1.Options.Authentication.UserName = "User"
richEditControl1.Options.Authentication.Group = "User"

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

'Define the user credentials:
richEditControl1.Options.Authentication.UserName = "Nancy Skywalker"
richEditControl1.Options.Authentication.Group = "Skywalkers"