SSGetColPageBreak, SSSetColPageBreak Functions

Applies To

fpSpread DLL control

Description

Set or return whether a page break occurs at the specified column when printing the sheet.

Syntax

BOOL SSGetColPageBreak(HWND hWnd, SS_COORD Col);

BOOL SSSetColPageBreak(HWND hWnd, SS_COORD Col, BOOL fPageBreak);

C++

BOOL TSpread::GetColPageBreak(SS_COORD Col);

BOOL TSpread::SetColPageBreak(SS_COORD Col, BOOL fPageBreak);

Parameters

The SSGetColPageBreak function has the following parameters:

Parameter	Description
hWnd	Window handle of the fpSpread control
Col	Column number of column to check for page breaks

The SSSetColPageBreak function has the following parameters:

Parameter	Description
hWnd	Window handle of the fpSpread control
Col	Column number of column to contain page break
fPageBreak	Sets page break

Remarks

This function is applied to the current sheet setting unless you first call the SSSetSheet function to specify the sheet for which you are calling this function. Use page breaks to format printed pages. Page breaks are not displayed on the screen, but force page breaks when you print the sheet. Page breaks occur to the left of the specified column.

For the SSSetColPageBreak function, set the fPageBreak parameter to TRUE to add a page break to the column. Set the parameter to FALSE to prevent a page break at that column.

Return Value

SSGetColPageBreak: TRUE if a page break is set for the specified column; FALSE if no page break is set for the specified column.
SSSetColPageBreak: TRUE if the function completes successfully; FALSE otherwise.

ActiveX Correspondence

ColPageBreak property