The RunReport method runs the specified report, outputting it to the specified file type, which is returned as a string. Internally, it calls RunReportToFile, reads the resulting file into a string, and returns that string.


RunReport(ReportName as String, 
    FileType as String
    [, FileSubType as String 
    [, Values as String]
    [, CallBack as Object]]]) as String

The name of the report to run.

The type of file to create. This is the same as a file extension: "PDF" for a PDF file, "XLS" for a Microsoft Excel file, "DOC" for a Microsoft Word file, "HTML" for an HTML file, and so forth (see the Output Options topic in the Stonefield Query help file for a list of the file types supported).

Since Stonefield Query can output either data-only or full format for Microsoft Excel or spreadsheets with an XLS extension, specify the type of file you want if you output to XLS: either "full" for full formatted Excel, "data" for data-only Excel, "fast" for fast data-only, or "spreadsheet" for a spreadsheet XLS file.

The values for any ask-at-runtime conditions. If it is passed, this parameter must be specified as an XML string with the following format:

      <value>First value</value>
      <value>Second value</value>

Put no space between the opening and closing tags to indicate that a condition should be ignored. For example:


For dates, use the format YYYY-MM-DD. For logical or Boolean fields, use "T", "True", "Y", or "Yes" for True (anything else is considered to be False). For the "is between" or "is one of" operators, separate the values with a comma (for example, "2002-01-01,2002-12-31" for a "Date is between 01/01/2002 and 12/31/2002" condition). Omit the value (that is, use an empty value element) to ignore the condition.



If you want the ask-at-runtime dialog to appear, you must set the AllowDialogs parameter to "yes". The dialog may appear behind your application's window, with the icon flashing in the Windows TaskBar. Automatically bringing the dialog to the front is a little complicated since recent Windows versions don't allow a window to bring itself to the front. Instead, use a callback object that does it. Here's an example (preceding and error handling code omitted for brevity):

loQuery.SQApplication.Parameters.AddItem('AllowDialogs', 'yes')
loCallBack = createobject('CallBack')
loQuery.SQApplication.ReportEngine.RunReport('Customers', ;
  'PDF', , , loCallBack)

define class CallBack as Custom
  function OnShowWindow(tnHWnd)
    declare integer SetForegroundWindow in user32 integer hwnd

Return Value
A string containing the output of the report or an empty string if the report run failed because of an error or no records matching the filter condition (in that case, check the ErrorMessage property of the ReportEngine object for the reason for failure).

This example runs the Customers report.

Visual FoxPro

loQuery = createobject('SQProxy.SQProxy')
loQuery.LoadProject('\MyProjects\Northwind', 'admin', 'admin')
if loQuery.ProjectLoaded
  lcOutput = loQuery.SQApplication.ReportEngine.RunReport('Customers', ;
  if not empty(lcOutput)
    strtofile(lcOutput, '\MyReports\customers.pdf')


using SFQWrapper;
using SQProxyWrapper;
using System.IO;

namespace ConsoleApplication1
  class Program
    static void Main(string[] args)
      SQProxy sqProxy = new SQProxy();

      // Wait for project to finish loading
      while (!sqProxy.ProjectLoaded)

      string result = sqProxy.SQApplication.ReportEngine.RunReport("Customers", "PDF");
      string fileName = @"\MyReports\customers.pdf";
      System.IO.File.WriteAllText(fileName, result);


Imports SQProxyWrapper
Imports SFQWrapper

Module Module1
  Sub Main()

      Dim sqProxy As SQProxyWrapper.SQProxy = New SQProxyWrapper.SQProxy

      ' Wait for project to finish loading
      While Not sqProxy.ProjectLoaded
      End While

      Dim result As String = sqProxy.SQApplication.ReportEngine.RunReport("Customers",
      Dim fileName As String = "\MyReports\customers.pdf"
      System.IO.File.WriteAllText(fileName, result)
  End Sub
End Module

See also

PrintReport | ReportEngine Object | RunReportToFile | SQProxy Object

© Stonefield Software Inc., 2023 • Updated: 02/05/20
Comment or report problem with topic