XtraReport.ScriptsSource Property

Specifies the report scripts.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core

Declaration

C#

[Browsable(false)]
[DefaultValue("")]
public string ScriptsSource { get; set; }

VB.NET

<DefaultValue("")>
<Browsable(False)>
Public Property ScriptsSource As String

Property Value

Type	Default	Description
String	String.Empty	A String value, storing the code of all report scripts.

Remarks

Use the ScriptsSource property to assign or access report scripts at runtime.

Before assigning the XtraReport.ScriptsSource in code, make sure to specify the XRControl.Name for each added report control. Otherwise, running the script will cause an exception, because the default control name is undefined.

The following code illustrates the correct approach.

C#

XtraReport report = new XtraReport();
report.Bands.Add(new DetailBand());

XRLabel label1 = new XRLabel();
label1.Name = "label1";
report.Bands[0].Controls.Add(label1);

XRLabel label2 = new XRLabel();
label2.Name = "label2";
report.Bands[0].Controls.Add(label2);

this.ScriptsSource = "int i = 0;";

ReportPrintTool pt = new ReportPrintTool(report);
pt.ShowPreviewDialog();

VB.NET

Dim report As New XtraReport()
report.Bands.Add(New DetailBand())

Dim label1 As New XRLabel()
label1.Name = "label1"
report.Bands(0).Controls.Add(label1)

Dim label2 As New XRLabel()
label2.Name = "label2"
report.Bands(0).Controls.Add(label2)

Dim pt As New ReportPrintTool(report)
pt.ShowPreviewDialog()

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ScriptsSource property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_how-to-add-custom-command-handlers-to-preview-buttons-in-the-end-user-designer-e98/CS/dxKB13085/Form1.cs#L23

private void OnDesignerLoaded(object sender, DesignerLoadedEventArgs e) {
    designForm.DesignPanel.Report.ScriptsSource += "private void OnAfterPrint(object sender, " +
        "System.EventArgs e) {((XtraReport)sender).PrintingSystem.AddCommandHandler(new " +

Reporting_how-to-programmatically-assign-a-script-to-a-report-control-e2385/CS/Form1.cs#L24

// Add a script to a report's collection of scripts.
report.ScriptsSource += "private void xrLabel1_BeforePrint(object sender, " +
                        "System.Drawing.Printing.PrintEventArgs e) {\r\n  " +

VB.NET

Reporting_how-to-add-custom-command-handlers-to-preview-buttons-in-the-end-user-designer-e98/VB/dxKB13085/Form1.vb#L25

Private Sub OnDesignerLoaded(ByVal sender As Object, ByVal e As DesignerLoadedEventArgs)
    designForm.DesignPanel.Report.ScriptsSource = designForm.DesignPanel.Report.ScriptsSource + _
        "private void OnAfterPrint(object sender, " _

Reporting_how-to-programmatically-assign-a-script-to-a-report-control-e2385/VB/Form1.vb#L29

' Add a script to a report's collection of scripts.
report.ScriptsSource &= "private void xrLabel1_BeforePrint(object sender, " & _
    "System.Drawing.Printing.PrintEventArgs e) {" & Constants.vbCrLf & "  " & _