officefileapi-devexpress-dot-spreadsheet-dot-workbook-dot-savedocument-x28-system-dot-string-devexpress-dot-spreadsheet-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 document to a file in the specified document format.
You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Namespace : DevExpress.Spreadsheet
Assembly : DevExpress.Docs.v25.2.dll
NuGet Package : DevExpress.Document.Processor
public void SaveDocument(
string fileName,
DocumentFormat format
)
Public Sub SaveDocument(
fileName As String,
format As DocumentFormat
)
| Name | Type | Description |
|---|---|---|
| fileName | String |
Specifies the file path to save the document.
| | format | DocumentFormat |
A DocumentFormat enumeration value that specifies the document’s format.
|
Use the Workbook.Options.Export property or Workbook.BeforeExport event to specify export options.
The default calculation mode for a Workbook is Manual. This mode implies that the Spreadsheet does not calculate formulas before it saves a document. Call the Workbook.Calculate or Workbook.CalculateFull method to calculate all formulas in the workbook.
Call the Workbook.SaveDocument method with the specified file path to save a workbook to the file. Specify the file format as the second parameter of the method using the DocumentFormat enumerator.
// Add a reference to the DevExpress.Docs.dll assembly.
using DevExpress.Spreadsheet;
// ...
Workbook workbook = new Workbook();
// ...
// Save the modified document to the file.
workbook.SaveDocument("Documents\\SavedDocument.xlsx", DocumentFormat.Xlsx);
' Add a reference to the DevExpress.Docs.dll assembly.
Imports DevExpress.Spreadsheet
' ...
Dim workbook As New Workbook()
' ...
' Save the modified document to the file.
workbook.SaveDocument("Documents\SavedDocument.xlsx", DocumentFormat.Xlsx)
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.
string fileName = String.Format("{0:yyyy-MM-ddTHH-mm-ss}{1}.xlsx", DateTime.Now, fileNameBase);
wb.SaveDocument(fileName, DocumentFormat.Xlsx);
}
// Save the modified document to a file.
workbook.SaveDocument("..\\..\\..\\Documents\\SavedDocument.xlsx", DocumentFormat.OpenXml);
#endregion #SaveDocumentToFile
spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/Form1.cs#L161
// Save the modified document to the file.
workbook.SaveDocument("SavedDocument.xlsx", DocumentFormat.OpenXml);
#endregion #SaveDocumentToFile
spreadsheet-document-api-pivot-table-examples/CS/SpreadsheetDocServerPivotAPI/Form1.cs#L160
// Save the modified document to the file.
workbook.SaveDocument("SavedDocument.xlsx", DocumentFormat.OpenXml);
#endregion #SaveDocumentToFile
spreadsheet-document-api-examples-part1/CS/SpreadsheetExamples/Form1.cs#L142
// Save the modified document to the file.
workbook.SaveDocument("Documents\\SavedDocument.xlsx", DocumentFormat.OpenXml);
#endregion #SaveDocumentToFile
Dim fileName As String = String.Format("{0:yyyy-MM-ddTHH-mm-ss}{1}.xlsx", Date.Now, fileNameBase)
wb.SaveDocument(fileName, DocumentFormat.Xlsx)
End Sub
' Save the modified document to a file.
workbook.SaveDocument("..\..\..\Documents\SavedDocument.xlsx", DocumentFormat.OpenXml)
#End Region
spreadsheet-document-api-encryption/VB/EncryptionExample/Program.vb#L37
If IsValid = True Then
workbook.SaveDocument(fileName, documentFormat)
Call Process.Start(fileName)
spreadsheet-document-api-examples-part2/VB/SpreadsheetDocServerAPIPart2/Form1.vb#L159
' Save the modified document to the file.
workbook.SaveDocument("SavedDocument.xlsx", DocumentFormat.OpenXml)
' #End Region ' #SaveDocumentToFile
spreadsheet-document-api-pivot-table-examples/VB/SpreadsheetDocServerPivotAPI/Form1.vb#L154
' Save the modified document to the file.
workbook.SaveDocument("SavedDocument.xlsx", DocumentFormat.OpenXml)
#End Region ' #SaveDocumentToFile
SaveDocument(String, DocumentFormat)
See Also
How to: Save a Document to a File