Back to Devexpress

RichEditDocumentServer.SaveDocument(String, DocumentFormat, EncryptionSettings) Method

officefileapi-devexpress-dot-xtrarichedit-dot-richeditdocumentserver-dot-savedocument-x28-system-dot-string-devexpress-dot-xtrarichedit-dot-documentformat-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-encryptionsettings-x29.md

latest4.2 KB
Original Source

RichEditDocumentServer.SaveDocument(String, DocumentFormat, EncryptionSettings) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

Saves the document to a file, specifying the document’s format and encryption options.

Namespace : DevExpress.XtraRichEdit

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
public void SaveDocument(
    string fileName,
    DocumentFormat documentFormat,
    EncryptionSettings encryptionSettings
)
vb
Public Sub SaveDocument(
    fileName As String,
    documentFormat As DocumentFormat,
    encryptionSettings As EncryptionSettings
)

Parameters

NameTypeDescription
fileNameString

A file name.

| | documentFormat | DocumentFormat |

Indicates the document format.

| | encryptionSettings | EncryptionSettings |

Document encryption options.

|

Remarks

Use this SaveDocument method overload to encrypt a document with a password, as shown below:

csharp
EncryptionSettings encryptionSettings = new EncryptionSettings();
encryptionSettings.Type = EncryptionType.Strong;
encryptionSettings.Password = "12345";

server.Document.SaveDocument(fileName, documentFormat, encryptionSettings);
vb
Dim encryptionSettings As EncryptionSettings = New EncryptionSettings()
encryptionSettings.Type = EncryptionType.Strong
encryptionSettings.Password = "12345"
server.Document.SaveDocument(fileName, documentFormat, encryptionSettings)

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SaveDocument(String, DocumentFormat, EncryptionSettings) 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.

word-document-api-open-and-save-encrypted-files/CS/Program.cs#L40

csharp
server.SaveDocument(fileName, documentFormat, encryptionOptions);

word-document-api-open-and-save-encrypted-files/VB/Program.vb#L32

vb
Dim fileName As String = String.Format("EncryptedwithNewPassword.{0}", answerFormat)
server.SaveDocument(fileName, documentFormat, encryptionOptions)
Console.WriteLine("The document is saved with new password. Continue? (y/n)")

See Also

How to: Open And Save Encrypted Files (GitHub)

RichEditDocumentServer Class

RichEditDocumentServer Members

DevExpress.XtraRichEdit Namespace