FarPoint.Web.Spread.FpSpread.OpenExcel

OpenExcel Method

OpenExcel(string)

Opens an Excel file and loads it into the Spread component.

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 to open

Returns

Type	Description
bool

OpenExcel(string, string)

Opens an Excel file and loads it into the Spread component.

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 to open
string	password	The Password

Returns

Type	Description
bool

OpenExcel(string, ExcelWarningList)

Opens an Excel file into the Spread component keeping track 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 to open
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

OpenExcel(string, int, string)

Opens an Excel file and loads the specified Excel sheet (by name) into the specified sheet of the Spread component (by index).

Declaration

public bool OpenExcel(string fileName, int spreadSheetIndex, string excelSheetName)

Public Function OpenExcel(fileName As String, spreadSheetIndex As Integer, excelSheetName As String) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of the file to open
int	spreadSheetIndex	Index of the sheet in the Spread component into which to load the Excel sheet
string	excelSheetName	Name of the Excel sheet to load

Returns

Type	Description
bool

OpenExcel(string, string, string)

Opens an Excel file and loads the specified Excel sheet (by name) into the specified sheet of the Spread component (by name).

Declaration

public bool OpenExcel(string fileName, string spreadSheetName, string excelSheetName)

Public Function OpenExcel(fileName As String, spreadSheetName As String, excelSheetName As String) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of the file to open
string	spreadSheetName	Name of the sheet in the Spread component into which to load the Excel sheet
string	excelSheetName	Name of the Excel sheet to load

Returns

Type	Description
bool

OpenExcel(string, int, int)

Opens an Excel file and loads the specified Excel sheet (by index) into the specified sheet of the Spread component (by index).

Declaration

public bool OpenExcel(string fileName, int spreadSheetIndex, int excelSheetIndex)

Public Function OpenExcel(fileName As String, spreadSheetIndex As Integer, excelSheetIndex As Integer) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of the file to open
int	spreadSheetIndex	Index of the sheet in the Spread component into which to load the Excel sheet
int	excelSheetIndex	Index of the Excel sheet to load

Returns

Type	Description
bool

OpenExcel(string, int, int, ExcelWarningList)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component keeping track of warnings.

Declaration

public bool OpenExcel(string fileName, int spreadSheetIndex, int excelSheetIndex, ExcelWarningList warningList)

Public Function OpenExcel(fileName As String, spreadSheetIndex As Integer, excelSheetIndex As Integer, warningList As ExcelWarningList) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of the file to open
int	spreadSheetIndex	Index of the sheet in the Spread component into which to load the Excel sheet
int	excelSheetIndex	Index of the Excel sheet to load
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

OpenExcel(string, ExcelOpenFlags)

Opens an Excel file into the Spread component including the specified parts of the spreadsheet.

Declaration

public bool OpenExcel(string fileName, ExcelOpenFlags excelOpenFlags)

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

Parameters

Type	Name	Description
string	fileName	Path and name of file to open
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load

Returns

Type	Description
bool

OpenExcel(string, ExcelOpenFlags, ExcelWarningList)

Opens an Excel file into the Spread component including the specified parts and keeps track of warnings.

Declaration

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

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

Parameters

Type	Name	Description
string	fileName	Path and name of file to open
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

OpenExcel(string, ExcelOpenFlags, ExcelWarningList, string)

Opens an Excel file into the Spread component including the specified parts and keeps track of warnings.

Declaration

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

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

Parameters

Type	Name	Description
string	fileName	Path and name of file to open
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load
ExcelWarningList	warningList	List of warning messages that occur during this operation
string	password	The password

Returns

Type	Description
bool

OpenExcel(string, int, string, ExcelOpenFlags)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

Declaration

public bool OpenExcel(string fileName, int spreadSheetIndex, string excelSheetName, ExcelOpenFlags excelOpenFlags)

Public Function OpenExcel(fileName As String, spreadSheetIndex As Integer, excelSheetName As String, excelOpenFlags As ExcelOpenFlags) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of the file to open
int	spreadSheetIndex	Index of the sheet in the Spread component into which to load the Excel sheet
string	excelSheetName	Name of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load

