blob: 77df5c39ec5c6b7710b52fa7f9dedf39cca1abb0 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class Showing
| Apache Lucene.NET 4.8.0 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Showing
| Apache Lucene.NET 4.8.0 Documentation ">
<meta name="generator" content="docfx 2.47.0.0">
<link rel="shortcut icon" href="../../logo/favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">
<meta property="docfx:rel" content="../../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../logo/lucene-net-color.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Lucene.Net.Support.C5.Showing">
<h1 id="Lucene_Net_Support_C5_Showing" data-uid="Lucene.Net.Support.C5.Showing" class="text-break">Class Showing
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">Showing</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Support.C5.html">Lucene.Net.Support.C5</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Support_C5_Showing_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Serializable]
public static class Showing</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_Showing_Show_System_Object_System_Text_StringBuilder_System_Int32__System_IFormatProvider_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.Showing.Show(System.Object%2CSystem.Text.StringBuilder%2CSystem.Int32%40%2CSystem.IFormatProvider)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/C5.Support.cs/#L4780">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_Showing_Show_" data-uid="Lucene.Net.Support.C5.Showing.Show*"></a>
<h4 id="Lucene_Net_Support_C5_Showing_Show_System_Object_System_Text_StringBuilder_System_Int32__System_IFormatProvider_" data-uid="Lucene.Net.Support.C5.Showing.Show(System.Object,System.Text.StringBuilder,System.Int32@,System.IFormatProvider)">Show(Object, StringBuilder, ref Int32, IFormatProvider)</h4>
<div class="markdown level1 summary"><p>Show <pre><code>Object obj</code></pre> by appending it to <pre><code>stringbuilder</code></pre></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool Show(object obj, StringBuilder stringbuilder, ref int rest, IFormatProvider formatProvider)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Object</span></td>
<td><span class="parametername">obj</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Text.StringBuilder</span></td>
<td><span class="parametername">stringbuilder</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">rest</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.IFormatProvider</span></td>
<td><span class="parametername">formatProvider</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>True if <pre><code>obj</code></pre> was shown completely.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_Showing_ShowCollectionValue__1_Lucene_Net_Support_C5_ICollectionValue___0__System_Text_StringBuilder_System_Int32__System_IFormatProvider_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.Showing.ShowCollectionValue%60%601(Lucene.Net.Support.C5.ICollectionValue%7B%60%600%7D%2CSystem.Text.StringBuilder%2CSystem.Int32%40%2CSystem.IFormatProvider)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/C5.Support.cs/#L4835">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_Showing_ShowCollectionValue_" data-uid="Lucene.Net.Support.C5.Showing.ShowCollectionValue*"></a>
<h4 id="Lucene_Net_Support_C5_Showing_ShowCollectionValue__1_Lucene_Net_Support_C5_ICollectionValue___0__System_Text_StringBuilder_System_Int32__System_IFormatProvider_" data-uid="Lucene.Net.Support.C5.Showing.ShowCollectionValue``1(Lucene.Net.Support.C5.ICollectionValue{``0},System.Text.StringBuilder,System.Int32@,System.IFormatProvider)">ShowCollectionValue&lt;T&gt;(ICollectionValue&lt;T&gt;, StringBuilder, ref Int32, IFormatProvider)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool ShowCollectionValue&lt;T&gt;(ICollectionValue&lt;T&gt; items, StringBuilder stringbuilder, ref int rest, IFormatProvider formatProvider)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html">ICollectionValue</a>&lt;T&gt;</td>
<td><span class="parametername">items</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Text.StringBuilder</span></td>
<td><span class="parametername">stringbuilder</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">rest</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.IFormatProvider</span></td>
<td><span class="parametername">formatProvider</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>True if collection was shown completely</p>
</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_Showing_ShowDictionary__2_Lucene_Net_Support_C5_IDictionary___0___1__System_Text_StringBuilder_System_Int32__System_IFormatProvider_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.Showing.ShowDictionary%60%602(Lucene.Net.Support.C5.IDictionary%7B%60%600%2C%60%601%7D%2CSystem.Text.StringBuilder%2CSystem.Int32%40%2CSystem.IFormatProvider)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/C5.Support.cs/#L4933">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_Showing_ShowDictionary_" data-uid="Lucene.Net.Support.C5.Showing.ShowDictionary*"></a>
<h4 id="Lucene_Net_Support_C5_Showing_ShowDictionary__2_Lucene_Net_Support_C5_IDictionary___0___1__System_Text_StringBuilder_System_Int32__System_IFormatProvider_" data-uid="Lucene.Net.Support.C5.Showing.ShowDictionary``2(Lucene.Net.Support.C5.IDictionary{``0,``1},System.Text.StringBuilder,System.Int32@,System.IFormatProvider)">ShowDictionary&lt;K, V&gt;(IDictionary&lt;K, V&gt;, StringBuilder, ref Int32, IFormatProvider)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool ShowDictionary&lt;K, V&gt;(IDictionary&lt;K, V&gt; dictionary, StringBuilder stringbuilder, ref int rest, IFormatProvider formatProvider)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.IDictionary-2.html">IDictionary</a>&lt;K, V&gt;</td>
<td><span class="parametername">dictionary</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Text.StringBuilder</span></td>
<td><span class="parametername">stringbuilder</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">rest</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.IFormatProvider</span></td>
<td><span class="parametername">formatProvider</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">K</span></td>
<td></td>
</tr>
<tr>
<td><span class="parametername">V</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_Showing_ShowString_Lucene_Net_Support_C5_IShowable_System_String_System_IFormatProvider_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.Showing.ShowString(Lucene.Net.Support.C5.IShowable%2CSystem.String%2CSystem.IFormatProvider)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/C5.Support.cs/#L4800">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_Showing_ShowString_" data-uid="Lucene.Net.Support.C5.Showing.ShowString*"></a>
<h4 id="Lucene_Net_Support_C5_Showing_ShowString_Lucene_Net_Support_C5_IShowable_System_String_System_IFormatProvider_" data-uid="Lucene.Net.Support.C5.Showing.ShowString(Lucene.Net.Support.C5.IShowable,System.String,System.IFormatProvider)">ShowString(IShowable, String, IFormatProvider)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string ShowString(IShowable showable, string format, IFormatProvider formatProvider)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.IShowable.html">IShowable</a></td>
<td><span class="parametername">showable</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">format</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.IFormatProvider</span></td>
<td><span class="parametername">formatProvider</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_Showing.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.Showing%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/C5.Support.cs/#L4768" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © 2020 Licensed to the Apache Software Foundation (ASF)
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>