Back to Devexpress

TCustomdxComponentPrinter.DesignReport(TBasedxReportLink) Method

vcl-dxpscore-dot-tcustomdxcomponentprinter-dot-designreport-x28-dxpscore-dot-tbasedxreportlink-x29.md

latest3.6 KB
Original Source

TCustomdxComponentPrinter.DesignReport(TBasedxReportLink) Method

Opens the Report Designer dialog.

Declaration

delphi
function DesignReport(AReportLink: TBasedxReportLink = nil): Boolean;

Parameters

NameTypeDescription
AReportLinkTBasedxReportLink

Optional. The source print link.

If this parameter is omitted (the parameter value is nil in Delphi or nullptr in C++Builder), the function uses the current print link as the target for the Report Designer dialog.

|

Returns

TypeDescription
Boolean
  • True if the Report Designer dialog applies pending changes when closed.
  • False if the displayed dialog is closed without confirmation.

|

Remarks

Call the DesignReport function to open the Report Designer dialog for a supported print link.

Code Example: Display Report Designer

The following code example rebuilds a report and opens the Report Designer dialog:

delphi
dxComponentPrinter1Link1.DesignerCaption := 'Report Designer';
  dxComponentPrinter1.RebuildReport(dxComponentPrinter1Link1);
  dxComponentPrinter1.DesignReport(dxComponentPrinter1Link1);
cpp
dxComponentPrinter1Link1->DesignerCaption = "Report Designer";
  dxComponentPrinter1->RebuildReport(dxComponentPrinter1Link1);
  dxComponentPrinter1->DesignReport(dxComponentPrinter1Link1);

Only the following report links register corresponding Report Designer dialog forms:

Data Grid

TdxGridReportLinkRepresents a ReportLink object used by the ExpressPrinting System to print the ExpressQuantumGrid component.

Pivot Grid

TcxPivotGridReportLinkA report link for Pivot Grid controls.

Scheduler

TcxSchedulerReportLinkImplements the scheduler’s report generating component.

Tree List

TcxDBTreeListReportLinkRepresents a report link for printing out the data aware TreeList control.TcxTreeListReportLinkRepresents a report link for printing out the standard TreeList control.TcxVirtualTreeListReportLinkRepresents a report link for printing out the standard TreeList control.

Vertical Grid

TcxRTTIInspectorReportLinkRepresents the report link used for printing out the cxRTTIInspector control.TcxUnboundVerticalGridReportLinkRepresents the report link used to print out single record controls.TcxVerticalGridReportLinkRepresents the report link used for printing out the cxVerticalGrid control. See Also

TCustomdxComponentPrinter.DesignerExists Function

TCustomdxComponentPrinter.DesignerExistsByComponent Function

TCustomdxComponentPrinter Class

TCustomdxComponentPrinter Members

dxPSCore Unit