Share via


ReportRun.caption(String, String, String, String) Method

Definition

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

public:
 virtual System::String ^ caption(System::String ^ _reportSpelling, System::String ^ _reportName, System::String ^ _designCaption, System::String ^ _designName);
public virtual string caption (string _reportSpelling, string _reportName, string _designCaption, string _designName);
abstract member caption : string * string * string * string -> string
override this.caption : string * string * string * string -> string
Public Overridable Function caption (_reportSpelling As String, _reportName As String, _designCaption As String, _designName As String) As String

Parameters

_reportSpelling
String

The name of the design.

_reportName
String

The name of the design.

_designCaption
String

The name of the design.

_designName
String

The name of the design.

Returns

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.

Applies to