FarPoint.Win.Spread.FpSpread.SaveExcel

SaveExcel Method

SaveExcel(Stream)

Saves the content of the Spread component to the specified stream.

Declaration

public bool SaveExcel(Stream stream)

Public Function SaveExcel(stream As Stream) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream to which to save the data

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null

SaveExcel(Stream, string)

Saves the content of the Spread component to the specified 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 which to save the data
string	password	The file password

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null

SaveExcel(Stream, ExcelWarningList)

Saves the content of the Spread component to the specified stream with a list 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	The stream to save to
ExcelWarningList	warningList	List of Excel warnings

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null

SaveExcel(Stream, ExcelSaveFlags)

Saves the content of the Spread component to the specified stream with the headers exported as data.

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
ExcelSaveFlags	saveFlags	Save flag

Returns

Type	Description
bool	True if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null

SaveExcel(Stream, ExcelSaveFlags, string)

Saves the content of the Spread component to the specified stream with the headers exported as data.

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
ExcelSaveFlags	saveFlags	Save flag
string	password	Password of file

Returns

Type	Description
bool	True if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null

SaveExcel(Stream, ExcelSaveFlags, ExcelWarningList)

Saves the content of the Spread component to the specified stream with headers and a list 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
ExcelSaveFlags	saveFlags	Save flag
ExcelWarningList	warningList	List of Excel warnings

Returns

Type	Description
bool	True if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null

SaveExcel(Stream, ExcelSaveFlags, ExcelWarningList, string)

Saves the content of the Spread component to the specified stream with headers and a list 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
ExcelSaveFlags	saveFlags	Save flag
ExcelWarningList	warningList	List of Excel warnings
string	password	Password of file

Returns

Type	Description
bool	True if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null

SaveExcel(string, ExcelSaveFlags)

Saves the content of the Spread component to the specified Excel-compatible file with the headers exported as data.

Declaration

public bool SaveExcel(string fileName, ExcelSaveFlags saveFlags)

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

Parameters

Type	Name	Description
string	fileName	Path and name of file
ExcelSaveFlags	saveFlags	Save flag

Returns

Type	Description
bool	True if successful; false otherwise

Exceptions

Type	Condition
FileNotFoundException	Specified file is not found
ArgumentNullException	No file name is specified (or specified file name is null)
ArgumentException	No file name is specified (or specified file name is empty)

SaveExcel(string, ExcelSaveFlags, string)

Saves the content of the Spread component to the specified Excel-compatible file with the headers exported as data.

Declaration

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

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

Parameters

Type	Name	Description
string	fileName	Path and name of file
ExcelSaveFlags	saveFlags	Save flag
string	password	Password of file

Returns

Type	Description
bool	True if successful; false otherwise

Exceptions

Type	Condition
FileNotFoundException	Specified file is not found
ArgumentNullException	No file name is specified (or specified file name is null)
ArgumentException	No file name is specified (or specified file name is empty)

SaveExcel(string, ExcelSaveFlags, ExcelWarningList)

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

Declaration

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

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

Parameters

Type	Name	Description
string	fileName	Path and name of file
ExcelSaveFlags	saveFlags	Save flag
ExcelWarningList	warningList	List of Excel warnings

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
FileNotFoundException	Specified file is not found
ArgumentNullException	No file name is specified (or specified file name is null)
ArgumentException	No file name is specified (or specified file name is empty)

SaveExcel(string, ExcelSaveFlags, ExcelWarningList, string)

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

Declaration

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

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

Parameters

Type	Name	Description
string	fileName	Path and name of file
ExcelSaveFlags	saveFlags	Save flag
ExcelWarningList	warningList	List of Excel warnings
string	password	Password of file

Returns

Type	Description
bool	True if successful; false otherwise

Exceptions

Type	Condition
FileNotFoundException	Specified file is not found
ArgumentNullException	No file name is specified (or specified file name is null)
ArgumentException	No file name is specified (or specified file name is empty)

SaveExcel(string)

Saves the content of the Spread component to the specified Excel-compatible file.

Declaration

public bool SaveExcel(string fileName)

Public Function SaveExcel(fileName As String) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of file

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
FileNotFoundException	Specified file is not found
ArgumentNullException	No file name is specified (or specified file name is null)
ArgumentException	No file name is specified (or specified file name is empty)

SaveExcel(string, string)

Saves the content of the Spread component to the specified Excel-compatible 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 name of file
string	password	Password of file

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
FileNotFoundException	Specified file is not found
ArgumentNullException	No file name is specified (or specified file name is null)
ArgumentException	No file name is specified (or specified file name is empty)

SaveExcel(string, ExcelWarningList)

Saves the content of the Spread component to the specified Excel-compatible file with a list 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 name of file
ExcelWarningList	warningList	List of Excel warnings

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
FileNotFoundException	Specified file is not found
ArgumentNullException	No file name is specified (or specified file name is null)
ArgumentException	No file name is specified (or specified file name is empty)

SaveExcel(string, IncludeHeaders)

Saves the content of the Spread component to the specified Excel-compatible file with the headers exported as data.

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 name of file
IncludeHeaders	includeHeaders	Whether to include headers

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
FileNotFoundException	Specified file is not found
ArgumentNullException	No file name is specified (or specified file name is null)
ArgumentException	No file name is specified (or specified file name is empty)

SaveExcel(string, IncludeHeaders, ExcelWarningList)

Saves the content of the Spread component to the specified Excel-compatible file with headers and a list 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 name of file
IncludeHeaders	includeHeaders	Whether to include headers
ExcelWarningList	warningList	List of Excel warnings

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
FileNotFoundException	Specified file is not found
ArgumentNullException	No file name is specified (or specified file name is null)
ArgumentException	No file name is specified (or specified file name is empty)