RichEditDocumentImportOptions.EncryptionPassword Property

Specifies a password used to unprotect a password-protected document during import.

Namespace: DevExpress.XtraRichEdit.Import

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

public string EncryptionPassword { get; set; }

VB.NET

Public Property EncryptionPassword As String

Property Value

Type	Description
String	The target password.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to EncryptionPassword
WinForms Controls	SnapControlOptions	.Import .EncryptionPassword
	RepositoryItemRichTextEdit	.OptionsImport .EncryptionPassword
	RichEditControlOptions	.Import .EncryptionPassword
WPF Controls	RichEditControlOptions	.Import .EncryptionPassword
Office File API	RichEditControlOptionsBase	.Import .EncryptionPassword

Remarks

The EncryptionPassword property specifies a password to open a password-encrypted document.
If the EncryptionPassword property is not specified or returns an invalid password, the EncryptedFilePasswordRequested event fires.

The code sample below shows how to specify the password to load an encrypted file.

C#

server.Options.Import.EncryptionPassword = "test";
server.LoadDocument("Documents//testEncrypted.docx");

VB.NET

  server.Options.Import.EncryptionPassword = "test"
  server.LoadDocument("Documents//testEncrypted.docx")

Related GitHub Examples

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

document-encryption-simple-example/CS/RichEditControl_Encryption/Form1.cs#L30

    //Specify the password to load an encrypted file
    richEditControl1.Options.Import.EncryptionPassword = "test";
}

VB.NET

document-encryption-simple-example/VB/RichEditControl_Encryption/Form1.vb#L28

    'Specify the password to load an encrypted file
    richEditControl1.Options.Import.EncryptionPassword = "test"
End Sub