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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetPresentation Function

Overview

The XBRLGetPresentation function returns information for a presentation from the high level master index.

Syntax/Parameters

Syntax

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

Parameters

hXM

A handle to an XBRL Object containing taxonomy information.

index

An int specifying the zero-based index of a presentation master index record.

Return Value

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

Remarks

The master index contains a record for each defined presentation. It defines the presentation and is linked to entries (line items) via the le_x key name. Master records are only available if the taxonomy data has been post processed using the XBRLPostProcess function or if records have been added using the XBRLAddPresentation function.

The array key names are as follows : 

	Key Name			Description/Comment
	Record:
		position		A decimal string containing the zero-based position of the record.
		id		Optional XML ID for the record.
		type		Type of presentation link.
		title		An optional title for the presentation. this is the title that is represented in the XML for the presentation link.
		role		An optional role for the presentation.
		element		Fully qualified QName for the root.
		prefix		Prefix name the root element (as part of a QName).
		concept		Root concept name.
	Control
		le_x		A decimal string containing the Line Entry Index.
		lnk_x		A decimal string containing the XML link index. This is only present if the record was derived from an XML taxonomy.
		loc_x		A decimal string containing the first the XML locator index. This is only present if the record was derived from an XML taxonomy.
		arc_x		A decimal string containing the first the XML arc index. This is only present if the record was derived from an XML taxonomy.

 .

 

Related Functions

XBRLGetPresentationCount — Returns the count of presentation index items.

XBRLGetPresentationEntry — Returns a presentation entry by index.

XBRLGetPresentationEntryCount — Returns the count of all presentation line items.

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 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.