Interface IAttributes2

SAX2 extension to augment the per-attribute information provided though IAttributes. If an implementation supports this extension, the attributes provided in IContentHandler will implement this interface, and the http://xml.org/sax/features/use-attributes2 feature flag will have the valuetrue.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

XMLReader implementations are not required to support this information, and it is not part of core-only SAX2 distributions.

Note that if an attribute was defaulted (!IsSpecified()) it will of necessity also have been declared(IsDeclared()) in the DTD. Similarly if an attribute's type is anything except CDATA, then it must have been declared.

Inherited Members

IAttributes.Length

IAttributes.GetURI(int)

IAttributes.GetLocalName(int)

IAttributes.GetQName(int)

IAttributes.GetType(int)

IAttributes.GetValue(int)

IAttributes.GetIndex(string, string)

IAttributes.GetIndex(string)

IAttributes.GetType(string, string)

IAttributes.GetType(string)

IAttributes.GetValue(string, string)

IAttributes.GetValue(string)

Namespace: Sax.Ext

Assembly: Lucene.Net.Benchmark.dll

Syntax

public interface IAttributes2 : IAttributes

Methods

IsDeclared(int)

Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid).

Declaration

bool IsDeclared(int index)

Parameters

Type	Name	Description
int	index	The attribute index (zero-based).

Returns

Type	Description
bool	true if the attribute was declared in the DTD, false otherwise.

Exceptions

Type	Condition
IndexOutOfRangeException	When the supplied index does not identify an attribute.

IsDeclared(string)

Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid).

Declaration

bool IsDeclared(string qName)

Parameters

Type	Name	Description
string	qName	The XML qualified (prefixed) name.

Returns

Type	Description
bool	true if the attribute was declared in the DTD, false otherwise.

Exceptions

Type	Condition
ArgumentException	When the supplied name does not identify an attribute.

IsDeclared(string, string)

Returns false unless the attribute was declared in the DTD. This helps distinguish two kinds of attributes that SAX reports as CDATA: ones that were declared (and hence are usually valid), and those that were not (and which are never valid).

Declaration

bool IsDeclared(string uri, string localName)

Parameters

Type	Name	Description
string	uri	The Namespace URI, or the empty string if the name has no Namespace URI.
string	localName	The attribute's local name.

Returns

Type	Description
bool	true if the attribute was declared in the DTD, false otherwise.

Remarks

Remember that since DTDs do not "understand" namespaces, the namespace URI associated with an attribute may not have come from the DTD.The declaration will have applied to the attribute's qName

Exceptions

Type	Condition
ArgumentException	When the supplied names do not identify an attribute.

IsSpecified(int)

Returns true unless the attribute value was provided by DTD defaulting.

Declaration

bool IsSpecified(int index)

Parameters

Type	Name	Description
int	index	The attribute index (zero-based).

Returns

Type	Description
bool	true if the value was found in the XML text, false if the value was provided by DTD defaulting.

Exceptions

Type	Condition
IndexOutOfRangeException	When the supplied index does not identify an attribute.

IsSpecified(string)

Returns true unless the attribute value was provided by DTD defaulting.

Declaration

bool IsSpecified(string qName)

Parameters

Type	Name	Description
string	qName	The XML qualified (prefixed) name.

Returns

Type	Description
bool	true if the value was found in the XML text, false if the value was provided by DTD defaulting.

Exceptions

Type	Condition
ArgumentException	When the supplied name does not identify an attribute.

IsSpecified(string, string)

Returns true unless the attribute value was provided by DTD defaulting.

Declaration

bool IsSpecified(string uri, string localName)

Parameters

Type	Name	Description
string	uri	The Namespace URI, or the empty string if the name has no Namespace URI.
string	localName	The attribute's local name.

Returns

Type	Description
bool	true if the value was found in the XML text, false if the value was provided by DTD defaulting.

Remarks

Remember that since DTDs do not "understand" namespaces, the namespace URI associated with an attribute may not have come from the DTD.The declaration will have applied to the attribute's qName.

Exceptions

Type	Condition
ArgumentException	When the supplied names do not identify an attribute.