Spread 8.0 Documentation
SSGetRowPageBreak, SSSetRowPageBreak Functions
Support Options
DLL Reference > DLL Functions > SSGetRowPageBreak, SSSetRowPageBreak Functions

Glossary Item Box

SSGetRowPageBreak, SSSetRowPageBreak Functions


See Also    ActiveX

Applies To

fpSpread DLL control

Description

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

Syntax

C

BOOL SSGetRowPageBreak(HWND hWnd, SS_COORD Row);

BOOL SSSetRowPageBreak(HWND hWnd, SS_COORD Row, BOOL fPageBreak);

C++

BOOL TSpread::GetRowPageBreak(SS_COORD Row);

BOOL TSpread::SetRowPageBreak(SS_COORD Row, BOOL fPageBreak);

Parameters

The SSGetRowPageBreak function has the following parameters:

Parameter Description
hWnd Window handle of the fpSpread control
Row Row number of row to check for page breaks

The SSSetRowPageBreak function has the following parameters:

Parameter Description
hWnd Window handle of the fpSpread control
Row Row number of row 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. The page break occurs above the specified row.

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

Return Value

SSGetRowPageBreak: TRUE if a page break is set for the specified row; FALSE if no page break is set for the specified row.
SSSetRowPageBreak: TRUE if the function completes successfully; FALSE otherwise.

See Also

Specifying Print Page Breaks

SSGetColPageBreak, SSSetColPageBreak, SSSetSheet functions

ActiveX Correspondence

RowPageBreak property

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.