Load finance document with options Leave feedback
On this page
GroupDocs.Conversion provides FinanceLoadOptions to control how source finance documents are processed. Finance documents include XBRL (eXtensible Business Reporting Language) and iXBRL (inline XBRL) files used for financial reporting.
NoteOn .NET 6 and later, converting XBRL and iXBRL documents to spreadsheet formats requires the System.Drawing.Common 4.7.3 package in your project; on Linux, libgdiplus must also be installed. Without it, the conversion throws aMissingDependencyExceptionthat names the missing package.
The following options are available:
| Option | Description |
|---|---|
| Format | The document type is auto-detected during loading, but you can explicitly specify the source format. Available options are: Xbrl, IXbrl |
| ExternalResourceHandler | A handler called for each taxonomy reference while SkipExternalResources is true. It can skip a reference but cannot allow one that is denied. Default: null. Available since version 26.10. |
| SkipExternalResources | Whether to deny taxonomy files outside the document’s own folder. Default: true. Set it to false to convert a document that references a remote taxonomy. Available since version 26.10. |
| WhitelistedResources | Validated like on the other load options classes, but not consulted for XBRL: a whitelisted remote schema is still denied. Available since version 26.10. |
WarningSince version 26.10, external resources are not loaded by default, and an XBRL or inline XBRL document loads only when every taxonomy file it references is inside the document’s own folder and the document is converted from a file path. A document that references a remote taxonomy, as most filings do, fails to load withInvalidLoadOptionsException. To convert such a document, setSkipExternalResourcestofalse. See XBRL and inline XBRL.
The following code snippet shows how to load an XBRL document with explicit format specification:
using GroupDocs.Conversion;
using GroupDocs.Conversion.FileTypes;
using GroupDocs.Conversion.Options.Convert;
using GroupDocs.Conversion.Options.Load;
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new FinanceLoadOptions
{
Format = FinanceFileType.Xbrl
};
using (Converter converter = new Converter("financial-report.xbrl", getLoadOptions))
{
SpreadsheetConvertOptions options = new SpreadsheetConvertOptions();
converter.Convert("financial-report.xlsx", options);
}
The following code snippet shows how to load an iXBRL (inline XBRL) document:
using GroupDocs.Conversion;
using GroupDocs.Conversion.FileTypes;
using GroupDocs.Conversion.Options.Convert;
using GroupDocs.Conversion.Options.Load;
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new FinanceLoadOptions
{
Format = FinanceFileType.IXbrl
};
using (Converter converter = new Converter("financial-statement.ixbrl", getLoadOptions))
{
SpreadsheetConvertOptions options = new SpreadsheetConvertOptions();
converter.Convert("financial-statement.xlsx", options);
}
The following code snippet shows how to load an XBRL document and convert it to CSV format:
using GroupDocs.Conversion;
using GroupDocs.Conversion.FileTypes;
using GroupDocs.Conversion.Options.Convert;
using GroupDocs.Conversion.Options.Load;
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new FinanceLoadOptions
{
Format = FinanceFileType.Xbrl
};
using (Converter converter = new Converter("quarterly-report.xbrl", getLoadOptions))
{
SpreadsheetConvertOptions options = new SpreadsheetConvertOptions
{
Format = SpreadsheetFileType.Csv
};
converter.Convert("quarterly-report.csv", options);
}
The following code snippet shows how to convert from iXBRL to XBRL:
using GroupDocs.Conversion;
using GroupDocs.Conversion.FileTypes;
using GroupDocs.Conversion.Options.Convert;
using GroupDocs.Conversion.Options.Load;
Func<LoadContext, LoadOptions> getLoadOptions = loadContext => new FinanceLoadOptions
{
Format = FinanceFileType.IXbrl
};
using (Converter converter = new Converter("annual-report.ixbrl", getLoadOptions))
{
FinanceConvertOptions options = new FinanceConvertOptions
{
Format = FinanceFileType.Xbrl
};
converter.Convert("annual-report.xbrl", options);
}
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
