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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XDXCreateContextComponent Function

Overview

The XDXCreateContextComponent function assembles parameters to create a context component.

Syntax/Parameters

Syntax

string = XDXCreateContextComponent ( string data[] );

Parameters

data

A string array containing named parameters. See Remarks below.

Return Value

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

Remarks

Component parameters are provided as an array with named keys. The key names are as follows:

	Definition		Description
	date_a		Starting date of duration or date of instant context.
	date_b		Ending date for a type duration context.
	dimension_xx		Pairs of dimension and value from 01 to 10.
	value_xx		Pairs of dimension and value from 01 to 10.

 

Note that the returned component does not contain an engram code. This is added when the component is added using the XDXPropertiesToEngram function.

The reciprocal function is XDXGetContextProperties.

Related Functions

XDXCreateCalculationComponent — Creates a property formatted calculation string for an engram.

XDXCreateContextComponent — Creates a property formatted context string for an engram.

XDXCreateElementComponent — Formats an element or concept name for placement as a component value.

XDXCreateFootnoteComponent

XDXCreateGroupingComponent — Creates a grouping component to be placed in an engram,

XDXCreatePrecisionComponent — Creates a component string for precision and power terms.

XDXCreatePresentationComponent — Creates a property string containing presentation line item terms.

XDXGetDisplayFlags — Extracts the display flags from an engram or component.

XDXGetDisplayProperties — Extracts the display properties from an engram or component.

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