Back to Devexpress

TBasedxReportLink.PageSetupEx(Integer,Boolean,Boolean,Boolean,Boolean) Method

vcl-dxpscore-dot-tbasedxreportlink-dot-pagesetupex-x28-system-dot-integer-system-dot-boolean-system-dot-boolean-system-dot-boolean-system-dot-boolean-x29.md

latest2.1 KB
Original Source

TBasedxReportLink.PageSetupEx(Integer,Boolean,Boolean,Boolean,Boolean) Method

Invokes the Page Setup dialog.

Declaration

delphi
function PageSetupEx(AActivePageIndex: Integer; AShowPreviewBtn: Boolean; AShowPrintBtn: Boolean; out APreviewBtnClicked: Boolean; out APrintBtnClicked: Boolean): Boolean; overload;

Parameters

NameType
AActivePageIndexInteger
AShowPreviewBtnBoolean
AShowPrintBtnBoolean
APreviewBtnClickedBoolean
APrintBtnClickedBoolean

Returns

Type
Boolean

Remarks

Call this function to invoke the Page Setup dialog with the active tab whose zero-based index is passed as the AActivePageIndex parameter.

The AShowPreviewBtn and AShowPrintBtn parameters specify whether the “Print Preview…” and “Print…” buttons are displayed on the Page Setup dialog form while the APreviewBtnClicked and APrintBtnClicked parameters are used to identify if any of the buttons was clicked to close the dialog.

The PageSetupEx function returns True if an end-user:

  • Clicks the “Ok” button on the Page Setup form;

  • Closes the Print Preview dialog invoked by clicking the “Print Preview…” button on the Page Setup form;

  • Clicks the “Print” button on the Print dialog invoked by clicking the “Print…” button on the Page Setup form.

Otherwise, the function returns False.

See Also

TBasedxReportLink Class

TBasedxReportLink Members

dxPSCore Unit