# C1.PivotEngine.PivotKey

## Content

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



  <h1 id="C1_PivotEngine_PivotKey" data-uid="C1.PivotEngine.PivotKey" class="text-break">PivotKey Class
</h1>
  <div class="markdown level0 summary"><p>Represents a combination of <a class="xref" href="C1.PivotEngine.PivotField.html">PivotField</a> objects and their values.</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">PivotKey</span></div>
      <div class="level2"><a class="xref" href="C1.FlexPivot.C1FlexPivotKey.html">C1FlexPivotKey</a></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.icomparable">IComparable</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_PivotKey_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class PivotKey : IComparable</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class PivotKey
    Implements IComparable</code></pre>
  </div>
  <h5 id="C1_PivotEngine_PivotKey_remarks"><strong>Remarks</strong></h5>
  <div class="markdown level0 remarks"><p>Each row and column on the output FlexPivot table is defined by a unique
<a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a>. The values in the table cells represent an aggregation
of the value field for all items that match the row and column keys.</p>
<p>For example, if a column key is set to 'Country:UK;Customer:Joe' and 
the row key is set to 'Category:Desserts;Product:Pie', then the corresponding 
cell contains the aggregate for all items with the following properties:
'Country:UK;Customer:Joe;Category:Desserts;Product:Pie'.</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_PivotKey_Fields" data-uid="C1.PivotEngine.PivotKey.Fields">
          <a class="xref" href="C1.PivotEngine.PivotKey.Fields.html#C1_PivotEngine_PivotKey_Fields">Fields</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the list of <a class="xref" href="C1.PivotEngine.PivotField.html">PivotField</a> pivot fields associated with this
<a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a>.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotKey_ValueField" data-uid="C1.PivotEngine.PivotKey.ValueField">
          <a class="xref" href="C1.PivotEngine.PivotKey.ValueField.html#C1_PivotEngine_PivotKey_ValueField">ValueField</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <a class="xref" href="C1.PivotEngine.PivotField.html">PivotField</a> that represents the value field
associated with this <a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a>.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotKey_Values" data-uid="C1.PivotEngine.PivotKey.Values">
          <a class="xref" href="C1.PivotEngine.PivotKey.Values.html#C1_PivotEngine_PivotKey_Values">Values</a>
        </td>
        <td class="markdown level1 summary"><p>Gets an array of values for the <a class="xref" href="C1.PivotEngine.PivotField.html">PivotField</a> pivot fields
associated with this <a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a>.</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_PivotKey_Equals_System_Object_" data-uid="C1.PivotEngine.PivotKey.Equals(System.Object)">
          <a class="xref" href="C1.PivotEngine.PivotKey.Equals.html#C1_PivotEngine_PivotKey_Equals_System_Object_">Equals(object)</a>
        </td>
        <td class="markdown level1 summary"><p>Returns true if two <a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a> objects represent the
same set of <a class="xref" href="C1.PivotEngine.PivotField.html">PivotField</a> objects and values.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotKey_GetFormattedValue_System_Int32_" data-uid="C1.PivotEngine.PivotKey.GetFormattedValue(System.Int32)">
          <a class="xref" href="C1.PivotEngine.PivotKey.GetFormattedValue.html#C1_PivotEngine_PivotKey_GetFormattedValue_System_Int32_">GetFormattedValue(int)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a formatted value from the <a class="xref" href="C1.PivotEngine.PivotKey.Values.html#C1_PivotEngine_PivotKey_Values">Values</a> array.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotKey_GetFormattedValue_System_Int32_System_Object_" data-uid="C1.PivotEngine.PivotKey.GetFormattedValue(System.Int32,System.Object)">
          <a class="xref" href="C1.PivotEngine.PivotKey.GetFormattedValue.html#C1_PivotEngine_PivotKey_GetFormattedValue_System_Int32_System_Object_">GetFormattedValue(int, object)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a formatted value from the <a class="xref" href="C1.PivotEngine.PivotKey.Values.html#C1_PivotEngine_PivotKey_Values">Values</a> array.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotKey_GetHashCode" data-uid="C1.PivotEngine.PivotKey.GetHashCode">
          <a class="xref" href="C1.PivotEngine.PivotKey.GetHashCode.html#C1_PivotEngine_PivotKey_GetHashCode">GetHashCode()</a>
        </td>
        <td class="markdown level1 summary"><p>Serves as a hash function for a <a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a> object.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotKey_MatchesItem_System_Object_" data-uid="C1.PivotEngine.PivotKey.MatchesItem(System.Object)">
          <a class="xref" href="C1.PivotEngine.PivotKey.MatchesItem.html#C1_PivotEngine_PivotKey_MatchesItem_System_Object_">MatchesItem(object)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value that determines whether a given data object matches the
content of this <a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a>.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotKey_MatchesKey_C1_PivotEngine_PivotKey_" data-uid="C1.PivotEngine.PivotKey.MatchesKey(C1.PivotEngine.PivotKey)">
          <a class="xref" href="C1.PivotEngine.PivotKey.MatchesKey.html#C1_PivotEngine_PivotKey_MatchesKey_C1_PivotEngine_PivotKey_">MatchesKey(PivotKey)</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value that indicates whether this <a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a>
partially matches the content of another key.</p>
</td>
      </tr>
      <tr>
        <td id="C1_PivotEngine_PivotKey_ToString" data-uid="C1.PivotEngine.PivotKey.ToString">
          <a class="xref" href="C1.PivotEngine.PivotKey.ToString.html#C1_PivotEngine_PivotKey_ToString">ToString()</a>
        </td>
        <td class="markdown level1 summary"><p>Returns a string that represents this <a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a>.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>