C1.WPF.Grid.Extensions.LoadExcelAsync
LoadExcelAsync Method
LoadExcelAsync(FlexGrid, string)
Loads data from an Excel file into the specified grid asynchronously.
Declaration
public static Task LoadExcelAsync(this FlexGrid grid, string fileName)Public Shared Function LoadExcelAsync(grid As FlexGrid, fileName As String) As TaskParameters
| Type | Name | Description |
|---|---|---|
| FlexGrid | grid | Instance of the FlexGrid to load the data into. |
| string | fileName | The path to the Excel file. |
Returns
| Type | Description |
|---|---|
| Task | A Task representing the asynchronous operation. |
Examples
var grid = new FlexGrid();
await grid.LoadExcel("ExcelFileSample.xlsx");Exceptions
LoadExcelAsync(FlexGrid, string, string)
Loads data from an Excel file into the specified grid asynchronously.
Declaration
public static Task LoadExcelAsync(this FlexGrid grid, string fileName, string sheetName)Public Shared Function LoadExcelAsync(grid As FlexGrid, fileName As String, sheetName As String) As TaskParameters
| Type | Name | Description |
|---|---|---|
| FlexGrid | grid | Instance of the FlexGrid to load the data into. |
| string | fileName | The path to the Excel file. |
| string | sheetName | The name of the Excel sheet to load. If null, the first sheet will be loaded by default. |
Returns
| Type | Description |
|---|---|
| Task | A Task representing the asynchronous operation. |
Exceptions
LoadExcelAsync(FlexGrid, string, LoadExcelOptions)
Loads data from an Excel file into the specified grid asynchronously.
Declaration
public static Task LoadExcelAsync(this FlexGrid grid, string fileName, LoadExcelOptions options)Public Shared Function LoadExcelAsync(grid As FlexGrid, fileName As String, options As LoadExcelOptions) As TaskParameters
| Type | Name | Description |
|---|---|---|
| FlexGrid | grid | Instance of the FlexGrid to load the data into. |
| string | fileName | The path to the Excel file. |
| LoadExcelOptions | options | A LoadExcelOptions loading options. |
Returns
| Type | Description |
|---|---|
| Task | A Task representing the asynchronous operation. |
Exceptions
LoadExcelAsync(FlexGrid, string, string, LoadExcelOptions)
Loads data from an Excel file into the specified grid asynchronously.
Declaration
public static Task LoadExcelAsync(this FlexGrid grid, string fileName, string sheetName, LoadExcelOptions options)Public Shared Function LoadExcelAsync(grid As FlexGrid, fileName As String, sheetName As String, options As LoadExcelOptions) As TaskParameters
| Type | Name | Description |
|---|---|---|
| FlexGrid | grid | Instance of the FlexGrid to load the data into. |
| string | fileName | The path to the Excel file. |
| string | sheetName | The name of the Excel sheet to load. If null, the first sheet will be loaded by default. |
| LoadExcelOptions | options | A LoadExcelOptions loading options. |
Returns
| Type | Description |
|---|---|
| Task | A Task representing the asynchronous operation. |
Exceptions
LoadExcelAsync(FlexGrid, string, ExcelFileFormat, string, LoadExcelOptions, CancellationToken)
Loads data from an Excel file into the specified grid asynchronously.
Declaration
public static Task LoadExcelAsync(this FlexGrid grid, string fileName, ExcelFileFormat fileFormat, string sheetName, LoadExcelOptions options, CancellationToken cancellationToken)Public Shared Function LoadExcelAsync(grid As FlexGrid, fileName As String, fileFormat As ExcelFileFormat, sheetName As String, options As LoadExcelOptions, cancellationToken As CancellationToken) As TaskParameters
| Type | Name | Description |
|---|---|---|
| FlexGrid | grid | Instance of the FlexGrid to load the data into. |
| string | fileName | The path to the Excel file. |
| ExcelFileFormat | fileFormat | A ExcelFileFormat file format. |
| string | sheetName | The name of the Excel sheet to load. If null, the first sheet will be loaded by default. |
| LoadExcelOptions | options | A LoadExcelOptions loading options. |
| CancellationToken | cancellationToken | The token to monitor for cancellation requests. |
Returns
| Type | Description |
|---|---|
| Task | A Task representing the asynchronous operation. |