SaveExcel(String,IncludeHeaders,ExcelWarningList) Method

Saves the content of the Spread component to the specified Excel-compatible file with headers and a list of warnings.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function SaveExcel( _
   ByVal fileName As String, _
   ByVal includeHeaders As IncludeHeaders, _
   ByVal warningList As ExcelWarningList _
) As Boolean

'Usage
 
Dim instance As FpSpread
Dim fileName As String
Dim includeHeaders As IncludeHeaders
Dim warningList As ExcelWarningList
Dim value As Boolean
 
value = instance.SaveExcel(fileName, includeHeaders, warningList)

public bool SaveExcel( 
   string fileName,
   IncludeHeaders includeHeaders,
   ExcelWarningList warningList
)

Parameters

fileName: Path and name of the Excel file to which to save the contents
includeHeaders: Whether to save the headers as data
warningList: Warning messages

Return Value

Boolean: true if successful; false otherwise

Exceptions

Exception	Description
System.IO.FileNotFoundException	Specified file is not found
System.ArgumentNullException	No file name is specified (or specified file name is null)
System.ArgumentException	No file name is specified (or specified file name is empty)

Example

This example saves the Spread component to an Excel-formatted file and provides a list of warnings, but does not save the headers.

FarPoint.Win.Spread.FpSpread fpSpread1 = new FarPoint.Win.Spread.FpSpread();
FarPoint.Win.Spread.SheetView shv = new FarPoint.Win.Spread.SheetView();
FarPoint.Excel.ExcelWarningList wList = new FarPoint.Excel.ExcelWarningList();
DialogResult dlg;
fpSpread1.Location = new Point(10, 10);
fpSpread1.Height = 200;
fpSpread1.Width = 400;
Controls.Add(fpSpread1);
fpSpread1.Sheets.Add(shv);
fpSpread1.ActiveSheet.ColumnCount = 4;
fpSpread1.ActiveSheet.RowCount = 4;
string fileName;
fileName = "..\\..\\bin\\savespreadstream.xls";
dlg = MessageBox.Show("Do you want to save to an Excel-formatted file??", "SaveExcel", MessageBoxButtons.YesNo);
if (dlg == DialogResult.Yes)
{
     fpSpread1.ActiveSheet.SetValue(0, 0, 20);
     fpSpread1.ActiveSheet.SetValue(1, 0, 30);
     fpSpread1.ActiveSheet.SetFormula(2, 2, "Sum(A1,A2)");
     fpSpread1.SaveExcel(fileName, FarPoint.Win.Spread.Model.IncludeHeaders.None, wList);
}

Visual Basic

Dim fpSpread1 As New FarPoint.Win.Spread.FpSpread()
Dim shv As New FarPoint.Win.Spread.SheetView()
Dim wList As New FarPoint.Excel.ExcelWarningList()
Dim dlg As DialogResult
fpSpread1.Location = New Point(10, 10)
fpSpread1.Height = 200
fpSpread1.Width = 400
Controls.Add(fpSpread1)
fpSpread1.Sheets.Add(shv)
fpSpread1.ActiveSheet.ColumnCount = 4
fpSpread1.ActiveSheet.RowCount = 4
Dim fileName As String
fileName = "..\bin\savespreadexcel.xls"
dlg = MessageBox.Show("Do you want to save to an Excel-formatted file??", "SaveExcel", MessageBoxButtons.YesNo)
If dlg = DialogResult.Yes Then
     fpSpread1.ActiveSheet.SetValue(0, 0, 20)
     fpSpread1.ActiveSheet.SetValue(1, 0, 30)
     fpSpread1.ActiveSheet.SetFormula(2, 2, "Sum(A1,A2)")
     fpSpread1.SaveExcel(fileName, FarPoint.Win.Spread.Model.IncludeHeaders.None, wList)
End If

Reference

FpSpread Class
FpSpread Members
Overload List