SpreadsheetAddSplitPane

Description

Splits panes into four separate worksheet areas.

Returns

Does not return a value.

Category

Microsoft Office Integration

Function syntax

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

See also

SpreadsheetAddColumn, SpreadsheetAddImage, SpreadsheetAddRow, SpreadsheetDeleteRow, SpreadsheetDeleteRows, SpreadsheetFormatRow, SpreadsheetFormatRows, SpreadsheetShiftRows

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 attribute 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.
Note: You cannot split the pane into two worksheet areas.

Example

The following example splits the spreadsheet into four quadrants. The x and y positions are at 2000 and 2000 values. Column 5 of the spreadsheet appears in quadrant 2; and row 7 of the spreadsheet appears in quadrant 7. The split bar appears at the lower left side of the spreadsheet.
SpreadSheetAddSplitPane(spreadsheetobj, 2000, 2000, 5, 7, LOWER_LEFT );