Přidejte odkazy na poznámky pod čarou a referenční objekty rolí do XBRL pomocí C#

V předchozím příspěvku jsme se naučili, jak přidat odkaz na schéma, kontext, jednotku a objekty faktů do dokumentů instance XBRL pomocí C#. V tomto článku se naučíme, jak přidat odkazy na poznámky pod čarou a objekty odkazu na role do XBRL pomocí C#.

Tento článek bude obsahovat následující témata:

Pro přidávání objektů reference role a reference role arc do dokumentu instance XBRL budeme používat Aspose.Finance for .NET API. Umožňuje vytváření instancí XBRL, analýzu a ověřování souborů XBRL nebo iXBRL. Třída XbrlDocument rozhraní API představuje dokument XBRL, který obsahuje jednu nebo více instancí XBRL. Instance XBRL je fragment XML, přičemž kořenový prvek má značku XBRL. Třída XbrlInstance poskytuje různé metody a vlastnosti pro práci s instancí XBRL. Třída FootnoteLink obsahuje lokátory, zdroje a oblouky k popisu vztahů mezi fakty v instanci XBRL. Rozhraní API poskytuje třídu RoleReference, která umožňuje odkazovat na definice libovolných hodnot atributů vlastních rolí používaných v odkazech na poznámky pod čarou v instanci XBRL. Podobně třída ArcRoleReference umožňuje rozlišení vlastních hodnot role oblouku, které se používají v základně Link nebo v instanci XBRL.

Prosím buď stáhněte DLL API, nebo ji nainstalujte pomocí NuGet.

PM> Install-Package Aspose.Finance

Do dokumentu instance XBRL můžeme přidat odkaz na poznámku pod čarou podle následujících kroků:

  1. Nejprve vytvořte instanci třídy XbrlDocument.
  2. Přidejte novou instanci XBRL k instancím objektu XbrlDocument.
  3. Přidejte nový odkaz na schéma k odkazům na schéma objektu XbrlInstance.
  4. Získejte SchemaRef podle jeho indexu ze SchemaRefCollection.
  5. Inicializujte instanci Context a přidejte ji do kolekce Context objects.
  6. Definujte instanci poznámka pod čarou a nastavte její popisek a text.
  7. Inicializujte typ Locator pomocí instance třídy Loc.
  8. Definujte FootnoteArc s popiskem Locator a popiskem poznámky pod čarou jako argumenty.
  9. Vytvořte instanci třídy FootnoteLink.
  10. Přidejte poznámku pod čarou, lokátor a oblouk pod čarou do příslušných kolekcí odkazů pod čarou.
  11. Poté přidejte FootnoteLink do kolekce FootnoteLinks.
  12. Nakonec uložte soubor XBRL pomocí metody XbrlDocument.Save(). Jako argument bere cestu k výstupnímu souboru.

Následující ukázka kódu ukazuje, jak přidat odkaz na poznámku pod čarou do dokumentu instance XBRL pomocí C#.

// Vytvořte instanci třídy XbrlDocument
XbrlDocument document = new XbrlDocument();

// Získejte XbrlInstance
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

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

// Definujte odkaz na schéma
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;
schemaRefs.Add(@"C:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");
SchemaRef schema = schemaRefs[0];

// Definujte kontext
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);

// Definujte poznámku pod čarou
Footnote footnote = new Footnote("footnote1");
footnote.Text = "Including the effects of the merger.";

// Definujte Lokátor
Loc loc = new Loc("#cd1", "fact1");

// Definujte poznámku pod čarouArc
FootnoteArc footnoteArc = new FootnoteArc(loc.Label, footnote.Label);

// Definujte poznámku pod čarou link
FootnoteLink footnoteLink = new FootnoteLink();
footnoteLink.Footnotes.Add(footnote);
footnoteLink.Locators.Add(loc);
footnoteLink.FootnoteArcs.Add(footnoteArc);
xbrlInstance.FootnoteLinks.Add(footnoteLink);

