Child pages
  • Utils

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{hidden} DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden} {sub-section:description|text=}{sub-section}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#dateFormat]\(date, format) Format a date object to a text representation.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getUnicodeCharacter]\(unicodeCharacterNumber) Returns a string containing the character for the unicode number.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#hasRecords]\(foundset) Returns true if the (related)foundset exists and has records.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#hasRecords]\(record, relationString) Returns true if the (related)foundset exists and has records.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#isMondayFirstDayOfWeek]\() Returns true when Monday is the first day of the week for your current locale setting.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#numberFormat]\(number, digits) Format a number to have a defined fraction.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#numberFormat]\(number, format) Format a number to specification.{td}{tr}{tbody}{tbody}{tr}{td}[Date]{td}{td}[#parseDate]\(date, format) Parse a string to a date object.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringEscapeMarkup]\(textString) Returns the escaped markup text (HTML/XML).{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringEscapeMarkup]\(textString, escapeSpaces) Returns the escaped markup text (HTML/XML).{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringEscapeMarkup]\(textString, escapeSpaces, convertToHtmlUnicodeEscapes) Returns the escaped markup text (HTML/XML).{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringFormat]\(text_to_format, parameters) Formats a string according to format specifiers and arguments.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringIndexReplace]\(text, i_start, i_size, replacement_text) Replaces a portion of a string with replacement text from a specified index.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringInitCap]\(text) Returns all words starting with capital chars.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringLeft]\(text, i_size) Returns a string with the requested number of characters, starting from the left.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringLeftWords]\(text, numberof_words) Returns the number of words, starting from the left.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringMD5HashBase16]\(textString) Returns the md5 hash (encoded as base16) for specified text.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringMD5HashBase64]\(textString) Returns the md5 hash (encoded as base64) for specified text.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringMiddle]\(text, i_start, i_size) Returns a substring from the original string.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringMiddleWords]\(text, i_start, numberof_words) Returns a substring from the original string.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringPBKDF2Hash]\(textString) Returns the PBKDF2 hash for specified text.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringPBKDF2Hash]\(textString, iterations) Returns the PBKDF2 hash for specified text.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#stringPatternCount]\(text, toSearchFor) Returns the number of times searchString appears in textString.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#stringPosition]\(textString, toSearchFor, i_start, i_occurrence) Returns the position of the string to search for, from a certain start position and occurrence.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringReplace]\(text, search_text, replacement_text) Replaces a portion of a string with replacement text.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringReplaceTags]\(text, scriptable) Returns the text with %%tags%% replaced, based on provided record or foundset or form.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringRight]\(text, i_size) Returns a string with the requested number of characters, starting from the right.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringRightWords]\(text, numberof_words) Returns the number of words, starting from the right.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#stringToNumber]\(textString) Filters characters out of from a string and leaves digits, returns the number.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#stringToNumber]\(textString, decimalSeparator) Filters characters out of from a string and leaves digits, returns the number.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#stringTrim]\(textString) Returns the string without leading or trailing spaces.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#stringWordCount]\(text) Returns the number of words in the text string.{td}{tr}{tbody}{tbody}{tr}{td}[Date]{td}{td}[#timestampToDate]\(date) Returns a datestamp from the timestamp (sets hours,minutes,seconds and milliseconds to 0).{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#validatePBKDF2Hash]\(password, hash) Validates the given password against the given hash.{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=dateFormat-Date_String|class=node}{tr:id=name}{td}h6.dateFormat{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}dateFormat{span}{span:id=iets|style=float: left;}\(date, format){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:dateFormat-Date_String_des|trigger=button|text=}{sub-section}{sub-section:dateFormat-Date_String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:dateFormat-Date_String_snc|trigger=button|text=}{sub-section}{sub-section:dateFormat-Date_String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:dateFormat-Date_String_prs|trigger=button|text=}{sub-section}{sub-section:dateFormat-Date_String_prs|trigger=none|class=sIndent}\{[Date]} date -- the date \{[String]} format -- the format to output {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:dateFormat-Date_String_ret|trigger=button|text=}{sub-section}{sub-section:dateFormat-Date_String_ret|trigger=none|class=sIndent}[String] -- the date as text{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:dateFormat-Date_String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:dateFormat-Date_String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:dateFormat-Date_String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:dateFormat-Date_String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:dateFormat-Date_String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:dateFormat-Date_String_sam|trigger=none}{code:language=javascript} var formattedDateString = utils.dateFormat(dateobject,'EEE, d MMM yyyy HH:mm:ss'); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getUnicodeCharacter|class=node}{tr:id=name}{td}h6.getUnicodeCharacter{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}getUnicodeCharacter{span}{span:id=iets|style=float: left;}\(unicodeCharacterNumber){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:getUnicodeCharacter_des|trigger=button|text=}{sub-section}{sub-section:getUnicodeCharacter_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:getUnicodeCharacter_snc|trigger=button|text=}{sub-section}{sub-section:getUnicodeCharacter_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:getUnicodeCharacter_prs|trigger=button|text=}{sub-section}{sub-section:getUnicodeCharacter_prs|trigger=none|class=sIndent}\{[Number]} unicodeCharacterNumber -- the number indicating the unicode character {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:getUnicodeCharacter_ret|trigger=button|text=}{sub-section}{sub-section:getUnicodeCharacter_ret|trigger=none|class=sIndent}[String] -- a string containing the unicode character{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:getUnicodeCharacter_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getUnicodeCharacter_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:getUnicodeCharacter_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getUnicodeCharacter_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:getUnicodeCharacter_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:getUnicodeCharacter_sam|trigger=none}{code:language=javascript} //returns a big dot var dot = utils.getUnicodeCharacter(9679); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=hasRecords-JSFoundSet|class=node}{tr:id=name}{td}h6.hasRecords{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}hasRecords{span}{span:id=iets|style=float: left;}\(foundset){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:hasRecords-JSFoundSet_des|trigger=button|text=}{sub-section}{sub-section:hasRecords-JSFoundSet_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:hasRecords-JSFoundSet_snc|trigger=button|text=}{sub-section}{sub-section:hasRecords-JSFoundSet_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:hasRecords-JSFoundSet_prs|trigger=button|text=}{sub-section}{sub-section:hasRecords-JSFoundSet_prs|trigger=none|class=sIndent}\{[JSFoundSet]} foundset -- the foundset to be tested {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:hasRecords-JSFoundSet_ret|trigger=button|text=}{sub-section}{sub-section:hasRecords-JSFoundSet_ret|trigger=none|class=sIndent}[Boolean] -- true if exists{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:hasRecords-JSFoundSet_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:hasRecords-JSFoundSet_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:hasRecords-JSFoundSet_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:hasRecords-JSFoundSet_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:hasRecords-JSFoundSet_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:hasRecords-JSFoundSet_sam|trigger=none}{code:language=javascript} //test the orders_to_orderitems foundset if (elements.customer_id.hasRecords(orders_to_orderitems)) { //do work on relatedFoundSet } //test the orders_to_orderitems.orderitems_to_products foundset to be reached from the current record //if (elements.customer_id.hasRecords(foundset.getSelectedRecord(),'orders_to_orderitems.orderitems_to_products')) //{ // //do work on deeper relatedFoundSet //} {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=hasRecords-JSRecord_String|class=node}{tr:id=name}{td}h6.hasRecords{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}hasRecords{span}{span:id=iets|style=float: left;}\(record, relationString){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:hasRecords-JSRecord_String_des|trigger=button|text=}{sub-section}{sub-section:hasRecords-JSRecord_String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:hasRecords-JSRecord_String_snc|trigger=button|text=}{sub-section}{sub-section:hasRecords-JSRecord_String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:hasRecords-JSRecord_String_prs|trigger=button|text=}{sub-section}{sub-section:hasRecords-JSRecord_String_prs|trigger=none|class=sIndent}\{[JSRecord]} record -- A JSRecord to test. \{[String]} relationString -- The relation name. {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:hasRecords-JSRecord_String_ret|trigger=button|text=}{sub-section}{sub-section:hasRecords-JSRecord_String_ret|trigger=none|class=sIndent}[Boolean] -- true if the foundset/relation has records.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:hasRecords-JSRecord_String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:hasRecords-JSRecord_String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:hasRecords-JSRecord_String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:hasRecords-JSRecord_String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:hasRecords-JSRecord_String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:hasRecords-JSRecord_String_sam|trigger=none}{code:language=javascript} //test the orders_to_orderitems foundset if (elements.customer_id.hasRecords(orders_to_orderitems)) { //do work on relatedFoundSet } //test the orders_to_orderitems.orderitems_to_products foundset to be reached from the current record //if (elements.customer_id.hasRecords(foundset.getSelectedRecord(),'orders_to_orderitems.orderitems_to_products')) //{ // //do work on deeper relatedFoundSet //} {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isMondayFirstDayOfWeek|class=node}{tr:id=name}{td}h6.isMondayFirstDayOfWeek{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}isMondayFirstDayOfWeek{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:isMondayFirstDayOfWeek_des|trigger=button|text=}{sub-section}{sub-section:isMondayFirstDayOfWeek_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:isMondayFirstDayOfWeek_snc|trigger=button|text=}{sub-section}{sub-section:isMondayFirstDayOfWeek_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:isMondayFirstDayOfWeek_prs|trigger=button|text=}{sub-section}{sub-section:isMondayFirstDayOfWeek_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:isMondayFirstDayOfWeek_ret|trigger=button|text=}{sub-section}{sub-section:isMondayFirstDayOfWeek_ret|trigger=none|class=sIndent}[Boolean] -- true if Monday is first day of the week in current locale{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:isMondayFirstDayOfWeek_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isMondayFirstDayOfWeek_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:isMondayFirstDayOfWeek_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isMondayFirstDayOfWeek_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:isMondayFirstDayOfWeek_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:isMondayFirstDayOfWeek_sam|trigger=none}{code:language=javascript} if(utils.isMondayFirstDayOfWeek()) { //a date calculation } {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=numberFormat-Number_Number|class=node}{tr:id=name}{td}h6.numberFormat{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}numberFormat{span}{span:id=iets|style=float: left;}\(number, digits){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:numberFormat-Number_Number_des|trigger=button|text=}{sub-section}{sub-section:numberFormat-Number_Number_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:numberFormat-Number_Number_snc|trigger=button|text=}{sub-section}{sub-section:numberFormat-Number_Number_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:numberFormat-Number_Number_prs|trigger=button|text=}{sub-section}{sub-section:numberFormat-Number_Number_prs|trigger=none|class=sIndent}\{[Number]} number -- the number to format \{[Number]} digits -- nr of digits {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:numberFormat-Number_Number_ret|trigger=button|text=}{sub-section}{sub-section:numberFormat-Number_Number_ret|trigger=none|class=sIndent}[String] -- the resulting number in text{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:numberFormat-Number_Number_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:numberFormat-Number_Number_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:numberFormat-Number_Number_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:numberFormat-Number_Number_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:numberFormat-Number_Number_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:numberFormat-Number_Number_sam|trigger=none}{code:language=javascript} var textalNumber = utils.numberFormat(16.749, 2); //returns 16.75 {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=numberFormat-Number_String|class=node}{tr:id=name}{td}h6.numberFormat{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}numberFormat{span}{span:id=iets|style=float: left;}\(number, format){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:numberFormat-Number_String_des|trigger=button|text=}{sub-section}{sub-section:numberFormat-Number_String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:numberFormat-Number_String_snc|trigger=button|text=}{sub-section}{sub-section:numberFormat-Number_String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:numberFormat-Number_String_prs|trigger=button|text=}{sub-section}{sub-section:numberFormat-Number_String_prs|trigger=none|class=sIndent}\{[Number]} number -- the number to format \{[String]} format -- the format {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:numberFormat-Number_String_ret|trigger=button|text=}{sub-section}{sub-section:numberFormat-Number_String_ret|trigger=none|class=sIndent}[String] -- the resulting number in text{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:numberFormat-Number_String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:numberFormat-Number_String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:numberFormat-Number_String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:numberFormat-Number_String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:numberFormat-Number_String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:numberFormat-Number_String_sam|trigger=none}{code:language=javascript} var textalNumber2 = utils.numberFormat(100006.749, '#,###.00'); //returns 100,006.75 {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=parseDate|class=node}{tr:id=name}{td}h6.parseDate{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Date]{span}{span:id=iets|style=float: left; font-weight: bold;}parseDate{span}{span:id=iets|style=float: left;}\(date, format){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:parseDate_des|trigger=button|text=}{sub-section}{sub-section:parseDate_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:parseDate_snc|trigger=button|text=}{sub-section}{sub-section:parseDate_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:parseDate_prs|trigger=button|text=}{sub-section}{sub-section:parseDate_prs|trigger=none|class=sIndent}\{[String]} date -- the date as text \{[String]} format -- the format to parse the to date {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:parseDate_ret|trigger=button|text=}{sub-section}{sub-section:parseDate_ret|trigger=none|class=sIndent}[Date] -- the date as date object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:parseDate_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:parseDate_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:parseDate_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:parseDate_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:parseDate_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:parseDate_sam|trigger=none}{code:language=javascript} var parsedDate = utils.parseDate(datestring,'EEE, d MMM yyyy HH:mm:ss'); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringEscapeMarkup-String|class=node}{tr:id=name}{td}h6.stringEscapeMarkup{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringEscapeMarkup{span}{span:id=iets|style=float: left;}\(textString){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringEscapeMarkup-String_des|trigger=button|text=}{sub-section}{sub-section:stringEscapeMarkup-String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringEscapeMarkup-String_snc|trigger=button|text=}{sub-section}{sub-section:stringEscapeMarkup-String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringEscapeMarkup-String_prs|trigger=button|text=}{sub-section}{sub-section:stringEscapeMarkup-String_prs|trigger=none|class=sIndent}\{[String]} textString -- the text to process {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringEscapeMarkup-String_ret|trigger=button|text=}{sub-section}{sub-section:stringEscapeMarkup-String_ret|trigger=none|class=sIndent}[String] -- the escaped text{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringEscapeMarkup-String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringEscapeMarkup-String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringEscapeMarkup-String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringEscapeMarkup-String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringEscapeMarkup-String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringEscapeMarkup-String_sam|trigger=none}{code:language=javascript} var escapedText = utils.stringEscapeMarkup('<html><body>escape me</body></html>') {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringEscapeMarkup-String_Boolean|class=node}{tr:id=name}{td}h6.stringEscapeMarkup{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringEscapeMarkup{span}{span:id=iets|style=float: left;}\(textString, escapeSpaces){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringEscapeMarkup-String_Boolean_des|trigger=button|text=}{sub-section}{sub-section:stringEscapeMarkup-String_Boolean_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringEscapeMarkup-String_Boolean_snc|trigger=button|text=}{sub-section}{sub-section:stringEscapeMarkup-String_Boolean_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringEscapeMarkup-String_Boolean_prs|trigger=button|text=}{sub-section}{sub-section:stringEscapeMarkup-String_Boolean_prs|trigger=none|class=sIndent}\{[String]} textString -- the text to process \{[Boolean]} escapeSpaces -- indicating to escape spaces {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringEscapeMarkup-String_Boolean_ret|trigger=button|text=}{sub-section}{sub-section:stringEscapeMarkup-String_Boolean_ret|trigger=none|class=sIndent}[String] -- the escaped text{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringEscapeMarkup-String_Boolean_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringEscapeMarkup-String_Boolean_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringEscapeMarkup-String_Boolean_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringEscapeMarkup-String_Boolean_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringEscapeMarkup-String_Boolean_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringEscapeMarkup-String_Boolean_sam|trigger=none}{code:language=javascript} var escapedText = utils.stringEscapeMarkup('<html><body>escape me</body></html>') {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringEscapeMarkup-String_Boolean_Boolean|class=node}{tr:id=name}{td}h6.stringEscapeMarkup{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringEscapeMarkup{span}{span:id=iets|style=float: left;}\(textString, escapeSpaces, convertToHtmlUnicodeEscapes){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringEscapeMarkup-String_Boolean_Boolean_des|trigger=button|text=}{sub-section}{sub-section:stringEscapeMarkup-String_Boolean_Boolean_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringEscapeMarkup-String_Boolean_Boolean_snc|trigger=button|text=}{sub-section}{sub-section:stringEscapeMarkup-String_Boolean_Boolean_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringEscapeMarkup-String_Boolean_Boolean_prs|trigger=button|text=}{sub-section}{sub-section:stringEscapeMarkup-String_Boolean_Boolean_prs|trigger=none|class=sIndent}\{[String]} textString -- the text to process \{[Boolean]} escapeSpaces -- indicating to escape spaces \{[Boolean]} convertToHtmlUnicodeEscapes -- indicating to use unicode escapes {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringEscapeMarkup-String_Boolean_Boolean_ret|trigger=button|text=}{sub-section}{sub-section:stringEscapeMarkup-String_Boolean_Boolean_ret|trigger=none|class=sIndent}[String] -- the escaped text{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringEscapeMarkup-String_Boolean_Boolean_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringEscapeMarkup-String_Boolean_Boolean_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringEscapeMarkup-String_Boolean_Boolean_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringEscapeMarkup-String_Boolean_Boolean_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringEscapeMarkup-String_Boolean_Boolean_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringEscapeMarkup-String_Boolean_Boolean_sam|trigger=none}{code:language=javascript} var escapedText = utils.stringEscapeMarkup('<html><body>escape me</body></html>') {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringFormat|class=node}{tr:id=name}{td}h6.stringFormat{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringFormat{span}{span:id=iets|style=float: left;}\(text_to_format, parameters){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringFormat_des|trigger=button|text=}{sub-section}{sub-section:stringFormat_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringFormat_snc|trigger=button|text=}{sub-section}{sub-section:stringFormat_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringFormat_prs|trigger=button|text=}{sub-section}{sub-section:stringFormat_prs|trigger=none|class=sIndent}\{[String]} text_to_format -- the text to format \{[Object]\[]} parameters -- the array with parameters {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringFormat_ret|trigger=button|text=}{sub-section}{sub-section:stringFormat_ret|trigger=none|class=sIndent}[String] -- the formatted text{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringFormat_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringFormat_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringFormat_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringFormat_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringFormat_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringFormat_sam|trigger=none}{code:language=javascript} // the format specifier has the syntax: %[argument_index$][flags][width][.precision]conversion // argument index is 1$, 2$ ... // flags is a set of characters that modify the output format // typical values: '+'(The result will always include a sign), ','(The result will include locale-specific grouping separators) // width is a non-negative decimal integer indicating the minimum number of characters to be written to the output // precision is a non-negative decimal integer usually used to restrict the number of characters // conversion is a character indicating how the argument should be formatted // typical conversion values: b(boolean), s(string), c(character), d(decimal integer), f(floating number), t(prefix for date and time) // Date/Time Conversions (used after 't' prefix): // 'H' Hour of the day for the 24-hour clock, formatted as two digits with a leading zero as necessary i.e. 00 - 23. // 'I' Hour for the 12-hour clock, formatted as two digits with a leading zero as necessary, i.e. 01 - 12. // 'k' Hour of the day for the 24-hour clock, i.e. 0 - 23. // 'l' Hour for the 12-hour clock, i.e. 1 - 12. // 'M' Minute within the hour formatted as two digits with a leading zero as necessary, i.e. 00 - 59. // 'S' Seconds within the minute, formatted as two digits with a leading zero as necessary, i.e. 00 - 60 ("60" is a special value required to support leap seconds). // 'L' Millisecond within the second formatted as three digits with leading zeros as necessary, i.e. 000 - 999. // 'p' Locale-specific morning or afternoon marker in lower case, e.g."am" or "pm". Use of the conversion prefix 'T' forces this output to upper case. // 'z' RFC 822 style numeric time zone offset from GMT, e.g. -0800. // 'Z' A string representing the abbreviation for the time zone. // 'B' Locale-specific full month name, e.g. "January", "February". // 'b' Locale-specific abbreviated month name, e.g. "Jan", "Feb". // 'h' Same as 'b'. // 'A' Locale-specific full name of the day of the week, e.g. "Sunday", "Monday" // 'a' Locale-specific short name of the day of the week, e.g. "Sun", "Mon" // 'C' Four-digit year divided by 100, formatted as two digits with leading zero as necessary, i.e. 00 - 99 // 'Y' Year, formatted as at least four digits with leading zeros as necessary, e.g. 0092 equals 92 CE for the Gregorian calendar. // 'y' Last two digits of the year, formatted with leading zeros as necessary, i.e. 00 - 99. // 'j' Day of year, formatted as three digits with leading zeros as necessary, e.g. 001 - 366 for the Gregorian calendar. // 'm' Month, formatted as two digits with leading zeros as necessary, i.e. 01 - 13. // 'd' Day of month, formatted as two digits with leading zeros as necessary, i.e. 01 - 31 // 'e' Day of month, formatted as two digits, i.e. 1 - 31. // common compositions for date/time conversion // 'R' Time formatted for the 24-hour clock as "%tH:%tM" // 'T' Time formatted for the 24-hour clock as "%tH:%tM:%tS". // 'r' Time formatted for the 12-hour clock as "%tI:%tM:%tS %Tp". The location of the morning or afternoon marker ('%Tp') may be locale-dependent. // 'D' Date formatted as "%tm/%td/%ty". // 'F' ISO 8601 complete date formatted as "%tY-%tm-%td". // 'c' Date and time formatted as "%ta %tb %td %tT %tZ %tY", e.g. "Sun Jul 20 16:17:00 EDT 1969". utils.stringFormat('%s Birthday: %2$tm %2$te,%2$tY',new Array('My',new Date(2009,0,1))) // returns My Birthday: 01 1,2009 utils.stringFormat('The time is: %1$tH:%1$tM:%1$tS',new Array(new Date(2009,0,1,12,0,0))) // returns The time is: 12:00:00 utils.stringFormat('My %s: %2$.0f, my float: %2$.2f',new Array('integer',10)) // returns My integer: 10, my float: 10.00 utils.stringFormat('Today is: %1$tc',new Array(new Date())) // returns current date/time as: Today is: Fri Feb 20 14:15:54 EET 2009 utils.stringFormat('Today is: %tF',new Array(new Date())) // returns current date as: Today is: 2009-02-20 {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringIndexReplace-String_Number_Number_String|class=node}{tr:id=name}{td}h6.stringIndexReplace{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringIndexReplace{span}{span:id=iets|style=float: left;}\(text, i_start, i_size, replacement_text){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringIndexReplace-String_Number_Number_String_des|trigger=button|text=}{sub-section}{sub-section:stringIndexReplace-String_Number_Number_String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringIndexReplace-String_Number_Number_String_snc|trigger=button|text=}{sub-section}{sub-section:stringIndexReplace-String_Number_Number_String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringIndexReplace-String_Number_Number_String_prs|trigger=button|text=}{sub-section}{sub-section:stringIndexReplace-String_Number_Number_String_prs|trigger=none|class=sIndent}\{[String]} text -- the text to process \{[Number]} i_start -- the start index to work from \{[Number]} i_size -- the size of the text to replace \{[String]} replacement_text -- the replacement text {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringIndexReplace-String_Number_Number_String_ret|trigger=button|text=}{sub-section}{sub-section:stringIndexReplace-String_Number_Number_String_ret|trigger=none|class=sIndent}[String] -- the changed text string{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringIndexReplace-String_Number_Number_String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringIndexReplace-String_Number_Number_String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringIndexReplace-String_Number_Number_String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringIndexReplace-String_Number_Number_String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringIndexReplace-String_Number_Number_String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringIndexReplace-String_Number_Number_String_sam|trigger=none}{code:language=javascript} //returns 'this was a test' var retval = utils.stringIndexReplace('this is a test',6,2,'was'); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringInitCap|class=node}{tr:id=name}{td}h6.stringInitCap{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringInitCap{span}{span:id=iets|style=float: left;}\(text){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringInitCap_des|trigger=button|text=}{sub-section}{sub-section:stringInitCap_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringInitCap_snc|trigger=button|text=}{sub-section}{sub-section:stringInitCap_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringInitCap_prs|trigger=button|text=}{sub-section}{sub-section:stringInitCap_prs|trigger=none|class=sIndent}\{[String]} text -- the text to process {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringInitCap_ret|trigger=button|text=}{sub-section}{sub-section:stringInitCap_ret|trigger=none|class=sIndent}[String] -- the changed text{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringInitCap_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringInitCap_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringInitCap_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringInitCap_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringInitCap_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringInitCap_sam|trigger=none}{code:language=javascript} //returns 'This Is A Test' var retval = utils.stringInitCap('This is A test'); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringLeft|class=node}{tr:id=name}{td}h6.stringLeft{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringLeft{span}{span:id=iets|style=float: left;}\(text, i_size){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringLeft_des|trigger=button|text=}{sub-section}{sub-section:stringLeft_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringLeft_snc|trigger=button|text=}{sub-section}{sub-section:stringLeft_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringLeft_prs|trigger=button|text=}{sub-section}{sub-section:stringLeft_prs|trigger=none|class=sIndent}\{[String]} text -- the text to process \{[Number]} i_size -- the size of the text to return {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringLeft_ret|trigger=button|text=}{sub-section}{sub-section:stringLeft_ret|trigger=none|class=sIndent}[String] -- the result text string{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringLeft_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringLeft_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringLeft_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringLeft_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringLeft_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringLeft_sam|trigger=none}{code:language=javascript} //returns 'this i' var retval = utils.stringLeft('this is a test',6); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringLeftWords|class=node}{tr:id=name}{td}h6.stringLeftWords{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringLeftWords{span}{span:id=iets|style=float: left;}\(text, numberof_words){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringLeftWords_des|trigger=button|text=}{sub-section}{sub-section:stringLeftWords_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringLeftWords_snc|trigger=button|text=}{sub-section}{sub-section:stringLeftWords_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringLeftWords_prs|trigger=button|text=}{sub-section}{sub-section:stringLeftWords_prs|trigger=none|class=sIndent}\{[String]} text -- to process \{[Number]} numberof_words -- to return {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringLeftWords_ret|trigger=button|text=}{sub-section}{sub-section:stringLeftWords_ret|trigger=none|class=sIndent}[String] -- the string with number of words form the left{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringLeftWords_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringLeftWords_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringLeftWords_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringLeftWords_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringLeftWords_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringLeftWords_sam|trigger=none}{code:language=javascript} //returns 'this is a' var retval = utils.stringLeftWords('this is a test',3); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringMD5HashBase16|class=node}{tr:id=name}{td}h6.stringMD5HashBase16{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringMD5HashBase16{span}{span:id=iets|style=float: left;}\(textString){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringMD5HashBase16_des|trigger=button|text=}{sub-section}{sub-section:stringMD5HashBase16_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringMD5HashBase16_snc|trigger=button|text=}{sub-section}{sub-section:stringMD5HashBase16_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringMD5HashBase16_prs|trigger=button|text=}{sub-section}{sub-section:stringMD5HashBase16_prs|trigger=none|class=sIndent}\{[String]} textString -- the text to process {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringMD5HashBase16_ret|trigger=button|text=}{sub-section}{sub-section:stringMD5HashBase16_ret|trigger=none|class=sIndent}[String] -- the resulting hashString{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringMD5HashBase16_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringMD5HashBase16_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringMD5HashBase16_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringMD5HashBase16_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringMD5HashBase16_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringMD5HashBase16_sam|trigger=none}{code:language=javascript} var hashed_password = utils.stringMD5HashBase16(user_password) {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringMD5HashBase64|class=node}{tr:id=name}{td}h6.stringMD5HashBase64{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringMD5HashBase64{span}{span:id=iets|style=float: left;}\(textString){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringMD5HashBase64_des|trigger=button|text=}{sub-section}{sub-section:stringMD5HashBase64_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringMD5HashBase64_snc|trigger=button|text=}{sub-section}{sub-section:stringMD5HashBase64_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringMD5HashBase64_prs|trigger=button|text=}{sub-section}{sub-section:stringMD5HashBase64_prs|trigger=none|class=sIndent}\{[String]} textString -- the text to process {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringMD5HashBase64_ret|trigger=button|text=}{sub-section}{sub-section:stringMD5HashBase64_ret|trigger=none|class=sIndent}[String] -- the resulting hashString{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringMD5HashBase64_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringMD5HashBase64_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringMD5HashBase64_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringMD5HashBase64_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringMD5HashBase64_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringMD5HashBase64_sam|trigger=none}{code:language=javascript} var hashed_password = utils.stringMD5HashBase64(user_password) {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringMiddle|class=node}{tr:id=name}{td}h6.stringMiddle{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringMiddle{span}{span:id=iets|style=float: left;}\(text, i_start, i_size){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringMiddle_des|trigger=button|text=}{sub-section}{sub-section:stringMiddle_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringMiddle_snc|trigger=button|text=}{sub-section}{sub-section:stringMiddle_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringMiddle_prs|trigger=button|text=}{sub-section}{sub-section:stringMiddle_prs|trigger=none|class=sIndent}\{[String]} text -- the text to process \{[Number]} i_start -- the start index to work from \{[Number]} i_size -- the size of the text to return {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringMiddle_ret|trigger=button|text=}{sub-section}{sub-section:stringMiddle_ret|trigger=none|class=sIndent}[String] -- the result text string{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringMiddle_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringMiddle_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringMiddle_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringMiddle_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringMiddle_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringMiddle_sam|trigger=none}{code:language=javascript} //returns 'his' var retval = utils.stringMiddle('this is a test',2,3); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringMiddleWords|class=node}{tr:id=name}{td}h6.stringMiddleWords{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringMiddleWords{span}{span:id=iets|style=float: left;}\(text, i_start, numberof_words){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringMiddleWords_des|trigger=button|text=}{sub-section}{sub-section:stringMiddleWords_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringMiddleWords_snc|trigger=button|text=}{sub-section}{sub-section:stringMiddleWords_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringMiddleWords_prs|trigger=button|text=}{sub-section}{sub-section:stringMiddleWords_prs|trigger=none|class=sIndent}\{[String]} text -- to process \{[Number]} i_start -- start word index \{[Number]} numberof_words -- the word count to return {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringMiddleWords_ret|trigger=button|text=}{sub-section}{sub-section:stringMiddleWords_ret|trigger=none|class=sIndent}[String] -- the string with number of words form the left and{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringMiddleWords_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringMiddleWords_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringMiddleWords_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringMiddleWords_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringMiddleWords_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringMiddleWords_sam|trigger=none}{code:language=javascript} //returns 'is a' var retval = utils.stringMiddleWords('this is a test',2,2); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringPBKDF2Hash-String|class=node}{tr:id=name}{td}h6.stringPBKDF2Hash{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringPBKDF2Hash{span}{span:id=iets|style=float: left;}\(textString){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringPBKDF2Hash-String_des|trigger=button|text=}{sub-section}{sub-section:stringPBKDF2Hash-String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringPBKDF2Hash-String_snc|trigger=button|text=}{sub-section}{sub-section:stringPBKDF2Hash-String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringPBKDF2Hash-String_prs|trigger=button|text=}{sub-section}{sub-section:stringPBKDF2Hash-String_prs|trigger=none|class=sIndent}\{[String]} textString -- the text to process {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringPBKDF2Hash-String_ret|trigger=button|text=}{sub-section}{sub-section:stringPBKDF2Hash-String_ret|trigger=none|class=sIndent}[String] -- the resulting hashString{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringPBKDF2Hash-String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringPBKDF2Hash-String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringPBKDF2Hash-String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringPBKDF2Hash-String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringPBKDF2Hash-String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringPBKDF2Hash-String_sam|trigger=none}{code:language=javascript} var hashed_password = utils.stringPBKDF2Hash(user_password) {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringPBKDF2Hash-String_Number|class=node}{tr:id=name}{td}h6.stringPBKDF2Hash{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringPBKDF2Hash{span}{span:id=iets|style=float: left;}\(textString, iterations){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringPBKDF2Hash-String_Number_des|trigger=button|text=}{sub-section}{sub-section:stringPBKDF2Hash-String_Number_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringPBKDF2Hash-String_Number_snc|trigger=button|text=}{sub-section}{sub-section:stringPBKDF2Hash-String_Number_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringPBKDF2Hash-String_Number_prs|trigger=button|text=}{sub-section}{sub-section:stringPBKDF2Hash-String_Number_prs|trigger=none|class=sIndent}\{[String]} textString -- the text to process \{[Number]} iterations -- how many hash iterations should be done, minimum should be 1000 or higher. {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringPBKDF2Hash-String_Number_ret|trigger=button|text=}{sub-section}{sub-section:stringPBKDF2Hash-String_Number_ret|trigger=none|class=sIndent}[String] -- the resulting hashString{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringPBKDF2Hash-String_Number_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringPBKDF2Hash-String_Number_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringPBKDF2Hash-String_Number_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringPBKDF2Hash-String_Number_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringPBKDF2Hash-String_Number_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringPBKDF2Hash-String_Number_sam|trigger=none}{code:language=javascript} var hashed_password = utils.stringPBKDF2Hash(user_password,5000) {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringPatternCount-String_String|class=node}{tr:id=name}{td}h6.stringPatternCount{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}stringPatternCount{span}{span:id=iets|style=float: left;}\(text, toSearchFor){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringPatternCount-String_String_des|trigger=button|text=}{sub-section}{sub-section:stringPatternCount-String_String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringPatternCount-String_String_snc|trigger=button|text=}{sub-section}{sub-section:stringPatternCount-String_String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringPatternCount-String_String_prs|trigger=button|text=}{sub-section}{sub-section:stringPatternCount-String_String_prs|trigger=none|class=sIndent}\{[String]} text -- the text to process \{[String]} toSearchFor -- the string to search for {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringPatternCount-String_String_ret|trigger=button|text=}{sub-section}{sub-section:stringPatternCount-String_String_ret|trigger=none|class=sIndent}[Number] -- the occurrenceCount that the search string is found in the text{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringPatternCount-String_String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringPatternCount-String_String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringPatternCount-String_String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringPatternCount-String_String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringPatternCount-String_String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringPatternCount-String_String_sam|trigger=none}{code:language=javascript} //returns 2 as count var count = utils.stringPatternCount('this is a test','is'); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringPosition-String_String_Number_Number|class=node}{tr:id=name}{td}h6.stringPosition{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}stringPosition{span}{span:id=iets|style=float: left;}\(textString, toSearchFor, i_start, i_occurrence){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringPosition-String_String_Number_Number_des|trigger=button|text=}{sub-section}{sub-section:stringPosition-String_String_Number_Number_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringPosition-String_String_Number_Number_snc|trigger=button|text=}{sub-section}{sub-section:stringPosition-String_String_Number_Number_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringPosition-String_String_Number_Number_prs|trigger=button|text=}{sub-section}{sub-section:stringPosition-String_String_Number_Number_prs|trigger=none|class=sIndent}\{[String]} textString -- the text to process \{[String]} toSearchFor -- the string to search \{[Number]} i_start -- the start index to search from \{[Number]} i_occurrence -- the occurrence {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringPosition-String_String_Number_Number_ret|trigger=button|text=}{sub-section}{sub-section:stringPosition-String_String_Number_Number_ret|trigger=none|class=sIndent}[Number] -- the position{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringPosition-String_String_Number_Number_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringPosition-String_String_Number_Number_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringPosition-String_String_Number_Number_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringPosition-String_String_Number_Number_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringPosition-String_String_Number_Number_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringPosition-String_String_Number_Number_sam|trigger=none}{code:language=javascript} //returns 4 as position var pos = utils.stringPosition('This is a test','s',1,1) {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringReplace-String_String_String|class=node}{tr:id=name}{td}h6.stringReplace{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringReplace{span}{span:id=iets|style=float: left;}\(text, search_text, replacement_text){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringReplace-String_String_String_des|trigger=button|text=}{sub-section}{sub-section:stringReplace-String_String_String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringReplace-String_String_String_snc|trigger=button|text=}{sub-section}{sub-section:stringReplace-String_String_String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringReplace-String_String_String_prs|trigger=button|text=}{sub-section}{sub-section:stringReplace-String_String_String_prs|trigger=none|class=sIndent}\{[String]} text -- the text to process \{[String]} search_text -- the string to search \{[String]} replacement_text -- the replacement text {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringReplace-String_String_String_ret|trigger=button|text=}{sub-section}{sub-section:stringReplace-String_String_String_ret|trigger=none|class=sIndent}[String] -- the changed text string{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringReplace-String_String_String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringReplace-String_String_String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringReplace-String_String_String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringReplace-String_String_String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringReplace-String_String_String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringReplace-String_String_String_sam|trigger=none}{code:language=javascript} //returns 'these are cow 1 and cow 2.' var retval = utils.stringReplace('these are test 1 and test 2.','test','cow'); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringReplaceTags|class=node}{tr:id=name}{td}h6.stringReplaceTags{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringReplaceTags{span}{span:id=iets|style=float: left;}\(text, scriptable){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringReplaceTags_des|trigger=button|text=}{sub-section}{sub-section:stringReplaceTags_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringReplaceTags_snc|trigger=button|text=}{sub-section}{sub-section:stringReplaceTags_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringReplaceTags_prs|trigger=button|text=}{sub-section}{sub-section:stringReplaceTags_prs|trigger=none|class=sIndent}\{[String]} text -- the text tags to work with \{[Object]} scriptable -- the javascript object or foundset,record,form to be used to fill in the tags {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringReplaceTags_ret|trigger=button|text=}{sub-section}{sub-section:stringReplaceTags_ret|trigger=none|class=sIndent}[String] -- the text with replaced tags{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringReplaceTags_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringReplaceTags_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringReplaceTags_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringReplaceTags_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringReplaceTags_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringReplaceTags_sam|trigger=none}{code:language=javascript} //Next line places a string in variable x, whereby the tag(%%TAG%%) is filled with the value of the database column 'company_name' of the selected record. var x = utils.stringReplaceTags("The companyName of the selected record is %%company_name%% ", foundset) //var otherExample = utils.stringReplaceTags("The amount of the related order line %%amount%% ", order_to_orderdetails); //var recordExample = utils.stringReplaceTags("The amount of the related order line %%amount%% ", order_to_orderdetails.getRecord(i); //Next line places a string in variable y, whereby the tag(%%TAG%%) is filled with the value of the form variable 'x' of the form named 'main'. //var y = utils.stringReplaceTags("The value of form variable is %%x%% ", forms.main); //The next sample shows the use of a javascript object //var obj = new Object();//create a javascript object //obj['x'] = 'test';//assign an named value //var y = utils.stringReplaceTags("The value of object variable is %%x%% ", obj);//use the named value in a tag {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringRight|class=node}{tr:id=name}{td}h6.stringRight{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringRight{span}{span:id=iets|style=float: left;}\(text, i_size){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringRight_des|trigger=button|text=}{sub-section}{sub-section:stringRight_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringRight_snc|trigger=button|text=}{sub-section}{sub-section:stringRight_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringRight_prs|trigger=button|text=}{sub-section}{sub-section:stringRight_prs|trigger=none|class=sIndent}\{[String]} text -- the text to process \{[Number]} i_size -- the size of the text to return {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringRight_ret|trigger=button|text=}{sub-section}{sub-section:stringRight_ret|trigger=none|class=sIndent}[String] -- the result text string{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringRight_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringRight_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringRight_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringRight_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringRight_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringRight_sam|trigger=none}{code:language=javascript} //returns 'a test' var retval = utils.stringLeft('this is a test',6); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringRightWords|class=node}{tr:id=name}{td}h6.stringRightWords{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringRightWords{span}{span:id=iets|style=float: left;}\(text, numberof_words){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringRightWords_des|trigger=button|text=}{sub-section}{sub-section:stringRightWords_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringRightWords_snc|trigger=button|text=}{sub-section}{sub-section:stringRightWords_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringRightWords_prs|trigger=button|text=}{sub-section}{sub-section:stringRightWords_prs|trigger=none|class=sIndent}\{[String]} text -- to process \{[Number]} numberof_words -- to return {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringRightWords_ret|trigger=button|text=}{sub-section}{sub-section:stringRightWords_ret|trigger=none|class=sIndent}[String] -- the string with number of words form the right{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringRightWords_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringRightWords_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringRightWords_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringRightWords_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringRightWords_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringRightWords_sam|trigger=none}{code:language=javascript} //returns 'is a test' var retval = utils.stringRightWords('this is a test',3); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringToNumber-String|class=node}{tr:id=name}{td}h6.stringToNumber{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}stringToNumber{span}{span:id=iets|style=float: left;}\(textString){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringToNumber-String_des|trigger=button|text=}{sub-section}{sub-section:stringToNumber-String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringToNumber-String_snc|trigger=button|text=}{sub-section}{sub-section:stringToNumber-String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringToNumber-String_prs|trigger=button|text=}{sub-section}{sub-section:stringToNumber-String_prs|trigger=none|class=sIndent}\{[String]} textString -- the text to process {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringToNumber-String_ret|trigger=button|text=}{sub-section}{sub-section:stringToNumber-String_ret|trigger=none|class=sIndent}[Number] -- the resulting number{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringToNumber-String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringToNumber-String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringToNumber-String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringToNumber-String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringToNumber-String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringToNumber-String_sam|trigger=none}{code:language=javascript} //returns 65567 var retval = utils.stringToNumber('fg65gf567'); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringToNumber-String_String|class=node}{tr:id=name}{td}h6.stringToNumber{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}stringToNumber{span}{span:id=iets|style=float: left;}\(textString, decimalSeparator){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringToNumber-String_String_des|trigger=button|text=}{sub-section}{sub-section:stringToNumber-String_String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringToNumber-String_String_snc|trigger=button|text=}{sub-section}{sub-section:stringToNumber-String_String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringToNumber-String_String_prs|trigger=button|text=}{sub-section}{sub-section:stringToNumber-String_String_prs|trigger=none|class=sIndent}\{[String]} textString -- the text to process \{[String]} decimalSeparator -- decimal separator {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringToNumber-String_String_ret|trigger=button|text=}{sub-section}{sub-section:stringToNumber-String_String_ret|trigger=none|class=sIndent}[Number] -- the resulting number{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringToNumber-String_String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringToNumber-String_String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringToNumber-String_String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringToNumber-String_String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringToNumber-String_String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringToNumber-String_String_sam|trigger=none}{code:language=javascript} //returns 65.567 var retval = utils.stringToNumber('fg65gf.567','.'); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringTrim-String|class=node}{tr:id=name}{td}h6.stringTrim{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}stringTrim{span}{span:id=iets|style=float: left;}\(textString){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringTrim-String_des|trigger=button|text=}{sub-section}{sub-section:stringTrim-String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringTrim-String_snc|trigger=button|text=}{sub-section}{sub-section:stringTrim-String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringTrim-String_prs|trigger=button|text=}{sub-section}{sub-section:stringTrim-String_prs|trigger=none|class=sIndent}\{[String]} textString -- the text to process {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringTrim-String_ret|trigger=button|text=}{sub-section}{sub-section:stringTrim-String_ret|trigger=none|class=sIndent}[String] -- the resulting trimmed string{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringTrim-String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringTrim-String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringTrim-String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringTrim-String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringTrim-String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringTrim-String_sam|trigger=none}{code:language=javascript} //returns 'text' var retval = utils.stringTrim(' text '); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=stringWordCount|class=node}{tr:id=name}{td}h6.stringWordCount{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Number]{span}{span:id=iets|style=float: left; font-weight: bold;}stringWordCount{span}{span:id=iets|style=float: left;}\(text){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:stringWordCount_des|trigger=button|text=}{sub-section}{sub-section:stringWordCount_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:stringWordCount_snc|trigger=button|text=}{sub-section}{sub-section:stringWordCount_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:stringWordCount_prs|trigger=button|text=}{sub-section}{sub-section:stringWordCount_prs|trigger=none|class=sIndent}\{[String]} text -- the text to process {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:stringWordCount_ret|trigger=button|text=}{sub-section}{sub-section:stringWordCount_ret|trigger=none|class=sIndent}[Number] -- the word count{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:stringWordCount_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringWordCount_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:stringWordCount_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringWordCount_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:stringWordCount_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:stringWordCount_sam|trigger=none}{code:language=javascript} //returns '4' as result var retval = utils.stringWordCount('this is a test'); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=timestampToDate|class=node}{tr:id=name}{td}h6.timestampToDate{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Date]{span}{span:id=iets|style=float: left; font-weight: bold;}timestampToDate{span}{span:id=iets|style=float: left;}\(date){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:timestampToDate_des|trigger=button|text=}{sub-section}{sub-section:timestampToDate_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:timestampToDate_snc|trigger=button|text=}{sub-section}{sub-section:timestampToDate_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:timestampToDate_prs|trigger=button|text=}{sub-section}{sub-section:timestampToDate_prs|trigger=none|class=sIndent}\{[Date]} date -- object to be stripped from its time elements {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:timestampToDate_ret|trigger=button|text=}{sub-section}{sub-section:timestampToDate_ret|trigger=none|class=sIndent}[Date] -- the stripped date object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:timestampToDate_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:timestampToDate_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:timestampToDate_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:timestampToDate_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:timestampToDate_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:timestampToDate_sam|trigger=none}{code:language=javascript} var date = utils.timestampToDate(application.getTimeStamp()); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=validatePBKDF2Hash|class=node}{tr:id=name}{td}h6.validatePBKDF2Hash{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}validatePBKDF2Hash{span}{span:id=iets|style=float: left;}\(password, hash){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:validatePBKDF2Hash_des|trigger=button|text=}{sub-section}{sub-section:validatePBKDF2Hash_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:validatePBKDF2Hash_snc|trigger=button|text=}{sub-section}{sub-section:validatePBKDF2Hash_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:validatePBKDF2Hash_prs|trigger=button|text=}{sub-section}{sub-section:validatePBKDF2Hash_prs|trigger=none|class=sIndent}\{[String]} password -- the password to test against \{[String]} hash -- the hash the password needs to validate to. {sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:validatePBKDF2Hash_ret|trigger=button|text=}{sub-section}{sub-section:validatePBKDF2Hash_ret|trigger=none|class=sIndent}[Boolean] -- true if his hash is valid for that password{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:validatePBKDF2Hash_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:validatePBKDF2Hash_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:validatePBKDF2Hash_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:validatePBKDF2Hash_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:validatePBKDF2Hash_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:validatePBKDF2Hash_sam|trigger=none}{code:language=javascript} if (utils.validatePBKDF2Hash(user_password, hashFromDb)) { // logged in } {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Wiki Markup
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryReturn the byte array representation of the Base64 valueReturn the String representation of the Base64 valueReturn the Base64 value representation of the byteArrayReturn the string conversion of the byteArrayFormat a date object to a text representation.Format a date object to a text representation using the format and timezone given.Format a date object to a text representation.Format a date object to a text representation using the format, timezone, language and country given.Returns a string containing the character for the unicode number.Returns true if the (related)foundset exists and has records.Returns true if the (related)foundset exists and has records.Returns true when Monday is the first day of the week for your current locale setting.Format a number to have a defined fraction.Format a number to have a defined fraction.Format a number to specification.Format a number to specification.Parse a string to a date object.Parse a string to a date object.Parse a string to a date object.Parse a string to a date object.Returns the escaped markup text (HTML/XML).Returns the escaped markup text (HTML/XML).Returns the escaped markup text (HTML/XML).Formats a string according to format specifiers and arguments.Format a string using mask.Replaces a portion of a string with replacement text from a specified index.Returns all words starting with capital chars.Returns a string with the requested number of characters, starting from the left.Returns the number of words, starting from the left.Returns the md5 hash (encoded as base16) for specified text.Returns the md5 hash (encoded as base64) for specified text.Returns a substring from the original string.Returns a substring from the original string.Returns the PBKDF2 hash for specified text.Returns the PBKDF2 hash for specified text.Returns the number of times searchString appears in textString.Returns the position of the string to search for, from a certain start position and occurrence.Replaces a portion of a string with replacement text.Returns the text with %%tags%% replaced, based on provided record or foundset or form.Returns a string with the requested number of characters, starting from the right.Returns the number of words, starting from the right.Return the Base64 representation of the stringReturn the byte array representation of the stringFilters characters out of from a string and leaves digits, returns the number.Filters characters out of from a string and leaves digits, returns the number.Returns the string without leading or trailing spaces.Returns the number of words in the text string.Returns a datestamp from the timestamp (sets hours,minutes,seconds and milliseconds to 0).Validates the given password against the given hash.

