<doc>
  <legacy_id>2025</legacy_id>
  <name>mouseChar</name>
  <type>function</type>
  <syntax>
    <example>the mouseChar</example>
    <example>mouseChar()</example>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>User Interaction</category>
  </classification>
  <references>
    <function tag="mouseCharChunk">mouseCharChunk Function</function>
    <function tag="mouseLine">mouseLine Function</function>
    <function tag="clickChar">clickChar Function</function>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
    <mobile/>
  </classes>
  <security>
  </security>
  <summary><glossary tag="return">Returns</glossary> the <keyword tag="character">character</keyword> the <glossary tag="mouse pointer">mouse pointer</glossary> is over.</summary>
  <examples>
    <example>the mouseChar</example>
    <example>if the mouseChar is a number then goToFootnote</example>
  </examples>
  <description>
    <p>Use the <b>mouseChar</b> <control_st tag="function">function</control_st> within a <glossary tag="handler">handler</glossary> to determine which <keyword tag="character">character</keyword> the mouse is hovering over, in order to take some action based on the current <keyword tag="character">character</keyword>.</p><p/><p><b>Value:</b></p><p>The <b>mouseChar</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> a <keyword tag="character">character</keyword>.</p><p/><p><b>Comments:</b></p><p>The <b>mouseChar</b> <control_st tag="function">function</control_st> only <glossary tag="return">returns</glossary> <keyword tag="characters">characters</keyword> in a <keyword tag="field">field</keyword>. If the <glossary tag="mouse pointer">mouse pointer</glossary> is not over a <keyword tag="field">field</keyword>, the <b>mouseChar</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> empty.</p><p/><p>To find the position of the <b>mouseChar</b> within the <keyword tag="field">field</keyword>, use the <function tag="mouseCharChunk">mouseCharChunk</function> <control_st tag="function">function</control_st>.</p>
  </description>
</doc>