# GrapeCity.Documents.Imaging.GifFrame

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="GrapeCity_Documents_Imaging_GifFrame" data-uid="GrapeCity.Documents.Imaging.GifFrame" class="text-break">GifFrame Class
</h1>
  <div class="markdown level0 summary"><p>Represents a single frame in the GIF file.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><span class="xref">GifFrame</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="GrapeCity.Documents.Imaging.html">GrapeCity.Documents.Imaging</a></h6>
  <h6><strong>Assembly</strong>: DS.Documents.Imaging.dll</h6>
  <h5 id="GrapeCity_Documents_Imaging_GifFrame_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class GifFrame</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class GifFrame</code></pre>
  </div>
  <h3 id="properties">Properties
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_BasedOnFrame" data-uid="GrapeCity.Documents.Imaging.GifFrame.BasedOnFrame">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.BasedOnFrame.html#GrapeCity_Documents_Imaging_GifFrame_BasedOnFrame">BasedOnFrame</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the index of a frame used as the base for the current frame, -1 if the current frame doesn't depend on previous frames.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_Bottom" data-uid="GrapeCity.Documents.Imaging.GifFrame.Bottom">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.Bottom.html#GrapeCity_Documents_Imaging_GifFrame_Bottom">Bottom</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the y-coordinate that is the sum of <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.Top.html#GrapeCity_Documents_Imaging_GifFrame_Top">Top</a> and <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.Height.html#GrapeCity_Documents_Imaging_GifFrame_Height">Height</a> property values.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_DelayTime" data-uid="GrapeCity.Documents.Imaging.GifFrame.DelayTime">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.DelayTime.html#GrapeCity_Documents_Imaging_GifFrame_DelayTime">DelayTime</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the number of hundredths (1/100) of a second to wait before continuing.</p>
<p>If the value is negative, the delay time is not specified.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_DisposalMethod" data-uid="GrapeCity.Documents.Imaging.GifFrame.DisposalMethod">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.DisposalMethod.html#GrapeCity_Documents_Imaging_GifFrame_DisposalMethod">DisposalMethod</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the way in which the GIF frame has to be treated after being displayed.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_FrameIndex" data-uid="GrapeCity.Documents.Imaging.GifFrame.FrameIndex">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.FrameIndex.html#GrapeCity_Documents_Imaging_GifFrame_FrameIndex">FrameIndex</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the index of the frame in the associated GIF file.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_HasLocalPalette" data-uid="GrapeCity.Documents.Imaging.GifFrame.HasLocalPalette">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.HasLocalPalette.html#GrapeCity_Documents_Imaging_GifFrame_HasLocalPalette">HasLocalPalette</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value indicating if the frame uses colors from the Local Color Table.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_Height" data-uid="GrapeCity.Documents.Imaging.GifFrame.Height">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.Height.html#GrapeCity_Documents_Imaging_GifFrame_Height">Height</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the height of the frame image in pixels.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_Left" data-uid="GrapeCity.Documents.Imaging.GifFrame.Left">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.Left.html#GrapeCity_Documents_Imaging_GifFrame_Left">Left</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the x-coordinate, in pixels, of the left edge of the frame image, with respect to the left edge of the Logical Screen.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_Opaque" data-uid="GrapeCity.Documents.Imaging.GifFrame.Opaque">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.Opaque.html#GrapeCity_Documents_Imaging_GifFrame_Opaque">Opaque</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value indicating if transparent pixels don't occur in the frame data.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_Reader" data-uid="GrapeCity.Documents.Imaging.GifFrame.Reader">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.Reader.html#GrapeCity_Documents_Imaging_GifFrame_Reader">Reader</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the associated <a class="xref" href="GrapeCity.Documents.Imaging.GcGifReader.html">GcGifReader</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_Right" data-uid="GrapeCity.Documents.Imaging.GifFrame.Right">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.Right.html#GrapeCity_Documents_Imaging_GifFrame_Right">Right</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the x-coordinate that is the sum of <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.Left.html#GrapeCity_Documents_Imaging_GifFrame_Left">Left</a> and <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.Width.html#GrapeCity_Documents_Imaging_GifFrame_Width">Width</a> property values.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_Top" data-uid="GrapeCity.Documents.Imaging.GifFrame.Top">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.Top.html#GrapeCity_Documents_Imaging_GifFrame_Top">Top</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the y-coordinate, in pixels, of the top edge of the frame image with respect to the top edge of the Logical Screen.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_UserInput" data-uid="GrapeCity.Documents.Imaging.GifFrame.UserInput">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.UserInput.html#GrapeCity_Documents_Imaging_GifFrame_UserInput">UserInput</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value indicating whether or not user input is expected before continuing.</p>
<p>When a <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.DelayTime.html#GrapeCity_Documents_Imaging_GifFrame_DelayTime">DelayTime</a> is not 0 and the <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.UserInput.html#GrapeCity_Documents_Imaging_GifFrame_UserInput">UserInput</a> flag is set, processing will continue when user input is received or when the delay time expires, whichever occurs first.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_Width" data-uid="GrapeCity.Documents.Imaging.GifFrame.Width">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.Width.html#GrapeCity_Documents_Imaging_GifFrame_Width">Width</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the width of the frame image in pixels.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_GetLocalPalette" data-uid="GrapeCity.Documents.Imaging.GifFrame.GetLocalPalette">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.GetLocalPalette.html#GrapeCity_Documents_Imaging_GifFrame_GetLocalPalette">GetLocalPalette()</a>
        </td>
        <td class="markdown level1 summary"><p>Returns a palette with sorted opaque colors in 32-bit ARGB format retrieved from the Local Color Table.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_ReadAsIndexed8bppBitmap" data-uid="GrapeCity.Documents.Imaging.GifFrame.ReadAsIndexed8bppBitmap">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.ReadAsIndexed8bppBitmap.html#GrapeCity_Documents_Imaging_GifFrame_ReadAsIndexed8bppBitmap">ReadAsIndexed8bppBitmap()</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the frame image as a <a class="xref" href="GrapeCity.Documents.Imaging.Indexed8bppBitmap.html">Indexed8bppBitmap</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_ToGcBitmap" data-uid="GrapeCity.Documents.Imaging.GifFrame.ToGcBitmap">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.ToGcBitmap.html#GrapeCity_Documents_Imaging_GifFrame_ToGcBitmap">ToGcBitmap()</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the frame image as a <a class="xref" href="GrapeCity.Documents.Imaging.GcBitmap.html">GcBitmap</a>.</p>
