blob: 8dc253a2eabd0b36c5736e8a3d2e668cf2f9252d [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 PatternReplaceCharFilter
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class PatternReplaceCharFilter
| Apache Lucene.NET 4.8.0-beta00010 Documentation ">
<meta name="generator" content="docfx 2.56.0.0">
<link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="analysis-common/toc.html">
<meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/">
</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="/">
<img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/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">
<ul class="level0 breadcrumb">
<li>
<a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a>
<span id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</span>
</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.Analysis.Pattern.PatternReplaceCharFilter">
<h1 id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter" data-uid="Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter" class="text-break">Class PatternReplaceCharFilter
</h1>
<div class="markdown level0 summary"><p><span class="xref">Lucene.Net.Analysis.CharFilter</span> that uses a regular expression for the target of replace string.
The pattern match will be done in each &quot;block&quot; in char stream.</p>
<p>
ex1) source=&quot;aa bb aa bb&quot;, pattern=&quot;(aa)\s+(bb)&quot; replacement=&quot;$1#$2&quot;
output=&quot;aa#bb aa#bb&quot;
</p>
<p>NOTE: If you produce a phrase that has different length to source string
and the field is used for highlighting for a term of the phrase, you will
face a trouble.</p>
<p>
ex2) source=&quot;aa123bb&quot;, pattern=&quot;(aa)\d+(bb)&quot; replacement=&quot;$1 $2&quot;
output=&quot;aa bb&quot;
and you want to search bb and highlight it, you will get
highlight snippet=&quot;aa1&lt;em&gt;23bb&lt;/em&gt;&quot;
</p>
<p>@since Solr 1.5</p>
</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">System.MarshalByRefObject</span></div>
<div class="level2"><span class="xref">System.IO.TextReader</span></div>
<div class="level3"><span class="xref">Lucene.Net.Analysis.CharFilter</span></div>
<div class="level4"><a class="xref" href="Lucene.Net.Analysis.CharFilters.BaseCharFilter.html">BaseCharFilter</a></div>
<div class="level5"><span class="xref">PatternReplaceCharFilter</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Analysis.CharFilters.BaseCharFilter.html#Lucene_Net_Analysis_CharFilters_BaseCharFilter_LastCumulativeDiff">BaseCharFilter.LastCumulativeDiff</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Analysis.CharFilters.BaseCharFilter.html#Lucene_Net_Analysis_CharFilters_BaseCharFilter_AddOffCorrectMap_System_Int32_System_Int32_">BaseCharFilter.AddOffCorrectMap(Int32, Int32)</a>
</div>
<div>
<span class="xref">Lucene.Net.Analysis.CharFilter.m_input</span>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Dispose_System_Boolean_">CharFilter.Dispose(Boolean)</a>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_CorrectOffset_System_Int32_">CharFilter.CorrectOffset(Int32)</a>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Skip_System_Int32_">CharFilter.Skip(Int32)</a>
</div>
<div>
<span class="xref">Lucene.Net.Analysis.CharFilter.Reset()</span>
</div>
<div>
<span class="xref">Lucene.Net.Analysis.CharFilter.IsReady</span>
</div>
<div>
<span class="xref">Lucene.Net.Analysis.CharFilter.IsMarkSupported</span>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Mark_System_Int32_">CharFilter.Mark(Int32)</a>
</div>
<div>
<span class="xref">System.IO.TextReader.Null</span>
</div>
<div>
<span class="xref">System.IO.TextReader.Close()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.Dispose()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.Peek()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadAsync(System.Char[], System.Int32, System.Int32)</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadBlock(System.Char[], System.Int32, System.Int32)</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadBlockAsync(System.Char[], System.Int32, System.Int32)</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadLine()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadLineAsync()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadToEnd()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.ReadToEndAsync()</span>
</div>
<div>
<span class="xref">System.IO.TextReader.Synchronized(System.IO.TextReader)</span>
</div>
<div>
<span class="xref">System.MarshalByRefObject.GetLifetimeService()</span>
</div>
<div>
<span class="xref">System.MarshalByRefObject.InitializeLifetimeService()</span>
</div>
<div>
<span class="xref">System.MarshalByRefObject.MemberwiseClone(System.Boolean)</span>
</div>
<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.Analysis.Pattern.html">Lucene.Net.Analysis.Pattern</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6>
<h5 id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class PatternReplaceCharFilter : BaseCharFilter, IDisposable</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter__ctor_System_Text_RegularExpressions_Regex_System_String_System_Int32_System_String_System_IO_TextReader_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.%23ctor(System.Text.RegularExpressions.Regex%2CSystem.String%2CSystem.Int32%2CSystem.String%2CSystem.IO.TextReader)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Pattern/PatternReplaceCharFilter.cs/#L64">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter__ctor_" data-uid="Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter__ctor_System_Text_RegularExpressions_Regex_System_String_System_Int32_System_String_System_IO_TextReader_" data-uid="Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.#ctor(System.Text.RegularExpressions.Regex,System.String,System.Int32,System.String,System.IO.TextReader)">PatternReplaceCharFilter(Regex, String, Int32, String, TextReader)</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">[Obsolete]
public PatternReplaceCharFilter(Regex pattern, string replacement, int maxBlockChars, string blockDelimiter, TextReader in)</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.Text.RegularExpressions.Regex</span></td>
<td><span class="parametername">pattern</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">replacement</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">maxBlockChars</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">blockDelimiter</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.IO.TextReader</span></td>
<td><span class="parametername">in</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter__ctor_System_Text_RegularExpressions_Regex_System_String_System_IO_TextReader_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.%23ctor(System.Text.RegularExpressions.Regex%2CSystem.String%2CSystem.IO.TextReader)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Pattern/PatternReplaceCharFilter.cs/#L57">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter__ctor_" data-uid="Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter__ctor_System_Text_RegularExpressions_Regex_System_String_System_IO_TextReader_" data-uid="Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.#ctor(System.Text.RegularExpressions.Regex,System.String,System.IO.TextReader)">PatternReplaceCharFilter(Regex, String, TextReader)</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 PatternReplaceCharFilter(Regex pattern, string replacement, TextReader in)</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.Text.RegularExpressions.Regex</span></td>
<td><span class="parametername">pattern</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">replacement</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.IO.TextReader</span></td>
<td><span class="parametername">in</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter_DEFAULT_MAX_BLOCK_CHARS.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.DEFAULT_MAX_BLOCK_CHARS%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Pattern/PatternReplaceCharFilter.cs/#L51">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter_DEFAULT_MAX_BLOCK_CHARS" data-uid="Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.DEFAULT_MAX_BLOCK_CHARS">DEFAULT_MAX_BLOCK_CHARS</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">[Obsolete]
public const int DEFAULT_MAX_BLOCK_CHARS = 10000</code></pre>
</div>
<h5 class="fieldValue">Field Value</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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter_Correct_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.Correct(System.Int32)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Pattern/PatternReplaceCharFilter.cs/#L102">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter_Correct_" data-uid="Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.Correct*"></a>
<h4 id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter_Correct_System_Int32_" data-uid="Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.Correct(System.Int32)">Correct(Int32)</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">protected override int Correct(int currentOff)</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.Int32</span></td>
<td><span class="parametername">currentOff</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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Analysis.CharFilters.BaseCharFilter.html#Lucene_Net_Analysis_CharFilters_BaseCharFilter_Correct_System_Int32_">BaseCharFilter.Correct(Int32)</a></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter_Read.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.Read%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Pattern/PatternReplaceCharFilter.cs/#L92">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter_Read_" data-uid="Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.Read*"></a>
<h4 id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter_Read" data-uid="Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.Read">Read()</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 override int Read()</code></pre>
</div>
<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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Analysis.CharFilter.Read()</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter_Read_System_Char___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.Read(System.Char%5B%5D%2CSystem.Int32%2CSystem.Int32)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Pattern/PatternReplaceCharFilter.cs/#L70">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter_Read_" data-uid="Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.Read*"></a>
<h4 id="Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter_Read_System_Char___System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter.Read(System.Char[],System.Int32,System.Int32)">Read(Char[], Int32, Int32)</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 override int Read(char[] cbuf, int off, int len)</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.Char</span>[]</td>
<td><span class="parametername">cbuf</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">off</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">len</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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Read_System_Char___System_Int32_System_Int32_">CharFilter.Read(Char[], Int32, Int32)</a></div>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
</div>
</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Pattern_PatternReplaceCharFilter.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Pattern.PatternReplaceCharFilter%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/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Pattern/PatternReplaceCharFilter.cs/#L48" 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="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script>
</body>
</html>