CreateReport Method

In This Topic

Syntax
Exceptions
Remarks
See Also

Creates report pages. Only one report for one device can exist in a project, therefore it's always overwritten, when creating. Different situation is while device list is an overview report. There can be many device list in a project(perhaps with different filters), therefore it's never overwritten when creating a new one. To update an existing list of devices, use Reports.Update function.

Syntax

C#
C++/CLI

public bool CreateReport( 
   ReportBlock oReportBlock,
   string strFirstPageName
)

public:
bool CreateReport( 
   ReportBlock^ oReportBlock,
   String^ strFirstPageName
)

Parameters

oReportBlock: Report block which contains settings for generating reports.
strFirstPageName: Full name of the start page for each report block generated by this method.

Exceptions

Exception	Description
System.ArgumentNullException	If any of parameters is null.
System.ArgumentException	If any of parameters is invlaid.
System.ApplicationException	Failed to create report pages. Please refer to the error message.
BaseException	An internal error occurred during creating embedded report Please refer to the error message.
Eplan.EplApi.HEServices.Exceptions.InvalidScheme	Thrown when invalid scheme name is set and scheme data is empty. Please refer to the error message for more information.

Remarks

Page with name passed in parameter strFirstPageName can exists in project but it has to be a report page (can't have the member Eplan.EplApi.DataModel.Page.ReportBlockempty). Existing report pages will be replaced with new reports.

Reference

Reports Class
Reports Members

Send Feedback