// Uložte dokument
document.Save(@"C:\Files\Finance\document6.xbrl");

Přidat objekt reference role do XBRL pomocí C#

Do dokumentu instance XBRL můžeme přidat odkaz na roli podle následujících kroků:

  1. Nejprve vytvořte instanci třídy XbrlDocument.
  2. Dále přidejte novou instanci XBRL do instancí objektu XbrlDocument.
  3. Potom přidejte nový odkaz na schéma k odkazům na schéma objektu XbrlInstance.
  4. Získejte SchemaRef podle jeho indexu ze SchemaRefCollection.
  5. Dále získáte RoleType z metody GetRoleTypeByURI().
  6. Potom vytvořte instanci třídy RoleReference s objektem RoleType jako argumentem.
  7. Poté přidejte RoleReference do kolekce objektů RoleReference.
  8. Nakonec uložte soubor XBRL pomocí metody XbrlDocument.Save(). Jako argument bere cestu k výstupnímu souboru.

Následující ukázka kódu ukazuje, jak přidat odkaz na roli v dokumentu instance XBRL pomocí C#.

// Vytvořte instanci třídy XbrlDocument
XbrlDocument document = new XbrlDocument();

// Získejte XbrlInstance
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

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

// Definujte odkaz na schéma
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;
schemaRefs.Add(@"C:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");
SchemaRef schema = schemaRefs[0];

// Přidat odkaz na roli
RoleType roleType = schema.GetRoleTypeByURI("http://abc.com/role/link1");
if (roleType != null)
{
    RoleReference roleReference = new RoleReference(roleType);
    xbrlInstance.RoleReferences.Add(roleReference);
}

// Uložte dokument
document.Save(@"C:\Files\Finance\document7.xbrl");

Přidejte referenční objekt Arc Role do XBRL pomocí C#

Do dokumentu instance XBRL můžeme přidat odkaz na roli Arc podle následujících kroků:

  1. Nejprve vytvořte instanci třídy XbrlDocument.
  2. Dále přidejte novou instanci XBRL do instancí objektu XbrlDocument.
  3. Potom přidejte nový odkaz na schéma k odkazům na schéma objektu XbrlInstance.
  4. Dále získejte SchemaRef podle jeho indexu ze SchemaRefCollection.
  5. Poté z metody GetArcroleTypeByURI() získejte ArcRoleType.
  6. Dále vytvořte instanci třídy ArcRoleReference s objektem ArcRoleType jako argumentem.
  7. Poté přidejte ArcRoleReference do kolekce objektů ArcRoleReference.
  8. Nakonec uložte soubor XBRL pomocí metody XbrlDocument.Save(). Jako argument bere cestu k výstupnímu souboru.

Následující ukázka kódu ukazuje, jak přidat odkaz na roli oblouku v dokumentu instance XBRL pomocí jazyka C#.

// Vytvořte instanci třídy XbrlDocument
XbrlDocument document = new XbrlDocument();

// Získejte XbrlInstance
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;

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

// Definujte odkaz na schéma
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;
schemaRefs.Add(@"C:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");
SchemaRef schema = schemaRefs[0];

// Přidat 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);
}

// Uložte dokument
document.Save(@"C:\Files\Finance\document8.xbrl");

Získejte bezplatnou licenci

Můžete získat bezplatnou dočasnou licenci a vyzkoušet knihovnu bez omezení hodnocení.

Závěr

V tomto článku jsme se naučili, jak:

  • vytvořit XBRL dokument pomocí C#;
  • přidat poznámku pod čarou a oblouk pomocí odkazu na poznámku pod čarou k objektům XBRL programově;
  • přidat odkazy na role a arc role v XBRL v C#.

Kromě toho se můžete dozvědět více o Aspose.Finance for .NET API pomocí dokumentace. V případě jakýchkoliv nejasností nás neváhejte kontaktovat na fóru.

Viz také