User Guide Cancel

spreadsheetAddPrintGridlines

 

Description

Adds print gridlines between all rows and columns of the sheet from the spreadsheet object. The purpose of adding print gridlines to a spreadsheet is to ensure that the document prints in an organized, readable, and professional manner.

Returns

None 

History

  • ColdFusion (2025 release): Added the function.

Syntax

spreadsheetAddPrintGridlines(spreadSheetObject,sheetName)
spreadsheetAddPrintGridlines(spreadSheetObject,sheetName)
spreadsheetAddPrintGridlines(spreadSheetObject,sheetName)

Parameters

Name

 

 

Required

 

 

Type

 

 

Description

 

 

spreadSheetObject

 

 

Yes

 

 

ExcelInfo 

 

 

The Excel spreadsheet object to which you’ll add the gridlines.

 

sheetName

 

 

No

 

 

String 

 

 

The sheet in which you’ll add the gridlines. If you do not specify a sheetName, the function adds gridlines to the active sheet.

 

Example

<cfquery name="art" datasource="cfartgallery">
SELECT * FROM ART
</cfquery>
<cfscript>
theFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "art-gridline.xls";
// create a spreadsheet object
theSheet=spreadsheetNew("SampleData")
// add second sheet
spreadSheetCreateSheet(theSheet, "Sheet2")
// add rows from the table to the spreadsheet
spreadsheetAddRows(theSheet,art)
// add print gridlines
try{
spreadsheetAddPrintGridlines(theSheet,"Sheet2")
}
catch (any e){
writeOutput(e.message)
}
// remove print gridlines
spreadsheetRemovePrintGridlines(theSheet)
// write spreadsheet
spreadSheetWrite(theSheet,theFile,"yes")
</cfscript>
<cfquery name="art" datasource="cfartgallery"> SELECT * FROM ART </cfquery> <cfscript> theFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "art-gridline.xls"; // create a spreadsheet object theSheet=spreadsheetNew("SampleData") // add second sheet spreadSheetCreateSheet(theSheet, "Sheet2") // add rows from the table to the spreadsheet spreadsheetAddRows(theSheet,art) // add print gridlines try{ spreadsheetAddPrintGridlines(theSheet,"Sheet2") } catch (any e){ writeOutput(e.message) } // remove print gridlines spreadsheetRemovePrintGridlines(theSheet) // write spreadsheet spreadSheetWrite(theSheet,theFile,"yes") </cfscript>
<cfquery name="art" datasource="cfartgallery">
    SELECT * FROM ART
</cfquery>
<cfscript>
    theFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "art-gridline.xls";
    // create a spreadsheet object
    theSheet=spreadsheetNew("SampleData")
    // add second sheet
    spreadSheetCreateSheet(theSheet, "Sheet2")
    // add rows from the table to the spreadsheet
    spreadsheetAddRows(theSheet,art)
    // add print gridlines
    try{
        spreadsheetAddPrintGridlines(theSheet,"Sheet2")
    }
    catch (any e){
        writeOutput(e.message)
    }
    // remove print gridlines
    spreadsheetRemovePrintGridlines(theSheet)
    // write spreadsheet
    spreadSheetWrite(theSheet,theFile,"yes")
</cfscript>

Get help faster and easier

New user?