Class GridExcelHelper
Helper class to convert grid range to excel range, and excel range to grid range.
Inheritance
Namespace: Syncfusion.UI.Xaml.Spreadsheet.Helpers
Assembly: Syncfusion.SfSpreadsheet.WPF.dll
Syntax
public static class GridExcelHelper : Object
Methods
ConvertExcelRangeToGridRange(IRange)
Coverts the excel range to the corresponding grid range.
Declaration
public static GridRangeInfo ConvertExcelRangeToGridRange(this IRange range)
Parameters
Type | Name | Description |
---|---|---|
IRange | range | Excel range which is to be converted to grid range. |
Returns
Type | Description |
---|---|
GridRangeInfo | Grid range. |
ConvertExcelRangeToGridRange(IRange, SpreadsheetGrid)
Convert the excel range to the corresponding grid range types either of rows/columns/table/cells.
Declaration
public static GridRangeInfo ConvertExcelRangeToGridRange(this IRange range, SpreadsheetGrid grid)
Parameters
Type | Name | Description |
---|---|---|
IRange | range | Excel range to be converted as grid range. |
SpreadsheetGrid | grid | Active instance of SpreadsheetGrid. |
Returns
Type | Description |
---|---|
GridRangeInfo | Grid range. |
ConvertGridRangeToExcelRange(GridRangeInfo, SpreadsheetGrid)
Converts the Grid range to the corresponding Excel range.
Declaration
public static string ConvertGridRangeToExcelRange(this GridRangeInfo gridRangeInfo, SpreadsheetGrid grid)
Parameters
Type | Name | Description |
---|---|---|
GridRangeInfo | gridRangeInfo | Grid range to be converted as excel range. |
SpreadsheetGrid | grid | Active instance of SpreadsheetGrid. |
Returns
Type | Description |
---|---|
System.String | Converted excel range in string format. |
ConvertToGlobalWorkbookRange(GridRangeInfo, SpreadsheetGrid)
Converts the grid range to workbook range (Address Global = "'Sheet1'!$A$1").
Declaration
public static string ConvertToGlobalWorkbookRange(this GridRangeInfo range, SpreadsheetGrid grid)
Parameters
Type | Name | Description |
---|---|---|
GridRangeInfo | range | Current grid range. |
SpreadsheetGrid | grid | An instance of SpreadsheetGrid. |
Returns
Type | Description |
---|---|
System.String | Global Address of the Workbook. |
GetExpandRange(GridRangeInfo, SpreadsheetGrid)
Gets the Expanded range when the column/row/table is selected in active SpreadsheetGrid.
Declaration
public static GridRangeInfo GetExpandRange(this GridRangeInfo range, SpreadsheetGrid grid)
Parameters
Type | Name | Description |
---|---|---|
GridRangeInfo | range | Range to be expanded. |
SpreadsheetGrid | grid | Current instance of SpreadsheetGrid. |
Returns
Type | Description |
---|---|
GridRangeInfo | Expanded grid range. |
InvalidateCellRange(SpreadsheetGrid)
This method invalidates/refreshes the total used cell ranges, imported from data table in grid.
Declaration
public static void InvalidateCellRange(this SpreadsheetGrid grid)
Parameters
Type | Name | Description |
---|---|---|
SpreadsheetGrid | grid | An instance of SpreadsheetGrid. |
IsRangeContainsComment(SpreadsheetGrid, GridRangeInfo)
Determines whether the range contains comment or not.
Declaration
public static bool IsRangeContainsComment(this SpreadsheetGrid grid, GridRangeInfo range)
Parameters
Type | Name | Description |
---|---|---|
SpreadsheetGrid | grid | An instance of SpreadsheetGrid. |
GridRangeInfo | range | Ranges which are selected. |
Returns
Type | Description |
---|---|
System.Boolean | True, if the selected range contains comment; otherwise false. |
IsRangeContainsHyperlink(GridRangeInfoList, SpreadsheetGrid)
Determines whether the hyperlink is present in the selected ranges of the active SpreadsheetGrid.
Declaration
public static bool IsRangeContainsHyperlink(GridRangeInfoList selectedranges, SpreadsheetGrid grid)
Parameters
Type | Name | Description |
---|---|---|
GridRangeInfoList | selectedranges | Ranges which are selected. |
SpreadsheetGrid | grid | An instance of SpreadsheetGrid. |
Returns
Type | Description |
---|---|
System.Boolean | True, if the selected range contains hyperlink; otherwise false. |