# FarPoint.Web.Spread.ButtonCellType

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="FarPoint_Web_Spread_ButtonCellType" data-uid="FarPoint.Web.Spread.ButtonCellType" class="text-break">ButtonCellType Class
</h1>
  <div class="markdown level0 summary"><p>Represents a button cell.</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"><a class="xref" href="FarPoint.Web.Spread.BaseCellType.html">BaseCellType</a></div>
    <div class="level2"><span class="xref">ButtonCellType</span></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="FarPoint.Web.Spread.ICellType.html">ICellType</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.Renderer.IFormatter.html">IFormatter</a></div>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.icloneable">ICloneable</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.IEnhancedRenderer.html">IEnhancedRenderer</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.IEnhancedPdfRenderer.html">IEnhancedPdfRenderer</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.IPdfSupport.html">IPdfSupport</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.Editor.IEditor3.html">IEditor3</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.Editor.IEditor.html">IEditor</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.Renderer.ICSSClassSupport.html">ICSSClassSupport</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.Renderer.IRenderer2.html">IRenderer2</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.Model.ISerializeSupport2.html">ISerializeSupport2</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.Model.ISerializeSupport.html">ISerializeSupport</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.IWrapableRenderer.html">IWrapableRenderer</a></div>
    <div><a class="xref" href="FarPoint.Web.Spread.Renderer.IRenderer.html">IRenderer</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_ButtonCellType_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class ButtonCellType : BaseCellType, ICellType, IFormatter, ICloneable, IEnhancedRenderer, IEnhancedPdfRenderer, IPdfSupport, IEditor3, IEditor, ICSSClassSupport, IRenderer2, ISerializeSupport2, ISerializeSupport, IWrapableRenderer, IRenderer</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class ButtonCellType
    Inherits BaseCellType
    Implements ICellType, IFormatter, ICloneable, IEnhancedRenderer, IEnhancedPdfRenderer, IPdfSupport, IEditor3, IEditor, ICSSClassSupport, IRenderer2, ISerializeSupport2, ISerializeSupport, IWrapableRenderer, IRenderer</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_ButtonCellType__ctor" data-uid="FarPoint.Web.Spread.ButtonCellType.#ctor">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.-ctor.html#FarPoint_Web_Spread_ButtonCellType__ctor">ButtonCellType()</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new button cell.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType__ctor_System_String_" data-uid="FarPoint.Web.Spread.ButtonCellType.#ctor(System.String)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.-ctor.html#FarPoint_Web_Spread_ButtonCellType__ctor_System_String_">ButtonCellType(string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new button cell with the specified command.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType__ctor_System_String_FarPoint_Web_Spread_ButtonType_" data-uid="FarPoint.Web.Spread.ButtonCellType.#ctor(System.String,FarPoint.Web.Spread.ButtonType)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.-ctor.html#FarPoint_Web_Spread_ButtonCellType__ctor_System_String_FarPoint_Web_Spread_ButtonType_">ButtonCellType(string, ButtonType)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new button cell with the specified command and button type.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType__ctor_System_String_FarPoint_Web_Spread_ButtonType_System_String_" data-uid="FarPoint.Web.Spread.ButtonCellType.#ctor(System.String,FarPoint.Web.Spread.ButtonType,System.String)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.-ctor.html#FarPoint_Web_Spread_ButtonCellType__ctor_System_String_FarPoint_Web_Spread_ButtonType_System_String_">ButtonCellType(string, ButtonType, string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new button cell with the specified command and button type.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType__ctor_System_String_System_String_" data-uid="FarPoint.Web.Spread.ButtonCellType.#ctor(System.String,System.String)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.-ctor.html#FarPoint_Web_Spread_ButtonCellType__ctor_System_String_System_String_">ButtonCellType(string, string)</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new button cell with the specified command and text.</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_ButtonCellType_AccessKey" data-uid="FarPoint.Web.Spread.ButtonCellType.AccessKey">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.AccessKey.html#FarPoint_Web_Spread_ButtonCellType_AccessKey">AccessKey</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the access key that allows you to quickly navigate to the cell.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_AllowWrap" data-uid="FarPoint.Web.Spread.ButtonCellType.AllowWrap">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.AllowWrap.html#FarPoint_Web_Spread_ButtonCellType_AllowWrap">AllowWrap</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether the cell allows text to wrap to multiple lines.
