User Guide Cancel

spreadsheetIsRowHidden

 

Description

Checks if the specified row in a sheet is hidden.

Returns

True if the row is hidden. False, otherwise. 

History

  • ColdFusion (2025 release): Added the function.

Syntax

spreadsheetIsRowHidden(spreadSheetObject,row)
spreadsheetIsRowHidden(spreadSheetObject,row)
spreadsheetIsRowHidden(spreadSheetObject,row)

Parameters

Name

 

 

Required

 

 

Type

 

 

Description

 

 

spreadSheetObject

 

 

Yes

 

 

ExcelInfo 

 

 

The Excel spreadsheet object to check whether the row is hidden.

 

row

 

 

Yes

 

 

Integer 

 

 

The row to check if it's hidden.

 

 

Example

<cfquery name="art" datasource="cfartgallery">
SELECT * FROM ART
</cfquery>
<cfscript>
theFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "art-row-hidden.xls";
// create a spreadsheet object
theSheet=spreadsheetNew("SampleData")
// add rows from the table to the spreadsheet
spreadsheetAddRows(theSheet,art)
// hide row 1 in the spreadsheet
spreadsheetSetRowHidden(theSheet,1,"TRUE")
// check if row is hidden
isHidden=spreadsheetIsRowHidden(theSheet,1)
writeOutput(isHidden) // YES
</cfscript>
<cfquery name="art" datasource="cfartgallery"> SELECT * FROM ART </cfquery> <cfscript> theFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "art-row-hidden.xls"; // create a spreadsheet object theSheet=spreadsheetNew("SampleData") // add rows from the table to the spreadsheet spreadsheetAddRows(theSheet,art) // hide row 1 in the spreadsheet spreadsheetSetRowHidden(theSheet,1,"TRUE") // check if row is hidden isHidden=spreadsheetIsRowHidden(theSheet,1) writeOutput(isHidden) // YES </cfscript>
<cfquery name="art" datasource="cfartgallery">
    SELECT * FROM ART
</cfquery>
<cfscript>
    theFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "art-row-hidden.xls";
    // create a spreadsheet object
    theSheet=spreadsheetNew("SampleData")
    // add rows from the table to the spreadsheet
    spreadsheetAddRows(theSheet,art)
    // hide row 1 in the spreadsheet
    spreadsheetSetRowHidden(theSheet,1,"TRUE")
    // check if row is hidden
    isHidden=spreadsheetIsRowHidden(theSheet,1)
    writeOutput(isHidden) // YES
</cfscript>

Get help faster and easier

New user?