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.

%outString = string:AsciiToEbcdic[( [CharacterEncode= boolean])]

%outString = string:Base64ToString

%number = string:BinaryToFloat

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

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

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

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

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

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

%outString = string:Center( length, [Pad= c], [OffsetLeft= boolean])

%outString = string:Centre( length, [Pad= c], [OffsetLeft= boolean])

%outString = string:Char( position)

%unicode = string:CharacterToUnicode( characterToUnicodeMap)

%outString = string:Deflate[( [FixedCode= boolean], [LazyMatch= boolean], - [MaxChain= number])]

%doc = string:DerToXmlDoc

%outString = string:EbcdicToAscii[( [CharacterDecode= boolean])]

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

%unicode = string:FormUrlDecodeUnicode[( [AllowUntranslatable= boolean])]

%outString = string:Gunzip

%number = string:GunzipDatetimeNS

%outString = string:GunzipFilename

%outString = string:Gzip[( [FixedCode= boolean], [LazyMatch= boolean], - [MaxChain= number], [Filename= string], - [LastModified= number])]

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

%outString = string:HexToString

%outString = string:Inflate

%outString = string:Insert( insertedString, position)

%boolean = string:IsOneOf( list)

%boolean = string:IsStartOf( longerString, MinLength= number)

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

%length = string:Length

%outString = string:MD5digest

%outString = string:MarksStoreCodeDecrement

%outString = string:MarksStoreCodeIncrement

%number = string:MarksStoreCodeToNumber

%sl = string:ParseLines[( [delims], [StripTrailingNull= boolean])]

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

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

%outString = string:RC4decrypt( key)

%outString = string:RC4encrypt( key)

%doc = string:RSAPrivateKeyToXmlDoc

%number = string:RegexMatch( regex, [Options= string], - [CaptureList= stringlist])

%outString = string:RegexReplace( regex, replacement, [Options= string])

%sl = string:RegexSplit( regex, [Options= string], - [Add= regexSplitOutputOptions])

%outString = string:Remove( substring, [Count= number])

%outString = string:Replace( substring, replacement, [Count= number])

%outString = string:Reverse

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

%outString = string:SHAdigest

%boolean = string:StartsWith( abbreviation)

%outString = string:StringToBase64

%days = string:StringToDays( format, [[CentSpan=] number])

%outString = string:StringToHex

%milliseconds = string:StringToMilliseconds( format, [[CentSpan=] number])

%seconds = string:StringToSeconds( format, [[CentSpan=] number])

%stringTokenizer = string:StringTokenizer[( [TokenChars= string], - [Spaces= string], - [Quotes= string], - [Separators= string])]

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

%outString = string:TimeStringConvert( inputFormat, outputFormat, - [[CentSpan=] number])

%outString = string:ToLower

%outString = string:ToString

%outString = string:ToUpper

%outString = string:Translate( characterMap)

%outString = string:TrimLeft( amount)

%outString = string:TrimRight( amount)

%unicode = string:U

%outString = string:Unspace[( [Spaces= string], [Leading= boolean], - [Trailing= boolean], [Compress= boolean])]

%unicode = string:UrlDecodeUnicode[( [AllowUntranslatable= boolean])]

%unicode = string:Utf16ToUnicode[( [AllowUntranslatable= boolean], - [Bom= utf16BOM])]

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

%selectedWord = string:Word( number, [Spaces= string])

%number = string:WordCount[( [Spaces= string])]

%number = string:WordNumberIn( haystack, [Spaces= string])

%number = string:WordNumberOf( needle, [Spaces= string])

%outString = string:Words( start, [count], [Spaces= string])

%outString = string:X

%doc = string:X509CertificateToXmlDoc

%doc = string:X509CrlToXmlDoc

%outString = string:Zip[( [FixedCode= boolean], [LazyMatch= boolean], - [MaxChain= number], [Filename= string], - [LastModified= number])]