Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter Eleven — SGML Functions

Chapter Contents

11.1 Introduction to SGML Support
11.1.1 General
11.1.2 Terminology
11.1.3 Namespace
11.1.4 SGML Object
11.1.5 Special Data Types
11.1.6 PVALUE Data Type
11.1.7 TOKEN Data Type
11.1.8 SGML Classes and Objects
11.2 Code Width
11.2.1 General
11.2.2 Functions
SGMLGetCodeIndent Function
SGMLGetCodeWidth Function
SGMLSetCodeIndent Function
SGMLSetCodeWidth Function
11.3 The SGML Object
11.3.1 General
11.3.2 SGML Element Class
11.3.3 Parsing
11.3.4 SGML Object Functions
SGMLClearAttributes Function
SGMLClearParameters Function
SGMLCreate Function
SGMLGetDTDType Function
SGMLGetEditObject Function
SGMLGetMappedTextObject Function
SGMLResetElement Function
SGMLSetCommentMode Function
SGMLSetHTMLDTD Function
SGMLSetFile Function
SGMLSetHandle Function
SGMLSetString Function
SGMLSetUTFEncoding Function
11.3.5 SGML Parsing Functions
SGMLEnumerateErrors Function
SGMLErrorsToLog Function
SGMLFindClosingElement Function
SGMLFindElement Function
SGMLGetCharacterValue Function
SGMLGetElementString Function
SGMLGetElementToken Function
SGMLGetItemPosition Function
SGMLGetItemPosEX Function
SGMLGetItemPosEY Function
SGMLGetItemPosSX Function
SGMLGetItemPosSY Function
SGMLGetItemResult Function
SGMLGetItemSize Function
SGMLGetItemType Function
SGMLGetNamespaceString Function
SGMLGetNamespaceToken Function
SGMLHasErrors Function
SGMLIsEmptyElement Function
SGMLNextElement Function
SGMLNextItem Function
SGMLNextNonSpaceItem Function
SGMLNormalizeErrors Function
SGMLNormalizeToCSS Function
SGMLPreviousElement Function
SGMLScrubParameters Function
SGMLSetDataRange Function
SGMLSetPosition Function
SGMLGetSegment Function
11.3.6 SGML Writing
SGMLToString Function
SGMLWriteSegment Function
SGMLWriteTag Function
11.3.7 Parameters and Properties
SGMLDeleteParameter Function
SGMLGetEntryCount Function
SGMLGetEntryFlags Function
SGMLGetEntryProperties Function
SGMLGetParameter Function
SGMLGetParameterFlags Function
SGMLGetParameterValue Function
SGMLGetParameters Function
SGMLPullParameter Function
SGMLPullParameterValue Function
SGMLPutParameter Function
SGMLSetParameter Function
SGMLSetElement Function
11.3.8 SGML Values and SGML Math
SGMLAddValues Function
SGMLCharEntityToValue Function
SGMLDivideValue Function
SGMLFloatToValue Function
SGMLIntegerToValue Function
SGMLIsDataAvailable Function
SGMLIsImplied Function
SGMLIsMeasurement Function
SGMLIsMixed Function
SGMLIsWholeUnits Function
SGMLMultiplyValue Function
SGMLNormalizeUnits Function
SGMLPixelsToValue Function
SGMLStringToValue Function
SGMLSubtractValues Function
SGMLTWIPSToValue Function
SGMLValueToData Function
SGMLValueToInteger Function
SGMLValueToPixels Function
SGMLValueToString Function
SGMLValueToTWIPS Function
11.3.9 CSS Functions
CSSClearProperties Function
CSSGetDeclaration Function
CSSGetProperties Function
CSSLayerDeclaration Function
CSSLayerProperties Function
CSSSetDeclaration Function
CSSSetProperties Function
11.3.10 DTD and Schema
DTDCreateObject Function
DTDEnumerateAttributes Function
DTDEnumerateElements Function
DTDEnumerateNamespaces Function
DTDEnumerateProperties Function
DTDGetCSSPropertyCase Function
DTDGetNamespaces Function
DTDGetObject Function
DTDGetProperties Function
DTDGetTagCase Function
DTDParseDocType Function
DTDParseTagCase Function
SGMLAttributeToString Function
SGMLElementToString Function
SGMLPropertyToString Function
SGMLStringToAttribute Function
SGMLStringToElement Function
SGMLStringToProperty Function
11.4 HTML Tables
11.4.1 Overview
11.4.2 Operation
11.4.3 Functions
HTMLTableFindCell Function
HTMLTableGetCell Function
HTMLTableGetCellAsText Function
HTMLTableGetCellClass Function
HTMLTableGetCellProperties Function
HTMLTableGetColumnCount Function
HTMLTableGetColumnProperties Function
HTMLTableGetDiscreteCount Function
HTMLTableGetMapCount Function
HTMLTableGetRowClass Function
HTMLTableGetRowCount Function
HTMLTableGetRowPositions Function
HTMLTableGetRowProperties Function
HTMLTableGetTablePosition Function
HTMLTableGetWidths Function
HTMLTableGetWidthValues Function
HTMLTableMap Function
HTMLTableToString Function
HTMLTableToTable Function
HTMLTableToText Function
HTMLTableWrite Function
11.5 HTML Header Management
11.5.1 Overview
11.5.2 Operation
11.5.3 Functions
HTMLHeaderOpen Function
HTMLHeaderGetComponents Function
HTMLHeaderGetDTDComponents Function
HTMLHeaderHasDTD Function
HTMLHeaderHasHeader Function
HTMLHeaderHasLinkData Function
HTMLHeaderHasMetaData Function
HTMLHeaderHasScriptData Function
HTMLHeaderHasStyleData Function
HTMLHeaderHasTitle Function
HTMLHeaderGetDTDString Function
HTMLMetaGetItem Function
HTMLMetaGetItemCount Function
HTMLHeaderGetTitle Function
11.6 The HTML Outline Object
11.6.1 General
11.6.2 Basic Operation
11.6.3 Functions
OutlineCreateObject Function
OutlineGetItemColumn Function
OutlineGetItemCount Function
OutlineGetItemHTML Function
OutlineGetItemPosEX Function
OutlineGetItemPosEY Function
OutlineGetItemPosSX Function
OutlineGetItemPosSY Function
OutlineGetItemRow Function
OutlineGetItemSpan Function
OutlineGetItemText Function
OutlineGetItemType Function
OutlineGetString Function
OutlineSetFile Function
OutlineSetObject Function
11.7 SGML Code Tools
11.7.1 General
11.7.2 Basic Operation
11.7.3 Functions
SGMLFindText Function
11.8 HTML Context Tools
11.8.1 General
11.8.2 Functions
HTMLContextCreate Function
HTMLContextScan Function
HTMLGetContext Function
HTMLGetNames Function
HTMLGetObjects Function
11.9 HTML Code Tools
11.9.1 General
11.9.2 HTML Element Testers
11.9.3 HTML Code Functions
HTMLIsBlockBasicElement Function
HTMLIsBlockElement Function
HTMLIsBodyContainerElement Function
HTMLIsContainerElement Function
HTMLIsFlowContainerElement Function
HTMLIsFormControlElement Function
HTMLIsHeadElement Function
HTMLIsInlineElement Function
HTMLIsInlineStyleElement Function
HTMLIsListContainer Function
HTMLIsListItem Function
HTMLIsRevisionElement Function
HTMLIsSelfContainedElement Function
HTMLIsTableElement Function
HTMLIsTableFrameElement Function
HTMLIsField Function
HTMLIsFieldBlock Function
HTMLIsFieldInline Function
HTMLConformCode Function
HTMLTidyCode Function
HTMLToXHTML Function
11.10 The HTML Writer Object
11.10.1 General
11.10.2 Basic Operation
11.10.3 HTML Writer Object Functions
HTMLAddSegment Function
HTMLCreateWriterObject Function
HTMLSetNewLineMode Function
HTMLWriterToFile Function
HTMLWriterToString Function
11.10.4 HTML Writer Header Functions
HTMLSetDTD Function
HTMLSetEncoding Function
HTMLAddHead Function
HTMLAddFoot Function
11.10.5 HTML Writer Default Style Functions
HTMLSetBlockClass Function
HTMLSetBlockStyle Function
HTMLSetLinkClass Function
HTMLSetCellClass Function
HTMLSetCellStyle Function
HTMLSetRowClass Function
HTMLSetRowStyle Function
HTMLSetTableClass Function
HTMLSetTableStyle Function
HTMLSetTableSpacing Function
11.10.6 HTML Writer Text Stream Functions
HTMLAddText Function
HTMLAddLinkedText Function
HTMLGetTextMode Function
HTMLSetTextMode Function
11.10.7 HTML Writer Paragraph Functions
HTMLAddPara Function
HTMLBeginPara Function
HTMLCompletePara Function
HTMLParaOpen Function
HTMLParaClose Function
11.10.8 Unmanaged Table Functions
HTMLTableOpen Function
HTMLTableClose Function
HTMLRowOpen Function
HTMLRowClose Function
HTMLCellOpen Function
HTMLCellClose Function
HTMLAddCell Function
11.10.9 Managed Table Functions
HTMLBeginTable Function
HTMLColumnSetWidth Function
HTMLCompleteTable Function
HTMLBeginRow Function
HTMLCompleteRow Function
HTMLBeginCell Function
HTMLCompleteCell Function
11.11 HTML Style
11.11.1 General
11.11.2 SGML Object 
11.11.3 Operation
11.11.4 Functions
HTMLStyleAddAttribute Function
HTMLStyleAddBlock Function
HTMLStyleAddItem Function
HTMLStyleCreate Function
HTMLStyleGetProperties Function
HTMLStyleNormalize Function
HTMLStyleRenderCode Function
HTMLStyleRenderText Function
HTMLStyleReset Function
HTMLStyleSetProperties Function
11.12 HTML/XML Fields
11.12.1 General
11.12.2 Field Structure
11.12.3 Field Names and Tokens
11.12.4 Field Parameters
11.12.5 Functions
FieldCreateObject Function
FieldDeleteParameter Function
FieldFindClosingField Function
FieldFindField Function
FieldFromParameters Function
FieldGetFieldContent Function
FieldGetFieldPosEX Function
FieldGetFieldPosEY Function
FieldGetFieldPosSX Function
FieldGetFieldPosSY Function
FieldGetFieldProperties Function
FieldGetFieldResult Function
FieldGetFieldToken Function
FieldGetParameter Function
FieldGetParameters Function
FieldGetParseString Function
FieldLoadString Function
FieldNextField Function
FieldReset Function
FieldSetParameter Function
FieldTokenToString Function
FieldToParameters Function
FieldToString Function
FieldWrite Function
EnumerateSetFields Function
11.13 Page Break Object
11.13.1 General
11.13.2 The Page-Break Field
11.13.3 Property Key Names
11.13.4 Functions
HTMLPageBreakCreate Function
HTMLPageBreakCreateCode Function
HTMLPageBreakGetCount Function
HTMLPageBreakGetPosition Function
HTMLPageBreakGetProperties Function
HTMLPageBreakEnumerate Function
HTMLPageBreakMap Function
11.14 HTML Tools
11.14.1 General
11.14.2 Functions
HTMLValidate Function
11.15 RSS and Atom News Feed Object
11.15.1 General
11.15.2 Functions
RSSLoadFeed Function
RSSGetItemCount Function
RSSGetItemProperties Function
11.16 Compare HTML Files
11.16.1 General
11.16.2 Functions
CompareHTMLCreateMerged Function
CompareHTMLGetFirstDifference Function
CompareHTMLGetNextDifference Function
CompareHTMLGetDifferenceProperties Function
11.17 Low Level Inline XBRL
11.17.1 Overview
11.17.2 Reading
11.17.3 Writing
11.17.4 Functions
iXBRLAddItem Function‡
iXBRLCommit Function‡
iXBRLCreateObject Function
iXBRLGetIDMap Function
iXBRLGetItemCount Function
iXBRLGetItemProperties Function
iXBRLGetMappedTextObject Function
11.18 Low Level XDX Functions
11.18.1 Overview
11.18.2 Engrams
11.18.4 HTML Embed
11.18.5 Functions
11.19 XDX Support Information 
11.19.1 Engram Types
11.19.2 Engram Properties
XDXCreateCalculationComponent Function
XDXCreateContextComponent Function
XDXCreateDisplayComponent Function
XDXCreateElementComponent Function
XDXCreateGroupingComponent Function
XDXCreatePrecisionComponent Function
XDXCreatePresentationComponent Function
XDXCreateUnitComponent Function
XDXEngramToParameters Function
XDXEngramToProperties Function
XDXGetCalculationProperties Function
XDXGetContextMember Function
XDXGetContextProperties Function
XDXGetDisplayFlags Function
XDXGetDisplayProperties Function
XDXGetElement Function
XDXGetEngram Function
XDXGetEngramCount Function
XDXGetEngramPosition Function
XDXGetEngramType Function
XDXGetGroupingProperties Function
XDXGetPrecisionProperties Function
XDXGetPresentationProperties Function
XDXGetUnitProperties Function
XDXMapArea Function
XDXMapFile Function
XDXPropertiesToEngram Function
11.20 XBRL Model
11.20.1 Overview
11.20.2 XBRL Instances
11.20.3 Taxonomies
11.20.4 Instance and Taxonomy Writing
11.20.5 XBRL Model Function Groups
XBRLCreateObject Function
11.20.6 XBRL Model — Loading Functions
XBRLAddInstance Function
XBRLLoadInstance Function
XBRLImportTaxonomy Function
XBRLLoadTaxonomy Function
XBRLPostProcess Function
11.20.7 XBRL Model — Writing Functions
XBRLExportXMLSegment Function†
11.20.8 XBRL Model Support Functions
XBRLGetBaseTaxonomyType Function
XBRLGetEntryPoint Function
XBRLGetEntryPointNamespace Function
XBRLGetEntryPointPrefix Function
XBRLGetInstanceFormat Function
XBRLGetLinkbaseList Function
XBRLGetNamespaceMap Function
XBRLGetSchemaList Function
XBRLGetSchemaRef Function
XBRLSetOptions Function
XBRLSetSchemaRef Function
XBRLTaxonomyTypeToString Function
XBRLTransformData Function
XBRLValidateByDataType Function
11.20.9 Instance — Facts
XBRLAddFact Function
XBRLGetFact Function
XBRLGetFactCount Function
XBRLGetFacts Function
XBRLGetFactsByConcept Function
XBRLGetFactsByContext Function
XBRLGetFactsByElement Function
XBRLGetFactsByPrefix Function
11.20.10 Instance — Contexts
XBRLAddContext Function
XBRLFindContextAxis Function
XBRLGetContext Function
XBRLGetContextCount Function
XBRLGetContexts Function
XBRLGetContextMember Function
11.20.11 Instance — Units
XBRLAddUnit Function
XBRLGetUnit Function
XBRLGetUnitCount Function
XBRLGetUnits Function
11.20.12 Instance — Footnotes
XBRLGetFootnote Function
XBRLGetFootnoteArcs Function
XBRLGetFootnoteCount Function
XBRLGetFootnoteLocators Function
XBRLGetFootnotes Function
XBRLGetFootnotesForFact Function
11.20.13 Taxonomy — Concepts
XBRLAddConcept Function
XBRLGetConcept Function
XBRLGetConceptByID Function
XBRLGetConceptCount Function
XBRLGetConcepts Function
11.20.14 Taxonomy — Definition Functions
XBRLGetDefinitionArc Function
XBRLGetDefinitionArcs Function
XBRLGetDefinitionLink Function
XBRLGetDefinitionLinkCount Function
XBRLGetDefinitionLinks Function
XBRLGetDefinitionLocator Function
XBRLGetDefinitionLocators Function
11.20.15 Taxonomy — Calculations
XBRLFindCalculationGroup Function
XBRLFindCalculationItem Function
XBRLFindCalculationRole Function
XBRLGetCalculationLinkCount Function
XBRLGetCalculationArc Function
XBRLGetCalculationArcs Function
XBRLGetCalculationItem Function
XBRLGetCalculationItemCount Function
XBRLGetCalculationItems Function
XBRLGetCalculationLinkCount Function
XBRLGetCalculationLink Function
XBRLGetCalculationLinks Function
XBRLGetCalculationLocators Function
XBRLGetCalculationRoles Function
11.20.16 Taxonomy — Data Types
XBRLGetDataType Function
XBRLGetDataTypeCount Function
XBRLGetDataTypes Function
11.20.17 Taxonomy — Labels
XBRLGetLabel Function
XBRLGetLabelArcs Function
XBRLGetLabelCount Function
XBRLGetLabelLinks Function
XBRLGetLabelLocators Function
XBRLGetLabels Function
11.20.18 Taxonomy — Presentations
XBRLGetPresentation Function
XBRLGetPresentationArcs Function
XBRLGetPresentationCount Function
XBRLGetPresentationEntry Function
XBRLGetPresentationEntryCount Function
XBRLGetPresentationLink Function
XBRLGetPresentationLinkCount Function
XBRLGetPresentationLinks Function
XBRLGetPresentationLocators Function
11.20.19 Taxonomy — References
XBRLGetReference Function
XBRLGetReferenceArcs Function
XBRLGetReferenceCount Function
XBRLGetReferenceData Function
XBRLGetReferenceLink Function
XBRLGetReferenceLinkCount Function
XBRLGetReferenceLinks Function
XBRLGetReferenceLocators Function
XBRLGetReferences Function
11.20.20 Role Functions
XBRLGetRole Function
XBRLGetRoleCount Function
XBRLGetRoleList Function
XBRLGetRoleReferenceCount Function
XBRLGetRoleReferences Function
XBRLAddFactValues Function
XBRLApplyPrecision Function
XBRLCompareFactValues Function
XBRLLibraryBrowse Function
iXBRLValidate Function

 

 

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.