functionservoy sDetail2100%height:30px2Methods Detailsbase64ToBytesname

base64ToBytes(base64String:)

dessIndent
Return the byte array representation of the Base64 value
prs

Parameters

sIndentbase64String:the Base64 encoded string to convert to byte array
ret

Returns

sIndent byteArray representation of the base64 string using UTF-8 charset for conversion
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowbase64ToStringname

base64ToString(base64String:)

dessIndent
Return the String representation of the Base64 value
prs

Parameters

sIndentbase64String:the Base64 value to convert to String
ret

Returns

sIndent String decoded representation of the Base64 value using UTF-8 charset for conversion
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
bytesToBase64name

bytesToBase64(byteArray:)

dessIndent
Return the Base64 value representation of the byteArray
prs

Parameters

sIndentbyteArray:the byte array to convert to Base64 value
ret

Returns

sIndent Base64 representation of the byte array using UTF-8 charset for conversion
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
bytesToHexname

bytesToHex(bytearray)

dessIndentprs

Parameters

sIndentbytearraythe byte array to convert to hex encoded string
ret

Returns

sIndent returns hex encoded string from bytearray
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
bytesToStringname

bytesToString(byteArray:)

dessIndent
Return the string conversion of the byteArray
prs

Parameters

sIndentbyteArray:the byte array to convert to
ret

