LoadExcelAsync(FlexGrid,String,ExcelFileFormat,String,LoadExcelOptions,CancellationToken) Method

In This Topic

Loads data from an Excel file into the specified grid asynchronously.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Shared Function LoadExcelAsync( _
   ByVal grid As FlexGrid, _
   ByVal fileName As String, _
   ByVal fileFormat As ExcelFileFormat, _
   ByVal sheetName As String, _
   ByVal options As LoadExcelOptions, _
   ByVal cancellationToken As CancellationToken _
) As Task

public static Task LoadExcelAsync( 
   FlexGrid grid,
   string fileName,
   ExcelFileFormat fileFormat,
   string sheetName,
   LoadExcelOptions options,
   CancellationToken cancellationToken
)

Parameters

grid: Instance of the FlexGrid to load the data into.
fileName: The path to the Excel file.
fileFormat: A ExcelFileFormat file format.
sheetName: The name of the Excel sheet to load. If null, the first sheet will be loaded by default.
options: A LoadExcelOptions loading options.
cancellationToken: The token to monitor for cancellation requests.

Return Value

A System.Threading.Tasks.Task representing the asynchronous operation.

Exceptions

Exception	Description
System.ArgumentException	The exception that is thrown when one of the arguments provided to a method is not valid.
System.ArgumentNullException	The exception that is thrown when a null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
System.IO.PathTooLongException	The exception that is thrown when a path or fully qualified file name is longer than the system-defined maximum length.
System.IO.DirectoryNotFoundException	The exception that is thrown when part of a file or directory cannot be found.
System.UnauthorizedAccessException	The exception that is thrown when the operating system denies access because of an I/O error or a specific type of security error.
System.IO.FileNotFoundException	The exception that is thrown when an attempt to access a file that does not exist on disk fails.
System.NotSupportedException	The exception that is thrown when an invoked method is not supported, or when there is an attempt to read, seek, or write to a stream that does not support the invoked functionality.
System.IO.IOException	The exception that is thrown when an I/O error occurs.
System.ArgumentOutOfRangeException	The exception that is thrown when the value of an argument is outside the allowable range of values as defined by the invoked method.
System.OperationCanceledException	The exception that is thrown in a thread upon cancellation of an operation that the thread was executing.

Reference

Extensions Class
Extensions Members
Overload List