GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetCalculationLink Function

Overview

The XBRLGetCalculationLink function returns a specified calculation link from the instance/taxonomy.

Syntax/Parameters

Syntax

string[] = XBRLGetCalculationLink ( handle hXM, int index );

Parameters

hXM

A handle to an XBRL Object containing taxonomy information.

index

A zero-based int specifying the position to retrieve.

Return Value

Returns a string list of all calculation links or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

The key names are as follows: 

	Key Name			Description/Comment
	Definition Link:
		id		The id attribute, if supplied.
		role		The role format the presentation
		title		The tittle attribute.
		type		The type of presentation
	Inter-record Links
		f_loc_index		Zero-based decimal string version of the first position of the locator records.
		f_arc_index		Zero-based decimal string version of the first position of the arc records.
	Control
		s_dx		Source file DTS index. String is “-1” if not from the DTS.
		s_lx		Source file linkbase index. String is “-1” if not from the Linkbase List.
		s_sx		Zero-based X position in source file.
		s_sy		Zero-based Y position in source file.
		ref_cnt		Number of link references.
		cl_flags		A string as a hexadecimal value for the status of the entry.

  

[define flags]

This function is the same as XBRLGetCalculationLinks except a single item is returned.

Related Functions

XBRLGetCalculationArcs — Returns a table of a group or all calculation arc records.

XBRLGetCalculationItem — Returns a calculation data item for a specified record.

XBRLGetCalculationItemCount — Returns the number defined calculations.

XBRLGetCalculationItems — Returns all calculation item or data for a specified group.

XBRLGetCalculationLinkCount — Returns the number of calculation links loaded.

XBRLGetCalculationLinks — Returns all calculation links.

XBRLGetCalculationLocators — Returns all calculation locators.

XBRLGetCalculationRoles — Returns the Roles and Titles for all calculations.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.