blob: 366817c3311ba17cc82f96ab8b2446b552179d96 [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>Interface ILocator2
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface ILocator2
| 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="benchmark/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="Sax.Ext.ILocator2">
<h1 id="Sax_Ext_ILocator2" data-uid="Sax.Ext.ILocator2" class="text-break">Interface ILocator2
</h1>
<div class="markdown level0 summary"><p>SAX2 extension to augment the entity information provided
though a <a class="xref" href="Sax.ILocator.html">ILocator</a>.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Sax.ILocator.html#Sax_ILocator_PublicId">ILocator.PublicId</a>
</div>
<div>
<a class="xref" href="Sax.ILocator.html#Sax_ILocator_SystemId">ILocator.SystemId</a>
</div>
<div>
<a class="xref" href="Sax.ILocator.html#Sax_ILocator_LineNumber">ILocator.LineNumber</a>
</div>
<div>
<a class="xref" href="Sax.ILocator.html#Sax_ILocator_ColumnNumber">ILocator.ColumnNumber</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Sax.Ext.html">Sax.Ext</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Benchmark.dll</h6>
<h5 id="Sax_Ext_ILocator2_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface ILocator2 : ILocator</code></pre>
</div>
<h5 id="Sax_Ext_ILocator2_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>If an implementation supports this extension, the Locator
provided in <a class="xref" href="Sax.IContentHandler.html#Sax_IContentHandler_SetDocumentLocator_Sax_ILocator_">SetDocumentLocator(ILocator)</a>
will implement this interface, and the
<a href="http://xml.org/sax/features/use-locator2">http://xml.org/sax/features/use-locator2</a> feature
flag will have the value <em>true</em>.
<p>
<em>This module, both source code and documentation, is in the
Public Domain, and comes with<strong> NO WARRANTY</strong>.</em>
<p>
XMLReader implementations are not required to support this
information, and it is not part of core-only SAX2 distributions.</p>
</div>
<h3 id="properties">Properties
</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=Sax_Ext_ILocator2_Encoding.md&amp;value=---%0Auid%3A%20Sax.Ext.ILocator2.Encoding%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.Benchmark/Support/Sax/Ext/Locator2.cs/#L62">View Source</a>
</span>
<a id="Sax_Ext_ILocator2_Encoding_" data-uid="Sax.Ext.ILocator2.Encoding*"></a>
<h4 id="Sax_Ext_ILocator2_Encoding" data-uid="Sax.Ext.ILocator2.Encoding">Encoding</h4>
<div class="markdown level1 summary"><p>Returns the name of the character encoding for the entity.
If the encoding was declared externally(for example, in a MIME
Content-Type header), that will be the name returned.Else if there
was an<em>&lt;?xml ...encoding=&apos;...&apos;?&gt;</em> declaration at
the start of the document, that encoding name will be returned.
Otherwise the encoding will been inferred (normally to be UTF-8, or
some UTF-16 variant), and that inferred name will be returned.
<p>
When an <a class="xref" href="Sax.InputSource.html">InputSource</a> is used
to provide an entity&apos;s character stream, this method returns the
encoding provided in that input stream.
<p>
Note that some recent W3C specifications require that text
in some encodings be normalized, using Unicode Normalization
Form C, before processing.Such normalization must be performed
by applications, and would normally be triggered based on the
value returned by this method.
<p>
Encoding names may be those used by the underlying JVM,
and comparisons should be case-insensitive.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Encoding Encoding { get; }</code></pre>
</div>
<h5 class="propertyValue">Property 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.Text.Encoding</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=Sax_Ext_ILocator2_XMLVersion.md&amp;value=---%0Auid%3A%20Sax.Ext.ILocator2.XMLVersion%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.Benchmark/Support/Sax/Ext/Locator2.cs/#L38">View Source</a>
</span>
<a id="Sax_Ext_ILocator2_XMLVersion_" data-uid="Sax.Ext.ILocator2.XMLVersion*"></a>
<h4 id="Sax_Ext_ILocator2_XMLVersion" data-uid="Sax.Ext.ILocator2.XMLVersion">XMLVersion</h4>
<div class="markdown level1 summary"><p>Returns the version of XML used for the entity. This will
normally be the identifier from the current entity&apos;s
<em>&lt;?xml version=&apos;...&apos; ...?&gt;</em> declaration,
or be defaulted by the parser.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">string XMLVersion { get; }</code></pre>
</div>
<h5 class="propertyValue">Property 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.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-beta00010/websites/apidocs/apiSpec/new?filename=Sax_Ext_ILocator2.md&amp;value=---%0Auid%3A%20Sax.Ext.ILocator2%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.Benchmark/Support/Sax/Ext/Locator2.cs/#L30" 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>