FinanceLoadOptions Leave feedback
On this page
Options for loading finance documents.
public class FinanceLoadOptions : LoadOptions, IResourceLoadingOptions
| Name | Description |
|---|---|
| FinanceLoadOptions() | Initializes new instance of FinanceLoadOptions class. |
| Name | Description |
|---|---|
| ExternalResourceHandler { get; set; } | Gets or sets the handler called for each resource the document asks an engine to load. Default: null. |
| Format { get; set; } | Input document file type. Is null until a format has been set, so test it for null rather than against Unknown, which it never equals. |
| virtual Format { get; } | Input document file type. |
| SkipExternalResources { get; set; } | Gets or sets whether external resources are denied. Default: true. |
| WhitelistedResources { get; set; } | Gets or sets the absolute URI prefixes of the external resources that load while SkipExternalResources is true. |
| Name | Description |
|---|---|
| override Equals(object) | Determines whether two object instances are equal. |
| virtual Equals(ValueObject) | Determines whether two object instances are equal. |
| override GetHashCode() | Serves as the default hash function. |
An XBRL or inline XBRL document references its taxonomy: schemas, linkbases and the schemas they import. While SkipExternalResources is true, the document loads only when every reference in that chain stays inside the document’s own folder, which requires converting from a path. A document that references a remote taxonomy, a file outside its folder or any file when loaded from a stream, or whose local chain is not well-formed XML, fails to load with InvalidLoadOptionsException. Nearly every published taxonomy is remote, so most filings need SkipExternalResources set to false.
WhitelistedResources is never consulted for XBRL: a whitelisted remote schema is still denied, because the schemas it imports cannot be judged without fetching it. Its entries are still validated.
With SkipExternalResources set to false, every taxonomy file the document needs is loaded, including schemas imported by remote schemas.
- class LoadOptions
- interface IResourceLoadingOptions
- namespace GroupDocs.Conversion.Options.Load
- assembly GroupDocs.Conversion
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.
