Tools¶
Properties of a tool (if any) can be specified in the Properties window in MIKE WORKBENCH.
Generate Report¶
Tool for generating a report.
| Tool Info | Generate Report |
|---|---|
| Tools Explorer | /Report Tools/Generate Report |
| NuGet Package | DHI.MikeOperations.ReportManager.Tools.GenerateReport |
| API Reference | DHI.Solutions.ReportManager.Tools.GenerateReport.IGenerateReportTool |
| Input Items | A single report |
| Output Items | A generated report handle containing report location and information |
Tool Properties
| Display Name | Name | Description |
|---|---|---|
| Folder | OutputFolder | Gets or sets the folder where the generated report is saved. |
| Save In Document Manager | SaveInDocumentManager | Gets or sets a value indicating whether the report should be saved in the document manager |
| Document Manager Path | DocumentManagerPath | Gets or sets the path in the document manager where the report is saved. |
Code Sample
// Get the tool.
var tool = application.Tools.CreateNew("Generate Report") as DHI.Solutions.ReportManager.Tools.GenerateReport.IGenerateReportTool;
# Get the tool.
tool = app.Tools.CreateNew("Generate Report")
# Get the tool.
tool = DHI.Solutions.ReportManager.Tools.GenerateReport.IGenerateReportTool(app.Tools.CreateNew("Generate Report"))