User Guide Cancel

spreadsheetGroupRows

 

Description

Groups rows in a spreadsheet to allow you to organize and manage large data sets by collapsing or expanding sections of rows.

Returns

None 

History

  • ColdFusion (2025 release): Added the function.

Syntax

spreadsheetGroupRows(spreadSheetObject, int startRow, int endRow)
spreadsheetGroupRows(spreadSheetObject, int startRow, int endRow)
spreadsheetGroupRows(spreadSheetObject, int startRow, int endRow)

Parameters

Name

 

 

Required

 

 

Type

 

 

Description

 

 

spreadSheetObject

 

 

Yes

 

 

ExcelInfo

 

 

The Excel spreadsheet object to which you’ll group rows between two specified rows. 

 

 

startRow

 

 

Yes

 

 

Integer

 

 

The row number of the row where the group starts. 

 

 

endRow

 

 

Yes

 

 

Integer

 

 

The row number of the row where the group ends. 

 

 

Example

<cfquery name="art" datasource="cfartgallery">
SELECT * FROM ART
</cfquery>
<cfscript>
theFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "art-row.xls";
// create a spreadsheet object
theSheet=spreadsheetNew("SampleData")
// add rows from the table to the spreadsheet
spreadsheetAddRows(theSheet,art)
// group rows
spreadsheetGroupRows(theSheet,12,22)
// ungroup the rows
spreadsheetUnGroupRows(theSheet,12,22)
// write the spreadsheet
spreadsheetWrite(theSheet,theFile,"yes")
</cfscript>
<cfquery name="art" datasource="cfartgallery"> SELECT * FROM ART </cfquery> <cfscript> theFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "art-row.xls"; // create a spreadsheet object theSheet=spreadsheetNew("SampleData") // add rows from the table to the spreadsheet spreadsheetAddRows(theSheet,art) // group rows spreadsheetGroupRows(theSheet,12,22) // ungroup the rows spreadsheetUnGroupRows(theSheet,12,22) // write the spreadsheet spreadsheetWrite(theSheet,theFile,"yes") </cfscript>
<cfquery name="art" datasource="cfartgallery">
    SELECT * FROM ART
</cfquery>
<cfscript>
    theFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "art-row.xls";
    // create a spreadsheet object
    theSheet=spreadsheetNew("SampleData")
    // add rows from the table to the spreadsheet
    spreadsheetAddRows(theSheet,art)
    // group rows
    spreadsheetGroupRows(theSheet,12,22)
    // ungroup the rows
    spreadsheetUnGroupRows(theSheet,12,22)
    // write the spreadsheet
    spreadsheetWrite(theSheet,theFile,"yes")
</cfscript>

Get help faster and easier

New user?