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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XDXCreateGroupingComponent Function

Overview

The XDXCreateGroupingComponent function assembles parameters to create group component.

Syntax/Parameters

Syntax

string = XDXCreateGroupingComponent ( 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:

	Key Name		Description
	id		An identifier for the grouping that is only letters with the exception of L1, L2, or L3 are allowable. All engrams that use the same grouping identifier will be part of a single group.
	order		An optional order that describes the order of the parts of the continuation. If an order is not specified the order is assumed to be the order the engrams appear in the file.

 

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

The complimenting function is XDXGetGroupingProperties.

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.

XDXGetGroupingProperties — Extracts grouping properties from 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 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.