Returns

sIndent string representation of the byte array using UTF-8 charset for conversion
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
dateFormatname

dateFormat(date, format)

dessIndent
Format a date object to a text representation.
This will format with the system timezone for the webclient
For NGClient it will use the timezone of the client, the same goes for the Smartclient (but that is the system timezone)
see #dateFormat(Date,String,String) for using the actual clients timezone.

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'.
Symbols meaning is:
 G        era designator
 y        year
 Y        week year
 M        month in year
 d        day in month
 h        hour in am/pm (1~12)
 H        hour in day (0~23)
 m        minute in hour
 s        second in minute
 S        millisecond
 E        day in week
 D        day in year
 F        day of week in month
 w        week in year
 W        week in month
 a        am/pm marker
 z        time zone
 k        hour in day (1~24)
 K        hour in am/pm (0~11)
prs

Parameters

sIndentdatethe dateformatthe format to output
ret

Returns

sIndent the date as text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
dateFormatname

dateFormat(date, format, timezone)

dessIndent
Format a date object to a text representation using the format and timezone given.
If the timezone is not given the timezone of the client itself will be used.
see i18n.getAvailableTimeZoneIDs() to get a timezone string that can be used.

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'
Symbols meaning is:
 G        era designator
 y        year
 Y        week year
 M        month in year
 d        day in month
 h        hour in am/pm (1~12)
 H        hour in day (0~23)
 m        minute in hour
 s        second in minute
 S        millisecond
 E        day in week
 D        day in year
 F        day of week in month
 w        week in year
 W        week in month
 a        am/pm marker
 z        time zone
 k        hour in day (1~24)
 K        hour in am/pm (0~11)
