GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetPresentationArcs Function

Overview

The XBRLGetPresentationArcs function returns presentation arcs present in the instance/taxonomy for a specified presentation link or all defined presentation arcs.

Syntax/Parameters

Syntax

string[][] = XBRLGetPresentationArcs ( handle hXM, [int link] );

Parameters

hXM

A handle to an XBRL Object containing instance information.

link

An optional int specifying the zero-based index of a presentation link.

Return Value

Returns a string table of arcs and their properties or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

The primary column key names are as follows (not that other key names may be present since this is a generic arc structure): 

	Key Name			Description/Comment
	Arc Record:
		actuate		The actuate attribute.
		arcrole		The arcrole attribute.
		from		The from attribute label to the arc. This is the link from the locator to the arc.
		order		The order attribute. Decimal with two places.
		preferred_label		An optional preferred label role URL.
		priority		The priority attribute.
		show		The show attribute.
		title		The tittle attribute.
		to		The to attribute as the label used to link the arc to an actual footnote record.
		use		The use attribute.
	Control
		f_sx		Position in source file.
		f_sy		Position in source file.
		ref_cnt		Number of arc references.
		arc_flags		A string as a hexadecimal value for the status of the entry.

 .

If all arcs are requested, there will be null records that delineate the break points in the list between presentation links. the arc_flags column will have the XM_ARC_NULL_RECORD bit set.

Related Functions

XBRLGetPresentationLink — Returns a specified presentation link record.

XBRLGetPresentationLinkCount — Returns the number of loaded presentation links.

XBRLGetPresentationLinks — Returns all presentation links.

XBRLGetPresentationLocators — Returns all presentation locators.

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 12/16/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.