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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XDXGetDisplayProperties Function

Overview

The XDXGetDisplayProperties function returns the translated display flags in the form of properties from a display component or engram.

Syntax/Parameters

Syntax

string = XDXGetDisplayProperties ( string data );

Parameters

data

A string containing an engram or element component of an engram.

Return Value

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

Remarks

The key names are as follows:

	Definition		Description
	type		Type of display, can be: general — General (No extra formatting) cardinal — Cardinal Type (“five hundred thirty”) cardinal_mixed — Mixed Type (“5.3 hundred”) date — Dates (“May 3, 2011” or “Feb 2011”) duration — ISO Duration (“Three Months”)
	duration		If the type is date or duration, the value can be: full — Full duration (1 year, 6 months) years — Duration in years (2 years) months — Duration in months (6 months) weeks — Duration in weeks (2 weeks) days — Duration in days (5 days) hours — Duration in hours (12 hours) This key name will not be present if the type is not relevant.
	percent		This key name will be present and the value “true” is associated value is a percentage.
	none_for_zero		This key name will be present and the value “true” is associated number represented by “none”.
	no_for_zero		This key name will be present and the value “true” is associated number represented by “no”.
	dash_for_zero		This key name will be present and the value “true” is associated number represented by “-” or a dash.
	no_commas		This key name will be present and the value “true” is associated value numeric without commas.
	use_negative		This key name will be present and the value “true” is associated numeric uses a ‘-’ sign rather than ( ) to indicate a negative number.
	invert		This key name will be present and the value “true” is associated numeric value with the sign flipped.

 

This function is the reciprocal of the XDXCreateDisplayComponent function,

Related Functions

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

XDXGetCalculationProperties — Extracts calculation data from a component or engram.

XDXGetContextProperties — Extracts context properties from an engram or component.

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

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

XDXEngramToProperties — Parses an engram and returns the high-level associated XBRL properties.

XDXGetElement — Extracts an element from an engram or component.

XDXGetGroupingProperties — Extracts grouping properties from engram or component.

XDXGetPrecisionProperties — Extracts precision properties from engram or component.

XDXGetPresentationProperties — Extracts presentation formation for one or more facts 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 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.