Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter Eleven — SGML Functions (continued)

XDXGetDisplayFlags Function

Overview

The XDXGetDisplayFlags function returns the translated display flags from a display component or engram.

Syntax/Parameters

Syntax

dword = XDXGetDisplayFlags ( string data );

Parameters

data

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

Return Value

A dword containing the display flags or 0x00000000 empty on failure. Use the GetLastError function to retrieve a formatted error code and GetLastErrorMessage for additional detail.

Remarks

The flags values are as follows:

  Definition   Bitwise   Description  
  Display Types          
    XDX_DISPLAY_TYPE_MASK   0xF0000000   Type Mask  
    XDX_DISPLAY_GENERAL   0x00000000   General (No extra formatting)  
    XDX_DISPLAY_CARDINAL   0x10000000   Cardinal Type (five hundred thirty)  
    XDX_DISPLAY_CARDINAL_MIX   0x20000000   Cardinal Mixed Type (5.3 hundred)  
    XDX_DISPLAY_DATE   0x40000000   Dates (May 3, 2011 or Feb 2011)  
    XDX_DISPLAY_ISODURATION   0x80000000   ISO Duration  
  Date/Duration Type Flags          
    XDX_DISPLAY_ISO_MASK   0x0F000000   ISO Mask  
    XDX_DISPLAY_ISO_FULL   0x00000000   Assume Full Duration (3 Years, 6 months)  
    XDX_DISPLAY_ISO_YEARS   0x01000000   Assume Years (ie 3 -> 3 Years)  
    XDX_DISPLAY_ISO_MONTHS   0x02000000   Assume Months (ie 3 -> 3 Months)  
    XDX_DISPLAY_ISO_WEEKS   0x03000000   Assume Weeks (ie 3 -> 3 Weeks)  
    XDX_DISPLAY_ISO_DAYS   0x04000000   Assume Days (ie 3 -> 3 Days)  
    XDX_DISPLAY_ISO_HOURS   0x05000000   Assume Hours (ie 3 -> 3 Hours)  
  Partial Types          
    XDX_DISPLAY_PERCENT   0x00100000   Is Percent (x100)  
  Additional Formatting          
    XDX_DISPLAY_NONEFORZERO   0x00000001   None for 0 (None in text)  
    XDX_DISPLAY_NOFORZERO   0x00000002   No for 0 (No in text)  
    XDX_DISPLAY_DASHFORZERO   0x00000004   - for 0 (- is normally nil)  
    XDX_DISPLAY_NOCOMMAS   0x00000008   No Commas in number  
    XDX_DISPLAY_USENEGATIVE   0x00000010   Use Negative Sign instead of parens  
    XDX_DISPLAY_INVERT   0x00010000   Invert Value  

 

This function is the reciprocal of the XDXCreateDisplayComponent function,

The error should be checked since 0x00000000 could be considered a value display value.

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.

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

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

 

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.