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

Table of Contents	< < Previous	Next >>

 

Chapter Twenty-three — XBRL Functions (continued)

XBRLViewGetContext Function

Overview

The XBRLViewGetContext function retrieves all the properties associated with a specific context in a string array.

Syntax/Parameters

Syntax

string[] = XBRLViewGetContext ( handle hXBRL, int index | string id );

Parameters

hXBRL

A handle containing the reference to an XBRL object.

index

If an integer is supplied, it is assumed to be a zero-based index to the internal context array. There is no meaning as to the position of contexts in the array and the position from object to object cannot be guaranteed.

id‡

If a string is supplied, it is assumed to be the context ID and is used to locate the specified context.

Return Value

A string array containing the context data or an empty set on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

The array will contain the following information. Note that not all contexts contain dimensional information:

	Key Name			Description/Comment
	General Items:
		ID		The context’s ID. This can essentially be any legal XML/XBRL.
		ContextIndex		The internal context ID. This is not an XBRL provided data element. If an index was used to retrieve the context data, this value will match that index.
		CIK		EDGAR CIK value for the context.
		StartDate		Starting date of the context.
		EndDate		Ending date of the context. If this field is not present, the context is considered an ‘instant’ context, otherwise it is considered a ‘duration’ context.
	Dimensional Items:
		MemberElement-nnn		Member element name (namespace and element).
		MemberLabel-nnn		Member label.
		DimensionElement-nnn		Dimension element name (namespace and element).
		DimensionLabel-nnn		Dimension label.

Related Functions

XBRLViewGetContextCount — Gets the total number of contexts.

XBRLViewGetContexts — Returns all the contexts by context ID.

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.