<doc>
  <legacy_id>2508</legacy_id>
  <name>repeatRate</name>
  <type>property</type>
  <syntax>
    <example>set the repeatRate to <i>milliseconds</i></example>
  </syntax>
  <library></library>
  <objects>
    <global/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>User Interaction</category>
  </classification>
  <references>
    <message tag="scrollbarLineInc">scrollbarLineInc Message</message>
    <property tag="pageIncrement">pageIncrement Property</property>
  </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>Specifies how long a <keyword tag="scrollbar">scrollbar</keyword> waits between repeats when the <glossary tag="mouse button">mouse button</glossary> is held down.</summary>
  <examples>
    <example>set the repeatRate to 1000 <code><i>-- 1 second</i></code></example>
  </examples>
  <description>
    <p>Use the <b>repeatRate</b> <glossary tag="property">property</glossary> to control auto-scrolling when the <glossary tag="mouse button">mouse button</glossary> is held down.</p><p/><p><b>Value:</b></p><p>The <b>repeatRate</b> is an <keyword tag="integer">integer</keyword>.</p><p/><p>By default, the <b>repeatRate</b> <glossary tag="property">property</glossary> is set to 50 (1/20th of a second).</p><p/><p><b>Comments:</b></p><p>If the user clicks in the gray region of a scrollbar or on one of its arrows and holds the mouse button down, the scroll action is repeated and the scrollbar is updated repeatedly as long as the mouse is down. The <b>repeatRate</b> is the time in <function tag="milliseconds">milliseconds</function> between one update and the next.</p><p/><p>If the <b>repeatRate</b> is zero, updates are performed as often as possible with no delay.</p><p/><p>If the <b>repeatRate</b> is <glossary tag="negative">negative</glossary>, scrollbar clicks do not repeat at all.</p>
  </description>
</doc>