| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class EscapeQuerySyntax |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class EscapeQuerySyntax |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation "> |
| <meta name="generator" content="docfx 2.56.2.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="queryparser/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"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <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.QueryParsers.Flexible.Standard.Parser.EscapeQuerySyntax"> |
| |
| |
| <h1 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_EscapeQuerySyntax" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.EscapeQuerySyntax" class="text-break">Class EscapeQuerySyntax |
| </h1> |
| <div class="markdown level0 summary"><p>Implementation of <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Parser.IEscapeQuerySyntax.html">IEscapeQuerySyntax</a> for the standard lucene |
| syntax.</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">EscapeQuerySyntax</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Parser.IEscapeQuerySyntax.html">IEscapeQuerySyntax</a></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.QueryParsers.Flexible.Standard.Parser.html">Lucene.Net.QueryParsers.Flexible.Standard.Parser</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.QueryParser.dll</h6> |
| <h5 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_EscapeQuerySyntax_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class EscapeQuerySyntax : IEscapeQuerySyntax</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_EscapeQuerySyntax_DiscardEscapeChar_System_String_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.EscapeQuerySyntax.DiscardEscapeChar(System.String)%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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/EscapeQuerySyntaxImpl.cs/#L249">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_EscapeQuerySyntax_DiscardEscapeChar_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.EscapeQuerySyntax.DiscardEscapeChar*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_EscapeQuerySyntax_DiscardEscapeChar_System_String_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.EscapeQuerySyntax.DiscardEscapeChar(System.String)">DiscardEscapeChar(String)</h4> |
| <div class="markdown level1 summary"><p>Returns a string where the escape char has been removed, or kept only once |
| if there was a double escape. |
| <p> |
| Supports escaped unicode characters, e. g. translates <code>A</code> to |
| <code>A</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static UnescapedCharSequence DiscardEscapeChar(string input)</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.String</span></td> |
| <td><span class="parametername">input</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><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Util.UnescapedCharSequence.html">UnescapedCharSequence</a></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_EscapeQuerySyntax_Escape_J2N_Text_ICharSequence_System_Globalization_CultureInfo_Lucene_Net_QueryParsers_Flexible_Core_Parser_EscapeQuerySyntaxType_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.EscapeQuerySyntax.Escape(J2N.Text.ICharSequence%2CSystem.Globalization.CultureInfo%2CLucene.Net.QueryParsers.Flexible.Core.Parser.EscapeQuerySyntaxType)%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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/EscapeQuerySyntaxImpl.cs/#L214">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_EscapeQuerySyntax_Escape_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.EscapeQuerySyntax.Escape*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_EscapeQuerySyntax_Escape_J2N_Text_ICharSequence_System_Globalization_CultureInfo_Lucene_Net_QueryParsers_Flexible_Core_Parser_EscapeQuerySyntaxType_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.EscapeQuerySyntax.Escape(J2N.Text.ICharSequence,System.Globalization.CultureInfo,Lucene.Net.QueryParsers.Flexible.Core.Parser.EscapeQuerySyntaxType)">Escape(ICharSequence, CultureInfo, EscapeQuerySyntaxType)</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 virtual ICharSequence Escape(ICharSequence text, CultureInfo locale, EscapeQuerySyntaxType type)</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">J2N.Text.ICharSequence</span></td> |
| <td><span class="parametername">text</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Globalization.CultureInfo</span></td> |
| <td><span class="parametername">locale</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Parser.EscapeQuerySyntaxType.html">EscapeQuerySyntaxType</a></td> |
| <td><span class="parametername">type</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">J2N.Text.ICharSequence</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_EscapeQuerySyntax_Escape_System_String_System_Globalization_CultureInfo_Lucene_Net_QueryParsers_Flexible_Core_Parser_EscapeQuerySyntaxType_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.EscapeQuerySyntax.Escape(System.String%2CSystem.Globalization.CultureInfo%2CLucene.Net.QueryParsers.Flexible.Core.Parser.EscapeQuerySyntaxType)%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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/EscapeQuerySyntaxImpl.cs/#L206">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_EscapeQuerySyntax_Escape_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.EscapeQuerySyntax.Escape*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Standard_Parser_EscapeQuerySyntax_Escape_System_String_System_Globalization_CultureInfo_Lucene_Net_QueryParsers_Flexible_Core_Parser_EscapeQuerySyntaxType_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Parser.EscapeQuerySyntax.Escape(System.String,System.Globalization.CultureInfo,Lucene.Net.QueryParsers.Flexible.Core.Parser.EscapeQuerySyntaxType)">Escape(String, CultureInfo, EscapeQuerySyntaxType)</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 virtual string Escape(string text, CultureInfo locale, EscapeQuerySyntaxType type)</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.String</span></td> |
| <td><span class="parametername">text</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Globalization.CultureInfo</span></td> |
| <td><span class="parametername">locale</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Parser.EscapeQuerySyntaxType.html">EscapeQuerySyntaxType</a></td> |
| <td><span class="parametername">type</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> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Parser.IEscapeQuerySyntax.html">IEscapeQuerySyntax</a> |
| </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_Parser_EscapeQuerySyntax.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.Parser.EscapeQuerySyntax%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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/Parser/EscapeQuerySyntaxImpl.cs/#L33" 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 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </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> |