Class GridGroupingExcelConverterBase

Implements the basic exporting functionality common to GridGroupingControl.

Inheritance

System.Object

GridGroupingExcelConverterBase

GridGroupingExcelConverterControl

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.GridExcelConverter

Assembly: Syncfusion.GridConverter.Windows.dll

Syntax

public class GridGroupingExcelConverterBase

Constructors

GridGroupingExcelConverterBase()

Initializes a new instance of the GridGroupingExcelConverterBase class.

Declaration

public GridGroupingExcelConverterBase()

Fields

DEF_MAXIMUM_ANGLE

Maximum possible angle value.

Declaration

protected const int DEF_MAXIMUM_ANGLE = 360

Field Value

Type
System.Int32

DEF_MINIMUM_SUPPORTED_ANGLE

Angle that corresponds to 90 rotation value in the XlsIO.

Declaration

protected const int DEF_MINIMUM_SUPPORTED_ANGLE = 270

Field Value

Type
System.Int32

DEF_RIGHT_ANGLE

Right angle value.

Declaration

protected const int DEF_RIGHT_ANGLE = 90

Field Value

Type
System.Int32

Properties

ExportBorders

Gets or sets a value indicating whether borders has to be exported.

Declaration

public bool ExportBorders { get; set; }

Property Value

Type
System.Boolean

ExportMode

Gets or sets the exporting mode of grid data.

Declaration

public GridGroupingExcelConverterBase.ExportingMode ExportMode { get; set; }

Property Value

Type
GridGroupingExcelConverterBase.ExportingMode

ExportStyle

Gets or sets a value indicating whether styles has to be exported. For example, styles like borders,colors,..and so on.

Declaration

public bool ExportStyle { get; set; }

Property Value

Type
System.Boolean

Methods

CreateEngine()

Creates excel engine.

Declaration

protected ExcelEngine CreateEngine()

Returns

Type	Description
ExcelEngine	Newly created ExcelEngine.

Remarks

The caller of this method is responsible for calling Dispose on the created ExcelEngine after all workbooks have been closed and the caller is finished with the engine.

ExportAlignment(GridStyleInfo, IRange)

Exports the grid cell alignment.

Declaration

protected virtual void ExportAlignment(GridStyleInfo style, IRange range)

Parameters

Type	Name	Description
GridStyleInfo	style	The grid cell's style info.
IRange	range	The Excel sheet cell's style info.

Exceptions

Type	Condition
System.ArgumentNullException	if `style` or `range` is `null`.

ExportBackcolor(GridStyleInfo, IRange)

Used to export the cell's backcolor.

Declaration

protected virtual void ExportBackcolor(GridStyleInfo style, IRange range)

Parameters

Type	Name	Description
GridStyleInfo	style	The cell style.
IRange	range	Destination excel sheet range.

Exceptions

Type	Condition
System.ArgumentNullException	if `style` or `range` is `null`.

ExportBorderStyle(GridBorder, IBorder)

Exports the border settings from grid border into excel sheet border.

Declaration

protected virtual void ExportBorderStyle(GridBorder cellBorder, IBorder range)

Parameters

Type	Name	Description
GridBorder	cellBorder	Grid border to copy.
IBorder	range	Destination excel border.

Exceptions

Type	Condition
System.ArgumentNullException	if `cellBorder` or `range` is `null`.

ExportBorderStyles(GridStyleInfo, IRange)

Exports the border styles to excel.

Declaration

protected virtual void ExportBorderStyles(GridStyleInfo gridCell, IRange range)

Parameters

Type	Name	Description
GridStyleInfo	gridCell	The cell style.
IRange	range	Destination excel sheet range.

Exceptions

Type	Condition
System.ArgumentNullException	if `gridCell` or `range` is `null`.

ExportCellValue(GridStyleInfo, IWorksheet, Int32, Int32)

Exports the cell value to Excel sheet.

Declaration

protected virtual void ExportCellValue(GridStyleInfo style, IWorksheet sheet, int excelRowIndex, int columnIndex)

Parameters

Type	Name	Description
GridStyleInfo	style	The grid cell's style info.
IWorksheet	sheet	The Excel sheet cell's style info.
System.Int32	excelRowIndex	The row index of the particular data.
System.Int32	columnIndex	the column index of the particular range.

ExportFontStyles(GridStyleInfo, IRange)

Exports font styles to Excel sheet.

Declaration

protected virtual void ExportFontStyles(GridStyleInfo style, IRange range)

Parameters

Type	Name	Description
GridStyleInfo	style	The cell style.
IRange	range	The destination excel sheet IRange.

Exceptions

Type	Condition
System.ArgumentNullException	if `style` or `range` is `null`.

ExportFormula(GridStyleInfo, IRange)

Exports the formula to Excel sheet.

Declaration

protected virtual void ExportFormula(GridStyleInfo style, IRange range)

Parameters

Type	Name	Description
GridStyleInfo	style	The grid cell's style info.
IRange	range	The Excel sheet cell's style info.

Exceptions

Type	Condition
System.ArgumentNullException	if `style` or `range` is `null`.

ExportHyperLink(GridStyleInfo, IRange)

Exports the grid hyperlink cells to Excel sheet cell.

Declaration

protected virtual void ExportHyperLink(GridStyleInfo style, IRange range)

Parameters

Type	Name	Description
GridStyleInfo	style	The grid cell's style info.
IRange	range	The Excel sheet cell's style info.

Exceptions

Type	Condition
System.ArgumentNullException	if `style` or `range` is `null`.

ExportImage(GridStyleInfo, IRange)

Exports the grid cell images to excel sheet cell.

Declaration

protected virtual void ExportImage(GridStyleInfo gridCell, IRange range)

Parameters

Type	Name	Description
GridStyleInfo	gridCell	The grid cell.
IRange	range	The excel cell.

Exceptions

Type	Condition
System.ArgumentNullException	if `gridCell` or `range` is `null`.

ExportNumberFormat(GridStyleInfo, IRange)

Exports the number format to Excel sheet.

Declaration

protected virtual void ExportNumberFormat(GridStyleInfo style, IRange range)

Parameters

Type	Name	Description
GridStyleInfo	style	The cell style.
IRange	range	Destination excel sheet range.

Exceptions

Type	Condition
System.ArgumentNullException	if `style` or `range` is `null`.

ExportStyles(GridStyleInfo, IRange)

Exports the cellstyles such as fonts, backcolors, alignments to Excel sheet.

Declaration

protected virtual void ExportStyles(GridStyleInfo style, IRange range)

Parameters

Type	Name	Description
GridStyleInfo	style	The grid cell's style info.
IRange	range	The Excel sheet cell's style info.

Exceptions

Type	Condition
System.ArgumentNullException	if `style` or `range` is `null`.