Tools¶
Properties of a tool (if any) can be specified in the Properties window in MIKE WORKBENCH.
Export Spreadsheet¶
Tool for exporting spreadsheets into external files.
| Tool Info | Export Spreadsheet |
|---|---|
| Tools Explorer | /Export/Export Spreadsheet |
| NuGet Package | DHI.MikeOperations.SpreadsheetManager.Tools.ExportSpreadsheet |
| API Reference | DHI.Solutions.SpreadsheetManager.UI.Tools.ExportSpreadsheet.IExportSpreadsheet |
| Input Items | A single spreadsheet |
| Output Items | No output items |
Tool Properties
| Display Name | Name | Description |
|---|---|---|
| File Path | FilePath | Gets or sets the file path fo the spreadsheet to exmport |
Code Sample
// Get the tool.
var tool = application.Tools.CreateNew("Export Spreadsheet") as DHI.Solutions.SpreadsheetManager.UI.Tools.ExportSpreadsheet.IExportSpreadsheet;
# Get the tool.
tool = app.Tools.CreateNew("Export Spreadsheet")
# Get the tool.
tool = DHI.Solutions.SpreadsheetManager.UI.Tools.ExportSpreadsheet.IExportSpreadsheet(app.Tools.CreateNew("Export Spreadsheet"))
Import Spreadsheet¶
Tool for importing spreadsheets from disk to MIKE WORKBENCH.
| Tool Info | Import Spreadsheet |
|---|---|
| Tools Explorer | /Import/Import Spreadsheet |
| NuGet Package | DHI.MikeOperations.SpreadsheetManager.Tools.ImportSpreadsheet |
| API Reference | DHI.Solutions.SpreadsheetManager.UI.Tools.ImportSpreadsheet.IImportSpreadsheet |
| Input Items | A single spreadsheet group |
| Output Items | A spreadsheet |
Tool Properties
| Display Name | Name | Description |
|---|---|---|
| File Path | FilePath | Gets or sets the file path for the spreadsheet to import |
| Group | Group | Gets or sets the group fo the spreadsheet to import |
| Name | FileName | Gets or sets the file name of the spreadsheet to import |
Code Sample
// Get the tool.
var tool = application.Tools.CreateNew("Import Spreadsheet") as DHI.Solutions.SpreadsheetManager.UI.Tools.ImportSpreadsheet.IImportSpreadsheet;
# Get the tool.
tool = app.Tools.CreateNew("Import Spreadsheet")
# Get the tool.
tool = DHI.Solutions.SpreadsheetManager.UI.Tools.ImportSpreadsheet.IImportSpreadsheet(app.Tools.CreateNew("Import Spreadsheet"))
Spreadsheet query¶
QueryToolTool class
| Tool Info | Spreadsheet query |
|---|---|
| Tools Explorer | /Data tools/Spreadsheet query |
| NuGet Package | DHI.MikeOperations.SpreadsheetManager.Tools.Query |
| API Reference | DHI.Solutions.SpreadsheetManager.Tools.QueryTool.QueryTool |
| Input Items | No input items required |
| Output Items | No output items |
Tool Properties
| Display Name | Name | Description |
|---|---|---|
| Name | SpreadsheetName | Gets or sets the speadsheet for searching entities. |
| Within Group | WithinGroup | Gets or sets the value of the group. |
| Metadata | Metadata | Gets or sets the metadata for searching entities. |
Code Sample
// Get the tool.
var tool = application.Tools.CreateNew("Spreadsheet query") as DHI.Solutions.SpreadsheetManager.Tools.QueryTool.QueryTool;
# Get the tool.
tool = app.Tools.CreateNew("Spreadsheet query")