TdxSpreadSheetInsertPageBreak Class

An action object corresponding to the InsertPageBreak command that the Spreadsheet and Report Designer controls provide.

Declaration

TdxSpreadSheetInsertPageBreak = class(
    TdxSpreadSheetCustomPrintingAction
)

Remarks

This class does not introduce any new public members. Its overridden Execute function call inserts a row and/or column page break into the active worksheet depending on the focused cell‘s position.

This command inserts:

A row page break between the row where the focused cell is located and the upper adjacent row. If there is no upper adjacent row (that is, the focused cell is within the topmost row), the command does not insert a row page break.
A column page break between the column where the focused cell is located and the adjacent column to the left. If there is no such column (that is, the focused cell is within the leftmost column), the command does not insert a column page break.
No page breaks if the A1 (or R1C1) cell has focus or the active worksheet already includes the custom page break(s) corresponding to the current focused cell’s position.

UI elements linked to a TdxSpreadSheetInsertPageBreak action object are enabled only if an in-place cell editor is inactive (that is, the active worksheet’s IsEditing property returns False).

To localize the caption and hint of UI elements linked to a TdxSpreadSheetInsertPageBreak action object, use the sdxSpreadSheetActionInsertPageBreakCaption and sdxSpreadSheetActionInsertPageBreakHint resource strings, respectively.

Note

Set the control’s OptionsView.PrintAreas property to True to visualize custom page breaks.