Spread Windows Forms 11.0 Product Documentation
SaveExcel(String,IncludeHeaders) Method
Example 


FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > FpSpread Class > SaveExcel Method : SaveExcel(String,IncludeHeaders) Method
Path and name of the Excel file to which to save the contents
Whether to save the headers as data
Saves the content of the Spread component to the specified Excel-compatible file with the headers exported as data.
Syntax
'Declaration
 
Public Overloads Function SaveExcel( _
   ByVal fileName As String, _
   ByVal includeHeaders As IncludeHeaders _
) As Boolean
'Usage
 
Dim instance As FpSpread
Dim fileName As String
Dim includeHeaders As IncludeHeaders
Dim value As Boolean
 
value = instance.SaveExcel(fileName, includeHeaders)
public bool SaveExcel( 
   string fileName,
   IncludeHeaders includeHeaders
)

Parameters

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

Return Value

Boolean: true if successful; false otherwise
Exceptions
ExceptionDescription
Specified file is not found
No file name is specified (or specified file name is null)
No file name is specified (or specified file name is empty)
Example
This example saves the Spread component to an Excel-formatted file, 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();
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);
}
Dim fpSpread1 As New FarPoint.Win.Spread.FpSpread()
Dim shv As New FarPoint.Win.Spread.SheetView()
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)
End If
See Also

Reference

FpSpread Class
FpSpread Members
Overload List