SpreadsheetSaveOptions Class

Contains options that define the file name and file format that are used when saving and loading the workbook.

Namespace: DevExpress.Xpf.Spreadsheet

Assembly: DevExpress.Xpf.Spreadsheet.v25.1.dll

NuGet Package: DevExpress.Wpf.Spreadsheet

Declaration

C#

public class SpreadsheetSaveOptions :
    SpreadsheetOptionsBase<WorkbookSaveOptions>

VB.NET

Public Class SpreadsheetSaveOptions
    Inherits SpreadsheetOptionsBase(Of WorkbookSaveOptions)

Related API Members

The following members return SpreadsheetSaveOptions objects:

• SpreadsheetControlOptions.Save

Remarks

An instance of the SpreadsheetSaveOptions class is accessible from the SpreadsheetControlOptions.Save property.

The following code snippet uses the SpreadsheetSaveOptions.CurrentFileName property to specify the saved document file name (including the path and extension):

MainWindow.xaml.cs

public partial class MainWindow : ThemedWindow {
    // ...

    private void spreadsheetControl1_DocumentLoaded(object sender, EventArgs e) {
        spreadsheetControl1.Options.Save.CurrentFileName = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "result.xlsx");
    }


    private void spreadsheetControl1_EmptyDocumentCreated(object sender, EventArgs e) {
        spreadsheetControl1.Options.Save.CurrentFileName = "newSpreadsheet.xlsx";
    }
}

MainWindow.xaml.vb

Public Partial Class MainWindow
    Inherits ThemedWindow
    ' ...
    Private Sub spreadsheetControl1_DocumentLoaded(sender As Object, e As EventArgs) Handles spreadsheetControl1.DocumentLoaded
        spreadsheetControl1.Options.Save.CurrentFileName =
            Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "result.xlsx")
    End Sub

    Private Sub spreadsheetControl1_EmptyDocumentCreated(sender As Object, e As EventArgs) Handles spreadsheetControl1.EmptyDocumentCreated
        spreadsheetControl1.Options.Save.CurrentFileName = "newSpreadsheet.xlsx"
    End Sub
End Class

MainWindow.xaml

<dxsps:SpreadsheetControl x:Name="spreadsheetControl1"
                          DocumentSource="Document.xlsx"
                          DocumentLoaded="spreadsheetControl1_DocumentLoaded"
                          EmptyDocumentCreated="spreadsheetControl1_EmptyDocumentCreated"/>

Inheritance

Object

DispatcherObject

DependencyObject

ContentElement

FrameworkContentElement

DevExpress.Xpf.Spreadsheet.SpreadsheetOptionsBase<WorkbookSaveOptions>

SpreadsheetSaveOptions