Add Footnote Links and Role Reference Objects to XBRL using C#

Add-Footnote-Links-and-Role-Reference-to-XBRL-CSharp.md

Learn how to add footnote links and role reference objects to XBRL using C#: https://blog.aspose.com/2022/05/22/add-footnote-links-and-role-reference-objects-to-xbrl-using-csharp/

The following topics are covered in this article:

1. C# API to Add Footnote Links and Role Reference Objects to XBRL
2. Add Footnote Links to XBRL
3. Add Role Reference Object to XBRL
4. Arc Role Reference Object in XBRL

Add-Footnote-Links-and-Role-Reference-to-XBRL-CSharp_AddArcRoleRef.cs

// Create an instance of XbrlDocument class
XbrlDocument document = new XbrlDocument();

// Get XbrlInstances
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// Add XbrlInstance
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];

// Define Schema reference
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;
schemaRefs.Add(@"C:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");
SchemaRef schema = schemaRefs[0];

// Add Arc Role Reference
ArcroleType arcroleType = schema.GetArcroleTypeByURI("http://abc.com/arcrole/footnote-test");
if (arcroleType != null)
{
    ArcroleReference arcroleReference = new ArcroleReference(arcroleType);
    xbrlInstance.ArcroleReferences.Add(arcroleReference);
}

// Save the document
document.Save(@"C:\Files\Finance\document8.xbrl");

Add-Footnote-Links-and-Role-Reference-to-XBRL-CSharp_AddFootnoteLink.cs

// Create an instance of XbrlDocument class
XbrlDocument document = new XbrlDocument();

// Get XbrlInstances
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// Add XbrlInstance
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];

// Define Schema reference
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;
schemaRefs.Add(@"C:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");
SchemaRef schema = schemaRefs[0];

// Define context
ContextPeriod contextPeriod = new ContextPeriod(DateTime.Parse("2020-01-01"), DateTime.Parse("2020-02-10"));
ContextEntity contextEntity = new ContextEntity("exampleIdentifierScheme", "exampleIdentifier");
Context context = new Context(contextPeriod, contextEntity);
context.Id = "cd1";
xbrlInstance.Contexts.Add(context);

// Define Footnote
Footnote footnote = new Footnote("footnote1");
footnote.Text = "Including the effects of the merger.";

// Define Locator
Loc loc = new Loc("#cd1", "fact1");

// Define FootnoteArc
FootnoteArc footnoteArc = new FootnoteArc(loc.Label, footnote.Label);

// Define Footnote link
FootnoteLink footnoteLink = new FootnoteLink();
footnoteLink.Footnotes.Add(footnote);
footnoteLink.Locators.Add(loc);
footnoteLink.FootnoteArcs.Add(footnoteArc);
xbrlInstance.FootnoteLinks.Add(footnoteLink);

// Save the document
document.Save(@"C:\Files\Finance\document6.xbrl");

Add-Footnote-Links-and-Role-Reference-to-XBRL-CSharp_AddRoleRef.cs

// Create an instance of XbrlDocument class
XbrlDocument document = new XbrlDocument();

// Get XbrlInstances
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

// Add XbrlInstance
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];

// Define Schema reference
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;
schemaRefs.Add(@"C:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");
SchemaRef schema = schemaRefs[0];

// Add Role Reference
RoleType roleType = schema.GetRoleTypeByURI("http://abc.com/role/link1");
if (roleType != null)
{
    RoleReference roleReference = new RoleReference(roleType);
    xbrlInstance.RoleReferences.Add(roleReference);
}

// Save the document
document.Save(@"C:\Files\Finance\document7.xbrl");