Returns

Type	Description
bool

OpenExcel(string, int, string, ExcelOpenFlags, string)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

Declaration

public bool OpenExcel(string fileName, int spreadSheetIndex, string excelSheetName, ExcelOpenFlags excelOpenFlags, string password)

Public Function OpenExcel(fileName As String, spreadSheetIndex As Integer, excelSheetName As String, excelOpenFlags As ExcelOpenFlags, password As String) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of the file to open
int	spreadSheetIndex	Index of the sheet in the Spread component into which to load the Excel sheet
string	excelSheetName	Name of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load
string	password	The password

Returns

Type	Description
bool

OpenExcel(string, string, string, ExcelOpenFlags)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

Declaration

public bool OpenExcel(string fileName, string spreadSheetName, string excelSheetName, ExcelOpenFlags excelOpenFlags)

Public Function OpenExcel(fileName As String, spreadSheetName As String, excelSheetName As String, excelOpenFlags As ExcelOpenFlags) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of the file to open
string	spreadSheetName	Name of the sheet in the Spread component into which to load the Excel sheet
string	excelSheetName	Name of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load

Returns

Type	Description
bool

OpenExcel(string, string, string, ExcelOpenFlags, string)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

Declaration

public bool OpenExcel(string fileName, string spreadSheetName, string excelSheetName, ExcelOpenFlags excelOpenFlags, string password)

Public Function OpenExcel(fileName As String, spreadSheetName As String, excelSheetName As String, excelOpenFlags As ExcelOpenFlags, password As String) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of the file to open
string	spreadSheetName	Name of the sheet in the Spread component into which to load the Excel sheet
string	excelSheetName	Name of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load
string	password	The password.

Returns

Type	Description
bool

OpenExcel(string, int, int, ExcelOpenFlags)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

Declaration

public bool OpenExcel(string fileName, int spreadSheetIndex, int excelSheetIndex, ExcelOpenFlags excelOpenFlags)

Public Function OpenExcel(fileName As String, spreadSheetIndex As Integer, excelSheetIndex As Integer, excelOpenFlags As ExcelOpenFlags) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of the file to open
int	spreadSheetIndex	Index of the sheet in the Spread component into which to load the Excel sheet
int	excelSheetIndex	Index of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load

Returns

Type	Description
bool

OpenExcel(string, int, int, ExcelOpenFlags, ExcelWarningList)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts and keeps track of warnings.

Declaration

public bool OpenExcel(string fileName, int spreadSheetIndex, int excelSheetIndex, ExcelOpenFlags excelOpenFlags, ExcelWarningList warningList)

Public Function OpenExcel(fileName As String, spreadSheetIndex As Integer, excelSheetIndex As Integer, excelOpenFlags As ExcelOpenFlags, warningList As ExcelWarningList) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of the file to open
int	spreadSheetIndex	Index of the sheet in the Spread component into which to load the Excel sheet
int	excelSheetIndex	Index of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

OpenExcel(string, int, int, ExcelOpenFlags, ExcelWarningList, string)

Opens an Excel file and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts and keeps track of warnings.

Declaration

public bool OpenExcel(string fileName, int spreadSheetIndex, int excelSheetIndex, ExcelOpenFlags excelOpenFlags, ExcelWarningList warningList, string password)

Public Function OpenExcel(fileName As String, spreadSheetIndex As Integer, excelSheetIndex As Integer, excelOpenFlags As ExcelOpenFlags, warningList As ExcelWarningList, password As String) As Boolean

Parameters

Type	Name	Description
string	fileName	Path and name of the file to open
int	spreadSheetIndex	Index of the sheet in the Spread component into which to load the Excel sheet
int	excelSheetIndex	Index of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load
ExcelWarningList	warningList	List of warning messages that occur during this operation
string	password	The password

Returns

Type	Description
bool

OpenExcel(Stream)

