# FarPoint.Web.Spread.Background

## Content

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



  <h1 id="FarPoint_Web_Spread_Background" data-uid="FarPoint.Web.Spread.Background" class="text-break">Background Class
</h1>
  <div class="markdown level0 summary"><p>Represents a background (image and gradient).</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">Background</span></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="FarPoint.Web.Spread.Model.ISerializeSupport.html">ISerializeSupport</a></div>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.serialization.iserializable">ISerializable</a></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="FarPoint.Web.Spread.html">FarPoint.Web.Spread</a></h6>
  <h6><strong>Assembly</strong>: FarPoint.Web.Spread.dll</h6>
  <h5 id="FarPoint_Web_Spread_Background_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[TypeConverter(typeof(ExpandableObjectConverter))]
public class Background : ISerializeSupport, ISerializable</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">&lt;TypeConverter(GetType(ExpandableObjectConverter))&gt;
Public Class Background
    Implements ISerializeSupport, ISerializable</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="FarPoint_Web_Spread_Background__ctor" data-uid="FarPoint.Web.Spread.Background.#ctor">
          <a class="xref" href="FarPoint.Web.Spread.Background.-ctor.html#FarPoint_Web_Spread_Background__ctor">Background()</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new background with default values.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background__ctor_FarPoint_Web_Spread_Background_" data-uid="FarPoint.Web.Spread.Background.#ctor(FarPoint.Web.Spread.Background)">
          <a class="xref" href="FarPoint.Web.Spread.Background.-ctor.html#FarPoint_Web_Spread_Background__ctor_FarPoint_Web_Spread_Background_">Background(Background)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new background with the specified background information.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background__ctor_System_Boolean_" data-uid="FarPoint.Web.Spread.Background.#ctor(System.Boolean)">
          <a class="xref" href="FarPoint.Web.Spread.Background.-ctor.html#FarPoint_Web_Spread_Background__ctor_System_Boolean_">Background(bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new background and whether enabled.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background__ctor_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_" data-uid="FarPoint.Web.Spread.Background.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
          <a class="xref" href="FarPoint.Web.Spread.Background.-ctor.html#FarPoint_Web_Spread_Background__ctor_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_">Background(SerializationInfo, StreamingContext)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new background from serialization.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background__ctor_System_String_" data-uid="FarPoint.Web.Spread.Background.#ctor(System.String)">
          <a class="xref" href="FarPoint.Web.Spread.Background.-ctor.html#FarPoint_Web_Spread_Background__ctor_System_String_">Background(string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new background with the specified image.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background__ctor_System_String_System_String_" data-uid="FarPoint.Web.Spread.Background.#ctor(System.String,System.String)">
          <a class="xref" href="FarPoint.Web.Spread.Background.-ctor.html#FarPoint_Web_Spread_Background__ctor_System_String_System_String_">Background(string, string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new background with the specified images.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background__ctor_System_String_System_String_System_String_System_String_System_String_" data-uid="FarPoint.Web.Spread.Background.#ctor(System.String,System.String,System.String,System.String,System.String)">
          <a class="xref" href="FarPoint.Web.Spread.Background.-ctor.html#FarPoint_Web_Spread_Background__ctor_System_String_System_String_System_String_System_String_System_String_">Background(string, string, string, string, string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new background with the specified images and image options.</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="FarPoint_Web_Spread_Background_BackgroundAttachment" data-uid="FarPoint.Web.Spread.Background.BackgroundAttachment">
          <a class="xref" href="FarPoint.Web.Spread.Background.BackgroundAttachment.html#FarPoint_Web_Spread_Background_BackgroundAttachment">BackgroundAttachment</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets how the background image is attached to the object in the document.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background_BackgroundImageUrl" data-uid="FarPoint.Web.Spread.Background.BackgroundImageUrl">
          <a class="xref" href="FarPoint.Web.Spread.Background.BackgroundImageUrl.html#FarPoint_Web_Spread_Background_BackgroundImageUrl">BackgroundImageUrl</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the location of a background image.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background_BackgroundPosition" data-uid="FarPoint.Web.Spread.Background.BackgroundPosition">
          <a class="xref" href="FarPoint.Web.Spread.Background.BackgroundPosition.html#FarPoint_Web_Spread_Background_BackgroundPosition">BackgroundPosition</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the position of the background of the object.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background_BackgroundRepeat" data-uid="FarPoint.Web.Spread.Background.BackgroundRepeat">
          <a class="xref" href="FarPoint.Web.Spread.Background.BackgroundRepeat.html#FarPoint_Web_Spread_Background_BackgroundRepeat">BackgroundRepeat</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets how the background image of the object is tiled.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background_Enable" data-uid="FarPoint.Web.Spread.Background.Enable">
          <a class="xref" href="FarPoint.Web.Spread.Background.Enable.html#FarPoint_Web_Spread_Background_Enable">Enable</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether the <a class="xref" href="FarPoint.Web.Spread.Background.html">Background</a> image is enabled.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background_IsEmpty" data-uid="FarPoint.Web.Spread.Background.IsEmpty">
          <a class="xref" href="FarPoint.Web.Spread.Background.IsEmpty.html#FarPoint_Web_Spread_Background_IsEmpty">IsEmpty</a>
        </td>
        <td class="markdown level1 summary"><p>Gets whether this instance is empty.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background_SelectedBackgroundImageUrl" data-uid="FarPoint.Web.Spread.Background.SelectedBackgroundImageUrl">
          <a class="xref" href="FarPoint.Web.Spread.Background.SelectedBackgroundImageUrl.html#FarPoint_Web_Spread_Background_SelectedBackgroundImageUrl">SelectedBackgroundImageUrl</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the location of a background image when a cell is selected.</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="FarPoint_Web_Spread_Background_Deserialize_System_Xml_XmlNodeReader_" data-uid="FarPoint.Web.Spread.Background.Deserialize(System.Xml.XmlNodeReader)">
          <a class="xref" href="FarPoint.Web.Spread.Background.Deserialize.html#FarPoint_Web_Spread_Background_Deserialize_System_Xml_XmlNodeReader_">Deserialize(XmlNodeReader)</a>
        </td>
        <td class="markdown level1 summary"><p>Loads the object from XML.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background_GetAttributesString_FarPoint_Web_Spread_Background_FarPoint_Web_Spread_FpSpread_" data-uid="FarPoint.Web.Spread.Background.GetAttributesString(FarPoint.Web.Spread.Background,FarPoint.Web.Spread.FpSpread)">
          <a class="xref" href="FarPoint.Web.Spread.Background.GetAttributesString.html#FarPoint_Web_Spread_Background_GetAttributesString_FarPoint_Web_Spread_Background_FarPoint_Web_Spread_FpSpread_">GetAttributesString(Background, FpSpread)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the attributes string for the specified background and FarPoint Spread.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background_GetObjectData_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_" data-uid="FarPoint.Web.Spread.Background.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
          <a class="xref" href="FarPoint.Web.Spread.Background.GetObjectData.html#FarPoint_Web_Spread_Background_GetObjectData_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_">GetObjectData(SerializationInfo, StreamingContext)</a>
        </td>
        <td class="markdown level1 summary"><p>Populates a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.serialization.serializationinfo">SerializationInfo</a> with the data needed to serialize the target object.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background_IsEquals_FarPoint_Web_Spread_Background_" data-uid="FarPoint.Web.Spread.Background.IsEquals(FarPoint.Web.Spread.Background)">
          <a class="xref" href="FarPoint.Web.Spread.Background.IsEquals.html#FarPoint_Web_Spread_Background_IsEquals_FarPoint_Web_Spread_Background_">IsEquals(Background)</a>
        </td>
        <td class="markdown level1 summary"><p>Determines whether the background is equal to the specified information.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_Background_Serialize_System_Xml_XmlTextWriter_" data-uid="FarPoint.Web.Spread.Background.Serialize(System.Xml.XmlTextWriter)">
          <a class="xref" href="FarPoint.Web.Spread.Background.Serialize.html#FarPoint_Web_Spread_Background_Serialize_System_Xml_XmlTextWriter_">Serialize(XmlTextWriter)</a>
        </td>
        <td class="markdown level1 summary"><p>Saves the object to XML.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>