prs

Parameters

sIndentdatethe dateformatthe format to outputtimezoneThe timezone string to use to parse the date (like GMT+3), if null then the timezone of the current client is used.
ret

Returns

sIndent the date as text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
dateFormatname

dateFormat(date, format, language, country)

dessIndent
Format a date object to a text representation.
This will format with the system timezone for the webclient
With language and/or country the locale will be created.
For NGClient it will use the timezone of the client, the same goes for the Smartclient (but that is the system timezone)
see #dateFormat(Date,String,String) for using the actual clients timezone.

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'.
Symbols meaning is:
 G        era designator
 y        year
 Y        week year
 M        month in year
 d        day in month
 h        hour in am/pm (1~12)
 H        hour in day (0~23)
 m        minute in hour
 s        second in minute
 S        millisecond
 E        day in week
 D        day in year
 F        day of week in month
 w        week in year
 W        week in month
 a        am/pm marker
 z        time zone
 k        hour in day (1~24)
 K        hour in am/pm (0~11)
prs

Parameters

sIndentdatethe dateformatthe format to outputlanguagelanguage used to create localecountrycountry used along side language to create the locale
ret

Returns

sIndent the date as text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
dateFormatname

dateFormat(date, format, timezone, language, country)

dessIndent
Format a date object to a text representation using the format, timezone, language and country given.
With the language and country given, the locale will be created.
If the timezone is not given the timezone of the client itself will be used.
see i18n.getAvailableTimeZoneIDs() to get a timezone string that can be used.

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'
Symbols meaning is:
 G        era designator
 y        year
 Y        week year
 M        month in year
 d        day in month
 h        hour in am/pm (1~12)
 H        hour in day (0~23)
 m        minute in hour
 s        second in minute
 S        millisecond
 E        day in week
 D        day in year
 F        day of week in month
 w        week in year
 W        week in month
 a        am/pm marker
 z        time zone
 k        hour in day (1~24)
 K        hour in am/pm (0~11)
