در پست قبلی، ما یاد گرفتیم که چگونه با استفاده از سی شارپ، مرجع طرحواره، زمینه، واحد و اشیاء واقعیت را به اسناد نمونه XBRL اضافه کنیم. در این مقاله، نحوه افزودن لینک های پاورقی و اشیاء مرجع نقش به XBRL با استفاده از سی شارپ را خواهیم آموخت.
موضوعات زیر در این مقاله پوشش داده خواهد شد:
- C# API برای افزودن پیوندهای پاورقی و اشیاء مرجع نقش به XBRL
- پیوندهای پاورقی را به XBRL اضافه کنید
- شیء مرجع نقش را به XBRL اضافه کنید
- Arc Role Reference Object در 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 اضافه کنید.
- یک نمونه Footnote را تعریف کنید و برچسب و متن آن را تنظیم کنید.
- نوع Locator را با استفاده از نمونه کلاس Loc راه اندازی کنید.
- FootnoteArc را با برچسب مکان یاب و برچسب پاورقی به عنوان آرگومان تعریف کنید.
- یک نمونه از کلاس 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.";
// Locator را تعریف کنید
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");
اضافه کردن Role Reference Object به 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");
اضافه کردن Arc Role Reference Object به 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];
// مرجع نقش Arc را اضافه کنید
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 در سی شارپ اضافه کنید.
علاوه بر این، می‌توانید با استفاده از مستندات درباره Aspose.Finance for .NET API اطلاعات بیشتری کسب کنید. در صورت وجود هرگونه ابهامی، لطفاً با ما در تالار گفتمان تماس بگیرید.