officefileapi-devexpress-dot-xtrarichedit-dot-richeditdocumentserver-dot-savedocument-x28-system-dot-string-devexpress-dot-xtrarichedit-dot-documentformat-x29.md
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 control’s document to a file, specifying the document’s format.
Namespace : DevExpress.XtraRichEdit
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
public virtual void SaveDocument(
string fileName,
DocumentFormat documentFormat
)
Public Overridable Sub SaveDocument(
fileName As String,
documentFormat As DocumentFormat
)
| Name | Type | Description |
|---|---|---|
| fileName | String |
A string value specifying the path to a file into which to save the control’s document.
| | documentFormat | DocumentFormat |
One of the DocumentFormat enumeration values.
|
Use the RichEditControl.Options.Export property to set global export options, or handle the RichEditDocumentServer.BeforeExport event to specify options for an individual export action.
When the specified document format requires that a certain type of content should be saved as external objects, as is the case for HTML format, the proper use of the SaveDocument becomes more complex. You can specify whether images are embedded in HTML code, using the HtmlDocumentExporterOptions.EmbedImages property or provide a custom IUriProvider to construct src references for images.
Note
The SaveDocument method call does not automatically change the RichEditDocumentServer.Modified property value.
The following code snippets (auto-collected from DevExpress Examples) contain references to the SaveDocument(String, DocumentFormat) 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-examples/CS/CodeExamples/ProtectionActions.cs#L46
// Save and open the protected document.
wordProcessor.SaveDocument("ResultProtected.docx", DocumentFormat.OpenXml);
System.Diagnostics.Process.Start("ResultProtected.docx");
word-processing-table-of-contents-practical-guide/CS/Program.cs#L48
string documentName = "Employees_with_Styles_TOC.docx";
wordProcessor.SaveDocument(documentName, DocumentFormat.OpenXml);
Console.WriteLine(documentName+" is created");
word-processing-merge-documents-with-different-headers-and-footers/CS/Helpers/DocumentsMerger.cs#L24
{
targetServer.SaveDocument(outputFileName, DocumentFormat.OpenXml);
return outputFileName;
word-document-api-create-master-detail-report/CS/MergeProcessor.cs#L62
mainRichEdit.MailMerge(resultRichEdit.Document);
resultRichEdit.SaveDocument("result.docx", DocumentFormat.OpenXml);
}
word-document-api-insert-inline-pictures/CS/Program.cs#L44
// Save the resulting document.
wordProcessor.SaveDocument("InlinePictures.docx", DocumentFormat.OpenXml);
}
word-document-api-examples/VB/CodeExamples/ProtectionActions.vb#L39
' Save and open the protected document.
wordProcessor.SaveDocument("ResultProtected.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
System.Diagnostics.Process.Start("ResultProtected.docx")
word-processing-table-of-contents-practical-guide/VB/Program.vb#L46
Dim documentName As String = "Employees_with_Styles_TOC.docx"
wordProcessor.SaveDocument(documentName, DocumentFormat.OpenXml)
Console.WriteLine(documentName & " is created")
word-processing-merge-documents-with-different-headers-and-footers/VB/Helpers/DocumentsMerger.vb#L21
If i = filenames.Count - 1 Then
targetServer.SaveDocument(outputFileName, DocumentFormat.OpenXml)
Return outputFileName
word-document-api-create-master-detail-report/VB/MergeProcessor.vb#L58
mainRichEdit.MailMerge(resultRichEdit.Document)
resultRichEdit.SaveDocument("result.docx", DocumentFormat.OpenXml)
End Sub
word-document-api-insert-inline-pictures/VB/Program.vb#L37
' Save the resulting document.
wordProcessor.SaveDocument("InlinePictures.docx", DocumentFormat.OpenXml)
End Using
See Also