ILexicalHandler.StartEntity(String) Method

Reference

Definition

Namespace:: Org.Xml.Sax.Ext

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Report the beginning of some internal and external XML entities.

[Android.Runtime.Register("startEntity", "(Ljava/lang/String;)V", "GetStartEntity_Ljava_lang_String_Handler:Org.Xml.Sax.Ext.ILexicalHandlerInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]
public void StartEntity (string? name);

[<Android.Runtime.Register("startEntity", "(Ljava/lang/String;)V", "GetStartEntity_Ljava_lang_String_Handler:Org.Xml.Sax.Ext.ILexicalHandlerInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]
abstract member StartEntity : string -> unit

Parameters

name: String

The name of the entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be "[dtd]".

Attributes: RegisterAttribute

Exceptions

SAXException

The application may raise an exception.

Remarks

Report the beginning of some internal and external XML entities.

The reporting of parameter entities (including the external DTD subset) is optional, and SAX2 drivers that report LexicalHandler events may not implement it; you can use the http://xml.org/sax/features/lexical-handler/parameter-entities feature to query or control the reporting of parameter entities.

General entities are reported with their regular names, parameter entities have '%' prepended to their names, and the external DTD subset has the pseudo-entity name "[dtd]".

When a SAX2 driver is providing these events, all other events must be properly nested within start/end entity events. There is no additional requirement that events from org.xml.sax.ext.DeclHandler DeclHandler or org.xml.sax.DTDHandler DTDHandler be properly ordered.

Note that skipped entities will be reported through the org.xml.sax.ContentHandler#skippedEntity skippedEntity event, which is part of the ContentHandler interface.

Because of the streaming event model that SAX uses, some entity boundaries cannot be reported under any circumstances:

<ul> <li>general entities within attribute values</li> <li>parameter entities within declarations</li> </ul>

These will be silently expanded, with no indication of where the original entity boundaries were.

Note also that the boundaries of character references (which are not really entities anyway) are not reported.

All start/endEntity events must be properly nested.

Java documentation for org.xml.sax.ext.LexicalHandler.startEntity(java.lang.String).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to