Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.6a

Application v 6.0a

  

 

Chapter Five — General Functions

Chapter Contents

5.1 General Functions
5.1.1 Overview
5.1.2 Function Groups
5.2 String Functions
5.2.1 Overview
5.2.2 Strings
5.2.2.1 Formatted Strings
5.2.3 String and String Related Functions
5.3 String Tester Functions
5.3.1 Overview
5.3.2 Functions
CompareStrings Function
CompareStringsNoCase Function
HasNumeric Function
HasOrdinalSuffix Function
HasText Function
IsAccounting Function
IsAllLower Function
IsAllUpper Function
IsAlpha8859 Function
IsAlphaNumeric8859 Function
IsAlphaNumeric Function
IsAlpha Function
IsANSI Function
IsANSICharacters Function
IsANSISpace Function
IsASCII Function
IsASCIICharacters Function
IsCurrency Function
IsCurrencyFormatted Function
IsCurrencyPrefix Function
IsCurrencyProper Function
IsDigit Function
IsDrawing Function
IsEmptyString Function
IsExpressionBoolean Function
IsExpressionCharacter Function
IsExpressionGroup Function
IsExpressionLogic Function
IsExpressionMath Function
IsExtendedAlpha Function
IsFalse Function
IsFinancial Function
IsFootnoteReference Function
IsHex Function
IsHTML Function
IsInString Function
IsLeaderBackFill Function
IsLeaderFill Function
IsLower Function
IsNil Function
IsNonBreakingSpace Function
IsNonBreakingSpaceEntity Function
IsNonBreakingSpacePCDATA Function
IsNumeric Function
IsPCDATARequired Function
IsPercentage Function
IsReal Function
IsRealStrict Function
IsRegexMatch Function
IsRoman Function
IsSectionNumber Function
IsSentenceDelimiter Function
IsSGMLCharacterEntity Function
IsSGMLEmptyElement Function
IsSGMLTag Function
IsStringPadded Function
IsTabbedString Function
IsText Function
IsTrue Function
IsUnicode Function
IsUpper Function
IsValidSGMLAttribute Function
IsValidSGMLCharacter Function
IsValidSGMLElement Function
IsValidSGMLStartCharacter Function
IsValidVariableCharacter Function
IsVowel Function
IsWildListMatch Function
IsWildMatch Function
IsWildString Function
IsWordDelimiter Function
IsWordSpace Function
5.4 Basic String Functions
5.4.1 Overview
5.4.2 Functions
ANSITextToXML Function
AppendWithDelimiter Function
ChangeCase Function
CharacterEntityToValue Function
CharacterToLowerCase Function
CharacterToUpperCase Function
ConformAddressString Function
ConvertAddNewlines Function
ConvertDeleteNewlines Function
ConvertFromEscapeCharacters Function
ConvertFromUnderbars Function
ConvertFromUnderlines Function
ConvertNoCodes Function
ConvertNoPunctuation Function
ConvertNoSpaces Function
ConvertSoftBreaksToSpaces Function
ConvertToEscapeCharacters Function
ConvertToSingleSpaces Function
ConvertToUnderbars Function
ConvertToUnderlines Function
ConvertWordSpaces Function
DeleteStringSegment Function
FindInString Function
GetListItemType Function
GetNthWord Function
GetNumericType Function
GetParameter Function
GetParameterName Function
GetParameterValue Function
GetParameterEqualName Function
GetParameterEqualValue Function
GetQNameParts Function
GetStringLength Function
GetStringFromQuotes Function
GetStringSegment Function
GetTagAttributes Function
GetTagElement Function
GetTagTextContent Function
GetTrimmedStringLength Function
GetWordCount Function
GetWordType Function
InsertStringSegment Function
InString Function
LayerStringSegment Function
MakeLowerCase Function
MakeUpperCase Function
OrderProperName Function
PadString Function
QuotedStringToString Function
ReplaceInString Function
ReplaceInStringRegex Function
ReplaceStringSegment Function
ReverseString Function
ScanString Function
SkipBackWordSpaces Function
SkipToLineEnding Function
SkipToNonText Function
SkipToWordSpace Function
SkipWordSpaces Function
SplitProperName Function
StringToQuotedString Function
StripOrdinalSuffix Function
TrailStringAfter Function
TrailStringAfterAlways Function
TrailStringBefore Function
TrimNonBreakingSpaces Function
TrimPadding Function
TrimPaddingEntities Function
TrimString Function
ValueToCharacterEntity Function
WordsToArray Function
XMLTextToANSI Function
XMLTextToUTF Function
5.5 Speciality String Functions
5.5.1 Overview
5.5.2 Functions
CreateSortImage Function
FormatString Function
GetLeaderFillPosition Function
WordToPlural Function
WordToSingular Function
5.6 Numeric String Processing
5.6.1 Overview
5.6.2 Functions
AlphaToInteger Function
CellAddressGetColumn Function
CellAddressGetRow Function
CellAddressToIndex Function
CellIndexToAddress Function
CardinalToInteger Function
DecimalToFloat Function
DecimalToInteger Function
FloatToString Function
FormatNumber Function
FormatNumberWithComma Function
FormattedMoneyToNumber Function
GetNumericDecimalPortion Function
GetNumericWholePortion Function
HexBufferToBlock Function
HexBufferToByteString Function
HexBufferToString Function
HexToBuffer Function
HexToInteger Function
IntegerToAlpha Function
IntegerToCardinal Function
IntegerToOrdinal Function
IntegerToRoman Function
IntegerToBinaryCombo Function
IntegerToBinaryUnits Function
MoneyRemoveTrailingZeros Function
OctalToInteger Function
RomanToInteger Function
TextToInteger Function
5.7 Tabs and Tab Characters
5.7.1 Overview
5.7.2 Tab Functions
CollapseTabs Function
ExpandTabs Function
NativeToRealized Function
RealizedToNative Function
Tabify Function
5.8 Word Parsing
5.8.1 Overview
5.8.2 Basic Operation
5.8.3 Setting Up a Parse Operation
5.8.4 Word Parse Functions
WordParseCreate Function
WordParseGetEndX Function
WordParseGetPosition Function
WordParseGetResult Function
WordParseGetSpace Function
WordParseGetSpaceSize Function
WordParseGetStartX Function
WordParseGetWord Function
WordParseHasSpace Function
WordParseSetData Function
WordParseSetPosition Function
5.9 String Pool Functions
5.9.1 Overview
5.9.2 When to Use an SPO
5.9.3 Pool Operation
5.9.4 Functions
PoolAppend Function
PoolAppendAsPCData Function
PoolAppendAsXString Function
PoolAppendFile Function
PoolAppendFormattedString Function
PoolAppendNewLine Function
PoolCreate Function
PoolGetPool Function
PoolGetPosition Function
PoolGetReadPosition Function
PoolGetString Function
PoolOverlay Function
PoolPut Function
PoolReset Function
PoolSetNewLineMode Function
PoolSetPosition Function
PoolWriteFile Function
5.10 Data Object Functions
5.10.1 Overview
5.10.2 Object Descriptors
5.10.3 Functions
DataObjectCreate Function
DataObjectGetAllocation Function
DataObjectDeleteSection Function
DataObjectGetDescriptor Function
DataObjectGetSize Function
DataObjectInsertSection Function
DataObjectLoadFile Function
DataObjectSetDescriptor Function
DataObjectSetSize Function
DataObjectWriteFile Function
5.11 Object Meta Data
5.11.1 Overview
5.11.2 Functions
GetObjectMetaData Function
SetObjectMetaData Function
5.12 Date and Time Functions
5.12.1 Overview
5.12.2 File Times and File Systems
5.12.3 Comparing Times and Dates
5.12.4 Formatting Codes
5.12.5 Locale
5.12.6 Functions
AddDays Function
AddDuration Function
DateToUnix Function
DurationToComponents Function
DurationToDays Function
DurationToString Function
DurationToTimeComponents Function
EnumerateTimeZones Function
FormatDate Function
GetDateTimeComponents Function
GetDayOfWeek Function
GetLocalTime Function
GetLocalTimeForZone Function
GetTimeZoneBias Function
GetTimeZoneInformation Function
GetTimeZoneOverride Function
GetUTCTime Function
IsBusinessDay Function
IsDaylightSavingsTime Function
IsUSFederalHoliday Function
IsUSTradingHoliday Function
LocalToUTC Function
MS1900ToDate Function
MS1900ToString Function
MS1904ToDate Function
MS1904ToString Function
SecondsToTime Function
StringToDate Function
StringToDuration Function
StringToTimeZone Function
StringToTimeZoneBias Function
SubtractDates Function
SubtractDays Function
SubtractDuration Function
UnixToDate Function
UTCToLocal Function
5.13 Logs and Log Functions
5.13.1 Overview
5.13.2 Log Objects
5.13.3 Meta Data
5.13.4 Global Log Object
5.13.5 Log Functions
AddMessage Function
ClearGlobalLog Function
GetDefaultLog Function
GetGlobalLog Function
LogAddErrorSummary Function
LogAppendLog Function
LogAppendString Function
LogClearProperties Function
LogCreate Function
LogDisplay Function
LogExport Function
LogGetMessage Function
LogGetMessageCount Function
LogGetMessageProperties Function
LogGetMessageType Function
LogImport Function
LogIndent Function
LogOutdent Function
LogReset Function
LogSetFileType Function
LogSetMessageType Function
LogSetPosition Function
LogSetProperty Function
LogSetTarget Function
LogSetWindow Function
LogToHTML Function
LogToTable Function
LogToText Function
5.14 Message Boxes
5.14.1 Overview
5.14.2 Message Box Function Syntax/Parameters
5.14.3 Console Operation
5.14.4 Message Box Functions
5.14.5 Other Functions
AdminYesNoBox Function
MessageBeep Function
MessageBox Function
OkCancelBox Function
SetMessageBoxDetail Function
UseMessageBoxes Function
YesNoBox Function
YesNoCancelBox Function
YesNoRememberBox Function
YesNoCancelRememberBox Function
5.15 Password Boxes
5.15.1 Overview
5.15.2 Functions
PasswordBox Function
PasswordChangeBox Function
PasswordRememberBox Function
PasswordUsernameBox Function
5.16 Script Timing and Control
5.16.1 Overview
5.16.2 Processing Time
5.16.3 Functions
GetElapsedTime Function
GetLastActivityTick Function
GetTickCount Function
ResetElapsedTime Function
Sleep Function
Yield Function
5.17 Progress Display
5.17.1 Overview
5.17.2 Progress Operation
5.17.3 Progress Options
5.17.4 Progress Functions
AttachApplicationProgress Function
IsApplicationProgressOpen Function
IsProgressOpen Function
ProgressClose Function
ProgressDisableCancel Function
ProgressOpen Function
ProgressSetCaption Function
ProgressSetPhase Function
ProgressSetPhaseCount Function
ProgressSetStatus Function
ProgressUpdate Function
5.18 Hash Functions
5.18.1 Overview
5.18.2 Basic Functions
5.18.3 MD5 Functions
HashString Function
MD5CreateDigest Function
MD5NewDigestObject Function
MD5AddToDigest Function
MD5FinishDigest Function
5.19 Encryption Functions
5.19.1 Overview
5.19.2 Functions
EncryptSettingsString Function
EncryptAsAES Function
DecryptAsAES Function
EncryptAsRC4 Function
GenerateTOTP Function
5.20 Error Processing and Codes
5.20.1 Overview 
5.20.2 Integer Return Values
5.20.3 String and Array Return Values
5.20.4 Handle Return Values 
5.20.5 Formatted Error Code Structure 
5.20.6 Get Last Error Data
5.20.7 IsError Function
5.20.8 IsCancel Function
5.21 Last Error Functions
5.21.1 GetLastError Function 
5.21.2 GetLastErrorMessage Function
5.21.3 Last Log Functions
5.21.4 SetLastError Function
5.21.5 Functions
GetLastDefaultLog Function
GetLastError Function
GetLastErrorLog Function
GetLastErrorMessage Function
SetLastError Function
IsCancel Function
IsError Function
IsNotError Function
5.22 Byte and Word Functions
5.22.1 Overview 
5.22.2 Get/Put Word Functions
Get8Word Function
Get16Word Function
Get32Word Function
Get64Word Function
Get32Float Function
Get64Float Function
Put8Word Function
Put16Word Function
Put32Word Function
Put64Word Function
Put32Float Function
Put64Float Function
Get8String Function
Get16String Function
PutString Function
5.22.3 Binary Word Functions
GetLowByte Function
GetHighByte Function
GetLowWord Function
GetHighWord Function
Make32Word Function
Make64Word Function
Swap16Word Function
Swap32Word Function
Swap64Word Function
5.22.4 Binary Memory Functions
BinaryCompare Function
BinaryCompareNoCase Function
BinaryCopySegment Function
BinaryPutSegment Function
BinaryReadRecord Function
BinaryScan Function
BinaryWriteRecord Function
5.22.5 Color Functions
ApplyTintToColor Function
ApplyTintToRGB Function
ColorToRGB Function
GetRedValue Function
GetGreenValue Function
GetBlueValue Function
IsDefaultColor Function
MakeRGBColor Function
RGBToColor Function
5.23 Encoding Functions
5.23.1 Overview 
5.23.2 Base32 Encoding
5.23.3 Base64 Encoding
5.23.4 Run Length Encoding
5.23.5 Functions
DecodeString Function
EncodeString Function
RunLengthDecode Function
RunLengthEncode Function
5.24 Unicode Functions
5.24.1 Overview 
5.24.2 Functions
AnsiToUnicode Function
AnsiToUTF Function
CheckUTFCompliance Function
EntitiesToUTF Function
UnicodeToAnsi Function
UnicodeToASCII Function
UnicodeToUTF Function
UTFToAnsi Function
UTFToEntities Function
UTFToUnicode Function
5.25 Special Functions
5.25.1 Overview 
5.25.2 Functions
CommandLineToTable Function
ExitApplication Function
ForceScriptError Function
IsDesktopRunning Function
IsDialogOpen Function
GetApplicationCode Function
GetApplicationName Function
GetApplicationParameter Function
GetApplicationStartTick Function
GetApplicationStartTime Function
GetApplicationVersion Function
GetCommandLine Function
GetScriptDescription Function
GetScriptEngineVersion Function
GetScriptFilename Function
GetScriptFolder Function
GetScriptFunction Function
GetScriptLine Function
GetScriptMapLine Function
GetScriptMapFilename Function
GetScriptName Function
GetScriptParent Function
GetScriptStackLevel Function
GetScriptStartTime Function
GetScriptsExtensionFolder Function
GetScriptsFolder Function
GetScriptsUserFolder Function
GetUnwindFunction Function
SetApplicationName Function
SetApplicationParameter Function
SetApplicationVendorURI Function
SetScriptDescription Function
SetScriptName Function
SetUnwindFunction Function
GetCaretXPosition Function
GetCaretYPosition Function
GetEditObjectChangeCount Function
GetEditObjectElapsedTime Function
GetEditObjectFilename Function
GetEditObjectFileType Function
GetEditObjectName Function
GetEditObjectType Function
GetEditObjectWindow Function
GetLastXPosition Function
GetLastYPosition Function
GetSelectClue Function
GetSelectCount Function
GetSelectEndXPosition Function
GetSelectEndYPosition Function
GetSelectMode Function
GetSelectStartXPosition Function
GetSelectStartYPosition Function
SetCaretPosition Function
SetSelectArea Function
SetSelectClue Function
SetSelectMode Function
UpdateEditWindow Function

 

 

GoFiler Legato Script Reference — Generated on 03/17/2025

© 2012-2025 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. Novaworks, GoFiler™ and Legato™ are registered 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.