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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetPresentationEntry Function

Overview

The XBRLGetPresentationEntry function returns a high level presentation entry from the master index.

Syntax/Parameters

Syntax

string[] = XBRLGetPresentationEntry ( 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 entry table.

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

After processing or adding to the presentation database, line item entries are organized in a serial list presentation by presentation. Each presentation group is separated by a null record. Programmer can enumerate records from the le_x position retrieved from the XBRLGetPresentation function until a null record is reached or the end of the list. The count of entries can be retrieved using the XBRLGetPresentionEntryCount function.

The array key names are as follows : 

	Key Name			Description/Comment
	Record:
		title		An optional title for the presentation entry.
		order		A decimal string containing the ordering of the entry.
		indent		A decimal string containing the zero-based level or indent of the item in the tree in relation to the entry prior. If 0, it is the first entry.
		element		Fully qualified QName for the concept.
		prefix		Prefix name (as part of a QName).
		concept		Concept name within the concept array.
		label		Optional label text. This can be the text added during a call to add an entry or the label text from the label linkbase.
		role		Optional label role. If blank, then the default label role applies.
	Control
		position		A decimal string containing the zero-based position of the record.
		m_x		A decimal string containing the index of the master entry, the parent.
		pe_flags		A decimal string containing the Line Entry Index.

 .

 

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