PrintReport

<< Click to Display Table of Contents >>

Manual > Control Reference > Data > Summary report grid control > Method >

PrintReport


 

Instructs the summary server to print the report.

 


syntax

PrintReport(

         summaryName,

         startReferenceDate,

         endReferenceDate,

         groupId,

         pageId,

         printerName,

         bPreview,

         startWaitTime,

         waitMode

         [,pageTargetID = 0]

         [,showProgressBar = T]

         [,reportLayoutMaster = ""]

         [,reportLayoutMasterSheet = ""]

         [,fileType = ""]

         )

 


Parameters

 

summaryName


Type:

character


Summary name (aggregated log name) such as DAY/MONTH/YEAR.

 

startReferenceDate


Type:

time


The start reference time for the period of the subreport you want to create.

For details about the reference time, see "ReferenceOffsetSee the " parameter description.

 

endReferenceDate


Type:

time


The end reference time of the period for which you want to create the subreport. The record at the exact end reference time is not included.

For details about the reference time, see "ReferenceOffsetSee the " parameter description.

 

groupId


Type:

Number


Specify the group of reports you want to print using a zero-based index.

-1 - Print all groups

0 or more - Print only the specified groups

 

pageId


Type:

Number


Specifies the page of the report you want to print, using a zero-based index.

-1 - Print all pages

0 or more - Print only the specified pages

 

printerName


Type:

character


Printer name. If empty, the default printer specified in the summary master file will be used.

 

bPreview


Type:

Boolean


Displays a preview screen before printing. Use this only for testing purposes.

 

startWaitTime


Type:

Number


Specifies the wait time (msec) before starting printing.

If you specify F for bWaitUntilCreated and execute the PrintReport method continuously, the order of pages may change due to the timing of actual printing being delayed.

In such cases, you can adjust the print order by specifying different print start wait times for each job.

 

waitMode


Type:

character


"wait_true" (or boolean value T): Wait for the method to finish until printing is finished.

"wait_false" (or Boolean value F): The method exits immediately without waiting for printing to finish.

”wait_true_event": Waits for the method to finish until printing is complete. After printing is complete, the OnSummaryNotification(type="printreport_done") event occurs.

”wait_false_event": Does not wait for the method to finish until printing is complete. After printing is complete, the OnSummaryNotification(type="printreport_done") event will occur.

 

pageTargetID


Type:

Number


0 - Print all pages that match the specified group ID and page ID.

1 - Print according to the value of page property PageTarget1.

2 - Print according to the value of page property PageTarget2.

x - Print according to the value of the page property PageTarge[x].

*For page properties, see SetPageProperty

 

showProgressBar


Type:

Boolean


T - Show progress bar

F - Hide progress bar

 

reportLayoutMaster


Type:

character


The file name of the Layout Master file. If none is specified, the default Layout Master file is used.

 

reportLayoutMasterSheet


Type:

character


Sheet name of the Layout Master File. If none is specified, the default sheet is used.

 

fileType


Type:

character


The type of file to output. Only "excel" can be selected.

 

"excel" - Excel file

 

●If the file type is Excel, you can set the detailed format by concatenating the following strings after "excel" with "_".

 

・date[summarymaster]

The text in the time column is determined according to the ReportTitleDateFormat in the Summary Master File.

・date['@DATETIME']

The characters in the time column will be determined according to the specified format. You can freely specify the '@DATETIME' part.

For information on the formats that can be specified, please refer to the ReportTitleDateFormat property of the Summary Master.

・locale[ja-JP]

Specify the locale. You can specify the ja-JP part freely. If not specified, the locale will follow the OS locale on which the server is running.

When you specify a locale, if there is a report master file "layoutmaster.xls" with the locale character added to the end (e.g. "layoutmaster_ja-JP.xls"), that file will be used. You can separate report master files for each language.

 

example)

"excel"

"excel_date['@[%mmonth%d(%a)]']"

"excel_date['@[%mmonth%d(%a)]']_locale[ja-JP]"

"excel_date['@DATETIME.%md.[(%a)]]']_locale[de]"

 

 

Return Value



Type:

Boolean


FALSE - Failure. TRUE - Success. To actually get whether printing was successful or not, you need to wait until the printing is completed, so set waitMode to T.

If printing takes a long time, adjust the timeout period (PSTimeOut root property).

 


hmtoggle_plus1Explanation

 


reference