<doc>
  <legacy_id>1177</legacy_id>
  <name>currentFrame</name>
  <type>property</type>
  <syntax>
    <example>set the currentFrame of <i>image</i> to <i>frameNumber</i></example>
  </syntax>
  <library></library>
  <objects>
    <image/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Images &amp; Multimedia</category>
  </classification>
  <references>
    <property tag="currentTime">currentTime Property</property>
    <property tag="frameCount">frameCount Property</property>
    <property tag="palindromeFrames">palindromeFrames Property</property>
    <property tag="repeatCount">repeatCount Property</property>
    <property tag="endFrame">endFrame Property</property>
    <property tag="startFrame">startFrame 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 the current <glossary tag="frame">frame</glossary> of an <glossary tag="animated GIF">animated GIF</glossary>.</summary>
  <examples>
    <example>set the currentFrame of image "Process" to 1 <code><i>-- back to the beginning</i></code></example>
  </examples>
  <description>
    <p>Use the <b>currentFrame</b> <glossary tag="property">property</glossary> to check where an <glossary tag="animated GIF">animated GIF</glossary> <keyword tag="image">image</keyword> is in its sequence. Set this <glossary tag="property">property</glossary> in order to change the current <glossary tag="frame">frame</glossary> of an <glossary tag="animated GIF">animated GIF</glossary>: for example, to examine the animation <glossary tag="frame">frame</glossary> by <glossary tag="frame">frame</glossary>.</p><p/><p><b>Value:</b></p><p>The <b>currentFrame</b> of an <keyword tag="image">image</keyword> is a positive <keyword tag="integer">integer</keyword>.</p><p/><p>By default, the <b>currentFrame</b> <glossary tag="property">property</glossary> of newly created <glossary tag="image">images</glossary> is set to 1.</p><p/><p><b>Comments:</b></p><p>If the image is not a GIF, the <b>currentFrame</b> <glossary tag="property">property</glossary> always reports 1, and setting it has no effect.</p>
  </description>
</doc>