prs

Parameters

sIndentdatethe dateformatthe format to outputtimezonethe timezone to use the format, if null then current client timezone is used.languagelanguage used to create localecountrycountry used along side language to create the locale
ret

Returns

sIndent the date as text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getUnicodeCharactername

getUnicodeCharacter(unicodeCharacterNumber)

dessIndent
Returns a string containing the character for the unicode number.
prs

Parameters

sIndentunicodeCharacterNumberthe number indicating the unicode character
ret

Returns

sIndent a string containing the unicode character
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
hasRecordsname

hasRecords(foundset)

dessIndent
Returns true if the (related)foundset exists and has records.
Another use is, to pass a record and qualified relations string to test multiple relations/foundset at once
prs

Parameters

sIndentfoundsetthe foundset to be tested
ret

Returns

sIndent true if exists
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
hasRecordsname

hasRecords(record, relationString)

dessIndent
Returns true if the (related)foundset exists and has records.
Another use is, to pass a record and qualified relations string to test multiple relations/foundset at once
prs

Parameters

sIndentrecordA JSRecord to test.relationStringThe relation name.
ret

Returns

sIndent true if the foundset/relation has records.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
hexToBytesname

hexToBytes(hex)

dessIndentprs

Parameters

sIndenthexhex encoded string to be decoded into a byte array.
ret

