.. _String:

================================================
String
================================================


Description
-----------

A character string. Each character is adressable by index.




Properties
^^^^^^^^^^

+---------------------------------------+---------------------------+
| :ref:`length<String.length>` readonly | The length of the string. |
+---------------------------------------+---------------------------+




Constructors
^^^^^^^^^^^^

+---------------------------------------+--------------------------------------------------------------------+
| :ref:`String<String.String>` readonly | Returns a string representation of the value given as an argument. |
+---------------------------------------+--------------------------------------------------------------------+


Methods
^^^^^^^

+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`anchor<String.anchor>` readonly                       | Returns a string consisting of this string enclosed in a <a> tag.                                                                       |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`big<String.big>` readonly                             | Returns a string consisting of this string enclosed in a <big> tag.                                                                     |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`blink<String.blink>` readonly                         | Returns a string consisting of this string enclosed in a <blink> tag.                                                                   |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bold<String.bold>` readonly                           | Returns a string consisting of this string enclosed in a <b> tag.                                                                       |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`charAt<String.charAt>` readonly                       | Returns the character at the specified index.                                                                                           |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`charCodeAt<String.charCodeAt>` readonly               | Returns the Unicode value of the character at the given index.                                                                          |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`concat<String.concat>` readonly                       | If necessary, converts the one or more given values to strings.                                                                         |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`fixed<String.fixed>` readonly                         | Returns a string consisting of this string enclosed in a <tt> tag.                                                                      |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`fontcolor<String.fontcolor>` readonly                 | Returns a string consisting of this string enclosed in a <font> tag.                                                                    |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`fontsize<String.fontsize>` readonly                   | Returns a string consisting of this string enclosed in a <font> tag.                                                                    |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`indexOf<String.indexOf>` readonly                     | Returns the index within the string of the first occurrence of the specified string, starting the search at fromIndex if provided.      |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`italics<String.italics>` readonly                     | Returns a string consisting of this string enclosed in a <i> tag.                                                                       |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`lastIndexOf<String.lastIndexOf>` readonly             | Returns the index within the string of the last occurrence of the specified value.                                                      |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`link<String.link>` readonly                           | Returns a string consisting of this string enclosed in a <a> tag.                                                                       |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`localeCompare<String.localeCompare>` readonly         | Performs a localized comparison of two strings.                                                                                         |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`match<String.match>` readonly                         | Matches a string against a regular expression.                                                                                          |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`replace<String.replace>` readonly                     |                                                                                                                                         |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`search<String.search>` readonly                       |                                                                                                                                         |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`slice<String.slice>` readonly                         | Extracts a substring of the given string and returns it as a new string.                                                                |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`small<String.small>` readonly                         | Returns a string consisting of this string enclosed in a <small> tag.                                                                   |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`split<String.split>` readonly                         | Splits a string into a group of substrings, places those strings in an array, and returns the array.                                    |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`strike<String.strike>` readonly                       | Returns a string consisting of this string enclosed in a <strike> tag.                                                                  |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`sub<String.sub>` readonly                             | Returns a string consisting of this string enclosed in a <sub> tag.                                                                     |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`substr<String.substr>` readonly                       | Returns a string containing the characters beginning at the specified index, start, through the specified number of characters.         |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`substring<String.substring>` readonly                 | Returns a substring of the given string by extracting characters from indexA up to but not including indexB.                            |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`sup<String.sup>` readonly                             | Returns a string consisting of this string enclosed in a <sup> tag.                                                                     |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`toLocaleLowerCase<String.toLocaleLowerCase>` readonly | Returns a new string which contains all the characters of the original string converted to lowercase (localized).                       |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`toLocaleUpperCase<String.toLocaleUpperCase>` readonly | Returns a new string which contains all the characters of the original string converted to uppercase (localized).                       |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`toLowerCase<String.toLowerCase>` readonly             | Returns a new string which contains all the characters of the original string converted to lowercase.                                   |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`toSource<String.toSource>` readonly                   | Creates a string representation of this object that can be fed back to?eval()?to re-create an object. Works only with built-in classes. |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`toString<String.toString>` readonly                   | Returns itself.                                                                                                                         |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`toUpperCase<String.toUpperCase>` readonly             | Returns a new string which contains all the characters of the original string converted to uppercase.                                   |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`valueOf<String.valueOf>` readonly                     | Returns itself.                                                                                                                         |
+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+

Static Methods
^^^^^^^^^^^^^^

+---------------------------------------------------+---------------------------------------------------------------------------------------------+
| :ref:`fromCharCode<String.fromCharCode>` readonly | Returns a string created by concatenation one or more characters specified as ASCII values. |
+---------------------------------------------------+---------------------------------------------------------------------------------------------+




.. container:: hide

   .. toctree::
      :hidden:
      :maxdepth: 1

      String/length.rst
      
      

      String/toString.rst
      String/toSource.rst
      String/valueOf.rst
      String/charAt.rst
      String/charCodeAt.rst
      String/concat.rst
      String/indexOf.rst
      String/lastIndexOf.rst
      String/slice.rst
      String/toLowerCase.rst
      String/toUpperCase.rst
      String/toLocaleLowerCase.rst
      String/toLocaleUpperCase.rst
      String/localeCompare.rst
      String/match.rst
      String/replace.rst
      String/search.rst
      String/split.rst
      String/substr.rst
      String/substring.rst
      String/anchor.rst
      String/big.rst
      String/blink.rst
      String/bold.rst
      String/fixed.rst
      String/fontcolor.rst
      String/fontsize.rst
      String/italics.rst
      String/link.rst
      String/small.rst
      String/strike.rst
      String/sub.rst
      String/sup.rst
      
      String/fromCharCode.rst
      
      
      String/String.rst