# C1.PivotEngine.PivotField

## Content

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



  <h1 id="C1_PivotEngine_PivotField" data-uid="C1.PivotEngine.PivotField" class="text-break">PivotField Class
</h1>
  <div class="markdown level0 summary"><p>Represents a property of the items in the data source.</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">PivotField</span></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.inotifypropertychanged">INotifyPropertyChanged</a></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="C1.PivotEngine.html">C1.PivotEngine</a></h6>
  <h6><strong>Assembly</strong>: C1.PivotEngine.dll</h6>
  <h5 id="C1_PivotEngine_PivotField_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class PivotField : INotifyPropertyChanged</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class PivotField
    Implements INotifyPropertyChanged</code></pre>
  </div>
  <h5 id="C1_PivotEngine_PivotField_remarks"><strong>Remarks</strong></h5>
  <div class="markdown level0 remarks"><p><a class="xref" href="C1.PivotEngine.PivotField.html">PivotField</a> objects represent 'dimensions' in 
the output FlexPivot table.</p>
<p>Each row and column on the output table is uniquely identified 
by a <a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a> object. These objects contain a list
of <a class="xref" href="C1.PivotEngine.PivotField.html">PivotField</a> objects and specific values.</p>
</div>
  <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_PivotEngine_PivotField_Caption" data-uid="C1.PivotEngine.PivotField.Caption">
          <a class="xref" href="C1.PivotEngine.PivotField.Caption.html#C1_PivotEngine_PivotField_Caption">Caption</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a string to be displayed in the user interface.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_Expression" data-uid="C1.PivotEngine.PivotField.Expression">
          <a class="xref" href="C1.PivotEngine.PivotField.Expression.html#C1_PivotEngine_PivotField_Expression">Expression</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the expression in case the field is a Calculated field.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_Filter" data-uid="C1.PivotEngine.PivotField.Filter">
          <a class="xref" href="C1.PivotEngine.PivotField.Filter.html#C1_PivotEngine_PivotField_Filter">Filter</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the filter used to select field values.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_Format" data-uid="C1.PivotEngine.PivotField.Format">
          <a class="xref" href="C1.PivotEngine.PivotField.Format.html#C1_PivotEngine_PivotField_Format">Format</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the format to use when displaying field values.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_IsActive" data-uid="C1.PivotEngine.PivotField.IsActive">
          <a class="xref" href="C1.PivotEngine.PivotField.IsActive.html#C1_PivotEngine_PivotField_IsActive">IsActive</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets whether this field is active in the FlexPivot view.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_Key" data-uid="C1.PivotEngine.PivotField.Key">
          <a class="xref" href="C1.PivotEngine.PivotField.Key.html#C1_PivotEngine_PivotField_Key">Key</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a key that uniquely identifies the field in a collection.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_Lookup" data-uid="C1.PivotEngine.PivotField.Lookup">
          <a class="xref" href="C1.PivotEngine.PivotField.Lookup.html#C1_PivotEngine_PivotField_Lookup">Lookup</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.idictionary">IDictionary</a> that contains lookup values for this field.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_Name" data-uid="C1.PivotEngine.PivotField.Name">
          <a class="xref" href="C1.PivotEngine.PivotField.Name.html#C1_PivotEngine_PivotField_Name">Name</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the name of the field source column.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_ParentList" data-uid="C1.PivotEngine.PivotField.ParentList">
          <a class="xref" href="C1.PivotEngine.PivotField.ParentList.html#C1_PivotEngine_PivotField_ParentList">ParentList</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="C1.PivotEngine.PivotFieldList.html">PivotFieldList</a> that contains this field.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_PivotEngine" data-uid="C1.PivotEngine.PivotField.PivotEngine">
          <a class="xref" href="C1.PivotEngine.PivotField.PivotEngine.html#C1_PivotEngine_PivotField_PivotEngine">PivotEngine</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="C1.PivotEngine.C1PivotEngine.html">C1PivotEngine</a> that owns this field.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_Range" data-uid="C1.PivotEngine.PivotField.Range">
          <a class="xref" href="C1.PivotEngine.PivotField.Range.html#C1_PivotEngine_PivotField_Range">Range</a>
        </td>
        <td class="markdown level1 summary"><p>Provides the <a class="xref" href="C1.PivotEngine.RangeInfo.html">RangeInfo</a> used to group values by a criteria.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_ShowAs" data-uid="C1.PivotEngine.PivotField.ShowAs">
          <a class="xref" href="C1.PivotEngine.PivotField.ShowAs.html#C1_PivotEngine_PivotField_ShowAs">ShowAs</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets how the field results should be formatted.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_Style" data-uid="C1.PivotEngine.PivotField.Style">
          <a class="xref" href="C1.PivotEngine.PivotField.Style.html#C1_PivotEngine_PivotField_Style">Style</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="C1.PivotEngine.PivotFieldStyle.html">PivotFieldStyle</a> used to display the field values on the grid.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_StyleHigh" data-uid="C1.PivotEngine.PivotField.StyleHigh">
          <a class="xref" href="C1.PivotEngine.PivotField.StyleHigh.html#C1_PivotEngine_PivotField_StyleHigh">StyleHigh</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="C1.PivotEngine.PivotConditionalFieldStyle.html">PivotConditionalFieldStyle</a> used to display high values.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_StyleLow" data-uid="C1.PivotEngine.PivotField.StyleLow">
          <a class="xref" href="C1.PivotEngine.PivotField.StyleLow.html#C1_PivotEngine_PivotField_StyleLow">StyleLow</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="C1.PivotEngine.PivotConditionalFieldStyle.html">PivotConditionalFieldStyle</a> used to display low values.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_Subtotal" data-uid="C1.PivotEngine.PivotField.Subtotal">
          <a class="xref" href="C1.PivotEngine.PivotField.Subtotal.html#C1_PivotEngine_PivotField_Subtotal">Subtotal</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the type of subtotal to use when combining field values.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_Type" data-uid="C1.PivotEngine.PivotField.Type">
          <a class="xref" href="C1.PivotEngine.PivotField.Type.html#C1_PivotEngine_PivotField_Type">Type</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the type of the field source column.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_WeightField" data-uid="C1.PivotEngine.PivotField.WeightField">
          <a class="xref" href="C1.PivotEngine.PivotField.WeightField.html#C1_PivotEngine_PivotField_WeightField">WeightField</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the <a class="xref" href="C1.PivotEngine.PivotField.html">PivotField</a> used as a weight for calculating
