Share via

ReportRun.caption Method

  • Article

Creates a caption when previewing a report, or a document name when printing a report.

Syntax

public str caption(
    str reportSpelling, 
    str reportName, 
    str designCaption, 
    str designName)

Run On

Called

Parameters

  • reportSpelling
    Type: str
    The word "Report".
  • reportName
    Type: str
    The name of the report.
  • designCaption
    Type: str
    The caption of the design.
  • designName
    Type: str
    The name of the design.

Return Value

Type: str
A string that contains "DesignLabel - ReportSpelling" if the DesignLabel is not empty.
A string that contains "ReportName(DesignName) - ReportSpelling" if the DesignLabel is empty.

Remarks

The call to the super method in this method creates a string that is used as a caption when previewing a report and as the document name when printing a report.It is recommended that you always fill out the Caption property of the report design so that the caption that is used during the preview of the report is in the actual language.

See Also

Reference

ReportRun Class