FarPoint.Win.Spread.FpSpread.OpenExcel

OpenExcel Method

OpenExcel(Stream, ExcelOpenFlags)

Opens an Excel Compound Document File and loads it into Spread.

Declaration

public bool OpenExcel(Stream stream, ExcelOpenFlags openFlags)

Public Function OpenExcel(stream As Stream, openFlags As ExcelOpenFlags) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream
ExcelOpenFlags	openFlags	Open flag

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null
ArgumentException	No stream specified or specified stream is empty

OpenExcel(Stream, ExcelOpenFlags, string)

Opens an Excel Compound Document File and loads it into Spread.

Declaration

public bool OpenExcel(Stream stream, ExcelOpenFlags openFlags, string password)

Public Function OpenExcel(stream As Stream, openFlags As ExcelOpenFlags, password As String) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream
ExcelOpenFlags	openFlags	Open flag
string	password	File password

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null
ArgumentException	No stream specified or specified stream is empty

OpenExcel(Stream, ExcelOpenFlags, ExcelWarningList)

Opens an Excel Compound Document File and loads it into Spread with a list of warnings.

Declaration

public bool OpenExcel(Stream stream, ExcelOpenFlags openFlags, ExcelWarningList warningList)

Public Function OpenExcel(stream As Stream, openFlags As ExcelOpenFlags, warningList As ExcelWarningList) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream
ExcelOpenFlags	openFlags	Open 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
ArgumentException	No stream specified or specified stream is empty

OpenExcel(Stream, ExcelOpenFlags, ExcelWarningList, string)

Opens an Excel Compound Document File and loads it into Spread with a list of warnings.

Declaration

public bool OpenExcel(Stream stream, ExcelOpenFlags openFlags, ExcelWarningList warningList, string password)

Public Function OpenExcel(stream As Stream, openFlags As ExcelOpenFlags, warningList As ExcelWarningList, password As String) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream
ExcelOpenFlags	openFlags	Open flag
ExcelWarningList	warningList	List of Excel warnings
string	password	File password

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null
ArgumentException	No stream specified or specified stream is empty

OpenExcel(Stream, ExcelOpenFlags, ExcelWarningList, string, bool)

Opens an Excel Compound Document File and loads it into Spread with a list of warnings.

Declaration

public bool OpenExcel(Stream stream, ExcelOpenFlags openFlags, ExcelWarningList warningList, string password, bool isClearInputMapKey)

Public Function OpenExcel(stream As Stream, openFlags As ExcelOpenFlags, warningList As ExcelWarningList, password As String, isClearInputMapKey As Boolean) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream
ExcelOpenFlags	openFlags	Open flag
ExcelWarningList	warningList	List of Excel warnings
string	password	File password
bool	isClearInputMapKey	Clear current input map key

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null
ArgumentException	No stream specified or specified stream is empty

OpenExcel(Stream)

Opens an Excel Compound Document File and loads it into Spread.

Declaration

public bool OpenExcel(Stream stream)

Public Function OpenExcel(stream As Stream) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Document File

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null
ArgumentException	No stream specified or specified stream is empty

OpenExcel(Stream, bool)

Opens an Excel Compound Document File and loads it into Spread.

Declaration

public bool OpenExcel(Stream stream, bool isClearInputMapKey)

Public Function OpenExcel(stream As Stream, isClearInputMapKey As Boolean) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Document File
bool	isClearInputMapKey	Clear current input map key of Spread.

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null
ArgumentException	No stream specified or specified stream is empty

OpenExcel(Stream, string)

Opens an Excel Compound Document File and loads it into Spread.

Declaration

public bool OpenExcel(Stream stream, string password)

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

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Document File
string	password	File password

Returns

Type	Description
bool	true if successful; false otherwise

Exceptions

Type	Condition
ArgumentNullException	No stream specified or specified stream is null
ArgumentException	No stream specified or specified stream is empty

OpenExcel(Stream, ExcelWarningList)

Opens an Excel Compound Document File and loads it into Spread with a list of warnings.

Declaration

public bool OpenExcel(Stream stream, ExcelWarningList warningList)

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

Parameters

Type	Name	Description
Stream	stream	Stream
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
ArgumentException	No stream specified or specified stream is empty

OpenExcel(string, ExcelOpenFlags)

Opens an Excel-compatible file and loads it into Spread.

Declaration

public bool OpenExcel(string fileName, ExcelOpenFlags openFlags)

Public Function OpenExcel(fileName As String, openFlags As ExcelOpenFlags) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of file
ExcelOpenFlags	openFlags	Open 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)

OpenExcel(string, ExcelOpenFlags, string)

Opens an Excel-compatible file and loads it into Spread.

Declaration

public bool OpenExcel(string fileName, ExcelOpenFlags openFlags, string password)

Public Function OpenExcel(fileName As String, openFlags As ExcelOpenFlags, password As String) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of file
ExcelOpenFlags	openFlags	Open 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)

OpenExcel(string, ExcelOpenFlags, ExcelWarningList)

Opens an Excel-compatible file and loads it into Spread with a list of warnings.

Declaration

public bool OpenExcel(string fileName, ExcelOpenFlags openFlags, ExcelWarningList warningList)

Public Function OpenExcel(fileName As String, openFlags As ExcelOpenFlags, warningList As ExcelWarningList) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of file
ExcelOpenFlags	openFlags	Open 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)

OpenExcel(string, ExcelOpenFlags, ExcelWarningList, string)

Opens an Excel-compatible file and loads it into Spread with a list of warnings.

Declaration

public bool OpenExcel(string fileName, ExcelOpenFlags openFlags, ExcelWarningList warningList, string password)

Public Function OpenExcel(fileName As String, openFlags As ExcelOpenFlags, warningList As ExcelWarningList, password As String) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of file
ExcelOpenFlags	openFlags	Open 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)

OpenExcel(string, ExcelOpenFlags, ExcelWarningList, string, bool)

Opens an Excel-compatible file and loads it into Spread with a list of warnings.

Declaration

public bool OpenExcel(string fileName, ExcelOpenFlags openFlags, ExcelWarningList warningList, string password, bool isClearInputMapKey)

Public Function OpenExcel(fileName As String, openFlags As ExcelOpenFlags, warningList As ExcelWarningList, password As String, isClearInputMapKey As Boolean) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of file
ExcelOpenFlags	openFlags	Open flag
ExcelWarningList	warningList	List of Excel warnings
string	password	Password of file
bool	isClearInputMapKey	Clear current input map key of Spread.

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)

OpenExcel(string)

Opens an Excel-compatible file and loads it into Spread.

Declaration

public bool OpenExcel(string fileName)

Public Function OpenExcel(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)

OpenExcel(string, bool)

Opens an Excel-compatible file and loads it into Spread.

Declaration

public bool OpenExcel(string fileName, bool isClearInputMapKey)

Public Function OpenExcel(fileName As String, isClearInputMapKey As Boolean) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of file
bool	isClearInputMapKey	Clear current input map key of Spread.

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)

OpenExcel(string, string)

Opens an Excel-compatible file and loads it into Spread.

Declaration

public bool OpenExcel(string fileName, string password)

Public Function OpenExcel(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)

OpenExcel(string, ExcelWarningList)

Opens an Excel-compatible file and loads it into Spread with a list of warnings.

Declaration

public bool OpenExcel(string fileName, ExcelWarningList warningList)

Public Function OpenExcel(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)