Returns

sIndent a byte array from hex encoded string
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
hexToStringname

hexToString(hex)

dessIndentprs

Parameters

sIndenthex ;
ret

Returns

sIndent returns decoded string from hex
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
isMondayFirstDayOfWeekname

isMondayFirstDayOfWeek()

dessIndent
Returns true when Monday is the first day of the week for your current locale setting.
ret

Returns

sIndent true if Monday is first day of the week in current locale
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
numberFormatname

numberFormat(number, digits)

dessIndent
Format a number to have a defined fraction.
prs

Parameters

sIndentnumberthe number to formatdigitsnr of digits
ret

Returns

sIndent the resulting number in text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
numberFormatname

numberFormat(number, digits, language, country)

dessIndent
Format a number to have a defined fraction.
prs

Parameters

sIndentnumberthe number to formatdigitsnr of digitslanguagelanguage used to create localecountrycountry used along side language to create the locale
ret

Returns

sIndent the resulting number in text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
numberFormatname

numberFormat(number, format)

dessIndent
Format a number to specification.
prs

Parameters

sIndentnumberthe number to formatformatthe format
ret

Returns

sIndent the resulting number in text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
numberFormatname

numberFormat(number, format, language, country)

dessIndent
Format a number to specification.
prs

Parameters

sIndentnumberthe number to formatformatthe formatlanguagelanguage used to create localecountrycountry used along side language to create the locale
ret

Returns

sIndent the resulting number in text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
parseDatename

parseDate(date, format)

dessIndent
Parse a string to a date object. This parses the date using the TimeZone of the server
Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'
prs

Parameters

sIndentdatethe date as textformatthe format to parse the date
ret

Returns

sIndent the date as date object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
parseDatename

parseDate(date, format, timezone)

dessIndent
Parse a string to a date object. Using the timezone that is given, if null then it formats it with the clients timezone.

see i18n.getAvailableTimeZoneIDs() to get a timezone string that can be used.

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'
prs

Parameters

sIndentdatethe date as textformatthe format to parse the datetimezoneThe timezone string to use to parse the date (like GMT+3)
ret

Returns

sIndent the date as date object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
parseDatename

parseDate(date, format, language, country)

dessIndent
Parse a string to a date object. Using language and country that are given,
if null then it formats it with the locale of the client

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'
prs

Parameters

sIndentdatethe date as textformatthe format to parse the datelanguagelanguage used to create localecountrycountry used along side language to create the locale
ret

Returns

sIndent the date as date object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
parseDatename

parseDate(date, format, timezone, language, country)

dessIndent
Parse a string to a date object. Using the timezone, language and country that are given,
if null then it formats it with the timezone and locale of the client

see i18n.getAvailableTimeZoneIDs() to get a timezone string that can be used.

Format can be a string like: 'dd-MM-yyyy' , 'dd-MM-yyyy HH:mm' , 'MM/dd/yyyy', 'MM/dd/yyyy hh:mm aa', 'dd.MM.yyyy'
prs

Parameters

sIndentdatethe date as textformatthe format to parse the datetimezoneThe timezone string to use to parse the date (like GMT+3)languagelanguage used to create localecountrycountry used along side language to create the locale
ret

Returns

sIndent the date as date object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringEscapeMarkupname

stringEscapeMarkup(textString)

dessIndent
Returns the escaped markup text (HTML/XML).
prs

Parameters

sIndenttextStringthe text to process
ret

Returns

sIndent the escaped text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringEscapeMarkupname

stringEscapeMarkup(textString, escapeSpaces)

dessIndent
Returns the escaped markup text (HTML/XML).
prs

Parameters

sIndenttextStringthe text to processescapeSpacesindicating to escape spaces
ret

Returns

sIndent the escaped text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringEscapeMarkupname

stringEscapeMarkup(textString, escapeSpaces, convertToHtmlUnicodeEscapes)

dessIndent
Returns the escaped markup text (HTML/XML).
prs

