FarPoint.Web.Spread.FpSpread.SaveExcel

SaveExcel Method

SaveExcel(Stream)

Saves the contents of the Spread component to the specified Excel file in a stream.

Declaration

public bool SaveExcel(Stream stream)

Public Function SaveExcel(stream As Stream) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream to save the file to as an Excel Compound Storage file

Returns

Type	Description
bool

SaveExcel(Stream, string)

Saves the contents of the Spread component to the specified Excel file in a stream.

Declaration

public bool SaveExcel(Stream stream, string password)

Public Function SaveExcel(stream As Stream, password As String) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream to save the file to as an Excel Compound Storage file
string	password	Password of file

Returns

Type	Description
bool

SaveExcel(Stream, ExcelWarningList)

Saves the contents of the Spread component to the specified Excel file in a stream keeping track of warnings.

Declaration

public bool SaveExcel(Stream stream, ExcelWarningList warningList)

Public Function SaveExcel(stream As Stream, warningList As ExcelWarningList) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream to save the file to as an Excel Compound Storage file
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

SaveExcel(Stream, ExcelSaveFlags)

Saves the contents of the Spread component with the specified parts to the specified Excel file in a stream.

Declaration

public bool SaveExcel(Stream stream, ExcelSaveFlags saveFlags)

Public Function SaveExcel(stream As Stream, saveFlags As ExcelSaveFlags) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream to save the file to as an Excel Compound Storage file
ExcelSaveFlags	saveFlags	Which parts of the spreadsheet to save

Returns

Type	Description
bool

SaveExcel(Stream, ExcelSaveFlags, string)

Saves the contents of the Spread component with the specified parts to the specified Excel file in a stream.

Declaration

public bool SaveExcel(Stream stream, ExcelSaveFlags saveFlags, string password)

Public Function SaveExcel(stream As Stream, saveFlags As ExcelSaveFlags, password As String) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream to save the file to as an Excel Compound Storage file
ExcelSaveFlags	saveFlags	Which parts of the spreadsheet to save
string	password	Password of file

Returns

Type	Description
bool

SaveExcel(Stream, ExcelSaveFlags, ExcelWarningList)

Saves the contents of the Spread component to the specified Excel file in a stream, keeping track of warnings.

Declaration

public bool SaveExcel(Stream stream, ExcelSaveFlags saveFlags, ExcelWarningList warningList)

Public Function SaveExcel(stream As Stream, saveFlags As ExcelSaveFlags, warningList As ExcelWarningList) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream to save the file to as an Excel Compound Storage file
ExcelSaveFlags	saveFlags	Which parts of the spreadsheet to save
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

SaveExcel(Stream, ExcelSaveFlags, ExcelWarningList, string)

Saves the contents of the Spread component to the specified Excel file in a stream, keeping track of warnings.

Declaration

public bool SaveExcel(Stream stream, ExcelSaveFlags saveFlags, ExcelWarningList warningList, string password)

Public Function SaveExcel(stream As Stream, saveFlags As ExcelSaveFlags, warningList As ExcelWarningList, password As String) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream to save the file to as an Excel Compound Storage file
ExcelSaveFlags	saveFlags	Which parts of the spreadsheet to save
ExcelWarningList	warningList	List of warning messages that occur during this operation
string	password	Password of file

Returns

Type	Description
bool

SaveExcel(string)

Saves the contents of the Spread component to Excel in the specified file.

Declaration

public bool SaveExcel(string fileName)

Public Function SaveExcel(fileName As String) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and file name of Excel file

Returns

Type	Description
bool

SaveExcel(string, string)

Saves the contents of the Spread component to Excel in the specified file.

Declaration

public bool SaveExcel(string fileName, string password)

Public Function SaveExcel(fileName As String, password As String) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and file name of Excel file
string	password	Password of file

Returns

Type	Description
bool

SaveExcel(string, ExcelWarningList)

Saves the contents of the Spread component to Excel in the specified file keeping track of warnings.

Declaration

public bool SaveExcel(string fileName, ExcelWarningList warningList)

Public Function SaveExcel(fileName As String, warningList As ExcelWarningList) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and file name of Excel file
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

SaveExcel(string, IncludeHeaders)

Saves the contents of the Spread component to Excel in the specified file and whether to include headers.

Declaration

public bool SaveExcel(string fileName, IncludeHeaders includeHeaders)

Public Function SaveExcel(fileName As String, includeHeaders As IncludeHeaders) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and file name of Excel file
IncludeHeaders	includeHeaders	Whether to export the headers as data

Returns

Type	Description
bool

SaveExcel(string, IncludeHeaders, ExcelWarningList)

Saves the contents of the Spread component to Excel in the specified file and whether to include headers and keeps track of warnings.

Declaration

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

Public Function SaveExcel(fileName As String, includeHeaders As IncludeHeaders, warningList As ExcelWarningList) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and file name of file to save
IncludeHeaders	includeHeaders	Whether to export the headers as data
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

SaveExcel(string, ExcelSaveFlags, ExcelWarningList)

Saves the contents of the Spread component with the specified parts to Excel in the specified file keeping track of warnings.

Declaration

public bool SaveExcel(string fileName, ExcelSaveFlags excelSaveFlags, ExcelWarningList warningList)

Public Function SaveExcel(fileName As String, excelSaveFlags As ExcelSaveFlags, warningList As ExcelWarningList) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and file name of file to save
ExcelSaveFlags	excelSaveFlags	Which parts of the spreadsheet to save
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

SaveExcel(string, ExcelSaveFlags, ExcelWarningList, string)

Saves the contents of the Spread component with the specified parts to Excel in the specified file keeping track of warnings.

Declaration

public bool SaveExcel(string fileName, ExcelSaveFlags excelSaveFlags, ExcelWarningList warningList, string password)

Public Function SaveExcel(fileName As String, excelSaveFlags As ExcelSaveFlags, warningList As ExcelWarningList, password As String) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and file name of file to save
ExcelSaveFlags	excelSaveFlags	Which parts of the spreadsheet to save
ExcelWarningList	warningList	List of warning messages that occur during this operation
string	password	Password of file

Returns

Type	Description
bool

SaveExcel(string, ExcelSaveFlags)

Saves the contents of the Spread component to Excel in the specified file including the specified parts.

Declaration

public bool SaveExcel(string fileName, ExcelSaveFlags excelSaveFlags)

Public Function SaveExcel(fileName As String, excelSaveFlags As ExcelSaveFlags) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and file name of file to save
ExcelSaveFlags	excelSaveFlags	Which parts of the spreadsheet to save

Returns

Type	Description
bool

SaveExcel(string, ExcelSaveFlags, string)

Saves the contents of the Spread component to Excel in the specified file including the specified parts.

Declaration

public bool SaveExcel(string fileName, ExcelSaveFlags excelSaveFlags, string password)

Public Function SaveExcel(fileName As String, excelSaveFlags As ExcelSaveFlags, password As String) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and file name of file to save
ExcelSaveFlags	excelSaveFlags	Which parts of the spreadsheet to save
string	password	Password of file

Returns

Type	Description
bool

SaveExcel Method