subtotals on this field.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_Width" data-uid="C1.PivotEngine.PivotField.Width">
          <a class="xref" href="C1.PivotEngine.PivotField.Width.html#C1_PivotEngine_PivotField_Width">Width</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the preferred width to be used for showing the field in the user interface.</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_PivotEngine_PivotField_GetUniqueValues" data-uid="C1.PivotEngine.PivotField.GetUniqueValues">
          <a class="xref" href="C1.PivotEngine.PivotField.GetUniqueValues.html#C1_PivotEngine_PivotField_GetUniqueValues">GetUniqueValues()</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a list of unique values found in the data source for this field.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_OnPropertyChanged_System_ComponentModel_PropertyChangedEventArgs_" data-uid="C1.PivotEngine.PivotField.OnPropertyChanged(System.ComponentModel.PropertyChangedEventArgs)">
          <a class="xref" href="C1.PivotEngine.PivotField.OnPropertyChanged.html#C1_PivotEngine_PivotField_OnPropertyChanged_System_ComponentModel_PropertyChangedEventArgs_">OnPropertyChanged(PropertyChangedEventArgs)</a>
        </td>
        <td class="markdown level1 summary"><p>Raises the <a class="xref" href="C1.PivotEngine.PivotField.PropertyChanged.html">PropertyChanged</a> event.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_ReadXml_System_Xml_XmlReader_" data-uid="C1.PivotEngine.PivotField.ReadXml(System.Xml.XmlReader)">
          <a class="xref" href="C1.PivotEngine.PivotField.ReadXml.html#C1_PivotEngine_PivotField_ReadXml_System_Xml_XmlReader_">ReadXml(XmlReader)</a>
        </td>
        <td class="markdown level1 summary"><p>Reads the field from an <span class="xref">System.Xml.XmlReader</span>.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_ToString" data-uid="C1.PivotEngine.PivotField.ToString">
          <a class="xref" href="C1.PivotEngine.PivotField.ToString.html#C1_PivotEngine_PivotField_ToString">ToString()</a>
        </td>
        <td class="markdown level1 summary"></td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_WriteAttributes_System_Xml_XmlWriter_" data-uid="C1.PivotEngine.PivotField.WriteAttributes(System.Xml.XmlWriter)">
          <a class="xref" href="C1.PivotEngine.PivotField.WriteAttributes.html#C1_PivotEngine_PivotField_WriteAttributes_System_Xml_XmlWriter_">WriteAttributes(XmlWriter)</a>
        </td>
        <td class="markdown level1 summary"><p>Saves addition attributes of the field into an <span class="xref">System.Xml.XmlWriter</span>.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotField_WriteXml_System_Xml_XmlWriter_" data-uid="C1.PivotEngine.PivotField.WriteXml(System.Xml.XmlWriter)">
          <a class="xref" href="C1.PivotEngine.PivotField.WriteXml.html#C1_PivotEngine_PivotField_WriteXml_System_Xml_XmlWriter_">WriteXml(XmlWriter)</a>
        </td>
        <td class="markdown level1 summary"><p>Saves the field into an <span class="xref">System.Xml.XmlWriter</span>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="events">Events
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="C1_PivotEngine_PivotField_PropertyChanged" data-uid="C1.PivotEngine.PivotField.PropertyChanged">
          <a class="xref" href="C1.PivotEngine.PivotField.PropertyChanged.html">PropertyChanged</a>
        </td>
        <td class="markdown level1 summary"><p>Fires when a property changes.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="operators">Operators
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="C1_PivotEngine_PivotField_op_Implicit_C1_PivotEngine_PivotField__C1_FlexPivot_C1FlexPivotField" data-uid="C1.PivotEngine.PivotField.op_Implicit(C1.PivotEngine.PivotField)~C1.FlexPivot.C1FlexPivotField">
          <a class="xref" href="C1.PivotEngine.PivotField.op_Implicit.html#C1_PivotEngine_PivotField_op_Implicit_C1_PivotEngine_PivotField__C1_FlexPivot_C1FlexPivotField">implicit operator C1FlexPivotField(PivotField)</a>
        </td>
        <td class="markdown level1 summary"></td>
      </tr>
    </tbody>
  </table>

</div>