CreateReport Method

In This Topic

Create a new report.

Syntax

public Report CreateReport( 
   string name,
   IEnumerable<DerivationSource> sources,
   ApiReportType type,
   string templatePath,
   ElectricalConfigurationInfo electricalConfiguration
)

Parameters

name: Name of the new report.
sources: Sources of the report. See GetAllWireHarnessInfos and GetAllCableUnitInfos.
type: Type of the report. See Report.GetReportTypes.
templatePath: The path to a report template file (*.hxrt).
electricalConfiguration: Select electrical configuration for creating this report.

Return Value

New report.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.ObjectInvalidException	The object is in invalid state. Obtain a new one.
EPLAN.Harness.API.Exceptions.InternalErrorException	Internal error of HpD or HpD API. IMPORTANT: Throwing this exception changes HpD Api's state to Failed.
EPLAN.Harness.API.Exceptions.LicensingErrorException	This operation was denied because of your license.
EPLAN.Harness.API.Exceptions.ArgumentException	Argument is invalid. The exception is thrown when a wrong argument is passed to the method or the setter of property.
EPLAN.Harness.API.Exceptions.DuplicateNameException	Report with this name already exists.

Example

// Make list of all harnesses.
// You can use both harnesses and cable units for report derivation. Its common base is DerivationSource class.
List<DerivationSource> sources = variant.GetAllWireHarnessInfos().Cast<DerivationSource>().ToList();

// You could add all cable units as well.
// sources.AddRange(variant.GetAllCableUnitInfos().Cast<DerivationSource>());

// Select an Aggregated BOM report type.
// We use "Name" property because it does not depend on localization. "LocalizedName" does.
// To see see all the report type names, list all report types using Report.GetReportTypes().
ReportType reportType = Report.GetReportTypes().Where(n => n.Name == "AggregatedBOMReporter").FirstOrDefault();

// Create a new Aggregated BOM report from all harnesses in a variant.
Report report = variant.CreateReport("My new report name", sources, reportType);

// Save the project so the new report is saved into the project structure.
project.Save();

Reference

Variant Class
Variant Members

Send Feedback