# C1.Framework.IconRenderer

## Content

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



  <h1 id="C1_Framework_IconRenderer" data-uid="C1.Framework.IconRenderer" class="text-break">IconRenderer Class
</h1>
  <div class="markdown level0 summary"><p>Provides basic functionality for rendering a <a class="xref" href="C1.Framework.C1Icon.html">C1Icon</a> to an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.drawing.image">Image</a>.</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">IconRenderer</span></div>
      <div class="level2"><a class="xref" href="C1.Framework.BitmapIconRenderer.html">BitmapIconRenderer</a></div>
      <div class="level2"><a class="xref" href="C1.Framework.CompositeIconRenderer.html">CompositeIconRenderer</a></div>
      <div class="level2"><a class="xref" href="C1.Framework.FontIconRenderer.html">FontIconRenderer</a></div>
      <div class="level2"><a class="xref" href="C1.Framework.VectorIconRenderer.html">VectorIconRenderer</a></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="C1.Framework.html">C1.Framework</a></h6>
  <h6><strong>Assembly</strong>: C1.Win.10.dll</h6>
  <h5 id="C1_Framework_IconRenderer_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract class IconRenderer : IDisposable</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public MustInherit Class IconRenderer
    Implements IDisposable</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="C1_Framework_IconRenderer__ctor_C1_Framework_C1Icon_System_Int32_" data-uid="C1.Framework.IconRenderer.#ctor(C1.Framework.C1Icon,System.Int32)">
          <a class="xref" href="C1.Framework.IconRenderer.-ctor.html#C1_Framework_IconRenderer__ctor_C1_Framework_C1Icon_System_Int32_">IconRenderer(C1Icon, int)</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="C1.Framework.IconRenderer.html">IconRenderer</a> class.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="fields">Fields
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="C1_Framework_IconRenderer_DefaultDpi" data-uid="C1.Framework.IconRenderer.DefaultDpi">
          <a class="xref" href="C1.Framework.IconRenderer.DefaultDpi.html">DefaultDpi</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a default value of dpi.</p>
</td>
      </tr>
    </tbody>
  </table>
  <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="C1_Framework_IconRenderer_BackColor" data-uid="C1.Framework.IconRenderer.BackColor">
          <a class="xref" href="C1.Framework.IconRenderer.BackColor.html#C1_Framework_IconRenderer_BackColor">BackColor</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the color used to paint the icon's background.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Framework_IconRenderer_CachedImage" data-uid="C1.Framework.IconRenderer.CachedImage">
          <a class="xref" href="C1.Framework.IconRenderer.CachedImage.html#C1_Framework_IconRenderer_CachedImage">CachedImage</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the cached icon image.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Framework_IconRenderer_Color" data-uid="C1.Framework.IconRenderer.Color">
          <a class="xref" href="C1.Framework.IconRenderer.Color.html#C1_Framework_IconRenderer_Color">Color</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the color used to paint the icon.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Framework_IconRenderer_DeviceDpi" data-uid="C1.Framework.IconRenderer.DeviceDpi">
          <a class="xref" href="C1.Framework.IconRenderer.DeviceDpi.html#C1_Framework_IconRenderer_DeviceDpi">DeviceDpi</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the device dpi where the image will be used.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Framework_IconRenderer_Icon" data-uid="C1.Framework.IconRenderer.Icon">
          <a class="xref" href="C1.Framework.IconRenderer.Icon.html#C1_Framework_IconRenderer_Icon">Icon</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the icon to render.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Framework_IconRenderer_Padding" data-uid="C1.Framework.IconRenderer.Padding">
          <a class="xref" href="C1.Framework.IconRenderer.Padding.html#C1_Framework_IconRenderer_Padding">Padding</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the padding of the icon.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Framework_IconRenderer_RightToLeft" data-uid="C1.Framework.IconRenderer.RightToLeft">
          <a class="xref" href="C1.Framework.IconRenderer.RightToLeft.html#C1_Framework_IconRenderer_RightToLeft">RightToLeft</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether the <a class="xref" href="C1.Framework.C1Icon.html">C1Icon</a> should be drawn using right-to-left layout.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Framework_IconRenderer_ScaledSize" data-uid="C1.Framework.IconRenderer.ScaledSize">
          <a class="xref" href="C1.Framework.IconRenderer.ScaledSize.html#C1_Framework_IconRenderer_ScaledSize">ScaledSize</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the size of icon after scaling by <a class="xref" href="C1.Framework.IconRenderer.DeviceDpi.html#C1_Framework_IconRenderer_DeviceDpi">DeviceDpi</a>.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Framework_IconRenderer_Size" data-uid="C1.Framework.IconRenderer.Size">
          <a class="xref" href="C1.Framework.IconRenderer.Size.html#C1_Framework_IconRenderer_Size">Size</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the size of icon to show.</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="C1_Framework_IconRenderer_CreateRenderer_C1_Framework_C1Icon_System_Int32_" data-uid="C1.Framework.IconRenderer.CreateRenderer(C1.Framework.C1Icon,System.Int32)">
          <a class="xref" href="C1.Framework.IconRenderer.CreateRenderer.html#C1_Framework_IconRenderer_CreateRenderer_C1_Framework_C1Icon_System_Int32_">CreateRenderer(C1Icon, int)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates an instance of the inheritor of <a class="xref" href="C1.Framework.IconRenderer.html">IconRenderer</a> class in accordance with the <a class="xref" href="C1.Framework.C1Icon.html">C1Icon</a> type.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Framework_IconRenderer_Dispose" data-uid="C1.Framework.IconRenderer.Dispose">
          <a class="xref" href="C1.Framework.IconRenderer.Dispose.html#C1_Framework_IconRenderer_Dispose">Dispose()</a>
        </td>
        <td class="markdown level1 summary"><p>Clean up any resources being used.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Framework_IconRenderer_Dispose_System_Boolean_" data-uid="C1.Framework.IconRenderer.Dispose(System.Boolean)">
          <a class="xref" href="C1.Framework.IconRenderer.Dispose.html#C1_Framework_IconRenderer_Dispose_System_Boolean_">Dispose(bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Clean up any resources being used.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Framework_IconRenderer_GetImage" data-uid="C1.Framework.IconRenderer.GetImage">
          <a class="xref" href="C1.Framework.IconRenderer.GetImage.html#C1_Framework_IconRenderer_GetImage">GetImage()</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the image that the icon was rendered into.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Framework_IconRenderer_ResetCache" data-uid="C1.Framework.IconRenderer.ResetCache">
          <a class="xref" href="C1.Framework.IconRenderer.ResetCache.html#C1_Framework_IconRenderer_ResetCache">ResetCache()</a>
        </td>
        <td class="markdown level1 summary"><p>Resets cached image.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>