ISpreadsheetComponent.SaveDocument(String, DocumentFormat) 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 format.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

void SaveDocument(
    string fileName,
    DocumentFormat format
)

VB.NET

Sub SaveDocument(
    fileName As String,
    format As DocumentFormat
)

Parameters

Name	Type	Description
fileName	String	A string value specifying the path to a file in which to save the document.
format	DocumentFormat	One of the DocumentFormat enumeration values.

Related GitHub Examples

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.

C#

winforms-spreadsheet-mail-merge/CS/DXApplication1/Form1.cs#L34

    string fileName = string.Format("Documents\\SavedDocument{0}" + ".xlsx", index++);
    workbook.SaveDocument(fileName, DocumentFormat.OpenXml);
}

winforms-spreadsheet-apply-conditional-formatting-to-a-range-of-cells/CS/SpreadsheetControl/Form1.cs#L83

// Save the modified document to a file.
workbook.SaveDocument("Documents\\SavedDocument.xlsx", DocumentFormat.OpenXml);
#endregion #SaveDocumentToFile

winforms-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_API_Part02/Form1.cs#L153

// Save the modified document to the file.
workbook.SaveDocument("Documents\\SavedDocument.xlsx", DocumentFormat.OpenXml);
#endregion #SaveDocumentToFile

wpf-spreadsheet-how-to-apply-conditional-formatting-to-a-range-of-cells/CS/ConditionalFormatting_WPF_Examples/MainWindow.xaml.cs#L65

// Save the modified document to a file.
workbook.SaveDocument("Documents\\SavedDocument.xlsx", DocumentFormat.OpenXml);
#endregion #SaveDocumentToFile

wpf-spreadsheetcontrol-api-part-1/CS/SpreadsheetControl_WPF_API/MainWindow.xaml.cs#L63

// Save the modified document to a file.
workbook.SaveDocument("Documents\\SavedDocument.xlsx", DocumentFormat.OpenXml);
#endregion #SaveToFile

VB.NET

winforms-spreadsheet-mail-merge/VB/DXApplication1/Form1.vb#L35

    index += 1
    workbook.SaveDocument(fileName, DocumentFormat.OpenXml)
Next workbook

winforms-spreadsheet-apply-conditional-formatting-to-a-range-of-cells/VB/SpreadsheetControl/Form1.vb#L79

            ' Save the modified document to a file.
            workbook.SaveDocument("Documents\SavedDocument.xlsx", DocumentFormat.OpenXml)
'            #End Region ' #SaveDocumentToFile

winforms-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_API_Part02/Form1.vb#L142

            ' Save the modified document to the file.
            workbook.SaveDocument("Documents\SavedDocument.xlsx", DocumentFormat.OpenXml)
'            #End Region ' #SaveDocumentToFile

wpf-spreadsheet-how-to-apply-conditional-formatting-to-a-range-of-cells/VB/ConditionalFormatting_WPF_Examples/MainWindow.xaml.vb#L59

            ' Save the modified document to a file.
            workbook.SaveDocument("Documents\SavedDocument.xlsx", DocumentFormat.OpenXml)
'            #End Region ' #SaveDocumentToFile

wpf-spreadsheetcontrol-api-part-1/VB/SpreadsheetControl_WPF_API/MainWindow.xaml.vb#L63

            ' Save the modified document to a file.
            workbook.SaveDocument("Documents\SavedDocument.xlsx", DocumentFormat.OpenXml)
'            #End Region ' #SaveToFile