String methods syntax

The syntax for each of the String class methods is shown below.

Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of String methods.

%string= string:AsciiToEbcdic[( [CharacterEncode= characterEncode])]

%string= string:Base64ToString

%number= string:BinaryToFloat

%number= string:BinaryToInteger[( [Signed= signed])]

%result= string:BitAndString( andBits, [Pad= pad])

%result= string:BitOffString( offBits, [Pad= pad])

%result= string:BitOnString( onBits, [Pad= pad])

%result= string:BitOrString( orBits, [Pad= pad])

%result= string:BitXorString( xorBits, [Pad= pad])

%string= string:Center( length, [Pad= pad], [OffsetLeft= offsetLeft])

%string= string:Centre( length, [Pad= pad], [OffsetLeft= offsetLeft])

%string= string:Char( position)

%string= string:Deflate[( [FixedCode= fixedCode], [LazyMatch= lazyMatch], - [MaxChain= maxChain])]

%string= string:EbcdicToAscii[( [CharacterDecode= characterDecode])]

%unicode= string:EbcdicToUnicode[( [CharacterDecode= characterDecode], - [Untranslatable= untranslatable])]

%number= string:GetCharacterPairValue( characterPairValueFunction)

%number= string:GetCharacterValue( characterValueFunction)

%string= string:Gunzip

%number= string:GunzipDatetimeNS

%string= string:GunzipFilename

%string= string:Gzip[( [FixedCode= fixedCode], [LazyMatch= lazyMatch], - [MaxChain= maxChain], [Filename= filename], - [LastModified= lastModified])]

%number= string:HexToInteger[( [Signed= signed])]

%string= string:HexToString

%string= string:Inflate

%string= string:Insert( string, position)

%boolean= string:IsOneOf( list)

%string= string:Left( length, [Pad= pad])

%length= string:Length

%string= string:MD5digest

%string= string:MarksStoreCodeDecrement

%string= string:MarksStoreCodeIncrement

%number= string:MarksStoreCodeToNumber

%object= string:ParseLines[( [string], [StripTrailingNull= stripTrailingNull])]

%position= string:PositionIn( string, [Start= start])

%position= string:PositionOf( string, [Start= start])

%string= string:RC4decrypt( string)

%string= string:RC4encrypt( string)

%number= string:RegexMatch( string, [Options= options], - [CaptureList= captureList])

%string= string:RegexReplace( string, string, [Options= options])

%object= string:RegexSplit( string, [Options= options], [Add= add])

%string= string:Remove( string, [Count= count])

%string= string:Replace( string, string, [Count= count])

%string= string:Reverse

%string= string:Right( length, [Pad= pad])

%string= string:SHAdigest

%string= string:StringToBase64

%days= string:StringToDays( string, [centSpan])

%string= string:StringToHex

%milliseconds= string:StringToMilliseconds( string, [centSpan])

%seconds= string:StringToSeconds( string, [centSpan])

%string= string:Substring( position, [length], [Pad= pad])

%string= string:ToLower

%string= string:ToString

%string= string:ToUpper

%string= string:Translate( characterMap)

%unicode= string:U

%string= string:Unspace[( [Spaces= spaces], [Leading= leading], - [Trailing= trailing], [Compress= compress])]

%unicode= string:Utf16ToUnicode[( [AllowUntranslatable= allowUntranslatable], - [Bom= bom])]

%unicode= string:Utf8ToUnicode[( [AllowUntranslatable= allowUntranslatable])]

%string= string:X

%string= string:Zip[( [FixedCode= fixedCode], [LazyMatch= lazyMatch], - [MaxChain= maxChain], [Filename= filename], - [LastModified= lastModified])]

%object= string:stringTokenizer[( [TokenChars= tokenChars], [Spaces= spaces], - [Quotes= quotes], [Separators= separators])]