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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XDXEngramToProperties Function

Overview

The XDXEngramToProperties function returns processes the engram and returns a set of properties that relate to the specific XDX command or action.

Syntax/Parameters

Syntax

string[] = XDXEngramToProperties ( string data );

string[] = XDXEngramToProperties ( handle hXDX, int index );

Parameters

data

A string containing an engram. Or,

hXDX

A handle to an XDX Object. And,

index

A zero-based int specifying the map index position to retrieve the data.

Return Value

A string array containing the parameters for the engram or an empty array on failure. Use the GetLastError function to retrieve a formatted error code and GetLastErrorMessage for additional detail.

Remarks

The XDXEngramToProperties takes an engram and breaks it into the properties for a specific engram type. The first parameter is always the same and represents the type of engram. The remaining contain the specific data based on the type of engram.

The key names are as follows:

	Key Name			Description
	Basic Information:
		code		The XDX code that specifies the function of the engram.
	Column Context:
		context		Composite context containing dates and members.
	Context:
		context		Composite context containing dates and members.
	DEI Fact:
		dei_fact		TBD
	Element
		element		Taxonomy Element (XBRL Concept).
		pm_mode		Period Match Mode
		indent		Indent Level.
		neg_flag		Negated Flag (for the current presentation)
		tot_flag		Total Flag (for the current presentation)
		abs_flag		Abstract Flag (for the current presentation)
		dat_flag		Date Heading Flag
		cal_flag		Calculation Flag
		main_flag		Use Main Presentation Flag
		rel_flag		Relation Flag
		parent		Parent Element.
		precision		Precision.
		counted		“Counted As”.
		display		TDB
		unit		Unit Applied.
	Fact (Inline or Block):
		context		Composite context containing dates and members.
		element		Taxonomy Element (XBRL Concept).
		pm_mode		Period Match Mode
		indent		Indent Level.
		neg_flag		Negated Flag (for the current presentation)
		tot_flag		Total Flag (for the current presentation)
		abs_flag		Abstract Flag (for the current presentation)
		dat_flag		Date Heading Flag
		cal_flag		Calculation Flag
		main_flag		Use Main Presentation Flag
		rel_flag		Relation Flag
		parent		Parent Element.
		precision		Precision.
		counted		“Counted As”.
		display		TBD
		unit		Unit Applied.
		ftn_refs		Footnote Reference
		val_over
	Link
		link		TBD
	Namespace:
		namespace		Instance namespace.
	Report Period:
		report_period		TBD
	Row Context:
		context		Composite context containing dates and members.
		element		Taxonomy Element (XBRL Concept).
		pm_mode		Period Match Mode
		indent		Indent Level.
		neg_flag		Negated Flag (for the current presentation)
		tot_flag		Total Flag (for the current presentation)
		abs_flag		Abstract Flag (for the current presentation)
		dat_flag		Date Heading Flag
		cal_flag		Calculation Flag
		main_flag		Use Main Presentation Flag
		rel_flag		Relation Flag
		parent		Parent Element.
		precision		Precision.
		counted		“Counted As”.
		display		TBD
		unit		Unit Applied.
	Table (Presentation):
		element		Taxonomy Element (XBRL Concept).
		type		TBD
		name		TBD
		precision		Default precision.
		counted		Default “Counted As.”
	Taxonomy:
		taxomony		Name of root taxonomy for instance.

 

Related Functions

XDXEngramToParameters — Parses an engram and breaks it in to its constituent parameters.

XDXGetEngram — Gets an engram at a specific position.

XDXGetEngramCount — Returns the current count in the engram map.

XDXGetEngramPosition — Returns the file position of a mapped engram.

XDXGetEngramType — Retrieves the engram type from a string or map entry.

XDXMapFile — Maps an existing item for XDX information.

XDXPropertiesToEngram — Creates an engram based on the specified properties.

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.