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

Table of Contents	< < Previous	Next >>

 

Chapter Twenty-three — XBRL Functions (continued)

XBRLViewGetPresentationProperties Function

Overview

The XBRLViewGetPresentationProperties function returns certain properties for the overall presentation.

Syntax/Parameters

Syntax

string [] = XBRLViewGetPresentationProperties ( handle hXBRL, int position );

Parameters

hXBRL

A handle containing the reference to an XBRL object.

position

An int specifying the zero-based presentation index within the XBRL data set. Note that this value is the position in the XBRL Object which can include pseudo presentations.

Return Value

A string array containing the presentation properties or an empty array on error. Use the GetLastError function to retrieve a formatted error code.

Remarks

The key values are defined as follows:

	Key Name		Description
	Name		Name of presentation.
	RootElement		Root element of presentation.
	TableElement		Table element for presentation. If blank, the default is used on export.
	LineItemElement		Line Item (top abstract) element for presentation. If blank, the default is used on export.
	DimensionElement-nnn		Dimension element for presentation, if applicable. Elements are numbered from 001 to 010. Empty elements are not added to the result.
	DomainElement-nnn		Domain element for presentation, if applicable. Elements are numbered from 001 to 010. Empty elements are not added to the result.
	RoleURI		Unique presentation role URI, if specified.

 

Related Functions

XBRLViewGetPresentations — Returns the names of all presentations.

Platform Support

GoFiler Complete, GoFiler Corporate, GoXBRL

 

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.