The IAutomationAPI interface is the main automation interface of EIOPA (Solvency II) XBRL Add-in. This interface is the starting point for doing any further operations with the add-in. This interface allows you to create, import and export reports, read and write data. For information about creating an instance of this interface, see Accessing the API.
Methods
The IAutomationAPI interface allows you to use the following methods:
Use this method to insert a new report of the respective taxonomy entry point.
Signature
InsertNewReport(in entryPointUrl:String) -> Microsoft.Office.Interop.Excel.Workbook
|
Parameters
|
Imports an XBRL report. Returns the Excel workbook that contains the imported XBRL report.
Signature
ImportXBRL(in inputFile:String) -> Microsoft.Office.Interop.Excel.Workbook
|
Parameters
|
Exports the report from the respective Excel workbook to XBRL and also validates it. To get the validation results, call GetValidationReport after calling this method. You can get the file name by using the GetReportBaseName method.
Signature
ExportXBRL(workbook as Microsoft.Office.Interop.Excel.Workbook, outputFile as String) -> Void
|
Parameters
|
Exports the report from the respective Excel workbook to the XBRL-CSV report package and validates it. To get the validation results, call GetValidationReport after calling this method.
Signature
ExportXBRL_CSV(in workbook:Microsoft.Office.Interop.Excel.Workbook, in outputFile:String) -> Void
|
Parameters
|
Validates the current report. To get the validation results, call GetValidationReport after calling this method.
Signature
Validate(in workbook:Microsoft.Office.Interop.Excel.Workbook) -> Void
|
Parameters
|
Returns an IValidationReport object representing the validation report currently shown in the validation report pane.
Signature
GetValidationReport(in workbook:Microsoft.Office.Interop.Excel.Workbook) -> IValidationReport
|
Parameters
|
Returns an IEntryPointTree object representing a tree of the available taxonomy entry points.
Signature
GetEntryPointTree() -> IEntryPointTree
|
|
Returns an ITableTree object representing the tree of the available tables in the report opened in the specified Excel workbook.
Signature
GetTableTree(in workbook:Microsoft.Office.Interop.Excel.Workbook) -> ITableTree
|
Parameters
|
Returns an IReportProperties object providing the properties of the XBRL report.
Signature
GetReportProperties(in workbook:Microsoft.Office.Interop.Excel.Workbook) -> IReportProperties
|
Parameters
|
Returns an IFormProperties object providing the properties of the XBRL form in the specified Excel worksheet.
Signature
GetFormProperties(in worksheet:Microsoft.Office.Interop.Excel.Worksheet) -> IFormProperties
|
Parameters
|
Returns an ICellProperties object providing the properties of the fact in the specified Excel range.
Signature
GetCellProperties(in cell:Microsoft.Office.Interop.Excel.Range) -> ICellProperties
|
Parameters
|
Returns the file name that Excel provides automatically when you export an XBRL file (via the ExportXBRL method) from an Excel workbook.
Signature
GetReportBaseName(workbook as Excel.Workbook) -> String
|
Parameters
|