Wrapping only occurs on word breaks.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_BackColor" data-uid="FarPoint.Web.Spread.ButtonCellType.BackColor">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.BackColor.html#FarPoint_Web_Spread_ButtonCellType_BackColor">BackColor</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the background color of the cell.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_ButtonType" data-uid="FarPoint.Web.Spread.ButtonCellType.ButtonType">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.ButtonType.html#FarPoint_Web_Spread_ButtonCellType_ButtonType">ButtonType</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets what type of command button to display.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_CommandName" data-uid="FarPoint.Web.Spread.ButtonCellType.CommandName">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.CommandName.html#FarPoint_Web_Spread_ButtonCellType_CommandName">CommandName</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the command name for the button.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_CssClass" data-uid="FarPoint.Web.Spread.ButtonCellType.CssClass">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.CssClass.html#FarPoint_Web_Spread_ButtonCellType_CssClass">CssClass</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the CSS class name.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_ForeColor" data-uid="FarPoint.Web.Spread.ButtonCellType.ForeColor">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.ForeColor.html#FarPoint_Web_Spread_ButtonCellType_ForeColor">ForeColor</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the foreground color (typically the color of the text) of the cell.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_ImageUrl" data-uid="FarPoint.Web.Spread.ButtonCellType.ImageUrl">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.ImageUrl.html#FarPoint_Web_Spread_ButtonCellType_ImageUrl">ImageUrl</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the image to display in the button cell.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_OnClientClick" data-uid="FarPoint.Web.Spread.ButtonCellType.OnClientClick">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.OnClientClick.html#FarPoint_Web_Spread_ButtonCellType_OnClientClick">OnClientClick</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the OnClientClick event settings of the cell.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_ShowEllipsis" data-uid="FarPoint.Web.Spread.ButtonCellType.ShowEllipsis">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.ShowEllipsis.html#FarPoint_Web_Spread_ButtonCellType_ShowEllipsis">ShowEllipsis</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether to render ellipsis (...) to indicate text overflow in the cell.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_Text" data-uid="FarPoint.Web.Spread.ButtonCellType.Text">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.Text.html#FarPoint_Web_Spread_ButtonCellType_Text">Text</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the button text.</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_ButtonCellType_Deserialize_System_Xml_XmlNodeReader_" data-uid="FarPoint.Web.Spread.ButtonCellType.Deserialize(System.Xml.XmlNodeReader)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.Deserialize.html#FarPoint_Web_Spread_ButtonCellType_Deserialize_System_Xml_XmlNodeReader_">Deserialize(XmlNodeReader)</a>
        </td>
        <td class="markdown level1 summary"><p>Loads the cell type from XML.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_GetEditorControl_System_String_System_Web_UI_WebControls_TableCell_FarPoint_Web_Spread_Appearance_FarPoint_Web_Spread_Inset_System_Object_System_Boolean_" data-uid="FarPoint.Web.Spread.ButtonCellType.GetEditorControl(System.String,System.Web.UI.WebControls.TableCell,FarPoint.Web.Spread.Appearance,FarPoint.Web.Spread.Inset,System.Object,System.Boolean)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.GetEditorControl.html#FarPoint_Web_Spread_ButtonCellType_GetEditorControl_System_String_System_Web_UI_WebControls_TableCell_FarPoint_Web_Spread_Appearance_FarPoint_Web_Spread_Inset_System_Object_System_Boolean_">GetEditorControl(string, TableCell, Appearance, Inset, object, bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the control used to edit the cell (and this implementation always returns null).</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_GetEditorValue_System_Web_UI_Control_System_String_" data-uid="FarPoint.Web.Spread.ButtonCellType.GetEditorValue(System.Web.UI.Control,System.String)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.GetEditorValue.html#FarPoint_Web_Spread_ButtonCellType_GetEditorValue_System_Web_UI_Control_System_String_">GetEditorValue(Control, string)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the value from the editor control for the cell.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_GetPreferredSize_System_Drawing_Graphics_System_Drawing_Size_FarPoint_Web_Spread_Appearance_System_Object_System_Single_System_Boolean_System_Boolean_" data-uid="FarPoint.Web.Spread.ButtonCellType.GetPreferredSize(System.Drawing.Graphics,System.Drawing.Size,FarPoint.Web.Spread.Appearance,System.Object,System.Single,System.Boolean,System.Boolean)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.GetPreferredSize.html#FarPoint_Web_Spread_ButtonCellType_GetPreferredSize_System_Drawing_Graphics_System_Drawing_Size_FarPoint_Web_Spread_Appearance_System_Object_System_Single_System_Boolean_System_Boolean_">GetPreferredSize(Graphics, Size, Appearance, object, float, bool, bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the preferred (maximum needed) size of the cell for the renderer control.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_PaintCell_FarPoint_PDF_PdfGraphics_System_Drawing_RectangleF_FarPoint_Web_Spread_Appearance_System_Object_System_Boolean_System_Boolean_System_Single_" data-uid="FarPoint.Web.Spread.ButtonCellType.PaintCell(FarPoint.PDF.PdfGraphics,System.Drawing.RectangleF,FarPoint.Web.Spread.Appearance,System.Object,System.Boolean,System.Boolean,System.Single)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.PaintCell.html#FarPoint_Web_Spread_ButtonCellType_PaintCell_FarPoint_PDF_PdfGraphics_System_Drawing_RectangleF_FarPoint_Web_Spread_Appearance_System_Object_System_Boolean_System_Boolean_System_Single_">PaintCell(PdfGraphics, RectangleF, Appearance, object, bool, bool, float)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a control and prints the cell to PDF based on the specified appearance and selection.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_PaintCell_System_String_System_Web_UI_WebControls_TableCell_FarPoint_Web_Spread_Appearance_FarPoint_Web_Spread_Inset_System_Object_System_Boolean_" data-uid="FarPoint.Web.Spread.ButtonCellType.PaintCell(System.String,System.Web.UI.WebControls.TableCell,FarPoint.Web.Spread.Appearance,FarPoint.Web.Spread.Inset,System.Object,System.Boolean)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.PaintCell.html#FarPoint_Web_Spread_ButtonCellType_PaintCell_System_String_System_Web_UI_WebControls_TableCell_FarPoint_Web_Spread_Appearance_FarPoint_Web_Spread_Inset_System_Object_System_Boolean_">PaintCell(string, TableCell, Appearance, Inset, object, bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a control and renders it in the cell based on the specified appearance, margin, and value.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_Parse_System_String_" data-uid="FarPoint.Web.Spread.ButtonCellType.Parse(System.String)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.Parse.html#FarPoint_Web_Spread_ButtonCellType_Parse_System_String_">Parse(string)</a>
        </td>
        <td class="markdown level1 summary"><p>When deriving a cell type based on this type, override this to change what gets parsed from the cell
on the sheet and put in the data model.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_Serialize_System_Xml_XmlTextWriter_" data-uid="FarPoint.Web.Spread.ButtonCellType.Serialize(System.Xml.XmlTextWriter)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.Serialize.html#FarPoint_Web_Spread_ButtonCellType_Serialize_System_Xml_XmlTextWriter_">Serialize(XmlTextWriter)</a>
        </td>
        <td class="markdown level1 summary"><p>Saves the cell type to XML.</p>
</td>
      </tr>
      <tr>
        <td id="FarPoint_Web_Spread_ButtonCellType_Serialize2_System_Xml_XmlTextWriter_" data-uid="FarPoint.Web.Spread.ButtonCellType.Serialize2(System.Xml.XmlTextWriter)">
          <a class="xref" href="FarPoint.Web.Spread.ButtonCellType.Serialize2.html#FarPoint_Web_Spread_ButtonCellType_Serialize2_System_Xml_XmlTextWriter_">Serialize2(XmlTextWriter)</a>
        </td>
        <td class="markdown level1 summary"><p>Saves the cell type to XML using short names.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>
