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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XDXPropertiesToEngram Function

Overview

The XDXPropertiesToEngram function takes an optional parameter list and creates an XDX engram.

Syntax/Parameters

Syntax

string = XDXPropertiesToEngram ( byte type, [string properties], [boolean unique] );

Parameters

type

A byte specifying the type of XDX engram.

properties

An optional string containing key named parameters to add to the engram,

unique

An optional boolean value indicated whether to add a randomly generated unique ID. If omitted, the default value is TRUE.

Return Value

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

Remarks

Engrams are normally stored in the ID attribute of HTML tags but may also be stored in comment fields. See Section 11.18 Low Level XDX Functions for the definition of engram type codes, properties names and value format. Note, many items must be encoded before being added to an engram.

The API function does not test whether specified properties are appropriate for the engram type.

Finally, not all XDX information is contained in ID engrams.

Related Functions

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

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

XDXCreateDisplayComponent — Assembles flags or array parameters to create display components for an engram.

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

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.

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

XDXEngramToProperties — Parses an engram and returns the high-level associated XBRL 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.