> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# String

> Variable-length Unicode string type in the FlexiLayout language, with Length, Find, Compare, Mid, and SubstParam methods plus concatenation operators.

## Methods

| Method                                                                                                                                                                                                                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                       |
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Int Length()`                                                                                                                                                                                                                                                                                                                             | Returns the number of characters in the string (read-only).                                                                                                                                                                                                                                                                       |
| `Int Find( String subStr, Int startPos = 0 )`                                                                                                                                                                                                                                                                                              | Returns the beginning of the substring subStr of the string. Starts the search from the startPos position. Can be used without the startPos argument, in which case it assumes the default value of 0. Returns -1 if the string does not include a startPos substring.                                                            |
| `Int Compare( String str )`                                                                                                                                                                                                                                                                                                                | Compares the string with the method's argument (case-sensitive). Returns: `<0`, if `this` is less than `str`; 0, if `this` is equal to `str`; `>0`, if `this` is greater than `str`                                                                                                                                               |
| `Int CompareNoCase( String str )`                                                                                                                                                                                                                                                                                                          | Compares the string with the method's argument (not a case-sensitive). Returns: `<0`, if `this` is less than `str`; 0, if `this` is equal to `str`; `>0`, if `this` is greater than `str`                                                                                                                                         |
| `String Mid( Int start, Int count )`                                                                                                                                                                                                                                                                                                       | Returns a substring of the string that is 'count' characters long and starts with the character number start.                                                                                                                                                                                                                     |
| `String Mid( String subStr, Int startPos = 0 )`                                                                                                                                                                                                                                                                                            | Returns the beginning of the substring subStr of the string. Can be used without the startPos argument, in which case it assumes the default value of 0. Returns -1 if the string does not include a startPos substring.                                                                                                          |
| `String SubstParam( String param0 ); String SubstParam( String param0, String param1 ); String SubstParam( String param0, String param1, String param2 ); String SubstParam( String param0, String param1, String param2, String param3 ); String SubstParam( String param0, String param1, String param2, String param3, String param4 )` | Returns the text of the string, replacing all occurrences of the `%n` characters (where n is a non-negative integer) with the corresponding parameters. The number of occurrences of the `%n` characters in the string must be the same as the number of passed parameters. The text of the original string will not be modified. |
| `String SubstParam( StringArray params )`                                                                                                                                                                                                                                                                                                  | Same as above, but the parameters are passed as an array of strings.                                                                                                                                                                                                                                                              |

## Operators

| Operator | Description                                                                                                                                                                                   |
| :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `==`     | Binary operator that checks if the two strings are equal. Returns a result of type Logic that is set to `true` if the strings are equal, and returns `false`, otherwise (case-sensitive).     |
| `!=`     | Binary operator that checks if the two strings are equal. Returns a result of type Logic that is set to `true` if the strings are not equal, and returns `false`, otherwise (case-sensitive). |
| `+`      | Concatenates two strings. Returns a value of type String.                                                                                                                                     |