<p>Many GIF files use frames with transparent pixels where the previous frame
is partly visible. If you read multiple GIF frames you can improve the performance
dramatically by reading frames into the same <a class="xref" href="GrapeCity.Documents.Imaging.GcBitmap.html">GcBitmap</a> and passing
index of the previous frame in the additional contentFrameIndex parameter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_ToGcBitmap_GrapeCity_Documents_Imaging_GcBitmap_System_Int32_" data-uid="GrapeCity.Documents.Imaging.GifFrame.ToGcBitmap(GrapeCity.Documents.Imaging.GcBitmap,System.Int32)">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.ToGcBitmap.html#GrapeCity_Documents_Imaging_GifFrame_ToGcBitmap_GrapeCity_Documents_Imaging_GcBitmap_System_Int32_">ToGcBitmap(GcBitmap, int)</a>
        </td>
        <td class="markdown level1 summary"><p>Reads the frame image into an existing <a class="xref" href="GrapeCity.Documents.Imaging.GcBitmap.html">GcBitmap</a>.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Imaging_GifFrame_ToImage_GrapeCity_Documents_Drawing_ImageBinding_" data-uid="GrapeCity.Documents.Imaging.GifFrame.ToImage(GrapeCity.Documents.Drawing.ImageBinding)">
          <a class="xref" href="GrapeCity.Documents.Imaging.GifFrame.ToImage.html#GrapeCity_Documents_Imaging_GifFrame_ToImage_GrapeCity_Documents_Drawing_ImageBinding_">ToImage(ImageBinding)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates an <a class="xref" href="GrapeCity.Documents.Drawing.Image.html">Image</a> object for the frame.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>