Opens an Excel stream and loads it into the Spread component.

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 Storage file

Returns

Type	Description
bool

OpenExcel(Stream, string)

Opens an Excel stream and loads it into the Spread component.

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 Storage file
string	password	The password

Returns

Type	Description
bool

OpenExcel(Stream, ExcelWarningList)

Opens an Excel stream into the Spread component keeping track 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 that contains an Excel Compound Storage file
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

OpenExcel(Stream, int, string)

Opens an Excel stream and loads the specified Excel sheet (by name) into this sheet of the Spread component (by index).

Declaration

public bool OpenExcel(Stream stream, int spreadSheetIndex, string excelSheetName)

Public Function OpenExcel(stream As Stream, spreadSheetIndex As Integer, excelSheetName As String) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
int	spreadSheetIndex	Index of the sheet in the Spread component into which to load the Excel sheet
string	excelSheetName	Name of the Excel sheet to load

Returns

Type	Description
bool

OpenExcel(Stream, string, string)

Opens an Excel stream and loads the specified Excel sheet (by name) into this sheet of the Spread component (by name).

Declaration

public bool OpenExcel(Stream stream, string spreadSheetName, string excelSheetName)

Public Function OpenExcel(stream As Stream, spreadSheetName As String, excelSheetName As String) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
string	spreadSheetName	Name of the sheet in the Spread component into which to load the Excel sheet
string	excelSheetName	Name of the Excel sheet to load

Returns

Type	Description
bool

OpenExcel(Stream, int, int)

Opens an Excel stream and loads the specified Excel sheet (by index) into this sheet of the Spread component (by index).

Declaration

public bool OpenExcel(Stream stream, int spreadSheetIndex, int excelSheetIndex)

Public Function OpenExcel(stream As Stream, spreadSheetIndex As Integer, excelSheetIndex As Integer) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
int	spreadSheetIndex	Index of the Spread component sheet into which the Excel sheet is to load
int	excelSheetIndex	Index of the Excel sheet to load

Returns

Type	Description
bool

OpenExcel(Stream, int, int, ExcelWarningList)

Opens an Excel stream and loads the specified Excel sheet (by index) into this sheet of the Spread component (by index) keeping track of warnings.

Declaration

public bool OpenExcel(Stream stream, int spreadSheetIndex, int excelSheetIndex, ExcelWarningList warningList)

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

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
int	spreadSheetIndex	Index of the Spread component sheet into which the Excel sheet is to load
int	excelSheetIndex	Index of the Excel sheet to load
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

OpenExcel(Stream, ExcelOpenFlags)

Opens an Excel stream into the Spread component including the specified parts of the spreadsheet.

Declaration

public bool OpenExcel(Stream stream, ExcelOpenFlags excelOpenFlags)

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

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load

Returns

Type	Description
bool

OpenExcel(Stream, ExcelOpenFlags, ExcelWarningList)

Opens an Excel stream into the Spread component including the specified parts keeping track of warnings.

Declaration

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

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

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

OpenExcel(Stream, ExcelOpenFlags, ExcelWarningList, string)

Opens an Excel stream into the Spread component including the specified parts keeping track of warnings.

Declaration

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

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

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load
ExcelWarningList	warningList	List of warning messages that occur during this operation
string	password	The password

Returns

Type	Description
bool

OpenExcel(Stream, int, string, ExcelOpenFlags)

Opens an Excel stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

Declaration

public bool OpenExcel(Stream stream, int spreadSheetIndex, string excelSheetName, ExcelOpenFlags excelOpenFlags)

Public Function OpenExcel(stream As Stream, spreadSheetIndex As Integer, excelSheetName As String, excelOpenFlags As ExcelOpenFlags) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
int	spreadSheetIndex	Index of the sheet in the Spread component into which to load the Excel sheet
string	excelSheetName	Name of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load

Returns

Type	Description
bool

OpenExcel(Stream, int, string, ExcelOpenFlags, string)

Opens an Excel stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

Declaration

