officefileapi-devexpress-dot-spreadsheet-dot-workbook-dot-savedocumentasync-x28-system-dot-string-system-dot-iprogress-system-dot-int32-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.
Asynchronously saves the document to a file (the file format is defined by the file extension) and allows you to implement progress notifications.
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 Task SaveDocumentAsync(
string fileName,
IProgress<int> progress
)
Public Function SaveDocumentAsync(
fileName As String,
progress As IProgress(Of Integer)
) As Task
| Name | Type | Description |
|---|---|---|
| fileName | String |
The file name (including the full path) for the output file.
| | progress | IProgress<Int32> |
An object used to report the task progress in percentage. Use a Progress<T> class instance to report progress.
|
| Type | Description |
|---|---|
| Task |
An object that defines the asynchronous save operation.
|
The DocumentFormat enumeration lists the supported document formats. To export a file to PDF or HTML, use the Workbook.ExportToPdfAsync and Workbook.ExportToHtmlAsync methods.
Important
Take into account the following when you call this method:
The events fired by this method call may occur in a different thread than the target operation.
The operation is not thread safe (the document should not be accessed simultaneously by different threads). Wait until the operation is completed before you continue to work with the document (for example, use the await operator).
The following example merges two workbooks and saves the result asynchronously. The console window displays the progress of the save operation.
using System;
using System.Threading.Tasks;
using DevExpress.Spreadsheet;
// ...
static async Task Main(string[] args) {
using (Workbook workbook1 = new Workbook())
{
using (Workbook workbook2 = new Workbook())
{
Console.WriteLine("Merging workbooks...");
await Task.WhenAll(new Task[]
{
workbook1.LoadDocumentAsync("Book1.xlsx"),
workbook2.LoadDocumentAsync("Book2.xlsx")
});
workbook1.Append(workbook2);
await workbook1.SaveDocumentAsync("MergedDocument.xlsx",
new Progress<int>((progress) => Console.WriteLine($"{progress}%")));
Console.WriteLine("Done!");
}
}
}
Imports System
Imports System.Threading.Tasks
Imports DevExpress.Spreadsheet
Module Example
Sub Main()
MainAsync().Wait()
End Sub
Async Function MainAsync() As Task
Using workbook1 As New Workbook()
Using workbook2 As New Workbook()
Console.WriteLine("Merging workbooks...")
Await Task.WhenAll(New Task() {
workbook1.LoadDocumentAsync("Book1.xlsx"),
workbook2.LoadDocumentAsync("Book2.xlsx") })
workbook1.Append(workbook2)
Await workbook1.SaveDocumentAsync("MergedDocument.xlsx",
New Progress(Of Integer)(Sub(progress) Console.WriteLine($"{progress}%")))
Console.WriteLine("Done!")
End Using
End Using
End Function
End Module
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.
See Also