| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Interface IDTDHandler |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Interface IDTDHandler |
| | 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.IDTDHandler"> |
| |
| |
| <h1 id="Sax_IDTDHandler" data-uid="Sax.IDTDHandler" class="text-break">Interface IDTDHandler |
| </h1> |
| <div class="markdown level0 summary"><p>Receive notification of basic DTD-related events.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Sax.html">Sax</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Benchmark.dll</h6> |
| <h5 id="Sax_IDTDHandler_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public interface IDTDHandler</code></pre> |
| </div> |
| <h5 id="Sax_IDTDHandler_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p><em>This module, both source code and documentation, is in the |
| Public Domain, and comes with <strong>NO WARRANTY</strong>.</em> |
| See <a href="http://www.saxproject.org">http://www.saxproject.org</a> |
| for further information. |
| <p> |
| If a SAX application needs information about notations and |
| unparsed entities, then the application implements this |
| interface and registers an instance with the SAX parser using |
| the parser's setDTDHandler method. The parser uses the |
| instance to report notation and unparsed entity declarations to |
| the application. |
| <p> |
| Note that this interface includes only those DTD events that |
| the XML recommendation<em>requires</em> processors to report: |
| notation and unparsed entity declarations. |
| <p> |
| The SAX parser may report these events in any order, regardless |
| of the order in which the notations and unparsed entities were |
| declared; however, all DTD events must be reported after the |
| document handler's startDocument event, and before the first |
| startElement event. |
| (If the <a class="xref" href="Sax.Ext.ILexicalHandler.html">ILexicalHandler</a> is |
| used, these events must also be reported before the endDTD event.) |
| <p> |
| It is up to the application to store the information for |
| future use(perhaps in a hash table or object tree). |
| If the application encounters attributes of type "NOTATION", |
| "ENTITY", or "ENTITIES", it can use the information that it |
| obtained through this interface to find the entity and/or |
| notation corresponding with the attribute value.</p> |
| </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-beta00010/websites/apidocs/apiSpec/new?filename=Sax_IDTDHandler_NotationDecl_System_String_System_String_System_String_.md&value=---%0Auid%3A%20Sax.IDTDHandler.NotationDecl(System.String%2CSystem.String%2CSystem.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/Support/Sax/DTDHandler.cs/#L71">View Source</a> |
| </span> |
| <a id="Sax_IDTDHandler_NotationDecl_" data-uid="Sax.IDTDHandler.NotationDecl*"></a> |
| <h4 id="Sax_IDTDHandler_NotationDecl_System_String_System_String_System_String_" data-uid="Sax.IDTDHandler.NotationDecl(System.String,System.String,System.String)">NotationDecl(String, String, String)</h4> |
| <div class="markdown level1 summary"><p>Receive notification of a notation declaration event.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">void NotationDecl(string name, string publicId, string systemId)</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">name</span></td> |
| <td><p>The notation name.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">publicId</span></td> |
| <td><p>The notation's public identifier, or <code>null</code> if none was given.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">systemId</span></td> |
| <td><p>The notation's system identifier, or <code>null</code> if none was given.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_IDTDHandler_NotationDecl_System_String_System_String_System_String__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>It is up to the application to record the notation for later |
| reference, if necessary; |
| notations may appear as attribute values and in unparsed entity |
| declarations, and are sometime used with processing instruction |
| target names. |
| <p> |
| At least one of publicId and systemId must be non-null. |
| If a system identifier is present, and it is a URL, the SAX |
| parser must resolve it fully before passing it to the |
| application through this event. |
| <p> |
| There is no guarantee that the notation declaration will be |
| reported before any unparsed entities that use it.</p> |
| </div> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Sax.SAXException.html">SAXException</a></td> |
| <td><p>Any SAX exception, possibly wrapping another exception.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_IDTDHandler_NotationDecl_System_String_System_String_System_String__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.IDTDHandler.html#Sax_IDTDHandler_UnparsedEntityDecl_System_String_System_String_System_String_System_String_">UnparsedEntityDecl(String, String, String, String)</a></div> |
| <div><a class="xref" href="Sax.IAttributes.html">IAttributes</a></div> |
| </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=Sax_IDTDHandler_UnparsedEntityDecl_System_String_System_String_System_String_System_String_.md&value=---%0Auid%3A%20Sax.IDTDHandler.UnparsedEntityDecl(System.String%2CSystem.String%2CSystem.String%2CSystem.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/Support/Sax/DTDHandler.cs/#L95">View Source</a> |
| </span> |
| <a id="Sax_IDTDHandler_UnparsedEntityDecl_" data-uid="Sax.IDTDHandler.UnparsedEntityDecl*"></a> |
| <h4 id="Sax_IDTDHandler_UnparsedEntityDecl_System_String_System_String_System_String_System_String_" data-uid="Sax.IDTDHandler.UnparsedEntityDecl(System.String,System.String,System.String,System.String)">UnparsedEntityDecl(String, String, String, String)</h4> |
| <div class="markdown level1 summary"><p>Receive notification of an unparsed entity declaration event.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">void UnparsedEntityDecl(string name, string publicId, string systemId, string notationName)</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">name</span></td> |
| <td><p>The unparsed entity's name.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">publicId</span></td> |
| <td><p>The entity's public identifier, or null if none was given.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">systemId</span></td> |
| <td><p>The entity's system identifier.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">notationName</span></td> |
| <td><p>The name of the associated notation.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_IDTDHandler_UnparsedEntityDecl_System_String_System_String_System_String_System_String__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Note that the notation name corresponds to a notation |
| reported by the <a class="xref" href="Sax.IDTDHandler.html#Sax_IDTDHandler_NotationDecl_System_String_System_String_System_String_">NotationDecl(String, String, String)</a> event.<br>It is up to the application to record the entity for later |
| reference, if necessary; |
| unparsed entities may appear as attribute values. |
| <p> |
| If the system identifier is a URL, the parser must resolve it |
| fully before passing it to the application.</p> |
| </div> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Sax.SAXException.html">SAXException</a></td> |
| <td><p>Any SAX exception, possibly wrapping another exception.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Sax_IDTDHandler_UnparsedEntityDecl_System_String_System_String_System_String_System_String__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.IDTDHandler.html#Sax_IDTDHandler_NotationDecl_System_String_System_String_System_String_">NotationDecl(String, String, String)</a></div> |
| <div><a class="xref" href="Sax.IAttributes.html">IAttributes</a></div> |
| </div> |
| <h3 id="seealso">See Also</h3> |
| <div class="seealso"> |
| <div><a class="xref" href="Sax.IXMLReader.html#Sax_IXMLReader_DTDHandler">DTDHandler</a></div> |
| </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=Sax_IDTDHandler.md&value=---%0Auid%3A%20Sax.IDTDHandler%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/DTDHandler.cs/#L45" 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> |
