<div class="header-panel member">
<h2><span class="identifier">PdfFormatItemEventArgs</span> Class</h2>
<dl class="dl-horizontal">
<dt>File</dt><dd class="filename">wijmo.grid.pdf.js</dd>
<dt>Module</dt><dd><a href="topic/wijmo.grid.pdf.Module.html"><span class="identifier">wijmo.grid.pdf</span></a></dd>
</dl>
<div class="comment"><p>Represents arguments of the IFlexGridDrawSettings.formatItem callback.</p></div>
</div>
<div class="member-panel class members" ng-class="{ 'show-inherited' : ctx.showInherited, 'show-raisers' : ctx.showRaisers }">
<h3 class="node">Constructor</h3>
<ul>
<li class="mmethod"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#constructor">constructor</a></li>
</ul>
<h3 class="node">Properties</h3>
<ul>
<li class="mproperty"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#cancelBorders">cancelBorders</a></li>
<li class="mproperty"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#canvas">canvas</a></li>
<li class="mproperty"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#cell">cell</a></li>
<li class="mproperty"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#clientRect">clientRect</a></li>
<li class="mproperty"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#col">col</a></li>
<li class="mproperty"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#contentRect">contentRect</a></li>
<li class="mproperty"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#data">data</a></li>
<li class="mproperty"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#panel">panel</a></li>
<li class="mproperty"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#range">range</a></li>
<li class="mproperty"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#row">row</a></li>
<li class="mproperty"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#style">style</a></li>
<li class="mproperty"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#textTop">textTop</a></li>
</ul>
<h3 class="node">Methods</h3>
<ul>
<li class="mmethod"><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html/#getFormattedCell">getFormattedCell</a></li>
</ul>
</div>
<h3>Constructor</h3>
<div id="constructor" class="member-panel mmethod">
<h3>constructor</h3>
<pre>constructor(p: <span class="identifier">any /*_IGridPanel*/</span>, rng: <span class="identifier">any /*_ICellRange*/</span>, cell: <a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a>, canvas: <a href="topic/wijmo.pdf.PdfPageArea.Class.html"><span class="identifier">PdfPageArea</span></a>, clientRect: <a href="topic/wijmo.Rect.Class.html"><span class="identifier">Rect</span></a>, contentRect: <a href="topic/wijmo.Rect.Class.html"><span class="identifier">Rect</span></a>, textTop: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a>, style: <a href="topic/wijmo.grid.pdf.ICellStyle.Interface.html"><span class="identifier">ICellStyle</span></a>, getFormattedCell?: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Function" target="_blank"><span class="identifier">Function</span></a>): <a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html"><span class="identifier">PdfFormatItemEventArgs</span></a></pre>
<div class="comment"><p>Initializes a new instance of the <a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html"><span class="identifier">PdfFormatItemEventArgs</span></a> class.</p></div>
<dl class="dl-horizontal">
  <dt>Parameters</dt><dd></dd>
</dl>
<ul>
<li><b>p</b>: <span class="identifier">any /*_IGridPanel*/</span><br/><p><a href="topic/wijmo.grid.GridPanel.Class.html"><span class="identifier">GridPanel</span></a> that contains the range.</p></li><li><b>rng</b>: <span class="identifier">any /*_ICellRange*/</span><br/><p>Range of cells affected by the event.</p></li><li><b>cell</b>: <a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a><br/><p>Element that represents the grid cell to be rendered.</p></li><li><b>canvas</b>: <a href="topic/wijmo.pdf.PdfPageArea.Class.html"><span class="identifier">PdfPageArea</span></a><br/><p>Canvas to perform the custom painting on.</p></li><li><b>clientRect</b>: <a href="topic/wijmo.Rect.Class.html"><span class="identifier">Rect</span></a><br/><p>Object that represents the client rectangle of the grid cell to be rendered in canvas coordinates.</p></li><li><b>contentRect</b>: <a href="topic/wijmo.Rect.Class.html"><span class="identifier">Rect</span></a><br/><p>Object that represents the content rectangle of the grid cell to be rendered in canvas coordinates.</p></li><li><b>textTop</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a><br/><p>Object that represents the top position of the text in canvas coordinates.</p></li><li><b>style</b>: <a href="topic/wijmo.grid.pdf.ICellStyle.Interface.html"><span class="identifier">ICellStyle</span></a><br/><p>Object that represents the style of the grid cell to be rendered.</p></li><li><b>getFormattedCell</b>: <a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Function" target="_blank"><span class="identifier">Function</span></a> <span class="badge">Optional</span><br/><p>Callback function that should return the grid cell when the getFormattedCell method is called.</p></li></ul>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><a href="topic/wijmo.grid.pdf.PdfFormatItemEventArgs.Class.html"><span class="identifier">PdfFormatItemEventArgs</span></a></dd>
</dl>
</div>
<h3 class="node">Properties</h3>
<div class="member-list" ng-class="{ 'show-inherited' : ctx.showInherited, 'show-raisers' : ctx.showRaisers }">
<div id="cancelBorders" class="member-panel mproperty">
<h3>cancelBorders</h3>
<div class="comment"><p>Gets or sets a value that indicates that default cell borders drawing should be canceled.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank"><span class="identifier">boolean</span></a></dd>
</dl>
</div>
<div id="canvas" class="member-panel mproperty">
<h3>canvas</h3>
<div class="comment"><p>Gets the canvas to perform the custom painting on.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="topic/wijmo.pdf.PdfPageArea.Class.html"><span class="identifier">PdfPageArea</span></a></dd>
</dl>
</div>
<div id="cell" class="member-panel mproperty">
<h3>cell</h3>
<div class="comment"><p>Gets a reference to the element that represents the grid cell being rendered.
If IFlexGridDrawSettings.customCellContent is set to true then contains
reference to the element that represents the formatted grid cell; otherwise, a null value.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a></dd>
</dl>
</div>
<div id="clientRect" class="member-panel mproperty">
<h3>clientRect</h3>
<div class="comment"><p>Gets the client rectangle of the cell being rendered in canvas coordinates.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="topic/wijmo.Rect.Class.html"><span class="identifier">Rect</span></a></dd>
</dl>
</div>
<div id="col" class="member-panel mproperty">
<h3>col</h3>
<div class="comment"><p>Gets the column affected by this event.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a></dd>
</dl>
</div>
<div id="contentRect" class="member-panel mproperty">
<h3>contentRect</h3>
<div class="comment"><p>Gets the content rectangle of the cell being rendered in canvas coordinates.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="topic/wijmo.Rect.Class.html"><span class="identifier">Rect</span></a></dd>
</dl>
</div>
<div id="data" class="member-panel mproperty">
<h3>data</h3>
<div class="comment"><p>Gets or sets the data associated with the event.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><span class="identifier">any</span></dd>
</dl>
</div>
<div id="panel" class="member-panel mproperty">
<h3>panel</h3>
<div class="comment"><p>Gets the <a href="topic/wijmo.grid.GridPanel.Class.html"><span class="identifier">GridPanel</span></a> affected by this event.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="topic/wijmo.grid.GridPanel.Class.html"><span class="identifier">GridPanel</span></a></dd>
</dl>
</div>
<div id="range" class="member-panel mproperty">
<h3>range</h3>
<div class="comment"><p>Gets the <a href="topic/wijmo.grid.CellRange.Class.html"><span class="identifier">CellRange</span></a> affected by this event.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="topic/wijmo.grid.CellRange.Class.html"><span class="identifier">CellRange</span></a></dd>
</dl>
</div>
<div id="row" class="member-panel mproperty">
<h3>row</h3>
<div class="comment"><p>Gets the row affected by this event.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a></dd>
</dl>
</div>
<div id="style" class="member-panel mproperty">
<h3>style</h3>
<div class="comment"><p>Gets an object that represents the style of the cell being rendered.
If IFlexGridDrawSettings.customCellContent is set to true then the style is inferred
from the cell style; othwerwise it contains a combination of the IFlexGridDrawSettings.styles export
setting, according to the row type of exported cell.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="topic/wijmo.grid.pdf.ICellStyle.Interface.html"><span class="identifier">ICellStyle</span></a></dd>
</dl>
</div>
<div id="textTop" class="member-panel mproperty">
<h3>textTop</h3>
<div class="comment"><p>Gets the value that represents the top position of the text of the cell being rendered in canvas coordinates.</p></div>
<dl class="dl-horizontal">
  <dt>Type</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank"><span class="identifier">number</span></a></dd>
</dl>
</div>
</div>
<h3 class="node">Methods</h3>
<div class="member-list" ng-class="{ 'show-inherited' : ctx.showInherited, 'show-raisers' : ctx.showRaisers }">
<div id="getFormattedCell" class="member-panel mmethod">
<h3>getFormattedCell</h3>
<pre>getFormattedCell(): <a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a></pre>
<div class="comment"><p>Returns a reference to the element that represents the grid cell being rendered.
This method is useful when export of custom formatting is disabled, but you need
to export custom content for certain cells.</p></div>
<dl class="dl-horizontal">
  <dt>Returns</dt><dd><a href="https://developer.mozilla.org/en/docs/Web/API/HTMLElement" target="_blank"><span class="identifier">HTMLElement</span></a></dd>
</dl>
</div>
</div>
