<doc>

<legacy_id>2455</legacy_id>

<name>capsLockKey</name>

<type>function</type>

<syntax>

<example>the capsLockKey</example>

<example>capsLockKey()</example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

<function tag="keysDown">keysDown Function</function>

</references>

<history>

<introduced version="1.0">Added.</introduced>

</history>

<platforms>

<mac/>

<windows/>

<linux/>

</platforms>

<classes>

<desktop/>

<server/>

<web/>

</classes>

<security>

</security>

<summary><glossary tag="return">Returns</glossary> the state of the Caps Lock key.</summary>

<examples>

<example>the capsLockKey</example>

<example>if the capsLockKey is down then exit repeat</example>

</examples>

<description>

<p>Use the <b>capsLockKey</b> function to check whether the Caps Lock key is locked down.</p><p/><p><b>Value:</b></p><p>The <b>capsLockKey</b> function <glossary tag="return">returns</glossary> down if the key is locked down and up if it's not.</p>

</description>

</doc>