Document Manager Tools¶
Properties of a tool (if any) can be specified in the Properties window in MIKE WORKBENCH.
Document query¶
QueryToolTool class
| Tool Info | Document query |
|---|---|
| Tools Explorer | /Data tools/Document query |
| NuGet Package | DHI.MikeOperations.DocumentManager.Tools.Query |
| API Reference | DHI.Solutions.DocumentManager.Tools.QueryTool.QueryTool |
| Input Items | No input items required |
| Output Items | No output items |
Tool Properties
The tool has no properties.
Code Sample
// Get the tool.
var tool = application.Tools.CreateNew("Document query") as DHI.Solutions.DocumentManager.Tools.QueryTool.QueryTool;
# Get the tool.
tool = app.Tools.CreateNew("Document query")
Export Document¶
Tool for exporting documents to files on disk.
| Tool Info | Export Document |
|---|---|
| Tools Explorer | /Export/Export Document |
| NuGet Package | DHI.MikeOperations.DocumentManager.Tools.Export |
| API Reference | DHI.Solutions.DocumentManager.UI.Tools.ExportDocument.IExportDocument |
| Input Items | One or more documents |
| Output Items | No output items |
Tool Properties
| Display Name | Name | Description |
|---|---|---|
| File Path | FilePath | Gets or sets the file path fo the document to export |
Code Sample
// Get the tool.
var tool = application.Tools.CreateNew("Export Document") as DHI.Solutions.DocumentManager.UI.Tools.ExportDocument.IExportDocument;
# Get the tool.
tool = app.Tools.CreateNew("Export Document")
# Get the tool.
tool = DHI.Solutions.DocumentManager.UI.Tools.ExportDocument.IExportDocument(app.Tools.CreateNew("Export Document"))
Import Document¶
Tool for importing documents into the MIKE WORKBENCH database.
| Tool Info | Import Document |
|---|---|
| Tools Explorer | /Import/Import Document |
| NuGet Package | DHI.MikeOperations.DocumentManager.Tools.Import |
| API Reference | DHI.Solutions.DocumentManager.UI.Tools.ImportDocument.IImportDocument |
| Input Items | A single document folder |
| Output Items | A document |
Tool Properties
| Display Name | Name | Description |
|---|---|---|
| Name | DocumentName | Gets or sets the name for the document to import |
| Document Path | FilePath | Gets or sets the file path for the document to import |
| Group | Group | Gets or sets the group for the document to import |
| Thumbnail | Thumbnail | Gets or sets the Thumbnail for the document to import |
Code Sample
// Get the tool.
var tool = application.Tools.CreateNew("Import Document") as DHI.Solutions.DocumentManager.UI.Tools.ImportDocument.IImportDocument;
# Get the tool.
tool = app.Tools.CreateNew("Import Document")
# Get the tool.
tool = DHI.Solutions.DocumentManager.UI.Tools.ImportDocument.IImportDocument(app.Tools.CreateNew("Import Document"))