# C1.PivotEngine.PivotKey.MatchesKey

## Content

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



<h1 id="C1_PivotEngine_PivotKey_MatchesKey_" data-uid="C1.PivotEngine.PivotKey.MatchesKey*">MatchesKey Method
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>



<a id="C1_PivotEngine_PivotKey_MatchesKey_" data-uid="C1.PivotEngine.PivotKey.MatchesKey*"></a>
<h4 id="C1_PivotEngine_PivotKey_MatchesKey_C1_PivotEngine_PivotKey_" data-uid="C1.PivotEngine.PivotKey.MatchesKey(C1.PivotEngine.PivotKey)">MatchesKey(PivotKey)</h4>
<div 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>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
  <pre><code class="lang-csharp hljs">public bool MatchesKey(PivotKey key)</code></pre>
</div>
<div class="codewrapper">
  <pre><code class="lang-vbnet hljs">Public Function MatchesKey(key As PivotKey) As Boolean</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Name</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a></td>
      <td><span class="parametername">key</span></td>
      <td><p>The <a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a> to be used for comparison.</p>
</td>
    </tr>
  </tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
      <td><p>True if the <code class="paramref">key</code> partially matches this
<a class="xref" href="C1.PivotEngine.PivotKey.html">PivotKey</a>.</p>
</td>
    </tr>
  </tbody>
</table>
<h5 id="C1_PivotEngine_PivotKey_MatchesKey_C1_PivotEngine_PivotKey__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>The match is determined by comparing the formatted values for each
<a class="xref" href="C1.PivotEngine.PivotField.html">PivotField</a> in the key to the formatted values in the
<code class="paramref">key</code>. Therefore, matches may occur even if the raw 
values are different.</p>
</div>
</div>