public bool OpenExcel(Stream stream, int spreadSheetIndex, string excelSheetName, ExcelOpenFlags excelOpenFlags, string password)

Public Function OpenExcel(stream As Stream, spreadSheetIndex As Integer, excelSheetName As String, excelOpenFlags As ExcelOpenFlags, password As String) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
int	spreadSheetIndex	Index of the sheet in the Spread component into which to load the Excel sheet
string	excelSheetName	Name of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load
string	password	The password

Returns

Type	Description
bool

OpenExcel(Stream, string, string, ExcelOpenFlags)

Opens an Excel stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

Declaration

public bool OpenExcel(Stream stream, string spreadSheetName, string excelSheetName, ExcelOpenFlags excelOpenFlags)

Public Function OpenExcel(stream As Stream, spreadSheetName As String, excelSheetName As String, excelOpenFlags As ExcelOpenFlags) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
string	spreadSheetName	Name of the sheet in the Spread component into which to load the Excel sheet
string	excelSheetName	Name of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load

Returns

Type	Description
bool

OpenExcel(Stream, string, string, ExcelOpenFlags, string)

Opens an Excel stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

Declaration

public bool OpenExcel(Stream stream, string spreadSheetName, string excelSheetName, ExcelOpenFlags excelOpenFlags, string password)

Public Function OpenExcel(stream As Stream, spreadSheetName As String, excelSheetName As String, excelOpenFlags As ExcelOpenFlags, password As String) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
string	spreadSheetName	Name of the sheet in the Spread component into which to load the Excel sheet
string	excelSheetName	Name of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load
string	password	The password.

Returns

Type	Description
bool

OpenExcel(Stream, int, int, ExcelOpenFlags)

Opens an Excel file from a stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts.

Declaration

public bool OpenExcel(Stream stream, int spreadSheetIndex, int excelSheetIndex, ExcelOpenFlags excelOpenFlags)

Public Function OpenExcel(stream As Stream, spreadSheetIndex As Integer, excelSheetIndex As Integer, excelOpenFlags As ExcelOpenFlags) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
int	spreadSheetIndex	Index of the Spread sheet into which the Excel sheet is to load
int	excelSheetIndex	Index of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load

Returns

Type	Description
bool

OpenExcel(Stream, int, int, ExcelOpenFlags, ExcelWarningList)

Opens an Excel file from a stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts and keeps track of warnings.

Declaration

public bool OpenExcel(Stream stream, int spreadSheetIndex, int excelSheetIndex, ExcelOpenFlags excelOpenFlags, ExcelWarningList warningList)

Public Function OpenExcel(stream As Stream, spreadSheetIndex As Integer, excelSheetIndex As Integer, excelOpenFlags As ExcelOpenFlags, warningList As ExcelWarningList) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
int	spreadSheetIndex	Index of the Spread sheet into which the Excel sheet is to load
int	excelSheetIndex	Index of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load
ExcelWarningList	warningList	List of warning messages that occur during this operation

Returns

Type	Description
bool

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

Opens an Excel file from a stream and loads the specified Excel sheet into the specified sheet of the Spread component including the specified parts and keeps track of warnings.

Declaration

public bool OpenExcel(Stream stream, int spreadSheetIndex, int excelSheetIndex, ExcelOpenFlags excelOpenFlags, ExcelWarningList warningList, string password)

Public Function OpenExcel(stream As Stream, spreadSheetIndex As Integer, excelSheetIndex As Integer, excelOpenFlags As ExcelOpenFlags, warningList As ExcelWarningList, password As String) As Boolean

Parameters

Type	Name	Description
Stream	stream	Stream that contains an Excel Compound Storage file
int	spreadSheetIndex	Index of the Spread sheet into which the Excel sheet is to load
int	excelSheetIndex	Index of the Excel sheet to load
ExcelOpenFlags	excelOpenFlags	Which parts of the spreadsheet to load
ExcelWarningList	warningList	List of warning messages that occur during this operation
string	password	The password

Returns

Type	Description
bool

OpenExcel Method