ב פוסט הקודם, למדנו כיצד להוסיף הפניה לסכימה, הקשר, יחידה ואובייקטי עובדה למסמכי מופע של XBRL באמצעות C#. במאמר זה, נלמד כיצד להוסיף קישורי הערות שוליים ואובייקטי הפניה לתפקידים ל-XBRL באמצעות C#.
הנושאים הבאים יכוסו במאמר זה:
- C# API להוספת קישורי הערות שוליים ואובייקטי התייחסות לתפקידים ל-XBRL
- הוסף קישורי הערות שוליים ל-XBRL
- הוסף אובייקט התייחסות לתפקיד ל-XBRL
- אובייקט התייחסות לתפקיד קשת ב-XBRL
C# API להוספת קישורי הערות שוליים ואובייקטי התייחסות לתפקידים ל-XBRL
להוספת אובייקטי הפניה לתפקידים ואובייקטי התייחסות לתפקידי קשת למסמך מופע XBRL, נשתמש ב-Aspose.Finance for .NET API. זה מאפשר יצירת מופעי XBRL, ניתוח ואימות של קבצי XBRL או iXBRL. המחלקה XbrlDocument של ה-API מייצגת מסמך XBRL המכיל מופע XBRL אחד או יותר. מופע XBRL הוא קטע XML, כאשר לאלמנט השורש יש תג XBRL. המחלקה XbrlInstance מספקת שיטות ומאפיינים שונים לעבודה עם מופע XBRL. המחלקה FootnoteLink מכילה מאתרים, משאבים וקשתות לתיאור היחסים בין עובדות במופע XBRL. ה-API מספק מחלקה RoleReference המאפשרת להתייחס להגדרות של כל ערכי תכונת תפקיד מותאמים אישית המשמשים בקישורי הערות שוליים במופע XBRL. באופן דומה, המחלקה ArcRoleReference מאפשרת לפתור ערכי תפקידי קשת מותאמים אישית המשמשים בבסיס קישור או במופע XBRL.
אנא הורד את ה-DLL של ה-API או התקן אותו באמצעות NuGet.
PM> Install-Package Aspose.Finance
הוסף קישורי הערות שוליים ל-XBRL באמצעות C#
אנו יכולים להוסיף קישור להערת שוליים במסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:
- ראשית, צור מופע של המחלקה XbrlDocument.
- הוסף מופע XBRL חדש למופעים של אובייקט XbrlDocument.
- הוסף הפניות לסכימה חדשה להפניות הסכימה של אובייקט XbrlInstance.
- קבל את SchemaRef לפי האינדקס שלו מ-SchemaRefCollection.
- אתחול המופע Context והוסף אותו לאוסף Context objects.
- הגדר מופע הערת שוליים והגדר את התווית והטקסט שלו.
- אתחול סוג Locator באמצעות מופע המחלקה Loc.
- הגדר את FootnoteArc עם תווית Locator ותווית הערת שוליים כארגומנטים.
- צור מופע של המחלקה FootnoteLink.
- הוסף את הערת Footnote, Locator ו-FootnoteArc לאוספי FootnoteLink רלוונטיים.
- לאחר מכן, הוסף את FootnoteLink לאוסף FootnoteLinks.
- לבסוף, שמור את קובץ ה-XBRL בשיטת XbrlDocument.Save(). זה לוקח את נתיב קובץ הפלט כארגומנט.
דוגמת הקוד הבאה מראה כיצד להוסיף קישור להערת שוליים במסמך מופע XBRL באמצעות C#.
// צור מופע של מחלקה XbrlDocument
XbrlDocument document = new XbrlDocument();
// קבל XbrlInstances
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;
// הוסף XbrlInstance
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];
// הגדר התייחסות לסכימה
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;
schemaRefs.Add(@"C:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");
SchemaRef schema = schemaRefs[0];
// הגדר הקשר
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);
// הגדר הערת שוליים
Footnote footnote = new Footnote("footnote1");
footnote.Text = "Including the effects of the merger.";
// הגדר איתור
Loc loc = new Loc("#cd1", "fact1");
// הגדר הערת שולייםArc
FootnoteArc footnoteArc = new FootnoteArc(loc.Label, footnote.Label);
// הגדר הערת שוליים link
FootnoteLink footnoteLink = new FootnoteLink();
footnoteLink.Footnotes.Add(footnote);
footnoteLink.Locators.Add(loc);
footnoteLink.FootnoteArcs.Add(footnoteArc);
xbrlInstance.FootnoteLinks.Add(footnoteLink);
// שמור את המסמך
document.Save(@"C:\Files\Finance\document6.xbrl");
הוסף אובייקט התייחסות לתפקיד ל-XBRL באמצעות C#
אנו יכולים להוסיף הפניה לתפקיד במסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:
- ראשית, צור מופע של המחלקה XbrlDocument.
- לאחר מכן, הוסף מופע XBRL חדש למופעים של אובייקט XbrlDocument.
- לאחר מכן, הוסף הפניות לסכימה חדשה להפניות הסכימה של אובייקט XbrlInstance.
- קבל את SchemaRef לפי האינדקס שלו מ- SchemaRefCollection.
- לאחר מכן, קבל את RoleType מהשיטה GetRoleTypeByURI().
- לאחר מכן, צור מופע של המחלקה RoleReference עם האובייקט RoleType כארגומנט.
- לאחר מכן, הוסף את ה-RoleReference לאוסף האובייקטים של RoleReference.
- לבסוף, שמור את קובץ ה-XBRL באמצעות שיטת XbrlDocument.Save(). זה לוקח את נתיב קובץ הפלט כארגומנט.
דוגמת הקוד הבאה מראה כיצד להוסיף הפניה לתפקיד במסמך מופע XBRL באמצעות C#.
// צור מופע של מחלקה XbrlDocument
XbrlDocument document = new XbrlDocument();
// קבל XbrlInstances
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;
// הוסף XbrlInstance
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];
// הגדר התייחסות לסכימה
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;
schemaRefs.Add(@"C:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");
SchemaRef schema = schemaRefs[0];
// הוסף התייחסות לתפקיד
RoleType roleType = schema.GetRoleTypeByURI("http://abc.com/role/link1");
if (roleType != null)
{
RoleReference roleReference = new RoleReference(roleType);
xbrlInstance.RoleReferences.Add(roleReference);
}
// שמור את המסמך
document.Save(@"C:\Files\Finance\document7.xbrl");
הוסף אובייקט התייחסות לתפקיד קשת ל-XBRL באמצעות C#
אנו יכולים להוסיף הפניה לתפקיד Arc במסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:
- ראשית, צור מופע של המחלקה XbrlDocument.
- לאחר מכן, הוסף מופע XBRL חדש למופעים של אובייקט XbrlDocument.
- לאחר מכן, הוסף הפניות לסכימה חדשה להפניות הסכימה של אובייקט XbrlInstance.
- לאחר מכן, קבל את SchemaRef לפי האינדקס שלו מ-SchemaRefCollection.
- לאחר מכן, קבל את ArcRoleType מהשיטה GetArcroleTypeByURI().
- לאחר מכן, צור מופע של המחלקה ArcRoleReference עם האובייקט ArcRoleType כארגומנט.
- לאחר מכן, הוסף את ArcRoleReference לאוסף האובייקטים של ArcRoleReference.
- לבסוף, שמור את קובץ XBRL באמצעות שיטת XbrlDocument.Save(). זה לוקח את נתיב קובץ הפלט כארגומנט.
דוגמת הקוד הבאה מראה כיצד להוסיף הפניה לתפקיד קשת במסמך מופע XBRL באמצעות C#.
// צור מופע של מחלקה XbrlDocument
XbrlDocument document = new XbrlDocument();
// קבל XbrlInstances
XbrlInstanceCollection xbrlInstances = document.XbrlInstances;
// הוסף XbrlInstance
xbrlInstances.Add();
XbrlInstance xbrlInstance = xbrlInstances[0];
// הגדר התייחסות לסכימה
SchemaRefCollection schemaRefs = xbrlInstance.SchemaRefs;
schemaRefs.Add(@"C:\Files\Finance\schema.xsd", "example", "http://example.com/xbrl/taxonomy");
SchemaRef schema = schemaRefs[0];
// הוסף התייחסות לתפקיד קשת
ArcroleType arcroleType = schema.GetArcroleTypeByURI("http://abc.com/arcrole/footnote-test");
if (arcroleType != null)
{
ArcroleReference arcroleReference = new ArcroleReference(arcroleType);
xbrlInstance.ArcroleReferences.Add(arcroleReference);
}
// שמור את המסמך
document.Save(@"C:\Files\Finance\document8.xbrl");
קבל רישיון חינם
אתה יכול לקבל רישיון זמני בחינם כדי לנסות את הספרייה ללא מגבלות הערכה.
סיכום
במאמר זה למדנו כיצד:
- צור מסמך XBRL באמצעות C#;
- הוסף הערת שוליים וקשת הערות באמצעות קישור הערת שוליים לאובייקטי XBRL באופן פרוגרמטי;
- הוסף הפניות לתפקידים וקשתות ב-XBRL ב-C#.
חוץ מזה, אתה יכול ללמוד עוד על Aspose.Finance עבור .NET API באמצעות תיעוד. בכל מקרה של אי בהירות, אנא אל תהסס לפנות אלינו בפורום.