Note:

You can find the CFFiddle demo of this function and other spreadsheet functions as part of a project that is shared with you.

Click the button below to launch CFFiddle.

To copy the project in your workspace in CFFiddle, follow the steps below:

  1. Log in with your Gmail or Facebook credentials.
  2. Navigate to the project in the left pane.
  3. Once you make some changes in any cfm in the project, a pop up displays asking you to save the project.
  4. Give the project a suitable name and click Save.

Description

Splits panes into four separate worksheet areas.

Returns

Nothing

Category

Syntax

SpreadsheetAddSplitPane(spreadsheetobj, x-position, y-position, splitcol, splitrow [, position])

See also

History

ColdFusion 9: Added the function.

Parameters

Parameter

Description

spreadsheetobj

The Excel spreadsheet object to which to add the split pane.

x-position

Specifies the x-axis position of the first quadrant. The x-position value is 1/20th the value of a pixel in the worksheet.

y-position

Specifies the y-axis position of the first quadrant. The y-position value is 1/20th the value of a pixel in the worksheet.

splitcol

Specifies the columns that appear in quadrant 2 of the spreadsheet.

splitrow

Specifies the rows that appear in quadrant 3 of the spreadsheet.

position

This parameter is optional. Specifies the position to apply the split bar to split the pane. It can be one of the following:

  • LOWER_LEFT
  • LOWER_RIGHT
  • UPPER_RIGHT
  • UPPER_LEFT

Usage

You can split the pane into four worksheet areas in the spread sheet. The split is applied at the pixel level. You can adjust the worksheet area by dragging the split bar, as required.

Example

The following example splits the spreadsheet into four quadrants. The x and y positions are at 2000 and 2000 values.

<cfscript>
       ArtOrders=QueryExecute("SELECT orderid,customerfirstname,customerlastname,address,total,city FROM orders
       ORDER BY orderid",[],{datasource="cfartgallery"});
       // Set the file path in the same location as this cfm
       myFile=GetDirectoryFromPath(GetCurrentTemplatePath()) & "mysplitfile.xlsx";
       // Create spreadsheet object. Set xml to true as this is an xlsx file
       mySheet=SpreadsheetNew("ColdFusion",true);
       // Set headers for the xlsx file
       SpreadSheetAddRow(mySheet,"Order,First Name,Last Name,Address,Amount,City");
       // Add row values
       SpreadSheetAddRows(mySheet,ArtOrders);
       SpreadsheetAddSplitPane(mySheet,2000, 2000, 4, 9, "LOWER_LEFT");
       SpreadsheetWrite(mySheet,"#myFile#",true);
</cfscript>

Output

spreadsheetaddsplitpane output
spreadsheetaddsplitpane output

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy