Child pages
  • Utils

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryFormat a date object to a text representation.Format a date object to a text representation using the format and timezone 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 specification.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.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.Filters 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 DetailsdateFormatname

dateFormat(date, format)

dessIndent
Format a date object to a text representation.
This will format with the system timezone, so for web and ng clients it will use the server timezone to format
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
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowdateFormatname

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 to use the format, if null then current client timezone is used.
ret

Returns

sIndent
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
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
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
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
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
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
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
numberFormatname

numberFormat(number, format)

dessIndent
Format a number to specification.
prs

Parameters

sIndentnumberthe number to formatformatthe format
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
parseDatename

parseDate(date, format)

dessIndent
Parse a string to a date object.
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 to date
ret

Returns

sIndent
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow