GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
XBRLGetPresentationLink Function
Overview
The XBRLGetPresentationLink function returns a single presentation link present in the instance/taxonomy.
Syntax/Parameters
Syntax
string[][] = XBRLGetPresentationLink ( handle hXM, int pos );
Parameters
hXM
A handle to an XBRL Object containing instance information.
pos
An optional int specifying the zero-based index of a presentation link.
Return Value
Returns a string list of the properties for a presentation link or an empty list on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
The list key names are as follows:
Key Name | Description/Comment | ||||
Position | |||||
position† | Zero-based decimal string version of the position of the record. | ||||
Presentation 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. | ||||
pl_flags | A string as a hexadecimal value for the status of the entry. |
† This value is not presented in terse mode.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
Table of Contents | < < Previous | Next >> |
© 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.