Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The StringFunc class defines the implementations of the expression runtime functions for String functions
in the Adobe application modeling language.
public static function charAt(s:String, pos:int):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the character at the indicated position.
Parameters
| s:String — String
|
|
| pos:int — Position - 0 is the first character in the string
|
Returns public static function chr(c:int):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the character with the provided code.
Parameters
Returns public static function compare(s1:String, s2:String):int
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Compares two strings lexicographically.
Parameters
Returns | int — Value 0 if the argument string is equal to this string;
-1 if this string is lexicographically less than the string argument;
+1 if this string is lexicographically greater than the string argument.
|
public static function compareNoCase(s1:String, s2:String):int
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Compare two strings lexicographically, ignoring case.
Parameters
Returns | int — 0 if the argument string is equal to this string;
-1 if this string is lexicographically less than the string argument;
+1 if this string is lexicographically greater than the string argument.
|
public static function endsWith(sub:String, str:String):Boolean
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Tests if this string ends with the specified suffix.
Parameters
Returns | Boolean — true if the string ends with the suffix
|
public static function find(sub:String, str:String):int
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the index of the substring within the string.
Parameters
Returns | int — Index of the substring, or -1 if not found
|
public static function findLast(sub:String, str:String):int
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the index within this string of the rightmost occurrence of the specified substring.
Parameters
Returns | int — Index of the first character of the last substring is returned or -1 if not found.
|
public static function findLastNoCase(sub:String, str:String):int
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the index within this string of the rightmost occurrence of the specified substring, ignoring case.
Parameters
Returns | int — Index of the first character of the last substring is returned or -1 if not found.
|
public static function findNoCase(sub:String, str:String):int
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the index of the substring within the string, ignoring case.
Parameters
Returns | int — Index of the substring, or -1 if not found
|
public static function findOneOf(cset:String, str:String):int
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Finds the first occurrence of any one of a set of characters in a string.
The search is case-sensitive.
Parameters
| cset:String — Set of characters to look for
|
|
| str:String — String
|
Returns | int — Position of the first member of set found in string; or -1, if no member of set is found in string.
|
public static function insert(sub:String, str:String, pos:int):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Inserts a substring in a string after a specified character position.
If position = -1, prefixes the substring to the string.
Parameters
| sub:String — String to insert
|
|
| str:String — String
|
|
| pos:int — Position to insert the substring
|
Returns public static function left(str:String, count:int):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets the leftmost characters from a string.
Parameters
| str:String — String
|
|
| count:int — How many characters
|
Returns | String — Leftmost count characters of the given string
|
public static function leftTrim(input:String):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes whitespace from the front of the specified string.
Parameters
| input:String — String whose beginning whitespace will be removed.
|
Returns | String — String with whitespace removed from the begining
|
public static function len(s:String):int
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the length of a string.
Parameters
Returns public static function lower(str:String):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Converts a string to lowercase.
Parameters
Returns | String — String, converted to lowercase.
|
public static function removeChars(str:String, start:int, count:int):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a copy of the string, with count characters removed from the specified start position.
If start or count is invalid, the original string is returned.
Parameters
| str:String — String
|
|
| start:int — Starting character to remove
|
|
| count:int — Number of characters to remove
|
Returns | String — New string with the characters removed
|
public static function repeatString(str:String, count:int):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates a string that contains a specified number of repetitions of the specified string.
Parameters
| str:String — String
|
|
| count:int — Number of times to repeat str
|
Returns public static function replace(input:String, search:String, replace:String):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Replaces first occurrence of search in the input string with replace.
The search is case-sensitive.
Parameters
| input:String — String to search
|
|
| search:String — What to look for
|
|
| replace:String — What to replace it with
|
Returns public static function replaceAll(input:String, search:String, replace:String):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Replaces all occurrences of search in the input string with replace.
The search is case-sensitive.
Parameters
| input:String — String to search
|
|
| search:String — What to look for
|
|
| replace:String — What to replace it with
|
Returns public static function replaceAllNoCase(input:String, search:String, replace:String):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Replaces all occurrences of search in the input string with replace.
The search is case-insensitive.
Parameters
| input:String — String to search
|
|
| search:String — What to look for
|
|
| replace:String — What to replace it with
|
Returns public static function replaceNoCase(input:String, search:String, replace:String):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Replaces first occurrence of search in the input string with replace.
The search is case-insensitive.
Parameters
| input:String — String to search
|
|
| search:String — What to look for
|
|
| replace:String — What to replace it with
|
Returns public static function reverse(s:String):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Reverse the characters in a string.
Parameters
Returns | String — New string with the characters in reverse order
|
public static function right(str:String, count:int):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the specified number of characters from the end (or right side) of the specified string.
Parameters
| str:String — String
|
|
| count:int — Number of rightmost characters
|
Returns | String — Rightmost count characters of the given string
|
public static function rightTrim(input:String):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes trailing white space from a string.
Parameters
Returns | String — String with trailing whitespace removed
|
public static function spanExcluding(str:String, cset:String):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets characters from a string, from the beginning to a character that is in a specified set of characters.
The search is case-sensitive.
Example SpanExcluding("MyString", "Sin") will return "My" as after that it hits 'S' which is present in 2nd string.
Parameters
| str:String — String
|
|
| cset:String — Set of characters to stop on
|
Returns public static function spanIncluding(str:String, cset:String):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets characters from a string, from the beginning to a character that is not in a specified set of characters.
The search is case-sensitive.
example : SpanIncluding("mystring", "mystery") will return "mystr"
Parameters
| str:String — String
|
|
| cset:String — Set of characters to include
|
Returns public static function startsWith(prefix:String, input:String):Boolean
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns true if string starts with a specified prefix.
Parameters
Returns | Boolean — true if the string starts with prefix
|
public static function substring(str:String, s:int, c:int):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Extracts a substring from a string, beginning at s (start), of length c (count).
Parameters
| str:String — String
|
|
| s:int — First character to extract (indexes start at 0)
|
|
| c:int — Number of characters
|
Returns public static function trim(s:String):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes whitespace from the start and end of a string.
Parameters
Returns | String — Copy of the string with no leading or trailing whitespace
|
public static function upper(s:String):String
Language Version: | ActionScript 3.0 |
Product Version: | LiveCycle Data Services 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Converts a string to uppercase.
Parameters
Returns | String — String converted to uppercase
|