Syncfusion.GridConverter.Windows


The element of the table.
The TableDescriptor of the ParentTable.
Visible columns collections.
Destination row index.
The start column for exporting the cells. This is mainly used for hierarchy export.
Stack indices for setting the grouping.
Destination worksheet.
Excel exporting options for some customization.

ExportCaptionRow Method (GridGroupingExcelConverterControl)

Exports the caption row to excel sheet.
Syntax
'Declaration
 
Protected Overridable Sub ExportCaptionRow( _
   ByVal element As Element, _
   ByVal tableDescriptor As GridTableDescriptor, _
   ByVal visibleColumns As GridVisibleColumnDescriptorCollection, _
   ByRef excelRowIndex As Integer, _
   ByVal excelStartColumnIndex As Integer, _
   ByVal groupStartIndexes As Stack, _
   ByVal sheet As IWorksheet, _
   ByVal exportingOptions As ExcelExportingOptions _
) 
'Usage
 
Dim instance As GridGroupingExcelConverterControl
Dim element As Element
Dim tableDescriptor As GridTableDescriptor
Dim visibleColumns As GridVisibleColumnDescriptorCollection
Dim excelRowIndex As Integer
Dim excelStartColumnIndex As Integer
Dim groupStartIndexes As Stack
Dim sheet As IWorksheet
Dim exportingOptions As ExcelExportingOptions
 
instance.ExportCaptionRow(element, tableDescriptor, visibleColumns, excelRowIndex, excelStartColumnIndex, groupStartIndexes, sheet, exportingOptions)

Parameters

element
The element of the table.
tableDescriptor
The TableDescriptor of the ParentTable.
visibleColumns
Visible columns collections.
excelRowIndex
Destination row index.
excelStartColumnIndex
The start column for exporting the cells. This is mainly used for hierarchy export.
groupStartIndexes
Stack indices for setting the grouping.
sheet
Destination worksheet.
exportingOptions
Excel exporting options for some customization.

Return Value

Returns True if Caption row is exported successfully otherwise returns False.
Exceptions
ExceptionDescription
If any of the parameters passed with null.
If row index is less or equal to 0.
AssemblyVersion

Syncfusion.GridConverter.Windows: 18.1460.0.36

See Also