# C1.Win.TouchToolKit.C1Magnify.BorderBackground

## Content

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



<h1 id="C1_Win_TouchToolKit_C1Magnify_BorderBackground_" data-uid="C1.Win.TouchToolKit.C1Magnify.BorderBackground*">BorderBackground Property
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>



<a id="C1_Win_TouchToolKit_C1Magnify_BorderBackground_" data-uid="C1.Win.TouchToolKit.C1Magnify.BorderBackground*"></a>
<h4 id="C1_Win_TouchToolKit_C1Magnify_BorderBackground" data-uid="C1.Win.TouchToolKit.C1Magnify.BorderBackground">BorderBackground</h4>
<div class="markdown level1 summary"><p>Gets or sets a value indicating the background image used for the border of the magnifier.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
  <pre><code class="lang-csharp hljs">public Image BorderBackground { get; set; }</code></pre>
</div>
<div class="codewrapper">
  <pre><code class="lang-vbnet hljs">Public Property BorderBackground As Image</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.drawing.image">Image</a></td>
      <td><p>A <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.drawing.image">Image</a> value that represents the background image used for the magnifier. The default is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</td>
    </tr>
  </tbody>
</table>
<h5 id="C1_Win_TouchToolKit_C1Magnify_BorderBackground_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This property only take effect when <a class="xref" href="C1.Win.TouchToolKit.C1Magnify.BorderBackgroundMode.html#C1_Win_TouchToolKit_C1Magnify_BorderBackgroundMode">BorderBackgroundMode</a> property value
is <a class="xref" href="C1.Win.TouchToolKit.BorderBackground.html#C1_Win_TouchToolKit_BorderBackground_Custom">BorderBackground.Custom</a>.</p>
</div>
<h5 id="C1_Win_TouchToolKit_C1Magnify_BorderBackground_examples">Examples</h5>
<p>
  The following code example shows how to use this property. 
</p>
<p>
  This code example is part of a larger example provided for the <a class="xref" href="C1.Win.TouchToolKit.C1Magnify.html">C1Magnify</a> class.
</p>
<pre><code class="lang-csharp">public class GcMagnifierDemo : Form
{
	private GcMagnifier _gcMagnifierObj = new GcMagnifier();

	public GcMagnifierDemo()
	{
		// Magnifier background mode. If property value is BorderBackground.Custom,
		// user can to use BorderBackground property to set the background image.
		_gcMagnifierObj.BorderBackgroundMode = BorderBackground.Dark;
	}
}</code></pre>
<pre><code class="lang-csharp">Public Class GcMagnifierDemo
	Inherits Form
	Private _gcMagnifierObj As New GcMagnifier()

	Public Sub New()
		' Magnifier background mode. If property value is BorderBackground.Custom,
		' user can to use BorderBackground property to set the background image.
		_gcMagnifierObj.BorderBackgroundMode = BorderBackground.Dark
	End Sub
End Class</code></pre>

</div>