String methods syntax: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Automatically generated page update)
m (Automatically generated page update)
Line 53: Line 53:
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%outString</span><span class="literal"> =</span> <span class="term">string</span><span class="literal">:[[Right (String function)|Right]]</span><span class="literal">(</span> <span class="term" title="Number">length</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="C">Pad=</span> <span class="term" title="C">c</span><span class="squareb">]</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%outString</span><span class="literal"> =</span> <span class="term">string</span><span class="literal">:[[Right (String function)|Right]]</span><span class="literal">(</span> <span class="term" title="Number">length</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="C">Pad=</span> <span class="term" title="C">c</span><span class="squareb">]</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%outString</span><span class="literal"> =</span> <span class="term">string</span><span class="literal">:[[SHAdigest (String function)|SHAdigest]]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%outString</span><span class="literal"> =</span> <span class="term">string</span><span class="literal">:[[SHAdigest (String function)|SHAdigest]]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%boolean</span><span class="literal"> =</span> <span class="term">string</span><span class="literal">:[[StartsWith (String function)|StartsWith]]</span><span class="literal">(</span> <span class="term" title="String">shorterString</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%boolean</span><span class="literal"> =</span> <span class="term">string</span><span class="literal">:[[StartsWith (String function)|StartsWith]]</span><span class="literal">(</span> <span class="term" title="String">abbreviation</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%outString</span><span class="literal"> =</span> <span class="term">string</span><span class="literal">:[[StringToBase64 (String function)|StringToBase64]]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%outString</span><span class="literal"> =</span> <span class="term">string</span><span class="literal">:[[StringToBase64 (String function)|StringToBase64]]</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%days</span><span class="literal"> =</span> <span class="term">string</span><span class="literal">:[[StringToDays (String function)|StringToDays]]</span><span class="literal">(</span> <span class="term" title="String">format</span><span class="comma">,</span> <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">CentSpan=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span></p>
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">%days</span><span class="literal"> =</span> <span class="term">string</span><span class="literal">:[[StringToDays (String function)|StringToDays]]</span><span class="literal">(</span> <span class="term" title="String">format</span><span class="comma">,</span> <span class="squareb">[</span><span class="squareb">[</span><span class="literal" title="Number">CentSpan=</span><span class="squareb">]</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="literal">)</span></p>

Revision as of 17:20, 29 June 2011

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)

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

%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)

%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

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