Parameters

sIndenttextStringthe text to processescapeSpacesindicating to escape spacesconvertToHtmlUnicodeEscapesindicating to use unicode escapes
ret

Returns

sIndent the escaped text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringFormatname

stringFormat(text_to_format, parameters)

dessIndent
Formats a string according to format specifiers and arguments.
prs

Parameters

sIndenttext_to_formatthe text to formatparametersthe array with parameters
ret

Returns

sIndent the formatted text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringFormatname

stringFormat(text, format)

dessIndent
Format a string using mask.
prs

Parameters

sIndenttextthe string to formatformatthe format
ret

Returns

sIndent the resulting text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringIndexReplacename

stringIndexReplace(text, i_start, i_size, replacement_text)

dessIndent
Replaces a portion of a string with replacement text from a specified index.
prs

Parameters

sIndenttextthe text to processi_startthe start index to work fromi_sizethe size of the text to replacereplacement_textthe replacement text
ret

Returns

sIndent the changed text string
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringInitCapname

stringInitCap(text)

dessIndent
Returns all words starting with capital chars.
prs

Parameters

sIndenttextthe text to process
ret

Returns

sIndent the changed text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringLeftname

stringLeft(text, i_size)

dessIndent
Returns a string with the requested number of characters, starting from the left.
prs

Parameters

sIndenttextthe text to processi_sizethe size of the text to return
ret

Returns

sIndent the result text string
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringLeftWordsname

stringLeftWords(text, numberof_words)

dessIndent
Returns the number of words, starting from the left.
prs

Parameters

sIndenttextto processnumberof_wordsto return
ret

Returns

sIndent the string with number of words form the left
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringMD5HashBase16name

stringMD5HashBase16(textString)

dessIndent
Returns the md5 hash (encoded as base16) for specified text.

NOTE: MD5 (Message-Digest Algorythm 5) is a hash function with a 128-bit hash value, for more info see: http://en.wikipedia.org/wiki/MD5
prs

Parameters

sIndenttextStringthe text to process
ret

Returns

sIndent the resulting hashString
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringMD5HashBase64name

stringMD5HashBase64(textString)

dessIndent
Returns the md5 hash (encoded as base64) for specified text.

NOTE: MD5 (Message-Digest Algorythm 5) is a hash function with a 128-bit hash value, for more info see: http://en.wikipedia.org/wiki/MD5
prs

Parameters

sIndenttextStringthe text to process
ret

Returns

sIndent the resulting hashString
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringMiddlename

stringMiddle(text, i_start, i_size)

dessIndent
Returns a substring from the original string.
prs

Parameters

sIndenttextthe text to processi_startthe start index to work fromi_sizethe size of the text to return
ret

Returns

sIndent the result text string
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringMiddleWordsname

stringMiddleWords(text, i_start, numberof_words)

dessIndent
Returns a substring from the original string.
prs

Parameters

sIndenttextto processi_startstart word indexnumberof_wordsthe word count to return
ret

Returns

sIndent the string with number of words form the left and
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringPBKDF2Hashname

stringPBKDF2Hash(textString)

dessIndent
Returns the PBKDF2 hash for specified text. This method is preferred above the old MD5 hash for enhanced security.
It uses a default of 9999 iterations. The string that is returned can only be used in the utils.validatePBKDF2Hash(password,thisReturnValue)
to check if this hash is a result of that password.
This will always be false: utils.stringPBKDF2Hash("test") == utils.stringPBKDF2Hash("test"). Because for the same string in multiply calls it will not generate the same hash.
So you can only check it like this: utils.validatePBKDF2Hash("test",utils.stringPBKDF2Hash("test"))

NOTE: PBKDF2 is the key hash function for the PKCS (Public-Key Cryptography) standard, for more info see: http://en.wikipedia.org/wiki/PBKDF2
prs

Parameters

sIndenttextStringthe text to process
ret

Returns

sIndent the resulting hashString
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringPBKDF2Hashname

stringPBKDF2Hash(textString, iterations)

dessIndent
Returns the PBKDF2 hash for specified text. This method is preferred above the old MD5 hash for enhanced security.

NOTE: PBKDF2 is the key hash function for the PKCS (Public-Key Cryptography) standard, for more info see: http://en.wikipedia.org/wiki/PBKDF2
prs

Parameters

sIndenttextStringthe text to processiterationshow many hash iterations should be done, minimum should be 1000 or higher.
ret

Returns

sIndent the resulting hashString
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringPatternCountname

stringPatternCount(text, toSearchFor)

dessIndent
Returns the number of times searchString appears in textString.
prs

Parameters

sIndenttextthe text to processtoSearchForthe string to search for
ret

Returns

sIndent the occurrenceCount that the search string is found in the text
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringPositionname

stringPosition(textString, toSearchFor, i_start, i_occurrence)

dessIndent
Returns the position of the string to search for, from a certain start position and occurrence.
prs

Parameters

sIndenttextStringthe text to processtoSearchForthe string to searchi_startthe start index to search fromi_occurrencethe occurrence
ret

Returns

sIndent the position
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringReplacename

stringReplace(text, search_text, replacement_text)

dessIndent
Replaces a portion of a string with replacement text.
prs

Parameters

sIndenttextthe text to processsearch_textthe string to searchreplacement_textthe replacement text
ret

Returns

sIndent the changed text string
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringReplaceTagsname

stringReplaceTags(text, scriptable)

dessIndent
Returns the text with %%tags%% replaced, based on provided record or foundset or form.
prs

Parameters

sIndenttextthe text tags to work withscriptablethe javascript object or foundset,record,form to be used to fill in the tags
ret

Returns

sIndent the text with replaced tags
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringRightname

stringRight(text, i_size)

dessIndent
Returns a string with the requested number of characters, starting from the right.
prs

Parameters

sIndenttextthe text to processi_sizethe size of the text to return
ret

Returns

sIndent the result text string
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringRightWordsname

stringRightWords(text, numberof_words)

dessIndent
Returns the number of words, starting from the right.
prs

Parameters

sIndenttextto processnumberof_wordsto return
ret

Returns

sIndent the string with number of words form the right
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringToBase64name

stringToBase64(string:)

dessIndent
Return the Base64 representation of the string
prs

Parameters

sIndentstring:the string to convert to Base64
ret

Returns

sIndent Base64 encoded representation of the string using UTF-8 charset for conversion
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringToBytesname

stringToBytes(string:)

dessIndent
Return the byte array representation of the string
prs

Parameters

sIndentstring:the string to convert to bytes
ret

Returns

sIndent byte array representation of the string using UTF-8 charset for conversion
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringToHexname

stringToHex(string)

dessIndentprs

Parameters

sIndentstringString to be encoded into hex
ret

Returns

sIndent returns hex encoded string
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringToNumbername

stringToNumber(textString)

dessIndent
Filters characters out of from a string and leaves digits, returns the number. Uses locale decimal separator.
prs

Parameters

sIndenttextStringthe text to process
ret

Returns

sIndent the resulting number
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringToNumbername

stringToNumber(textString, decimalSeparator)

dessIndent
Filters characters out of from a string and leaves digits, returns the number. Decimal separator is specified as parameter.
prs

Parameters

sIndenttextStringthe text to processdecimalSeparatordecimal separator
ret

Returns

sIndent the resulting number
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringTrimname

stringTrim(textString)

dessIndent
Returns the string without leading or trailing spaces.
prs

Parameters

sIndenttextStringthe text to process
ret

Returns

sIndent the resulting trimmed string
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
stringWordCountname

stringWordCount(text)

dessIndent
Returns the number of words in the text string.
prs

Parameters

sIndenttextthe text to process
ret

Returns

sIndent the word count
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
timestampToDatename

timestampToDate(date)

dessIndent
Returns a datestamp from the timestamp (sets hours,minutes,seconds and milliseconds to 0).
prs

Parameters

sIndentdateobject to be stripped from its time elements
ret

Returns

sIndent the stripped date object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
validatePBKDF2Hashname

validatePBKDF2Hash(password, hash)

dessIndent
Validates the given password against the given hash. The hash should be generated by one of the stringPBKDF2Hash(password [,iteration]) functions. If hash is null or empty string the method will return false.

NOTE: PBKDF2 is the key hash function for the PKCS (Public-Key Cryptography) standard, for more info see: http://en.wikipedia.org/wiki/PBKDF2
prs

Parameters

sIndentpasswordthe password to test againsthashthe hash the password needs to validate to.
ret

Returns

sIndent true if his hash is valid for that password
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow