<summary>Specifies the amount of input or output checking that <see cref="T:System.Xml.XmlReader" /> and <see cref="T:System.Xml.XmlWriter" /> objects perform.</summary>
</member>
<member name="F:System.Xml.ConformanceLevel.Auto">
- <summary>The <see cref="T:System.Xml.XmlReader" /> or <see cref="T:System.Xml.XmlWriter" /> object automatically detects whether document-level or fragment-level checking should be performed, and does the appropriate checking. If you're wrapping another <see cref="T:System.Xml.XmlReader" /> or <see cref="T:System.Xml.XmlWriter" /> object, the outer object doesn't do any additional conformance checking. Conformance checking is left up to the underlying object.
-
- See the <see cref="P:System.Xml.XmlReaderSettings.ConformanceLevel" /> and <see cref="P:System.Xml.XmlWriterSettings.ConformanceLevel" /> properties for details on how the compliance level is determined.</summary>
+ <summary>The <see cref="T:System.Xml.XmlReader" /> or <see cref="T:System.Xml.XmlWriter" /> object automatically detects whether document-level or fragment-level checking should be performed, and does the appropriate checking. If you're wrapping another <see cref="T:System.Xml.XmlReader" /> or <see cref="T:System.Xml.XmlWriter" /> object, the outer object doesn't do any additional conformance checking. Conformance checking is left up to the underlying object.
+See the <see cref="P:System.Xml.XmlReaderSettings.ConformanceLevel" /> and <see cref="P:System.Xml.XmlWriterSettings.ConformanceLevel" /> properties for details on how the compliance level is determined.</summary>
</member>
<member name="F:System.Xml.ConformanceLevel.Document">
<summary>The XML data complies with the rules for a well-formed XML 1.0 document, as defined by the W3C. This level of checking ensures that the stream being read or written can be consumed by any processor as an XML 1.0 document.</summary>
<summary>Specifies how the <see cref="T:System.Xml.XmlTextReader" /> or <see cref="T:System.Xml.XmlValidatingReader" /> handle entities.</summary>
</member>
<member name="F:System.Xml.EntityHandling.ExpandCharEntities">
- <summary>Expands character entities and returns general entities as <see cref="F:System.Xml.XmlNodeType.EntityReference" /> nodes.
-
-You must call <see cref="Overload:System.Xml.XmlReader.ResolveEntity" /> to see what the general entities expand to. This enables you to optimize entity handling by only expanding the entity the first time it is used.
-
+ <summary>Expands character entities and returns general entities as <see cref="F:System.Xml.XmlNodeType.EntityReference" /> nodes.
+You must call <see cref="Overload:System.Xml.XmlReader.ResolveEntity" /> to see what the general entities expand to. This enables you to optimize entity handling by only expanding the entity the first time it is used.
When set to <see langword="ExpandCharEntities" />, a reader call to the <see cref="Overload:System.Xml.XmlReader.GetAttribute" /> method expands all entities (both general and character entities).</summary>
</member>
<member name="F:System.Xml.EntityHandling.ExpandEntities">
<summary>Expands all entities and returns the expanded nodes.
-
<see cref="F:System.Xml.XmlNodeType.EntityReference" /> nodes are not returned. The entity text is expanded in place of the entity references.</summary>
</member>
<member name="T:System.Xml.Formatting">
</member>
<member name="F:System.Xml.Formatting.Indented">
<summary>Causes child elements to be indented according to the <see cref="P:System.Xml.XmlTextWriter.Indentation" /> and <see cref="P:System.Xml.XmlTextWriter.IndentChar" /> settings.
-
This option indents element content only; mixed content is not affected. For the XML 1.0 definitions of these terms, see the World Wide Web Consortium (W3C) documentation Element Content and Mixed Content.</summary>
</member>
<member name="F:System.Xml.Formatting.None">
<param name="key">The character array containing the string to add.</param>
<param name="start">The zero-based index into the array specifying the first character of the string.</param>
<param name="len">The number of characters in the string.</param>
- <exception cref="T:System.IndexOutOfRangeException">0 > <paramref name="start" />
-
- -or-
-
- <paramref name="start" /> >= <paramref name="key" />.Length
-
- -or-
-
- <paramref name="len" /> >= <paramref name="key" />.Length
-
- The above conditions do not cause an exception to be thrown if <paramref name="len" /> =0.</exception>
+ <returns>The atomized string or the existing string if one already exists in the <see langword="NameTable" />. If <paramref name="len" /> is zero, String.Empty is returned.</returns>
+ <exception cref="T:System.IndexOutOfRangeException">0 > <paramref name="start" />
+-or-
+<paramref name="start" /> >= <paramref name="key" />.Length
+-or-
+<paramref name="len" /> >= <paramref name="key" />.Length
+The above conditions do not cause an exception to be thrown if <paramref name="len" /> =0.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="len" /> < 0.</exception>
- <returns>The atomized string or the existing string if one already exists in the <see langword="NameTable" />. If <paramref name="len" /> is zero, String.Empty is returned.</returns>
</member>
<member name="M:System.Xml.NameTable.Add(System.String)">
<summary>Atomizes the specified string and adds it to the <see langword="NameTable" />.</summary>
<param name="key">The string to add.</param>
+ <returns>The atomized string or the existing string if it already exists in the <see langword="NameTable" />.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="key" /> is <see langword="null" />.</exception>
- <returns>The atomized string or the existing string if it already exists in the <see langword="NameTable" />.</returns>
</member>
<member name="M:System.Xml.NameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>Gets the atomized string containing the same characters as the specified range of characters in the given array.</summary>
<param name="key">The character array containing the name to find.</param>
<param name="start">The zero-based index into the array specifying the first character of the name.</param>
<param name="len">The number of characters in the name.</param>
- <exception cref="T:System.IndexOutOfRangeException">0 > <paramref name="start" />
-
- -or-
-
- <paramref name="start" /> >= <paramref name="key" />.Length
-
- -or-
-
- <paramref name="len" /> >= <paramref name="key" />.Length
-
- The above conditions do not cause an exception to be thrown if <paramref name="len" /> =0.</exception>
+ <returns>The atomized string or <see langword="null" /> if the string has not already been atomized. If <paramref name="len" /> is zero, String.Empty is returned.</returns>
+ <exception cref="T:System.IndexOutOfRangeException">0 > <paramref name="start" />
+-or-
+<paramref name="start" /> >= <paramref name="key" />.Length
+-or-
+<paramref name="len" /> >= <paramref name="key" />.Length
+The above conditions do not cause an exception to be thrown if <paramref name="len" /> =0.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="len" /> < 0.</exception>
- <returns>The atomized string or <see langword="null" /> if the string has not already been atomized. If <paramref name="len" /> is zero, String.Empty is returned.</returns>
</member>
<member name="M:System.Xml.NameTable.Get(System.String)">
<summary>Gets the atomized string with the specified value.</summary>
<param name="value">The name to find.</param>
+ <returns>The atomized string object or <see langword="null" /> if the string has not already been atomized.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="value" /> is <see langword="null" />.</exception>
- <returns>The atomized string object or <see langword="null" /> if the string has not already been atomized.</returns>
</member>
<member name="T:System.Xml.NewLineHandling">
<summary>Specifies how to handle line breaks.</summary>
<exception cref="T:System.ArgumentNullException">
<paramref name="uri" /> or <paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="offset" /> or <paramref name="count" /> is less than 0.
-
- -or-
-
- The length of the <paramref name="value" /> minus <paramref name="offset" /> is less than <paramref name="count" />.</exception>
+ <paramref name="offset" /> or <paramref name="count" /> is less than 0.
+-or-
+The length of the <paramref name="value" /> minus <paramref name="offset" /> is less than <paramref name="count." /></exception>
</member>
<member name="M:System.Xml.Resolvers.XmlPreloadedResolver.Add(System.Uri,System.IO.Stream)">
<summary>Adds a <see cref="T:System.IO.Stream" /> to the <see cref="T:System.Xml.Resolvers.XmlPreloadedResolver" /> store and maps it to a URI. If the store already contains a mapping for the same URI, the existing mapping is overridden.</summary>
<exception cref="T:System.ArgumentNullException">
<paramref name="uri" /> or <paramref name="value" /> is <see langword="null" />.</exception>
</member>
+ <member name="P:System.Xml.Resolvers.XmlPreloadedResolver.Credentials">
+ <summary>Sets the credentials that are used to authenticate the underlying <see cref="T:System.Net.WebRequest" />.</summary>
+ <returns>The credentials that are used to authenticate the underlying web request.</returns>
+ </member>
<member name="M:System.Xml.Resolvers.XmlPreloadedResolver.GetEntity(System.Uri,System.String,System.Type)">
<summary>Maps a URI to an object that contains the actual resource.</summary>
<param name="absoluteUri">The URI returned from <see cref="M:System.Xml.XmlResolver.ResolveUri(System.Uri,System.String)" />.</param>
<param name="role">The current version of the .NET Framework for Silverlight does not use this parameter when resolving URIs. This parameter is provided for future extensibility purposes. For example, this parameter can be mapped to the xlink:role and used as an implementation-specific argument in other scenarios.</param>
<param name="ofObjectToReturn">The type of object to return. The <see cref="T:System.Xml.Resolvers.XmlPreloadedResolver" /> supports <see cref="T:System.IO.Stream" /> objects and <see cref="T:System.IO.TextReader" /> objects for URIs that were added as <see langword="String" />. If the requested type is not supported by the resolver, an exception will be thrown. Use the <see cref="M:System.Xml.Resolvers.XmlPreloadedResolver.SupportsType(System.Uri,System.Type)" /> method to determine whether a certain <see langword="Type" /> is supported by this resolver.</param>
+ <returns>A <see cref="T:System.IO.Stream" /> or <see cref="T:System.IO.TextReader" /> object that corresponds to the actual source.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="absoluteUri" /> is <see langword="null" />.</exception>
- <exception cref="T:System.Xml.XmlException">Cannot resolve URI passed in <paramref name="absoluteUri" />.
-
- -or-
-
- <paramref name="ofObjectToReturn" /> is not of a supported type.</exception>
- <returns>A <see cref="T:System.IO.Stream" /> or <see cref="T:System.IO.TextReader" /> object that corresponds to the actual source.</returns>
+ <exception cref="T:System.Xml.XmlException">Cannot resolve URI passed in <paramref name="absoluteUri" />.
+-or-
+<paramref name="ofObjectToReturn" /> is not of a supported type.</exception>
</member>
<member name="M:System.Xml.Resolvers.XmlPreloadedResolver.GetEntityAsync(System.Uri,System.String,System.Type)">
<summary>Asynchronously maps a URI to an object that contains the actual resource.</summary>
<param name="ofObjectToReturn">The type of object to return. The <see cref="T:System.Xml.Resolvers.XmlPreloadedResolver" /> supports <see cref="T:System.IO.Stream" /> objects and <see cref="T:System.IO.TextReader" /> objects for URIs that were added as <see langword="String" />. If the requested type is not supported by the resolver, an exception will be thrown. Use the <see cref="M:System.Xml.Resolvers.XmlPreloadedResolver.SupportsType(System.Uri,System.Type)" /> method to determine whether a certain <see langword="Type" /> is supported by this resolver.</param>
<returns>A <see cref="T:System.IO.Stream" /> or <see cref="T:System.IO.TextReader" /> object that corresponds to the actual source.</returns>
</member>
+ <member name="P:System.Xml.Resolvers.XmlPreloadedResolver.PreloadedUris">
+ <summary>Gets a collection of preloaded URIs.</summary>
+ <returns>The collection of preloaded URIs.</returns>
+ </member>
<member name="M:System.Xml.Resolvers.XmlPreloadedResolver.Remove(System.Uri)">
<summary>Removes the data that corresponds to the URI from the <see cref="T:System.Xml.Resolvers.XmlPreloadedResolver" />.</summary>
<param name="uri">The URI of the data that should be removed from the <see cref="T:System.Xml.Resolvers.XmlPreloadedResolver" /> store.</param>
<summary>Resolves the absolute URI from the base and relative URIs.</summary>
<param name="baseUri">The base URI used to resolve the relative URI.</param>
<param name="relativeUri">The URI to resolve. The URI can be absolute or relative. If absolute, this value effectively replaces the <paramref name="baseUri" /> value. If relative, it combines with the <paramref name="baseUri" /> to make an absolute URI.</param>
+ <returns>The <see cref="T:System.Uri" /> representing the absolute URI or <see langword="null" /> if the relative URI cannot be resolved.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="uri" /> is <see langword="null" />.</exception>
- <returns>The <see cref="T:System.Uri" /> representing the absolute URI or <see langword="null" /> if the relative URI cannot be resolved.</returns>
</member>
<member name="M:System.Xml.Resolvers.XmlPreloadedResolver.SupportsType(System.Uri,System.Type)">
<summary>Determines whether the resolver supports other <see cref="T:System.Type" />s than just <see cref="T:System.IO.Stream" />.</summary>
<param name="absoluteUri">The absolute URI to check.</param>
<param name="type">The <see cref="T:System.Type" /> to return.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="uri" /> is <see langword="null" />.</exception>
<returns>
<see langword="true" /> if the <see cref="T:System.Type" /> is supported; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.Resolvers.XmlPreloadedResolver.Credentials">
- <summary>Sets the credentials that are used to authenticate the underlying <see cref="T:System.Net.WebRequest" />.</summary>
- <returns>The credentials that are used to authenticate the underlying web request.</returns>
- </member>
- <member name="P:System.Xml.Resolvers.XmlPreloadedResolver.PreloadedUris">
- <summary>Gets a collection of preloaded URIs.</summary>
- <returns>The collection of preloaded URIs.</returns>
+ <exception cref="T:System.ArgumentNullException">
+ <paramref name="uri" /> is <see langword="null" />.</exception>
</member>
<member name="T:System.Xml.Schema.IXmlSchemaInfo">
<summary>Defines the post-schema-validation infoset of a validated XML node.</summary>
</member>
<member name="T:System.Xml.Schema.ValidationEventHandler">
<summary>Represents the callback method that will handle XML schema validation events and the <see cref="T:System.Xml.Schema.ValidationEventArgs" />.</summary>
- <param name="sender">The source of the event.
-
- Note Determine the type of a sender before using it in your code. You cannot assume that the sender is an instance of a particular type. The sender is also not guaranteed to not be null. Always surround your casts with failure handling logic.</param>
+ <param name="sender">The source of the event.
+Note Determine the type of a sender before using it in your code. You cannot assume that the sender is an instance of a particular type. The sender is also not guaranteed to not be null. Always surround your casts with failure handling logic.</param>
<param name="e">The event data.</param>
</member>
<member name="T:System.Xml.Schema.XmlAtomicValue">
<summary>Returns a copy of this <see cref="T:System.Xml.Schema.XmlAtomicValue" /> object.</summary>
<returns>An <see cref="T:System.Xml.Schema.XmlAtomicValue" /> object copy of this <see cref="T:System.Xml.Schema.XmlAtomicValue" /> object.</returns>
</member>
+ <member name="P:System.Xml.Schema.XmlAtomicValue.IsNode">
+ <summary>Gets a value indicating whether the validated XML element or attribute is an XPath node or an atomic value.</summary>
+ <returns>
+ <see langword="true" /> if the validated XML element or attribute is an XPath node; <see langword="false" /> if the validated XML element or attribute is an atomic value.</returns>
+ </member>
<member name="M:System.Xml.Schema.XmlAtomicValue.System#ICloneable#Clone">
<summary>For a description of this member, see <see cref="M:System.Xml.Schema.XmlAtomicValue.Clone" />.</summary>
<returns>A copy of this <see cref="T:System.Xml.Schema.XmlAtomicValue" /> object.</returns>
<summary>Gets the <see langword="string" /> value of the validated XML element or attribute.</summary>
<returns>The <see langword="string" /> value of the validated XML element or attribute.</returns>
</member>
+ <member name="P:System.Xml.Schema.XmlAtomicValue.TypedValue">
+ <summary>Gets the current validated XML element or attribute as a boxed object of the most appropriate Microsoft .NET Framework type according to its schema type.</summary>
+ <returns>The current validated XML element or attribute as a boxed object of the most appropriate .NET Framework type.</returns>
+ </member>
+ <member name="P:System.Xml.Schema.XmlAtomicValue.Value">
+ <summary>Gets the <see langword="string" /> value of the validated XML element or attribute.</summary>
+ <returns>The <see langword="string" /> value of the validated XML element or attribute.</returns>
+ </member>
<member name="M:System.Xml.Schema.XmlAtomicValue.ValueAs(System.Type,System.Xml.IXmlNamespaceResolver)">
<summary>Returns the validated XML element or attribute's value as the type specified using the <see cref="T:System.Xml.IXmlNamespaceResolver" /> object specified to resolve namespace prefixes.</summary>
<param name="type">The type to return the validated XML element or attribute's value as.</param>
<param name="nsResolver">The <see cref="T:System.Xml.IXmlNamespaceResolver" /> object used to resolve namespace prefixes.</param>
+ <returns>The value of the validated XML element or attribute as the type requested.</returns>
<exception cref="T:System.FormatException">The validated XML element or attribute's value is not in the correct format for the target type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.OverflowException">The attempted cast resulted in an overflow.</exception>
- <returns>The value of the validated XML element or attribute as the type requested.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlAtomicValue.IsNode">
- <summary>Gets a value indicating whether the validated XML element or attribute is an XPath node or an atomic value.</summary>
- <returns>
- <see langword="true" /> if the validated XML element or attribute is an XPath node; <see langword="false" /> if the validated XML element or attribute is an atomic value.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlAtomicValue.TypedValue">
- <summary>Gets the current validated XML element or attribute as a boxed object of the most appropriate .NET type according to its schema type.</summary>
- <returns>The current validated XML element or attribute as a boxed object of the most appropriate .NET type.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlAtomicValue.Value">
- <summary>Gets the <see langword="string" /> value of the validated XML element or attribute.</summary>
- <returns>The <see langword="string" /> value of the validated XML element or attribute.</returns>
</member>
<member name="P:System.Xml.Schema.XmlAtomicValue.ValueAsBoolean">
<summary>Gets the validated XML element or attribute's value as a <see cref="T:System.Boolean" />.</summary>
+ <returns>The validated XML element or attribute's value as a <see cref="T:System.Boolean" />.</returns>
<exception cref="T:System.FormatException">The validated XML element or attribute's value is not in the correct format for the <see cref="T:System.Boolean" /> type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.Boolean" /> is not valid.</exception>
- <returns>The validated XML element or attribute's value as a <see cref="T:System.Boolean" />.</returns>
</member>
<member name="P:System.Xml.Schema.XmlAtomicValue.ValueAsDateTime">
<summary>Gets the validated XML element or attribute's value as a <see cref="T:System.DateTime" />.</summary>
+ <returns>The validated XML element or attribute's value as a <see cref="T:System.DateTime" />.</returns>
<exception cref="T:System.FormatException">The validated XML element or attribute's value is not in the correct format for the <see cref="T:System.DateTime" /> type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.DateTime" /> is not valid.</exception>
- <returns>The validated XML element or attribute's value as a <see cref="T:System.DateTime" />.</returns>
</member>
<member name="P:System.Xml.Schema.XmlAtomicValue.ValueAsDouble">
<summary>Gets the validated XML element or attribute's value as a <see cref="T:System.Double" />.</summary>
+ <returns>The validated XML element or attribute's value as a <see cref="T:System.Double" />.</returns>
<exception cref="T:System.FormatException">The validated XML element or attribute's value is not in the correct format for the <see cref="T:System.Double" /> type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.Double" /> is not valid.</exception>
<exception cref="T:System.OverflowException">The attempted cast resulted in an overflow.</exception>
- <returns>The validated XML element or attribute's value as a <see cref="T:System.Double" />.</returns>
</member>
<member name="P:System.Xml.Schema.XmlAtomicValue.ValueAsInt">
<summary>Gets the validated XML element or attribute's value as an <see cref="T:System.Int32" />.</summary>
+ <returns>The validated XML element or attribute's value as an <see cref="T:System.Int32" />.</returns>
<exception cref="T:System.FormatException">The validated XML element or attribute's value is not in the correct format for the <see cref="T:System.Int32" /> type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.Int32" /> is not valid.</exception>
<exception cref="T:System.OverflowException">The attempted cast resulted in an overflow.</exception>
- <returns>The validated XML element or attribute's value as an <see cref="T:System.Int32" />.</returns>
</member>
<member name="P:System.Xml.Schema.XmlAtomicValue.ValueAsLong">
<summary>Gets the validated XML element or attribute's value as an <see cref="T:System.Int64" />.</summary>
+ <returns>The validated XML element or attribute's value as an <see cref="T:System.Int64" />.</returns>
<exception cref="T:System.FormatException">The validated XML element or attribute's value is not in the correct format for the <see cref="T:System.Int64" /> type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.Int64" /> is not valid.</exception>
<exception cref="T:System.OverflowException">The attempted cast resulted in an overflow.</exception>
- <returns>The validated XML element or attribute's value as an <see cref="T:System.Int64" />.</returns>
</member>
<member name="P:System.Xml.Schema.XmlAtomicValue.ValueType">
- <summary>Gets the .NET type of the validated XML element or attribute.</summary>
- <returns>The .NET type of the validated XML element or attribute. The default value is <see cref="T:System.String" />.</returns>
+ <summary>Gets the Microsoft .NET Framework type of the validated XML element or attribute.</summary>
+ <returns>The .NET Framework type of the validated XML element or attribute. The default value is <see cref="T:System.String" />.</returns>
</member>
<member name="P:System.Xml.Schema.XmlAtomicValue.XmlType">
<summary>Gets the <see cref="T:System.Xml.Schema.XmlSchemaType" /> for the validated XML element or attribute.</summary>
<member name="T:System.Xml.Schema.XmlSchema">
<summary>An in-memory representation of an XML Schema, as specified in the World Wide Web Consortium (W3C) XML Schema Part 1: Structures and XML Schema Part 2: Datatypes].</summary>
</member>
- <member name="F:System.Xml.Schema.XmlSchema.InstanceNamespace">
- <summary>The XML schema instance namespace. This field is constant.</summary>
- </member>
- <member name="F:System.Xml.Schema.XmlSchema.Namespace">
- <summary>The XML schema namespace. This field is constant.</summary>
- </member>
<member name="M:System.Xml.Schema.XmlSchema.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.Schema.XmlSchema" /> class.</summary>
</member>
- <member name="M:System.Xml.Schema.XmlSchema.Compile(System.Xml.Schema.ValidationEventHandler)">
- <summary>Compiles the XML Schema Object Model (SOM) into schema information for validation. Used to check the syntactic and semantic structure of the programmatically built SOM. Semantic validation checking is performed during compilation.</summary>
- <param name="validationEventHandler">The validation event handler that receives information about XML Schema validation errors.</param>
- </member>
- <member name="M:System.Xml.Schema.XmlSchema.Compile(System.Xml.Schema.ValidationEventHandler,System.Xml.XmlResolver)">
- <summary>Compiles the XML Schema Object Model (SOM) into schema information for validation. Used to check the syntactic and semantic structure of the programmatically built SOM. Semantic validation checking is performed during compilation.</summary>
- <param name="validationEventHandler">The validation event handler that receives information about the XML Schema validation errors.</param>
- <param name="resolver">The <see langword="XmlResolver" /> used to resolve namespaces referenced in <see langword="include" /> and <see langword="import" /> elements.</param>
- </member>
- <member name="M:System.Xml.Schema.XmlSchema.Read(System.IO.Stream,System.Xml.Schema.ValidationEventHandler)">
- <summary>Reads an XML Schema from the supplied stream.</summary>
- <param name="stream">The supplied data stream.</param>
- <param name="validationEventHandler">The validation event handler that receives information about XML Schema syntax errors.</param>
- <exception cref="T:System.Xml.Schema.XmlSchemaException">An <see cref="T:System.Xml.Schema.XmlSchemaException" /> is raised if no <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified.</exception>
- <returns>The <see cref="T:System.Xml.Schema.XmlSchema" /> object representing the XML Schema.</returns>
- </member>
- <member name="M:System.Xml.Schema.XmlSchema.Read(System.IO.TextReader,System.Xml.Schema.ValidationEventHandler)">
- <summary>Reads an XML Schema from the supplied <see cref="T:System.IO.TextReader" />.</summary>
- <param name="reader">The <see langword="TextReader" /> containing the XML Schema to read.</param>
- <param name="validationEventHandler">The validation event handler that receives information about the XML Schema syntax errors.</param>
- <exception cref="T:System.Xml.Schema.XmlSchemaException">An <see cref="T:System.Xml.Schema.XmlSchemaException" /> is raised if no <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified.</exception>
- <returns>The <see cref="T:System.Xml.Schema.XmlSchema" /> object representing the XML Schema.</returns>
- </member>
- <member name="M:System.Xml.Schema.XmlSchema.Read(System.Xml.XmlReader,System.Xml.Schema.ValidationEventHandler)">
- <summary>Reads an XML Schema from the supplied <see cref="T:System.Xml.XmlReader" />.</summary>
- <param name="reader">The <see langword="XmlReader" /> containing the XML Schema to read.</param>
- <param name="validationEventHandler">The validation event handler that receives information about the XML Schema syntax errors.</param>
- <exception cref="T:System.Xml.Schema.XmlSchemaException">An <see cref="T:System.Xml.Schema.XmlSchemaException" /> is raised if no <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified.</exception>
- <returns>The <see cref="T:System.Xml.Schema.XmlSchema" /> object representing the XML Schema.</returns>
- </member>
- <member name="M:System.Xml.Schema.XmlSchema.Write(System.IO.Stream)">
- <summary>Writes the XML Schema to the supplied data stream.</summary>
- <param name="stream">The supplied data stream.</param>
- </member>
- <member name="M:System.Xml.Schema.XmlSchema.Write(System.IO.Stream,System.Xml.XmlNamespaceManager)">
- <summary>Writes the XML Schema to the supplied <see cref="T:System.IO.Stream" /> using the <see cref="T:System.Xml.XmlNamespaceManager" /> specified.</summary>
- <param name="stream">The supplied data stream.</param>
- <param name="namespaceManager">The <see cref="T:System.Xml.XmlNamespaceManager" />.</param>
- </member>
- <member name="M:System.Xml.Schema.XmlSchema.Write(System.IO.TextWriter)">
- <summary>Writes the XML Schema to the supplied <see cref="T:System.IO.TextWriter" />.</summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter" /> to write to.</param>
- </member>
- <member name="M:System.Xml.Schema.XmlSchema.Write(System.IO.TextWriter,System.Xml.XmlNamespaceManager)">
- <summary>Writes the XML Schema to the supplied <see cref="T:System.IO.TextWriter" />.</summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter" /> to write to.</param>
- <param name="namespaceManager">The <see cref="T:System.Xml.XmlNamespaceManager" />.</param>
- </member>
- <member name="M:System.Xml.Schema.XmlSchema.Write(System.Xml.XmlWriter)">
- <summary>Writes the XML Schema to the supplied <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter" /> to write to.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> parameter is null.</exception>
- </member>
- <member name="M:System.Xml.Schema.XmlSchema.Write(System.Xml.XmlWriter,System.Xml.XmlNamespaceManager)">
- <summary>Writes the XML Schema to the supplied <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter" /> to write to.</param>
- <param name="namespaceManager">The <see cref="T:System.Xml.XmlNamespaceManager" />.</param>
- </member>
<member name="P:System.Xml.Schema.XmlSchema.AttributeFormDefault">
<summary>Gets or sets the form for attributes declared in the target namespace of the schema.</summary>
<returns>The <see cref="T:System.Xml.Schema.XmlSchemaForm" /> value that indicates if attributes from the target namespace are required to be qualified with the namespace prefix. The default is <see cref="F:System.Xml.Schema.XmlSchemaForm.None" />.</returns>
<summary>Gets or sets the <see langword="blockDefault" /> attribute which sets the default value of the <see langword="block" /> attribute on element and complex types in the <see langword="targetNamespace" /> of the schema.</summary>
<returns>An <see cref="T:System.Xml.Schema.XmlSchemaDerivationMethod" /> value representing the different methods for preventing derivation. The default value is <see langword="XmlSchemaDerivationMethod.None" />.</returns>
</member>
+ <member name="M:System.Xml.Schema.XmlSchema.Compile(System.Xml.Schema.ValidationEventHandler)">
+ <summary>Compiles the XML Schema Object Model (SOM) into schema information for validation. Used to check the syntactic and semantic structure of the programmatically built SOM. Semantic validation checking is performed during compilation.</summary>
+ <param name="validationEventHandler">The validation event handler that receives information about XML Schema validation errors.</param>
+ </member>
+ <member name="M:System.Xml.Schema.XmlSchema.Compile(System.Xml.Schema.ValidationEventHandler,System.Xml.XmlResolver)">
+ <summary>Compiles the XML Schema Object Model (SOM) into schema information for validation. Used to check the syntactic and semantic structure of the programmatically built SOM. Semantic validation checking is performed during compilation.</summary>
+ <param name="validationEventHandler">The validation event handler that receives information about the XML Schema validation errors.</param>
+ <param name="resolver">The <see langword="XmlResolver" /> used to resolve namespaces referenced in <see langword="include" /> and <see langword="import" /> elements.</param>
+ </member>
<member name="P:System.Xml.Schema.XmlSchema.ElementFormDefault">
<summary>Gets or sets the form for elements declared in the target namespace of the schema.</summary>
<returns>The <see cref="T:System.Xml.Schema.XmlSchemaForm" /> value that indicates if elements from the target namespace are required to be qualified with the namespace prefix. The default is <see cref="F:System.Xml.Schema.XmlSchemaForm.None" />.</returns>
<summary>Gets the collection of included and imported schemas.</summary>
<returns>An <see cref="T:System.Xml.Schema.XmlSchemaObjectCollection" /> of the included and imported schemas.</returns>
</member>
+ <member name="F:System.Xml.Schema.XmlSchema.InstanceNamespace">
+ <summary>The XML schema instance namespace. This field is constant.</summary>
+ </member>
<member name="P:System.Xml.Schema.XmlSchema.IsCompiled">
<summary>Indicates if the schema has been compiled.</summary>
<returns>
<summary>Gets the collection of schema elements in the schema and is used to add new element types at the <see langword="schema" /> element level.</summary>
<returns>An <see cref="T:System.Xml.Schema.XmlSchemaObjectCollection" /> of schema elements in the schema.</returns>
</member>
+ <member name="F:System.Xml.Schema.XmlSchema.Namespace">
+ <summary>The XML schema namespace. This field is constant.</summary>
+ </member>
<member name="P:System.Xml.Schema.XmlSchema.Notations">
<summary>Gets the post-schema-compilation value for all notations in the schema.</summary>
<returns>An <see cref="T:System.Xml.Schema.XmlSchemaObjectTable" /> collection of all notations in the schema.</returns>
</member>
+ <member name="M:System.Xml.Schema.XmlSchema.Read(System.IO.Stream,System.Xml.Schema.ValidationEventHandler)">
+ <summary>Reads an XML Schema from the supplied stream.</summary>
+ <param name="stream">The supplied data stream.</param>
+ <param name="validationEventHandler">The validation event handler that receives information about XML Schema syntax errors.</param>
+ <returns>The <see cref="T:System.Xml.Schema.XmlSchema" /> object representing the XML Schema.</returns>
+ <exception cref="T:System.Xml.Schema.XmlSchemaException">An <see cref="T:System.Xml.Schema.XmlSchemaException" /> is raised if no <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified.</exception>
+ </member>
+ <member name="M:System.Xml.Schema.XmlSchema.Read(System.IO.TextReader,System.Xml.Schema.ValidationEventHandler)">
+ <summary>Reads an XML Schema from the supplied <see cref="T:System.IO.TextReader" />.</summary>
+ <param name="reader">The <see langword="TextReader" /> containing the XML Schema to read.</param>
+ <param name="validationEventHandler">The validation event handler that receives information about the XML Schema syntax errors.</param>
+ <returns>The <see cref="T:System.Xml.Schema.XmlSchema" /> object representing the XML Schema.</returns>
+ <exception cref="T:System.Xml.Schema.XmlSchemaException">An <see cref="T:System.Xml.Schema.XmlSchemaException" /> is raised if no <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified.</exception>
+ </member>
+ <member name="M:System.Xml.Schema.XmlSchema.Read(System.Xml.XmlReader,System.Xml.Schema.ValidationEventHandler)">
+ <summary>Reads an XML Schema from the supplied <see cref="T:System.Xml.XmlReader" />.</summary>
+ <param name="reader">The <see langword="XmlReader" /> containing the XML Schema to read.</param>
+ <param name="validationEventHandler">The validation event handler that receives information about the XML Schema syntax errors.</param>
+ <returns>The <see cref="T:System.Xml.Schema.XmlSchema" /> object representing the XML Schema.</returns>
+ <exception cref="T:System.Xml.Schema.XmlSchemaException">An <see cref="T:System.Xml.Schema.XmlSchemaException" /> is raised if no <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified.</exception>
+ </member>
<member name="P:System.Xml.Schema.XmlSchema.SchemaTypes">
<summary>Gets the post-schema-compilation value of all schema types in the schema.</summary>
<returns>An <see cref="T:System.Xml.Schema.XmlSchemaObjectCollection" /> of all schema types in the schema.</returns>
<summary>Gets or sets the version of the schema.</summary>
<returns>The version of the schema. The default value is <see langword="String.Empty" />.</returns>
</member>
+ <member name="M:System.Xml.Schema.XmlSchema.Write(System.IO.Stream)">
+ <summary>Writes the XML Schema to the supplied data stream.</summary>
+ <param name="stream">The supplied data stream.</param>
+ </member>
+ <member name="M:System.Xml.Schema.XmlSchema.Write(System.IO.Stream,System.Xml.XmlNamespaceManager)">
+ <summary>Writes the XML Schema to the supplied <see cref="T:System.IO.Stream" /> using the <see cref="T:System.Xml.XmlNamespaceManager" /> specified.</summary>
+ <param name="stream">The supplied data stream.</param>
+ <param name="namespaceManager">The <see cref="T:System.Xml.XmlNamespaceManager" />.</param>
+ </member>
+ <member name="M:System.Xml.Schema.XmlSchema.Write(System.IO.TextWriter)">
+ <summary>Writes the XML Schema to the supplied <see cref="T:System.IO.TextWriter" />.</summary>
+ <param name="writer">The <see cref="T:System.IO.TextWriter" /> to write to.</param>
+ </member>
+ <member name="M:System.Xml.Schema.XmlSchema.Write(System.IO.TextWriter,System.Xml.XmlNamespaceManager)">
+ <summary>Writes the XML Schema to the supplied <see cref="T:System.IO.TextWriter" />.</summary>
+ <param name="writer">The <see cref="T:System.IO.TextWriter" /> to write to.</param>
+ <param name="namespaceManager">The <see cref="T:System.Xml.XmlNamespaceManager" />.</param>
+ </member>
+ <member name="M:System.Xml.Schema.XmlSchema.Write(System.Xml.XmlWriter)">
+ <summary>Writes the XML Schema to the supplied <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="writer">The <see cref="T:System.Xml.XmlWriter" /> to write to.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> parameter is null.</exception>
+ </member>
+ <member name="M:System.Xml.Schema.XmlSchema.Write(System.Xml.XmlWriter,System.Xml.XmlNamespaceManager)">
+ <summary>Writes the XML Schema to the supplied <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="writer">The <see cref="T:System.Xml.XmlWriter" /> to write to.</param>
+ <param name="namespaceManager">The <see cref="T:System.Xml.XmlNamespaceManager" />.</param>
+ </member>
<member name="T:System.Xml.Schema.XmlSchemaAll">
<summary>Represents the World Wide Web Consortium (W3C) <see langword="all" /> element (compositor).</summary>
</member>
<member name="T:System.Xml.Schema.XmlSchemaCollection">
<summary>Contains a cache of XML Schema definition language (XSD) and XML-Data Reduced (XDR) schemas. The <see cref="T:System.Xml.Schema.XmlSchemaCollection" /> class is obsolete. Use <see cref="T:System.Xml.Schema.XmlSchemaSet" /> instead.</summary>
</member>
- <member name="E:System.Xml.Schema.XmlSchemaCollection.ValidationEventHandler">
- <summary>Sets an event handler for receiving information about the XDR and XML schema validation errors.</summary>
- </member>
<member name="M:System.Xml.Schema.XmlSchemaCollection.#ctor">
<summary>Initializes a new instance of the <see langword="XmlSchemaCollection" /> class.</summary>
</member>
<summary>Adds the schema located by the given URL into the schema collection.</summary>
<param name="ns">The namespace URI associated with the schema. For XML Schemas, this will typically be the <see langword="targetNamespace" />.</param>
<param name="uri">The URL that specifies the schema to load.</param>
- <exception cref="T:System.Xml.XmlException">The schema is not a valid schema.</exception>
<returns>The <see cref="T:System.Xml.Schema.XmlSchema" /> added to the schema collection; <see langword="null" /> if the schema being added is an XDR schema or if there are compilation errors in the schema.</returns>
+ <exception cref="T:System.Xml.XmlException">The schema is not a valid schema.</exception>
</member>
<member name="M:System.Xml.Schema.XmlSchemaCollection.Add(System.String,System.Xml.XmlReader)">
<summary>Adds the schema contained in the <see cref="T:System.Xml.XmlReader" /> to the schema collection.</summary>
<param name="ns">The namespace URI associated with the schema. For XML Schemas, this will typically be the <see langword="targetNamespace" />.</param>
<param name="reader">
<see cref="T:System.Xml.XmlReader" /> containing the schema to add.</param>
- <exception cref="T:System.Xml.XmlException">The schema is not a valid schema.</exception>
<returns>The <see cref="T:System.Xml.Schema.XmlSchema" /> added to the schema collection; <see langword="null" /> if the schema being added is an XDR schema or if there are compilation errors in the schema.</returns>
+ <exception cref="T:System.Xml.XmlException">The schema is not a valid schema.</exception>
</member>
<member name="M:System.Xml.Schema.XmlSchemaCollection.Add(System.String,System.Xml.XmlReader,System.Xml.XmlResolver)">
<summary>Adds the schema contained in the <see cref="T:System.Xml.XmlReader" /> to the schema collection. The specified <see cref="T:System.Xml.XmlResolver" /> is used to resolve any external resources.</summary>
<param name="reader">
<see cref="T:System.Xml.XmlReader" /> containing the schema to add.</param>
<param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve namespaces referenced in <see langword="include" /> and <see langword="import" /> elements or <see langword="x-schema" /> attribute (XDR schemas). If this is <see langword="null" />, external references are not resolved.</param>
- <exception cref="T:System.Xml.XmlException">The schema is not a valid schema.</exception>
<returns>The <see cref="T:System.Xml.Schema.XmlSchema" /> added to the schema collection; <see langword="null" /> if the schema being added is an XDR schema or if there are compilation errors in the schema.</returns>
+ <exception cref="T:System.Xml.XmlException">The schema is not a valid schema.</exception>
</member>
<member name="M:System.Xml.Schema.XmlSchemaCollection.Add(System.Xml.Schema.XmlSchema)">
<summary>Adds the <see cref="T:System.Xml.Schema.XmlSchema" /> to the collection.</summary>
<summary>Adds the <see cref="T:System.Xml.Schema.XmlSchema" /> to the collection. The specified <see cref="T:System.Xml.XmlResolver" /> is used to resolve any external references.</summary>
<param name="schema">The <see langword="XmlSchema" /> to add to the collection.</param>
<param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve namespaces referenced in <see langword="include" /> and <see langword="import" /> elements. If this is <see langword="null" />, external references are not resolved.</param>
- <exception cref="T:System.Xml.XmlException">The schema is not a valid schema.</exception>
<returns>The <see langword="XmlSchema" /> added to the schema collection.</returns>
+ <exception cref="T:System.Xml.XmlException">The schema is not a valid schema.</exception>
</member>
<member name="M:System.Xml.Schema.XmlSchemaCollection.Add(System.Xml.Schema.XmlSchemaCollection)">
<summary>Adds all the namespaces defined in the given collection (including their associated schemas) to this collection.</summary>
<param name="array">The array to copy the objects to.</param>
<param name="index">The index in <paramref name="array" /> where copying will begin.</param>
</member>
- <member name="M:System.Xml.Schema.XmlSchemaCollection.GetEnumerator">
- <summary>Provides support for the "for each" style iteration over the collection of schemas.</summary>
- <returns>An enumerator for iterating over all schemas in the current collection.</returns>
- </member>
- <member name="M:System.Xml.Schema.XmlSchemaCollection.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
- <summary>For a description of this member, see <see cref="M:System.Xml.Schema.XmlSchemaCollection.CopyTo(System.Xml.Schema.XmlSchema[],System.Int32)" />.</summary>
- <param name="array">The array to copy the objects to.</param>
- <param name="index">The index in <paramref name="array" /> where copying will begin.</param>
- </member>
- <member name="M:System.Xml.Schema.XmlSchemaCollection.System#Collections#IEnumerable#GetEnumerator">
- <summary>For a description of this member, see <see cref="M:System.Xml.Schema.XmlSchemaCollection.GetEnumerator" />.</summary>
- <returns>The <see cref="T:System.Collections.IEnumerator" /> for the collection.</returns>
- </member>
<member name="P:System.Xml.Schema.XmlSchemaCollection.Count">
<summary>Gets the number of namespaces defined in this collection.</summary>
<returns>The number of namespaces defined in this collection.</returns>
</member>
+ <member name="M:System.Xml.Schema.XmlSchemaCollection.GetEnumerator">
+ <summary>Provides support for the "for each" style iteration over the collection of schemas.</summary>
+ <returns>An enumerator for iterating over all schemas in the current collection.</returns>
+ </member>
<member name="P:System.Xml.Schema.XmlSchemaCollection.Item(System.String)">
<summary>Gets the <see cref="T:System.Xml.Schema.XmlSchema" /> associated with the given namespace URI.</summary>
<param name="ns">The namespace URI associated with the schema you want to return. This will typically be the <see langword="targetNamespace" /> of the schema.</param>
<summary>Gets the default <see langword="XmlNameTable" /> used by the <see langword="XmlSchemaCollection" /> when loading new schemas.</summary>
<returns>An <see langword="XmlNameTable" />.</returns>
</member>
+ <member name="M:System.Xml.Schema.XmlSchemaCollection.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
+ <summary>For a description of this member, see <see cref="M:System.Xml.Schema.XmlSchemaCollection.CopyTo(System.Xml.Schema.XmlSchema[],System.Int32)" />.</summary>
+ <param name="array">The array to copy the objects to.</param>
+ <param name="index">The index in <paramref name="array" /> where copying will begin.</param>
+ </member>
<member name="P:System.Xml.Schema.XmlSchemaCollection.System#Collections#ICollection#Count">
<summary>For a description of this member, see <see cref="P:System.Xml.Schema.XmlSchemaCollection.Count" />.</summary>
<returns>The count of the items in the collection.</returns>
<summary>For a description of this member, see <see cref="P:System.Xml.Schema.XmlSchemaCollection.System#Collections#ICollection#SyncRoot" />.</summary>
<returns>A <see cref="P:System.Collections.ICollection.SyncRoot" /> object that can be used to synchronize access to the collection.</returns>
</member>
- <member name="T:System.Xml.Schema.XmlSchemaCollectionEnumerator">
- <summary>Supports a simple iteration over a collection. This class cannot be inherited.</summary>
+ <member name="M:System.Xml.Schema.XmlSchemaCollection.System#Collections#IEnumerable#GetEnumerator">
+ <summary>For a description of this member, see <see cref="M:System.Xml.Schema.XmlSchemaCollection.GetEnumerator" />.</summary>
+ <returns>The <see cref="T:System.Collections.IEnumerator" /> for the collection.</returns>
+ </member>
+ <member name="E:System.Xml.Schema.XmlSchemaCollection.ValidationEventHandler">
+ <summary>Sets an event handler for receiving information about the XDR and XML schema validation errors.</summary>
+ </member>
+ <member name="T:System.Xml.Schema.XmlSchemaCollectionEnumerator">
+ <summary>Supports a simple iteration over a collection. This class cannot be inherited.</summary>
+ </member>
+ <member name="P:System.Xml.Schema.XmlSchemaCollectionEnumerator.Current">
+ <summary>Gets the current <see cref="T:System.Xml.Schema.XmlSchema" /> in the collection.</summary>
+ <returns>The current <see langword="XmlSchema" /> in the collection.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaCollectionEnumerator.MoveNext">
<summary>Advances the enumerator to the next schema in the collection.</summary>
<returns>
<see langword="true" /> if the move was successful; <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
</member>
+ <member name="P:System.Xml.Schema.XmlSchemaCollectionEnumerator.System#Collections#IEnumerator#Current">
+ <summary>For a description of this member, see <see cref="P:System.Xml.Schema.XmlSchemaCollectionEnumerator.Current" />.</summary>
+ <returns>The current node.</returns>
+ </member>
<member name="M:System.Xml.Schema.XmlSchemaCollectionEnumerator.System#Collections#IEnumerator#MoveNext">
<summary>For a description of this member, see <see cref="M:System.Xml.Schema.XmlSchemaCollectionEnumerator.MoveNext" />.</summary>
<returns>The next node.</returns>
<member name="M:System.Xml.Schema.XmlSchemaCollectionEnumerator.System#Collections#IEnumerator#Reset">
<summary>For a description of this member, see <see cref="M:System.Xml.Schema.XmlSchemaCollectionEnumerator.System#Collections#IEnumerator#Reset" />.</summary>
</member>
- <member name="P:System.Xml.Schema.XmlSchemaCollectionEnumerator.Current">
- <summary>Gets the current <see cref="T:System.Xml.Schema.XmlSchema" /> in the collection.</summary>
- <returns>The current <see langword="XmlSchema" /> in the collection.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaCollectionEnumerator.System#Collections#IEnumerator#Current">
- <summary>For a description of this member, see <see cref="P:System.Xml.Schema.XmlSchemaCollectionEnumerator.Current" />.</summary>
- <returns>The current node.</returns>
- </member>
<member name="T:System.Xml.Schema.XmlSchemaCompilationSettings">
<summary>Provides schema compilation options for the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> class This class cannot be inherited.</summary>
</member>
</member>
<member name="F:System.Xml.Schema.XmlSchemaContentProcessing.Lax">
<summary>If the associated schema is found, the document items will be validated. No errors will be thrown otherwise.
-
If the item is not validated, the XML processor attempts to notify the client through a validation event handler with <see cref="P:System.Xml.Schema.ValidationEventArgs.Severity" /> = <see langword="XmlSeverityType.Warning" />. If a validation event handler has not been set up, no information is returned when the warning is produced.</summary>
</member>
<member name="F:System.Xml.Schema.XmlSchemaContentProcessing.None">
</member>
<member name="F:System.Xml.Schema.XmlSchemaContentProcessing.Skip">
<summary>Document items must consist of well-formed XML and are not validated by the schema.
-
The XML processor attempts to notify the client through a validation event handler with <see cref="P:System.Xml.Schema.ValidationEventArgs.Severity" /> = <see langword="XmlSeverityType.Warning" /> that no validation took place for the given item. If a validation event handler has not been set up, no information is returned when the warning is produced.</summary>
</member>
<member name="F:System.Xml.Schema.XmlSchemaContentProcessing.Strict">
<summary>The schema processor must find a schema associated with the indicated namespace to validate the document items.
-
If the processor cannot find a schema or if the items are not valid, the XML processor attempts to notify the client through a validation event handler with <see cref="P:System.Xml.Schema.ValidationEventArgs.Severity" /> = <see langword="XmlSeverityType.Warning" />. If a validation error occurs and a validation event handler is not provided, an exception is thrown.</summary>
</member>
<member name="T:System.Xml.Schema.XmlSchemaContentType">
<summary>Converts the value specified, whose type is one of the valid Common Language Runtime (CLR) representations of the XML schema type represented by the <see cref="T:System.Xml.Schema.XmlSchemaDatatype" />, to the CLR type specified.</summary>
<param name="value">The input value to convert to the specified type.</param>
<param name="targetType">The target type to convert the input value to.</param>
+ <returns>The converted input value.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="T:System.Object" /> or <see cref="T:System.Type" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidCastException">The type represented by the <see cref="T:System.Xml.Schema.XmlSchemaDatatype" /> does not support a conversion from type of the value specified to the type specified.</exception>
- <returns>The converted input value.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaDatatype.ChangeType(System.Object,System.Type,System.Xml.IXmlNamespaceResolver)">
<summary>Converts the value specified, whose type is one of the valid Common Language Runtime (CLR) representations of the XML schema type represented by the <see cref="T:System.Xml.Schema.XmlSchemaDatatype" />, to the CLR type specified using the <see cref="T:System.Xml.IXmlNamespaceResolver" /> if the <see cref="T:System.Xml.Schema.XmlSchemaDatatype" /> represents the xs:QName type or a type derived from it.</summary>
<param name="value">The input value to convert to the specified type.</param>
<param name="targetType">The target type to convert the input value to.</param>
<param name="namespaceResolver">An <see cref="T:System.Xml.IXmlNamespaceResolver" /> used for resolving namespace prefixes. This is only of use if the <see cref="T:System.Xml.Schema.XmlSchemaDatatype" /> represents the xs:QName type or a type derived from it.</param>
+ <returns>The converted input value.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="T:System.Object" /> or <see cref="T:System.Type" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidCastException">The type represented by the <see cref="T:System.Xml.Schema.XmlSchemaDatatype" /> does not support a conversion from type of the value specified to the type specified.</exception>
- <returns>The converted input value.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaDatatype.IsDerivedFrom(System.Xml.Schema.XmlSchemaDatatype)">
<summary>The <see cref="M:System.Xml.Schema.XmlSchemaDatatype.IsDerivedFrom(System.Xml.Schema.XmlSchemaDatatype)" /> method always returns <see langword="false" />.</summary>
<param name="s">The <see langword="string" /> to validate against the simple type.</param>
<param name="nameTable">The <see cref="T:System.Xml.XmlNameTable" /> to use for atomization while parsing the <see langword="string" /> if this <see cref="T:System.Xml.Schema.XmlSchemaDatatype" /> object represents the xs:NCName type.</param>
<param name="nsmgr">The <see cref="T:System.Xml.IXmlNamespaceResolver" /> object to use while parsing the <see langword="string" /> if this <see cref="T:System.Xml.Schema.XmlSchemaDatatype" /> object represents the xs:QName type.</param>
+ <returns>An <see cref="T:System.Object" /> that can be cast safely to the type returned by the <see cref="P:System.Xml.Schema.XmlSchemaDatatype.ValueType" /> property.</returns>
<exception cref="T:System.Xml.Schema.XmlSchemaValidationException">The input value is not a valid instance of this W3C XML Schema type.</exception>
<exception cref="T:System.ArgumentNullException">The value to parse cannot be <see langword="null" />.</exception>
- <returns>An <see cref="T:System.Object" /> that can be cast safely to the type returned by the <see cref="P:System.Xml.Schema.XmlSchemaDatatype.ValueType" /> property.</returns>
</member>
<member name="P:System.Xml.Schema.XmlSchemaDatatype.TokenizedType">
<summary>When overridden in a derived class, gets the type for the <see langword="string" /> as specified in the World Wide Web Consortium (W3C) XML 1.0 specification.</summary>
<member name="M:System.Xml.Schema.XmlSchemaException.#ctor(System.String,System.Exception)">
<summary>Initializes a new instance of the <see cref="T:System.Xml.Schema.XmlSchemaException" /> class with the exception message and original <see cref="T:System.Exception" /> object that caused this exception specified.</summary>
<param name="message">A <see langword="string" /> description of the error condition.</param>
- <param name="innerException">The original <see cref="T:System.Exception" /> object that caused this exception.</param>
+ <param name="innerException">The original T:System.Exception object that caused this exception.</param>
</member>
<member name="M:System.Xml.Schema.XmlSchemaException.#ctor(System.String,System.Exception,System.Int32,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.Xml.Schema.XmlSchemaException" /> class with the exception message specified, and the original <see cref="T:System.Exception" /> object, line number, and line position of the XML that cause this exception specified.</summary>
<param name="message">A <see langword="string" /> description of the error condition.</param>
- <param name="innerException">The original <see cref="T:System.Exception" /> object that caused this exception.</param>
+ <param name="innerException">The original T:System.Exception object that caused this exception.</param>
<param name="lineNumber">The line number of the XML that caused this exception.</param>
<param name="linePosition">The line position of the XML that caused this exception.</param>
</member>
<member name="M:System.Xml.Schema.XmlSchemaInference.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.Schema.XmlSchemaInference" /> class.</summary>
</member>
+ <member name="T:System.Xml.Schema.XmlSchemaInference.InferenceOption">
+ <summary>Affects occurrence and type information inferred by the <see cref="T:System.Xml.Schema.XmlSchemaInference" /> class for elements and attributes in an XML document.</summary>
+ </member>
+ <member name="F:System.Xml.Schema.XmlSchemaInference.InferenceOption.Relaxed">
+ <summary>Indicates that a less restrictive schema declaration should be inferred for a particular element or attribute.</summary>
+ </member>
+ <member name="F:System.Xml.Schema.XmlSchemaInference.InferenceOption.Restricted">
+ <summary>Indicates that a more restrictive schema declaration should be inferred for a particular element or attribute.</summary>
+ </member>
<member name="M:System.Xml.Schema.XmlSchemaInference.InferSchema(System.Xml.XmlReader)">
<summary>Infers an XML Schema Definition Language (XSD) schema from the XML document contained in the <see cref="T:System.Xml.XmlReader" /> object specified.</summary>
<param name="instanceDocument">An <see cref="T:System.Xml.XmlReader" /> object containing the XML document to infer a schema from.</param>
+ <returns>An <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object containing the inferred schemas.</returns>
<exception cref="T:System.Xml.XmlException">The XML document is not well-formed.</exception>
<exception cref="T:System.Xml.Schema.XmlSchemaInferenceException">The <see cref="T:System.Xml.XmlReader" /> object is not positioned on the root node or on an element. An error occurs during the schema inference process.</exception>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object containing the inferred schemas.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaInference.InferSchema(System.Xml.XmlReader,System.Xml.Schema.XmlSchemaSet)">
<summary>Infers an XML Schema Definition Language (XSD) schema from the XML document contained in the <see cref="T:System.Xml.XmlReader" /> object specified, and refines the inferred schema using an existing schema in the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object specified with the same target namespace.</summary>
<param name="instanceDocument">An <see cref="T:System.Xml.XmlReader" /> object containing the XML document to infer a schema from.</param>
<param name="schemas">An <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object containing an existing schema used to refine the inferred schema.</param>
+ <returns>An <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object containing the inferred schemas.</returns>
<exception cref="T:System.Xml.XmlException">The XML document is not well-formed.</exception>
<exception cref="T:System.Xml.Schema.XmlSchemaInferenceException">The <see cref="T:System.Xml.XmlReader" /> object is not positioned on the root node or on an element. An error occurs during the schema inference process.</exception>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object containing the inferred schemas.</returns>
</member>
<member name="P:System.Xml.Schema.XmlSchemaInference.Occurrence">
<summary>Gets or sets the <see cref="T:System.Xml.Schema.XmlSchemaInference.InferenceOption" /> value that affects schema occurrence declarations inferred from the XML document.</summary>
<summary>Gets or sets the <see cref="T:System.Xml.Schema.XmlSchemaInference.InferenceOption" /> value that affects types inferred from the XML document.</summary>
<returns>An <see cref="T:System.Xml.Schema.XmlSchemaInference.InferenceOption" /> object.</returns>
</member>
- <member name="T:System.Xml.Schema.XmlSchemaInference.InferenceOption">
- <summary>Affects occurrence and type information inferred by the <see cref="T:System.Xml.Schema.XmlSchemaInference" /> class for elements and attributes in an XML document.</summary>
- </member>
- <member name="F:System.Xml.Schema.XmlSchemaInference.InferenceOption.Relaxed">
- <summary>Indicates that a less restrictive schema declaration should be inferred for a particular element or attribute.</summary>
- </member>
- <member name="F:System.Xml.Schema.XmlSchemaInference.InferenceOption.Restricted">
- <summary>Indicates that a more restrictive schema declaration should be inferred for a particular element or attribute.</summary>
- </member>
<member name="T:System.Xml.Schema.XmlSchemaInferenceException">
<summary>Returns information about errors encountered by the <see cref="T:System.Xml.Schema.XmlSchemaInference" /> class while inferring a schema from an XML document.</summary>
</member>
<returns>The <see langword="system" /> identifier. The value must be a valid URI.</returns>
</member>
<member name="T:System.Xml.Schema.XmlSchemaNumericFacet">
- <summary>Abstract class for defining <see langword="numeric" /> facets. This class is the base class for numeric facet classes such as <see cref="T:System.Xml.Schema.XmlSchemaMinLengthFacet" />.</summary>
+ <summary>Abstract class for defining <see langword="numeric" /> facets. This class is the base class for numeric facet classes such as <see cref="T:System.Xml.Schema.XmlSchemaMinLengthFacet" /></summary>
</member>
<member name="M:System.Xml.Schema.XmlSchemaNumericFacet.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.Schema.XmlSchemaNumericFacet" /> class.</summary>
<member name="M:System.Xml.Schema.XmlSchemaObjectCollection.Add(System.Xml.Schema.XmlSchemaObject)">
<summary>Adds an <see cref="T:System.Xml.Schema.XmlSchemaObject" /> to the <see langword="XmlSchemaObjectCollection" />.</summary>
<param name="item">The <see cref="T:System.Xml.Schema.XmlSchemaObject" />.</param>
+ <returns>The index at which the item has been added.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index" /> is less than zero.
-
- -or-
-
- <paramref name="index" /> is greater than <see langword="Count" />.</exception>
+ <paramref name="index" /> is less than zero.
+-or-
+<paramref name="index" /> is greater than <see langword="Count" />.</exception>
<exception cref="T:System.InvalidCastException">The <see cref="T:System.Xml.Schema.XmlSchemaObject" /> parameter specified is not of type <see cref="T:System.Xml.Schema.XmlSchemaExternal" /> or its derived types <see cref="T:System.Xml.Schema.XmlSchemaImport" />, <see cref="T:System.Xml.Schema.XmlSchemaInclude" />, and <see cref="T:System.Xml.Schema.XmlSchemaRedefine" />.</exception>
- <returns>The index at which the item has been added.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaObjectCollection.Contains(System.Xml.Schema.XmlSchemaObject)">
<summary>Indicates if the specified <see cref="T:System.Xml.Schema.XmlSchemaObject" /> is in the <see langword="XmlSchemaObjectCollection" />.</summary>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
- <paramref name="array" /> is multi-dimensional.
-
+ <paramref name="array" /> is multi-dimensional.
-or-
-
- <paramref name="index" /> is equal to or greater than the length of <paramref name="array" />.
-
+<paramref name="index" /> is equal to or greater than the length of <paramref name="array" />.
-or-
-
- The number of elements in the source <see cref="T:System.Xml.Schema.XmlSchemaObject" /> is greater than the available space from index to the end of the destination array.</exception>
+The number of elements in the source <see cref="T:System.Xml.Schema.XmlSchemaObject" /> is greater than the available space from index to the end of the destination array.</exception>
<exception cref="T:System.InvalidCastException">The type of the source <see cref="T:System.Xml.Schema.XmlSchemaObject" /> cannot be cast automatically to the type of the destination array.</exception>
</member>
<member name="M:System.Xml.Schema.XmlSchemaObjectCollection.GetEnumerator">
<param name="index">The zero-based index at which an item should be inserted.</param>
<param name="item">The <see cref="T:System.Xml.Schema.XmlSchemaObject" /> to insert.</param>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index" /> is less than zero.
-
- -or-
-
- <paramref name="index" /> is greater than <see langword="Count" />.</exception>
+ <paramref name="index" /> is less than zero.
+-or-
+<paramref name="index" /> is greater than <see langword="Count" />.</exception>
+ </member>
+ <member name="P:System.Xml.Schema.XmlSchemaObjectCollection.Item(System.Int32)">
+ <summary>Gets the <see cref="T:System.Xml.Schema.XmlSchemaObject" /> at the specified index.</summary>
+ <param name="index">The index of the <see cref="T:System.Xml.Schema.XmlSchemaObject" />.</param>
+ <returns>The <see cref="T:System.Xml.Schema.XmlSchemaObject" /> at the specified index.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaObjectCollection.OnClear">
<summary>
<summary>Removes an <see cref="T:System.Xml.Schema.XmlSchemaObject" /> from the <see langword="XmlSchemaObjectCollection" />.</summary>
<param name="item">The <see cref="T:System.Xml.Schema.XmlSchemaObject" /> to remove.</param>
</member>
- <member name="P:System.Xml.Schema.XmlSchemaObjectCollection.Item(System.Int32)">
- <summary>Gets the <see cref="T:System.Xml.Schema.XmlSchemaObject" /> at the specified index.</summary>
- <param name="index">The index of the <see cref="T:System.Xml.Schema.XmlSchemaObject" />.</param>
- <returns>The <see cref="T:System.Xml.Schema.XmlSchemaObject" /> at the specified index.</returns>
- </member>
<member name="T:System.Xml.Schema.XmlSchemaObjectEnumerator">
<summary>Represents the enumerator for the <see cref="T:System.Xml.Schema.XmlSchemaObjectCollection" />.</summary>
</member>
+ <member name="P:System.Xml.Schema.XmlSchemaObjectEnumerator.Current">
+ <summary>Gets the current <see cref="T:System.Xml.Schema.XmlSchemaObject" /> in the collection.</summary>
+ <returns>The current <see cref="T:System.Xml.Schema.XmlSchemaObject" />.</returns>
+ </member>
<member name="M:System.Xml.Schema.XmlSchemaObjectEnumerator.MoveNext">
<summary>Moves to the next item in the collection.</summary>
<returns>
<member name="M:System.Xml.Schema.XmlSchemaObjectEnumerator.Reset">
<summary>Resets the enumerator to the start of the collection.</summary>
</member>
+ <member name="P:System.Xml.Schema.XmlSchemaObjectEnumerator.System#Collections#IEnumerator#Current">
+ <summary>For a description of this member, see <see cref="P:System.Xml.Schema.XmlSchemaObjectEnumerator.Current" />.</summary>
+ <returns>The current <see cref="T:System.Xml.Schema.XmlSchemaObject" />.</returns>
+ </member>
<member name="M:System.Xml.Schema.XmlSchemaObjectEnumerator.System#Collections#IEnumerator#MoveNext">
<summary>For a description of this member, see <see cref="M:System.Xml.Schema.XmlSchemaObjectEnumerator.MoveNext" />.</summary>
<returns>The next <see cref="T:System.Xml.Schema.XmlSchemaObject" />.</returns>
<member name="M:System.Xml.Schema.XmlSchemaObjectEnumerator.System#Collections#IEnumerator#Reset">
<summary>For a description of this member, see <see cref="M:System.Xml.Schema.XmlSchemaObjectEnumerator.Reset" />.</summary>
</member>
- <member name="P:System.Xml.Schema.XmlSchemaObjectEnumerator.Current">
- <summary>Gets the current <see cref="T:System.Xml.Schema.XmlSchemaObject" /> in the collection.</summary>
- <returns>The current <see cref="T:System.Xml.Schema.XmlSchemaObject" />.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaObjectEnumerator.System#Collections#IEnumerator#Current">
- <summary>For a description of this member, see <see cref="P:System.Xml.Schema.XmlSchemaObjectEnumerator.Current" />.</summary>
- <returns>The current <see cref="T:System.Xml.Schema.XmlSchemaObject" />.</returns>
- </member>
<member name="T:System.Xml.Schema.XmlSchemaObjectTable">
<summary>Provides the collections for contained elements in the <see cref="T:System.Xml.Schema.XmlSchema" /> class (for example, Attributes, AttributeGroups, Elements, and so on).</summary>
</member>
<returns>
<see langword="true" /> if the qualified name specified exists in the collection; otherwise, <see langword="false" />.</returns>
</member>
- <member name="M:System.Xml.Schema.XmlSchemaObjectTable.GetEnumerator">
- <summary>Returns an enumerator that can iterate through the <see cref="T:System.Xml.Schema.XmlSchemaObjectTable" />.</summary>
- <returns>An <see cref="T:System.Collections.IDictionaryEnumerator" /> that can iterate through <see cref="T:System.Xml.Schema.XmlSchemaObjectTable" />.</returns>
- </member>
<member name="P:System.Xml.Schema.XmlSchemaObjectTable.Count">
<summary>Gets the number of items contained in the <see cref="T:System.Xml.Schema.XmlSchemaObjectTable" />.</summary>
<returns>The number of items contained in the <see cref="T:System.Xml.Schema.XmlSchemaObjectTable" />.</returns>
</member>
+ <member name="M:System.Xml.Schema.XmlSchemaObjectTable.GetEnumerator">
+ <summary>Returns an enumerator that can iterate through the <see cref="T:System.Xml.Schema.XmlSchemaObjectTable" />.</summary>
+ <returns>An <see cref="T:System.Collections.IDictionaryEnumerator" /> that can iterate through <see cref="T:System.Xml.Schema.XmlSchemaObjectTable" />.</returns>
+ </member>
<member name="P:System.Xml.Schema.XmlSchemaObjectTable.Item(System.Xml.XmlQualifiedName)">
<summary>Returns the element in the <see cref="T:System.Xml.Schema.XmlSchemaObjectTable" /> specified by qualified name.</summary>
<param name="name">The <see cref="T:System.Xml.XmlQualifiedName" /> of the element to return.</param>
<member name="T:System.Xml.Schema.XmlSchemaSet">
<summary>Contains a cache of XML Schema definition language (XSD) schemas.</summary>
</member>
- <member name="E:System.Xml.Schema.XmlSchemaSet.ValidationEventHandler">
- <summary>Specifies an event handler for receiving information about XML Schema definition language (XSD) schema validation errors.</summary>
- </member>
<member name="M:System.Xml.Schema.XmlSchemaSet.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> class.</summary>
</member>
<summary>Adds the XML Schema definition language (XSD) schema at the URL specified to the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
<param name="targetNamespace">The schema <paramref name="targetNamespace" /> property, or <see langword="null" /> to use the <paramref name="targetNamespace" /> specified in the schema.</param>
<param name="schemaUri">The URL that specifies the schema to load.</param>
+ <returns>An <see cref="T:System.Xml.Schema.XmlSchema" /> object if the schema is valid. If the schema is not valid and a <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified, then <see langword="null" /> is returned and the appropriate validation event is raised. Otherwise, an <see cref="T:System.Xml.Schema.XmlSchemaException" /> is thrown.</returns>
<exception cref="T:System.Xml.Schema.XmlSchemaException">The schema is not valid.</exception>
<exception cref="T:System.ArgumentNullException">The URL passed as a parameter is <see langword="null" /> or <see cref="F:System.String.Empty" />.</exception>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema" /> object if the schema is valid. If the schema is not valid and a <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified, then <see langword="null" /> is returned and the appropriate validation event is raised. Otherwise, an <see cref="T:System.Xml.Schema.XmlSchemaException" /> is thrown.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaSet.Add(System.String,System.Xml.XmlReader)">
<summary>Adds the XML Schema definition language (XSD) schema contained in the <see cref="T:System.Xml.XmlReader" /> to the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
<param name="targetNamespace">The schema <paramref name="targetNamespace" /> property, or <see langword="null" /> to use the <paramref name="targetNamespace" /> specified in the schema.</param>
<param name="schemaDocument">The <see cref="T:System.Xml.XmlReader" /> object.</param>
+ <returns>An <see cref="T:System.Xml.Schema.XmlSchema" /> object if the schema is valid. If the schema is not valid and a <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified, then <see langword="null" /> is returned and the appropriate validation event is raised. Otherwise, an <see cref="T:System.Xml.Schema.XmlSchemaException" /> is thrown.</returns>
<exception cref="T:System.Xml.Schema.XmlSchemaException">The schema is not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.XmlReader" /> object passed as a parameter is <see langword="null" />.</exception>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema" /> object if the schema is valid. If the schema is not valid and a <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified, then <see langword="null" /> is returned and the appropriate validation event is raised. Otherwise, an <see cref="T:System.Xml.Schema.XmlSchemaException" /> is thrown.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaSet.Add(System.Xml.Schema.XmlSchema)">
<summary>Adds the given <see cref="T:System.Xml.Schema.XmlSchema" /> to the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
<param name="schema">The <see cref="T:System.Xml.Schema.XmlSchema" /> object to add to the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</param>
+ <returns>An <see cref="T:System.Xml.Schema.XmlSchema" /> object if the schema is valid. If the schema is not valid and a <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified, then <see langword="null" /> is returned and the appropriate validation event is raised. Otherwise, an <see cref="T:System.Xml.Schema.XmlSchemaException" /> is thrown.</returns>
<exception cref="T:System.Xml.Schema.XmlSchemaException">The schema is not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.Schema.XmlSchema" /> object passed as a parameter is <see langword="null" />.</exception>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema" /> object if the schema is valid. If the schema is not valid and a <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified, then <see langword="null" /> is returned and the appropriate validation event is raised. Otherwise, an <see cref="T:System.Xml.Schema.XmlSchemaException" /> is thrown.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaSet.Add(System.Xml.Schema.XmlSchemaSet)">
<summary>Adds all the XML Schema definition language (XSD) schemas in the given <see cref="T:System.Xml.Schema.XmlSchemaSet" /> to the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
<exception cref="T:System.Xml.Schema.XmlSchemaException">A schema in the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> is not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object passed as a parameter is <see langword="null" />.</exception>
</member>
+ <member name="P:System.Xml.Schema.XmlSchemaSet.CompilationSettings">
+ <summary>Gets or sets the <see cref="T:System.Xml.Schema.XmlSchemaCompilationSettings" /> for the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
+ <returns>The <see cref="T:System.Xml.Schema.XmlSchemaCompilationSettings" /> for the <see cref="T:System.Xml.Schema.XmlSchemaSet" />. The default is an <see cref="T:System.Xml.Schema.XmlSchemaCompilationSettings" /> instance with the <see cref="P:System.Xml.Schema.XmlSchemaCompilationSettings.EnableUpaCheck" /> property set to <see langword="true" />.</returns>
+ </member>
<member name="M:System.Xml.Schema.XmlSchemaSet.Compile">
<summary>Compiles the XML Schema definition language (XSD) schemas added to the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> into one logical schema.</summary>
<exception cref="T:System.Xml.Schema.XmlSchemaException">An error occurred when validating and compiling the schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</exception>
<member name="M:System.Xml.Schema.XmlSchemaSet.Contains(System.Xml.Schema.XmlSchema)">
<summary>Indicates whether the specified XML Schema definition language (XSD) <see cref="T:System.Xml.Schema.XmlSchema" /> object is in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
<param name="schema">The <see cref="T:System.Xml.Schema.XmlSchema" /> object.</param>
- <exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.Schema.XmlSchemaSet" /> passed as a parameter is <see langword="null" />.</exception>
<returns>
<see langword="true" /> if the <see cref="T:System.Xml.Schema.XmlSchema" /> object is in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.Schema.XmlSchemaSet" /> passed as a parameter is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.Schema.XmlSchemaSet.CopyTo(System.Xml.Schema.XmlSchema[],System.Int32)">
<summary>Copies all the <see cref="T:System.Xml.Schema.XmlSchema" /> objects from the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> to the given array, starting at the given index.</summary>
<param name="schemas">The array to copy the objects to.</param>
<param name="index">The index in the array where copying will begin.</param>
</member>
+ <member name="P:System.Xml.Schema.XmlSchemaSet.Count">
+ <summary>Gets the number of logical XML Schema definition language (XSD) schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
+ <returns>The number of logical schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</returns>
+ </member>
+ <member name="P:System.Xml.Schema.XmlSchemaSet.GlobalAttributes">
+ <summary>Gets all the global attributes in all the XML Schema definition language (XSD) schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
+ <returns>The collection of global attributes.</returns>
+ </member>
+ <member name="P:System.Xml.Schema.XmlSchemaSet.GlobalElements">
+ <summary>Gets all the global elements in all the XML Schema definition language (XSD) schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
+ <returns>The collection of global elements.</returns>
+ </member>
+ <member name="P:System.Xml.Schema.XmlSchemaSet.GlobalTypes">
+ <summary>Gets all of the global simple and complex types in all the XML Schema definition language (XSD) schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
+ <returns>The collection of global simple and complex types.</returns>
+ </member>
+ <member name="P:System.Xml.Schema.XmlSchemaSet.IsCompiled">
+ <summary>Gets a value that indicates whether the XML Schema definition language (XSD) schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> have been compiled.</summary>
+ <returns>
+ <see langword="true" /> if the schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> have been compiled since the last time a schema was added or removed from the <see cref="T:System.Xml.Schema.XmlSchemaSet" />; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.Schema.XmlSchemaSet.NameTable">
+ <summary>Gets the default <see cref="T:System.Xml.XmlNameTable" /> used by the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> when loading new XML Schema definition language (XSD) schemas.</summary>
+ <returns>A table of atomized string objects.</returns>
+ </member>
<member name="M:System.Xml.Schema.XmlSchemaSet.Remove(System.Xml.Schema.XmlSchema)">
<summary>Removes the specified XML Schema definition language (XSD) schema from the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
<param name="schema">The <see cref="T:System.Xml.Schema.XmlSchema" /> object to remove from the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</param>
+ <returns>The <see cref="T:System.Xml.Schema.XmlSchema" /> object removed from the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> or <see langword="null" /> if the schema was not found in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</returns>
<exception cref="T:System.Xml.Schema.XmlSchemaException">The schema is not a valid schema.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.Schema.XmlSchema" /> passed as a parameter is <see langword="null" />.</exception>
- <returns>The <see cref="T:System.Xml.Schema.XmlSchema" /> object removed from the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> or <see langword="null" /> if the schema was not found in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaSet.RemoveRecursive(System.Xml.Schema.XmlSchema)">
<summary>Removes the specified XML Schema definition language (XSD) schema and all the schemas it imports from the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
<param name="schemaToRemove">The <see cref="T:System.Xml.Schema.XmlSchema" /> object to remove from the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</param>
- <exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.Schema.XmlSchema" /> passed as a parameter is <see langword="null" />.</exception>
<returns>
<see langword="true" /> if the <see cref="T:System.Xml.Schema.XmlSchema" /> object and all its imports were successfully removed; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.Schema.XmlSchema" /> passed as a parameter is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.Schema.XmlSchemaSet.Reprocess(System.Xml.Schema.XmlSchema)">
<summary>Reprocesses an XML Schema definition language (XSD) schema that already exists in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
<param name="schema">The schema to reprocess.</param>
+ <returns>An <see cref="T:System.Xml.Schema.XmlSchema" /> object if the schema is a valid schema. If the schema is not valid and a <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified, <see langword="null" /> is returned and the appropriate validation event is raised. Otherwise, an <see cref="T:System.Xml.Schema.XmlSchemaException" /> is thrown.</returns>
<exception cref="T:System.Xml.Schema.XmlSchemaException">The schema is not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.Schema.XmlSchema" /> object passed as a parameter is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="T:System.Xml.Schema.XmlSchema" /> object passed as a parameter does not already exist in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</exception>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchema" /> object if the schema is a valid schema. If the schema is not valid and a <see cref="T:System.Xml.Schema.ValidationEventHandler" /> is specified, <see langword="null" /> is returned and the appropriate validation event is raised. Otherwise, an <see cref="T:System.Xml.Schema.XmlSchemaException" /> is thrown.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaSet.Schemas">
<summary>Returns a collection of all the XML Schema definition language (XSD) schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
<param name="targetNamespace">The schema <paramref name="targetNamespace" /> property.</param>
<returns>An <see cref="T:System.Collections.ICollection" /> object containing all the schemas that have been added to the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> that belong to the given namespace. If no schemas have been added to the <see cref="T:System.Xml.Schema.XmlSchemaSet" />, an empty <see cref="T:System.Collections.ICollection" /> object is returned.</returns>
</member>
- <member name="P:System.Xml.Schema.XmlSchemaSet.CompilationSettings">
- <summary>Gets or sets the <see cref="T:System.Xml.Schema.XmlSchemaCompilationSettings" /> for the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
- <returns>The <see cref="T:System.Xml.Schema.XmlSchemaCompilationSettings" /> for the <see cref="T:System.Xml.Schema.XmlSchemaSet" />. The default is an <see cref="T:System.Xml.Schema.XmlSchemaCompilationSettings" /> instance with the <see cref="P:System.Xml.Schema.XmlSchemaCompilationSettings.EnableUpaCheck" /> property set to <see langword="true" />.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaSet.Count">
- <summary>Gets the number of logical XML Schema definition language (XSD) schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
- <returns>The number of logical schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaSet.GlobalAttributes">
- <summary>Gets all the global attributes in all the XML Schema definition language (XSD) schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
- <returns>The collection of global attributes.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaSet.GlobalElements">
- <summary>Gets all the global elements in all the XML Schema definition language (XSD) schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
- <returns>The collection of global elements.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaSet.GlobalTypes">
- <summary>Gets all of the global simple and complex types in all the XML Schema definition language (XSD) schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" />.</summary>
- <returns>The collection of global simple and complex types.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaSet.IsCompiled">
- <summary>Gets a value that indicates whether the XML Schema definition language (XSD) schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> have been compiled.</summary>
- <returns>
- <see langword="true" /> if the schemas in the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> have been compiled since the last time a schema was added or removed from the <see cref="T:System.Xml.Schema.XmlSchemaSet" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaSet.NameTable">
- <summary>Gets the default <see cref="T:System.Xml.XmlNameTable" /> used by the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> when loading new XML Schema definition language (XSD) schemas.</summary>
- <returns>A table of atomized string objects.</returns>
+ <member name="E:System.Xml.Schema.XmlSchemaSet.ValidationEventHandler">
+ <summary>Specifies an event handler for receiving information about XML Schema definition language (XSD) schema validation errors.</summary>
</member>
<member name="P:System.Xml.Schema.XmlSchemaSet.XmlResolver">
<summary>Sets the <see cref="T:System.Xml.XmlResolver" /> used to resolve namespaces or locations referenced in include and import elements of a schema.</summary>
</member>
<member name="P:System.Xml.Schema.XmlSchemaSimpleContentRestriction.Facets">
<summary>Gets or sets an Xml Schema facet.</summary>
- <returns>One of the following facet classes:
-
- <see cref="T:System.Xml.Schema.XmlSchemaLengthFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMinLengthFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMaxLengthFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaPatternFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaEnumerationFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMaxInclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMaxExclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMinInclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMinExclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaFractionDigitsFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaTotalDigitsFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaWhiteSpaceFacet" />.</returns>
+ <returns>One of the following facet classes:
+<see cref="T:System.Xml.Schema.XmlSchemaLengthFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMinLengthFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMaxLengthFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaPatternFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaEnumerationFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMaxInclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMaxExclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMinInclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMinExclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaFractionDigitsFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaTotalDigitsFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaWhiteSpaceFacet" />.</returns>
</member>
<member name="T:System.Xml.Schema.XmlSchemaSimpleType">
<summary>Represents the <see langword="simpleType" /> element for simple content from XML Schema as specified by the World Wide Web Consortium (W3C). This class defines a simple type. Simple types can specify information and constraints for the value of attributes or elements with text-only content.</summary>
</member>
<member name="P:System.Xml.Schema.XmlSchemaSimpleTypeRestriction.Facets">
<summary>Gets or sets an Xml Schema facet.</summary>
- <returns>One of the following facet classes:
-
- <see cref="T:System.Xml.Schema.XmlSchemaLengthFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMinLengthFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMaxLengthFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaPatternFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaEnumerationFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMaxInclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMaxExclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMinInclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMinExclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaFractionDigitsFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaTotalDigitsFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaWhiteSpaceFacet" />.</returns>
+ <returns>One of the following facet classes:
+<see cref="T:System.Xml.Schema.XmlSchemaLengthFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMinLengthFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMaxLengthFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaPatternFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaEnumerationFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMaxInclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMaxExclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMinInclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaMinExclusiveFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaFractionDigitsFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaTotalDigitsFacet" />, <see cref="T:System.Xml.Schema.XmlSchemaWhiteSpaceFacet" />.</returns>
</member>
<member name="T:System.Xml.Schema.XmlSchemaSimpleTypeUnion">
<summary>Represents the <see langword="union" /> element for simple types from XML Schema as specified by the World Wide Web Consortium (W3C). A <see langword="union" /> datatype can be used to specify the content of a <see langword="simpleType" />. The value of the <see langword="simpleType" /> element must be any one of a set of alternative datatypes specified in the union. Union types are always derived types and must comprise at least two alternative datatypes.</summary>
<member name="M:System.Xml.Schema.XmlSchemaType.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.Schema.XmlSchemaType" /> class.</summary>
</member>
+ <member name="P:System.Xml.Schema.XmlSchemaType.BaseSchemaType">
+ <summary>Gets the post-compilation object type or the built-in XML Schema Definition Language (XSD) data type, simpleType element, or complexType element. This is a post-schema-compilation infoset property.</summary>
+ <returns>The built-in XSD data type, simpleType element, or complexType element.</returns>
+ </member>
+ <member name="P:System.Xml.Schema.XmlSchemaType.BaseXmlSchemaType">
+ <summary>Gets the post-compilation value for the base type of this schema type.</summary>
+ <returns>An <see cref="T:System.Xml.Schema.XmlSchemaType" /> object representing the base type of this schema type.</returns>
+ </member>
+ <member name="P:System.Xml.Schema.XmlSchemaType.Datatype">
+ <summary>Gets the post-compilation value for the data type of the complex type.</summary>
+ <returns>The <see cref="T:System.Xml.Schema.XmlSchemaDatatype" /> post-schema-compilation value.</returns>
+ </member>
+ <member name="P:System.Xml.Schema.XmlSchemaType.DerivedBy">
+ <summary>Gets the post-compilation information on how this element was derived from its base type.</summary>
+ <returns>One of the valid <see cref="T:System.Xml.Schema.XmlSchemaDerivationMethod" /> values.</returns>
+ </member>
+ <member name="P:System.Xml.Schema.XmlSchemaType.Final">
+ <summary>Gets or sets the final attribute of the type derivation that indicates if further derivations are allowed.</summary>
+ <returns>One of the valid <see cref="T:System.Xml.Schema.XmlSchemaDerivationMethod" /> values. The default is <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.None" />.</returns>
+ </member>
+ <member name="P:System.Xml.Schema.XmlSchemaType.FinalResolved">
+ <summary>Gets the post-compilation value of the <see cref="P:System.Xml.Schema.XmlSchemaType.Final" /> property.</summary>
+ <returns>The post-compilation value of the <see cref="P:System.Xml.Schema.XmlSchemaType.Final" /> property. The default is the <see langword="finalDefault" /> attribute value of the <see langword="schema" /> element.</returns>
+ </member>
<member name="M:System.Xml.Schema.XmlSchemaType.GetBuiltInComplexType(System.Xml.Schema.XmlTypeCode)">
<summary>Returns an <see cref="T:System.Xml.Schema.XmlSchemaComplexType" /> that represents the built-in complex type of the complex type specified.</summary>
<param name="typeCode">One of the <see cref="T:System.Xml.Schema.XmlTypeCode" /> values representing the complex type.</param>
<member name="M:System.Xml.Schema.XmlSchemaType.GetBuiltInComplexType(System.Xml.XmlQualifiedName)">
<summary>Returns an <see cref="T:System.Xml.Schema.XmlSchemaComplexType" /> that represents the built-in complex type of the complex type specified by qualified name.</summary>
<param name="qualifiedName">The <see cref="T:System.Xml.XmlQualifiedName" /> of the complex type.</param>
- <exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.XmlQualifiedName" /> parameter is <see langword="null" />.</exception>
<returns>The <see cref="T:System.Xml.Schema.XmlSchemaComplexType" /> that represents the built-in complex type.</returns>
+ <exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.XmlQualifiedName" /> parameter is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.Schema.XmlSchemaType.GetBuiltInSimpleType(System.Xml.Schema.XmlTypeCode)">
<summary>Returns an <see cref="T:System.Xml.Schema.XmlSchemaSimpleType" /> that represents the built-in simple type of the specified simple type.</summary>
<member name="M:System.Xml.Schema.XmlSchemaType.GetBuiltInSimpleType(System.Xml.XmlQualifiedName)">
<summary>Returns an <see cref="T:System.Xml.Schema.XmlSchemaSimpleType" /> that represents the built-in simple type of the simple type that is specified by the qualified name.</summary>
<param name="qualifiedName">The <see cref="T:System.Xml.XmlQualifiedName" /> of the simple type.</param>
- <exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.XmlQualifiedName" /> parameter is <see langword="null" />.</exception>
<returns>The <see cref="T:System.Xml.Schema.XmlSchemaSimpleType" /> that represents the built-in simple type.</returns>
+ <exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.XmlQualifiedName" /> parameter is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.Schema.XmlSchemaType.IsDerivedFrom(System.Xml.Schema.XmlSchemaType,System.Xml.Schema.XmlSchemaType,System.Xml.Schema.XmlSchemaDerivationMethod)">
<summary>Returns a value indicating if the derived schema type specified is derived from the base schema type specified.</summary>
<returns>
<see langword="true" /> if the derived type is derived from the base type; otherwise, <see langword="false" />.</returns>
</member>
- <member name="P:System.Xml.Schema.XmlSchemaType.BaseSchemaType">
- <summary>Gets the post-compilation object type or the built-in XML Schema Definition Language (XSD) data type, simpleType element, or complexType element. This is a post-schema-compilation infoset property.</summary>
- <returns>The built-in XSD data type, simpleType element, or complexType element.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaType.BaseXmlSchemaType">
- <summary>Gets the post-compilation value for the base type of this schema type.</summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchemaType" /> object representing the base type of this schema type.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaType.Datatype">
- <summary>Gets the post-compilation value for the data type of the complex type.</summary>
- <returns>The <see cref="T:System.Xml.Schema.XmlSchemaDatatype" /> post-schema-compilation value.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaType.DerivedBy">
- <summary>Gets the post-compilation information on how this element was derived from its base type.</summary>
- <returns>One of the valid <see cref="T:System.Xml.Schema.XmlSchemaDerivationMethod" /> values.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaType.Final">
- <summary>Gets or sets the final attribute of the type derivation that indicates if further derivations are allowed.</summary>
- <returns>One of the valid <see cref="T:System.Xml.Schema.XmlSchemaDerivationMethod" /> values. The default is <see cref="F:System.Xml.Schema.XmlSchemaDerivationMethod.None" />.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaType.FinalResolved">
- <summary>Gets the post-compilation value of the <see cref="P:System.Xml.Schema.XmlSchemaType.Final" /> property.</summary>
- <returns>The post-compilation value of the <see cref="P:System.Xml.Schema.XmlSchemaType.Final" /> property. The default is the <see langword="finalDefault" /> attribute value of the <see langword="schema" /> element.</returns>
- </member>
<member name="P:System.Xml.Schema.XmlSchemaType.IsMixed">
<summary>Gets or sets a value indicating if this type has a mixed content model. This property is only valid in a complex type.</summary>
<returns>
<member name="T:System.Xml.Schema.XmlSchemaValidator">
<summary>Represents an XML Schema Definition Language (XSD) Schema validation engine. The <see cref="T:System.Xml.Schema.XmlSchemaValidator" /> class cannot be inherited.</summary>
</member>
- <member name="E:System.Xml.Schema.XmlSchemaValidator.ValidationEventHandler">
- <summary>The <see cref="T:System.Xml.Schema.ValidationEventHandler" /> that receives schema validation warnings and errors encountered during schema validation.</summary>
- </member>
<member name="M:System.Xml.Schema.XmlSchemaValidator.#ctor(System.Xml.XmlNameTable,System.Xml.Schema.XmlSchemaSet,System.Xml.IXmlNamespaceResolver,System.Xml.Schema.XmlSchemaValidationFlags)">
<summary>Initializes a new instance of the <see cref="T:System.Xml.Schema.XmlSchemaValidator" /> class.</summary>
<param name="nameTable">An <see cref="T:System.Xml.XmlNameTable" /> object containing element and attribute names as atomized strings.</param>
<exception cref="T:System.ArgumentException">The <see cref="T:System.Xml.Schema.XmlSchemaObject" /> parameter is not an <see cref="T:System.Xml.Schema.XmlSchemaElement" />, <see cref="T:System.Xml.Schema.XmlSchemaAttribute" />, or <see cref="T:System.Xml.Schema.XmlSchemaType" /> object.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.Schema.XmlSchemaObject" /> parameter cannot be <see langword="null" />.</exception>
</member>
+ <member name="P:System.Xml.Schema.XmlSchemaValidator.LineInfoProvider">
+ <summary>Gets or sets the line number information for the XML node being validated.</summary>
+ <returns>An <see cref="T:System.Xml.IXmlLineInfo" /> object.</returns>
+ </member>
<member name="M:System.Xml.Schema.XmlSchemaValidator.SkipToEndElement(System.Xml.Schema.XmlSchemaInfo)">
<summary>Skips validation of the current element content and prepares the <see cref="T:System.Xml.Schema.XmlSchemaValidator" /> object to validate content in the parent element's context.</summary>
<param name="schemaInfo">An <see cref="T:System.Xml.Schema.XmlSchemaInfo" /> object whose properties are set if the current element content is successfully skipped. This parameter can be <see langword="null" />.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="M:System.Xml.Schema.XmlSchemaValidator.SkipToEndElement(System.Xml.Schema.XmlSchemaInfo)" /> method was not called in the correct sequence. For example, calling <see cref="M:System.Xml.Schema.XmlSchemaValidator.SkipToEndElement(System.Xml.Schema.XmlSchemaInfo)" /> after calling <see cref="M:System.Xml.Schema.XmlSchemaValidator.SkipToEndElement(System.Xml.Schema.XmlSchemaInfo)" />.</exception>
</member>
+ <member name="P:System.Xml.Schema.XmlSchemaValidator.SourceUri">
+ <summary>Gets or sets the source URI for the XML node being validated.</summary>
+ <returns>A <see cref="T:System.Uri" /> object representing the source URI for the XML node being validated; the default is <see langword="null" />.</returns>
+ </member>
<member name="M:System.Xml.Schema.XmlSchemaValidator.ValidateAttribute(System.String,System.String,System.String,System.Xml.Schema.XmlSchemaInfo)">
<summary>Validates the attribute name, namespace URI, and value in the current element context.</summary>
<param name="localName">The local name of the attribute to validate.</param>
<param name="namespaceUri">The namespace URI of the attribute to validate.</param>
<param name="attributeValue">The value of the attribute to validate.</param>
<param name="schemaInfo">An <see cref="T:System.Xml.Schema.XmlSchemaInfo" /> object whose properties are set on successful validation of the attribute. This parameter can be <see langword="null" />.</param>
+ <returns>The validated attribute's value.</returns>
<exception cref="T:System.Xml.Schema.XmlSchemaValidationException">The attribute is not valid in the current element context.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="Overload:System.Xml.Schema.XmlSchemaValidator.ValidateAttribute" /> method was not called in the correct sequence. For example, calling <see cref="Overload:System.Xml.Schema.XmlSchemaValidator.ValidateAttribute" /> after calling <see cref="M:System.Xml.Schema.XmlSchemaValidator.ValidateEndOfAttributes(System.Xml.Schema.XmlSchemaInfo)" />.</exception>
<exception cref="T:System.ArgumentNullException">One or more of the parameters specified are <see langword="null" />.</exception>
- <returns>The validated attribute's value.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaValidator.ValidateAttribute(System.String,System.String,System.Xml.Schema.XmlValueGetter,System.Xml.Schema.XmlSchemaInfo)">
<summary>Validates the attribute name, namespace URI, and value in the current element context.</summary>
<param name="namespaceUri">The namespace URI of the attribute to validate.</param>
<param name="attributeValue">An <see cref="T:System.Xml.Schema.XmlValueGetter" /><see langword="delegate" /> used to pass the attribute's value as a Common Language Runtime (CLR) type compatible with the XML Schema Definition Language (XSD) type of the attribute.</param>
<param name="schemaInfo">An <see cref="T:System.Xml.Schema.XmlSchemaInfo" /> object whose properties are set on successful validation of the attribute. This parameter and can be <see langword="null" />.</param>
+ <returns>The validated attribute's value.</returns>
<exception cref="T:System.Xml.Schema.XmlSchemaValidationException">The attribute is not valid in the current element context.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="Overload:System.Xml.Schema.XmlSchemaValidator.ValidateAttribute" /> method was not called in the correct sequence. For example, calling <see cref="Overload:System.Xml.Schema.XmlSchemaValidator.ValidateAttribute" /> after calling <see cref="M:System.Xml.Schema.XmlSchemaValidator.ValidateEndOfAttributes(System.Xml.Schema.XmlSchemaInfo)" />.</exception>
<exception cref="T:System.ArgumentNullException">One or more of the parameters specified are <see langword="null" />.</exception>
- <returns>The validated attribute's value.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaValidator.ValidateElement(System.String,System.String,System.Xml.Schema.XmlSchemaInfo)">
<summary>Validates the element in the current context.</summary>
<member name="M:System.Xml.Schema.XmlSchemaValidator.ValidateEndElement(System.Xml.Schema.XmlSchemaInfo)">
<summary>Verifies if the text content of the element is valid according to its data type for elements with simple content, and verifies if the content of the current element is complete for elements with complex content.</summary>
<param name="schemaInfo">An <see cref="T:System.Xml.Schema.XmlSchemaInfo" /> object whose properties are set on successful validation of the element. This parameter can be <see langword="null" />.</param>
+ <returns>The parsed, typed text value of the element if the element has simple content.</returns>
<exception cref="T:System.Xml.Schema.XmlSchemaValidationException">The element's content is not valid.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="Overload:System.Xml.Schema.XmlSchemaValidator.ValidateEndElement" /> method was not called in the correct sequence. For example, if the <see cref="Overload:System.Xml.Schema.XmlSchemaValidator.ValidateEndElement" /> method is called after calling <see cref="M:System.Xml.Schema.XmlSchemaValidator.SkipToEndElement(System.Xml.Schema.XmlSchemaInfo)" />.</exception>
- <returns>The parsed, typed text value of the element if the element has simple content.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaValidator.ValidateEndElement(System.Xml.Schema.XmlSchemaInfo,System.Object)">
<summary>Verifies if the text content of the element specified is valid according to its data type.</summary>
<param name="schemaInfo">An <see cref="T:System.Xml.Schema.XmlSchemaInfo" /> object whose properties are set on successful validation of the text content of the element. This parameter can be <see langword="null" />.</param>
<param name="typedValue">The typed text content of the element.</param>
+ <returns>The parsed, typed simple content of the element.</returns>
<exception cref="T:System.Xml.Schema.XmlSchemaValidationException">The element's text content is not valid.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="Overload:System.Xml.Schema.XmlSchemaValidator.ValidateEndElement" /> method was not called in the correct sequence (for example, if the <see cref="Overload:System.Xml.Schema.XmlSchemaValidator.ValidateEndElement" /> method is called after calling <see cref="M:System.Xml.Schema.XmlSchemaValidator.SkipToEndElement(System.Xml.Schema.XmlSchemaInfo)" />), calls to the <see cref="Overload:System.Xml.Schema.XmlSchemaValidator.ValidateText" /> method have been previously made, or the element has complex content.</exception>
<exception cref="T:System.ArgumentNullException">The typed text content parameter cannot be <see langword="null" />.</exception>
- <returns>The parsed, typed simple content of the element.</returns>
</member>
<member name="M:System.Xml.Schema.XmlSchemaValidator.ValidateEndOfAttributes(System.Xml.Schema.XmlSchemaInfo)">
<summary>Verifies whether all the required attributes in the element context are present and prepares the <see cref="T:System.Xml.Schema.XmlSchemaValidator" /> object to validate the child content of the element.</summary>
<exception cref="T:System.Xml.Schema.XmlSchemaValidationException">White space is not allowed in the current element context.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="Overload:System.Xml.Schema.XmlSchemaValidator.ValidateWhitespace" /> method was not called in the correct sequence. For example, if the <see cref="Overload:System.Xml.Schema.XmlSchemaValidator.ValidateWhitespace" /> method is called after calling <see cref="Overload:System.Xml.Schema.XmlSchemaValidator.ValidateAttribute" />.</exception>
</member>
- <member name="P:System.Xml.Schema.XmlSchemaValidator.LineInfoProvider">
- <summary>Gets or sets the line number information for the XML node being validated.</summary>
- <returns>An <see cref="T:System.Xml.IXmlLineInfo" /> object.</returns>
- </member>
- <member name="P:System.Xml.Schema.XmlSchemaValidator.SourceUri">
- <summary>Gets or sets the source URI for the XML node being validated.</summary>
- <returns>A <see cref="T:System.Uri" /> object representing the source URI for the XML node being validated; the default is <see langword="null" />.</returns>
+ <member name="E:System.Xml.Schema.XmlSchemaValidator.ValidationEventHandler">
+ <summary>The <see cref="T:System.Xml.Schema.ValidationEventHandler" /> that receives schema validation warnings and errors encountered during schema validation.</summary>
</member>
<member name="P:System.Xml.Schema.XmlSchemaValidator.ValidationEventSender">
<summary>Gets or sets the object sent as the sender object of a validation event.</summary>
</member>
<member name="P:System.Xml.Serialization.XmlAnyElementAttribute.Name">
<summary>Gets or sets the XML element name.</summary>
- <exception cref="T:System.InvalidOperationException">The element name of an array member does not match the element name specified by the <see cref="P:System.Xml.Serialization.XmlAnyElementAttribute.Name" /> property.</exception>
<returns>The name of the XML element.</returns>
+ <exception cref="T:System.InvalidOperationException">The element name of an array member does not match the element name specified by the <see cref="P:System.Xml.Serialization.XmlAnyElementAttribute.Name" /> property.</exception>
</member>
<member name="P:System.Xml.Serialization.XmlAnyElementAttribute.Namespace">
<summary>Gets or sets the XML namespace generated in the XML document.</summary>
</member>
<member name="P:System.Xml.Serialization.XmlElementAttribute.DataType">
<summary>Gets or sets the XML Schema definition (XSD) data type of the XML element generated by the <see cref="T:System.Xml.Serialization.XmlSerializer" />.</summary>
- <exception cref="T:System.Exception">The XML Schema data type you have specified cannot be mapped to the.NET data type.</exception>
<returns>An XML Schema data type.</returns>
+ <exception cref="T:System.Exception">The XML Schema data type you have specified cannot be mapped to the.NET data type.</exception>
</member>
<member name="P:System.Xml.Serialization.XmlElementAttribute.ElementName">
<summary>Gets or sets the name of the generated XML element.</summary>
<param name="prefix">The prefix associated with an XML namespace.</param>
<param name="ns">An XML namespace.</param>
</member>
- <member name="M:System.Xml.Serialization.XmlSerializerNamespaces.ToArray">
- <summary>Gets the array of prefix and namespace pairs in an <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> object.</summary>
- <returns>An array of <see cref="T:System.Xml.XmlQualifiedName" /> objects that are used as qualified names in an XML document.</returns>
- </member>
<member name="P:System.Xml.Serialization.XmlSerializerNamespaces.Count">
<summary>Gets the number of prefix and namespace pairs in the collection.</summary>
<returns>The number of prefix and namespace pairs in the collection.</returns>
</member>
+ <member name="M:System.Xml.Serialization.XmlSerializerNamespaces.ToArray">
+ <summary>Gets the array of prefix and namespace pairs in an <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> object.</summary>
+ <returns>An array of <see cref="T:System.Xml.XmlQualifiedName" /> objects that are used as qualified names in an XML document.</returns>
+ </member>
<member name="T:System.Xml.Serialization.XmlTextAttribute">
<summary>Indicates to the <see cref="T:System.Xml.Serialization.XmlSerializer" /> that the member must be treated as XML text when the class that contains it is serialized or deserialized.</summary>
</member>
</member>
<member name="P:System.Xml.Serialization.XmlTextAttribute.DataType">
<summary>Gets or sets the XML Schema definition language (XSD) data type of the text generated by the <see cref="T:System.Xml.Serialization.XmlSerializer" />.</summary>
+ <returns>An XML Schema (XSD) data type.</returns>
<exception cref="T:System.Exception">The XML Schema data type you have specified cannot be mapped to the .NET data type.</exception>
<exception cref="T:System.InvalidOperationException">The XML Schema data type you have specified is invalid for the property and cannot be converted to the member type.</exception>
- <returns>An XML Schema (XSD) data type.</returns>
</member>
<member name="P:System.Xml.Serialization.XmlTextAttribute.Type">
<summary>Gets or sets the type of the member.</summary>
<summary>Specifies the type of validation to perform.</summary>
</member>
<member name="F:System.Xml.ValidationType.Auto">
- <summary>Validates if DTD or schema information is found.
-
+ <summary>Validates if DTD or schema information is found.
Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete <see cref="T:System.Xml.XmlValidatingReader" /> class.</summary>
</member>
<member name="F:System.Xml.ValidationType.DTD">
</member>
<member name="F:System.Xml.ValidationType.None">
<summary>No validation is performed, and no validation errors are thrown. This setting creates an XML 1.0 compliant non-validating parser.
-
Calls to <see cref="M:System.Xml.XmlReader.ResolveEntity" /> report default attributes and resolve general entities. The DOCTYPE is not used for validation purposes.</summary>
</member>
<member name="F:System.Xml.ValidationType.Schema">
</member>
<member name="F:System.Xml.ValidationType.XDR">
<summary>Validate according to XML-Data Reduced (XDR) schemas, including inline XDR schemas. XDR schemas are recognized using the <see langword="x-schema" /> namespace prefix or the <see cref="P:System.Xml.XmlValidatingReader.Schemas" /> property.
-
Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete <see cref="T:System.Xml.XmlValidatingReader" /> class.</summary>
</member>
<member name="T:System.Xml.WhitespaceHandling">
</member>
<member name="F:System.Xml.WriteState.Error">
<summary>An exception has been thrown, which has left the <see cref="T:System.Xml.XmlWriter" /> in an invalid state. You can call the <see cref="M:System.Xml.XmlWriter.Close" /> method to put the <see cref="T:System.Xml.XmlWriter" /> in the <see cref="F:System.Xml.WriteState.Closed" /> state. Any other <see cref="T:System.Xml.XmlWriter" /> method calls results in an <see cref="T:System.InvalidOperationException" />.
-
This field was added in .NET Framework 2.0.</summary>
</member>
<member name="F:System.Xml.WriteState.Prolog">
<member name="M:System.Xml.XmlAttribute.AppendChild(System.Xml.XmlNode)">
<summary>Adds the specified node to the end of the list of child nodes, of this node.</summary>
<param name="newChild">The <see cref="T:System.Xml.XmlNode" /> to add.</param>
- <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
-
- The <paramref name="newChild" /> is an ancestor of this node.</exception>
- <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
-
- This node is read-only.</exception>
<returns>The <see cref="T:System.Xml.XmlNode" /> added.</returns>
+ <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
+The <paramref name="newChild" /> is an ancestor of this node.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
+This node is read-only.</exception>
+ </member>
+ <member name="P:System.Xml.XmlAttribute.BaseURI">
+ <summary>Gets the base Uniform Resource Identifier (URI) of the node.</summary>
+ <returns>The location from which the node was loaded or String.Empty if the node has no base URI. Attribute nodes have the same base URI as their owner element. If an attribute node does not have an owner element, <see langword="BaseURI" /> returns String.Empty.</returns>
</member>
<member name="M:System.Xml.XmlAttribute.CloneNode(System.Boolean)">
<summary>Creates a duplicate of this node.</summary>
<param name="deep">
- <see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself.</param>
+ <see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself</param>
<returns>The duplicate node.</returns>
</member>
+ <member name="P:System.Xml.XmlAttribute.InnerText">
+ <summary>Sets the concatenated values of the node and all its children.</summary>
+ <returns>The concatenated values of the node and all its children. For attribute nodes, this property has the same functionality as the <see cref="P:System.Xml.XmlAttribute.Value" /> property.</returns>
+ </member>
+ <member name="P:System.Xml.XmlAttribute.InnerXml">
+ <summary>Sets the value of the attribute.</summary>
+ <returns>The attribute value.</returns>
+ <exception cref="T:System.Xml.XmlException">The XML specified when setting this property is not well-formed.</exception>
+ </member>
<member name="M:System.Xml.XmlAttribute.InsertAfter(System.Xml.XmlNode,System.Xml.XmlNode)">
<summary>Inserts the specified node immediately after the specified reference node.</summary>
<param name="newChild">The <see cref="T:System.Xml.XmlNode" /> to insert.</param>
<param name="refChild">The <see cref="T:System.Xml.XmlNode" /> that is the reference node. The <paramref name="newChild" /> is placed after the <paramref name="refChild" />.</param>
- <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
-
- The <paramref name="newChild" /> is an ancestor of this node.</exception>
- <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
-
- The <paramref name="refChild" /> is not a child of this node.
-
- This node is read-only.</exception>
<returns>The <see cref="T:System.Xml.XmlNode" /> inserted.</returns>
+ <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
+The <paramref name="newChild" /> is an ancestor of this node.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
+The <paramref name="refChild" /> is not a child of this node.
+This node is read-only.</exception>
</member>
<member name="M:System.Xml.XmlAttribute.InsertBefore(System.Xml.XmlNode,System.Xml.XmlNode)">
<summary>Inserts the specified node immediately before the specified reference node.</summary>
<param name="newChild">The <see cref="T:System.Xml.XmlNode" /> to insert.</param>
<param name="refChild">The <see cref="T:System.Xml.XmlNode" /> that is the reference node. The <paramref name="newChild" /> is placed before this node.</param>
- <exception cref="T:System.InvalidOperationException">The current node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
-
- The <paramref name="newChild" /> is an ancestor of this node.</exception>
- <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
-
- The <paramref name="refChild" /> is not a child of this node.
-
- This node is read-only.</exception>
<returns>The <see cref="T:System.Xml.XmlNode" /> inserted.</returns>
- </member>
- <member name="M:System.Xml.XmlAttribute.PrependChild(System.Xml.XmlNode)">
- <summary>Adds the specified node to the beginning of the list of child nodes for this node.</summary>
- <param name="newChild">The <see cref="T:System.Xml.XmlNode" /> to add. If it is an <see cref="T:System.Xml.XmlDocumentFragment" />, the entire contents of the document fragment are moved into the child list of this node.</param>
- <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
-
- The <paramref name="newChild" /> is an ancestor of this node.</exception>
- <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
-
- This node is read-only.</exception>
- <returns>The <see cref="T:System.Xml.XmlNode" /> added.</returns>
- </member>
- <member name="M:System.Xml.XmlAttribute.RemoveChild(System.Xml.XmlNode)">
- <summary>Removes the specified child node.</summary>
- <param name="oldChild">The <see cref="T:System.Xml.XmlNode" /> to remove.</param>
- <exception cref="T:System.ArgumentException">The <paramref name="oldChild" /> is not a child of this node. Or this node is read-only.</exception>
- <returns>The <see cref="T:System.Xml.XmlNode" /> removed.</returns>
- </member>
- <member name="M:System.Xml.XmlAttribute.ReplaceChild(System.Xml.XmlNode,System.Xml.XmlNode)">
- <summary>Replaces the child node specified with the new child node specified.</summary>
- <param name="newChild">The new child <see cref="T:System.Xml.XmlNode" />.</param>
- <param name="oldChild">The <see cref="T:System.Xml.XmlNode" /> to replace.</param>
- <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
-
- The <paramref name="newChild" /> is an ancestor of this node.</exception>
- <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
-
- This node is read-only.
-
- The <paramref name="oldChild" /> is not a child of this node.</exception>
- <returns>The <see cref="T:System.Xml.XmlNode" /> replaced.</returns>
- </member>
- <member name="M:System.Xml.XmlAttribute.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlAttribute.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="P:System.Xml.XmlAttribute.BaseURI">
- <summary>Gets the base Uniform Resource Identifier (URI) of the node.</summary>
- <returns>The location from which the node was loaded or String.Empty if the node has no base URI. Attribute nodes have the same base URI as their owner element. If an attribute node does not have an owner element, <see langword="BaseURI" /> returns String.Empty.</returns>
- </member>
- <member name="P:System.Xml.XmlAttribute.InnerText">
- <summary>Sets the concatenated values of the node and all its children.</summary>
- <returns>The concatenated values of the node and all its children. For attribute nodes, this property has the same functionality as the <see cref="P:System.Xml.XmlAttribute.Value" /> property.</returns>
- </member>
- <member name="P:System.Xml.XmlAttribute.InnerXml">
- <summary>Sets the value of the attribute.</summary>
- <exception cref="T:System.Xml.XmlException">The XML specified when setting this property is not well-formed.</exception>
- <returns>The attribute value.</returns>
+ <exception cref="T:System.InvalidOperationException">The current node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
+The <paramref name="newChild" /> is an ancestor of this node.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
+The <paramref name="refChild" /> is not a child of this node.
+This node is read-only.</exception>
</member>
<member name="P:System.Xml.XmlAttribute.LocalName">
<summary>Gets the local name of the node.</summary>
</member>
<member name="P:System.Xml.XmlAttribute.Prefix">
<summary>Gets or sets the namespace prefix of this node.</summary>
- <exception cref="T:System.ArgumentException">This node is read-only.</exception>
- <exception cref="T:System.Xml.XmlException">The specified prefix contains an invalid character.
-
- The specified prefix is malformed.
-
- The namespaceURI of this node is <see langword="null" />.
-
- The specified prefix is "xml", and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace".
-
- This node is an attribute, the specified prefix is "xmlns", and the namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/".
-
- This node is an attribute, and the qualifiedName of this node is "xmlns" [Namespaces].</exception>
<returns>The namespace prefix of this node. If there is no prefix, this property returns String.Empty.</returns>
+ <exception cref="T:System.ArgumentException">This node is read-only.</exception>
+ <exception cref="T:System.Xml.XmlException">The specified prefix contains an invalid character.
+The specified prefix is malformed.
+The namespaceURI of this node is <see langword="null" />.
+The specified prefix is "xml", and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace".
+This node is an attribute, the specified prefix is "xmlns", and the namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/".
+This node is an attribute, and the qualifiedName of this node is "xmlns" [Namespaces].</exception>
+ </member>
+ <member name="M:System.Xml.XmlAttribute.PrependChild(System.Xml.XmlNode)">
+ <summary>Adds the specified node to the beginning of the list of child nodes for this node.</summary>
+ <param name="newChild">The <see cref="T:System.Xml.XmlNode" /> to add. If it is an <see cref="T:System.Xml.XmlDocumentFragment" />, the entire contents of the document fragment are moved into the child list of this node.</param>
+ <returns>The <see cref="T:System.Xml.XmlNode" /> added.</returns>
+ <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
+The <paramref name="newChild" /> is an ancestor of this node.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
+This node is read-only.</exception>
+ </member>
+ <member name="M:System.Xml.XmlAttribute.RemoveChild(System.Xml.XmlNode)">
+ <summary>Removes the specified child node.</summary>
+ <param name="oldChild">The <see cref="T:System.Xml.XmlNode" /> to remove.</param>
+ <returns>The <see cref="T:System.Xml.XmlNode" /> removed.</returns>
+ <exception cref="T:System.ArgumentException">The <paramref name="oldChild" /> is not a child of this node. Or this node is read-only.</exception>
+ </member>
+ <member name="M:System.Xml.XmlAttribute.ReplaceChild(System.Xml.XmlNode,System.Xml.XmlNode)">
+ <summary>Replaces the child node specified with the new child node specified.</summary>
+ <param name="newChild">The new child <see cref="T:System.Xml.XmlNode" />.</param>
+ <param name="oldChild">The <see cref="T:System.Xml.XmlNode" /> to replace.</param>
+ <returns>The <see cref="T:System.Xml.XmlNode" /> replaced.</returns>
+ <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
+The <paramref name="newChild" /> is an ancestor of this node.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
+This node is read-only.
+The <paramref name="oldChild" /> is not a child of this node.</exception>
</member>
<member name="P:System.Xml.XmlAttribute.SchemaInfo">
<summary>Gets the post-schema-validation-infoset that has been assigned to this node as a result of schema validation.</summary>
</member>
<member name="P:System.Xml.XmlAttribute.Value">
<summary>Gets or sets the value of the node.</summary>
- <exception cref="T:System.ArgumentException">The node is read-only and a set operation is called.</exception>
<returns>The value returned depends on the <see cref="P:System.Xml.XmlNode.NodeType" /> of the node. For <see langword="XmlAttribute" /> nodes, this property is the value of attribute.</returns>
+ <exception cref="T:System.ArgumentException">The node is read-only and a set operation is called.</exception>
+ </member>
+ <member name="M:System.Xml.XmlAttribute.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="M:System.Xml.XmlAttribute.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
</member>
<member name="T:System.Xml.XmlAttributeCollection">
<summary>Represents a collection of attributes that can be accessed by name or index.</summary>
<member name="M:System.Xml.XmlAttributeCollection.Append(System.Xml.XmlAttribute)">
<summary>Inserts the specified attribute as the last node in the collection.</summary>
<param name="node">The attribute to insert.</param>
+ <returns>The <see langword="XmlAttribute" /> to append to the collection.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="node" /> was created from a document different from the one that created this collection.</exception>
- <returns>The <see langword="XmlAttribute" /> to append to the collection.</returns>
</member>
<member name="M:System.Xml.XmlAttributeCollection.CopyTo(System.Xml.XmlAttribute[],System.Int32)">
<summary>Copies all the <see cref="T:System.Xml.XmlAttribute" /> objects from this collection into the given array.</summary>
<summary>Inserts the specified attribute immediately after the specified reference attribute.</summary>
<param name="newNode">The attribute to insert.</param>
<param name="refNode">The reference attribute. <paramref name="newNode" /> is placed after the <paramref name="refNode" />.</param>
- <exception cref="T:System.ArgumentException">The <paramref name="newNode" /> was created from a document different from the one that created this collection. Or the <paramref name="refNode" /> is not a member of this collection.</exception>
<returns>The <see langword="XmlAttribute" /> to insert into the collection.</returns>
+ <exception cref="T:System.ArgumentException">The <paramref name="newNode" /> was created from a document different from the one that created this collection. Or the <paramref name="refNode" /> is not a member of this collection.</exception>
</member>
<member name="M:System.Xml.XmlAttributeCollection.InsertBefore(System.Xml.XmlAttribute,System.Xml.XmlAttribute)">
<summary>Inserts the specified attribute immediately before the specified reference attribute.</summary>
<param name="newNode">The attribute to insert.</param>
<param name="refNode">The reference attribute. <paramref name="newNode" /> is placed before the <paramref name="refNode" />.</param>
- <exception cref="T:System.ArgumentException">The <paramref name="newNode" /> was created from a document different from the one that created this collection. Or the <paramref name="refNode" /> is not a member of this collection.</exception>
<returns>The <see langword="XmlAttribute" /> to insert into the collection.</returns>
+ <exception cref="T:System.ArgumentException">The <paramref name="newNode" /> was created from a document different from the one that created this collection. Or the <paramref name="refNode" /> is not a member of this collection.</exception>
+ </member>
+ <member name="P:System.Xml.XmlAttributeCollection.ItemOf(System.Int32)">
+ <summary>Gets the attribute with the specified index.</summary>
+ <param name="i">The index of the attribute.</param>
+ <returns>The attribute at the specified index.</returns>
+ <exception cref="T:System.IndexOutOfRangeException">The index being passed in is out of range.</exception>
+ </member>
+ <member name="P:System.Xml.XmlAttributeCollection.ItemOf(System.String)">
+ <summary>Gets the attribute with the specified name.</summary>
+ <param name="name">The qualified name of the attribute.</param>
+ <returns>The attribute with the specified name. If the attribute does not exist, this property returns <see langword="null" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlAttributeCollection.ItemOf(System.String,System.String)">
+ <summary>Gets the attribute with the specified local name and namespace Uniform Resource Identifier (URI).</summary>
+ <param name="localName">The local name of the attribute.</param>
+ <param name="namespaceURI">The namespace URI of the attribute.</param>
+ <returns>The attribute with the specified local name and namespace URI. If the attribute does not exist, this property returns <see langword="null" />.</returns>
</member>
<member name="M:System.Xml.XmlAttributeCollection.Prepend(System.Xml.XmlAttribute)">
<summary>Inserts the specified attribute as the first node in the collection.</summary>
<member name="M:System.Xml.XmlAttributeCollection.SetNamedItem(System.Xml.XmlNode)">
<summary>Adds a <see cref="T:System.Xml.XmlNode" /> using its <see cref="P:System.Xml.XmlNode.Name" /> property.</summary>
<param name="node">An attribute node to store in this collection. The node will later be accessible using the name of the node. If a node with that name is already present in the collection, it is replaced by the new one; otherwise, the node is appended to the end of the collection.</param>
+ <returns>If the <paramref name="node" /> replaces an existing node with the same name, the old node is returned; otherwise, the added node is returned.</returns>
<exception cref="T:System.ArgumentException">
- <paramref name="node" /> was created from a different <see cref="T:System.Xml.XmlDocument" /> than the one that created this collection.
-
- This <see langword="XmlAttributeCollection" /> is read-only.</exception>
+ <paramref name="node" /> was created from a different <see cref="T:System.Xml.XmlDocument" /> than the one that created this collection.
+This <see langword="XmlAttributeCollection" /> is read-only.</exception>
<exception cref="T:System.InvalidOperationException">
<paramref name="node" /> is an <see cref="T:System.Xml.XmlAttribute" /> that is already an attribute of another <see cref="T:System.Xml.XmlElement" /> object. To re-use attributes in other elements, you must clone the <see langword="XmlAttribute" /> objects you want to re-use.</exception>
- <returns>If the <paramref name="node" /> replaces an existing node with the same name, the old node is returned; otherwise, the added node is returned.</returns>
</member>
<member name="M:System.Xml.XmlAttributeCollection.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
<summary>For a description of this member, see <see cref="M:System.Xml.XmlAttributeCollection.CopyTo(System.Xml.XmlAttribute[],System.Int32)" />.</summary>
<param name="array">The array that is the destination of the objects copied from this collection.</param>
<param name="index">The index in the array where copying begins.</param>
</member>
- <member name="P:System.Xml.XmlAttributeCollection.ItemOf(System.Int32)">
- <summary>Gets the attribute with the specified index.</summary>
- <param name="i">The index of the attribute.</param>
- <exception cref="T:System.IndexOutOfRangeException">The index being passed in is out of range.</exception>
- <returns>The attribute at the specified index.</returns>
- </member>
- <member name="P:System.Xml.XmlAttributeCollection.ItemOf(System.String)">
- <summary>Gets the attribute with the specified name.</summary>
- <param name="name">The qualified name of the attribute.</param>
- <returns>The attribute with the specified name. If the attribute does not exist, this property returns <see langword="null" />.</returns>
- </member>
- <member name="P:System.Xml.XmlAttributeCollection.ItemOf(System.String,System.String)">
- <summary>Gets the attribute with the specified local name and namespace Uniform Resource Identifier (URI).</summary>
- <param name="localName">The local name of the attribute.</param>
- <param name="namespaceURI">The namespace URI of the attribute.</param>
- <returns>The attribute with the specified local name and namespace URI. If the attribute does not exist, this property returns <see langword="null" />.</returns>
- </member>
<member name="P:System.Xml.XmlAttributeCollection.System#Collections#ICollection#Count">
<summary>For a description of this member, see <see cref="P:System.Xml.XmlAttributeCollection.System#Collections#ICollection#Count" />.</summary>
<returns>An <see langword="int" /> that contains the count of the attributes.</returns>
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself. Because CDATA nodes do not have children, regardless of the parameter setting, the cloned node will always include the data content.</param>
<returns>The cloned node.</returns>
</member>
- <member name="M:System.Xml.XmlCDataSection.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlCDataSection.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
<member name="P:System.Xml.XmlCDataSection.LocalName">
<summary>Gets the local name of the node.</summary>
<returns>For CDATA nodes, the local name is <see langword="#cdata-section" />.</returns>
<summary>Gets the text node that immediately precedes this node.</summary>
<returns>Returns <see cref="T:System.Xml.XmlNode" />.</returns>
</member>
+ <member name="M:System.Xml.XmlCDataSection.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="M:System.Xml.XmlCDataSection.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
<member name="T:System.Xml.XmlCharacterData">
<summary>Provides text manipulation methods that are used by several classes.</summary>
</member>
<summary>Appends the specified string to the end of the character data of the node.</summary>
<param name="strData">The string to insert into the existing string.</param>
</member>
+ <member name="P:System.Xml.XmlCharacterData.Data">
+ <summary>Contains the data of the node.</summary>
+ <returns>The data of the node.</returns>
+ </member>
<member name="M:System.Xml.XmlCharacterData.DeleteData(System.Int32,System.Int32)">
<summary>Removes a range of characters from the node.</summary>
<param name="offset">The position within the string to start deleting.</param>
<param name="count">The number of characters to delete.</param>
</member>
+ <member name="P:System.Xml.XmlCharacterData.InnerText">
+ <summary>Gets or sets the concatenated values of the node and all the children of the node.</summary>
+ <returns>The concatenated values of the node and all the children of the node.</returns>
+ </member>
<member name="M:System.Xml.XmlCharacterData.InsertData(System.Int32,System.String)">
<summary>Inserts the specified string at the specified character offset.</summary>
<param name="offset">The position within the string to insert the supplied string data.</param>
<param name="strData">The string data that is to be inserted into the existing string.</param>
</member>
+ <member name="P:System.Xml.XmlCharacterData.Length">
+ <summary>Gets the length of the data, in characters.</summary>
+ <returns>The length, in characters, of the string in the <see cref="P:System.Xml.XmlCharacterData.Data" /> property. The length may be zero; that is, CharacterData nodes can be empty.</returns>
+ </member>
<member name="M:System.Xml.XmlCharacterData.ReplaceData(System.Int32,System.Int32,System.String)">
<summary>Replaces the specified number of characters starting at the specified offset with the specified string.</summary>
<param name="offset">The position within the string to start replacing.</param>
<param name="count">The number of characters to retrieve.</param>
<returns>The substring corresponding to the specified range.</returns>
</member>
- <member name="P:System.Xml.XmlCharacterData.Data">
- <summary>Contains the data of the node.</summary>
- <returns>The data of the node.</returns>
- </member>
- <member name="P:System.Xml.XmlCharacterData.InnerText">
- <summary>Gets or sets the concatenated values of the node and all the children of the node.</summary>
- <returns>The concatenated values of the node and all the children of the node.</returns>
- </member>
- <member name="P:System.Xml.XmlCharacterData.Length">
- <summary>Gets the length of the data, in characters.</summary>
- <returns>The length, in characters, of the string in the <see cref="P:System.Xml.XmlCharacterData.Data" /> property. The length may be zero; that is, CharacterData nodes can be empty.</returns>
- </member>
<member name="P:System.Xml.XmlCharacterData.Value">
<summary>Gets or sets the value of the node.</summary>
- <exception cref="T:System.ArgumentException">Node is read-only.</exception>
<returns>The value of the node.</returns>
+ <exception cref="T:System.ArgumentException">Node is read-only.</exception>
</member>
<member name="T:System.Xml.XmlComment">
<summary>Represents the content of an XML comment.</summary>
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself. Because comment nodes do not have children, the cloned node always includes the text content, regardless of the parameter setting.</param>
<returns>The cloned node.</returns>
</member>
- <member name="M:System.Xml.XmlComment.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. Because comment nodes do not have children, this method has no effect.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlComment.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
<member name="P:System.Xml.XmlComment.LocalName">
<summary>Gets the local name of the node.</summary>
<returns>For comment nodes, the value is <see langword="#comment" />.</returns>
<summary>Gets the type of the current node.</summary>
<returns>For comment nodes, the value is XmlNodeType.Comment.</returns>
</member>
+ <member name="M:System.Xml.XmlComment.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. Because comment nodes do not have children, this method has no effect.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="M:System.Xml.XmlComment.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
<member name="T:System.Xml.XmlConvert">
<summary>Encodes and decodes XML names, and provides methods for converting between common language runtime types and XML Schema definition language (XSD) types. When converting data types, the values returned are locale-independent.</summary>
</member>
<member name="M:System.Xml.XmlConvert.ToBoolean(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.Boolean" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>A <see langword="Boolean" /> value, that is, <see langword="true" /> or <see langword="false" />.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> does not represent a <see langword="Boolean" /> value.</exception>
- <returns>A <see langword="Boolean" /> value, that is, <see langword="true" /> or <see langword="false" />.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToByte(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.Byte" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>A <see langword="Byte" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is not in the correct format.</exception>
<exception cref="T:System.OverflowException">
<paramref name="s" /> represents a number less than <see cref="F:System.Byte.MinValue" /> or greater than <see cref="F:System.Byte.MaxValue" />.</exception>
- <returns>A <see langword="Byte" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToChar(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.Char" /> equivalent.</summary>
<param name="s">The string containing a single character to convert.</param>
+ <returns>A <see langword="Char" /> representing the single character.</returns>
<exception cref="T:System.ArgumentNullException">The value of the <paramref name="s" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">The <paramref name="s" /> parameter contains more than one character.</exception>
- <returns>A <see langword="Char" /> representing the single character.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToDateTime(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.DateTime" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>A <see langword="DateTime" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is an empty string or is not in the correct format.</exception>
- <returns>A <see langword="DateTime" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToDateTime(System.String,System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.DateTime" /> equivalent.</summary>
<param name="s">The string to convert.</param>
<param name="format">The format structure to apply to the converted <see langword="DateTime" />. Valid formats include "yyyy-MM-ddTHH:mm:sszzzzzz" and its subsets. The string is validated against this format.</param>
+ <returns>A <see langword="DateTime" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
- <paramref name="s" /> or <paramref name="format" /> is String.Empty
-
- -or-
-
- <paramref name="s" /> does not contain a date and time that corresponds to <paramref name="format" />.</exception>
- <returns>A <see langword="DateTime" /> equivalent of the string.</returns>
+ <paramref name="s" /> or <paramref name="format" /> is String.Empty
+-or-
+<paramref name="s" /> does not contain a date and time that corresponds to <paramref name="format" />.</exception>
</member>
<member name="M:System.Xml.XmlConvert.ToDateTime(System.String,System.String[])">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.DateTime" /> equivalent.</summary>
<param name="s">The string to convert.</param>
<param name="formats">An array containing the format structures to apply to the converted <see langword="DateTime" />. Valid formats include "yyyy-MM-ddTHH:mm:sszzzzzz" and its subsets.</param>
+ <returns>A <see langword="DateTime" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
- <paramref name="s" /> or an element of <paramref name="formats" /> is String.Empty
-
- -or-
-
- <paramref name="s" /> does not contain a date and time that corresponds to any of the elements of <paramref name="formats" />.</exception>
- <returns>A <see langword="DateTime" /> equivalent of the string.</returns>
+ <paramref name="s" /> or an element of <paramref name="formats" /> is String.Empty
+-or-
+<paramref name="s" /> does not contain a date and time that corresponds to any of the elements of <paramref name="formats" />.</exception>
</member>
<member name="M:System.Xml.XmlConvert.ToDateTime(System.String,System.Xml.XmlDateTimeSerializationMode)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.DateTime" /> using the <see cref="T:System.Xml.XmlDateTimeSerializationMode" /> specified.</summary>
<param name="s">The <see cref="T:System.String" /> value to convert.</param>
<param name="dateTimeOption">One of the enumeration values that specify whether the date should be converted to local time or preserved as Coordinated Universal Time (UTC), if it is a UTC date.</param>
+ <returns>A <see cref="T:System.DateTime" /> equivalent of the <see cref="T:System.String" />.</returns>
<exception cref="T:System.NullReferenceException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="dateTimeOption" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is an empty string or is not in a valid format.</exception>
- <returns>A <see cref="T:System.DateTime" /> equivalent of the <see cref="T:System.String" />.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToDateTimeOffset(System.String)">
<summary>Converts the supplied <see cref="T:System.String" /> to a <see cref="T:System.DateTimeOffset" /> equivalent.</summary>
- <param name="s">The string to convert. The string must conform to a subset of the W3C Recommendation for the XML dateTime type. For more information, see the dateTime section of the XML Schema specification.</param>
+ <param name="s">The string to convert.
+Note The string must conform to a subset of the W3C Recommendation for the XML dateTime type. For more information, see the dateTime section of the XML Schema specification..</param>
+ <returns>The <see cref="T:System.DateTimeOffset" /> equivalent of the supplied string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The argument passed to this method is outside the range of allowable values. For information about allowable values, see <see cref="T:System.DateTimeOffset" />.</exception>
<exception cref="T:System.FormatException">The argument passed to this method does not conform to a subset of the W3C Recommendations for the XML dateTime type. For more information, see the dateTime section of the XML Schema specification.</exception>
- <returns>The <see cref="T:System.DateTimeOffset" /> equivalent of the supplied string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToDateTimeOffset(System.String,System.String)">
<summary>Converts the supplied <see cref="T:System.String" /> to a <see cref="T:System.DateTimeOffset" /> equivalent.</summary>
<param name="s">The string to convert.</param>
<param name="format">The format from which <paramref name="s" /> is converted. The format parameter can be any subset of the W3C Recommendation for the XML dateTime type. (For more information, see the dateTime section of the XML Schema specification..) The string <paramref name="s" /> is validated against this format.</param>
+ <returns>The <see cref="T:System.DateTimeOffset" /> equivalent of the supplied string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> or <paramref name="format" /> is an empty string or is not in the specified format.</exception>
- <returns>The <see cref="T:System.DateTimeOffset" /> equivalent of the supplied string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToDateTimeOffset(System.String,System.String[])">
<summary>Converts the supplied <see cref="T:System.String" /> to a <see cref="T:System.DateTimeOffset" /> equivalent.</summary>
<member name="M:System.Xml.XmlConvert.ToDecimal(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.Decimal" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>A <see langword="Decimal" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is not in the correct format.</exception>
<exception cref="T:System.OverflowException">
<paramref name="s" /> represents a number less than <see cref="F:System.Decimal.MinValue" /> or greater than <see cref="F:System.Decimal.MaxValue" />.</exception>
- <returns>A <see langword="Decimal" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToDouble(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.Double" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>A <see langword="Double" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is not in the correct format.</exception>
<exception cref="T:System.OverflowException">
<paramref name="s" /> represents a number less than <see cref="F:System.Double.MinValue" /> or greater than <see cref="F:System.Double.MaxValue" />.</exception>
- <returns>A <see cref="T:System.Double" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToGuid(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.Guid" /> equivalent.</summary>
<member name="M:System.Xml.XmlConvert.ToInt16(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.Int16" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>An <see langword="Int16" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is not in the correct format.</exception>
<exception cref="T:System.OverflowException">
<paramref name="s" /> represents a number less than <see cref="F:System.Int16.MinValue" /> or greater than <see cref="F:System.Int16.MaxValue" />.</exception>
- <returns>An <see cref="T:System.Int16" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToInt32(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.Int32" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>An <see langword="Int32" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is not in the correct format.</exception>
<exception cref="T:System.OverflowException">
<paramref name="s" /> represents a number less than <see cref="F:System.Int32.MinValue" /> or greater than <see cref="F:System.Int32.MaxValue" />.</exception>
- <returns>An <see cref="T:System.Int32" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToInt64(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.Int64" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>An <see langword="Int64" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is not in the correct format.</exception>
<exception cref="T:System.OverflowException">
<paramref name="s" /> represents a number less than <see cref="F:System.Int64.MinValue" /> or greater than <see cref="F:System.Int64.MaxValue" />.</exception>
- <returns>An <see cref="T:System.Int64" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToSByte(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.SByte" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>An <see langword="SByte" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is not in the correct format.</exception>
<exception cref="T:System.OverflowException">
<paramref name="s" /> represents a number less than <see cref="F:System.SByte.MinValue" /> or greater than <see cref="F:System.SByte.MaxValue" />.</exception>
- <returns>An <see langword="SByte" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToSingle(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.Single" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>A <see langword="Single" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is not in the correct format.</exception>
<exception cref="T:System.OverflowException">
<paramref name="s" /> represents a number less than <see cref="F:System.Single.MinValue" /> or greater than <see cref="F:System.Single.MaxValue" />.</exception>
- <returns>A <see cref="T:System.Single" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToString(System.Boolean)">
<summary>Converts the <see cref="T:System.Boolean" /> to a <see cref="T:System.String" />.</summary>
<summary>Converts the <see cref="T:System.DateTime" /> to a <see cref="T:System.String" /> using the <see cref="T:System.Xml.XmlDateTimeSerializationMode" /> specified.</summary>
<param name="value">The <see cref="T:System.DateTime" /> value to convert.</param>
<param name="dateTimeOption">One of the <see cref="T:System.Xml.XmlDateTimeSerializationMode" /> values that specify how to treat the <see cref="T:System.DateTime" /> value.</param>
+ <returns>A <see cref="T:System.String" /> equivalent of the <see cref="T:System.DateTime" />.</returns>
<exception cref="T:System.ArgumentException">The <paramref name="dateTimeOption" /> value is not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="value" /> or <paramref name="dateTimeOption" /> value is <see langword="null" />.</exception>
- <returns>A <see cref="T:System.String" /> equivalent of the <see cref="T:System.DateTime" />.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToString(System.DateTimeOffset)">
<summary>Converts the supplied <see cref="T:System.DateTimeOffset" /> to a <see cref="T:System.String" />.</summary>
<member name="M:System.Xml.XmlConvert.ToString(System.Double)">
<summary>Converts the <see cref="T:System.Double" /> to a <see cref="T:System.String" />.</summary>
<param name="value">The value to convert.</param>
- <returns>A string representation of the <see cref="T:System.Double" />.</returns>
+ <returns>A string representation of the <see langword="Double" />.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToString(System.Guid)">
<summary>Converts the <see cref="T:System.Guid" /> to a <see cref="T:System.String" />.</summary>
<member name="M:System.Xml.XmlConvert.ToString(System.Int16)">
<summary>Converts the <see cref="T:System.Int16" /> to a <see cref="T:System.String" />.</summary>
<param name="value">The value to convert.</param>
- <returns>A string representation of the <see cref="T:System.Int16" />.</returns>
+ <returns>A string representation of the <see langword="Int16" />.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToString(System.Int32)">
<summary>Converts the <see cref="T:System.Int32" /> to a <see cref="T:System.String" />.</summary>
<param name="value">The value to convert.</param>
- <returns>A string representation of the <see cref="T:System.Int32" />.</returns>
+ <returns>A string representation of the <see langword="Int32" />.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToString(System.Int64)">
<summary>Converts the <see cref="T:System.Int64" /> to a <see cref="T:System.String" />.</summary>
<param name="value">The value to convert.</param>
- <returns>A string representation of the <see cref="T:System.Int64" />.</returns>
+ <returns>A string representation of the <see langword="Int64" />.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToString(System.SByte)">
<summary>Converts the <see cref="T:System.SByte" /> to a <see cref="T:System.String" />.</summary>
<member name="M:System.Xml.XmlConvert.ToString(System.Single)">
<summary>Converts the <see cref="T:System.Single" /> to a <see cref="T:System.String" />.</summary>
<param name="value">The value to convert.</param>
- <returns>A string representation of the <see cref="T:System.Single" />.</returns>
+ <returns>A string representation of the <see langword="Single" />.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToString(System.TimeSpan)">
<summary>Converts the <see cref="T:System.TimeSpan" /> to a <see cref="T:System.String" />.</summary>
<member name="M:System.Xml.XmlConvert.ToString(System.UInt16)">
<summary>Converts the <see cref="T:System.UInt16" /> to a <see cref="T:System.String" />.</summary>
<param name="value">The value to convert.</param>
- <returns>A string representation of the <see cref="T:System.UInt16" />.</returns>
+ <returns>A string representation of the <see langword="UInt16" />.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToString(System.UInt32)">
<summary>Converts the <see cref="T:System.UInt32" /> to a <see cref="T:System.String" />.</summary>
<param name="value">The value to convert.</param>
- <returns>A string representation of the <see cref="T:System.UInt32" />.</returns>
+ <returns>A string representation of the <see langword="UInt32" />.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToString(System.UInt64)">
<summary>Converts the <see cref="T:System.UInt64" /> to a <see cref="T:System.String" />.</summary>
<param name="value">The value to convert.</param>
- <returns>A string representation of the <see cref="T:System.UInt64" />.</returns>
+ <returns>A string representation of the <see langword="UInt64" />.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToTimeSpan(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.TimeSpan" /> equivalent.</summary>
<param name="s">The string to convert. The string format must conform to the W3C XML Schema Part 2: Datatypes recommendation for duration.</param>
+ <returns>A <see langword="TimeSpan" /> equivalent of the string.</returns>
<exception cref="T:System.FormatException">
<paramref name="s" /> is not in correct format to represent a <see langword="TimeSpan" /> value.</exception>
- <returns>A <see langword="TimeSpan" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToUInt16(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.UInt16" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>A <see langword="UInt16" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is not in the correct format.</exception>
<exception cref="T:System.OverflowException">
<paramref name="s" /> represents a number less than <see cref="F:System.UInt16.MinValue" /> or greater than <see cref="F:System.UInt16.MaxValue" />.</exception>
- <returns>A <see cref="T:System.UInt16" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToUInt32(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.UInt32" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>A <see langword="UInt32" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is not in the correct format.</exception>
<exception cref="T:System.OverflowException">
<paramref name="s" /> represents a number less than <see cref="F:System.UInt32.MinValue" /> or greater than <see cref="F:System.UInt32.MaxValue" />.</exception>
- <returns>A <see cref="T:System.UInt32" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.ToUInt64(System.String)">
<summary>Converts the <see cref="T:System.String" /> to a <see cref="T:System.UInt64" /> equivalent.</summary>
<param name="s">The string to convert.</param>
+ <returns>A <see langword="UInt64" /> equivalent of the string.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="s" /> is <see langword="null" />.</exception>
<exception cref="T:System.FormatException">
<paramref name="s" /> is not in the correct format.</exception>
<exception cref="T:System.OverflowException">
<paramref name="s" /> represents a number less than <see cref="F:System.UInt64.MinValue" /> or greater than <see cref="F:System.UInt64.MaxValue" />.</exception>
- <returns>A <see cref="T:System.UInt64" /> equivalent of the string.</returns>
</member>
<member name="M:System.Xml.XmlConvert.VerifyName(System.String)">
<summary>Verifies that the name is a valid name according to the W3C Extended Markup Language recommendation.</summary>
<param name="name">The name to verify.</param>
+ <returns>The name, if it is a valid XML name.</returns>
<exception cref="T:System.Xml.XmlException">
<paramref name="name" /> is not a valid XML name.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is <see langword="null" /> or String.Empty.</exception>
- <returns>The name, if it is a valid XML name.</returns>
</member>
<member name="M:System.Xml.XmlConvert.VerifyNCName(System.String)">
<summary>Verifies that the name is a valid <see langword="NCName" /> according to the W3C Extended Markup Language recommendation. An <see langword="NCName" /> is a name that cannot contain a colon.</summary>
<param name="name">The name to verify.</param>
+ <returns>The name, if it is a valid NCName.</returns>
<exception cref="T:System.ArgumentNullException">
- <paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.</exception>
+ <paramref name="name" /> is <see langword="null" /> or <c>String.Empty</c>.</exception>
<exception cref="T:System.Xml.XmlException">
<paramref name="name" /> is not a valid non-colon name.</exception>
- <returns>The name, if it is a valid NCName.</returns>
</member>
<member name="M:System.Xml.XmlConvert.VerifyNMTOKEN(System.String)">
<summary>Verifies that the string is a valid NMTOKEN according to the W3C XML Schema Part2: Datatypes recommendation.</summary>
<param name="name">The string you wish to verify.</param>
+ <returns>The name token, if it is a valid NMTOKEN.</returns>
<exception cref="T:System.Xml.XmlException">The string is not a valid name token.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is <see langword="null" />.</exception>
- <returns>The name token, if it is a valid NMTOKEN.</returns>
</member>
<member name="M:System.Xml.XmlConvert.VerifyPublicId(System.String)">
<summary>Returns the passed in string instance if all the characters in the string argument are valid public id characters.</summary>
<member name="M:System.Xml.XmlConvert.VerifyTOKEN(System.String)">
<summary>Verifies that the string is a valid token according to the W3C XML Schema Part2: Datatypes recommendation.</summary>
<param name="token">The string value you wish to verify.</param>
- <exception cref="T:System.Xml.XmlException">The string value is not a valid token.</exception>
<returns>The token, if it is a valid token.</returns>
+ <exception cref="T:System.Xml.XmlException">The string value is not a valid token.</exception>
</member>
<member name="M:System.Xml.XmlConvert.VerifyWhitespace(System.String)">
<summary>Returns the passed-in string instance if all the characters in the string argument are valid whitespace characters.</summary>
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself. Because <see langword="XmlDeclaration" /> nodes do not have children, the cloned node always includes the data value, regardless of the parameter setting.</param>
<returns>The cloned node.</returns>
</member>
- <member name="M:System.Xml.XmlDeclaration.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. Because <see langword="XmlDeclaration" /> nodes do not have children, this method has no effect.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlDeclaration.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
<member name="P:System.Xml.XmlDeclaration.Encoding">
<summary>Gets or sets the encoding level of the XML document.</summary>
- <returns>The valid character encoding name. The most commonly supported character encoding names for XML are the following:
+ <returns>The valid character encoding name. The most commonly supported character encoding names for XML are the following:
+ Category
- <list type="table"><listheader><term> Category</term><description> Encoding Names</description></listheader><item><term> Unicode</term><description> UTF-8, UTF-16</description></item><item><term> ISO 10646</term><description> ISO-10646-UCS-2, ISO-10646-UCS-4</description></item><item><term> ISO 8859</term><description> ISO-8859-n (where "n" is a digit from 1 to 9)</description></item><item><term> JIS X-0208-1997</term><description> ISO-2022-JP, Shift_JIS, EUC-JP</description></item></list>
-
- This value is optional. If a value is not set, this property returns String.Empty.
+ Encoding Names
+
+ Unicode
+
+ UTF-8, UTF-16
+
+ ISO 10646
+
+ ISO-10646-UCS-2, ISO-10646-UCS-4
+
+ ISO 8859
+
+ ISO-8859-n (where "n" is a digit from 1 to 9)
+
+ JIS X-0208-1997
- If an encoding attribute is not included, UTF-8 encoding is assumed when the document is written or saved out.</returns>
+ ISO-2022-JP, Shift_JIS, EUC-JP
+
+
+This value is optional. If a value is not set, this property returns String.Empty.
+If an encoding attribute is not included, UTF-8 encoding is assumed when the document is written or saved out.</returns>
</member>
<member name="P:System.Xml.XmlDeclaration.InnerText">
<summary>Gets or sets the concatenated values of the <see langword="XmlDeclaration" />.</summary>
<summary>Gets the XML version of the document.</summary>
<returns>The value is always <see langword="1.0" />.</returns>
</member>
- <member name="T:System.Xml.XmlDocument">
- <summary>Represents an XML document. You can use this class to load, validate, edit, add, and position XML in a document.</summary>
- </member>
- <member name="E:System.Xml.XmlDocument.NodeChanged">
- <summary>Occurs when the <see cref="P:System.Xml.XmlNode.Value" /> of a node belonging to this document has been changed.</summary>
- </member>
- <member name="E:System.Xml.XmlDocument.NodeChanging">
- <summary>Occurs when the <see cref="P:System.Xml.XmlNode.Value" /> of a node belonging to this document is about to be changed.</summary>
- </member>
- <member name="E:System.Xml.XmlDocument.NodeInserted">
- <summary>Occurs when a node belonging to this document has been inserted into another node.</summary>
- </member>
- <member name="E:System.Xml.XmlDocument.NodeInserting">
- <summary>Occurs when a node belonging to this document is about to be inserted into another node.</summary>
+ <member name="M:System.Xml.XmlDeclaration.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. Because <see langword="XmlDeclaration" /> nodes do not have children, this method has no effect.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
</member>
- <member name="E:System.Xml.XmlDocument.NodeRemoved">
- <summary>Occurs when a node belonging to this document has been removed from its parent.</summary>
+ <member name="M:System.Xml.XmlDeclaration.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
</member>
- <member name="E:System.Xml.XmlDocument.NodeRemoving">
- <summary>Occurs when a node belonging to this document is about to be removed from the document.</summary>
+ <member name="T:System.Xml.XmlDocument">
+ <summary>Represents an XML document. You can use this class to load, validate, edit, add, and position XML in a document.</summary>
</member>
<member name="M:System.Xml.XmlDocument.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.XmlDocument" /> class.</summary>
<summary>Initializes a new instance of the <see langword="XmlDocument" /> class with the specified <see cref="T:System.Xml.XmlNameTable" />.</summary>
<param name="nt">The <see langword="XmlNameTable" /> to use.</param>
</member>
+ <member name="P:System.Xml.XmlDocument.BaseURI">
+ <summary>Gets the base URI of the current node.</summary>
+ <returns>The location from which the node was loaded.</returns>
+ </member>
<member name="M:System.Xml.XmlDocument.CloneNode(System.Boolean)">
<summary>Creates a duplicate of this node.</summary>
<param name="deep">
<member name="M:System.Xml.XmlDocument.CreateEntityReference(System.String)">
<summary>Creates an <see cref="T:System.Xml.XmlEntityReference" /> with the specified name.</summary>
<param name="name">The name of the entity reference.</param>
- <exception cref="T:System.ArgumentException">The name is invalid (for example, names starting with'#' are invalid.)</exception>
<returns>The new <see langword="XmlEntityReference" />.</returns>
+ <exception cref="T:System.ArgumentException">The name is invalid (for example, names starting with'#' are invalid.)</exception>
</member>
<member name="M:System.Xml.XmlDocument.CreateNavigator">
<summary>Creates a new <see cref="T:System.Xml.XPath.XPathNavigator" /> object for navigating this document.</summary>
<param name="nodeTypeString">String version of the <see cref="T:System.Xml.XmlNodeType" /> of the new node. This parameter must be one of the values listed in the table below.</param>
<param name="name">The qualified name of the new node. If the name contains a colon, it is parsed into <see cref="P:System.Xml.XmlNode.Prefix" /> and <see cref="P:System.Xml.XmlDocument.LocalName" /> components.</param>
<param name="namespaceURI">The namespace URI of the new node.</param>
- <exception cref="T:System.ArgumentException">The name was not provided and the <see langword="XmlNodeType" /> requires a name; or <paramref name="nodeTypeString" /> is not one of the strings listed below.</exception>
<returns>The new <see langword="XmlNode" />.</returns>
+ <exception cref="T:System.ArgumentException">The name was not provided and the <see langword="XmlNodeType" /> requires a name; or <paramref name="nodeTypeString" /> is not one of the strings listed below.</exception>
</member>
<member name="M:System.Xml.XmlDocument.CreateNode(System.Xml.XmlNodeType,System.String,System.String)">
<summary>Creates an <see cref="T:System.Xml.XmlNode" /> with the specified <see cref="T:System.Xml.XmlNodeType" />, <see cref="P:System.Xml.XmlDocument.Name" />, and <see cref="P:System.Xml.XmlNode.NamespaceURI" />.</summary>
<param name="type">The <see langword="XmlNodeType" /> of the new node.</param>
<param name="name">The qualified name of the new node. If the name contains a colon then it is parsed into <see cref="P:System.Xml.XmlNode.Prefix" /> and <see cref="P:System.Xml.XmlDocument.LocalName" /> components.</param>
<param name="namespaceURI">The namespace URI of the new node.</param>
- <exception cref="T:System.ArgumentException">The name was not provided and the <see langword="XmlNodeType" /> requires a name.</exception>
<returns>The new <see langword="XmlNode" />.</returns>
+ <exception cref="T:System.ArgumentException">The name was not provided and the <see langword="XmlNodeType" /> requires a name.</exception>
</member>
<member name="M:System.Xml.XmlDocument.CreateNode(System.Xml.XmlNodeType,System.String,System.String,System.String)">
<summary>Creates a <see cref="T:System.Xml.XmlNode" /> with the specified <see cref="T:System.Xml.XmlNodeType" />, <see cref="P:System.Xml.XmlNode.Prefix" />, <see cref="P:System.Xml.XmlDocument.Name" />, and <see cref="P:System.Xml.XmlNode.NamespaceURI" />.</summary>
<param name="prefix">The prefix of the new node.</param>
<param name="name">The local name of the new node.</param>
<param name="namespaceURI">The namespace URI of the new node.</param>
- <exception cref="T:System.ArgumentException">The name was not provided and the <see langword="XmlNodeType" /> requires a name.</exception>
<returns>The new <see langword="XmlNode" />.</returns>
+ <exception cref="T:System.ArgumentException">The name was not provided and the <see langword="XmlNodeType" /> requires a name.</exception>
</member>
<member name="M:System.Xml.XmlDocument.CreateProcessingInstruction(System.String,System.String)">
<summary>Creates an <see cref="T:System.Xml.XmlProcessingInstruction" /> with the specified name and data.</summary>
</member>
<member name="M:System.Xml.XmlDocument.CreateSignificantWhitespace(System.String)">
<summary>Creates an <see cref="T:System.Xml.XmlSignificantWhitespace" /> node.</summary>
- <param name="text">The string must contain only the following characters &#20; &#10; &#13; and &#9;.</param>
+ <param name="text">The string must contain only the following characters &#20; &#10; &#13; and &#9;</param>
<returns>A new <see langword="XmlSignificantWhitespace" /> node.</returns>
</member>
<member name="M:System.Xml.XmlDocument.CreateTextNode(System.String)">
</member>
<member name="M:System.Xml.XmlDocument.CreateWhitespace(System.String)">
<summary>Creates an <see cref="T:System.Xml.XmlWhitespace" /> node.</summary>
- <param name="text">The string must contain only the following characters &#20; &#10; &#13; and &#9;.</param>
+ <param name="text">The string must contain only the following characters &#20; &#10; &#13; and &#9;</param>
<returns>A new <see langword="XmlWhitespace" /> node.</returns>
</member>
<member name="M:System.Xml.XmlDocument.CreateXmlDeclaration(System.String,System.String,System.String)">
<summary>Creates an <see cref="T:System.Xml.XmlDeclaration" /> node with the specified values.</summary>
<param name="version">The version must be "1.0".</param>
- <param name="encoding">The value of the encoding attribute. This is the encoding that is used when you save the <see cref="T:System.Xml.XmlDocument" /> to a file or a stream; therefore, it must be set to a string supported by the <see cref="T:System.Text.Encoding" /> class, otherwise <see cref="M:System.Xml.XmlDocument.Save(System.String)" /> fails. If this is <see langword="null" /> or String.Empty, the <see langword="Save" /> method does not write an encoding attribute on the XML declaration and therefore the default encoding, UTF-8, is used.
-
- Note: If the <see langword="XmlDocument" /> is saved to either a <see cref="T:System.IO.TextWriter" /> or an <see cref="T:System.Xml.XmlTextWriter" />, this encoding value is discarded. Instead, the encoding of the <see langword="TextWriter" /> or the <see langword="XmlTextWriter" /> is used. This ensures that the XML written out can be read back using the correct encoding.</param>
+ <param name="encoding">The value of the encoding attribute. This is the encoding that is used when you save the <see cref="T:System.Xml.XmlDocument" /> to a file or a stream; therefore, it must be set to a string supported by the <see cref="T:System.Text.Encoding" /> class, otherwise <see cref="M:System.Xml.XmlDocument.Save(System.String)" /> fails. If this is <see langword="null" /> or String.Empty, the <see langword="Save" /> method does not write an encoding attribute on the XML declaration and therefore the default encoding, UTF-8, is used.
+Note: If the <see langword="XmlDocument" /> is saved to either a <see cref="T:System.IO.TextWriter" /> or an <see cref="T:System.Xml.XmlTextWriter" />, this encoding value is discarded. Instead, the encoding of the <see langword="TextWriter" /> or the <see langword="XmlTextWriter" /> is used. This ensures that the XML written out can be read back using the correct encoding.</param>
<param name="standalone">The value must be either "yes" or "no". If this is <see langword="null" /> or String.Empty, the <see langword="Save" /> method does not write a standalone attribute on the XML declaration.</param>
- <exception cref="T:System.ArgumentException">The values of <paramref name="version" /> or <paramref name="standalone" /> are something other than the ones specified above.</exception>
<returns>The new <see langword="XmlDeclaration" /> node.</returns>
+ <exception cref="T:System.ArgumentException">The values of <paramref name="version" /> or <paramref name="standalone" /> are something other than the ones specified above.</exception>
+ </member>
+ <member name="P:System.Xml.XmlDocument.DocumentElement">
+ <summary>Gets the root <see cref="T:System.Xml.XmlElement" /> for the document.</summary>
+ <returns>The <see langword="XmlElement" /> that represents the root of the XML document tree. If no root exists, <see langword="null" /> is returned.</returns>
+ </member>
+ <member name="P:System.Xml.XmlDocument.DocumentType">
+ <summary>Gets the node containing the DOCTYPE declaration.</summary>
+ <returns>The <see cref="T:System.Xml.XmlNode" /> containing the DocumentType (DOCTYPE declaration).</returns>
</member>
<member name="M:System.Xml.XmlDocument.GetElementById(System.String)">
<summary>Gets the <see cref="T:System.Xml.XmlElement" /> with the specified ID.</summary>
<param name="namespaceURI">NamespaceURI to match.</param>
<returns>An <see cref="T:System.Xml.XmlNodeList" /> containing a list of all matching nodes. If no nodes match the specified <paramref name="localName" /> and <paramref name="namespaceURI" />, the returned collection will be empty.</returns>
</member>
+ <member name="P:System.Xml.XmlDocument.Implementation">
+ <summary>Gets the <see cref="T:System.Xml.XmlImplementation" /> object for the current document.</summary>
+ <returns>The <see langword="XmlImplementation" /> object for the current document.</returns>
+ </member>
<member name="M:System.Xml.XmlDocument.ImportNode(System.Xml.XmlNode,System.Boolean)">
<summary>Imports a node from another document to the current document.</summary>
<param name="node">The node being imported.</param>
<param name="deep">
<see langword="true" /> to perform a deep clone; otherwise, <see langword="false" />.</param>
- <exception cref="T:System.InvalidOperationException">Calling this method on a node type which cannot be imported.</exception>
<returns>The imported <see cref="T:System.Xml.XmlNode" />.</returns>
+ <exception cref="T:System.InvalidOperationException">Calling this method on a node type which cannot be imported.</exception>
+ </member>
+ <member name="P:System.Xml.XmlDocument.InnerText">
+ <summary>Throws an <see cref="T:System.InvalidOperationException" /> in all cases.</summary>
+ <returns>The values of the node and all its child nodes.</returns>
+ <exception cref="T:System.InvalidOperationException">In all cases.</exception>
+ </member>
+ <member name="P:System.Xml.XmlDocument.InnerXml">
+ <summary>Gets or sets the markup representing the children of the current node.</summary>
+ <returns>The markup of the children of the current node.</returns>
+ <exception cref="T:System.Xml.XmlException">The XML specified when setting this property is not well-formed.</exception>
+ </member>
+ <member name="P:System.Xml.XmlDocument.IsReadOnly">
+ <summary>Gets a value indicating whether the current node is read-only.</summary>
+ <returns>
+ <see langword="true" /> if the current node is read-only; otherwise <see langword="false" />. <see langword="XmlDocument" /> nodes always return <see langword="false" />.</returns>
</member>
<member name="M:System.Xml.XmlDocument.Load(System.IO.Stream)">
<summary>Loads the XML document from the specified stream.</summary>
<exception cref="T:System.IO.DirectoryNotFoundException">The specified path is invalid (for example, it is on an unmapped drive).</exception>
<exception cref="T:System.IO.IOException">An I/O error occurred while opening the file.</exception>
<exception cref="T:System.UnauthorizedAccessException">
- <paramref name="filename" /> specified a file that is read-only.
-
- -or-
-
- This operation is not supported on the current platform.
-
- -or-
-
- <paramref name="filename" /> specified a directory.
-
- -or-
-
- The caller does not have the required permission.</exception>
+ <paramref name="filename" /> specified a file that is read-only.
+-or-
+This operation is not supported on the current platform.
+-or-
+<paramref name="filename" /> specified a directory.
+-or-
+The caller does not have the required permission.</exception>
<exception cref="T:System.IO.FileNotFoundException">The file specified in <paramref name="filename" /> was not found.</exception>
<exception cref="T:System.NotSupportedException">
<paramref name="filename" /> is in an invalid format.</exception>
<param name="xml">String containing the XML document to load.</param>
<exception cref="T:System.Xml.XmlException">There is a load or parse error in the XML. In this case, the document remains empty.</exception>
</member>
+ <member name="P:System.Xml.XmlDocument.LocalName">
+ <summary>Gets the local name of the node.</summary>
+ <returns>For <see langword="XmlDocument" /> nodes, the local name is #document.</returns>
+ </member>
+ <member name="P:System.Xml.XmlDocument.Name">
+ <summary>Gets the qualified name of the node.</summary>
+ <returns>For <see langword="XmlDocument" /> nodes, the name is #document.</returns>
+ </member>
+ <member name="P:System.Xml.XmlDocument.NameTable">
+ <summary>Gets the <see cref="T:System.Xml.XmlNameTable" /> associated with this implementation.</summary>
+ <returns>An <see langword="XmlNameTable" /> enabling you to get the atomized version of a string within the document.</returns>
+ </member>
+ <member name="E:System.Xml.XmlDocument.NodeChanged">
+ <summary>Occurs when the <see cref="P:System.Xml.XmlNode.Value" /> of a node belonging to this document has been changed.</summary>
+ </member>
+ <member name="E:System.Xml.XmlDocument.NodeChanging">
+ <summary>Occurs when the <see cref="P:System.Xml.XmlNode.Value" /> of a node belonging to this document is about to be changed.</summary>
+ </member>
+ <member name="E:System.Xml.XmlDocument.NodeInserted">
+ <summary>Occurs when a node belonging to this document has been inserted into another node.</summary>
+ </member>
+ <member name="E:System.Xml.XmlDocument.NodeInserting">
+ <summary>Occurs when a node belonging to this document is about to be inserted into another node.</summary>
+ </member>
+ <member name="E:System.Xml.XmlDocument.NodeRemoved">
+ <summary>Occurs when a node belonging to this document has been removed from its parent.</summary>
+ </member>
+ <member name="E:System.Xml.XmlDocument.NodeRemoving">
+ <summary>Occurs when a node belonging to this document is about to be removed from the document.</summary>
+ </member>
+ <member name="P:System.Xml.XmlDocument.NodeType">
+ <summary>Gets the type of the current node.</summary>
+ <returns>The node type. For <see langword="XmlDocument" /> nodes, this value is XmlNodeType.Document.</returns>
+ </member>
+ <member name="P:System.Xml.XmlDocument.OwnerDocument">
+ <summary>Gets the <see cref="T:System.Xml.XmlDocument" /> to which the current node belongs.</summary>
+ <returns>For <see langword="XmlDocument" /> nodes (<see cref="P:System.Xml.XmlDocument.NodeType" /> equals XmlNodeType.Document), this property always returns <see langword="null" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlDocument.ParentNode">
+ <summary>Gets the parent node of this node (for nodes that can have parents).</summary>
+ <returns>Always returns <see langword="null" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlDocument.PreserveWhitespace">
+ <summary>Gets or sets a value indicating whether to preserve white space in element content.</summary>
+ <returns>
+ <see langword="true" /> to preserve white space; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
+ </member>
<member name="M:System.Xml.XmlDocument.ReadNode(System.Xml.XmlReader)">
<summary>Creates an <see cref="T:System.Xml.XmlNode" /> object based on the information in the <see cref="T:System.Xml.XmlReader" />. The reader must be positioned on a node or attribute.</summary>
- <param name="reader">The XML source.</param>
- <exception cref="T:System.NullReferenceException">The reader is positioned on a node type that does not translate to a valid DOM node (for example, EndElement or EndEntity).</exception>
+ <param name="reader">The XML source</param>
<returns>The new <see langword="XmlNode" /> or <see langword="null" /> if no more nodes exist.</returns>
+ <exception cref="T:System.NullReferenceException">The reader is positioned on a node type that does not translate to a valid DOM node (for example, EndElement or EndEntity).</exception>
</member>
<member name="M:System.Xml.XmlDocument.Save(System.IO.Stream)">
<summary>Saves the XML document to the specified stream.</summary>
<param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
<exception cref="T:System.Xml.XmlException">The operation would not result in a well formed XML document (for example, no document element or duplicate XML declarations).</exception>
</member>
+ <member name="P:System.Xml.XmlDocument.SchemaInfo">
+ <summary>Returns the Post-Schema-Validation-Infoset (PSVI) of the node.</summary>
+ <returns>The <see cref="T:System.Xml.Schema.IXmlSchemaInfo" /> object representing the PSVI of the node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlDocument.Schemas">
+ <summary>Gets or sets the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object associated with this <see cref="T:System.Xml.XmlDocument" />.</summary>
+ <returns>An <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object containing the XML Schema Definition Language (XSD) schemas associated with this <see cref="T:System.Xml.XmlDocument" />; otherwise, an empty <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object.</returns>
+ </member>
<member name="M:System.Xml.XmlDocument.Validate(System.Xml.Schema.ValidationEventHandler)">
<summary>Validates the <see cref="T:System.Xml.XmlDocument" /> against the XML Schema Definition Language (XSD) schemas contained in the <see cref="P:System.Xml.XmlDocument.Schemas" /> property.</summary>
<param name="validationEventHandler">The <see cref="T:System.Xml.Schema.ValidationEventHandler" /> object that receives information about schema validation warnings and errors.</param>
<summary>Saves the <see langword="XmlDocument" /> node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
<param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
</member>
- <member name="P:System.Xml.XmlDocument.BaseURI">
- <summary>Gets the base URI of the current node.</summary>
- <returns>The location from which the node was loaded.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.DocumentElement">
- <summary>Gets the root <see cref="T:System.Xml.XmlElement" /> for the document.</summary>
- <returns>The <see langword="XmlElement" /> that represents the root of the XML document tree. If no root exists, <see langword="null" /> is returned.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.DocumentType">
- <summary>Gets the node containing the DOCTYPE declaration.</summary>
- <returns>The <see cref="T:System.Xml.XmlNode" /> containing the DocumentType (DOCTYPE declaration).</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.Implementation">
- <summary>Gets the <see cref="T:System.Xml.XmlImplementation" /> object for the current document.</summary>
- <returns>The <see langword="XmlImplementation" /> object for the current document.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.InnerText">
- <summary>Throws an <see cref="T:System.InvalidOperationException" /> in all cases.</summary>
- <exception cref="T:System.InvalidOperationException">In all cases.</exception>
- <returns>The values of the node and all its child nodes.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.InnerXml">
- <summary>Gets or sets the markup representing the children of the current node.</summary>
- <exception cref="T:System.Xml.XmlException">The XML specified when setting this property is not well-formed.</exception>
- <returns>The markup of the children of the current node.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.IsReadOnly">
- <summary>Gets a value indicating whether the current node is read-only.</summary>
- <returns>
- <see langword="true" /> if the current node is read-only; otherwise <see langword="false" />. <see langword="XmlDocument" /> nodes always return <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.LocalName">
- <summary>Gets the local name of the node.</summary>
- <returns>For <see langword="XmlDocument" /> nodes, the local name is #document.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.Name">
- <summary>Gets the qualified name of the node.</summary>
- <returns>For <see langword="XmlDocument" /> nodes, the name is #document.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.NameTable">
- <summary>Gets the <see cref="T:System.Xml.XmlNameTable" /> associated with this implementation.</summary>
- <returns>An <see langword="XmlNameTable" /> enabling you to get the atomized version of a string within the document.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.NodeType">
- <summary>Gets the type of the current node.</summary>
- <returns>The node type. For <see langword="XmlDocument" /> nodes, this value is XmlNodeType.Document.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.OwnerDocument">
- <summary>Gets the <see cref="T:System.Xml.XmlDocument" /> to which the current node belongs.</summary>
- <returns>For <see langword="XmlDocument" /> nodes (<see cref="P:System.Xml.XmlDocument.NodeType" /> equals XmlNodeType.Document), this property always returns <see langword="null" />.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.ParentNode">
- <summary>Gets the parent node of this node (for nodes that can have parents).</summary>
- <returns>Always returns <see langword="null" />.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.PreserveWhitespace">
- <summary>Gets or sets a value indicating whether to preserve white space in element content.</summary>
- <returns>
- <see langword="true" /> to preserve white space; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.SchemaInfo">
- <summary>Returns the Post-Schema-Validation-Infoset (PSVI) of the node.</summary>
- <returns>The <see cref="T:System.Xml.Schema.IXmlSchemaInfo" /> object representing the PSVI of the node.</returns>
- </member>
- <member name="P:System.Xml.XmlDocument.Schemas">
- <summary>Gets or sets the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object associated with this <see cref="T:System.Xml.XmlDocument" />.</summary>
- <returns>An <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object containing the XML Schema Definition Language (XSD) schemas associated with this <see cref="T:System.Xml.XmlDocument" />; otherwise, an empty <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object.</returns>
- </member>
<member name="P:System.Xml.XmlDocument.XmlResolver">
<summary>Sets the <see cref="T:System.Xml.XmlResolver" /> to use for resolving external resources.</summary>
+ <returns>The <see langword="XmlResolver" /> to use.
+In version 1.1 of the.NET Framework, the caller must be fully trusted in order to specify an <see langword="XmlResolver" />.</returns>
<exception cref="T:System.Xml.XmlException">This property is set to <see langword="null" /> and an external DTD or entity is encountered.</exception>
- <returns>The <see langword="XmlResolver" /> to use.
-
- In version 1.1 of the.NET Framework, the caller must be fully trusted in order to specify an <see langword="XmlResolver" />.</returns>
</member>
<member name="T:System.Xml.XmlDocumentFragment">
<summary>Represents a lightweight object that is useful for tree insert operations.</summary>
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself.</param>
<returns>The cloned node.</returns>
</member>
- <member name="M:System.Xml.XmlDocumentFragment.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlDocumentFragment.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
<member name="P:System.Xml.XmlDocumentFragment.InnerXml">
<summary>Gets or sets the markup representing the children of this node.</summary>
- <exception cref="T:System.Xml.XmlException">The XML specified when setting this property is not well-formed.</exception>
<returns>The markup of the children of this node.</returns>
+ <exception cref="T:System.Xml.XmlException">The XML specified when setting this property is not well-formed.</exception>
</member>
<member name="P:System.Xml.XmlDocumentFragment.LocalName">
<summary>Gets the local name of the node.</summary>
</member>
<member name="P:System.Xml.XmlDocumentFragment.ParentNode">
<summary>Gets the parent of this node (for nodes that can have parents).</summary>
- <returns>The parent of this node.
-
- For <see langword="XmlDocumentFragment" /> nodes, this property is always <see langword="null" />.</returns>
+ <returns>The parent of this node.
+For <see langword="XmlDocumentFragment" /> nodes, this property is always <see langword="null" />.</returns>
+ </member>
+ <member name="M:System.Xml.XmlDocumentFragment.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="M:System.Xml.XmlDocumentFragment.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
</member>
<member name="T:System.Xml.XmlDocumentType">
<summary>Represents the document type declaration.</summary>
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself. For document type nodes, the cloned node always includes the subtree, regardless of the parameter setting.</param>
<returns>The cloned node.</returns>
</member>
- <member name="M:System.Xml.XmlDocumentType.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. For <see langword="XmlDocumentType" /> nodes, this method has no effect.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlDocumentType.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
<member name="P:System.Xml.XmlDocumentType.Entities">
<summary>Gets the collection of <see cref="T:System.Xml.XmlEntity" /> nodes declared in the document type declaration.</summary>
<returns>An <see cref="T:System.Xml.XmlNamedNodeMap" /> containing the <see langword="XmlEntity" /> nodes. The returned <see langword="XmlNamedNodeMap" /> is read-only.</returns>
<member name="P:System.Xml.XmlDocumentType.IsReadOnly">
<summary>Gets a value indicating whether the node is read-only.</summary>
<returns>
- <see langword="true" /> if the node is read-only; otherwise, <see langword="false" />.
-
- Because DocumentType nodes are read-only, this property always returns <see langword="true" />.</returns>
+ <see langword="true" /> if the node is read-only; otherwise, <see langword="false" />.
+Because DocumentType nodes are read-only, this property always returns <see langword="true" />.</returns>
</member>
<member name="P:System.Xml.XmlDocumentType.LocalName">
<summary>Gets the local name of the node.</summary>
<summary>Gets the value of the system identifier on the DOCTYPE declaration.</summary>
<returns>The system identifier on the DOCTYPE. If there is no system identifier, <see langword="null" /> is returned.</returns>
</member>
- <member name="T:System.Xml.XmlElement">
- <summary>Represents an element.</summary>
+ <member name="M:System.Xml.XmlDocumentType.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. For <see langword="XmlDocumentType" /> nodes, this method has no effect.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
</member>
- <member name="M:System.Xml.XmlElement.#ctor(System.String,System.String,System.String,System.Xml.XmlDocument)">
+ <member name="M:System.Xml.XmlDocumentType.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="T:System.Xml.XmlElement">
+ <summary>Represents an element.</summary>
+ </member>
+ <member name="M:System.Xml.XmlElement.#ctor(System.String,System.String,System.String,System.Xml.XmlDocument)">
<summary>Initializes a new instance of the <see cref="T:System.Xml.XmlElement" /> class.</summary>
<param name="prefix">The namespace prefix; see the <see cref="P:System.Xml.XmlElement.Prefix" /> property.</param>
<param name="localName">The local name; see the <see cref="P:System.Xml.XmlElement.LocalName" /> property.</param>
<param name="namespaceURI">The namespace URI; see the <see cref="P:System.Xml.XmlElement.NamespaceURI" /> property.</param>
<param name="doc">The parent XML document.</param>
</member>
+ <member name="P:System.Xml.XmlElement.Attributes">
+ <summary>Gets an <see cref="T:System.Xml.XmlAttributeCollection" /> containing the list of attributes for this node.</summary>
+ <returns>
+ <see cref="T:System.Xml.XmlAttributeCollection" /> containing the list of attributes for this node.</returns>
+ </member>
<member name="M:System.Xml.XmlElement.CloneNode(System.Boolean)">
<summary>Creates a duplicate of this node.</summary>
<param name="deep">
<returns>
<see langword="true" /> if the current node has the specified attribute; otherwise, <see langword="false" />.</returns>
</member>
+ <member name="P:System.Xml.XmlElement.HasAttributes">
+ <summary>Gets a <see langword="boolean" /> value indicating whether the current node has any attributes.</summary>
+ <returns>
+ <see langword="true" /> if the current node has attributes; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlElement.InnerText">
+ <summary>Gets or sets the concatenated values of the node and all its children.</summary>
+ <returns>The concatenated values of the node and all its children.</returns>
+ </member>
+ <member name="P:System.Xml.XmlElement.InnerXml">
+ <summary>Gets or sets the markup representing just the children of this node.</summary>
+ <returns>The markup of the children of this node.</returns>
+ <exception cref="T:System.Xml.XmlException">The XML specified when setting this property is not well-formed.</exception>
+ </member>
+ <member name="P:System.Xml.XmlElement.IsEmpty">
+ <summary>Gets or sets the tag format of the element.</summary>
+ <returns>
+ <see langword="true" /> if the element is to be serialized in the short tag format "<item/>"; <see langword="false" /> for the long format "<item></item>".
+When setting this property, if set to <see langword="true" />, the children of the element are removed and the element is serialized in the short tag format. If set to <see langword="false" />, the value of the property is changed (regardless of whether or not the element has content); if the element is empty, it is serialized in the long format.
+This property is a Microsoft extension to the Document Object Model (DOM).</returns>
+ </member>
+ <member name="P:System.Xml.XmlElement.LocalName">
+ <summary>Gets the local name of the current node.</summary>
+ <returns>The name of the current node with the prefix removed. For example, <see langword="LocalName" /> is book for the element <bk:book>.</returns>
+ </member>
+ <member name="P:System.Xml.XmlElement.Name">
+ <summary>Gets the qualified name of the node.</summary>
+ <returns>The qualified name of the node. For <see langword="XmlElement" /> nodes, this is the tag name of the element.</returns>
+ </member>
+ <member name="P:System.Xml.XmlElement.NamespaceURI">
+ <summary>Gets the namespace URI of this node.</summary>
+ <returns>The namespace URI of this node. If there is no namespace URI, this property returns String.Empty.</returns>
+ </member>
+ <member name="P:System.Xml.XmlElement.NextSibling">
+ <summary>Gets the <see cref="T:System.Xml.XmlNode" /> immediately following this element.</summary>
+ <returns>The <see langword="XmlNode" /> immediately following this element.</returns>
+ </member>
+ <member name="P:System.Xml.XmlElement.NodeType">
+ <summary>Gets the type of the current node.</summary>
+ <returns>The node type. For <see langword="XmlElement" /> nodes, this value is XmlNodeType.Element.</returns>
+ </member>
+ <member name="P:System.Xml.XmlElement.OwnerDocument">
+ <summary>Gets the <see cref="T:System.Xml.XmlDocument" /> to which this node belongs.</summary>
+ <returns>The <see langword="XmlDocument" /> to which this element belongs.</returns>
+ </member>
+ <member name="P:System.Xml.XmlElement.ParentNode">
+ <summary>Gets the parent of this node (for nodes that can have parents).</summary>
+ <returns>The <see langword="XmlNode" /> that is the parent of the current node. If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is <see langword="null" />. For all other nodes, the value returned depends on the <see cref="P:System.Xml.XmlNode.NodeType" /> of the node. The following table describes the possible return values for the <see langword="ParentNode" /> property.</returns>
+ </member>
+ <member name="P:System.Xml.XmlElement.Prefix">
+ <summary>Gets or sets the namespace prefix of this node.</summary>
+ <returns>The namespace prefix of this node. If there is no prefix, this property returns String.Empty.</returns>
+ <exception cref="T:System.ArgumentException">This node is read-only</exception>
+ <exception cref="T:System.Xml.XmlException">The specified prefix contains an invalid character.
+The specified prefix is malformed.
+The namespaceURI of this node is <see langword="null" />.
+The specified prefix is "xml" and the namespaceURI of this node is different from http://www.w3.org/XML/1998/namespace.</exception>
+ </member>
<member name="M:System.Xml.XmlElement.RemoveAll">
<summary>Removes all specified attributes and children of the current node. Default attributes are not removed.</summary>
</member>
</member>
<member name="M:System.Xml.XmlElement.RemoveAttribute(System.String)">
<summary>Removes an attribute by name.</summary>
- <param name="name">The name of the attribute to remove. This is a qualified name. It is matched against the <see langword="Name" /> property of the matching node.</param>
+ <param name="name">The name of the attribute to remove.This is a qualified name. It is matched against the <see langword="Name" /> property of the matching node.</param>
<exception cref="T:System.ArgumentException">The node is read-only.</exception>
</member>
<member name="M:System.Xml.XmlElement.RemoveAttribute(System.String,System.String)">
<summary>Removes the <see cref="T:System.Xml.XmlAttribute" /> specified by the local name and namespace URI. (If the removed attribute has a default value, it is immediately replaced).</summary>
<param name="localName">The local name of the attribute.</param>
<param name="namespaceURI">The namespace URI of the attribute.</param>
- <exception cref="T:System.ArgumentException">This node is read-only.</exception>
<returns>The removed <see langword="XmlAttribute" /> or <see langword="null" /> if the <see langword="XmlElement" /> does not have a matching attribute node.</returns>
+ <exception cref="T:System.ArgumentException">This node is read-only.</exception>
</member>
<member name="M:System.Xml.XmlElement.RemoveAttributeNode(System.Xml.XmlAttribute)">
<summary>Removes the specified <see cref="T:System.Xml.XmlAttribute" />.</summary>
<param name="oldAttr">The <see langword="XmlAttribute" /> node to remove. If the removed attribute has a default value, it is immediately replaced.</param>
- <exception cref="T:System.ArgumentException">This node is read-only.</exception>
<returns>The removed <see langword="XmlAttribute" /> or <see langword="null" /> if <paramref name="oldAttr" /> is not an attribute node of the <see langword="XmlElement" />.</returns>
+ <exception cref="T:System.ArgumentException">This node is read-only.</exception>
+ </member>
+ <member name="P:System.Xml.XmlElement.SchemaInfo">
+ <summary>Gets the post schema validation infoset that has been assigned to this node as a result of schema validation.</summary>
+ <returns>An <see cref="T:System.Xml.Schema.IXmlSchemaInfo" /> object containing the post schema validation infoset of this node.</returns>
</member>
<member name="M:System.Xml.XmlElement.SetAttribute(System.String,System.String)">
<summary>Sets the value of the attribute with the specified name.</summary>
<member name="M:System.Xml.XmlElement.SetAttributeNode(System.Xml.XmlAttribute)">
<summary>Adds the specified <see cref="T:System.Xml.XmlAttribute" />.</summary>
<param name="newAttr">The <see langword="XmlAttribute" /> node to add to the attribute collection for this element.</param>
+ <returns>If the attribute replaces an existing attribute with the same name, the old <see langword="XmlAttribute" /> is returned; otherwise, <see langword="null" /> is returned.</returns>
<exception cref="T:System.ArgumentException">The <paramref name="newAttr" /> was created from a different document than the one that created this node. Or this node is read-only.</exception>
<exception cref="T:System.InvalidOperationException">The <paramref name="newAttr" /> is already an attribute of another <see langword="XmlElement" /> object. You must explicitly clone <see langword="XmlAttribute" /> nodes to re-use them in other <see langword="XmlElement" /> objects.</exception>
- <returns>If the attribute replaces an existing attribute with the same name, the old <see langword="XmlAttribute" /> is returned; otherwise, <see langword="null" /> is returned.</returns>
</member>
<member name="M:System.Xml.XmlElement.WriteContentTo(System.Xml.XmlWriter)">
<summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
<summary>Saves the current node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
<param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
</member>
- <member name="P:System.Xml.XmlElement.Attributes">
- <summary>Gets an <see cref="T:System.Xml.XmlAttributeCollection" /> containing the list of attributes for this node.</summary>
- <returns>
- <see cref="T:System.Xml.XmlAttributeCollection" /> containing the list of attributes for this node.</returns>
- </member>
- <member name="P:System.Xml.XmlElement.HasAttributes">
- <summary>Gets a <see langword="boolean" /> value indicating whether the current node has any attributes.</summary>
- <returns>
- <see langword="true" /> if the current node has attributes; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlElement.InnerText">
- <summary>Gets or sets the concatenated values of the node and all its children.</summary>
- <returns>The concatenated values of the node and all its children.</returns>
- </member>
- <member name="P:System.Xml.XmlElement.InnerXml">
- <summary>Gets or sets the markup representing just the children of this node.</summary>
- <exception cref="T:System.Xml.XmlException">The XML specified when setting this property is not well-formed.</exception>
- <returns>The markup of the children of this node.</returns>
- </member>
- <member name="P:System.Xml.XmlElement.IsEmpty">
- <summary>Gets or sets the tag format of the element.</summary>
- <returns>
- <see langword="true" /> if the element is to be serialized in the short tag format "<item/>"; <see langword="false" /> for the long format "<item></item>".
-
- When setting this property, if set to <see langword="true" />, the children of the element are removed and the element is serialized in the short tag format. If set to <see langword="false" />, the value of the property is changed (regardless of whether or not the element has content); if the element is empty, it is serialized in the long format.
-
- This property is a Microsoft extension to the Document Object Model (DOM).</returns>
- </member>
- <member name="P:System.Xml.XmlElement.LocalName">
- <summary>Gets the local name of the current node.</summary>
- <returns>The name of the current node with the prefix removed. For example, <see langword="LocalName" /> is book for the element <bk:book>.</returns>
- </member>
- <member name="P:System.Xml.XmlElement.Name">
- <summary>Gets the qualified name of the node.</summary>
- <returns>The qualified name of the node. For <see langword="XmlElement" /> nodes, this is the tag name of the element.</returns>
- </member>
- <member name="P:System.Xml.XmlElement.NamespaceURI">
- <summary>Gets the namespace URI of this node.</summary>
- <returns>The namespace URI of this node. If there is no namespace URI, this property returns String.Empty.</returns>
- </member>
- <member name="P:System.Xml.XmlElement.NextSibling">
- <summary>Gets the <see cref="T:System.Xml.XmlNode" /> immediately following this element.</summary>
- <returns>The <see langword="XmlNode" /> immediately following this element.</returns>
- </member>
- <member name="P:System.Xml.XmlElement.NodeType">
- <summary>Gets the type of the current node.</summary>
- <returns>The node type. For <see langword="XmlElement" /> nodes, this value is XmlNodeType.Element.</returns>
- </member>
- <member name="P:System.Xml.XmlElement.OwnerDocument">
- <summary>Gets the <see cref="T:System.Xml.XmlDocument" /> to which this node belongs.</summary>
- <returns>The <see langword="XmlDocument" /> to which this element belongs.</returns>
- </member>
- <member name="P:System.Xml.XmlElement.ParentNode">
- <summary>Gets the parent of this node (for nodes that can have parents).</summary>
- <returns>The <see langword="XmlNode" /> that is the parent of the current node. If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is <see langword="null" />. For all other nodes, the value returned depends on the <see cref="P:System.Xml.XmlNode.NodeType" /> of the node. The following table describes the possible return values for the <see langword="ParentNode" /> property.</returns>
- </member>
- <member name="P:System.Xml.XmlElement.Prefix">
- <summary>Gets or sets the namespace prefix of this node.</summary>
- <exception cref="T:System.ArgumentException">This node is read-only.</exception>
- <exception cref="T:System.Xml.XmlException">The specified prefix contains an invalid character.
-
- The specified prefix is malformed.
-
- The namespaceURI of this node is <see langword="null" />.
-
- The specified prefix is "xml" and the namespaceURI of this node is different from http://www.w3.org/XML/1998/namespace.</exception>
- <returns>The namespace prefix of this node. If there is no prefix, this property returns String.Empty.</returns>
- </member>
- <member name="P:System.Xml.XmlElement.SchemaInfo">
- <summary>Gets the post schema validation infoset that has been assigned to this node as a result of schema validation.</summary>
- <returns>An <see cref="T:System.Xml.Schema.IXmlSchemaInfo" /> object containing the post schema validation infoset of this node.</returns>
- </member>
<member name="T:System.Xml.XmlEntity">
<summary>Represents an entity declaration, such as <!ENTITY... >.</summary>
</member>
+ <member name="P:System.Xml.XmlEntity.BaseURI">
+ <summary>Gets the base Uniform Resource Identifier (URI) of the current node.</summary>
+ <returns>The location from which the node was loaded.</returns>
+ </member>
<member name="M:System.Xml.XmlEntity.CloneNode(System.Boolean)">
<summary>Creates a duplicate of this node. Entity nodes cannot be cloned. Calling this method on an <see cref="T:System.Xml.XmlEntity" /> object throws an exception.</summary>
<param name="deep">
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself.</param>
- <exception cref="T:System.InvalidOperationException">Entity nodes cannot be cloned. Calling this method on an <see cref="T:System.Xml.XmlEntity" /> object throws an exception.</exception>
<returns>A copy of the <see cref="T:System.Xml.XmlNode" /> from which the method is called.</returns>
- </member>
- <member name="M:System.Xml.XmlEntity.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. For <see langword="XmlEntity" /> nodes, this method has no effect.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlEntity.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />. For <see langword="XmlEntity" /> nodes, this method has no effect.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="P:System.Xml.XmlEntity.BaseURI">
- <summary>Gets the base Uniform Resource Identifier (URI) of the current node.</summary>
- <returns>The location from which the node was loaded.</returns>
+ <exception cref="T:System.InvalidOperationException">Entity nodes cannot be cloned. Calling this method on an <see cref="T:System.Xml.XmlEntity" /> object throws an exception.</exception>
</member>
<member name="P:System.Xml.XmlEntity.InnerText">
<summary>Gets the concatenated values of the entity node and all its children.</summary>
- <exception cref="T:System.InvalidOperationException">Attempting to set the property.</exception>
<returns>The concatenated values of the node and all its children.</returns>
+ <exception cref="T:System.InvalidOperationException">Attempting to set the property.</exception>
</member>
<member name="P:System.Xml.XmlEntity.InnerXml">
<summary>Gets the markup representing the children of this node.</summary>
- <exception cref="T:System.InvalidOperationException">Attempting to set the property.</exception>
<returns>For <see langword="XmlEntity" /> nodes, String.Empty is returned.</returns>
+ <exception cref="T:System.InvalidOperationException">Attempting to set the property.</exception>
</member>
<member name="P:System.Xml.XmlEntity.IsReadOnly">
<summary>Gets a value indicating whether the node is read-only.</summary>
<returns>
- <see langword="true" /> if the node is read-only; otherwise, <see langword="false" />.
-
- Because <see langword="XmlEntity" /> nodes are read-only, this property always returns <see langword="true" />.</returns>
+ <see langword="true" /> if the node is read-only; otherwise, <see langword="false" />.
+Because <see langword="XmlEntity" /> nodes are read-only, this property always returns <see langword="true" />.</returns>
</member>
<member name="P:System.Xml.XmlEntity.LocalName">
<summary>Gets the name of the node without the namespace prefix.</summary>
<summary>Gets the value of the system identifier on the entity declaration.</summary>
<returns>The system identifier on the entity. If there is no system identifier, <see langword="null" /> is returned.</returns>
</member>
+ <member name="M:System.Xml.XmlEntity.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. For <see langword="XmlEntity" /> nodes, this method has no effect.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="M:System.Xml.XmlEntity.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />. For <see langword="XmlEntity" /> nodes, this method has no effect.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
<member name="T:System.Xml.XmlEntityReference">
<summary>Represents an entity reference node.</summary>
</member>
<param name="name">The name of the entity reference; see the <see cref="P:System.Xml.XmlEntityReference.Name" /> property.</param>
<param name="doc">The parent XML document.</param>
</member>
+ <member name="P:System.Xml.XmlEntityReference.BaseURI">
+ <summary>Gets the base Uniform Resource Identifier (URI) of the current node.</summary>
+ <returns>The location from which the node was loaded.</returns>
+ </member>
<member name="M:System.Xml.XmlEntityReference.CloneNode(System.Boolean)">
<summary>Creates a duplicate of this node.</summary>
<param name="deep">
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself. For <see langword="XmlEntityReference" /> nodes, this method always returns an entity reference node with no children. The replacement text is set when the node is inserted into a parent.</param>
<returns>The cloned node.</returns>
</member>
- <member name="M:System.Xml.XmlEntityReference.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlEntityReference.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="P:System.Xml.XmlEntityReference.BaseURI">
- <summary>Gets the base Uniform Resource Identifier (URI) of the current node.</summary>
- <returns>The location from which the node was loaded.</returns>
- </member>
<member name="P:System.Xml.XmlEntityReference.IsReadOnly">
<summary>Gets a value indicating whether the node is read-only.</summary>
<returns>
- <see langword="true" /> if the node is read-only; otherwise <see langword="false" />.
-
- Because <see langword="XmlEntityReference" /> nodes are read-only, this property always returns <see langword="true" />.</returns>
+ <see langword="true" /> if the node is read-only; otherwise <see langword="false" />.
+Because <see langword="XmlEntityReference" /> nodes are read-only, this property always returns <see langword="true" />.</returns>
</member>
<member name="P:System.Xml.XmlEntityReference.LocalName">
<summary>Gets the local name of the node.</summary>
</member>
<member name="P:System.Xml.XmlEntityReference.Value">
<summary>Gets or sets the value of the node.</summary>
+ <returns>The value of the node. For <see langword="XmlEntityReference" /> nodes, this property returns <see langword="null" />.</returns>
<exception cref="T:System.ArgumentException">Node is read-only.</exception>
<exception cref="T:System.InvalidOperationException">Setting the property.</exception>
- <returns>The value of the node. For <see langword="XmlEntityReference" /> nodes, this property returns <see langword="null" />.</returns>
+ </member>
+ <member name="M:System.Xml.XmlEntityReference.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="M:System.Xml.XmlEntityReference.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
</member>
<member name="T:System.Xml.XmlException">
<summary>Returns detailed information about the last exception.</summary>
<param name="context">The <see langword="StreamingContext" /> object.</param>
</member>
<member name="P:System.Xml.XmlException.LineNumber">
- <summary>Gets the line number indicating where the error occurred. Line numbers start at 1.</summary>
+ <summary>Gets the line number indicating where the error occurred.</summary>
<returns>The line number indicating where the error occurred.</returns>
</member>
<member name="P:System.Xml.XmlException.LinePosition">
- <summary>Gets the line position indicating where the error occurred. Line position starts at 1.</summary>
+ <summary>Gets the line position indicating where the error occurred.</summary>
<returns>The line position indicating where the error occurred.</returns>
</member>
<member name="P:System.Xml.XmlException.Message">
<param name="strFeature">The package name of the feature to test. This name is not case-sensitive.</param>
<param name="strVersion">This is the version number of the package name to test. If the version is not specified (<see langword="null" />), supporting any version of the feature causes the method to return <see langword="true" />.</param>
<returns>
- <see langword="true" /> if the feature is implemented in the specified version; otherwise, <see langword="false" />.
-
- The following table shows the combinations that cause <see langword="HasFeature" /> to return <see langword="true" />.
-
- <list type="table"><listheader><term> strFeature</term><description> strVersion</description></listheader><item><term> XML</term><description> 1.0</description></item><item><term> XML</term><description> 2.0</description></item></list></returns>
+ <see langword="true" /> if the feature is implemented in the specified version; otherwise, <see langword="false" />.
+The following table shows the combinations that cause <see langword="HasFeature" /> to return <see langword="true" />.
+ strFeature
+
+ strVersion
+
+ XML
+
+ 1.0
+
+ XML
+
+ 2.0</returns>
</member>
<member name="T:System.Xml.XmlLinkedNode">
<summary>Gets the node immediately preceding or following this node.</summary>
<member name="T:System.Xml.XmlNamedNodeMap">
<summary>Represents a collection of nodes that can be accessed by name or index.</summary>
</member>
+ <member name="P:System.Xml.XmlNamedNodeMap.Count">
+ <summary>Gets the number of nodes in the <see langword="XmlNamedNodeMap" />.</summary>
+ <returns>The number of nodes.</returns>
+ </member>
<member name="M:System.Xml.XmlNamedNodeMap.GetEnumerator">
<summary>Provides support for the "foreach" style iteration over the collection of nodes in the <see langword="XmlNamedNodeMap" />.</summary>
<returns>An enumerator object.</returns>
<member name="M:System.Xml.XmlNamedNodeMap.SetNamedItem(System.Xml.XmlNode)">
<summary>Adds an <see cref="T:System.Xml.XmlNode" /> using its <see cref="P:System.Xml.XmlNode.Name" /> property.</summary>
<param name="node">An <see langword="XmlNode" /> to store in the <see langword="XmlNamedNodeMap" />. If a node with that name is already present in the map, it is replaced by the new one.</param>
- <exception cref="T:System.ArgumentException">The <paramref name="node" /> was created from a different <see cref="T:System.Xml.XmlDocument" /> than the one that created the <see langword="XmlNamedNodeMap" />; or the <see langword="XmlNamedNodeMap" /> is read-only.</exception>
<returns>If the <paramref name="node" /> replaces an existing node with the same name, the old node is returned; otherwise, <see langword="null" /> is returned.</returns>
- </member>
- <member name="P:System.Xml.XmlNamedNodeMap.Count">
- <summary>Gets the number of nodes in the <see langword="XmlNamedNodeMap" />.</summary>
- <returns>The number of nodes.</returns>
+ <exception cref="T:System.ArgumentException">The <paramref name="node" /> was created from a different <see cref="T:System.Xml.XmlDocument" /> than the one that created the <see langword="XmlNamedNodeMap" />; or the <see langword="XmlNamedNodeMap" /> is read-only.</exception>
</member>
<member name="T:System.Xml.XmlNamespaceManager">
<summary>Resolves, adds, and removes namespaces to a collection and provides scope management for these namespaces.</summary>
<summary>Initializes a new instance of the <see cref="T:System.Xml.XmlNamespaceManager" /> class with the specified <see cref="T:System.Xml.XmlNameTable" />.</summary>
<param name="nameTable">The <see cref="T:System.Xml.XmlNameTable" /> to use.</param>
<exception cref="T:System.NullReferenceException">
- <see langword="null" /> is passed to the constructor.</exception>
+ <see langword="null" /> is passed to the constructor</exception>
</member>
<member name="M:System.Xml.XmlNamespaceManager.AddNamespace(System.String,System.String)">
<summary>Adds the given namespace to the collection.</summary>
- <param name="prefix">The prefix to associate with the namespace being added. Use String.Empty to add a default namespace.
-
- Note If the <see cref="T:System.Xml.XmlNamespaceManager" /> will be used for resolving namespaces in an XML Path Language (XPath) expression, a prefix must be specified. If an XPath expression does not include a prefix, it is assumed that the namespace Uniform Resource Identifier (URI) is the empty namespace. For more information about XPath expressions and the <see cref="T:System.Xml.XmlNamespaceManager" />, refer to the <see cref="M:System.Xml.XmlNode.SelectNodes(System.String)" /> and <see cref="M:System.Xml.XPath.XPathExpression.SetContext(System.Xml.XmlNamespaceManager)" /> methods.</param>
+ <param name="prefix">The prefix to associate with the namespace being added. Use String.Empty to add a default namespace.
+NoteIf the <see cref="T:System.Xml.XmlNamespaceManager" /> will be used for resolving namespaces in an XML Path Language (XPath) expression, a prefix must be specified. If an XPath expression does not include a prefix, it is assumed that the namespace Uniform Resource Identifier (URI) is the empty namespace. For more information about XPath expressions and the <see cref="T:System.Xml.XmlNamespaceManager" />, refer to the <see cref="M:System.Xml.XmlNode.SelectNodes(System.String)" /> and <see cref="M:System.Xml.XPath.XPathExpression.SetContext(System.Xml.XmlNamespaceManager)" /> methods.</param>
<param name="uri">The namespace to add.</param>
<exception cref="T:System.ArgumentException">The value for <paramref name="prefix" /> is "xml" or "xmlns".</exception>
<exception cref="T:System.ArgumentNullException">The value for <paramref name="prefix" /> or <paramref name="uri" /> is <see langword="null" />.</exception>
</member>
+ <member name="P:System.Xml.XmlNamespaceManager.DefaultNamespace">
+ <summary>Gets the namespace URI for the default namespace.</summary>
+ <returns>The namespace URI for the default namespace, or an empty string if there is no default namespace.</returns>
+ </member>
<member name="M:System.Xml.XmlNamespaceManager.GetEnumerator">
<summary>Returns an enumerator to use to iterate through the namespaces in the <see cref="T:System.Xml.XmlNamespaceManager" />.</summary>
<returns>An <see cref="T:System.Collections.IEnumerator" /> containing the prefixes stored by the <see cref="T:System.Xml.XmlNamespaceManager" />.</returns>
<member name="M:System.Xml.XmlNamespaceManager.LookupNamespace(System.String)">
<summary>Gets the namespace URI for the specified prefix.</summary>
<param name="prefix">The prefix whose namespace URI you want to resolve. To match the default namespace, pass String.Empty.</param>
- <returns>The namespace URI for <paramref name="prefix" /> or <see langword="null" /> if there is no mapped namespace. The returned string is atomized.
-
- For more information on atomized strings, see the <see cref="T:System.Xml.XmlNameTable" /> class.</returns>
+ <returns>The namespace URI for <paramref name="prefix" /> or <see langword="null" /> if there is no mapped namespace. The returned string is atomized.
+For more information on atomized strings, see the <see cref="T:System.Xml.XmlNameTable" /> class.</returns>
</member>
<member name="M:System.Xml.XmlNamespaceManager.LookupPrefix(System.String)">
<summary>Finds the prefix declared for the given namespace URI.</summary>
<param name="uri">The namespace to resolve for the prefix.</param>
<returns>The matching prefix. If there is no mapped prefix, the method returns String.Empty. If a null value is supplied, then <see langword="null" /> is returned.</returns>
</member>
+ <member name="P:System.Xml.XmlNamespaceManager.NameTable">
+ <summary>Gets the <see cref="T:System.Xml.XmlNameTable" /> associated with this object.</summary>
+ <returns>The <see cref="T:System.Xml.XmlNameTable" /> used by this object.</returns>
+ </member>
<member name="M:System.Xml.XmlNamespaceManager.PopScope">
<summary>Pops a namespace scope off the stack.</summary>
<returns>
</member>
<member name="M:System.Xml.XmlNamespaceManager.RemoveNamespace(System.String,System.String)">
<summary>Removes the given namespace for the given prefix.</summary>
- <param name="prefix">The prefix for the namespace.</param>
+ <param name="prefix">The prefix for the namespace</param>
<param name="uri">The namespace to remove for the given prefix. The namespace removed is from the current namespace scope. Namespaces outside the current scope are ignored.</param>
<exception cref="T:System.ArgumentNullException">The value of <paramref name="prefix" /> or <paramref name="uri" /> is <see langword="null" />.</exception>
</member>
- <member name="P:System.Xml.XmlNamespaceManager.DefaultNamespace">
- <summary>Gets the namespace URI for the default namespace.</summary>
- <returns>The namespace URI for the default namespace, or an empty string if there is no default namespace.</returns>
- </member>
- <member name="P:System.Xml.XmlNamespaceManager.NameTable">
- <summary>Gets the <see cref="T:System.Xml.XmlNameTable" /> associated with this object.</summary>
- <returns>The <see cref="T:System.Xml.XmlNameTable" /> used by this object.</returns>
- </member>
<member name="T:System.Xml.XmlNamespaceScope">
<summary>Defines the namespace scope.</summary>
</member>
<param name="array">The character array containing the name to add.</param>
<param name="offset">Zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
- <exception cref="T:System.IndexOutOfRangeException">0 > <paramref name="offset" />
-
- -or-
-
- <paramref name="offset" /> >= <paramref name="array" />.Length
-
- -or-
-
- <paramref name="length" /> > <paramref name="array" />.Length
-
- The above conditions do not cause an exception to be thrown if <paramref name="length" /> =0.</exception>
+ <returns>The new atomized string or the existing one if it already exists. If length is zero, String.Empty is returned.</returns>
+ <exception cref="T:System.IndexOutOfRangeException">0 > <paramref name="offset" />
+-or-
+<paramref name="offset" /> >= <paramref name="array" />.Length
+-or-
+<paramref name="length" /> > <paramref name="array" />.Length
+The above conditions do not cause an exception to be thrown if <paramref name="length" /> =0.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="length" /> < 0.</exception>
- <returns>The new atomized string or the existing one if it already exists. If length is zero, String.Empty is returned.</returns>
</member>
<member name="M:System.Xml.XmlNameTable.Add(System.String)">
<summary>When overridden in a derived class, atomizes the specified string and adds it to the <see langword="XmlNameTable" />.</summary>
<param name="array">The name to add.</param>
+ <returns>The new atomized string or the existing one if it already exists.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="array" /> is <see langword="null" />.</exception>
- <returns>The new atomized string or the existing one if it already exists.</returns>
</member>
<member name="M:System.Xml.XmlNameTable.Get(System.Char[],System.Int32,System.Int32)">
<summary>When overridden in a derived class, gets the atomized string containing the same characters as the specified range of characters in the given array.</summary>
<param name="array">The character array containing the name to look up.</param>
<param name="offset">The zero-based index into the array specifying the first character of the name.</param>
<param name="length">The number of characters in the name.</param>
- <exception cref="T:System.IndexOutOfRangeException">0 > <paramref name="offset" />
-
- -or-
-
- <paramref name="offset" /> >= <paramref name="array" />.Length
-
- -or-
-
- <paramref name="length" /> > <paramref name="array" />.Length
-
- The above conditions do not cause an exception to be thrown if <paramref name="length" /> =0.</exception>
+ <returns>The atomized string or <see langword="null" /> if the string has not already been atomized. If <paramref name="length" /> is zero, String.Empty is returned.</returns>
+ <exception cref="T:System.IndexOutOfRangeException">0 > <paramref name="offset" />
+-or-
+<paramref name="offset" /> >= <paramref name="array" />.Length
+-or-
+<paramref name="length" /> > <paramref name="array" />.Length
+The above conditions do not cause an exception to be thrown if <paramref name="length" /> =0.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="length" /> < 0.</exception>
- <returns>The atomized string or <see langword="null" /> if the string has not already been atomized. If <paramref name="length" /> is zero, String.Empty is returned.</returns>
</member>
<member name="M:System.Xml.XmlNameTable.Get(System.String)">
<summary>When overridden in a derived class, gets the atomized string containing the same value as the specified string.</summary>
<param name="array">The name to look up.</param>
+ <returns>The atomized string or <see langword="null" /> if the string has not already been atomized.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="array" /> is <see langword="null" />.</exception>
- <returns>The atomized string or <see langword="null" /> if the string has not already been atomized.</returns>
</member>
<member name="T:System.Xml.XmlNode">
<summary>Represents a single node in the XML document.</summary>
<member name="M:System.Xml.XmlNode.AppendChild(System.Xml.XmlNode)">
<summary>Adds the specified node to the end of the list of child nodes, of this node.</summary>
<param name="newChild">The node to add. All the contents of the node to be added are moved into the specified location.</param>
- <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
-
- The <paramref name="newChild" /> is an ancestor of this node.</exception>
- <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
-
- This node is read-only.</exception>
<returns>The node added.</returns>
+ <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
+The <paramref name="newChild" /> is an ancestor of this node.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
+This node is read-only.</exception>
+ </member>
+ <member name="P:System.Xml.XmlNode.Attributes">
+ <summary>Gets an <see cref="T:System.Xml.XmlAttributeCollection" /> containing the attributes of this node.</summary>
+ <returns>An <see langword="XmlAttributeCollection" /> containing the attributes of the node.
+If the node is of type XmlNodeType.Element, the attributes of the node are returned. Otherwise, this property returns <see langword="null" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.BaseURI">
+ <summary>Gets the base URI of the current node.</summary>
+ <returns>The location from which the node was loaded or String.Empty if the node has no base URI.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.ChildNodes">
+ <summary>Gets all the child nodes of the node.</summary>
+ <returns>An object that contains all the child nodes of the node.
+If there are no child nodes, this property returns an empty <see cref="T:System.Xml.XmlNodeList" />.</returns>
+ </member>
+ <member name="M:System.Xml.XmlNode.Clone">
+ <summary>Creates a duplicate of this node.</summary>
+ <returns>The cloned node.</returns>
</member>
- <member name="M:System.Xml.XmlNode.Clone">
- <summary>Creates a duplicate of this node.</summary>
- <returns>The cloned node.</returns>
- </member>
<member name="M:System.Xml.XmlNode.CloneNode(System.Boolean)">
<summary>Creates a duplicate of the node, when overridden in a derived class.</summary>
<param name="deep">
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself.</param>
- <exception cref="T:System.InvalidOperationException">Calling this method on a node type that cannot be cloned.</exception>
<returns>The cloned node.</returns>
+ <exception cref="T:System.InvalidOperationException">Calling this method on a node type that cannot be cloned.</exception>
</member>
<member name="M:System.Xml.XmlNode.CreateNavigator">
<summary>Creates an <see cref="T:System.Xml.XPath.XPathNavigator" /> for navigating this object.</summary>
<returns>An <see langword="XPathNavigator" /> object used to navigate the node. The <see langword="XPathNavigator" /> is positioned on the node from which the method was called. It is not positioned on the root of the document.</returns>
</member>
+ <member name="P:System.Xml.XmlNode.FirstChild">
+ <summary>Gets the first child of the node.</summary>
+ <returns>The first child of the node. If there is no such node, <see langword="null" /> is returned.</returns>
+ </member>
<member name="M:System.Xml.XmlNode.GetEnumerator">
<summary>Gets an enumerator that iterates through the child nodes in the current node.</summary>
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the child nodes in the current node.</returns>
<param name="namespaceURI">The namespace URI whose prefix you want to find.</param>
<returns>The prefix for the specified namespace URI.</returns>
</member>
+ <member name="P:System.Xml.XmlNode.HasChildNodes">
+ <summary>Gets a value indicating whether this node has any child nodes.</summary>
+ <returns>
+ <see langword="true" /> if the node has child nodes; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.InnerText">
+ <summary>Gets or sets the concatenated values of the node and all its child nodes.</summary>
+ <returns>The concatenated values of the node and all its child nodes.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.InnerXml">
+ <summary>Gets or sets the markup representing only the child nodes of this node.</summary>
+ <returns>The markup of the child nodes of this node.
+<see langword="InnerXml" /> does not return default attributes.</returns>
+ <exception cref="T:System.InvalidOperationException">Setting this property on a node that cannot have child nodes.</exception>
+ <exception cref="T:System.Xml.XmlException">The XML specified when setting this property is not well-formed.</exception>
+ </member>
<member name="M:System.Xml.XmlNode.InsertAfter(System.Xml.XmlNode,System.Xml.XmlNode)">
<summary>Inserts the specified node immediately after the specified reference node.</summary>
<param name="newChild">The node to insert.</param>
<param name="refChild">The reference node. <paramref name="newChild" /> is placed after <paramref name="refChild" />.</param>
- <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
-
- The <paramref name="newChild" /> is an ancestor of this node.</exception>
- <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
-
- The <paramref name="refChild" /> is not a child of this node.
-
- This node is read-only.</exception>
<returns>The node being inserted.</returns>
+ <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
+The <paramref name="newChild" /> is an ancestor of this node.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
+The <paramref name="refChild" /> is not a child of this node.
+This node is read-only.</exception>
</member>
<member name="M:System.Xml.XmlNode.InsertBefore(System.Xml.XmlNode,System.Xml.XmlNode)">
<summary>Inserts the specified node immediately before the specified reference node.</summary>
<param name="newChild">The node to insert.</param>
<param name="refChild">The reference node. <paramref name="newChild" /> is placed before this node.</param>
- <exception cref="T:System.InvalidOperationException">The current node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
+ <returns>The node being inserted.</returns>
+ <exception cref="T:System.InvalidOperationException">The current node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
+The <paramref name="newChild" /> is an ancestor of this node.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
+The <paramref name="refChild" /> is not a child of this node.
+This node is read-only.</exception>
+ </member>
+ <member name="P:System.Xml.XmlNode.IsReadOnly">
+ <summary>Gets a value indicating whether the node is read-only.</summary>
+ <returns>
+ <see langword="true" /> if the node is read-only; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.Item(System.String)">
+ <summary>Gets the first child element with the specified <see cref="P:System.Xml.XmlNode.Name" />.</summary>
+ <param name="name">The qualified name of the element to retrieve.</param>
+ <returns>The first <see cref="T:System.Xml.XmlElement" /> that matches the specified name. It returns a null reference (<see langword="Nothing" /> in Visual Basic) if there is no match.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.Item(System.String,System.String)">
+ <summary>Gets the first child element with the specified <see cref="P:System.Xml.XmlNode.LocalName" /> and <see cref="P:System.Xml.XmlNode.NamespaceURI" />.</summary>
+ <param name="localname">The local name of the element.</param>
+ <param name="ns">The namespace URI of the element.</param>
+ <returns>The first <see cref="T:System.Xml.XmlElement" /> with the matching <paramref name="localname" /> and <paramref name="ns" />. . It returns a null reference (<see langword="Nothing" /> in Visual Basic) if there is no match.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.LastChild">
+ <summary>Gets the last child of the node.</summary>
+ <returns>The last child of the node. If there is no such node, <see langword="null" /> is returned.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.LocalName">
+ <summary>Gets the local name of the node, when overridden in a derived class.</summary>
+ <returns>The name of the node with the prefix removed. For example, <see langword="LocalName" /> is book for the element <bk:book>.
+The name returned is dependent on the <see cref="P:System.Xml.XmlNode.NodeType" /> of the node:
+ Type
- The <paramref name="newChild" /> is an ancestor of this node.</exception>
- <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
+ Name
- The <paramref name="refChild" /> is not a child of this node.
+ Attribute
- This node is read-only.</exception>
- <returns>The node being inserted.</returns>
+ The local name of the attribute.
+
+ CDATA
+
+ #cdata-section
+
+ Comment
+
+ #comment
+
+ Document
+
+ #document
+
+ DocumentFragment
+
+ #document-fragment
+
+ DocumentType
+
+ The document type name.
+
+ Element
+
+ The local name of the element.
+
+ Entity
+
+ The name of the entity.
+
+ EntityReference
+
+ The name of the entity referenced.
+
+ Notation
+
+ The notation name.
+
+ ProcessingInstruction
+
+ The target of the processing instruction.
+
+ Text
+
+ #text
+
+ Whitespace
+
+ #whitespace
+
+ SignificantWhitespace
+
+ #significant-whitespace
+
+ XmlDeclaration
+
+ #xml-declaration</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.Name">
+ <summary>Gets the qualified name of the node, when overridden in a derived class.</summary>
+ <returns>The qualified name of the node. The name returned is dependent on the <see cref="P:System.Xml.XmlNode.NodeType" /> of the node:
+ Type
+
+ Name
+
+ Attribute
+
+ The qualified name of the attribute.
+
+ CDATA
+
+ #cdata-section
+
+ Comment
+
+ #comment
+
+ Document
+
+ #document
+
+ DocumentFragment
+
+ #document-fragment
+
+ DocumentType
+
+ The document type name.
+
+ Element
+
+ The qualified name of the element.
+
+ Entity
+
+ The name of the entity.
+
+ EntityReference
+
+ The name of the entity referenced.
+
+ Notation
+
+ The notation name.
+
+ ProcessingInstruction
+
+ The target of the processing instruction.
+
+ Text
+
+ #text
+
+ Whitespace
+
+ #whitespace
+
+ SignificantWhitespace
+
+ #significant-whitespace
+
+ XmlDeclaration
+
+ #xml-declaration</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.NamespaceURI">
+ <summary>Gets the namespace URI of this node.</summary>
+ <returns>The namespace URI of this node. If there is no namespace URI, this property returns String.Empty.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.NextSibling">
+ <summary>Gets the node immediately following this node.</summary>
+ <returns>The next <see langword="XmlNode" />. If there is no next node, <see langword="null" /> is returned.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.NodeType">
+ <summary>Gets the type of the current node, when overridden in a derived class.</summary>
+ <returns>One of the <see cref="T:System.Xml.XmlNodeType" /> values.</returns>
</member>
<member name="M:System.Xml.XmlNode.Normalize">
<summary>Puts all XmlText nodes in the full depth of the sub-tree underneath this XmlNode into a "normal" form where only markup (that is, tags, comments, processing instructions, CDATA sections, and entity references) separates XmlText nodes, that is, there are no adjacent XmlText nodes.</summary>
</member>
+ <member name="P:System.Xml.XmlNode.OuterXml">
+ <summary>Gets the markup containing this node and all its child nodes.</summary>
+ <returns>The markup containing this node and all its child nodes.
+<see langword="OuterXml" /> does not return default attributes.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.OwnerDocument">
+ <summary>Gets the <see cref="T:System.Xml.XmlDocument" /> to which this node belongs.</summary>
+ <returns>The <see cref="T:System.Xml.XmlDocument" /> to which this node belongs.
+If the node is an <see cref="T:System.Xml.XmlDocument" /> (NodeType equals XmlNodeType.Document), this property returns <see langword="null" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.ParentNode">
+ <summary>Gets the parent of this node (for nodes that can have parents).</summary>
+ <returns>The <see langword="XmlNode" /> that is the parent of the current node. If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is <see langword="null" />. For all other nodes, the value returned depends on the <see cref="P:System.Xml.XmlNode.NodeType" /> of the node. The following table describes the possible return values for the <see langword="ParentNode" /> property.
+ NodeType
+
+ Return Value of ParentNode
+
+ Attribute, Document, DocumentFragment, Entity, Notation
+
+ Returns <see langword="null" />; these nodes do not have parents.
+
+ CDATA
+
+ Returns the element or entity reference containing the CDATA section.
+
+ Comment
+
+ Returns the element, entity reference, document type, or document containing the comment.
+
+ DocumentType
+
+ Returns the document node.
+
+ Element
+
+ Returns the parent node of the element. If the element is the root node in the tree, the parent is the document node.
+
+ EntityReference
+
+ Returns the element, attribute, or entity reference containing the entity reference.
+
+ ProcessingInstruction
+
+ Returns the document, element, document type, or entity reference containing the processing instruction.
+
+ Text
+
+ Returns the parent element, attribute, or entity reference containing the text node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.Prefix">
+ <summary>Gets or sets the namespace prefix of this node.</summary>
+ <returns>The namespace prefix of this node. For example, <see langword="Prefix" /> is bk for the element <bk:book>. If there is no prefix, this property returns String.Empty.</returns>
+ <exception cref="T:System.ArgumentException">This node is read-only.</exception>
+ <exception cref="T:System.Xml.XmlException">The specified prefix contains an invalid character.
+The specified prefix is malformed.
+The specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace".
+This node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/ ".
+This node is an attribute and the qualifiedName of this node is "xmlns".</exception>
+ </member>
<member name="M:System.Xml.XmlNode.PrependChild(System.Xml.XmlNode)">
<summary>Adds the specified node to the beginning of the list of child nodes for this node.</summary>
<param name="newChild">The node to add. All the contents of the node to be added are moved into the specified location.</param>
- <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
-
- The <paramref name="newChild" /> is an ancestor of this node.</exception>
- <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
-
- This node is read-only.</exception>
<returns>The node added.</returns>
+ <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
+The <paramref name="newChild" /> is an ancestor of this node.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
+This node is read-only.</exception>
+ </member>
+ <member name="P:System.Xml.XmlNode.PreviousSibling">
+ <summary>Gets the node immediately preceding this node.</summary>
+ <returns>The preceding <see langword="XmlNode" />. If there is no preceding node, <see langword="null" /> is returned.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNode.PreviousText">
+ <summary>Gets the text node that immediately precedes this node.</summary>
+ <returns>Returns <see cref="T:System.Xml.XmlNode" />.</returns>
</member>
<member name="M:System.Xml.XmlNode.RemoveAll">
<summary>Removes all the child nodes and/or attributes of the current node.</summary>
<member name="M:System.Xml.XmlNode.RemoveChild(System.Xml.XmlNode)">
<summary>Removes specified child node.</summary>
<param name="oldChild">The node being removed.</param>
- <exception cref="T:System.ArgumentException">The <paramref name="oldChild" /> is not a child of this node. Or this node is read-only.</exception>
<returns>The node removed.</returns>
+ <exception cref="T:System.ArgumentException">The <paramref name="oldChild" /> is not a child of this node. Or this node is read-only.</exception>
</member>
<member name="M:System.Xml.XmlNode.ReplaceChild(System.Xml.XmlNode,System.Xml.XmlNode)">
<summary>Replaces the child node <paramref name="oldChild" /> with <paramref name="newChild" /> node.</summary>
<param name="newChild">The new node to put in the child list.</param>
<param name="oldChild">The node being replaced in the list.</param>
- <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
-
- The <paramref name="newChild" /> is an ancestor of this node.</exception>
- <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
-
- This node is read-only.
-
- The <paramref name="oldChild" /> is not a child of this node.</exception>
<returns>The node replaced.</returns>
+ <exception cref="T:System.InvalidOperationException">This node is of a type that does not allow child nodes of the type of the <paramref name="newChild" /> node.
+The <paramref name="newChild" /> is an ancestor of this node.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="newChild" /> was created from a different document than the one that created this node.
+This node is read-only.
+The <paramref name="oldChild" /> is not a child of this node.</exception>
+ </member>
+ <member name="P:System.Xml.XmlNode.SchemaInfo">
+ <summary>Gets the post schema validation infoset that has been assigned to this node as a result of schema validation.</summary>
+ <returns>An <see cref="T:System.Xml.Schema.IXmlSchemaInfo" /> object containing the post schema validation infoset of this node.</returns>
</member>
<member name="M:System.Xml.XmlNode.SelectNodes(System.String)">
<summary>Selects a list of nodes matching the XPath expression.</summary>
<param name="xpath">The XPath expression.</param>
- <exception cref="T:System.Xml.XPath.XPathException">The XPath expression contains a prefix. See XPath Examples.</exception>
<returns>An <see cref="T:System.Xml.XmlNodeList" /> containing a collection of nodes matching the XPath query.</returns>
+ <exception cref="T:System.Xml.XPath.XPathException">The XPath expression contains a prefix. See XPath Examples.</exception>
</member>
<member name="M:System.Xml.XmlNode.SelectNodes(System.String,System.Xml.XmlNamespaceManager)">
<summary>Selects a list of nodes matching the XPath expression. Any prefixes found in the XPath expression are resolved using the supplied <see cref="T:System.Xml.XmlNamespaceManager" />.</summary>
<param name="xpath">The XPath expression. See XPath Examples.</param>
<param name="nsmgr">An <see cref="T:System.Xml.XmlNamespaceManager" /> to use for resolving namespaces for prefixes in the XPath expression.</param>
- <exception cref="T:System.Xml.XPath.XPathException">The XPath expression contains a prefix which is not defined in the <see langword="XmlNamespaceManager" />.</exception>
<returns>An <see cref="T:System.Xml.XmlNodeList" /> containing a collection of nodes matching the XPath query.</returns>
+ <exception cref="T:System.Xml.XPath.XPathException">The XPath expression contains a prefix which is not defined in the <see langword="XmlNamespaceManager" />.</exception>
</member>
<member name="M:System.Xml.XmlNode.SelectSingleNode(System.String)">
<summary>Selects the first <see langword="XmlNode" /> that matches the XPath expression.</summary>
<param name="xpath">The XPath expression. See XPath Examples.</param>
- <exception cref="T:System.Xml.XPath.XPathException">The XPath expression contains a prefix.</exception>
<returns>The first <see langword="XmlNode" /> that matches the XPath query or <see langword="null" /> if no matching node is found.</returns>
+ <exception cref="T:System.Xml.XPath.XPathException">The XPath expression contains a prefix.</exception>
</member>
<member name="M:System.Xml.XmlNode.SelectSingleNode(System.String,System.Xml.XmlNamespaceManager)">
<summary>Selects the first <see langword="XmlNode" /> that matches the XPath expression. Any prefixes found in the XPath expression are resolved using the supplied <see cref="T:System.Xml.XmlNamespaceManager" />.</summary>
<param name="xpath">The XPath expression. See XPath Examples.</param>
<param name="nsmgr">An <see cref="T:System.Xml.XmlNamespaceManager" /> to use for resolving namespaces for prefixes in the XPath expression.</param>
- <exception cref="T:System.Xml.XPath.XPathException">The XPath expression contains a prefix which is not defined in the <see langword="XmlNamespaceManager" />.</exception>
<returns>The first <see langword="XmlNode" /> that matches the XPath query or <see langword="null" /> if no matching node is found.</returns>
+ <exception cref="T:System.Xml.XPath.XPathException">The XPath expression contains a prefix which is not defined in the <see langword="XmlNamespaceManager" />.</exception>
</member>
<member name="M:System.Xml.XmlNode.Supports(System.String,System.String)">
<summary>Tests if the DOM implementation implements a specific feature.</summary>
<param name="feature">The package name of the feature to test. This name is not case-sensitive.</param>
<param name="version">The version number of the package name to test. If the version is not specified (null), supporting any version of the feature causes the method to return true.</param>
<returns>
- <see langword="true" /> if the feature is implemented in the specified version; otherwise, <see langword="false" />. The following table describes the combinations that return <see langword="true" />.
-
- <list type="table"><listheader><term> Feature</term><description> Version</description></listheader><item><term> XML</term><description> 1.0</description></item><item><term> XML</term><description> 2.0</description></item></list></returns>
+ <see langword="true" /> if the feature is implemented in the specified version; otherwise, <see langword="false" />. The following table describes the combinations that return <see langword="true" />.
+ Feature
+
+ Version
+
+ XML
+
+ 1.0
+
+ XML
+
+ 2.0</returns>
</member>
<member name="M:System.Xml.XmlNode.System#Collections#IEnumerable#GetEnumerator">
<summary>For a description of this member, see <see cref="M:System.Xml.XmlNode.GetEnumerator" />.</summary>
<summary>For a description of this member, see <see cref="M:System.Xml.XmlNode.Clone" />.</summary>
<returns>A copy of the node from which it is called.</returns>
</member>
- <member name="M:System.Xml.XmlNode.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves all the child nodes of the node to the specified <see cref="T:System.Xml.XmlWriter" />, when overridden in a derived class.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlNode.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the current node to the specified <see cref="T:System.Xml.XmlWriter" />, when overridden in a derived class.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="P:System.Xml.XmlNode.Attributes">
- <summary>Gets an <see cref="T:System.Xml.XmlAttributeCollection" /> containing the attributes of this node.</summary>
- <returns>An <see langword="XmlAttributeCollection" /> containing the attributes of the node.
+ <member name="P:System.Xml.XmlNode.Value">
+ <summary>Gets or sets the value of the node.</summary>
+ <returns>The value returned depends on the <see cref="P:System.Xml.XmlNode.NodeType" /> of the node:
+ Type
- If the node is of type XmlNodeType.Element, the attributes of the node are returned. Otherwise, this property returns <see langword="null" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.BaseURI">
- <summary>Gets the base URI of the current node.</summary>
- <returns>The location from which the node was loaded or String.Empty if the node has no base URI.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.ChildNodes">
- <summary>Gets all the child nodes of the node.</summary>
- <returns>An object that contains all the child nodes of the node.
+ Value
- If there are no child nodes, this property returns an empty <see cref="T:System.Xml.XmlNodeList" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.FirstChild">
- <summary>Gets the first child of the node.</summary>
- <returns>The first child of the node. If there is no such node, <see langword="null" /> is returned.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.HasChildNodes">
- <summary>Gets a value indicating whether this node has any child nodes.</summary>
- <returns>
- <see langword="true" /> if the node has child nodes; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.InnerText">
- <summary>Gets or sets the concatenated values of the node and all its child nodes.</summary>
- <returns>The concatenated values of the node and all its child nodes.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.InnerXml">
- <summary>Gets or sets the markup representing only the child nodes of this node.</summary>
- <exception cref="T:System.InvalidOperationException">Setting this property on a node that cannot have child nodes.</exception>
- <exception cref="T:System.Xml.XmlException">The XML specified when setting this property is not well-formed.</exception>
- <returns>The markup of the child nodes of this node, not including default attributes.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.IsReadOnly">
- <summary>Gets a value indicating whether the node is read-only.</summary>
- <returns>
- <see langword="true" /> if the node is read-only; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.Item(System.String)">
- <summary>Gets the first child element with the specified <see cref="P:System.Xml.XmlNode.Name" />.</summary>
- <param name="name">The qualified name of the element to retrieve.</param>
- <returns>The first <see cref="T:System.Xml.XmlElement" /> that matches the specified name. It returns a null reference (<see langword="Nothing" /> in Visual Basic) if there is no match.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.Item(System.String,System.String)">
- <summary>Gets the first child element with the specified <see cref="P:System.Xml.XmlNode.LocalName" /> and <see cref="P:System.Xml.XmlNode.NamespaceURI" />.</summary>
- <param name="localname">The local name of the element.</param>
- <param name="ns">The namespace URI of the element.</param>
- <returns>The first <see cref="T:System.Xml.XmlElement" /> with the matching <paramref name="localname" /> and <paramref name="ns" />. It returns a null reference (<see langword="Nothing" /> in Visual Basic) if there is no match.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.LastChild">
- <summary>Gets the last child of the node.</summary>
- <returns>The last child of the node. If there is no such node, <see langword="null" /> is returned.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.LocalName">
- <summary>Gets the local name of the node, when overridden in a derived class.</summary>
- <returns>The name of the node with the prefix removed. For example, <see langword="LocalName" /> is book for the element <bk:book>.
+ Attribute
- The name returned is dependent on the <see cref="P:System.Xml.XmlNode.NodeType" /> of the node:
+ The value of the attribute.
- <list type="table"><listheader><term> Type</term><description> Name</description></listheader><item><term> Attribute</term><description> The local name of the attribute.</description></item><item><term> CDATA</term><description> #cdata-section</description></item><item><term> Comment</term><description> #comment</description></item><item><term> Document</term><description> #document</description></item><item><term> DocumentFragment</term><description> #document-fragment</description></item><item><term> DocumentType</term><description> The document type name.</description></item><item><term> Element</term><description> The local name of the element.</description></item><item><term> Entity</term><description> The name of the entity.</description></item><item><term> EntityReference</term><description> The name of the entity referenced.</description></item><item><term> Notation</term><description> The notation name.</description></item><item><term> ProcessingInstruction</term><description> The target of the processing instruction.</description></item><item><term> Text</term><description> #text</description></item><item><term> Whitespace</term><description> #whitespace</description></item><item><term> SignificantWhitespace</term><description> #significant-whitespace</description></item><item><term> XmlDeclaration</term><description> #xml-declaration</description></item></list></returns>
- </member>
- <member name="P:System.Xml.XmlNode.Name">
- <summary>Gets the qualified name of the node, when overridden in a derived class.</summary>
- <returns>The qualified name of the node. The name returned is dependent on the <see cref="P:System.Xml.XmlNode.NodeType" /> of the node:
+ CDATASection
- <list type="table"><listheader><term> Type</term><description> Name</description></listheader><item><term> Attribute</term><description> The qualified name of the attribute.</description></item><item><term> CDATA</term><description> #cdata-section</description></item><item><term> Comment</term><description> #comment</description></item><item><term> Document</term><description> #document</description></item><item><term> DocumentFragment</term><description> #document-fragment</description></item><item><term> DocumentType</term><description> The document type name.</description></item><item><term> Element</term><description> The qualified name of the element.</description></item><item><term> Entity</term><description> The name of the entity.</description></item><item><term> EntityReference</term><description> The name of the entity referenced.</description></item><item><term> Notation</term><description> The notation name.</description></item><item><term> ProcessingInstruction</term><description> The target of the processing instruction.</description></item><item><term> Text</term><description> #text</description></item><item><term> Whitespace</term><description> #whitespace</description></item><item><term> SignificantWhitespace</term><description> #significant-whitespace</description></item><item><term> XmlDeclaration</term><description> #xml-declaration</description></item></list></returns>
- </member>
- <member name="P:System.Xml.XmlNode.NamespaceURI">
- <summary>Gets the namespace URI of this node.</summary>
- <returns>The namespace URI of this node. If there is no namespace URI, this property returns String.Empty.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.NextSibling">
- <summary>Gets the node immediately following this node.</summary>
- <returns>The next <see langword="XmlNode" />. If there is no next node, <see langword="null" /> is returned.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.NodeType">
- <summary>Gets the type of the current node, when overridden in a derived class.</summary>
- <returns>One of the <see cref="T:System.Xml.XmlNodeType" /> values.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.OuterXml">
- <summary>Gets the markup containing this node and all its child nodes.</summary>
- <returns>The markup containing this node and all its child nodes, not including default attributes.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.OwnerDocument">
- <summary>Gets the <see cref="T:System.Xml.XmlDocument" /> to which this node belongs.</summary>
- <returns>The <see cref="T:System.Xml.XmlDocument" /> to which this node belongs.
+ The content of the CDATA Section.
+
+ Comment
+
+ The content of the comment.
+
+ Document
+
+ <see langword="null" />.
+
+ DocumentFragment
+
+ <see langword="null" />.
+
+ DocumentType
+
+ <see langword="null" />.
+
+ Element
+
+ <see langword="null" />. You can use the <see cref="P:System.Xml.XmlElement.InnerText" /> or <see cref="P:System.Xml.XmlElement.InnerXml" /> properties to access the value of the element node.
+
+ Entity
+
+ <see langword="null" />.
+
+ EntityReference
+
+ <see langword="null" />.
+
+ Notation
+
+ <see langword="null" />.
+
+ ProcessingInstruction
- If the node is an <see cref="T:System.Xml.XmlDocument" /> (NodeType equals XmlNodeType.Document), this property returns <see langword="null" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.ParentNode">
- <summary>Gets the parent of this node (for nodes that can have parents).</summary>
- <returns>The <see langword="XmlNode" /> that is the parent of the current node. If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is <see langword="null" />. For all other nodes, the value returned depends on the <see cref="P:System.Xml.XmlNode.NodeType" /> of the node. The following table describes the possible return values for the <see langword="ParentNode" /> property.
+ The entire content excluding the target.
- <list type="table"><listheader><term> NodeType</term><description> Return Value of ParentNode</description></listheader><item><term> Attribute, Document, DocumentFragment, Entity, Notation</term><description> Returns <see langword="null" />; these nodes do not have parents.</description></item><item><term> CDATA</term><description> Returns the element or entity reference containing the CDATA section.</description></item><item><term> Comment</term><description> Returns the element, entity reference, document type, or document containing the comment.</description></item><item><term> DocumentType</term><description> Returns the document node.</description></item><item><term> Element</term><description> Returns the parent node of the element. If the element is the root node in the tree, the parent is the document node.</description></item><item><term> EntityReference</term><description> Returns the element, attribute, or entity reference containing the entity reference.</description></item><item><term> ProcessingInstruction</term><description> Returns the document, element, document type, or entity reference containing the processing instruction.</description></item><item><term> Text</term><description> Returns the parent element, attribute, or entity reference containing the text node.</description></item></list></returns>
- </member>
- <member name="P:System.Xml.XmlNode.Prefix">
- <summary>Gets or sets the namespace prefix of this node.</summary>
- <exception cref="T:System.ArgumentException">This node is read-only.</exception>
- <exception cref="T:System.Xml.XmlException">The specified prefix contains an invalid character.
+ Text
- The specified prefix is malformed.
+ The content of the text node.
- The specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace".
+ SignificantWhitespace
- This node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/ ".
+ The white space characters. White space can consist of one or more space characters, carriage returns, line feeds, or tabs.
- This node is an attribute and the qualifiedName of this node is "xmlns".</exception>
- <returns>The namespace prefix of this node. For example, <see langword="Prefix" /> is bk for the element <bk:book>. If there is no prefix, this property returns String.Empty.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.PreviousSibling">
- <summary>Gets the node immediately preceding this node.</summary>
- <returns>The preceding <see langword="XmlNode" />. If there is no preceding node, <see langword="null" /> is returned.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.PreviousText">
- <summary>Gets the text node that immediately precedes this node.</summary>
- <returns>Returns <see cref="T:System.Xml.XmlNode" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.SchemaInfo">
- <summary>Gets the post schema validation infoset that has been assigned to this node as a result of schema validation.</summary>
- <returns>An <see cref="T:System.Xml.Schema.IXmlSchemaInfo" /> object containing the post schema validation infoset of this node.</returns>
- </member>
- <member name="P:System.Xml.XmlNode.Value">
- <summary>Gets or sets the value of the node.</summary>
+ Whitespace
+
+ The white space characters. White space can consist of one or more space characters, carriage returns, line feeds, or tabs.
+
+ XmlDeclaration
+
+ The content of the declaration (that is, everything between <?xml and ?>).</returns>
<exception cref="T:System.ArgumentException">Setting the value of a node that is read-only.</exception>
<exception cref="T:System.InvalidOperationException">Setting the value of a node that is not supposed to have a value (for example, an Element node).</exception>
- <returns>The value returned depends on the <see cref="P:System.Xml.XmlNode.NodeType" /> of the node:
-
- <list type="table"><listheader><term> Type</term><description> Value</description></listheader><item><term> Attribute</term><description> The value of the attribute.</description></item><item><term> CDATASection</term><description> The content of the CDATA Section.</description></item><item><term> Comment</term><description> The content of the comment.</description></item><item><term> Document</term><description><see langword="null" />.</description></item><item><term> DocumentFragment</term><description><see langword="null" />.</description></item><item><term> DocumentType</term><description><see langword="null" />.</description></item><item><term> Element</term><description><see langword="null" />. You can use the <see cref="P:System.Xml.XmlElement.InnerText" /> or <see cref="P:System.Xml.XmlElement.InnerXml" /> properties to access the value of the element node.</description></item><item><term> Entity</term><description><see langword="null" />.</description></item><item><term> EntityReference</term><description><see langword="null" />.</description></item><item><term> Notation</term><description><see langword="null" />.</description></item><item><term> ProcessingInstruction</term><description> The entire content excluding the target.</description></item><item><term> Text</term><description> The content of the text node.</description></item><item><term> SignificantWhitespace</term><description> The white space characters. White space can consist of one or more space characters, carriage returns, line feeds, or tabs.</description></item><item><term> Whitespace</term><description> The white space characters. White space can consist of one or more space characters, carriage returns, line feeds, or tabs.</description></item><item><term> XmlDeclaration</term><description> The content of the declaration (that is, everything between <?xml and ?>).</description></item></list></returns>
+ </member>
+ <member name="M:System.Xml.XmlNode.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves all the child nodes of the node to the specified <see cref="T:System.Xml.XmlWriter" />, when overridden in a derived class.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="M:System.Xml.XmlNode.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the current node to the specified <see cref="T:System.Xml.XmlWriter" />, when overridden in a derived class.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
</member>
<member name="T:System.Xml.XmlNodeChangedAction">
<summary>Specifies the type of node change.</summary>
</member>
<member name="P:System.Xml.XmlNodeChangedEventArgs.NewParent">
<summary>Gets the value of the <see cref="P:System.Xml.XmlNode.ParentNode" /> after the operation completes.</summary>
- <returns>The value of the <see langword="ParentNode" /> after the operation completes. This property returns <see langword="null" /> if the node is being removed. For attribute nodes, this property returns the <see cref="P:System.Xml.XmlAttribute.OwnerElement" />.</returns>
+ <returns>The value of the <see langword="ParentNode" /> after the operation completes. This property returns <see langword="null" /> if the node is being removed.
+
+For attribute nodes this property returns the <see cref="P:System.Xml.XmlAttribute.OwnerElement" />.</returns>
</member>
<member name="P:System.Xml.XmlNodeChangedEventArgs.NewValue">
<summary>Gets the new value of the node.</summary>
- <returns>The new value of the node. This property returns <see langword="null" /> if the node is neither an attribute nor a text node, or if the node is being removed.
-
- If called in a <see cref="E:System.Xml.XmlDocument.NodeChanging" /> event, <see langword="NewValue" /> returns the value of the node if the change is successful. If called in a <see cref="E:System.Xml.XmlDocument.NodeChanged" /> event, <see langword="NewValue" /> returns the current value of the node.</returns>
+ <returns>The new value of the node. This property returns <see langword="null" /> if the node is neither an attribute nor a text node, or if the node is being removed.
+If called in a <see cref="E:System.Xml.XmlDocument.NodeChanging" /> event, <see langword="NewValue" /> returns the value of the node if the change is successful. If called in a <see cref="E:System.Xml.XmlDocument.NodeChanged" /> event, <see langword="NewValue" /> returns the current value of the node.</returns>
</member>
<member name="P:System.Xml.XmlNodeChangedEventArgs.Node">
<summary>Gets the <see cref="T:System.Xml.XmlNode" /> that is being added, removed or changed.</summary>
</member>
<member name="P:System.Xml.XmlNodeChangedEventArgs.OldParent">
<summary>Gets the value of the <see cref="P:System.Xml.XmlNode.ParentNode" /> before the operation began.</summary>
- <returns>The value of the <see langword="ParentNode" /> before the operation began. This property returns <see langword="null" /> if the node did not have a parent. For attribute nodes, this property returns the <see cref="P:System.Xml.XmlAttribute.OwnerElement" />.</returns>
+ <returns>The value of the <see langword="ParentNode" /> before the operation began. This property returns <see langword="null" /> if the node did not have a parent.
+
+For attribute nodes this property returns the <see cref="P:System.Xml.XmlAttribute.OwnerElement" />.</returns>
</member>
<member name="P:System.Xml.XmlNodeChangedEventArgs.OldValue">
<summary>Gets the original value of the node.</summary>
- <returns>The original value of the node. This property returns <see langword="null" /> if the node is neither an attribute nor a text node, or if the node is being inserted.
-
- If called in a <see cref="E:System.Xml.XmlDocument.NodeChanging" /> event, <see langword="OldValue" /> returns the current value of the node that will be replaced if the change is successful. If called in a <see cref="E:System.Xml.XmlDocument.NodeChanged" /> event, <see langword="OldValue" /> returns the value of node prior to the change.</returns>
+ <returns>The original value of the node. This property returns <see langword="null" /> if the node is neither an attribute nor a text node, or if the node is being inserted.
+If called in a <see cref="E:System.Xml.XmlDocument.NodeChanging" /> event, <see langword="OldValue" /> returns the current value of the node that will be replaced if the change is successful. If called in a <see cref="E:System.Xml.XmlDocument.NodeChanged" /> event, <see langword="OldValue" /> returns the value of node prior to the change.</returns>
</member>
<member name="T:System.Xml.XmlNodeChangedEventHandler">
<summary>Represents the method that handles <see cref="E:System.Xml.XmlDocument.NodeChanged" />, <see cref="E:System.Xml.XmlDocument.NodeChanging" />, <see cref="E:System.Xml.XmlDocument.NodeInserted" />, <see cref="E:System.Xml.XmlDocument.NodeInserting" />, <see cref="E:System.Xml.XmlDocument.NodeRemoved" /> and <see cref="E:System.Xml.XmlDocument.NodeRemoving" /> events.</summary>
<member name="M:System.Xml.XmlNodeList.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.XmlNodeList" /> class.</summary>
</member>
+ <member name="P:System.Xml.XmlNodeList.Count">
+ <summary>Gets the number of nodes in the <see langword="XmlNodeList" />.</summary>
+ <returns>The number of nodes in the <see langword="XmlNodeList" />.</returns>
+ </member>
<member name="M:System.Xml.XmlNodeList.GetEnumerator">
<summary>Gets an enumerator that iterates through the collection of nodes.</summary>
<returns>An enumerator used to iterate through the collection of nodes.</returns>
<param name="index">The zero-based index into the list of nodes.</param>
<returns>The <see cref="T:System.Xml.XmlNode" /> with the specified index in the collection. If <paramref name="index" /> is greater than or equal to the number of nodes in the list, this returns <see langword="null" />.</returns>
</member>
+ <member name="P:System.Xml.XmlNodeList.ItemOf(System.Int32)">
+ <summary>Gets a node at the given index.</summary>
+ <param name="i">The zero-based index into the list of nodes.</param>
+ <returns>The <see cref="T:System.Xml.XmlNode" /> with the specified index in the collection. If index is greater than or equal to the number of nodes in the list, this returns <see langword="null" />.</returns>
+ </member>
<member name="M:System.Xml.XmlNodeList.PrivateDisposeNodeList">
<summary>Disposes resources in the node list privately.</summary>
</member>
<member name="M:System.Xml.XmlNodeList.System#IDisposable#Dispose">
<summary>Releases all resources used by the <see cref="T:System.Xml.XmlNodeList" /> class.</summary>
</member>
- <member name="P:System.Xml.XmlNodeList.Count">
- <summary>Gets the number of nodes in the <see langword="XmlNodeList" />.</summary>
- <returns>The number of nodes in the <see langword="XmlNodeList" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeList.ItemOf(System.Int32)">
- <summary>Gets a node at the given index.</summary>
- <param name="i">The zero-based index into the list of nodes.</param>
- <returns>The <see cref="T:System.Xml.XmlNode" /> with the specified index in the collection. If index is greater than or equal to the number of nodes in the list, this returns <see langword="null" />.</returns>
- </member>
<member name="T:System.Xml.XmlNodeOrder">
<summary>Describes the document order of a node compared to a second node.</summary>
</member>
<summary>Creates an instance of the <see langword="XmlNodeReader" /> class using the specified <see cref="T:System.Xml.XmlNode" />.</summary>
<param name="node">The <see langword="XmlNode" /> you want to read.</param>
</member>
+ <member name="P:System.Xml.XmlNodeReader.AttributeCount">
+ <summary>Gets the number of attributes on the current node.</summary>
+ <returns>The number of attributes on the current node. This number includes default attributes.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNodeReader.BaseURI">
+ <summary>Gets the base URI of the current node.</summary>
+ <returns>The base URI of the current node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNodeReader.CanReadBinaryContent">
+ <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlNodeReader" /> implements the binary content read methods.</summary>
+ <returns>
+ <see langword="true" /> if the binary content read methods are implemented; otherwise <see langword="false" />. The <see cref="T:System.Xml.XmlNodeReader" /> class always returns <see langword="true" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNodeReader.CanResolveEntity">
+ <summary>Gets a value indicating whether this reader can parse and resolve entities.</summary>
+ <returns>
+ <see langword="true" /> if the reader can parse and resolve entities; otherwise, <see langword="false" />. <see langword="XmlNodeReader" /> always returns <see langword="true" />.</returns>
+ </member>
<member name="M:System.Xml.XmlNodeReader.Close">
<summary>Changes the <see cref="P:System.Xml.XmlNodeReader.ReadState" /> to <see langword="Closed" />.</summary>
</member>
+ <member name="P:System.Xml.XmlNodeReader.Depth">
+ <summary>Gets the depth of the current node in the XML document.</summary>
+ <returns>The depth of the current node in the XML document.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNodeReader.EOF">
+ <summary>Gets a value indicating whether the reader is positioned at the end of the stream.</summary>
+ <returns>
+ <see langword="true" /> if the reader is positioned at the end of the stream; otherwise, <see langword="false" />.</returns>
+ </member>
<member name="M:System.Xml.XmlNodeReader.GetAttribute(System.Int32)">
<summary>Gets the value of the attribute with the specified index.</summary>
<param name="attributeIndex">The index of the attribute. The index is zero-based. (The first attribute has index 0.)</param>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="i" /> parameter is less than 0 or greater than or equal to <see cref="P:System.Xml.XmlNodeReader.AttributeCount" />.</exception>
<returns>The value of the specified attribute.</returns>
+ <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="i" /> parameter is less than 0 or greater than or equal to <see cref="P:System.Xml.XmlNodeReader.AttributeCount" />.</exception>
</member>
<member name="M:System.Xml.XmlNodeReader.GetAttribute(System.String)">
<summary>Gets the value of the attribute with the specified name.</summary>
<param name="namespaceURI">The namespace URI of the attribute.</param>
<returns>The value of the specified attribute. If the attribute is not found, <see langword="null" /> is returned.</returns>
</member>
+ <member name="P:System.Xml.XmlNodeReader.HasAttributes">
+ <summary>Gets a value indicating whether the current node has any attributes.</summary>
+ <returns>
+ <see langword="true" /> if the current node has attributes; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNodeReader.HasValue">
+ <summary>Gets a value indicating whether the current node can have a <see cref="P:System.Xml.XmlNodeReader.Value" />.</summary>
+ <returns>
+ <see langword="true" /> if the node on which the reader is currently positioned can have a <see langword="Value" />; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNodeReader.IsDefault">
+ <summary>Gets a value indicating whether the current node is an attribute that was generated from the default value defined in the document type definition (DTD) or schema.</summary>
+ <returns>
+ <see langword="true" /> if the current node is an attribute whose value was generated from the default value defined in the DTD or schema; <see langword="false" /> if the attribute value was explicitly set.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNodeReader.IsEmptyElement">
+ <summary>Gets a value indicating whether the current node is an empty element (for example, <c><MyElement/></c>).</summary>
+ <returns>
+ <see langword="true" /> if the current node is an element (<see cref="P:System.Xml.XmlNodeReader.NodeType" /> equals <see langword="XmlNodeType.Element" />) and it ends with <c>/></c>; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNodeReader.LocalName">
+ <summary>Gets the local name of the current node.</summary>
+ <returns>The name of the current node with the prefix removed. For example, <see langword="LocalName" /> is <see langword="book" /> for the element <c><bk:book></c>.
+For node types that do not have a name (like <see langword="Text" />, <see langword="Comment" />, and so on), this property returns String.Empty.</returns>
+ </member>
<member name="M:System.Xml.XmlNodeReader.LookupNamespace(System.String)">
<summary>Resolves a namespace prefix in the current element's scope.</summary>
<param name="prefix">The prefix whose namespace URI you want to resolve. To match the default namespace, pass an empty string. This string does not have to be atomized.</param>
<returns>
<see langword="true" /> if there is a next attribute; <see langword="false" /> if there are no more attributes.</returns>
</member>
+ <member name="P:System.Xml.XmlNodeReader.Name">
+ <summary>Gets the qualified name of the current node.</summary>
+ <returns>The qualified name of the current node. For example, <see langword="Name" /> is <see langword="bk:book" /> for the element <c><bk:book></c>.
+The name returned is dependent on the <see cref="P:System.Xml.XmlNodeReader.NodeType" /> of the node. The following node types return the listed values. All other node types return an empty string.
+ Node Type
+
+ Name
+
+ <see langword="Attribute" /> The name of the attribute.
+
+ <see langword="DocumentType" /> The document type name.
+
+ <see langword="Element" /> The tag name.
+
+ <see langword="EntityReference" /> The name of the entity referenced.
+
+ <see langword="ProcessingInstruction" /> The target of the processing instruction.
+
+ <see langword="XmlDeclaration" /> The literal string <see langword="xml" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNodeReader.NamespaceURI">
+ <summary>Gets the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned.</summary>
+ <returns>The namespace URI of the current node; otherwise an empty string.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNodeReader.NameTable">
+ <summary>Gets the <see cref="T:System.Xml.XmlNameTable" /> associated with this implementation.</summary>
+ <returns>The <see langword="XmlNameTable" /> enabling you to get the atomized version of a string within the node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNodeReader.NodeType">
+ <summary>Gets the type of the current node.</summary>
+ <returns>One of the <see cref="T:System.Xml.XmlNodeType" /> values representing the type of the current node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlNodeReader.Prefix">
+ <summary>Gets the namespace prefix associated with the current node.</summary>
+ <returns>The namespace prefix associated with the current node.</returns>
+ </member>
<member name="M:System.Xml.XmlNodeReader.Read">
<summary>Reads the next node from the stream.</summary>
<returns>
<member name="M:System.Xml.XmlNodeReader.ReadAttributeValue">
<summary>Parses the attribute value into one or more <see langword="Text" />, <see langword="EntityReference" />, or <see langword="EndEntity" /> nodes.</summary>
<returns>
- <see langword="true" /> if there are nodes to return.
-
- <see langword="false" /> if the reader is not positioned on an attribute node when the initial call is made or if all the attribute values have been read.
-
- An empty attribute, such as, <c>misc=""</c>, returns <see langword="true" /> with a single node with a value of String.Empty.</returns>
+ <see langword="true" /> if there are nodes to return.
+<see langword="false" /> if the reader is not positioned on an attribute node when the initial call is made or if all the attribute values have been read.
+An empty attribute, such as, <c>misc=""</c>, returns <see langword="true" /> with a single node with a value of String.Empty.</returns>
</member>
<member name="M:System.Xml.XmlNodeReader.ReadContentAsBase64(System.Byte[],System.Int32,System.Int32)">
<summary>Reads the content and returns the Base64 decoded binary bytes.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="M:System.Xml.XmlNodeReader.ReadContentAsBase64(System.Byte[],System.Int32,System.Int32)" /> is not supported on the current node.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlNodeReader.ReadContentAsBinHex(System.Byte[],System.Int32,System.Int32)">
<summary>Reads the content and returns the BinHex decoded binary bytes.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="M:System.Xml.XmlNodeReader.ReadContentAsBinHex(System.Byte[],System.Int32,System.Int32)" /> is not supported on the current node.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlNodeReader.ReadElementContentAsBase64(System.Byte[],System.Int32,System.Int32)">
<summary>Reads the element and decodes the Base64 content.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
- <exception cref="T:System.InvalidOperationException">The current node is not an element node.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
- <exception cref="T:System.Xml.XmlException">The element contains mixed content.</exception>
- <exception cref="T:System.FormatException">The content cannot be converted to the requested type.</exception>
<returns>The number of bytes written to the buffer.</returns>
- </member>
- <member name="M:System.Xml.XmlNodeReader.ReadElementContentAsBinHex(System.Byte[],System.Int32,System.Int32)">
- <summary>Reads the element and decodes the BinHex content.</summary>
- <param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
- <param name="index">The offset into the buffer where to start copying the result.</param>
- <param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The current node is not an element node.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
- <exception cref="T:System.Xml.XmlException">The element contains mixed content.</exception>
- <exception cref="T:System.FormatException">The content cannot be converted to the requested type.</exception>
- <returns>The number of bytes written to the buffer.</returns>
- </member>
- <member name="M:System.Xml.XmlNodeReader.ReadString">
- <summary>Reads the contents of an element or text node as a string.</summary>
- <returns>The contents of the element or text-like node (This can include CDATA, Text nodes, and so on). This can be an empty string if the reader is positioned on something other than an element or text node, or if there is no more text content to return in the current context.
-
- <see langword="Note:" /> The text node can be either an element or an attribute text node.</returns>
- </member>
- <member name="M:System.Xml.XmlNodeReader.ResolveEntity">
- <summary>Resolves the entity reference for <see langword="EntityReference" /> nodes.</summary>
- <exception cref="T:System.InvalidOperationException">The reader is not positioned on an <see langword="EntityReference" /> node.</exception>
- </member>
- <member name="M:System.Xml.XmlNodeReader.Skip">
- <summary>Skips the children of the current node.</summary>
- </member>
- <member name="M:System.Xml.XmlNodeReader.System#Xml#IXmlNamespaceResolver#GetNamespacesInScope(System.Xml.XmlNamespaceScope)">
- <summary>For a description of this member, see <see cref="M:System.Xml.IXmlNamespaceResolver.GetNamespacesInScope(System.Xml.XmlNamespaceScope)" />.</summary>
- <param name="scope">
- <see cref="T:System.Xml.XmlNamespaceScope" /> object.</param>
- <returns>
- <see cref="T:System.Collections.IDictionary" /> object that contains the namespaces that are in scope.</returns>
- </member>
- <member name="M:System.Xml.XmlNodeReader.System#Xml#IXmlNamespaceResolver#LookupNamespace(System.String)">
- <summary>For a description of this member, see <see cref="M:System.Xml.IXmlNamespaceResolver.LookupNamespace(System.String)" />.</summary>
- <param name="prefix">
- <see cref="T:System.String" /> that contains the namespace prefix.</param>
- <returns>
- <see cref="T:System.String" /> that contains the namespace name.</returns>
- </member>
- <member name="M:System.Xml.XmlNodeReader.System#Xml#IXmlNamespaceResolver#LookupPrefix(System.String)">
- <summary>For a description of this member, see <see cref="M:System.Xml.IXmlNamespaceResolver.LookupPrefix(System.String)" />.</summary>
- <param name="namespaceName">
- <see cref="T:System.String" /> object that identifies the namespace.</param>
- <returns>
- <see cref="T:System.String" /> object that contains the namespace prefix.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.AttributeCount">
- <summary>Gets the number of attributes on the current node.</summary>
- <returns>The number of attributes on the current node. This number includes default attributes.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.BaseURI">
- <summary>Gets the base URI of the current node.</summary>
- <returns>The base URI of the current node.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.CanReadBinaryContent">
- <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlNodeReader" /> implements the binary content read methods.</summary>
- <returns>
- <see langword="true" /> if the binary content read methods are implemented; otherwise <see langword="false" />. The <see cref="T:System.Xml.XmlNodeReader" /> class always returns <see langword="true" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.CanResolveEntity">
- <summary>Gets a value indicating whether this reader can parse and resolve entities.</summary>
- <returns>
- <see langword="true" /> if the reader can parse and resolve entities; otherwise, <see langword="false" />. <see langword="XmlNodeReader" /> always returns <see langword="true" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.Depth">
- <summary>Gets the depth of the current node in the XML document.</summary>
- <returns>The depth of the current node in the XML document.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.EOF">
- <summary>Gets a value indicating whether the reader is positioned at the end of the stream.</summary>
- <returns>
- <see langword="true" /> if the reader is positioned at the end of the stream; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.HasAttributes">
- <summary>Gets a value indicating whether the current node has any attributes.</summary>
- <returns>
- <see langword="true" /> if the current node has attributes; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.HasValue">
- <summary>Gets a value indicating whether the current node can have a <see cref="P:System.Xml.XmlNodeReader.Value" />.</summary>
- <returns>
- <see langword="true" /> if the node on which the reader is currently positioned can have a <see langword="Value" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.IsDefault">
- <summary>Gets a value indicating whether the current node is an attribute that was generated from the default value defined in the document type definition (DTD) or schema.</summary>
- <returns>
- <see langword="true" /> if the current node is an attribute whose value was generated from the default value defined in the DTD or schema; <see langword="false" /> if the attribute value was explicitly set.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.IsEmptyElement">
- <summary>Gets a value indicating whether the current node is an empty element (for example, <c><MyElement/></c>).</summary>
- <returns>
- <see langword="true" /> if the current node is an element (<see cref="P:System.Xml.XmlNodeReader.NodeType" /> equals <see langword="XmlNodeType.Element" />) and it ends with <c>/></c>; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.LocalName">
- <summary>Gets the local name of the current node.</summary>
- <returns>The name of the current node with the prefix removed. For example, <see langword="LocalName" /> is <see langword="book" /> for the element <c><bk:book></c>.
-
- For node types that do not have a name (like <see langword="Text" />, <see langword="Comment" />, and so on), this property returns String.Empty.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.Name">
- <summary>Gets the qualified name of the current node.</summary>
- <returns>The qualified name of the current node. For example, <see langword="Name" /> is <see langword="bk:book" /> for the element <c><bk:book></c>.
-
- The name returned is dependent on the <see cref="P:System.Xml.XmlNodeReader.NodeType" /> of the node. The following node types return the listed values. All other node types return an empty string.
-
- <list type="table"><listheader><term> Node Type</term><description> Name</description></listheader><item><term><see langword="Attribute" /></term><description> The name of the attribute.</description></item><item><term><see langword="DocumentType" /></term><description> The document type name.</description></item><item><term><see langword="Element" /></term><description> The tag name.</description></item><item><term><see langword="EntityReference" /></term><description> The name of the entity referenced.</description></item><item><term><see langword="ProcessingInstruction" /></term><description> The target of the processing instruction.</description></item><item><term><see langword="XmlDeclaration" /></term><description> The literal string <see langword="xml" />.</description></item></list></returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.NamespaceURI">
- <summary>Gets the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned.</summary>
- <returns>The namespace URI of the current node; otherwise an empty string.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.NameTable">
- <summary>Gets the <see cref="T:System.Xml.XmlNameTable" /> associated with this implementation.</summary>
- <returns>The <see langword="XmlNameTable" /> enabling you to get the atomized version of a string within the node.</returns>
- </member>
- <member name="P:System.Xml.XmlNodeReader.NodeType">
- <summary>Gets the type of the current node.</summary>
- <returns>One of the <see cref="T:System.Xml.XmlNodeType" /> values representing the type of the current node.</returns>
+ <exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
+ <exception cref="T:System.Xml.XmlException">The element contains mixed content.</exception>
+ <exception cref="T:System.FormatException">The content cannot be converted to the requested type.</exception>
</member>
- <member name="P:System.Xml.XmlNodeReader.Prefix">
- <summary>Gets the namespace prefix associated with the current node.</summary>
- <returns>The namespace prefix associated with the current node.</returns>
+ <member name="M:System.Xml.XmlNodeReader.ReadElementContentAsBinHex(System.Byte[],System.Int32,System.Int32)">
+ <summary>Reads the element and decodes the BinHex content.</summary>
+ <param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
+ <param name="index">The offset into the buffer where to start copying the result.</param>
+ <param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
+ <exception cref="T:System.InvalidOperationException">The current node is not an element node.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
+ <exception cref="T:System.Xml.XmlException">The element contains mixed content.</exception>
+ <exception cref="T:System.FormatException">The content cannot be converted to the requested type.</exception>
</member>
<member name="P:System.Xml.XmlNodeReader.ReadState">
<summary>Gets the state of the reader.</summary>
<returns>One of the <see cref="T:System.Xml.ReadState" /> values.</returns>
</member>
+ <member name="M:System.Xml.XmlNodeReader.ReadString">
+ <summary>Reads the contents of an element or text node as a string.</summary>
+ <returns>The contents of the element or text-like node (This can include CDATA, Text nodes, and so on). This can be an empty string if the reader is positioned on something other than an element or text node, or if there is no more text content to return in the current context.
+<see langword="Note:" /> The text node can be either an element or an attribute text node.</returns>
+ </member>
+ <member name="M:System.Xml.XmlNodeReader.ResolveEntity">
+ <summary>Resolves the entity reference for <see langword="EntityReference" /> nodes.</summary>
+ <exception cref="T:System.InvalidOperationException">The reader is not positioned on an <see langword="EntityReference" /> node.</exception>
+ </member>
<member name="P:System.Xml.XmlNodeReader.SchemaInfo">
<summary>Gets the schema information that has been assigned to the current node.</summary>
<returns>An <see cref="T:System.Xml.Schema.IXmlSchemaInfo" /> object containing the schema information for the current node.</returns>
</member>
+ <member name="M:System.Xml.XmlNodeReader.Skip">
+ <summary>Skips the children of the current node.</summary>
+ </member>
+ <member name="M:System.Xml.XmlNodeReader.System#Xml#IXmlNamespaceResolver#GetNamespacesInScope(System.Xml.XmlNamespaceScope)">
+ <summary>For a description of this member, see <see cref="M:System.Xml.IXmlNamespaceResolver.GetNamespacesInScope(System.Xml.XmlNamespaceScope)" />.</summary>
+ <param name="scope">
+ <see cref="T:System.Xml.XmlNamespaceScope" /> object.</param>
+ <returns>
+ <see cref="T:System.Collections.IDictionary" /> object that contains the namespaces that are in scope.</returns>
+ </member>
+ <member name="M:System.Xml.XmlNodeReader.System#Xml#IXmlNamespaceResolver#LookupNamespace(System.String)">
+ <summary>For a description of this member, see <see cref="M:System.Xml.IXmlNamespaceResolver.LookupNamespace(System.String)" />.</summary>
+ <param name="prefix">
+ <see cref="T:System.String" /> that contains the namespace prefix.</param>
+ <returns>
+ <see cref="T:System.String" /> that contains the namespace name.</returns>
+ </member>
+ <member name="M:System.Xml.XmlNodeReader.System#Xml#IXmlNamespaceResolver#LookupPrefix(System.String)">
+ <summary>For a description of this member, see <see cref="M:System.Xml.IXmlNamespaceResolver.LookupPrefix(System.String)" />.</summary>
+ <param name="namespaceName">
+ <see cref="T:System.String" /> object that identifies the namespace.</param>
+ <returns>
+ <see cref="T:System.String" /> object that contains the namespace prefix.</returns>
+ </member>
<member name="P:System.Xml.XmlNodeReader.Value">
<summary>Gets the text value of the current node.</summary>
- <returns>The value returned depends on the <see cref="P:System.Xml.XmlNodeReader.NodeType" /> of the node. The following table lists node types that have a value to return. All other node types return String.Empty.
+ <returns>The value returned depends on the <see cref="P:System.Xml.XmlNodeReader.NodeType" /> of the node. The following table lists node types that have a value to return. All other node types return String.Empty.
+ Node Type
- <list type="table"><listheader><term> Node Type</term><description> Value</description></listheader><item><term><see langword="Attribute" /></term><description> The value of the attribute.</description></item><item><term><see langword="CDATA" /></term><description> The content of the CDATA section.</description></item><item><term><see langword="Comment" /></term><description> The content of the comment.</description></item><item><term><see langword="DocumentType" /></term><description> The internal subset.</description></item><item><term><see langword="ProcessingInstruction" /></term><description> The entire content, excluding the target.</description></item><item><term><see langword="SignificantWhitespace" /></term><description> The white space between markup in a mixed content model.</description></item><item><term><see langword="Text" /></term><description> The content of the text node.</description></item><item><term><see langword="Whitespace" /></term><description> The white space between markup.</description></item><item><term><see langword="XmlDeclaration" /></term><description> The content of the declaration.</description></item></list></returns>
+ Value
+
+ <see langword="Attribute" /> The value of the attribute.
+
+ <see langword="CDATA" /> The content of the CDATA section.
+
+ <see langword="Comment" /> The content of the comment.
+
+ <see langword="DocumentType" /> The internal subset.
+
+ <see langword="ProcessingInstruction" /> The entire content, excluding the target.
+
+ <see langword="SignificantWhitespace" /> The white space between markup in a mixed content model.
+
+ <see langword="Text" /> The content of the text node.
+
+ <see langword="Whitespace" /> The white space between markup.
+
+ <see langword="XmlDeclaration" /> The content of the declaration.</returns>
</member>
<member name="P:System.Xml.XmlNodeReader.XmlLang">
<summary>Gets the current <see langword="xml:lang" /> scope.</summary>
<summary>White space between markup in a mixed content model or white space within the <c>xml:space="preserve"</c> scope.</summary>
</member>
<member name="F:System.Xml.XmlNodeType.Text">
- <summary>
- <para>The text content of a node.</para>
- <para>A <see cref="F:System.Xml.XmlNodeType.Text" /> node cannot have any child nodes. It can appear as the child node of the <see cref="F:System.Xml.XmlNodeType.Attribute" />, <see cref="F:System.Xml.XmlNodeType.DocumentFragment" />, <see cref="F:System.Xml.XmlNodeType.Element" />, and <see cref="F:System.Xml.XmlNodeType.EntityReference" /> nodes.</para>
- </summary>
+ <summary>The text content of a node.</summary>
</member>
<member name="F:System.Xml.XmlNodeType.Whitespace">
<summary>White space between markup.</summary>
</member>
<member name="F:System.Xml.XmlNodeType.XmlDeclaration">
- <summary>
- <para>The XML declaration (for example, <c><?xml version='1.0'?></c> ).</para>
- <para>The <see cref="F:System.Xml.XmlNodeType.XmlDeclaration" /> node must be the first node in the document. It cannot have children. It is a child of the <see cref="F:System.Xml.XmlNodeType.Document" /> node. It can have attributes that provide version and encoding information.</para>
- </summary>
+ <summary>The XML declaration (for example, <c><?xml version='1.0'?></c> ).</summary>
</member>
<member name="T:System.Xml.XmlNotation">
<summary>Represents a notation declaration, such as <!NOTATION... >.</summary>
<summary>Creates a duplicate of this node. Notation nodes cannot be cloned. Calling this method on an <see cref="T:System.Xml.XmlNotation" /> object throws an exception.</summary>
<param name="deep">
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself.</param>
- <exception cref="T:System.InvalidOperationException">Notation nodes cannot be cloned. Calling this method on an <see cref="T:System.Xml.XmlNotation" /> object throws an exception.</exception>
<returns>A <see cref="T:System.Xml.XmlNode" /> copy of the node from which the method is called.</returns>
- </member>
- <member name="M:System.Xml.XmlNotation.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. This method has no effect on <see langword="XmlNotation" /> nodes.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlNotation.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />. This method has no effect on <see langword="XmlNotation" /> nodes.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ <exception cref="T:System.InvalidOperationException">Notation nodes cannot be cloned. Calling this method on an <see cref="T:System.Xml.XmlNotation" /> object throws an exception.</exception>
</member>
<member name="P:System.Xml.XmlNotation.InnerXml">
<summary>Gets the markup representing the children of this node.</summary>
- <exception cref="T:System.InvalidOperationException">Attempting to set the property.</exception>
<returns>For <see langword="XmlNotation" /> nodes, String.Empty is returned.</returns>
+ <exception cref="T:System.InvalidOperationException">Attempting to set the property.</exception>
</member>
<member name="P:System.Xml.XmlNotation.IsReadOnly">
<summary>Gets a value indicating whether the node is read-only.</summary>
<returns>
- <see langword="true" /> if the node is read-only; otherwise, <see langword="false" />.
-
- Because <see langword="XmlNotation" /> nodes are read-only, this property always returns <see langword="true" />.</returns>
+ <see langword="true" /> if the node is read-only; otherwise, <see langword="false" />.
+Because <see langword="XmlNotation" /> nodes are read-only, this property always returns <see langword="true" />.</returns>
</member>
<member name="P:System.Xml.XmlNotation.LocalName">
<summary>Gets the name of the current node without the namespace prefix.</summary>
<summary>Gets the value of the system identifier on the notation declaration.</summary>
<returns>The system identifier on the notation. If there is no system identifier, <see langword="null" /> is returned.</returns>
</member>
+ <member name="M:System.Xml.XmlNotation.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. This method has no effect on <see langword="XmlNotation" /> nodes.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="M:System.Xml.XmlNotation.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />. This method has no effect on <see langword="XmlNotation" /> nodes.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
<member name="T:System.Xml.XmlOutputMethod">
<summary>Specifies the method used to serialize the <see cref="T:System.Xml.XmlWriter" /> output.</summary>
</member>
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself.</param>
<returns>The duplicate node.</returns>
</member>
- <member name="M:System.Xml.XmlProcessingInstruction.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. Because ProcessingInstruction nodes do not have children, this method has no effect.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlProcessingInstruction.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
<member name="P:System.Xml.XmlProcessingInstruction.Data">
<summary>Gets or sets the content of the processing instruction, excluding the target.</summary>
<returns>The content of the processing instruction, excluding the target.</returns>
</member>
<member name="P:System.Xml.XmlProcessingInstruction.Value">
<summary>Gets or sets the value of the node.</summary>
- <exception cref="T:System.ArgumentException">Node is read-only.</exception>
<returns>The entire content of the processing instruction, excluding the target.</returns>
+ <exception cref="T:System.ArgumentException">Node is read-only.</exception>
+ </member>
+ <member name="M:System.Xml.XmlProcessingInstruction.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. Because ProcessingInstruction nodes do not have children, this method has no effect.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="M:System.Xml.XmlProcessingInstruction.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
</member>
<member name="T:System.Xml.XmlQualifiedName">
<summary>Represents an XML qualified name.</summary>
</member>
- <member name="F:System.Xml.XmlQualifiedName.Empty">
- <summary>Provides an empty <see cref="T:System.Xml.XmlQualifiedName" />.</summary>
- </member>
<member name="M:System.Xml.XmlQualifiedName.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.XmlQualifiedName" /> class.</summary>
</member>
<param name="name">The local name to use as the name of the <see cref="T:System.Xml.XmlQualifiedName" /> object.</param>
<param name="ns">The namespace for the <see cref="T:System.Xml.XmlQualifiedName" /> object.</param>
</member>
+ <member name="F:System.Xml.XmlQualifiedName.Empty">
+ <summary>Provides an empty <see cref="T:System.Xml.XmlQualifiedName" />.</summary>
+ </member>
<member name="M:System.Xml.XmlQualifiedName.Equals(System.Object)">
<summary>Determines whether the specified <see cref="T:System.Xml.XmlQualifiedName" /> object is equal to the current <see cref="T:System.Xml.XmlQualifiedName" /> object.</summary>
<param name="other">The <see cref="T:System.Xml.XmlQualifiedName" /> to compare.</param>
<summary>Returns the hash code for the <see cref="T:System.Xml.XmlQualifiedName" />.</summary>
<returns>A hash code for this object.</returns>
</member>
+ <member name="P:System.Xml.XmlQualifiedName.IsEmpty">
+ <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlQualifiedName" /> is empty.</summary>
+ <returns>
+ <see langword="true" /> if name and namespace are empty strings; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlQualifiedName.Name">
+ <summary>Gets a string representation of the qualified name of the <see cref="T:System.Xml.XmlQualifiedName" />.</summary>
+ <returns>A string representation of the qualified name or String.Empty if a name is not defined for the object.</returns>
+ </member>
+ <member name="P:System.Xml.XmlQualifiedName.Namespace">
+ <summary>Gets a string representation of the namespace of the <see cref="T:System.Xml.XmlQualifiedName" />.</summary>
+ <returns>A string representation of the namespace or String.Empty if a namespace is not defined for the object.</returns>
+ </member>
<member name="M:System.Xml.XmlQualifiedName.op_Equality(System.Xml.XmlQualifiedName,System.Xml.XmlQualifiedName)">
<summary>Compares two <see cref="T:System.Xml.XmlQualifiedName" /> objects.</summary>
<param name="a">An <see cref="T:System.Xml.XmlQualifiedName" /> to compare.</param>
<param name="ns">The namespace of the object.</param>
<returns>The string value of the <see cref="T:System.Xml.XmlQualifiedName" /> in the format of <see langword="namespace:localname" />. If the object does not have a namespace defined, this method returns just the local name.</returns>
</member>
- <member name="P:System.Xml.XmlQualifiedName.IsEmpty">
- <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlQualifiedName" /> is empty.</summary>
- <returns>
- <see langword="true" /> if name and namespace are empty strings; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlQualifiedName.Name">
- <summary>Gets a string representation of the qualified name of the <see cref="T:System.Xml.XmlQualifiedName" />.</summary>
- <returns>A string representation of the qualified name or String.Empty if a name is not defined for the object.</returns>
- </member>
- <member name="P:System.Xml.XmlQualifiedName.Namespace">
- <summary>Gets a string representation of the namespace of the <see cref="T:System.Xml.XmlQualifiedName" />.</summary>
- <returns>A string representation of the namespace or String.Empty if a namespace is not defined for the object.</returns>
- </member>
<member name="T:System.Xml.XmlReader">
<summary>Represents a reader that provides fast, noncached, forward-only access to XML data.</summary>
</member>
<member name="M:System.Xml.XmlReader.#ctor">
<summary>Initializes a new instance of the <see langword="XmlReader" /> class.</summary>
</member>
+ <member name="P:System.Xml.XmlReader.AttributeCount">
+ <summary>When overridden in a derived class, gets the number of attributes on the current node.</summary>
+ <returns>The number of attributes on the current node.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.BaseURI">
+ <summary>When overridden in a derived class, gets the base URI of the current node.</summary>
+ <returns>The base URI of the current node.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.CanReadBinaryContent">
+ <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlReader" /> implements the binary content read methods.</summary>
+ <returns>
+ <see langword="true" /> if the binary content read methods are implemented; otherwise <see langword="false" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.CanReadValueChunk">
+ <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlReader" /> implements the <see cref="M:System.Xml.XmlReader.ReadValueChunk(System.Char[],System.Int32,System.Int32)" /> method.</summary>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Xml.XmlReader" /> implements the <see cref="M:System.Xml.XmlReader.ReadValueChunk(System.Char[],System.Int32,System.Int32)" /> method; otherwise <see langword="false" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.CanResolveEntity">
+ <summary>Gets a value indicating whether this reader can parse and resolve entities.</summary>
+ <returns>
+ <see langword="true" /> if the reader can parse and resolve entities; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
<member name="M:System.Xml.XmlReader.Close">
<summary>When overridden in a derived class, changes the <see cref="P:System.Xml.XmlReader.ReadState" /> to <see cref="F:System.Xml.ReadState.Closed" />.</summary>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.Create(System.IO.Stream)">
<summary>Creates a new <see cref="T:System.Xml.XmlReader" /> instance using the specified stream with default settings.</summary>
- <param name="input">The stream that contains the XML data.
-
- The <see cref="T:System.Xml.XmlReader" /> scans the first bytes of the stream looking for a byte order mark or other sign of encoding. When encoding is determined, the encoding is used to continue reading the stream, and processing continues parsing the input as a stream of (Unicode) characters.</param>
+ <param name="input">The stream that contains the XML data.
+The <see cref="T:System.Xml.XmlReader" /> scans the first bytes of the stream looking for a byte order mark or other sign of encoding. When encoding is determined, the encoding is used to continue reading the stream, and processing continues parsing the input as a stream of (Unicode) characters.</param>
+ <returns>An object that is used to read the XML data in the stream.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Security.SecurityException">The <see cref="T:System.Xml.XmlReader" /> does not have sufficient permissions to access the location of the XML data.</exception>
- <returns>An object that is used to read the XML data in the stream.</returns>
</member>
<member name="M:System.Xml.XmlReader.Create(System.IO.Stream,System.Xml.XmlReaderSettings)">
<summary>Creates a new <see cref="T:System.Xml.XmlReader" /> instance with the specified stream and settings.</summary>
- <param name="input">The stream that contains the XML data.
-
- The <see cref="T:System.Xml.XmlReader" /> scans the first bytes of the stream looking for a byte order mark or other sign of encoding. When encoding is determined, the encoding is used to continue reading the stream, and processing continues parsing the input as a stream of (Unicode) characters.</param>
+ <param name="input">The stream that contains the XML data.
+The <see cref="T:System.Xml.XmlReader" /> scans the first bytes of the stream looking for a byte order mark or other sign of encoding. When encoding is determined, the encoding is used to continue reading the stream, and processing continues parsing the input as a stream of (Unicode) characters.</param>
<param name="settings">The settings for the new <see cref="T:System.Xml.XmlReader" /> instance. This value can be <see langword="null" />.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
<returns>An object that is used to read the XML data in the stream.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlReader.Create(System.IO.Stream,System.Xml.XmlReaderSettings,System.String)">
<summary>Creates a new <see cref="T:System.Xml.XmlReader" /> instance using the specified stream, base URI, and settings.</summary>
- <param name="input">The stream that contains the XML data.
-
- The <see cref="T:System.Xml.XmlReader" /> scans the first bytes of the stream looking for a byte order mark or other sign of encoding. When encoding is determined, the encoding is used to continue reading the stream, and processing continues parsing the input as a stream of (Unicode) characters.</param>
+ <param name="input">The stream that contains the XML data.
+The <see cref="T:System.Xml.XmlReader" /> scans the first bytes of the stream looking for a byte order mark or other sign of encoding. When encoding is determined, the encoding is used to continue reading the stream, and processing continues parsing the input as a stream of (Unicode) characters.</param>
<param name="settings">The settings for the new <see cref="T:System.Xml.XmlReader" /> instance. This value can be <see langword="null" />.</param>
- <param name="baseUri">The base URI for the entity or document being read. This value can be <see langword="null" />.
-
- Security Note The base URI is used to resolve the relative URI of the XML document. Do not use a base URI from an untrusted source.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
+ <param name="baseUri">The base URI for the entity or document being read. This value can be <see langword="null" />.
+Security Note The base URI is used to resolve the relative URI of the XML document. Do not use a base URI from an untrusted source.</param>
<returns>An object that is used to read the XML data in the stream.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlReader.Create(System.IO.Stream,System.Xml.XmlReaderSettings,System.Xml.XmlParserContext)">
<summary>Creates a new <see cref="T:System.Xml.XmlReader" /> instance using the specified stream, settings, and context information for parsing.</summary>
- <param name="input">The stream that contains the XML data.
-
- The <see cref="T:System.Xml.XmlReader" /> scans the first bytes of the stream looking for a byte order mark or other sign of encoding. When encoding is determined, the encoding is used to continue reading the stream, and processing continues parsing the input as a stream of (Unicode) characters.</param>
+ <param name="input">The stream that contains the XML data.
+The <see cref="T:System.Xml.XmlReader" /> scans the first bytes of the stream looking for a byte order mark or other sign of encoding. When encoding is determined, the encoding is used to continue reading the stream, and processing continues parsing the input as a stream of (Unicode) characters.</param>
<param name="settings">The settings for the new <see cref="T:System.Xml.XmlReader" /> instance. This value can be <see langword="null" />.</param>
- <param name="inputContext">The context information required to parse the XML fragment. The context information can include the <see cref="T:System.Xml.XmlNameTable" /> to use, encoding, namespace scope, the current <c>xml:lang</c> and <c>xml:space</c> scope, base URI, and document type definition.
-
- This value can be <see langword="null" />.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
+ <param name="inputContext">The context information required to parse the XML fragment. The context information can include the <see cref="T:System.Xml.XmlNameTable" /> to use, encoding, namespace scope, the current <c>xml:lang</c> and <c>xml:space</c> scope, base URI, and document type definition.
+This value can be <see langword="null" />.</param>
<returns>An object that is used to read the XML data in the stream.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlReader.Create(System.IO.TextReader)">
<summary>Creates a new <see cref="T:System.Xml.XmlReader" /> instance by using the specified text reader.</summary>
<param name="input">The text reader from which to read the XML data. A text reader returns a stream of Unicode characters, so the encoding specified in the XML declaration is not used by the XML reader to decode the data stream.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
<returns>An object that is used to read the XML data in the stream.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlReader.Create(System.IO.TextReader,System.Xml.XmlReaderSettings)">
<summary>Creates a new <see cref="T:System.Xml.XmlReader" /> instance by using the specified text reader and settings.</summary>
<param name="input">The text reader from which to read the XML data. A text reader returns a stream of Unicode characters, so the encoding specified in the XML declaration isn't used by the XML reader to decode the data stream.</param>
<param name="settings">The settings for the new <see cref="T:System.Xml.XmlReader" />. This value can be <see langword="null" />.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
<returns>An object that is used to read the XML data in the stream.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlReader.Create(System.IO.TextReader,System.Xml.XmlReaderSettings,System.String)">
<summary>Creates a new <see cref="T:System.Xml.XmlReader" /> instance by using the specified text reader, settings, and base URI.</summary>
<param name="input">The text reader from which to read the XML data. A text reader returns a stream of Unicode characters, so the encoding specified in the XML declaration isn't used by the <see cref="T:System.Xml.XmlReader" /> to decode the data stream.</param>
<param name="settings">The settings for the new <see cref="T:System.Xml.XmlReader" /> instance. This value can be <see langword="null" />.</param>
- <param name="baseUri">The base URI for the entity or document being read. This value can be <see langword="null" />.
-
- Security Note The base URI is used to resolve the relative URI of the XML document. Do not use a base URI from an untrusted source.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
+ <param name="baseUri">The base URI for the entity or document being read. This value can be <see langword="null" />.
+Security Note The base URI is used to resolve the relative URI of the XML document. Do not use a base URI from an untrusted source.</param>
<returns>An object that is used to read the XML data in the stream.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlReader.Create(System.IO.TextReader,System.Xml.XmlReaderSettings,System.Xml.XmlParserContext)">
<summary>Creates a new <see cref="T:System.Xml.XmlReader" /> instance by using the specified text reader, settings, and context information for parsing.</summary>
<param name="input">The text reader from which to read the XML data. A text reader returns a stream of Unicode characters, so the encoding specified in the XML declaration isn't used by the XML reader to decode the data stream.</param>
<param name="settings">The settings for the new <see cref="T:System.Xml.XmlReader" /> instance. This value can be <see langword="null" />.</param>
- <param name="inputContext">The context information required to parse the XML fragment. The context information can include the <see cref="T:System.Xml.XmlNameTable" /> to use, encoding, namespace scope, the current <c>xml:lang</c> and <c>xml:space</c> scope, base URI, and document type definition.
-
- This value can be <see langword="null" />.</param>
+ <param name="inputContext">The context information required to parse the XML fragment. The context information can include the <see cref="T:System.Xml.XmlNameTable" /> to use, encoding, namespace scope, the current <c>xml:lang</c> and <c>xml:space</c> scope, base URI, and document type definition.
+This value can be <see langword="null" />.</param>
+ <returns>An object that is used to read the XML data in the stream.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="input" /> value is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.Xml.XmlReaderSettings.NameTable" /> and <see cref="P:System.Xml.XmlParserContext.NameTable" /> properties both contain values. (Only one of these <see langword="NameTable" /> properties can be set and used).</exception>
- <returns>An object that is used to read the XML data in the stream.</returns>
</member>
<member name="M:System.Xml.XmlReader.Create(System.String)">
<summary>Creates a new <see cref="T:System.Xml.XmlReader" /> instance with specified URI.</summary>
<param name="inputUri">The URI for the file that contains the XML data. The <see cref="T:System.Xml.XmlUrlResolver" /> class is used to convert the path to a canonical data representation.</param>
+ <returns>An object that is used to read the XML data in the stream.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="inputUri" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Security.SecurityException">The <see cref="T:System.Xml.XmlReader" /> does not have sufficient permissions to access the location of the XML data.</exception>
<exception cref="T:System.IO.FileNotFoundException">The file identified by the URI does not exist.</exception>
- <exception cref="T:System.UriFormatException">The URI format is not correct.
+ <exception cref="T:System.UriFormatException">In the .NET for Windows Store apps or the Portable Class Library, catch the base class exception, <see cref="T:System.FormatException" />, instead.
+
-Note: In .NET for Windows Store apps or the Portable Class Library, catch the base class exception, <see cref="T:System.FormatException" />, instead.</exception>
- <returns>An object that is used to read the XML data in the stream.</returns>
+
+
+ The URI format is not correct.</exception>
</member>
<member name="M:System.Xml.XmlReader.Create(System.String,System.Xml.XmlReaderSettings)">
<summary>Creates a new <see cref="T:System.Xml.XmlReader" /> instance by using the specified URI and settings.</summary>
<param name="inputUri">The URI for the file containing the XML data. The <see cref="T:System.Xml.XmlResolver" /> object on the <see cref="T:System.Xml.XmlReaderSettings" /> object is used to convert the path to a canonical data representation. If <see cref="P:System.Xml.XmlReaderSettings.XmlResolver" /> is <see langword="null" />, a new <see cref="T:System.Xml.XmlUrlResolver" /> object is used.</param>
<param name="settings">The settings for the new <see cref="T:System.Xml.XmlReader" /> instance. This value can be <see langword="null" />.</param>
+ <returns>An object that is used to read the XML data in the stream.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="inputUri" /> value is <see langword="null" />.</exception>
<exception cref="T:System.IO.FileNotFoundException">The file specified by the URI cannot be found.</exception>
- <exception cref="T:System.UriFormatException">The URI format is not correct.
+ <exception cref="T:System.UriFormatException">In the .NET for Windows Store apps or the Portable Class Library, catch the base class exception, <see cref="T:System.FormatException" />, instead.
+
-Note: In .NET for Windows Store apps or the Portable Class Library, catch the base class exception, <see cref="T:System.FormatException" />, instead.</exception>
- <returns>An object that is used to read the XML data in the stream.</returns>
+
+
+ The URI format is not correct.</exception>
</member>
<member name="M:System.Xml.XmlReader.Create(System.String,System.Xml.XmlReaderSettings,System.Xml.XmlParserContext)">
<summary>Creates a new <see cref="T:System.Xml.XmlReader" /> instance by using the specified URI, settings, and context information for parsing.</summary>
<param name="inputUri">The URI for the file containing the XML data. The <see cref="T:System.Xml.XmlResolver" /> object on the <see cref="T:System.Xml.XmlReaderSettings" /> object is used to convert the path to a canonical data representation. If <see cref="P:System.Xml.XmlReaderSettings.XmlResolver" /> is <see langword="null" />, a new <see cref="T:System.Xml.XmlUrlResolver" /> object is used.</param>
<param name="settings">The settings for the new <see cref="T:System.Xml.XmlReader" /> instance. This value can be <see langword="null" />.</param>
- <param name="inputContext">The context information required to parse the XML fragment. The context information can include the <see cref="T:System.Xml.XmlNameTable" /> to use, encoding, namespace scope, the current <c>xml:lang</c> and <c>xml:space</c> scope, base URI, and document type definition.
-
- This value can be <see langword="null" />.</param>
+ <param name="inputContext">The context information required to parse the XML fragment. The context information can include the <see cref="T:System.Xml.XmlNameTable" /> to use, encoding, namespace scope, the current <c>xml:lang</c> and <c>xml:space</c> scope, base URI, and document type definition.
+This value can be <see langword="null" />.</param>
+ <returns>An object that is used to read the XML data in the stream.</returns>
<exception cref="T:System.ArgumentNullException">The <see langword="inputUri" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Security.SecurityException">The <see cref="T:System.Xml.XmlReader" /> does not have sufficient permissions to access the location of the XML data.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.Xml.XmlReaderSettings.NameTable" /> and <see cref="P:System.Xml.XmlParserContext.NameTable" /> properties both contain values. (Only one of these <see langword="NameTable" /> properties can be set and used).</exception>
<exception cref="T:System.IO.FileNotFoundException">The file specified by the URI cannot be found.</exception>
<exception cref="T:System.UriFormatException">The URI format is not correct.</exception>
- <returns>An object that is used to read the XML data in the stream.</returns>
</member>
<member name="M:System.Xml.XmlReader.Create(System.Xml.XmlReader,System.Xml.XmlReaderSettings)">
<summary>Creates a new <see cref="T:System.Xml.XmlReader" /> instance by using the specified XML reader and settings.</summary>
<param name="reader">The object that you want to use as the underlying XML reader.</param>
- <param name="settings">The settings for the new <see cref="T:System.Xml.XmlReader" /> instance.
-
- The conformance level of the <see cref="T:System.Xml.XmlReaderSettings" /> object must either match the conformance level of the underlying reader, or it must be set to <see cref="F:System.Xml.ConformanceLevel.Auto" />.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="reader" /> value is <see langword="null" />.</exception>
- <exception cref="T:System.InvalidOperationException">If the <see cref="T:System.Xml.XmlReaderSettings" /> object specifies a conformance level that is not consistent with conformance level of the underlying reader.
-
- -or-
-
- The underlying <see cref="T:System.Xml.XmlReader" /> is in an <see cref="F:System.Xml.ReadState.Error" /> or <see cref="F:System.Xml.ReadState.Closed" /> state.</exception>
+ <param name="settings">The settings for the new <see cref="T:System.Xml.XmlReader" /> instance.
+The conformance level of the <see cref="T:System.Xml.XmlReaderSettings" /> object must either match the conformance level of the underlying reader, or it must be set to <see cref="F:System.Xml.ConformanceLevel.Auto" />.</param>
<returns>An object that is wrapped around the specified <see cref="T:System.Xml.XmlReader" /> object.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="reader" /> value is <see langword="null" />.</exception>
+ <exception cref="T:System.InvalidOperationException">If the <see cref="T:System.Xml.XmlReaderSettings" /> object specifies a conformance level that is not consistent with conformance level of the underlying reader.
+-or-
+The underlying <see cref="T:System.Xml.XmlReader" /> is in an <see cref="F:System.Xml.ReadState.Error" /> or <see cref="F:System.Xml.ReadState.Closed" /> state.</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.Depth">
+ <summary>When overridden in a derived class, gets the depth of the current node in the XML document.</summary>
+ <returns>The depth of the current node in the XML document.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.Dispose">
<summary>Releases all resources used by the current instance of the <see cref="T:System.Xml.XmlReader" /> class.</summary>
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
+ <member name="P:System.Xml.XmlReader.EOF">
+ <summary>When overridden in a derived class, gets a value indicating whether the reader is positioned at the end of the stream.</summary>
+ <returns>
+ <see langword="true" /> if the reader is positioned at the end of the stream; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
<member name="M:System.Xml.XmlReader.GetAttribute(System.Int32)">
<summary>When overridden in a derived class, gets the value of the attribute with the specified index.</summary>
<param name="i">The index of the attribute. The index is zero-based. (The first attribute has index 0.)</param>
+ <returns>The value of the specified attribute. This method does not move the reader.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="i" /> is out of range. It must be non-negative and less than the size of the attribute collection.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The value of the specified attribute. This method does not move the reader.</returns>
</member>
<member name="M:System.Xml.XmlReader.GetAttribute(System.String)">
<summary>When overridden in a derived class, gets the value of the attribute with the specified <see cref="P:System.Xml.XmlReader.Name" />.</summary>
<param name="name">The qualified name of the attribute.</param>
+ <returns>The value of the specified attribute. If the attribute is not found or the value is <see langword="String.Empty" />, <see langword="null" /> is returned.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The value of the specified attribute. If the attribute is not found or the value is <see langword="String.Empty" />, <see langword="null" /> is returned.</returns>
</member>
<member name="M:System.Xml.XmlReader.GetAttribute(System.String,System.String)">
<summary>When overridden in a derived class, gets the value of the attribute with the specified <see cref="P:System.Xml.XmlReader.LocalName" /> and <see cref="P:System.Xml.XmlReader.NamespaceURI" />.</summary>
<param name="name">The local name of the attribute.</param>
<param name="namespaceURI">The namespace URI of the attribute.</param>
+ <returns>The value of the specified attribute. If the attribute is not found or the value is <see langword="String.Empty" />, <see langword="null" /> is returned. This method does not move the reader.</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The value of the specified attribute. If the attribute is not found or the value is <see langword="String.Empty" />, <see langword="null" /> is returned. This method does not move the reader.</returns>
</member>
<member name="M:System.Xml.XmlReader.GetValueAsync">
<summary>Asynchronously gets the value of the current node.</summary>
+ <returns>The value of the current node.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress".
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The value of the current node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlReader.HasAttributes">
+ <summary>Gets a value indicating whether the current node has any attributes.</summary>
+ <returns>
+ <see langword="true" /> if the current node has attributes; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.HasValue">
+ <summary>When overridden in a derived class, gets a value indicating whether the current node can have a <see cref="P:System.Xml.XmlReader.Value" />.</summary>
+ <returns>
+ <see langword="true" /> if the node on which the reader is currently positioned can have a <see langword="Value" />; otherwise, <see langword="false" />. If <see langword="false" />, the node has a value of <see langword="String.Empty" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.IsDefault">
+ <summary>When overridden in a derived class, gets a value indicating whether the current node is an attribute that was generated from the default value defined in the DTD or schema.</summary>
+ <returns>
+ <see langword="true" /> if the current node is an attribute whose value was generated from the default value defined in the DTD or schema; <see langword="false" /> if the attribute value was explicitly set.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.IsEmptyElement">
+ <summary>When overridden in a derived class, gets a value indicating whether the current node is an empty element (for example, <c><MyElement/></c>).</summary>
+ <returns>
+ <see langword="true" /> if the current node is an element (<see cref="P:System.Xml.XmlReader.NodeType" /> equals <see langword="XmlNodeType.Element" />) that ends with <c>/></c>; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.IsName(System.String)">
<summary>Returns a value indicating whether the string argument is a valid XML name.</summary>
<param name="str">The name to validate.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="str" /> value is <see langword="null" />.</exception>
<returns>
<see langword="true" /> if the name is valid; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="str" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlReader.IsNameToken(System.String)">
<summary>Returns a value indicating whether or not the string argument is a valid XML name token.</summary>
<param name="str">The name token to validate.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="str" /> value is <see langword="null" />.</exception>
<returns>
<see langword="true" /> if it is a valid name token; otherwise <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="str" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlReader.IsStartElement">
<summary>Calls <see cref="M:System.Xml.XmlReader.MoveToContent" /> and tests if the current content node is a start tag or empty element tag.</summary>
- <exception cref="T:System.Xml.XmlException">Incorrect XML is encountered in the input stream.</exception>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>
<see langword="true" /> if <see cref="M:System.Xml.XmlReader.MoveToContent" /> finds a start tag or empty element tag; <see langword="false" /> if a node type other than <see langword="XmlNodeType.Element" /> was found.</returns>
+ <exception cref="T:System.Xml.XmlException">Incorrect XML is encountered in the input stream.</exception>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.IsStartElement(System.String)">
<summary>Calls <see cref="M:System.Xml.XmlReader.MoveToContent" /> and tests if the current content node is a start tag or empty element tag and if the <see cref="P:System.Xml.XmlReader.Name" /> property of the element found matches the given argument.</summary>
<param name="name">The string matched against the <see langword="Name" /> property of the element found.</param>
- <exception cref="T:System.Xml.XmlException">Incorrect XML is encountered in the input stream.</exception>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>
<see langword="true" /> if the resulting node is an element and the <see langword="Name" /> property matches the specified string. <see langword="false" /> if a node type other than <see langword="XmlNodeType.Element" /> was found or if the element <see langword="Name" /> property does not match the specified string.</returns>
+ <exception cref="T:System.Xml.XmlException">Incorrect XML is encountered in the input stream.</exception>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.IsStartElement(System.String,System.String)">
<summary>Calls <see cref="M:System.Xml.XmlReader.MoveToContent" /> and tests if the current content node is a start tag or empty element tag and if the <see cref="P:System.Xml.XmlReader.LocalName" /> and <see cref="P:System.Xml.XmlReader.NamespaceURI" /> properties of the element found match the given strings.</summary>
<param name="localname">The string to match against the <see langword="LocalName" /> property of the element found.</param>
<param name="ns">The string to match against the <see langword="NamespaceURI" /> property of the element found.</param>
- <exception cref="T:System.Xml.XmlException">Incorrect XML is encountered in the input stream.</exception>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>
<see langword="true" /> if the resulting node is an element. <see langword="false" /> if a node type other than <see langword="XmlNodeType.Element" /> was found or if the <see langword="LocalName" /> and <see langword="NamespaceURI" /> properties of the element do not match the specified strings.</returns>
+ <exception cref="T:System.Xml.XmlException">Incorrect XML is encountered in the input stream.</exception>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.Item(System.Int32)">
+ <summary>When overridden in a derived class, gets the value of the attribute with the specified index.</summary>
+ <param name="i">The index of the attribute.</param>
+ <returns>The value of the specified attribute.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.Item(System.String)">
+ <summary>When overridden in a derived class, gets the value of the attribute with the specified <see cref="P:System.Xml.XmlReader.Name" />.</summary>
+ <param name="name">The qualified name of the attribute.</param>
+ <returns>The value of the specified attribute. If the attribute is not found, <see langword="null" /> is returned.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.Item(System.String,System.String)">
+ <summary>When overridden in a derived class, gets the value of the attribute with the specified <see cref="P:System.Xml.XmlReader.LocalName" /> and <see cref="P:System.Xml.XmlReader.NamespaceURI" />.</summary>
+ <param name="name">The local name of the attribute.</param>
+ <param name="namespaceURI">The namespace URI of the attribute.</param>
+ <returns>The value of the specified attribute. If the attribute is not found, <see langword="null" /> is returned.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.LocalName">
+ <summary>When overridden in a derived class, gets the local name of the current node.</summary>
+ <returns>The name of the current node with the prefix removed. For example, <see langword="LocalName" /> is <see langword="book" /> for the element <c><bk:book></c>.
+For node types that do not have a name (like <see langword="Text" />, <see langword="Comment" />, and so on), this property returns <see langword="String.Empty" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.LookupNamespace(System.String)">
<summary>When overridden in a derived class, resolves a namespace prefix in the current element's scope.</summary>
<param name="prefix">The prefix whose namespace URI you want to resolve. To match the default namespace, pass an empty string.</param>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>The namespace URI to which the prefix maps or <see langword="null" /> if no matching prefix is found.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.MoveToAttribute(System.Int32)">
<summary>When overridden in a derived class, moves to the attribute with the specified index.</summary>
<member name="M:System.Xml.XmlReader.MoveToAttribute(System.String)">
<summary>When overridden in a derived class, moves to the attribute with the specified <see cref="P:System.Xml.XmlReader.Name" />.</summary>
<param name="name">The qualified name of the attribute.</param>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.ArgumentException">The parameter is an empty string.</exception>
<returns>
<see langword="true" /> if the attribute is found; otherwise, <see langword="false" />. If <see langword="false" />, the reader's position does not change.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ <exception cref="T:System.ArgumentException">The parameter is an empty string.</exception>
</member>
<member name="M:System.Xml.XmlReader.MoveToAttribute(System.String,System.String)">
<summary>When overridden in a derived class, moves to the attribute with the specified <see cref="P:System.Xml.XmlReader.LocalName" /> and <see cref="P:System.Xml.XmlReader.NamespaceURI" />.</summary>
<param name="name">The local name of the attribute.</param>
<param name="ns">The namespace URI of the attribute.</param>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.ArgumentNullException">Both parameter values are <see langword="null" />.</exception>
<returns>
<see langword="true" /> if the attribute is found; otherwise, <see langword="false" />. If <see langword="false" />, the reader's position does not change.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ <exception cref="T:System.ArgumentNullException">Both parameter values are <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlReader.MoveToContent">
<summary>Checks whether the current node is a content (non-white space text, <see langword="CDATA" />, <see langword="Element" />, <see langword="EndElement" />, <see langword="EntityReference" />, or <see langword="EndEntity" />) node. If the node is not a content node, the reader skips ahead to the next content node or end of file. It skips over nodes of the following type: <see langword="ProcessingInstruction" />, <see langword="DocumentType" />, <see langword="Comment" />, <see langword="Whitespace" />, or <see langword="SignificantWhitespace" />.</summary>
+ <returns>The <see cref="P:System.Xml.XmlReader.NodeType" /> of the current node found by the method or <see langword="XmlNodeType.None" /> if the reader has reached the end of the input stream.</returns>
<exception cref="T:System.Xml.XmlException">Incorrect XML encountered in the input stream.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The <see cref="P:System.Xml.XmlReader.NodeType" /> of the current node found by the method or <see langword="XmlNodeType.None" /> if the reader has reached the end of the input stream.</returns>
</member>
<member name="M:System.Xml.XmlReader.MoveToContentAsync">
<summary>Asynchronously checks whether the current node is a content node. If the node is not a content node, the reader skips ahead to the next content node or end of file.</summary>
+ <returns>The <see cref="P:System.Xml.XmlReader.NodeType" /> of the current node found by the method or <see langword="XmlNodeType.None" /> if the reader has reached the end of the input stream.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The <see cref="P:System.Xml.XmlReader.NodeType" /> of the current node found by the method or <see langword="XmlNodeType.None" /> if the reader has reached the end of the input stream.</returns>
</member>
<member name="M:System.Xml.XmlReader.MoveToElement">
<summary>When overridden in a derived class, moves to the element that contains the current attribute node.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>
<see langword="true" /> if the reader is positioned on an attribute (the reader moves to the element that owns the attribute); <see langword="false" /> if the reader is not positioned on an attribute (the position of the reader does not change).</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.MoveToFirstAttribute">
<summary>When overridden in a derived class, moves to the first attribute.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>
<see langword="true" /> if an attribute exists (the reader moves to the first attribute); otherwise, <see langword="false" /> (the position of the reader does not change).</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.MoveToNextAttribute">
<summary>When overridden in a derived class, moves to the next attribute.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>
<see langword="true" /> if there is a next attribute; <see langword="false" /> if there are no more attributes.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.Name">
+ <summary>When overridden in a derived class, gets the qualified name of the current node.</summary>
+ <returns>The qualified name of the current node. For example, <see langword="Name" /> is <see langword="bk:book" /> for the element <c><bk:book></c>.
+The name returned is dependent on the <see cref="P:System.Xml.XmlReader.NodeType" /> of the node. The following node types return the listed values. All other node types return an empty string.
+ Node type
+
+ Name
+
+ <see langword="Attribute" /> The name of the attribute.
+
+ <see langword="DocumentType" /> The document type name.
+
+ <see langword="Element" /> The tag name.
+
+ <see langword="EntityReference" /> The name of the entity referenced.
+
+ <see langword="ProcessingInstruction" /> The target of the processing instruction.
+
+ <see langword="XmlDeclaration" /> The literal string <see langword="xml" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.NamespaceURI">
+ <summary>When overridden in a derived class, gets the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned.</summary>
+ <returns>The namespace URI of the current node; otherwise an empty string.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.NameTable">
+ <summary>When overridden in a derived class, gets the <see cref="T:System.Xml.XmlNameTable" /> associated with this implementation.</summary>
+ <returns>The <see langword="XmlNameTable" /> enabling you to get the atomized version of a string within the node.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.NodeType">
+ <summary>When overridden in a derived class, gets the type of the current node.</summary>
+ <returns>One of the enumeration values that specify the type of the current node.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.Prefix">
+ <summary>When overridden in a derived class, gets the namespace prefix associated with the current node.</summary>
+ <returns>The namespace prefix associated with the current node.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.QuoteChar">
+ <summary>When overridden in a derived class, gets the quotation mark character used to enclose the value of an attribute node.</summary>
+ <returns>The quotation mark character (" or ') used to enclose the value of an attribute node.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.Read">
<summary>When overridden in a derived class, reads the next node from the stream.</summary>
- <exception cref="T:System.Xml.XmlException">An error occurred while parsing the XML.</exception>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>
<see langword="true" /> if the next node was read successfully; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.Xml.XmlException">An error occurred while parsing the XML.</exception>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.ReadAsync">
<summary>Asynchronously reads the next node from the stream.</summary>
+ <returns>
+ <see langword="true" /> if the next node was read successfully; <see langword="false" /> if there are no more nodes to read.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>
- <see langword="true" /> if the next node was read successfully; <see langword="false" /> if there are no more nodes to read.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadAttributeValue">
<summary>When overridden in a derived class, parses the attribute value into one or more <see langword="Text" />, <see langword="EntityReference" />, or <see langword="EndEntity" /> nodes.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>
- <see langword="true" /> if there are nodes to return.
-
- <see langword="false" /> if the reader is not positioned on an attribute node when the initial call is made or if all the attribute values have been read.
-
- An empty attribute, such as, <c>misc=""</c>, returns <see langword="true" /> with a single node with a value of <see langword="String.Empty" />.</returns>
+ <see langword="true" /> if there are nodes to return.
+<see langword="false" /> if the reader is not positioned on an attribute node when the initial call is made or if all the attribute values have been read.
+An empty attribute, such as, <c>misc=""</c>, returns <see langword="true" /> with a single node with a value of <see langword="String.Empty" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAs(System.Type,System.Xml.IXmlNamespaceResolver)">
<summary>Reads the content as an object of the type specified.</summary>
- <param name="returnType">The type of the value to be returned.
-
- Note With the release of the .NET Framework 3.5, the value of the <paramref name="returnType" /> parameter can now be the <see cref="T:System.DateTimeOffset" /> type.</param>
- <param name="namespaceResolver">An <see cref="T:System.Xml.IXmlNamespaceResolver" /> object that is used to resolve any namespace prefixes related to type conversion. For example, this can be used when converting an <see cref="T:System.Xml.XmlQualifiedName" /> object to an <c>xs:string</c>.
-
- This value can be <see langword="null" />.</param>
+ <param name="returnType">The type of the value to be returned.
+Note With the release of the .NET Framework 3.5, the value of the <paramref name="returnType" /> parameter can now be the <see cref="T:System.DateTimeOffset" /> type.</param>
+ <param name="namespaceResolver">An <see cref="T:System.Xml.IXmlNamespaceResolver" /> object that is used to resolve any namespace prefixes related to type conversion. For example, this can be used when converting an <see cref="T:System.Xml.XmlQualifiedName" /> object to an <c>xs:string</c>.
+This value can be <see langword="null" />.</param>
+ <returns>The concatenated text content or attribute value converted to the requested type.</returns>
<exception cref="T:System.FormatException">The content is not in the correct format for the target type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="returnType" /> value is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The current node is not a supported node type. See the table below for details.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.OverflowException">Read <see langword="Decimal.MaxValue" />.</exception>
- <returns>The concatenated text content or attribute value converted to the requested type.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsAsync(System.Type,System.Xml.IXmlNamespaceResolver)">
<summary>Asynchronously reads the content as an object of the type specified.</summary>
<param name="returnType">The type of the value to be returned.</param>
<param name="namespaceResolver">An <see cref="T:System.Xml.IXmlNamespaceResolver" /> object that is used to resolve any namespace prefixes related to type conversion.</param>
+ <returns>The concatenated text content or attribute value converted to the requested type.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The concatenated text content or attribute value converted to the requested type.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsBase64(System.Byte[],System.Int32,System.Int32)">
<summary>Reads the content and returns the Base64 decoded binary bytes.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="M:System.Xml.XmlReader.ReadContentAsBase64(System.Byte[],System.Int32,System.Int32)" /> is not supported on the current node.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlReader" /> implementation does not support this method.</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsBase64Async(System.Byte[],System.Int32,System.Int32)">
<summary>Asynchronously reads the content and returns the Base64 decoded binary bytes.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsBinHex(System.Byte[],System.Int32,System.Int32)">
<summary>Reads the content and returns the <see langword="BinHex" /> decoded binary bytes.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="M:System.Xml.XmlReader.ReadContentAsBinHex(System.Byte[],System.Int32,System.Int32)" /> is not supported on the current node.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlReader" /> implementation does not support this method.</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsBinHexAsync(System.Byte[],System.Int32,System.Int32)">
<summary>Asynchronously reads the content and returns the <see langword="BinHex" /> decoded binary bytes.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsBoolean">
<summary>Reads the text content at the current position as a <see langword="Boolean" />.</summary>
+ <returns>The text content as a <see cref="T:System.Boolean" /> object.</returns>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.FormatException">The string format is not valid.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The text content as a <see cref="T:System.Boolean" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsDateTime">
<summary>Reads the text content at the current position as a <see cref="T:System.DateTime" /> object.</summary>
+ <returns>The text content as a <see cref="T:System.DateTime" /> object.</returns>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.FormatException">The string format is not valid.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The text content as a <see cref="T:System.DateTime" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsDateTimeOffset">
<summary>Reads the text content at the current position as a <see cref="T:System.DateTimeOffset" /> object.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>The text content as a <see cref="T:System.DateTimeOffset" /> object.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsDecimal">
<summary>Reads the text content at the current position as a <see cref="T:System.Decimal" /> object.</summary>
+ <returns>The text content at the current position as a <see cref="T:System.Decimal" /> object.</returns>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.FormatException">The string format is not valid.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The text content at the current position as a <see cref="T:System.Decimal" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsDouble">
<summary>Reads the text content at the current position as a double-precision floating-point number.</summary>
+ <returns>The text content as a double-precision floating-point number.</returns>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.FormatException">The string format is not valid.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The text content as a double-precision floating-point number.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsFloat">
<summary>Reads the text content at the current position as a single-precision floating point number.</summary>
+ <returns>The text content at the current position as a single-precision floating point number.</returns>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.FormatException">The string format is not valid.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The text content at the current position as a single-precision floating point number.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsInt">
<summary>Reads the text content at the current position as a 32-bit signed integer.</summary>
+ <returns>The text content as a 32-bit signed integer.</returns>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.FormatException">The string format is not valid.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The text content as a 32-bit signed integer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsLong">
<summary>Reads the text content at the current position as a 64-bit signed integer.</summary>
+ <returns>The text content as a 64-bit signed integer.</returns>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.FormatException">The string format is not valid.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The text content as a 64-bit signed integer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsObject">
<summary>Reads the text content at the current position as an <see cref="T:System.Object" />.</summary>
+ <returns>The text content as the most appropriate common language runtime (CLR) object.</returns>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.FormatException">The string format is not valid.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The text content as the most appropriate common language runtime (CLR) object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsObjectAsync">
<summary>Asynchronously reads the text content at the current position as an <see cref="T:System.Object" />.</summary>
+ <returns>The text content as the most appropriate common language runtime (CLR) object.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The text content as the most appropriate common language runtime (CLR) object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsString">
<summary>Reads the text content at the current position as a <see cref="T:System.String" /> object.</summary>
+ <returns>The text content as a <see cref="T:System.String" /> object.</returns>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.FormatException">The string format is not valid.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The text content as a <see cref="T:System.String" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadContentAsStringAsync">
<summary>Asynchronously reads the text content at the current position as a <see cref="T:System.String" /> object.</summary>
+ <returns>The text content as a <see cref="T:System.String" /> object.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The text content as a <see cref="T:System.String" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAs(System.Type,System.Xml.IXmlNamespaceResolver)">
<summary>Reads the element content as the requested type.</summary>
- <param name="returnType">The type of the value to be returned.
-
- Note With the release of the .NET Framework 3.5, the value of the <paramref name="returnType" /> parameter can now be the <see cref="T:System.DateTimeOffset" /> type.</param>
+ <param name="returnType">The type of the value to be returned.
+Note With the release of the .NET Framework 3.5, the value of the <paramref name="returnType" /> parameter can now be the <see cref="T:System.DateTimeOffset" /> type.</param>
<param name="namespaceResolver">An <see cref="T:System.Xml.IXmlNamespaceResolver" /> object that is used to resolve any namespace prefixes related to type conversion.</param>
+ <returns>The element content converted to the requested typed object.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to the requested type.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to the requested type.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
<exception cref="T:System.OverflowException">Read <see langword="Decimal.MaxValue" />.</exception>
- <returns>The element content converted to the requested typed object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAs(System.Type,System.Xml.IXmlNamespaceResolver,System.String,System.String)">
<summary>Checks that the specified local name and namespace URI matches that of the current element, then reads the element content as the requested type.</summary>
- <param name="returnType">The type of the value to be returned.
-
- Note With the release of the .NET Framework 3.5, the value of the <paramref name="returnType" /> parameter can now be the <see cref="T:System.DateTimeOffset" /> type.</param>
+ <param name="returnType">The type of the value to be returned.
+Note With the release of the .NET Framework 3.5, the value of the <paramref name="returnType" /> parameter can now be the <see cref="T:System.DateTimeOffset" /> type.</param>
<param name="namespaceResolver">An <see cref="T:System.Xml.IXmlNamespaceResolver" /> object that is used to resolve any namespace prefixes related to type conversion.</param>
<param name="localName">The local name of the element.</param>
<param name="namespaceURI">The namespace URI of the element.</param>
+ <returns>The element content converted to the requested typed object.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to the requested type.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to the requested type.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
<exception cref="T:System.ArgumentException">The specified local name and namespace URI do not match that of the current element being read.</exception>
<exception cref="T:System.OverflowException">Read <see langword="Decimal.MaxValue" />.</exception>
- <returns>The element content converted to the requested typed object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsAsync(System.Type,System.Xml.IXmlNamespaceResolver)">
<summary>Asynchronously reads the element content as the requested type.</summary>
<param name="returnType">The type of the value to be returned.</param>
<param name="namespaceResolver">An <see cref="T:System.Xml.IXmlNamespaceResolver" /> object that is used to resolve any namespace prefixes related to type conversion.</param>
+ <returns>The element content converted to the requested typed object.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The element content converted to the requested typed object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsBase64(System.Byte[],System.Int32,System.Int32)">
<summary>Reads the element and decodes the <see langword="Base64" /> content.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The current node is not an element node.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlReader" /> implementation does not support this method.</exception>
<exception cref="T:System.Xml.XmlException">The element contains mixed-content.</exception>
<exception cref="T:System.FormatException">The content cannot be converted to the requested type.</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsBase64Async(System.Byte[],System.Int32,System.Int32)">
<summary>Asynchronously reads the element and decodes the <see langword="Base64" /> content.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsBinHex(System.Byte[],System.Int32,System.Int32)">
<summary>Reads the element and decodes the <see langword="BinHex" /> content.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The current node is not an element node.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlReader" /> implementation does not support this method.</exception>
<exception cref="T:System.Xml.XmlException">The element contains mixed-content.</exception>
<exception cref="T:System.FormatException">The content cannot be converted to the requested type.</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsBinHexAsync(System.Byte[],System.Int32,System.Int32)">
<summary>Asynchronously reads the element and decodes the <see langword="BinHex" /> content.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsBoolean">
<summary>Reads the current element and returns the contents as a <see cref="T:System.Boolean" /> object.</summary>
+ <returns>The element content as a <see cref="T:System.Boolean" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a <see cref="T:System.Boolean" /> object.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a <see cref="T:System.Boolean" /> object.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
- <returns>The element content as a <see cref="T:System.Boolean" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsBoolean(System.String,System.String)">
<summary>Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a <see cref="T:System.Boolean" /> object.</summary>
<param name="localName">The local name of the element.</param>
<param name="namespaceURI">The namespace URI of the element.</param>
+ <returns>The element content as a <see cref="T:System.Boolean" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to the requested type.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to the requested type.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
<exception cref="T:System.ArgumentException">The specified local name and namespace URI do not match that of the current element being read.</exception>
- <returns>The element content as a <see cref="T:System.Boolean" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsDateTime">
<summary>Reads the current element and returns the contents as a <see cref="T:System.DateTime" /> object.</summary>
+ <returns>The element content as a <see cref="T:System.DateTime" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a <see cref="T:System.DateTime" /> object.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a <see cref="T:System.DateTime" /> object.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
- <returns>The element content as a <see cref="T:System.DateTime" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsDateTime(System.String,System.String)">
<summary>Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a <see cref="T:System.DateTime" /> object.</summary>
<param name="localName">The local name of the element.</param>
<param name="namespaceURI">The namespace URI of the element.</param>
+ <returns>The element contents as a <see cref="T:System.DateTime" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to the requested type.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to the requested type.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
<exception cref="T:System.ArgumentException">The specified local name and namespace URI do not match that of the current element being read.</exception>
- <returns>The element contents as a <see cref="T:System.DateTime" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsDecimal">
<summary>Reads the current element and returns the contents as a <see cref="T:System.Decimal" /> object.</summary>
+ <returns>The element content as a <see cref="T:System.Decimal" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a <see cref="T:System.Decimal" />.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a <see cref="T:System.Decimal" />.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
- <returns>The element content as a <see cref="T:System.Decimal" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsDecimal(System.String,System.String)">
<summary>Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a <see cref="T:System.Decimal" /> object.</summary>
<param name="localName">The local name of the element.</param>
<param name="namespaceURI">The namespace URI of the element.</param>
+ <returns>The element content as a <see cref="T:System.Decimal" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a <see cref="T:System.Decimal" />.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a <see cref="T:System.Decimal" />.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
<exception cref="T:System.ArgumentException">The specified local name and namespace URI do not match that of the current element being read.</exception>
- <returns>The element content as a <see cref="T:System.Decimal" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsDouble">
<summary>Reads the current element and returns the contents as a double-precision floating-point number.</summary>
+ <returns>The element content as a double-precision floating-point number.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a double-precision floating-point number.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a double-precision floating-point number.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
- <returns>The element content as a double-precision floating-point number.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsDouble(System.String,System.String)">
<summary>Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a double-precision floating-point number.</summary>
<param name="localName">The local name of the element.</param>
<param name="namespaceURI">The namespace URI of the element.</param>
+ <returns>The element content as a double-precision floating-point number.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to the requested type.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to the requested type.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
<exception cref="T:System.ArgumentException">The specified local name and namespace URI do not match that of the current element being read.</exception>
- <returns>The element content as a double-precision floating-point number.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsFloat">
<summary>Reads the current element and returns the contents as single-precision floating-point number.</summary>
+ <returns>The element content as a single-precision floating point number.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a single-precision floating-point number.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a single-precision floating-point number.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
- <returns>The element content as a single-precision floating point number.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsFloat(System.String,System.String)">
<summary>Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a single-precision floating-point number.</summary>
<param name="localName">The local name of the element.</param>
<param name="namespaceURI">The namespace URI of the element.</param>
+ <returns>The element content as a single-precision floating point number.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a single-precision floating-point number.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a single-precision floating-point number.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
<exception cref="T:System.ArgumentException">The specified local name and namespace URI do not match that of the current element being read.</exception>
- <returns>The element content as a single-precision floating point number.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsInt">
<summary>Reads the current element and returns the contents as a 32-bit signed integer.</summary>
+ <returns>The element content as a 32-bit signed integer.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a 32-bit signed integer.</exception>
- <returns>The element content as a 32-bit signed integer.</returns>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a 32-bit signed integer.</exception>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsInt(System.String,System.String)">
<summary>Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a 32-bit signed integer.</summary>
<param name="localName">The local name of the element.</param>
<param name="namespaceURI">The namespace URI of the element.</param>
+ <returns>The element content as a 32-bit signed integer.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a 32-bit signed integer.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a 32-bit signed integer.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
<exception cref="T:System.ArgumentException">The specified local name and namespace URI do not match that of the current element being read.</exception>
- <returns>The element content as a 32-bit signed integer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsLong">
<summary>Reads the current element and returns the contents as a 64-bit signed integer.</summary>
+ <returns>The element content as a 64-bit signed integer.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a 64-bit signed integer.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a 64-bit signed integer.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
- <returns>The element content as a 64-bit signed integer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsLong(System.String,System.String)">
<summary>Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a 64-bit signed integer.</summary>
<param name="localName">The local name of the element.</param>
<param name="namespaceURI">The namespace URI of the element.</param>
+ <returns>The element content as a 64-bit signed integer.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a 64-bit signed integer.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a 64-bit signed integer.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
<exception cref="T:System.ArgumentException">The specified local name and namespace URI do not match that of the current element being read.</exception>
- <returns>The element content as a 64-bit signed integer.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsObject">
<summary>Reads the current element and returns the contents as an <see cref="T:System.Object" />.</summary>
+ <returns>A boxed common language runtime (CLR) object of the most appropriate type. The <see cref="P:System.Xml.XmlReader.ValueType" /> property determines the appropriate CLR type. If the content is typed as a list type, this method returns an array of boxed objects of the appropriate type.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to the requested type</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to the requested type</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
- <returns>A boxed common language runtime (CLR) object of the most appropriate type. The <see cref="P:System.Xml.XmlReader.ValueType" /> property determines the appropriate CLR type. If the content is typed as a list type, this method returns an array of boxed objects of the appropriate type.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsObject(System.String,System.String)">
<summary>Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as an <see cref="T:System.Object" />.</summary>
<param name="localName">The local name of the element.</param>
<param name="namespaceURI">The namespace URI of the element.</param>
+ <returns>A boxed common language runtime (CLR) object of the most appropriate type. The <see cref="P:System.Xml.XmlReader.ValueType" /> property determines the appropriate CLR type. If the content is typed as a list type, this method returns an array of boxed objects of the appropriate type.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to the requested type.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to the requested type.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
<exception cref="T:System.ArgumentException">The specified local name and namespace URI do not match that of the current element being read.</exception>
- <returns>A boxed common language runtime (CLR) object of the most appropriate type. The <see cref="P:System.Xml.XmlReader.ValueType" /> property determines the appropriate CLR type. If the content is typed as a list type, this method returns an array of boxed objects of the appropriate type.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsObjectAsync">
<summary>Asynchronously reads the current element and returns the contents as an <see cref="T:System.Object" />.</summary>
+ <returns>A boxed common language runtime (CLR) object of the most appropriate type. The <see cref="P:System.Xml.XmlReader.ValueType" /> property determines the appropriate CLR type. If the content is typed as a list type, this method returns an array of boxed objects of the appropriate type.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>A boxed common language runtime (CLR) object of the most appropriate type. The <see cref="P:System.Xml.XmlReader.ValueType" /> property determines the appropriate CLR type. If the content is typed as a list type, this method returns an array of boxed objects of the appropriate type.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsString">
<summary>Reads the current element and returns the contents as a <see cref="T:System.String" /> object.</summary>
+ <returns>The element content as a <see cref="T:System.String" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a <see cref="T:System.String" /> object.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a <see cref="T:System.String" /> object.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
- <returns>The element content as a <see cref="T:System.String" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsString(System.String,System.String)">
<summary>Checks that the specified local name and namespace URI matches that of the current element, then reads the current element and returns the contents as a <see cref="T:System.String" /> object.</summary>
<param name="localName">The local name of the element.</param>
<param name="namespaceURI">The namespace URI of the element.</param>
+ <returns>The element content as a <see cref="T:System.String" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XmlReader" /> is not positioned on an element.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.Xml.XmlException">The current element contains child elements.
-
- -or-
-
- The element content cannot be converted to a <see cref="T:System.String" /> object.</exception>
+ <exception cref="T:System.Xml.XmlException">The current element contains child elements.
+-or-
+The element content cannot be converted to a <see cref="T:System.String" /> object.</exception>
<exception cref="T:System.ArgumentNullException">The method is called with <see langword="null" /> arguments.</exception>
<exception cref="T:System.ArgumentException">The specified local name and namespace URI do not match that of the current element being read.</exception>
- <returns>The element content as a <see cref="T:System.String" /> object.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementContentAsStringAsync">
<summary>Asynchronously reads the current element and returns the contents as a <see cref="T:System.String" /> object.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
<returns>The element content as a <see cref="T:System.String" /> object.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
</member>
<member name="M:System.Xml.XmlReader.ReadElementString">
<summary>Reads a text-only element. However, we recommend that you use the <see cref="M:System.Xml.XmlReader.ReadElementContentAsString" /> method instead, because it provides a more straightforward way to handle this operation.</summary>
+ <returns>The text contained in the element that was read. An empty string if the element is empty.</returns>
<exception cref="T:System.Xml.XmlException">The next content node is not a start tag; or the element found does not contain a simple text value.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The text contained in the element that was read. An empty string if the element is empty.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementString(System.String)">
<summary>Checks that the <see cref="P:System.Xml.XmlReader.Name" /> property of the element found matches the given string before reading a text-only element. However, we recommend that you use the <see cref="M:System.Xml.XmlReader.ReadElementContentAsString" /> method instead, because it provides a more straightforward way to handle this operation.</summary>
<param name="name">The name to check.</param>
+ <returns>The text contained in the element that was read. An empty string if the element is empty.</returns>
<exception cref="T:System.Xml.XmlException">If the next content node is not a start tag; if the element <see langword="Name" /> does not match the given argument; or if the element found does not contain a simple text value.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The text contained in the element that was read. An empty string if the element is empty.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadElementString(System.String,System.String)">
<summary>Checks that the <see cref="P:System.Xml.XmlReader.LocalName" /> and <see cref="P:System.Xml.XmlReader.NamespaceURI" /> properties of the element found matches the given strings before reading a text-only element. However, we recommend that you use the <see cref="M:System.Xml.XmlReader.ReadElementContentAsString(System.String,System.String)" /> method instead, because it provides a more straightforward way to handle this operation.</summary>
<param name="localname">The local name to check.</param>
<param name="ns">The namespace URI to check.</param>
+ <returns>The text contained in the element that was read. An empty string if the element is empty.</returns>
<exception cref="T:System.Xml.XmlException">If the next content node is not a start tag; if the element <see langword="LocalName" /> or <see langword="NamespaceURI" /> do not match the given arguments; or if the element found does not contain a simple text value.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The text contained in the element that was read. An empty string if the element is empty.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadEndElement">
<summary>Checks that the current content node is an end tag and advances the reader to the next node.</summary>
</member>
<member name="M:System.Xml.XmlReader.ReadInnerXml">
<summary>When overridden in a derived class, reads all the content, including markup, as a string.</summary>
+ <returns>All the XML content, including markup, in the current node. If the current node has no children, an empty string is returned.
+If the current node is neither an element nor attribute, an empty string is returned.</returns>
<exception cref="T:System.Xml.XmlException">The XML was not well-formed, or an error occurred while parsing the XML.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>All the XML content, including markup, in the current node. If the current node has no children, an empty string is returned.
-
- If the current node is neither an element nor attribute, an empty string is returned.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadInnerXmlAsync">
<summary>Asynchronously reads all the content, including markup, as a string.</summary>
+ <returns>All the XML content, including markup, in the current node. If the current node has no children, an empty string is returned.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>All the XML content, including markup, in the current node. If the current node has no children, an empty string is returned.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadOuterXml">
<summary>When overridden in a derived class, reads the content, including markup, representing this node and all its children.</summary>
+ <returns>If the reader is positioned on an element or an attribute node, this method returns all the XML content, including markup, of the current node and all its children; otherwise, it returns an empty string.</returns>
<exception cref="T:System.Xml.XmlException">The XML was not well-formed, or an error occurred while parsing the XML.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>If the reader is positioned on an element or an attribute node, this method returns all the XML content, including markup, of the current node and all its children; otherwise, it returns an empty string.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadOuterXmlAsync">
<summary>Asynchronously reads the content, including markup, representing this node and all its children.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
<returns>If the reader is positioned on an element or an attribute node, this method returns all the XML content, including markup, of the current node and all its children; otherwise, it returns an empty string.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
</member>
<member name="M:System.Xml.XmlReader.ReadStartElement">
<summary>Checks that the current node is an element and advances the reader to the next node.</summary>
<member name="M:System.Xml.XmlReader.ReadStartElement(System.String)">
<summary>Checks that the current content node is an element with the given <see cref="P:System.Xml.XmlReader.Name" /> and advances the reader to the next node.</summary>
<param name="name">The qualified name of the element.</param>
- <exception cref="T:System.Xml.XmlException">Incorrect XML was encountered in the input stream.
-
- -or-
-
- The <see cref="P:System.Xml.XmlReader.Name" /> of the element does not match the given <paramref name="name" />.</exception>
+ <exception cref="T:System.Xml.XmlException">Incorrect XML was encountered in the input stream.
+-or-
+The <see cref="P:System.Xml.XmlReader.Name" /> of the element does not match the given <paramref name="name" />.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.ReadStartElement(System.String,System.String)">
<summary>Checks that the current content node is an element with the given <see cref="P:System.Xml.XmlReader.LocalName" /> and <see cref="P:System.Xml.XmlReader.NamespaceURI" /> and advances the reader to the next node.</summary>
<param name="localname">The local name of the element.</param>
<param name="ns">The namespace URI of the element.</param>
- <exception cref="T:System.Xml.XmlException">Incorrect XML was encountered in the input stream.
-
- -or-
-
- The <see cref="P:System.Xml.XmlReader.LocalName" /> and <see cref="P:System.Xml.XmlReader.NamespaceURI" /> properties of the element found do not match the given arguments.</exception>
+ <exception cref="T:System.Xml.XmlException">Incorrect XML was encountered in the input stream.
+-or-
+The <see cref="P:System.Xml.XmlReader.LocalName" /> and <see cref="P:System.Xml.XmlReader.NamespaceURI" /> properties of the element found do not match the given arguments.</exception>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="P:System.Xml.XmlReader.ReadState">
+ <summary>When overridden in a derived class, gets the state of the reader.</summary>
+ <returns>One of the enumeration values that specifies the state of the reader.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlReader.ReadString">
<summary>When overridden in a derived class, reads the contents of an element or text node as a string. However, we recommend that you use the <see cref="Overload:System.Xml.XmlReader.ReadElementContentAsString" /> method instead, because it provides a more straightforward way to handle this operation.</summary>
+ <returns>The contents of the element or an empty string.</returns>
<exception cref="T:System.Xml.XmlException">An error occurred while parsing the XML.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The contents of the element or an empty string.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadSubtree">
<summary>Returns a new <see langword="XmlReader" /> instance that can be used to read the current node, and all its descendants.</summary>
+ <returns>A new XML reader instance set to <see cref="F:System.Xml.ReadState.Initial" />. Calling the <see cref="M:System.Xml.XmlReader.Read" /> method positions the new reader on the node that was current before the call to the <see cref="M:System.Xml.XmlReader.ReadSubtree" /> method.</returns>
<exception cref="T:System.InvalidOperationException">The XML reader isn't positioned on an element when this method is called.
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>A new XML reader instance set to <see cref="F:System.Xml.ReadState.Initial" />. Calling the <see cref="M:System.Xml.XmlReader.Read" /> method positions the new reader on the node that was current before the call to the <see cref="M:System.Xml.XmlReader.ReadSubtree" /> method.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadToDescendant(System.String)">
<summary>Advances the <see cref="T:System.Xml.XmlReader" /> to the next descendant element with the specified qualified name.</summary>
<param name="name">The qualified name of the element you wish to move to.</param>
+ <returns>
+ <see langword="true" /> if a matching descendant element is found; otherwise <see langword="false" />. If a matching child element is not found, the <see cref="T:System.Xml.XmlReader" /> is positioned on the end tag (<see cref="P:System.Xml.XmlReader.NodeType" /> is <see langword="XmlNodeType.EndElement" />) of the element.
+If the <see cref="T:System.Xml.XmlReader" /> is not positioned on an element when <see cref="M:System.Xml.XmlReader.ReadToDescendant(System.String)" /> was called, this method returns <see langword="false" /> and the position of the <see cref="T:System.Xml.XmlReader" /> is not changed.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.ArgumentException">The parameter is an empty string.</exception>
- <returns>
- <see langword="true" /> if a matching descendant element is found; otherwise <see langword="false" />. If a matching child element is not found, the <see cref="T:System.Xml.XmlReader" /> is positioned on the end tag (<see cref="P:System.Xml.XmlReader.NodeType" /> is <see langword="XmlNodeType.EndElement" />) of the element.
-
- If the <see cref="T:System.Xml.XmlReader" /> is not positioned on an element when <see cref="M:System.Xml.XmlReader.ReadToDescendant(System.String)" /> was called, this method returns <see langword="false" /> and the position of the <see cref="T:System.Xml.XmlReader" /> is not changed.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadToDescendant(System.String,System.String)">
<summary>Advances the <see cref="T:System.Xml.XmlReader" /> to the next descendant element with the specified local name and namespace URI.</summary>
<param name="localName">The local name of the element you wish to move to.</param>
<param name="namespaceURI">The namespace URI of the element you wish to move to.</param>
+ <returns>
+ <see langword="true" /> if a matching descendant element is found; otherwise <see langword="false" />. If a matching child element is not found, the <see cref="T:System.Xml.XmlReader" /> is positioned on the end tag (<see cref="P:System.Xml.XmlReader.NodeType" /> is <see langword="XmlNodeType.EndElement" />) of the element.
+If the <see cref="T:System.Xml.XmlReader" /> is not positioned on an element when <see cref="M:System.Xml.XmlReader.ReadToDescendant(System.String,System.String)" /> was called, this method returns <see langword="false" /> and the position of the <see cref="T:System.Xml.XmlReader" /> is not changed.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.ArgumentNullException">Both parameter values are <see langword="null" />.</exception>
- <returns>
- <see langword="true" /> if a matching descendant element is found; otherwise <see langword="false" />. If a matching child element is not found, the <see cref="T:System.Xml.XmlReader" /> is positioned on the end tag (<see cref="P:System.Xml.XmlReader.NodeType" /> is <see langword="XmlNodeType.EndElement" />) of the element.
-
- If the <see cref="T:System.Xml.XmlReader" /> is not positioned on an element when <see cref="M:System.Xml.XmlReader.ReadToDescendant(System.String,System.String)" /> was called, this method returns <see langword="false" /> and the position of the <see cref="T:System.Xml.XmlReader" /> is not changed.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadToFollowing(System.String)">
<summary>Reads until an element with the specified qualified name is found.</summary>
<param name="name">The qualified name of the element.</param>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.ArgumentException">The parameter is an empty string.</exception>
<returns>
<see langword="true" /> if a matching element is found; otherwise <see langword="false" /> and the <see cref="T:System.Xml.XmlReader" /> is in an end of file state.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ <exception cref="T:System.ArgumentException">The parameter is an empty string.</exception>
</member>
<member name="M:System.Xml.XmlReader.ReadToFollowing(System.String,System.String)">
<summary>Reads until an element with the specified local name and namespace URI is found.</summary>
<param name="localName">The local name of the element.</param>
<param name="namespaceURI">The namespace URI of the element.</param>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.ArgumentNullException">Both parameter values are <see langword="null" />.</exception>
<returns>
<see langword="true" /> if a matching element is found; otherwise <see langword="false" /> and the <see cref="T:System.Xml.XmlReader" /> is in an end of file state.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ <exception cref="T:System.ArgumentNullException">Both parameter values are <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlReader.ReadToNextSibling(System.String)">
<summary>Advances the <see langword="XmlReader" /> to the next sibling element with the specified qualified name.</summary>
<param name="name">The qualified name of the sibling element you wish to move to.</param>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.ArgumentException">The parameter is an empty string.</exception>
<returns>
<see langword="true" /> if a matching sibling element is found; otherwise <see langword="false" />. If a matching sibling element is not found, the <see langword="XmlReader" /> is positioned on the end tag (<see cref="P:System.Xml.XmlReader.NodeType" /> is <see langword="XmlNodeType.EndElement" />) of the parent element.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ <exception cref="T:System.ArgumentException">The parameter is an empty string.</exception>
</member>
<member name="M:System.Xml.XmlReader.ReadToNextSibling(System.String,System.String)">
<summary>Advances the <see langword="XmlReader" /> to the next sibling element with the specified local name and namespace URI.</summary>
<param name="localName">The local name of the sibling element you wish to move to.</param>
<param name="namespaceURI">The namespace URI of the sibling element you wish to move to.</param>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <exception cref="T:System.ArgumentNullException">Both parameter values are <see langword="null" />.</exception>
<returns>
<see langword="true" /> if a matching sibling element is found; otherwise, <see langword="false" />. If a matching sibling element is not found, the <see langword="XmlReader" /> is positioned on the end tag (<see cref="P:System.Xml.XmlReader.NodeType" /> is <see langword="XmlNodeType.EndElement" />) of the parent element.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ <exception cref="T:System.ArgumentNullException">Both parameter values are <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlReader.ReadValueChunk(System.Char[],System.Int32,System.Int32)">
<summary>Reads large streams of text embedded in an XML document.</summary>
<param name="buffer">The array of characters that serves as the buffer to which the text contents are written. This value cannot be <see langword="null" />.</param>
<param name="index">The offset within the buffer where the <see cref="T:System.Xml.XmlReader" /> can start to copy the results.</param>
<param name="count">The maximum number of characters to copy into the buffer. The actual number of characters copied is returned from this method.</param>
+ <returns>The number of characters read into the buffer. The value zero is returned when there is no more text content.</returns>
<exception cref="T:System.InvalidOperationException">The current node does not have a value (<see cref="P:System.Xml.XmlReader.HasValue" /> is <see langword="false" />).
-
-or-
-
An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer, or index + count is larger than the allocated buffer size.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlReader" /> implementation does not support this method.</exception>
<exception cref="T:System.Xml.XmlException">The XML data is not well-formed.</exception>
- <returns>The number of characters read into the buffer. The value zero is returned when there is no more text content.</returns>
</member>
<member name="M:System.Xml.XmlReader.ReadValueChunkAsync(System.Char[],System.Int32,System.Int32)">
<summary>Asynchronously reads large streams of text embedded in an XML document.</summary>
<param name="buffer">The array of characters that serves as the buffer to which the text contents are written. This value cannot be <see langword="null" />.</param>
<param name="index">The offset within the buffer where the <see cref="T:System.Xml.XmlReader" /> can start to copy the results.</param>
<param name="count">The maximum number of characters to copy into the buffer. The actual number of characters copied is returned from this method.</param>
+ <returns>The number of characters read into the buffer. The value zero is returned when there is no more text content.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-or-
-
An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The number of characters read into the buffer. The value zero is returned when there is no more text content.</returns>
</member>
<member name="M:System.Xml.XmlReader.ResolveEntity">
<summary>When overridden in a derived class, resolves the entity reference for <see langword="EntityReference" /> nodes.</summary>
<exception cref="T:System.InvalidOperationException">The reader is not positioned on an <see langword="EntityReference" /> node; this implementation of the reader cannot resolve entities (<see cref="P:System.Xml.XmlReader.CanResolveEntity" /> returns <see langword="false" />).
-
--or-
-
-An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- </member>
- <member name="M:System.Xml.XmlReader.Skip">
- <summary>Skips the children of the current node.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- </member>
- <member name="M:System.Xml.XmlReader.SkipAsync">
- <summary>Asynchronously skips the children of the current node.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
-An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The current node.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.AttributeCount">
- <summary>When overridden in a derived class, gets the number of attributes on the current node.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The number of attributes on the current node.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.BaseURI">
- <summary>When overridden in a derived class, gets the base URI of the current node.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The base URI of the current node.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.CanReadBinaryContent">
- <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlReader" /> implements the binary content read methods.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>
- <see langword="true" /> if the binary content read methods are implemented; otherwise <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.CanReadValueChunk">
- <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlReader" /> implements the <see cref="M:System.Xml.XmlReader.ReadValueChunk(System.Char[],System.Int32,System.Int32)" /> method.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Xml.XmlReader" /> implements the <see cref="M:System.Xml.XmlReader.ReadValueChunk(System.Char[],System.Int32,System.Int32)" /> method; otherwise <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.CanResolveEntity">
- <summary>Gets a value indicating whether this reader can parse and resolve entities.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>
- <see langword="true" /> if the reader can parse and resolve entities; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.Depth">
- <summary>When overridden in a derived class, gets the depth of the current node in the XML document.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The depth of the current node in the XML document.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.EOF">
- <summary>When overridden in a derived class, gets a value indicating whether the reader is positioned at the end of the stream.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>
- <see langword="true" /> if the reader is positioned at the end of the stream; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.HasAttributes">
- <summary>Gets a value indicating whether the current node has any attributes.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>
- <see langword="true" /> if the current node has attributes; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.HasValue">
- <summary>When overridden in a derived class, gets a value indicating whether the current node can have a <see cref="P:System.Xml.XmlReader.Value" />.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>
- <see langword="true" /> if the node on which the reader is currently positioned can have a <see langword="Value" />; otherwise, <see langword="false" />. If <see langword="false" />, the node has a value of <see langword="String.Empty" />.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.IsDefault">
- <summary>When overridden in a derived class, gets a value indicating whether the current node is an attribute that was generated from the default value defined in the DTD or schema.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>
- <see langword="true" /> if the current node is an attribute whose value was generated from the default value defined in the DTD or schema; <see langword="false" /> if the attribute value was explicitly set.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.IsEmptyElement">
- <summary>When overridden in a derived class, gets a value indicating whether the current node is an empty element (for example, <c><MyElement/></c>).</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>
- <see langword="true" /> if the current node is an element (<see cref="P:System.Xml.XmlReader.NodeType" /> equals <see langword="XmlNodeType.Element" />) that ends with <c>/></c>; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.Item(System.Int32)">
- <summary>When overridden in a derived class, gets the value of the attribute with the specified index.</summary>
- <param name="i">The index of the attribute.</param>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The value of the specified attribute.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.Item(System.String)">
- <summary>When overridden in a derived class, gets the value of the attribute with the specified <see cref="P:System.Xml.XmlReader.Name" />.</summary>
- <param name="name">The qualified name of the attribute.</param>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The value of the specified attribute. If the attribute is not found, <see langword="null" /> is returned.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.Item(System.String,System.String)">
- <summary>When overridden in a derived class, gets the value of the attribute with the specified <see cref="P:System.Xml.XmlReader.LocalName" /> and <see cref="P:System.Xml.XmlReader.NamespaceURI" />.</summary>
- <param name="name">The local name of the attribute.</param>
- <param name="namespaceURI">The namespace URI of the attribute.</param>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The value of the specified attribute. If the attribute is not found, <see langword="null" /> is returned.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.LocalName">
- <summary>When overridden in a derived class, gets the local name of the current node.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The name of the current node with the prefix removed. For example, <see langword="LocalName" /> is <see langword="book" /> for the element <c><bk:book></c>.
-
- For node types that do not have a name (like <see langword="Text" />, <see langword="Comment" />, and so on), this property returns <see langword="String.Empty" />.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.Name">
- <summary>When overridden in a derived class, gets the qualified name of the current node.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The qualified name of the current node. For example, <see langword="Name" /> is <see langword="bk:book" /> for the element <c><bk:book></c>.
-
- The name returned is dependent on the <see cref="P:System.Xml.XmlReader.NodeType" /> of the node. The following node types return the listed values. All other node types return an empty string.
-
- <list type="table"><listheader><term> Node type</term><description> Name</description></listheader><item><term><see langword="Attribute" /></term><description> The name of the attribute.</description></item><item><term><see langword="DocumentType" /></term><description> The document type name.</description></item><item><term><see langword="Element" /></term><description> The tag name.</description></item><item><term><see langword="EntityReference" /></term><description> The name of the entity referenced.</description></item><item><term><see langword="ProcessingInstruction" /></term><description> The target of the processing instruction.</description></item><item><term><see langword="XmlDeclaration" /></term><description> The literal string <see langword="xml" />.</description></item></list></returns>
- </member>
- <member name="P:System.Xml.XmlReader.NamespaceURI">
- <summary>When overridden in a derived class, gets the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The namespace URI of the current node; otherwise an empty string.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.NameTable">
- <summary>When overridden in a derived class, gets the <see cref="T:System.Xml.XmlNameTable" /> associated with this implementation.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The <see langword="XmlNameTable" /> enabling you to get the atomized version of a string within the node.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.NodeType">
- <summary>When overridden in a derived class, gets the type of the current node.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>One of the enumeration values that specify the type of the current node.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.Prefix">
- <summary>When overridden in a derived class, gets the namespace prefix associated with the current node.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The namespace prefix associated with the current node.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.QuoteChar">
- <summary>When overridden in a derived class, gets the quotation mark character used to enclose the value of an attribute node.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The quotation mark character (" or ') used to enclose the value of an attribute node.</returns>
- </member>
- <member name="P:System.Xml.XmlReader.ReadState">
- <summary>When overridden in a derived class, gets the state of the reader.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>One of the enumeration values that specifies the state of the reader.</returns>
+An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="P:System.Xml.XmlReader.SchemaInfo">
<summary>Gets the schema information that has been assigned to the current node as a result of schema validation.</summary>
+ <returns>An <see cref="T:System.Xml.Schema.IXmlSchemaInfo" /> object containing the schema information for the current node. Schema information can be set on elements, attributes, or on text nodes with a non-null <see cref="P:System.Xml.XmlReader.ValueType" /> (typed values).
+If the current node is not one of the above node types, or if the <see langword="XmlReader" /> instance does not report schema information, this property returns <see langword="null" />.
+If this property is called from an <see cref="T:System.Xml.XmlTextReader" /> or an <see cref="T:System.Xml.XmlValidatingReader" /> object, this property always returns <see langword="null" />. These <see langword="XmlReader" /> implementations do not expose schema information through the <see langword="SchemaInfo" /> property.
+
+If you have to get the post-schema-validation information set (PSVI) for an element, position the reader on the end tag of the element, rather than on the start tag. You get the PSVI through the <see langword="SchemaInfo" /> property of a reader. The validating reader that is created through <see cref="Overload:System.Xml.XmlReader.Create" /> with the <see cref="P:System.Xml.XmlReaderSettings.ValidationType" /> property set to <see cref="F:System.Xml.ValidationType.Schema" /> has complete PSVI for an element only when the reader is positioned on the end tag of an element.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>An <see cref="T:System.Xml.Schema.IXmlSchemaInfo" /> object containing the schema information for the current node. Schema information can be set on elements, attributes, or on text nodes with a non-null <see cref="P:System.Xml.XmlReader.ValueType" /> (typed values).
-
- If the current node is not one of the above node types, or if the <see langword="XmlReader" /> instance does not report schema information, this property returns <see langword="null" />.
-
- If this property is called from an <see cref="T:System.Xml.XmlTextReader" /> or an <see cref="T:System.Xml.XmlValidatingReader" /> object, this property always returns <see langword="null" />. These <see langword="XmlReader" /> implementations do not expose schema information through the <see langword="SchemaInfo" /> property.</returns>
</member>
<member name="P:System.Xml.XmlReader.Settings">
<summary>Gets the <see cref="T:System.Xml.XmlReaderSettings" /> object used to create this <see cref="T:System.Xml.XmlReader" /> instance.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>The <see cref="T:System.Xml.XmlReaderSettings" /> object used to create this reader instance. If this reader was not created using the <see cref="Overload:System.Xml.XmlReader.Create" /> method, this property returns <see langword="null" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="M:System.Xml.XmlReader.Skip">
+ <summary>Skips the children of the current node.</summary>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
+ </member>
+ <member name="M:System.Xml.XmlReader.SkipAsync">
+ <summary>Asynchronously skips the children of the current node.</summary>
+ <returns>The current node.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
+-or-
+An <see cref="T:System.Xml.XmlReader" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlReaderSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlReaderSettings.Async to true if you want to use Async Methods."</exception>
</member>
<member name="P:System.Xml.XmlReader.Value">
<summary>When overridden in a derived class, gets the text value of the current node.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The value returned depends on the <see cref="P:System.Xml.XmlReader.NodeType" /> of the node. The following table lists node types that have a value to return. All other node types return <see langword="String.Empty" />.
+ <returns>The value returned depends on the <see cref="P:System.Xml.XmlReader.NodeType" /> of the node. The following table lists node types that have a value to return. All other node types return <see langword="String.Empty" />.
+ Node type
+
+ Value
+
+ <see langword="Attribute" /> The value of the attribute.
+
+ <see langword="CDATA" /> The content of the CDATA section.
+
+ <see langword="Comment" /> The content of the comment.
+
+ <see langword="DocumentType" /> The internal subset.
+
+ <see langword="ProcessingInstruction" /> The entire content, excluding the target.
- <list type="table"><listheader><term> Node type</term><description> Value</description></listheader><item><term><see langword="Attribute" /></term><description> The value of the attribute.</description></item><item><term><see langword="CDATA" /></term><description> The content of the CDATA section.</description></item><item><term><see langword="Comment" /></term><description> The content of the comment.</description></item><item><term><see langword="DocumentType" /></term><description> The internal subset.</description></item><item><term><see langword="ProcessingInstruction" /></term><description> The entire content, excluding the target.</description></item><item><term><see langword="SignificantWhitespace" /></term><description> The white space between markup in a mixed content model.</description></item><item><term><see langword="Text" /></term><description> The content of the text node.</description></item><item><term><see langword="Whitespace" /></term><description> The white space between markup.</description></item><item><term><see langword="XmlDeclaration" /></term><description> The content of the declaration.</description></item></list></returns>
+ <see langword="SignificantWhitespace" /> The white space between markup in a mixed content model.
+
+ <see langword="Text" /> The content of the text node.
+
+ <see langword="Whitespace" /> The white space between markup.
+
+ <see langword="XmlDeclaration" /> The content of the declaration.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="P:System.Xml.XmlReader.ValueType">
<summary>Gets The Common Language Runtime (CLR) type for the current node.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>The CLR type that corresponds to the typed value of the node. The default is <see langword="System.String" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="P:System.Xml.XmlReader.XmlLang">
<summary>When overridden in a derived class, gets the current <see langword="xml:lang" /> scope.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>The current <see langword="xml:lang" /> scope.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="P:System.Xml.XmlReader.XmlSpace">
<summary>When overridden in a derived class, gets the current <see langword="xml:space" /> scope.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>One of the <see cref="T:System.Xml.XmlSpace" /> values. If no <see langword="xml:space" /> scope exists, this property defaults to <see langword="XmlSpace.None" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlReader" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="T:System.Xml.XmlReaderSettings">
<summary>Specifies a set of features to support on the <see cref="T:System.Xml.XmlReader" /> object created by the <see cref="Overload:System.Xml.XmlReader.Create" /> method.</summary>
</member>
- <member name="E:System.Xml.XmlReaderSettings.ValidationEventHandler">
- <summary>Occurs when the reader encounters validation errors.</summary>
- </member>
<member name="M:System.Xml.XmlReaderSettings.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.XmlReaderSettings" /> class.</summary>
</member>
- <member name="M:System.Xml.XmlReaderSettings.Clone">
- <summary>Creates a copy of the <see cref="T:System.Xml.XmlReaderSettings" /> instance.</summary>
- <returns>The cloned <see cref="T:System.Xml.XmlReaderSettings" /> object.</returns>
- </member>
- <member name="M:System.Xml.XmlReaderSettings.Reset">
- <summary>Resets the members of the settings class to their default values.</summary>
- </member>
<member name="P:System.Xml.XmlReaderSettings.Async">
<summary>Gets or sets whether asynchronous <see cref="T:System.Xml.XmlReader" /> methods can be used on a particular <see cref="T:System.Xml.XmlReader" /> instance.</summary>
<returns>
<member name="P:System.Xml.XmlReaderSettings.CheckCharacters">
<summary>Gets or sets a value indicating whether to do character checking.</summary>
<returns>
- <see langword="true" /> to do character checking; otherwise <see langword="false" />. The default is <see langword="true" />.</returns>
+ <see langword="true" /> to do character checking; otherwise <see langword="false" />. The default is <see langword="true" />.
+
+If the <see cref="T:System.Xml.XmlReader" /> is processing text data, it always checks that the XML names and text content are valid, regardless of the property setting. Setting <see cref="P:System.Xml.XmlReaderSettings.CheckCharacters" /> to <see langword="false" /> turns off character checking for character entity references.</returns>
+ </member>
+ <member name="M:System.Xml.XmlReaderSettings.Clone">
+ <summary>Creates a copy of the <see cref="T:System.Xml.XmlReaderSettings" /> instance.</summary>
+ <returns>The cloned <see cref="T:System.Xml.XmlReaderSettings" /> object.</returns>
</member>
<member name="P:System.Xml.XmlReaderSettings.CloseInput">
<summary>Gets or sets a value indicating whether the underlying stream or <see cref="T:System.IO.TextReader" /> should be closed when the reader is closed.</summary>
</member>
<member name="P:System.Xml.XmlReaderSettings.NameTable">
<summary>Gets or sets the <see cref="T:System.Xml.XmlNameTable" /> used for atomized string comparisons.</summary>
- <returns>The <see cref="T:System.Xml.XmlNameTable" /> that stores all the atomized strings used by all <see cref="T:System.Xml.XmlReader" /> instances created using this <see cref="T:System.Xml.XmlReaderSettings" /> object.
-
- The default is <see langword="null" />. The created <see cref="T:System.Xml.XmlReader" /> instance will use a new empty <see cref="T:System.Xml.NameTable" /> if this value is <see langword="null" />.</returns>
+ <returns>The <see cref="T:System.Xml.XmlNameTable" /> that stores all the atomized strings used by all <see cref="T:System.Xml.XmlReader" /> instances created using this <see cref="T:System.Xml.XmlReaderSettings" /> object.
+The default is <see langword="null" />. The created <see cref="T:System.Xml.XmlReader" /> instance will use a new empty <see cref="T:System.Xml.NameTable" /> if this value is <see langword="null" />.</returns>
</member>
<member name="P:System.Xml.XmlReaderSettings.ProhibitDtd">
<summary>Gets or sets a value indicating whether to prohibit document type definition (DTD) processing. This property is obsolete. Use <see cref="P:System.Xml.XmlTextReader.DtdProcessing" /> instead.</summary>
<returns>
<see langword="true" /> to prohibit DTD processing; otherwise <see langword="false" />. The default is <see langword="true" />.</returns>
</member>
+ <member name="M:System.Xml.XmlReaderSettings.Reset">
+ <summary>Resets the members of the settings class to their default values.</summary>
+ </member>
<member name="P:System.Xml.XmlReaderSettings.Schemas">
<summary>Gets or sets the <see cref="T:System.Xml.Schema.XmlSchemaSet" /> to use when performing schema validation.</summary>
<returns>The <see cref="T:System.Xml.Schema.XmlSchemaSet" /> to use when performing schema validation. The default is an empty <see cref="T:System.Xml.Schema.XmlSchemaSet" /> object.</returns>
</member>
+ <member name="E:System.Xml.XmlReaderSettings.ValidationEventHandler">
+ <summary>Occurs when the reader encounters validation errors.</summary>
+ </member>
<member name="P:System.Xml.XmlReaderSettings.ValidationFlags">
<summary>Gets or sets a value indicating the schema validation settings. This setting applies to <see cref="T:System.Xml.XmlReader" /> objects that validate schemas (<see cref="P:System.Xml.XmlReaderSettings.ValidationType" /> property set to <see langword="ValidationType.Schema" />).</summary>
<returns>A bitwise combination of enumeration values that specify validation options. <see cref="F:System.Xml.Schema.XmlSchemaValidationFlags.ProcessIdentityConstraints" /> and <see cref="F:System.Xml.Schema.XmlSchemaValidationFlags.AllowXmlAttributes" /> are enabled by default. <see cref="F:System.Xml.Schema.XmlSchemaValidationFlags.ProcessInlineSchema" />, <see cref="F:System.Xml.Schema.XmlSchemaValidationFlags.ProcessSchemaLocation" />, and <see cref="F:System.Xml.Schema.XmlSchemaValidationFlags.ReportValidationWarnings" /> are disabled by default.</returns>
<member name="M:System.Xml.XmlResolver.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.XmlResolver" /> class.</summary>
</member>
+ <member name="P:System.Xml.XmlResolver.Credentials">
+ <summary>When overridden in a derived class, sets the credentials used to authenticate web requests.</summary>
+ <returns>The credentials to be used to authenticate web requests. If this property is not set, the value defaults to <see langword="null" />; that is, the <see langword="XmlResolver" /> has no user credentials.</returns>
+ </member>
<member name="M:System.Xml.XmlResolver.GetEntity(System.Uri,System.String,System.Type)">
<summary>When overridden in a derived class, maps a URI to an object that contains the actual resource.</summary>
<param name="absoluteUri">The URI returned from <see cref="M:System.Xml.XmlResolver.ResolveUri(System.Uri,System.String)" />.</param>
<param name="role">Currently not used.</param>
<param name="ofObjectToReturn">The type of object to return. The current version only returns System.IO.Stream objects.</param>
+ <returns>A stream object or <see langword="null" /> if a type other than stream is specified.</returns>
<exception cref="T:System.Xml.XmlException">
<paramref name="ofObjectToReturn" /> is not a <see langword="Stream" /> type.</exception>
<exception cref="T:System.UriFormatException">The specified URI is not an absolute URI.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="absoluteUri" /> is <see langword="null" />.</exception>
<exception cref="T:System.Exception">There is a runtime error (for example, an interrupted server connection).</exception>
- <returns>A stream object or <see langword="null" /> if a type other than stream is specified.</returns>
</member>
<member name="M:System.Xml.XmlResolver.GetEntityAsync(System.Uri,System.String,System.Type)">
<summary>Asynchronously maps a URI to an object that contains the actual resource.</summary>
<summary>When overridden in a derived class, resolves the absolute URI from the base and relative URIs.</summary>
<param name="baseUri">The base URI used to resolve the relative URI.</param>
<param name="relativeUri">The URI to resolve. The URI can be absolute or relative. If absolute, this value effectively replaces the <paramref name="baseUri" /> value. If relative, it combines with the <paramref name="baseUri" /> to make an absolute URI.</param>
+ <returns>The absolute URI or <see langword="null" /> if the relative URI cannot be resolved.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="relativeUri" /> is <see langword="null" />.</exception>
- <returns>The absolute URI or <see langword="null" /> if the relative URI cannot be resolved.</returns>
</member>
<member name="M:System.Xml.XmlResolver.SupportsType(System.Uri,System.Type)">
<summary>Enables the resolver to return types other than <see cref="T:System.IO.Stream" />.</summary>
<returns>
<see langword="true" /> if the <paramref name="type" /> is supported; otherwise, <see langword="false" />.</returns>
</member>
- <member name="P:System.Xml.XmlResolver.Credentials">
- <summary>When overridden in a derived class, sets the credentials used to authenticate web requests.</summary>
- <returns>The credentials to be used to authenticate web requests. If this property is not set, the value defaults to <see langword="null" />; that is, the <see langword="XmlResolver" /> has no user credentials.</returns>
- </member>
<member name="T:System.Xml.XmlSecureResolver">
<summary>Helps to secure another implementation of <see cref="T:System.Xml.XmlResolver" /> by wrapping the <see cref="T:System.Xml.XmlResolver" /> object and restricting the resources that the underlying <see cref="T:System.Xml.XmlResolver" /> has access to.</summary>
</member>
<param name="resolver">The XML resolver that is wrapped by the <see cref="T:System.Xml.XmlSecureResolver" />.</param>
<param name="securityUrl">The URL used to create the <see cref="T:System.Security.PermissionSet" /> that will be applied to the underlying <see cref="T:System.Xml.XmlResolver" />. The <see cref="T:System.Xml.XmlSecureResolver" /> calls <see cref="M:System.Security.PermissionSet.PermitOnly" /> on the created <see cref="T:System.Security.PermissionSet" /> before calling <see cref="M:System.Xml.XmlSecureResolver.GetEntity(System.Uri,System.String,System.Type)" /> on the underlying <see cref="T:System.Xml.XmlResolver" />.</param>
</member>
+ <member name="P:System.Xml.XmlSecureResolver.Credentials">
+ <summary>Sets credentials used to authenticate web requests.</summary>
+ <returns>The credentials to be used to authenticate web requests. The <see cref="T:System.Xml.XmlSecureResolver" /> sets the given credentials on the underlying <see cref="T:System.Xml.XmlResolver" />. If this property is not set, the value defaults to <see langword="null" />; that is, the <see cref="T:System.Xml.XmlSecureResolver" /> has no user credentials.</returns>
+ </member>
<member name="M:System.Xml.XmlSecureResolver.GetEntity(System.Uri,System.String,System.Type)">
<summary>Maps a URI to an object that contains the actual resource. This method temporarily sets the <see cref="T:System.Security.PermissionSet" /> created in the constructor by calling <see cref="M:System.Security.PermissionSet.PermitOnly" /> before calling <see langword="GetEntity" /> on the underlying <see cref="T:System.Xml.XmlResolver" /> to open the resource.</summary>
<param name="absoluteUri">The URI that is returned from <see cref="M:System.Xml.XmlSecureResolver.ResolveUri(System.Uri,System.String)" />.</param>
<param name="role">Currently not used.</param>
<param name="ofObjectToReturn">The type of object to return. The current version only returns <see cref="T:System.IO.Stream" /> objects.</param>
+ <returns>The stream returned by calling <see langword="GetEntity" /> on the underlying <see cref="T:System.Xml.XmlResolver" />. If a type other than <see cref="T:System.IO.Stream" /> is specified, the method returns <see langword="null" />.</returns>
<exception cref="T:System.Xml.XmlException">
<paramref name="ofObjectToReturn" /> is neither <see langword="null" /> nor a <see cref="T:System.IO.Stream" /> type.</exception>
<exception cref="T:System.UriFormatException">The specified URI is not an absolute URI.</exception>
<exception cref="T:System.NullReferenceException">
<paramref name="absoluteUri" /> is <see langword="null" />.</exception>
<exception cref="T:System.Exception">There is a runtime error (for example, an interrupted server connection).</exception>
- <returns>The stream returned by calling <see langword="GetEntity" /> on the underlying <see cref="T:System.Xml.XmlResolver" />. If a type other than <see cref="T:System.IO.Stream" /> is specified, the method returns <see langword="null" />.</returns>
</member>
<member name="M:System.Xml.XmlSecureResolver.GetEntityAsync(System.Uri,System.String,System.Type)">
<summary>Asynchronously maps a URI to an object that contains the actual resource.</summary>
<summary>Resolves the absolute URI from the base and relative URIs by calling <see langword="ResolveUri" /> on the underlying <see cref="T:System.Xml.XmlResolver" />.</summary>
<param name="baseUri">The base URI used to resolve the relative URI.</param>
<param name="relativeUri">The URI to resolve. The URI can be absolute or relative. If absolute, this value effectively replaces the <paramref name="baseUri" /> value. If relative, it combines with the <paramref name="baseUri" /> to make an absolute URI.</param>
+ <returns>The absolute URI or <see langword="null" /> if the relative URI cannot be resolved (returned by calling <see langword="ResolveUri" /> on the underlying <see cref="T:System.Xml.XmlResolver" />).</returns>
<exception cref="T:System.ArgumentException">
<paramref name="relativeUri" /> is <see langword="null" />.</exception>
- <returns>The absolute URI or <see langword="null" /> if the relative URI cannot be resolved (returned by calling <see langword="ResolveUri" /> on the underlying <see cref="T:System.Xml.XmlResolver" />).</returns>
- </member>
- <member name="P:System.Xml.XmlSecureResolver.Credentials">
- <summary>Sets credentials used to authenticate web requests.</summary>
- <returns>The credentials to be used to authenticate web requests. The <see cref="T:System.Xml.XmlSecureResolver" /> sets the given credentials on the underlying <see cref="T:System.Xml.XmlResolver" />. If this property is not set, the value defaults to <see langword="null" />; that is, the <see cref="T:System.Xml.XmlSecureResolver" /> has no user credentials.</returns>
</member>
<member name="T:System.Xml.XmlSignificantWhitespace">
<summary>Represents white space between markup in a mixed content node or white space within an xml:space= 'preserve' scope. This is also referred to as significant white space.</summary>
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself. For significant white space nodes, the cloned node always includes the data value, regardless of the parameter setting.</param>
<returns>The cloned node.</returns>
</member>
- <member name="M:System.Xml.XmlSignificantWhitespace.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlSignificantWhitespace.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
<member name="P:System.Xml.XmlSignificantWhitespace.LocalName">
<summary>Gets the local name of the node.</summary>
<returns>For <see langword="XmlSignificantWhitespace" /> nodes, this property returns <see langword="#significant-whitespace" />.</returns>
</member>
<member name="P:System.Xml.XmlSignificantWhitespace.Value">
<summary>Gets or sets the value of the node.</summary>
- <exception cref="T:System.ArgumentException">Setting <see langword="Value" /> to invalid white space characters.</exception>
<returns>The white space characters found in the node.</returns>
+ <exception cref="T:System.ArgumentException">Setting <see langword="Value" /> to invalid white space characters.</exception>
+ </member>
+ <member name="M:System.Xml.XmlSignificantWhitespace.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="M:System.Xml.XmlSignificantWhitespace.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
</member>
<member name="T:System.Xml.XmlSpace">
<summary>Specifies the current <see langword="xml:space" /> scope.</summary>
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself.</param>
<returns>The cloned node.</returns>
</member>
- <member name="M:System.Xml.XmlText.SplitText(System.Int32)">
- <summary>Splits the node into two nodes at the specified offset, keeping both in the tree as siblings.</summary>
- <param name="offset">The offset at which to split the node.</param>
- <returns>The new node.</returns>
- </member>
- <member name="M:System.Xml.XmlText.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. <see langword="XmlText" /> nodes do not have children, so this method has no effect.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlText.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
- </member>
<member name="P:System.Xml.XmlText.LocalName">
<summary>Gets the local name of the node.</summary>
<returns>For text nodes, this property returns <see langword="#text" />.</returns>
<summary>Gets the text node that immediately precedes this node.</summary>
<returns>Returns <see cref="T:System.Xml.XmlNode" />.</returns>
</member>
+ <member name="M:System.Xml.XmlText.SplitText(System.Int32)">
+ <summary>Splits the node into two nodes at the specified offset, keeping both in the tree as siblings.</summary>
+ <param name="offset">The offset at which to split the node.</param>
+ <returns>The new node.</returns>
+ </member>
<member name="P:System.Xml.XmlText.Value">
<summary>Gets or sets the value of the node.</summary>
<returns>The content of the text node.</returns>
</member>
+ <member name="M:System.Xml.XmlText.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />. <see langword="XmlText" /> nodes do not have children, so this method has no effect.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="M:System.Xml.XmlText.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see langword="XmlWriter" /> to which you want to save.</param>
+ </member>
<member name="T:System.Xml.XmlTextReader">
- <summary>Represents a reader that provides fast, non-cached, forward-only access to XML data.
-
- Starting with the .NET Framework 2.0, we recommend that you use the <see cref="T:System.Xml.XmlReader" /> class instead.</summary>
+ <summary>Represents a reader that provides fast, non-cached, forward-only access to XML data.
+Starting with the .NET Framework 2.0, we recommend that you use the <see cref="T:System.Xml.XmlReader" /> class instead.</summary>
</member>
<member name="M:System.Xml.XmlTextReader.#ctor">
<summary>Initializes a new instance of the <see langword="XmlTextReader" />.</summary>
<exception cref="T:System.IO.DirectoryNotFoundException">Part of the filename or directory cannot be found.</exception>
<exception cref="T:System.InvalidOperationException">
<paramref name="url" /> is an empty string.</exception>
- <exception cref="T:System.Net.WebException">The remote filename cannot be resolved.
-
- -or-
-
- An error occurred while processing the request.</exception>
+ <exception cref="T:System.Net.WebException">The remote filename cannot be resolved.
+-or-
+An error occurred while processing the request.</exception>
<exception cref="T:System.UriFormatException">
<paramref name="url" /> is not a valid URI.</exception>
</member>
<exception cref="T:System.IO.DirectoryNotFoundException">Part of the filename or directory cannot be found.</exception>
<exception cref="T:System.InvalidOperationException">
<paramref name="url" /> is an empty string.</exception>
- <exception cref="T:System.Net.WebException">The remote filename cannot be resolved.
-
- -or-
-
- An error occurred while processing the request.</exception>
+ <exception cref="T:System.Net.WebException">The remote filename cannot be resolved.
+-or-
+An error occurred while processing the request.</exception>
<exception cref="T:System.UriFormatException">
<paramref name="url" /> is not a valid URI.</exception>
</member>
<summary>Initializes a new instance of the <see cref="T:System.Xml.XmlTextReader" /> class with the specified <see cref="T:System.Xml.XmlNameTable" />.</summary>
<param name="nt">The <see langword="XmlNameTable" /> to use.</param>
</member>
+ <member name="P:System.Xml.XmlTextReader.AttributeCount">
+ <summary>Gets the number of attributes on the current node.</summary>
+ <returns>The number of attributes on the current node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.BaseURI">
+ <summary>Gets the base URI of the current node.</summary>
+ <returns>The base URI of the current node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.CanReadBinaryContent">
+ <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlTextReader" /> implements the binary content read methods.</summary>
+ <returns>
+ <see langword="true" /> if the binary content read methods are implemented; otherwise <see langword="false" />. The <see cref="T:System.Xml.XmlTextReader" /> class always returns <see langword="true" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.CanReadValueChunk">
+ <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlTextReader" /> implements the <see cref="M:System.Xml.XmlReader.ReadValueChunk(System.Char[],System.Int32,System.Int32)" /> method.</summary>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Xml.XmlTextReader" /> implements the <see cref="M:System.Xml.XmlReader.ReadValueChunk(System.Char[],System.Int32,System.Int32)" /> method; otherwise <see langword="false" />. The <see cref="T:System.Xml.XmlTextReader" /> class always returns <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.CanResolveEntity">
+ <summary>Gets a value indicating whether this reader can parse and resolve entities.</summary>
+ <returns>
+ <see langword="true" /> if the reader can parse and resolve entities; otherwise, <see langword="false" />. The <see langword="XmlTextReader" /> class always returns <see langword="true" />.</returns>
+ </member>
<member name="M:System.Xml.XmlTextReader.Close">
<summary>Changes the <see cref="P:System.Xml.XmlReader.ReadState" /> to <see langword="Closed" />.</summary>
</member>
+ <member name="P:System.Xml.XmlTextReader.Depth">
+ <summary>Gets the depth of the current node in the XML document.</summary>
+ <returns>The depth of the current node in the XML document.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.DtdProcessing">
+ <summary>Gets or sets the <see cref="T:System.Xml.DtdProcessing" /> enumeration.</summary>
+ <returns>The <see cref="T:System.Xml.DtdProcessing" /> enumeration.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.Encoding">
+ <summary>Gets the encoding of the document.</summary>
+ <returns>The encoding value. If no encoding attribute exists, and there is no byte-order mark, this defaults to UTF-8.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.EntityHandling">
+ <summary>Gets or sets a value that specifies how the reader handles entities.</summary>
+ <returns>One of the <see cref="T:System.Xml.EntityHandling" /> values. If no <see langword="EntityHandling" /> is specified, it defaults to <see langword="EntityHandling.ExpandCharEntities" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.EOF">
+ <summary>Gets a value indicating whether the reader is positioned at the end of the stream.</summary>
+ <returns>
+ <see langword="true" /> if the reader is positioned at the end of the stream; otherwise, <see langword="false" />.</returns>
+ </member>
<member name="M:System.Xml.XmlTextReader.GetAttribute(System.Int32)">
<summary>Gets the value of the attribute with the specified index.</summary>
<param name="i">The index of the attribute. The index is zero-based. (The first attribute has index 0.)</param>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="i" /> parameter is less than 0 or greater than or equal to <see cref="P:System.Xml.XmlTextReader.AttributeCount" />.</exception>
<returns>The value of the specified attribute.</returns>
+ <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="i" /> parameter is less than 0 or greater than or equal to <see cref="P:System.Xml.XmlTextReader.AttributeCount" />.</exception>
</member>
<member name="M:System.Xml.XmlTextReader.GetAttribute(System.String)">
<summary>Gets the value of the attribute with the specified name.</summary>
<returns>
<see langword="true" /> if the class can return line information; otherwise, <see langword="false" />.</returns>
</member>
+ <member name="P:System.Xml.XmlTextReader.HasValue">
+ <summary>Gets a value indicating whether the current node can have a <see cref="P:System.Xml.XmlTextReader.Value" /> other than <see langword="String.Empty" />.</summary>
+ <returns>
+ <see langword="true" /> if the node on which the reader is currently positioned can have a <see langword="Value" />; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.IsDefault">
+ <summary>Gets a value indicating whether the current node is an attribute that was generated from the default value defined in the DTD or schema.</summary>
+ <returns>This property always returns <see langword="false" />. (<see cref="T:System.Xml.XmlTextReader" /> does not expand default attributes.)</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.IsEmptyElement">
+ <summary>Gets a value indicating whether the current node is an empty element (for example, <c><MyElement/></c>).</summary>
+ <returns>
+ <see langword="true" /> if the current node is an element (<see cref="P:System.Xml.XmlTextReader.NodeType" /> equals <see langword="XmlNodeType.Element" />) that ends with <c>/></c>; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.LineNumber">
+ <summary>Gets the current line number.</summary>
+ <returns>The current line number.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.LinePosition">
+ <summary>Gets the current line position.</summary>
+ <returns>The current line position.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.LocalName">
+ <summary>Gets the local name of the current node.</summary>
+ <returns>The name of the current node with the prefix removed. For example, <see langword="LocalName" /> is <see langword="book" /> for the element <c><bk:book></c>.
+For node types that do not have a name (like <see langword="Text" />, <see langword="Comment" />, and so on), this property returns <see langword="String.Empty" />.</returns>
+ </member>
<member name="M:System.Xml.XmlTextReader.LookupNamespace(System.String)">
<summary>Resolves a namespace prefix in the current element's scope.</summary>
<param name="prefix">The prefix whose namespace URI you want to resolve. To match the default namespace, pass an empty string. This string does not have to be atomized.</param>
- <exception cref="T:System.ArgumentNullException">The <see cref="P:System.Xml.XmlTextReader.Namespaces" /> property is set to <see langword="true" /> and the <paramref name="prefix" /> value is <see langword="null" />.</exception>
<returns>The namespace URI to which the prefix maps or <see langword="null" /> if no matching prefix is found.</returns>
+ <exception cref="T:System.ArgumentNullException">The <see cref="P:System.Xml.XmlTextReader.Namespaces" /> property is set to <see langword="true" /> and the <paramref name="prefix" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlTextReader.MoveToAttribute(System.Int32)">
<summary>Moves to the attribute with the specified index.</summary>
<returns>
<see langword="true" /> if there is a next attribute; <see langword="false" /> if there are no more attributes.</returns>
</member>
+ <member name="P:System.Xml.XmlTextReader.Name">
+ <summary>Gets the qualified name of the current node.</summary>
+ <returns>The qualified name of the current node. For example, <see langword="Name" /> is <see langword="bk:book" /> for the element <c><bk:book></c>.
+The name returned is dependent on the <see cref="P:System.Xml.XmlTextReader.NodeType" /> of the node. The following node types return the listed values. All other node types return an empty string.
+ Node Type
+
+ Name
+
+ <see langword="Attribute" /> The name of the attribute.
+
+ <see langword="DocumentType" /> The document type name.
+
+ <see langword="Element" /> The tag name.
+
+ <see langword="EntityReference" /> The name of the entity referenced.
+
+ <see langword="ProcessingInstruction" /> The target of the processing instruction.
+
+ <see langword="XmlDeclaration" /> The literal string <see langword="xml" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.Namespaces">
+ <summary>Gets or sets a value indicating whether to do namespace support.</summary>
+ <returns>
+ <see langword="true" /> to do namespace support; otherwise, <see langword="false" />. The default is <see langword="true" />.</returns>
+ <exception cref="T:System.InvalidOperationException">Setting this property after a read operation has occurred (<see cref="P:System.Xml.XmlTextReader.ReadState" /> is not <see langword="ReadState.Initial" />).</exception>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.NamespaceURI">
+ <summary>Gets the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned.</summary>
+ <returns>The namespace URI of the current node; otherwise an empty string.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.NameTable">
+ <summary>Gets the <see cref="T:System.Xml.XmlNameTable" /> associated with this implementation.</summary>
+ <returns>The <see langword="XmlNameTable" /> enabling you to get the atomized version of a string within the node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.NodeType">
+ <summary>Gets the type of the current node.</summary>
+ <returns>One of the <see cref="T:System.Xml.XmlNodeType" /> values representing the type of the current node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.Normalization">
+ <summary>Gets or sets a value indicating whether to normalize white space and attribute values.</summary>
+ <returns>
+ <see langword="true" /> to normalize; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
+ <exception cref="T:System.InvalidOperationException">Setting this property when the reader is closed (<see cref="P:System.Xml.XmlTextReader.ReadState" /> is <see langword="ReadState.Closed" />).</exception>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.Prefix">
+ <summary>Gets the namespace prefix associated with the current node.</summary>
+ <returns>The namespace prefix associated with the current node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.ProhibitDtd">
+ <summary>Gets or sets a value indicating whether to allow DTD processing. This property is obsolete. Use <see cref="P:System.Xml.XmlTextReader.DtdProcessing" /> instead.</summary>
+ <returns>
+ <see langword="true" /> to disallow DTD processing; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.QuoteChar">
+ <summary>Gets the quotation mark character used to enclose the value of an attribute node.</summary>
+ <returns>The quotation mark character (" or ') used to enclose the value of an attribute node.</returns>
+ </member>
<member name="M:System.Xml.XmlTextReader.Read">
<summary>Reads the next node from the stream.</summary>
- <exception cref="T:System.Xml.XmlException">An error occurred while parsing the XML.</exception>
<returns>
<see langword="true" /> if the next node was read successfully; <see langword="false" /> if there are no more nodes to read.</returns>
+ <exception cref="T:System.Xml.XmlException">An error occurred while parsing the XML.</exception>
</member>
<member name="M:System.Xml.XmlTextReader.ReadAttributeValue">
<summary>Parses the attribute value into one or more <see langword="Text" />, <see langword="EntityReference" />, or <see langword="EndEntity" /> nodes.</summary>
- <returns>
- <see langword="true" /> if there are nodes to return.
-
- <see langword="false" /> if the reader is not positioned on an attribute node when the initial call is made or if all the attribute values have been read.
-
- An empty attribute, such as, <c>misc=""</c>, returns <see langword="true" /> with a single node with a value of <see langword="String.Empty" />.</returns>
+ <returns>
+ <see langword="true" /> if there are nodes to return.
+<see langword="false" /> if the reader is not positioned on an attribute node when the initial call is made or if all the attribute values have been read.
+An empty attribute, such as, <c>misc=""</c>, returns <see langword="true" /> with a single node with a value of <see langword="String.Empty" />.</returns>
</member>
<member name="M:System.Xml.XmlTextReader.ReadBase64(System.Byte[],System.Int32,System.Int32)">
<summary>Decodes Base64 and returns the decoded binary bytes.</summary>
<param name="array">The array of characters that serves as the buffer to which the text contents are written.</param>
<param name="offset">The zero-based index into the array specifying where the method can begin to write to the buffer.</param>
<param name="len">The number of bytes to write into the buffer.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.Xml.XmlException">The Base64 sequence is not valid.</exception>
<exception cref="T:System.ArgumentNullException">The value of <paramref name="array" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="offset" /> < 0, or <paramref name="len" /> < 0, or <paramref name="len" /> > <paramref name="array" />.Length- <paramref name="offset" />.</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlTextReader.ReadBinHex(System.Byte[],System.Int32,System.Int32)">
<summary>Decodes <see langword="BinHex" /> and returns the decoded binary bytes.</summary>
<param name="array">The byte array that serves as the buffer to which the decoded binary bytes are written.</param>
<param name="offset">The zero-based index into the array specifying where the method can begin to write to the buffer.</param>
<param name="len">The number of bytes to write into the buffer.</param>
+ <returns>The number of bytes written to your buffer.</returns>
<exception cref="T:System.Xml.XmlException">The <see langword="BinHex" /> sequence is not valid.</exception>
<exception cref="T:System.ArgumentNullException">The value of <paramref name="array" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="offset" /> < 0, or <paramref name="len" /> < 0, or <paramref name="len" /> > <paramref name="array" />.Length- <paramref name="offset" />.</exception>
- <returns>The number of bytes written to your buffer.</returns>
</member>
<member name="M:System.Xml.XmlTextReader.ReadChars(System.Char[],System.Int32,System.Int32)">
<summary>Reads the text contents of an element into a character buffer. This method is designed to read large streams of embedded text by calling it successively.</summary>
<param name="buffer">The array of characters that serves as the buffer to which the text contents are written.</param>
<param name="index">The position within <paramref name="buffer" /> where the method can begin writing text contents.</param>
<param name="count">The number of characters to write into <paramref name="buffer" />.</param>
+ <returns>The number of characters read. This can be <see langword="0" /> if the reader is not positioned on an element or if there is no more text content to return in the current context.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="count" /> is greater than the space specified in the <paramref name="buffer" /> (buffer size - <paramref name="index" />).</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" />
<see langword="< 0" /> or <paramref name="count" /><see langword="< 0" />.</exception>
- <returns>The number of characters read. This can be <see langword="0" /> if the reader is not positioned on an element or if there is no more text content to return in the current context.</returns>
</member>
<member name="M:System.Xml.XmlTextReader.ReadContentAsBase64(System.Byte[],System.Int32,System.Int32)">
<summary>Reads the content and returns the <see langword="Base64" /> decoded binary bytes.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="M:System.Xml.XmlTextReader.ReadContentAsBase64(System.Byte[],System.Int32,System.Int32)" /> is not supported in the current node.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlTextReader.ReadContentAsBinHex(System.Byte[],System.Int32,System.Int32)">
<summary>Reads the content and returns the <see langword="BinHex" /> decoded binary bytes.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<see cref="M:System.Xml.XmlTextReader.ReadContentAsBinHex(System.Byte[],System.Int32,System.Int32)" /> is not supported on the current node.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlTextReader" /> implementation does not support this method.</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlTextReader.ReadElementContentAsBase64(System.Byte[],System.Int32,System.Int32)">
<summary>Reads the element and decodes the Base64 content.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The current node is not an element node.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlTextReader" /> implementation does not support this method.</exception>
<exception cref="T:System.Xml.XmlException">The element contains mixed-content.</exception>
<exception cref="T:System.FormatException">The content cannot be converted to the requested type.</exception>
- <returns>The number of bytes written to the buffer.</returns>
</member>
<member name="M:System.Xml.XmlTextReader.ReadElementContentAsBinHex(System.Byte[],System.Int32,System.Int32)">
<summary>Reads the element and decodes the <see langword="BinHex" /> content.</summary>
<param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
<param name="index">The offset into the buffer where to start copying the result.</param>
<param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The current node is not an element node.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlReader" /> implementation does not support this method.</exception>
<exception cref="T:System.Xml.XmlException">The element contains mixed-content.</exception>
<exception cref="T:System.FormatException">The content cannot be converted to the requested type.</exception>
- <returns>The number of bytes written to the buffer.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextReader.ReadState">
+ <summary>Gets the state of the reader.</summary>
+ <returns>One of the <see cref="T:System.Xml.ReadState" /> values.</returns>
</member>
<member name="M:System.Xml.XmlTextReader.ReadString">
<summary>Reads the contents of an element or a text node as a string.</summary>
+ <returns>The contents of the element or text node. This can be an empty string if the reader is positioned on something other than an element or text node, or if there is no more text content to return in the current context.
+<see langword="Note:" /> The text node can be either an element or an attribute text node.</returns>
<exception cref="T:System.Xml.XmlException">An error occurred while parsing the XML.</exception>
<exception cref="T:System.InvalidOperationException">An invalid operation was attempted.</exception>
- <returns>The contents of the element or text node. This can be an empty string if the reader is positioned on something other than an element or text node, or if there is no more text content to return in the current context.
-
- <see langword="Note:" /> The text node can be either an element or an attribute text node.</returns>
</member>
<member name="M:System.Xml.XmlTextReader.ResetState">
<summary>Resets the state of the reader to ReadState.Initial.</summary>
<param name="namespaceName">The namespace URI whose prefix you wish to find.</param>
<returns>The prefix that is mapped to the namespace URI; <see langword="null" /> if the namespace URI is not mapped to a prefix.</returns>
</member>
- <member name="P:System.Xml.XmlTextReader.AttributeCount">
- <summary>Gets the number of attributes on the current node.</summary>
- <returns>The number of attributes on the current node.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.BaseURI">
- <summary>Gets the base URI of the current node.</summary>
- <returns>The base URI of the current node.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.CanReadBinaryContent">
- <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlTextReader" /> implements the binary content read methods.</summary>
- <returns>
- <see langword="true" /> if the binary content read methods are implemented; otherwise <see langword="false" />. The <see cref="T:System.Xml.XmlTextReader" /> class always returns <see langword="true" />.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.CanReadValueChunk">
- <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlTextReader" /> implements the <see cref="M:System.Xml.XmlReader.ReadValueChunk(System.Char[],System.Int32,System.Int32)" /> method.</summary>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Xml.XmlTextReader" /> implements the <see cref="M:System.Xml.XmlReader.ReadValueChunk(System.Char[],System.Int32,System.Int32)" /> method; otherwise <see langword="false" />. The <see cref="T:System.Xml.XmlTextReader" /> class always returns <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.CanResolveEntity">
- <summary>Gets a value indicating whether this reader can parse and resolve entities.</summary>
- <returns>
- <see langword="true" /> if the reader can parse and resolve entities; otherwise, <see langword="false" />. The <see langword="XmlTextReader" /> class always returns <see langword="true" />.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.Depth">
- <summary>Gets the depth of the current node in the XML document.</summary>
- <returns>The depth of the current node in the XML document.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.DtdProcessing">
- <summary>Gets or sets the <see cref="T:System.Xml.DtdProcessing" /> enumeration.</summary>
- <returns>The <see cref="T:System.Xml.DtdProcessing" /> enumeration.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.Encoding">
- <summary>Gets the encoding of the document.</summary>
- <returns>The encoding value. If no encoding attribute exists, and there is no byte-order mark, this defaults to UTF-8.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.EntityHandling">
- <summary>Gets or sets a value that specifies how the reader handles entities.</summary>
- <returns>One of the <see cref="T:System.Xml.EntityHandling" /> values. If no <see langword="EntityHandling" /> is specified, it defaults to <see langword="EntityHandling.ExpandCharEntities" />.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.EOF">
- <summary>Gets a value indicating whether the reader is positioned at the end of the stream.</summary>
- <returns>
- <see langword="true" /> if the reader is positioned at the end of the stream; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.HasValue">
- <summary>Gets a value indicating whether the current node can have a <see cref="P:System.Xml.XmlTextReader.Value" /> other than <see langword="String.Empty" />.</summary>
- <returns>
- <see langword="true" /> if the node on which the reader is currently positioned can have a <see langword="Value" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.IsDefault">
- <summary>Gets a value indicating whether the current node is an attribute that was generated from the default value defined in the DTD or schema.</summary>
- <returns>This property always returns <see langword="false" />. (<see cref="T:System.Xml.XmlTextReader" /> does not expand default attributes.)</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.IsEmptyElement">
- <summary>Gets a value indicating whether the current node is an empty element (for example, <c><MyElement/></c>).</summary>
- <returns>
- <see langword="true" /> if the current node is an element (<see cref="P:System.Xml.XmlTextReader.NodeType" /> equals <see langword="XmlNodeType.Element" />) that ends with <c>/></c>; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.LineNumber">
- <summary>Gets the current line number.</summary>
- <returns>The current line number.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.LinePosition">
- <summary>Gets the current line position.</summary>
- <returns>The current line position.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.LocalName">
- <summary>Gets the local name of the current node.</summary>
- <returns>The name of the current node with the prefix removed. For example, <see langword="LocalName" /> is <see langword="book" /> for the element <c><bk:book></c>.
+ <member name="P:System.Xml.XmlTextReader.Value">
+ <summary>Gets the text value of the current node.</summary>
+ <returns>The value returned depends on the <see cref="P:System.Xml.XmlTextReader.NodeType" /> of the node. The following table lists node types that have a value to return. All other node types return <see langword="String.Empty" />.
+ Node Type
- For node types that do not have a name (like <see langword="Text" />, <see langword="Comment" />, and so on), this property returns <see langword="String.Empty" />.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.Name">
- <summary>Gets the qualified name of the current node.</summary>
- <returns>The qualified name of the current node. For example, <see langword="Name" /> is <see langword="bk:book" /> for the element <c><bk:book></c>.
+ Value
- The name returned is dependent on the <see cref="P:System.Xml.XmlTextReader.NodeType" /> of the node. The following node types return the listed values. All other node types return an empty string.
+ <see langword="Attribute" /> The value of the attribute.
- <list type="table"><listheader><term> Node Type</term><description> Name</description></listheader><item><term><see langword="Attribute" /></term><description> The name of the attribute.</description></item><item><term><see langword="DocumentType" /></term><description> The document type name.</description></item><item><term><see langword="Element" /></term><description> The tag name.</description></item><item><term><see langword="EntityReference" /></term><description> The name of the entity referenced.</description></item><item><term><see langword="ProcessingInstruction" /></term><description> The target of the processing instruction.</description></item><item><term><see langword="XmlDeclaration" /></term><description> The literal string <see langword="xml" />.</description></item></list></returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.Namespaces">
- <summary>Gets or sets a value indicating whether to do namespace support.</summary>
- <exception cref="T:System.InvalidOperationException">Setting this property after a read operation has occurred (<see cref="P:System.Xml.XmlTextReader.ReadState" /> is not <see langword="ReadState.Initial" />).</exception>
- <returns>
- <see langword="true" /> to do namespace support; otherwise, <see langword="false" />. The default is <see langword="true" />.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.NamespaceURI">
- <summary>Gets the namespace URI (as defined in the W3C Namespace specification) of the node on which the reader is positioned.</summary>
- <returns>The namespace URI of the current node; otherwise an empty string.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.NameTable">
- <summary>Gets the <see cref="T:System.Xml.XmlNameTable" /> associated with this implementation.</summary>
- <returns>The <see langword="XmlNameTable" /> enabling you to get the atomized version of a string within the node.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.NodeType">
- <summary>Gets the type of the current node.</summary>
- <returns>One of the <see cref="T:System.Xml.XmlNodeType" /> values representing the type of the current node.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.Normalization">
- <summary>Gets or sets a value indicating whether to normalize white space and attribute values.</summary>
- <exception cref="T:System.InvalidOperationException">Setting this property when the reader is closed (<see cref="P:System.Xml.XmlTextReader.ReadState" /> is <see langword="ReadState.Closed" />).</exception>
- <returns>
- <see langword="true" /> to normalize; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.Prefix">
- <summary>Gets the namespace prefix associated with the current node.</summary>
- <returns>The namespace prefix associated with the current node.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.ProhibitDtd">
- <summary>Gets or sets a value indicating whether to allow DTD processing. This property is obsolete. Use <see cref="P:System.Xml.XmlTextReader.DtdProcessing" /> instead.</summary>
- <returns>
- <see langword="true" /> to disallow DTD processing; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.QuoteChar">
- <summary>Gets the quotation mark character used to enclose the value of an attribute node.</summary>
- <returns>The quotation mark character (" or ') used to enclose the value of an attribute node.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.ReadState">
- <summary>Gets the state of the reader.</summary>
- <returns>One of the <see cref="T:System.Xml.ReadState" /> values.</returns>
- </member>
- <member name="P:System.Xml.XmlTextReader.Value">
- <summary>Gets the text value of the current node.</summary>
- <returns>The value returned depends on the <see cref="P:System.Xml.XmlTextReader.NodeType" /> of the node. The following table lists node types that have a value to return. All other node types return <see langword="String.Empty" />.
+ <see langword="CDATA" /> The content of the CDATA section.
+
+ <see langword="Comment" /> The content of the comment.
+
+ <see langword="DocumentType" /> The internal subset.
+
+ <see langword="ProcessingInstruction" /> The entire content, excluding the target.
- <list type="table"><listheader><term> Node Type</term><description> Value</description></listheader><item><term><see langword="Attribute" /></term><description> The value of the attribute.</description></item><item><term><see langword="CDATA" /></term><description> The content of the CDATA section.</description></item><item><term><see langword="Comment" /></term><description> The content of the comment.</description></item><item><term><see langword="DocumentType" /></term><description> The internal subset.</description></item><item><term><see langword="ProcessingInstruction" /></term><description> The entire content, excluding the target.</description></item><item><term><see langword="SignificantWhitespace" /></term><description> The white space within an <see langword="xml:space" />= 'preserve' scope.</description></item><item><term><see langword="Text" /></term><description> The content of the text node.</description></item><item><term><see langword="Whitespace" /></term><description> The white space between markup.</description></item><item><term><see langword="XmlDeclaration" /></term><description> The content of the declaration.</description></item></list></returns>
+ <see langword="SignificantWhitespace" /> The white space within an <see langword="xml:space" />= 'preserve' scope.
+
+ <see langword="Text" /> The content of the text node.
+
+ <see langword="Whitespace" /> The white space between markup.
+
+ <see langword="XmlDeclaration" /> The content of the declaration.</returns>
</member>
<member name="P:System.Xml.XmlTextReader.WhitespaceHandling">
<summary>Gets or sets a value that specifies how white space is handled.</summary>
+ <returns>One of the <see cref="T:System.Xml.WhitespaceHandling" /> values. The default is <see langword="WhitespaceHandling.All" /> (returns <see langword="Whitespace" /> and <see langword="SignificantWhitespace" /> nodes).</returns>
<exception cref="T:System.ArgumentOutOfRangeException">Invalid value specified.</exception>
<exception cref="T:System.InvalidOperationException">Setting this property when the reader is closed (<see cref="P:System.Xml.XmlTextReader.ReadState" /> is <see langword="ReadState.Closed" />).</exception>
- <returns>One of the <see cref="T:System.Xml.WhitespaceHandling" /> values. The default is <see langword="WhitespaceHandling.All" /> (returns <see langword="Whitespace" /> and <see langword="SignificantWhitespace" /> nodes).</returns>
</member>
<member name="P:System.Xml.XmlTextReader.XmlLang">
<summary>Gets the current <see langword="xml:lang" /> scope.</summary>
</member>
<member name="P:System.Xml.XmlTextReader.XmlResolver">
<summary>Sets the <see cref="T:System.Xml.XmlResolver" /> used for resolving DTD references.</summary>
- <returns>The <see langword="XmlResolver" /> to use. If set to <see langword="null" />, external resources are not resolved.
-
- In version 1.1 of the .NET Framework, the caller must be fully trusted in order to specify an <see langword="XmlResolver" />.</returns>
+ <returns>The <see langword="XmlResolver" /> to use. If set to <see langword="null" />, external resources are not resolved.
+In version 1.1 of the .NET Framework, the caller must be fully trusted in order to specify an <see langword="XmlResolver" />.</returns>
</member>
<member name="P:System.Xml.XmlTextReader.XmlSpace">
<summary>Gets the current <see langword="xml:space" /> scope.</summary>
<returns>One of the <see cref="T:System.Xml.XmlSpace" /> values. If no <see langword="xml:space" /> scope exists, this property defaults to <see langword="XmlSpace.None" />.</returns>
</member>
<member name="T:System.Xml.XmlTextWriter">
- <summary>Represents a writer that provides a fast, non-cached, forward-only way of generating streams or files containing XML data that conforms to the W3C Extensible Markup Language (XML) 1.0 and the Namespaces in XML recommendations.
-
- Starting with the .NET Framework 2.0, we recommend that you use the <see cref="T:System.Xml.XmlWriter" /> class instead.</summary>
+ <summary>Represents a writer that provides a fast, non-cached, forward-only way of generating streams or files containing XML data that conforms to the W3C Extensible Markup Language (XML) 1.0 and the Namespaces in XML recommendations.
+Starting with the .NET Framework 2.0, we recommend that you use the <see cref="T:System.Xml.XmlWriter" /> class instead.</summary>
</member>
<member name="M:System.Xml.XmlTextWriter.#ctor(System.IO.Stream,System.Text.Encoding)">
<summary>Creates an instance of the <see langword="XmlTextWriter" /> class using the specified stream and encoding.</summary>
<exception cref="T:System.IO.IOException">The filename includes an incorrect or invalid syntax for file name, directory name, or volume label syntax.</exception>
<exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
</member>
+ <member name="P:System.Xml.XmlTextWriter.BaseStream">
+ <summary>Gets the underlying stream object.</summary>
+ <returns>The stream to which the <see langword="XmlTextWriter" /> is writing or <see langword="null" /> if the <see langword="XmlTextWriter" /> was constructed using a <see cref="T:System.IO.TextWriter" /> that does not inherit from the <see cref="T:System.IO.StreamWriter" /> class.</returns>
+ </member>
<member name="M:System.Xml.XmlTextWriter.Close">
<summary>Closes this stream and the underlying stream.</summary>
</member>
<member name="M:System.Xml.XmlTextWriter.Flush">
<summary>Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream.</summary>
</member>
+ <member name="P:System.Xml.XmlTextWriter.Formatting">
+ <summary>Indicates how the output is formatted.</summary>
+ <returns>One of the <see cref="T:System.Xml.Formatting" /> values. The default is <see langword="Formatting.None" /> (no special formatting).</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextWriter.Indentation">
+ <summary>Gets or sets how many IndentChars to write for each level in the hierarchy when <see cref="P:System.Xml.XmlTextWriter.Formatting" /> is set to <see langword="Formatting.Indented" />.</summary>
+ <returns>Number of <see langword="IndentChars" /> for each level. The default is 2.</returns>
+ <exception cref="T:System.ArgumentException">Setting this property to a negative value.</exception>
+ </member>
+ <member name="P:System.Xml.XmlTextWriter.IndentChar">
+ <summary>Gets or sets which character to use for indenting when <see cref="P:System.Xml.XmlTextWriter.Formatting" /> is set to <see langword="Formatting.Indented" />.</summary>
+ <returns>The character to use for indenting. The default is space.
+
+The <see langword="XmlTextWriter" /> allows you to set this property to any character. To ensure valid XML, you must specify a valid white space character, 0x9, 0x10, 0x13 or 0x20.</returns>
+ </member>
<member name="M:System.Xml.XmlTextWriter.LookupPrefix(System.String)">
<summary>Returns the closest prefix defined in the current namespace scope for the namespace URI.</summary>
<param name="ns">Namespace URI whose prefix you want to find.</param>
+ <returns>The matching prefix. Or <see langword="null" /> if no matching namespace URI is found in the current scope.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="ns" /> is either <see langword="null" /> or <see langword="String.Empty" />.</exception>
- <returns>The matching prefix. Or <see langword="null" /> if no matching namespace URI is found in the current scope.</returns>
+ </member>
+ <member name="P:System.Xml.XmlTextWriter.Namespaces">
+ <summary>Gets or sets a value indicating whether to do namespace support.</summary>
+ <returns>
+ <see langword="true" /> to support namespaces; otherwise, <see langword="false" />.
+The default is <see langword="true" />.</returns>
+ <exception cref="T:System.InvalidOperationException">You can only change this property when in the <see langword="WriteState.Start" /> state.</exception>
+ </member>
+ <member name="P:System.Xml.XmlTextWriter.QuoteChar">
+ <summary>Gets or sets which character to use to quote attribute values.</summary>
+ <returns>The character to use to quote attribute values. This must be a single quote (&#39;) or a double quote (&#34;). The default is a double quote.</returns>
+ <exception cref="T:System.ArgumentException">Setting this property to something other than either a single or double quote.</exception>
</member>
<member name="M:System.Xml.XmlTextWriter.WriteBase64(System.Byte[],System.Int32,System.Int32)">
<summary>Encodes the specified binary bytes as base64 and writes out the resulting text.</summary>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index" /> or <paramref name="count" /> is less than zero.
-
- -or-
-
- The buffer length minus <paramref name="index" /> is less than <paramref name="count" />; the call results in surrogate pair characters being split or an invalid surrogate pair being written.</exception>
+ <paramref name="index" /> or <paramref name="count" /> is less than zero.
+-or-
+The buffer length minus <paramref name="index" /> is less than <paramref name="count" />; the call results in surrogate pair characters being split or an invalid surrogate pair being written.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is Closed.</exception>
</member>
<member name="M:System.Xml.XmlTextWriter.WriteComment(System.String)">
<summary>Writes out a comment <!--...--> containing the specified text.</summary>
<param name="text">Text to place inside the comment.</param>
- <exception cref="T:System.ArgumentException">The text would result in a non-well formed XML document.</exception>
+ <exception cref="T:System.ArgumentException">The text would result in a non-well formed XML document</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see langword="Closed" />.</exception>
</member>
<member name="M:System.Xml.XmlTextWriter.WriteDocType(System.String,System.String,System.String,System.String)">
<param name="subset">If non-null it writes [subset] where subset is replaced with the value of this argument.</param>
<exception cref="T:System.InvalidOperationException">This method was called outside the prolog (after the root element).</exception>
<exception cref="T:System.ArgumentException">
- <paramref name="name" /> is <see langword="null" /> or <see langword="String.Empty" />
-
- -or-
-
- the value for <paramref name="name" /> would result in invalid XML.</exception>
+ <paramref name="name" /> is <see langword="null" /> or <see langword="String.Empty" />
+-or-
+the value for <paramref name="name" /> would result in invalid XML.</exception>
</member>
<member name="M:System.Xml.XmlTextWriter.WriteEndAttribute">
<summary>Closes the previous <see cref="M:System.Xml.XmlTextWriter.WriteStartAttribute(System.String,System.String,System.String)" /> call.</summary>
<summary>Writes out a processing instruction with a space between the name and text as follows: <?name text?>.</summary>
<param name="name">Name of the processing instruction.</param>
<param name="text">Text to include in the processing instruction.</param>
- <exception cref="T:System.ArgumentException">The text would result in a non-well formed XML document.
-
- <paramref name="name" /> is either <see langword="null" /> or <see langword="String.Empty" />.
-
- This method is being used to create an XML declaration after <see cref="M:System.Xml.XmlTextWriter.WriteStartDocument" /> has already been called.</exception>
+ <exception cref="T:System.ArgumentException">The text would result in a non-well formed XML document.
+<paramref name="name" /> is either <see langword="null" /> or <see langword="String.Empty" />.
+This method is being used to create an XML declaration after <see cref="M:System.Xml.XmlTextWriter.WriteStartDocument" /> has already been called.</exception>
</member>
<member name="M:System.Xml.XmlTextWriter.WriteQualifiedName(System.String,System.String)">
<summary>Writes out the namespace-qualified name. This method looks up the prefix that is in scope for the given namespace.</summary>
<param name="localName">The local name to write.</param>
<param name="ns">The namespace URI to associate with the name.</param>
<exception cref="T:System.ArgumentException">
- <paramref name="localName" /> is either <see langword="null" /> or <see langword="String.Empty" />.
-
- <paramref name="localName" /> is not a valid name according to the W3C Namespaces spec.</exception>
+ <paramref name="localName" /> is either <see langword="null" /> or <see langword="String.Empty" />.
+<paramref name="localName" /> is not a valid name according to the W3C Namespaces spec.</exception>
</member>
<member name="M:System.Xml.XmlTextWriter.WriteRaw(System.Char[],System.Int32,System.Int32)">
<summary>Writes raw markup manually from a character buffer.</summary>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index" /> or <paramref name="count" /> is less than zero.
-
- -or-
-
- The buffer length minus <paramref name="index" /> is less than <paramref name="count" />.</exception>
+ <paramref name="index" /> or <paramref name="count" /> is less than zero.
+-or-
+The buffer length minus <paramref name="index" /> is less than <paramref name="count" />.</exception>
</member>
<member name="M:System.Xml.XmlTextWriter.WriteRaw(System.String)">
<summary>Writes raw markup manually from a string.</summary>
<param name="localName">
<see langword="LocalName" /> of the attribute.</param>
<param name="ns">
- <see langword="NamespaceURI" /> of the attribute.</param>
+ <see langword="NamespaceURI" /> of the attribute</param>
<exception cref="T:System.ArgumentException">
<paramref name="localName" /> is either <see langword="null" /> or <see langword="String.Empty" />.</exception>
</member>
<param name="ns">The namespace URI to associate with the element. If this namespace is already in scope and has an associated prefix then the writer automatically writes that prefix also.</param>
<exception cref="T:System.InvalidOperationException">The writer is closed.</exception>
</member>
+ <member name="P:System.Xml.XmlTextWriter.WriteState">
+ <summary>Gets the state of the writer.</summary>
+ <returns>One of the <see cref="T:System.Xml.WriteState" /> values.</returns>
+ </member>
<member name="M:System.Xml.XmlTextWriter.WriteString(System.String)">
<summary>Writes the given text content.</summary>
<param name="text">Text to write.</param>
<param name="ws">The string of white space characters.</param>
<exception cref="T:System.ArgumentException">The string contains non-white space characters.</exception>
</member>
- <member name="P:System.Xml.XmlTextWriter.BaseStream">
- <summary>Gets the underlying stream object.</summary>
- <returns>The stream to which the <see langword="XmlTextWriter" /> is writing or <see langword="null" /> if the <see langword="XmlTextWriter" /> was constructed using a <see cref="T:System.IO.TextWriter" /> that does not inherit from the <see cref="T:System.IO.StreamWriter" /> class.</returns>
- </member>
- <member name="P:System.Xml.XmlTextWriter.Formatting">
- <summary>Indicates how the output is formatted.</summary>
- <returns>One of the <see cref="T:System.Xml.Formatting" /> values. The default is <see langword="Formatting.None" /> (no special formatting).</returns>
- </member>
- <member name="P:System.Xml.XmlTextWriter.Indentation">
- <summary>Gets or sets how many IndentChars to write for each level in the hierarchy when <see cref="P:System.Xml.XmlTextWriter.Formatting" /> is set to <see langword="Formatting.Indented" />.</summary>
- <exception cref="T:System.ArgumentException">Setting this property to a negative value.</exception>
- <returns>Number of <see langword="IndentChars" /> for each level. The default is 2.</returns>
- </member>
- <member name="P:System.Xml.XmlTextWriter.IndentChar">
- <summary>Gets or sets which character to use for indenting when <see cref="P:System.Xml.XmlTextWriter.Formatting" /> is set to <see langword="Formatting.Indented" />.</summary>
- <returns>The character to use for indenting. The default is space.</returns>
- </member>
- <member name="P:System.Xml.XmlTextWriter.Namespaces">
- <summary>Gets or sets a value indicating whether to do namespace support.</summary>
- <exception cref="T:System.InvalidOperationException">You can only change this property when in the <see langword="WriteState.Start" /> state.</exception>
- <returns>
- <see langword="true" /> to support namespaces; otherwise, <see langword="false" />.
-
- The default is <see langword="true" />.</returns>
- </member>
- <member name="P:System.Xml.XmlTextWriter.QuoteChar">
- <summary>Gets or sets which character to use to quote attribute values.</summary>
- <exception cref="T:System.ArgumentException">Setting this property to something other than either a single or double quote.</exception>
- <returns>The character to use to quote attribute values. This must be a single quote (&#39;) or a double quote (&#34;). The default is a double quote.</returns>
- </member>
- <member name="P:System.Xml.XmlTextWriter.WriteState">
- <summary>Gets the state of the writer.</summary>
- <returns>One of the <see cref="T:System.Xml.WriteState" /> values.</returns>
- </member>
<member name="P:System.Xml.XmlTextWriter.XmlLang">
<summary>Gets the current <see langword="xml:lang" /> scope.</summary>
<returns>The current <see langword="xml:lang" /> or <see langword="null" /> if there is no <see langword="xml:lang" /> in the current scope.</returns>
</member>
<member name="P:System.Xml.XmlTextWriter.XmlSpace">
<summary>Gets an <see cref="T:System.Xml.XmlSpace" /> representing the current <see langword="xml:space" /> scope.</summary>
- <returns>An <see langword="XmlSpace" /> representing the current <see langword="xml:space" /> scope.
+ <returns>An <see langword="XmlSpace" /> representing the current <see langword="xml:space" /> scope.
+ Value
- <list type="table"><listheader><term> Value</term><description> Meaning</description></listheader><item><term> None</term><description> This is the default if no <see langword="xml:space" /> scope exists.</description></item><item><term> Default</term><description> The current scope is <see langword="xml:space" />="default".</description></item><item><term> Preserve</term><description> The current scope is <see langword="xml:space" />="preserve".</description></item></list></returns>
+ Meaning
+
+ None
+
+ This is the default if no <see langword="xml:space" /> scope exists.
+
+ Default
+
+ The current scope is <see langword="xml:space" />="default".
+
+ Preserve
+
+ The current scope is <see langword="xml:space" />="preserve".</returns>
</member>
<member name="T:System.Xml.XmlTokenizedType">
<summary>Represents the XML type for the string. This allows the string to be read as a particular XML type, for example a CDATA section type.</summary>
<member name="M:System.Xml.XmlUrlResolver.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.XmlUrlResolver" /> class.</summary>
</member>
+ <member name="P:System.Xml.XmlUrlResolver.CachePolicy">
+ <summary>Gets or sets the cache policy for the underlying <see cref="T:System.Net.WebRequest" /> object.</summary>
+ <returns>The cache policy for the underlying web request.</returns>
+ </member>
+ <member name="P:System.Xml.XmlUrlResolver.Credentials">
+ <summary>Sets credentials used to authenticate web requests.</summary>
+ <returns>The credentials to be used to authenticate web requests. If this property is not set, the value defaults to <see langword="null" />; that is, the <see langword="XmlUrlResolver" /> has no user credentials.</returns>
+ </member>
<member name="M:System.Xml.XmlUrlResolver.GetEntity(System.Uri,System.String,System.Type)">
<summary>Maps a URI to an object that contains the actual resource.</summary>
<param name="absoluteUri">The URI returned from <see cref="M:System.Xml.XmlResolver.ResolveUri(System.Uri,System.String)" />.</param>
<param name="role">Currently not used.</param>
<param name="ofObjectToReturn">The type of object to return. The current implementation only returns <see cref="T:System.IO.Stream" /> objects.</param>
+ <returns>A stream object or <see langword="null" /> if a type other than stream is specified.</returns>
<exception cref="T:System.Xml.XmlException">
<paramref name="ofObjectToReturn" /> is neither <see langword="null" /> nor a <see langword="Stream" /> type.</exception>
<exception cref="T:System.UriFormatException">The specified URI is not an absolute URI.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="absoluteUri" /> is <see langword="null" />.</exception>
<exception cref="T:System.Exception">There is a runtime error (for example, an interrupted server connection).</exception>
- <returns>A stream object or <see langword="null" /> if a type other than stream is specified.</returns>
</member>
<member name="M:System.Xml.XmlUrlResolver.GetEntityAsync(System.Uri,System.String,System.Type)">
<summary>Asynchronously maps a URI to an object that contains the actual resource.</summary>
<param name="ofObjectToReturn">The type of object to return. The current implementation only returns <see cref="T:System.IO.Stream" /> objects.</param>
<returns>A stream object or <see langword="null" /> if a type other than stream is specified.</returns>
</member>
- <member name="M:System.Xml.XmlUrlResolver.ResolveUri(System.Uri,System.String)">
- <summary>Resolves the absolute URI from the base and relative URIs.</summary>
- <param name="baseUri">The base URI used to resolve the relative URI.</param>
- <param name="relativeUri">The URI to resolve. The URI can be absolute or relative. If absolute, this value effectively replaces the <paramref name="baseUri" /> value. If relative, it combines with the <paramref name="baseUri" /> to make an absolute URI.</param>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="baseUri" /> is <see langword="null" /> or <paramref name="relativeUri" /> is <see langword="null" />.</exception>
- <returns>The absolute URI, or <see langword="null" /> if the relative URI cannot be resolved.</returns>
- </member>
- <member name="P:System.Xml.XmlUrlResolver.CachePolicy">
- <summary>Gets or sets the cache policy for the underlying <see cref="T:System.Net.WebRequest" /> object.</summary>
- <returns>The cache policy for the underlying web request.</returns>
- </member>
- <member name="P:System.Xml.XmlUrlResolver.Credentials">
- <summary>Sets credentials used to authenticate web requests.</summary>
- <returns>The credentials to be used to authenticate web requests. If this property is not set, the value defaults to <see langword="null" />; that is, the <see langword="XmlUrlResolver" /> has no user credentials.</returns>
- </member>
<member name="P:System.Xml.XmlUrlResolver.Proxy">
<summary>Gets or sets the network proxy for the underlying <see cref="T:System.Net.WebRequest" /> object.</summary>
<returns>The <see cref="T:System.Net.IWebProxy" /> to use to access the Internet resource.</returns>
</member>
- <member name="T:System.Xml.XmlValidatingReader">
- <summary>Represents a reader that provides document type definition (DTD), XML-Data Reduced (XDR) schema, and XML Schema definition language (XSD) validation.
-
- This class is obsolete. Starting with the .NET Framework 2.0, we recommend that you use the <see cref="T:System.Xml.XmlReaderSettings" /> class and the <see cref="Overload:System.Xml.XmlReader.Create" /> method to create a validating XML reader.</summary>
+ <member name="M:System.Xml.XmlUrlResolver.ResolveUri(System.Uri,System.String)">
+ <summary>Resolves the absolute URI from the base and relative URIs.</summary>
+ <param name="baseUri">The base URI used to resolve the relative URI.</param>
+ <param name="relativeUri">The URI to resolve. The URI can be absolute or relative. If absolute, this value effectively replaces the <paramref name="baseUri" /> value. If relative, it combines with the <paramref name="baseUri" /> to make an absolute URI.</param>
+ <returns>The absolute URI, or <see langword="null" /> if the relative URI cannot be resolved.</returns>
+ <exception cref="T:System.ArgumentNullException">
+ <paramref name="baseUri" /> is <see langword="null" /> or <paramref name="relativeUri" /> is <see langword="null" />.</exception>
</member>
- <member name="E:System.Xml.XmlValidatingReader.ValidationEventHandler">
- <summary>Sets an event handler for receiving information about document type definition (DTD), XML-Data Reduced (XDR) schema, and XML Schema definition language (XSD) schema validation errors.</summary>
+ <member name="T:System.Xml.XmlValidatingReader">
+ <summary>Represents a reader that provides document type definition (DTD), XML-Data Reduced (XDR) schema, and XML Schema definition language (XSD) validation.
+This class is obsolete. Starting with the .NET Framework 2.0, we recommend that you use the <see cref="T:System.Xml.XmlReaderSettings" /> class and the <see cref="Overload:System.Xml.XmlReader.Create" /> method to create a validating XML reader.</summary>
</member>
<member name="M:System.Xml.XmlValidatingReader.#ctor(System.IO.Stream,System.Xml.XmlNodeType,System.Xml.XmlParserContext)">
<summary>Initializes a new instance of the <see langword="XmlValidatingReader" /> class with the specified values.</summary>
<param name="reader">The <see langword="XmlReader" /> to read from while validating. The current implementation supports only <see cref="T:System.Xml.XmlTextReader" />.</param>
<exception cref="T:System.ArgumentException">The reader specified is not an <see langword="XmlTextReader" />.</exception>
</member>
+ <member name="P:System.Xml.XmlValidatingReader.AttributeCount">
+ <summary>Gets the number of attributes on the current node.</summary>
+ <returns>The number of attributes on the current node. This number includes default attributes.</returns>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.BaseURI">
+ <summary>Gets the base URI of the current node.</summary>
+ <returns>The base URI of the current node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.CanReadBinaryContent">
+ <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlValidatingReader" /> implements the binary content read methods.</summary>
+ <returns>
+ <see langword="true" /> if the binary content read methods are implemented; otherwise <see langword="false" />. The <see cref="T:System.Xml.XmlValidatingReader" /> class returns <see langword="true" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.CanResolveEntity">
+ <summary>Gets a value indicating whether this reader can parse and resolve entities.</summary>
+ <returns>
+ <see langword="true" /> if the reader can parse and resolve entities; otherwise, <see langword="false" />. <see langword="XmlValidatingReader" /> always returns <see langword="true" />.</returns>
+ </member>
<member name="M:System.Xml.XmlValidatingReader.Close">
<summary>Changes the <see cref="P:System.Xml.XmlReader.ReadState" /> to Closed.</summary>
</member>
+ <member name="P:System.Xml.XmlValidatingReader.Depth">
+ <summary>Gets the depth of the current node in the XML document.</summary>
+ <returns>The depth of the current node in the XML document.</returns>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.Encoding">
+ <summary>Gets the encoding attribute for the document.</summary>
+ <returns>The encoding value. If no encoding attribute exists, and there is not byte-order mark, this defaults to UTF-8.</returns>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.EntityHandling">
+ <summary>Gets or sets a value that specifies how the reader handles entities.</summary>
+ <returns>One of the <see cref="T:System.Xml.EntityHandling" /> values. If no <see langword="EntityHandling" /> is specified, it defaults to EntityHandling.ExpandEntities.</returns>
+ <exception cref="T:System.ArgumentOutOfRangeException">Invalid value was specified.</exception>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.EOF">
+ <summary>Gets a value indicating whether the reader is positioned at the end of the stream.</summary>
+ <returns>
+ <see langword="true" /> if the reader is positioned at the end of the stream; otherwise, <see langword="false" />.</returns>
+ </member>
<member name="M:System.Xml.XmlValidatingReader.GetAttribute(System.Int32)">
<summary>Gets the value of the attribute with the specified index.</summary>
<param name="i">The index of the attribute. The index is zero-based. (The first attribute has index 0.)</param>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="i" /> parameter is less than 0 or greater than or equal to <see cref="P:System.Xml.XmlValidatingReader.AttributeCount" />.</exception>
<returns>The value of the specified attribute.</returns>
+ <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="i" /> parameter is less than 0 or greater than or equal to <see cref="P:System.Xml.XmlValidatingReader.AttributeCount" />.</exception>
</member>
<member name="M:System.Xml.XmlValidatingReader.GetAttribute(System.String)">
<summary>Gets the value of the attribute with the specified name.</summary>
<returns>
<see langword="true" /> if the class can return line information; otherwise, <see langword="false" />.</returns>
</member>
+ <member name="P:System.Xml.XmlValidatingReader.HasValue">
+ <summary>Gets a value indicating whether the current node can have a <see cref="P:System.Xml.XmlValidatingReader.Value" /> other than String.Empty.</summary>
+ <returns>
+ <see langword="true" /> if the node on which the reader is currently positioned can have a <see langword="Value" />; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.IsDefault">
+ <summary>Gets a value indicating whether the current node is an attribute that was generated from the default value defined in the document type definition (DTD) or schema.</summary>
+ <returns>
+ <see langword="true" /> if the current node is an attribute whose value was generated from the default value defined in the DTD or schema; <see langword="false" /> if the attribute value was explicitly set.</returns>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.IsEmptyElement">
+ <summary>Gets a value indicating whether the current node is an empty element (for example, <c><MyElement/></c>).</summary>
+ <returns>
+ <see langword="true" /> if the current node is an element (<see cref="P:System.Xml.XmlValidatingReader.NodeType" /> equals <see langword="XmlNodeType.Element" />) that ends with <c>/></c>; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.LineNumber">
+ <summary>Gets the current line number.</summary>
+ <returns>The current line number. The starting value for this property is 1.</returns>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.LinePosition">
+ <summary>Gets the current line position.</summary>
+ <returns>The current line position. The starting value for this property is 1.</returns>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.LocalName">
+ <summary>Gets the local name of the current node.</summary>
+ <returns>The name of the current node with the prefix removed. For example, <see langword="LocalName" /> is <see langword="book" /> for the element <c><bk:book></c>.
+For node types that do not have a name (like <see langword="Text" />, <see langword="Comment" />, and so on), this property returns String.Empty.</returns>
+ </member>
<member name="M:System.Xml.XmlValidatingReader.LookupNamespace(System.String)">
<summary>Resolves a namespace prefix in the current element's scope.</summary>
<param name="prefix">The prefix whose namespace Uniform Resource Identifier (URI) you want to resolve. To match the default namespace, pass an empty string.</param>
<returns>
<see langword="true" /> if there is a next attribute; <see langword="false" /> if there are no more attributes.</returns>
</member>
- <member name="M:System.Xml.XmlValidatingReader.Read">
- <summary>Reads the next node from the stream.</summary>
- <returns>
- <see langword="true" /> if the next node was read successfully; <see langword="false" /> if there are no more nodes to read.</returns>
- </member>
- <member name="M:System.Xml.XmlValidatingReader.ReadAttributeValue">
- <summary>Parses the attribute value into one or more <see langword="Text" />, <see langword="EntityReference" />, or <see langword="EndEntity" /> nodes.</summary>
- <returns>
- <see langword="true" /> if there are nodes to return.
+ <member name="P:System.Xml.XmlValidatingReader.Name">
+ <summary>Gets the qualified name of the current node.</summary>
+ <returns>The qualified name of the current node. For example, <see langword="Name" /> is <see langword="bk:book" /> for the element <c><bk:book></c>.
+The name returned is dependent on the <see cref="P:System.Xml.XmlValidatingReader.NodeType" /> of the node. The following node types return the listed values. All other node types return an empty string.
+ Node Type
- <see langword="false" /> if the reader is not positioned on an attribute node when the initial call is made or if all the attribute values have been read.
+ Name
- An empty attribute, such as, <c>misc=""</c>, returns <see langword="true" /> with a single node with a value of String.Empty.</returns>
- </member>
- <member name="M:System.Xml.XmlValidatingReader.ReadContentAsBase64(System.Byte[],System.Int32,System.Int32)">
- <summary>Reads the content and returns the Base64 decoded binary bytes.</summary>
- <param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
- <param name="index">The offset into the buffer where to start copying the result.</param>
- <param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
- <exception cref="T:System.InvalidOperationException">
- <see cref="M:System.Xml.XmlValidatingReader.ReadContentAsBase64(System.Byte[],System.Int32,System.Int32)" /> is not supported on the current node.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
- <returns>The number of bytes written to the buffer.</returns>
- </member>
- <member name="M:System.Xml.XmlValidatingReader.ReadContentAsBinHex(System.Byte[],System.Int32,System.Int32)">
- <summary>Reads the content and returns the BinHex decoded binary bytes.</summary>
- <param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
- <param name="index">The offset into the buffer where to start copying the result.</param>
- <param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
- <exception cref="T:System.InvalidOperationException">
- <see cref="M:System.Xml.XmlValidatingReader.ReadContentAsBinHex(System.Byte[],System.Int32,System.Int32)" /> is not supported on the current node.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
- <exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlValidatingReader" /> implementation does not support this method.</exception>
- <returns>The number of bytes written to the buffer.</returns>
- </member>
- <member name="M:System.Xml.XmlValidatingReader.ReadElementContentAsBase64(System.Byte[],System.Int32,System.Int32)">
- <summary>Reads the element and decodes the Base64 content.</summary>
- <param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
- <param name="index">The offset into the buffer where to start copying the result.</param>
- <param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
- <exception cref="T:System.InvalidOperationException">The current node is not an element node.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
- <exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlValidatingReader" /> implementation does not support this method.</exception>
- <exception cref="T:System.Xml.XmlException">The element contains mixed-content.</exception>
- <exception cref="T:System.FormatException">The content cannot be converted to the requested type.</exception>
- <returns>The number of bytes written to the buffer.</returns>
- </member>
- <member name="M:System.Xml.XmlValidatingReader.ReadElementContentAsBinHex(System.Byte[],System.Int32,System.Int32)">
- <summary>Reads the element and decodes the BinHex content.</summary>
- <param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
- <param name="index">The offset into the buffer where to start copying the result.</param>
- <param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
- <exception cref="T:System.InvalidOperationException">The current node is not an element node.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
- <exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlValidatingReader" /> implementation does not support this method.</exception>
- <exception cref="T:System.Xml.XmlException">The element contains mixed-content.</exception>
- <exception cref="T:System.FormatException">The content cannot be converted to the requested type.</exception>
- <returns>The number of bytes written to the buffer.</returns>
- </member>
- <member name="M:System.Xml.XmlValidatingReader.ReadString">
- <summary>Reads the contents of an element or text node as a string.</summary>
- <returns>The contents of the element or text node. This can be an empty string if the reader is positioned on something other than an element or text node, or if there is no more text content to return in the current context.</returns>
- </member>
- <member name="M:System.Xml.XmlValidatingReader.ReadTypedValue">
- <summary>Gets the common language runtime type for the specified XML Schema definition language (XSD) type.</summary>
- <returns>The common language runtime type for the specified XML Schema type.</returns>
- </member>
- <member name="M:System.Xml.XmlValidatingReader.ResolveEntity">
- <summary>Resolves the entity reference for <see langword="EntityReference" /> nodes.</summary>
- <exception cref="T:System.InvalidOperationException">The reader is not positioned on an <see langword="EntityReference" /> node.</exception>
- </member>
- <member name="M:System.Xml.XmlValidatingReader.System#Xml#IXmlNamespaceResolver#GetNamespacesInScope(System.Xml.XmlNamespaceScope)">
- <summary>For a description of this member, see <see cref="M:System.Xml.IXmlNamespaceResolver.GetNamespacesInScope(System.Xml.XmlNamespaceScope)" />.</summary>
- <param name="scope">An <see cref="T:System.Xml.XmlNamespaceScope" /> object that identifies the scope of the reader.</param>
- <returns>An <see cref="T:System.Collections.IDictionary" /> object that identifies the namespaces in scope.</returns>
- </member>
- <member name="M:System.Xml.XmlValidatingReader.System#Xml#IXmlNamespaceResolver#LookupNamespace(System.String)">
- <summary>For a description of this member, see <see cref="M:System.Xml.IXmlNamespaceResolver.LookupNamespace(System.String)" />.</summary>
- <param name="prefix">The namespace prefix.</param>
- <returns>A string value that contains the namespace Uri that is associated with the prefix.</returns>
- </member>
- <member name="M:System.Xml.XmlValidatingReader.System#Xml#IXmlNamespaceResolver#LookupPrefix(System.String)">
- <summary>For a description of this member, see <see cref="M:System.Xml.IXmlNamespaceResolver.LookupPrefix(System.String)" />.</summary>
- <param name="namespaceName">The namespace that is associated with the prefix.</param>
- <returns>A string value that contains the namespace prefix that is associated with the <paramref name="namespaceName" />.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.AttributeCount">
- <summary>Gets the number of attributes on the current node.</summary>
- <returns>The number of attributes on the current node. This number includes default attributes.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.BaseURI">
- <summary>Gets the base URI of the current node.</summary>
- <returns>The base URI of the current node.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.CanReadBinaryContent">
- <summary>Gets a value indicating whether the <see cref="T:System.Xml.XmlValidatingReader" /> implements the binary content read methods.</summary>
- <returns>
- <see langword="true" /> if the binary content read methods are implemented; otherwise <see langword="false" />. The <see cref="T:System.Xml.XmlValidatingReader" /> class returns <see langword="true" />.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.CanResolveEntity">
- <summary>Gets a value indicating whether this reader can parse and resolve entities.</summary>
- <returns>
- <see langword="true" /> if the reader can parse and resolve entities; otherwise, <see langword="false" />. <see langword="XmlValidatingReader" /> always returns <see langword="true" />.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.Depth">
- <summary>Gets the depth of the current node in the XML document.</summary>
- <returns>The depth of the current node in the XML document.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.Encoding">
- <summary>Gets the encoding attribute for the document.</summary>
- <returns>The encoding value. If no encoding attribute exists, and there is not byte-order mark, this defaults to UTF-8.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.EntityHandling">
- <summary>Gets or sets a value that specifies how the reader handles entities.</summary>
- <exception cref="T:System.ArgumentOutOfRangeException">Invalid value was specified.</exception>
- <returns>One of the <see cref="T:System.Xml.EntityHandling" /> values. If no <see langword="EntityHandling" /> is specified, it defaults to EntityHandling.ExpandEntities.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.EOF">
- <summary>Gets a value indicating whether the reader is positioned at the end of the stream.</summary>
- <returns>
- <see langword="true" /> if the reader is positioned at the end of the stream; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.HasValue">
- <summary>Gets a value indicating whether the current node can have a <see cref="P:System.Xml.XmlValidatingReader.Value" /> other than String.Empty.</summary>
- <returns>
- <see langword="true" /> if the node on which the reader is currently positioned can have a <see langword="Value" />; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.IsDefault">
- <summary>Gets a value indicating whether the current node is an attribute that was generated from the default value defined in the document type definition (DTD) or schema.</summary>
- <returns>
- <see langword="true" /> if the current node is an attribute whose value was generated from the default value defined in the DTD or schema; <see langword="false" /> if the attribute value was explicitly set.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.IsEmptyElement">
- <summary>Gets a value indicating whether the current node is an empty element (for example, <c><MyElement/></c>).</summary>
- <returns>
- <see langword="true" /> if the current node is an element (<see cref="P:System.Xml.XmlValidatingReader.NodeType" /> equals <see langword="XmlNodeType.Element" />) that ends with <c>/></c>; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.LineNumber">
- <summary>Gets the current line number.</summary>
- <returns>The current line number. The starting value for this property is 1.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.LinePosition">
- <summary>Gets the current line position.</summary>
- <returns>The current line position. The starting value for this property is 1.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.LocalName">
- <summary>Gets the local name of the current node.</summary>
- <returns>The name of the current node with the prefix removed. For example, <see langword="LocalName" /> is <see langword="book" /> for the element <c><bk:book></c>.
+ <see langword="Attribute" /> The name of the attribute.
- For node types that do not have a name (like <see langword="Text" />, <see langword="Comment" />, and so on), this property returns String.Empty.</returns>
- </member>
- <member name="P:System.Xml.XmlValidatingReader.Name">
- <summary>Gets the qualified name of the current node.</summary>
- <returns>The qualified name of the current node. For example, <see langword="Name" /> is <see langword="bk:book" /> for the element <c><bk:book></c>.
+ <see langword="DocumentType" /> The document type name.
+
+ <see langword="Element" /> The tag name.
- The name returned is dependent on the <see cref="P:System.Xml.XmlValidatingReader.NodeType" /> of the node. The following node types return the listed values. All other node types return an empty string.
+ <see langword="EntityReference" /> The name of the entity referenced.
- <list type="table"><listheader><term> Node Type</term><description> Name</description></listheader><item><term><see langword="Attribute" /></term><description> The name of the attribute.</description></item><item><term><see langword="DocumentType" /></term><description> The document type name.</description></item><item><term><see langword="Element" /></term><description> The tag name.</description></item><item><term><see langword="EntityReference" /></term><description> The name of the entity referenced.</description></item><item><term><see langword="ProcessingInstruction" /></term><description> The target of the processing instruction.</description></item><item><term><see langword="XmlDeclaration" /></term><description> The literal string <see langword="xml" />.</description></item></list></returns>
+ <see langword="ProcessingInstruction" /> The target of the processing instruction.
+
+ <see langword="XmlDeclaration" /> The literal string <see langword="xml" />.</returns>
</member>
<member name="P:System.Xml.XmlValidatingReader.Namespaces">
<summary>Gets or sets a value indicating whether to do namespace support.</summary>
<returns>
<see langword="XmlNameTable" /> that enables you to get the atomized version of a string within the node.</returns>
</member>
- <member name="P:System.Xml.XmlValidatingReader.NodeType">
- <summary>Gets the type of the current node.</summary>
- <returns>One of the <see cref="T:System.Xml.XmlNodeType" /> values representing the type of the current node.</returns>
+ <member name="P:System.Xml.XmlValidatingReader.NodeType">
+ <summary>Gets the type of the current node.</summary>
+ <returns>One of the <see cref="T:System.Xml.XmlNodeType" /> values representing the type of the current node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.Prefix">
+ <summary>Gets the namespace prefix associated with the current node.</summary>
+ <returns>The namespace prefix associated with the current node.</returns>
+ </member>
+ <member name="P:System.Xml.XmlValidatingReader.QuoteChar">
+ <summary>Gets the quotation mark character used to enclose the value of an attribute node.</summary>
+ <returns>The quotation mark character (" or ') used to enclose the value of an attribute node.</returns>
+ </member>
+ <member name="M:System.Xml.XmlValidatingReader.Read">
+ <summary>Reads the next node from the stream.</summary>
+ <returns>
+ <see langword="true" /> if the next node was read successfully; <see langword="false" /> if there are no more nodes to read.</returns>
+ </member>
+ <member name="M:System.Xml.XmlValidatingReader.ReadAttributeValue">
+ <summary>Parses the attribute value into one or more <see langword="Text" />, <see langword="EntityReference" />, or <see langword="EndEntity" /> nodes.</summary>
+ <returns>
+ <see langword="true" /> if there are nodes to return.
+<see langword="false" /> if the reader is not positioned on an attribute node when the initial call is made or if all the attribute values have been read.
+An empty attribute, such as, <c>misc=""</c>, returns <see langword="true" /> with a single node with a value of String.Empty.</returns>
+ </member>
+ <member name="M:System.Xml.XmlValidatingReader.ReadContentAsBase64(System.Byte[],System.Int32,System.Int32)">
+ <summary>Reads the content and returns the Base64 decoded binary bytes.</summary>
+ <param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
+ <param name="index">The offset into the buffer where to start copying the result.</param>
+ <param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
+ <exception cref="T:System.InvalidOperationException">
+ <see cref="M:System.Xml.XmlValidatingReader.ReadContentAsBase64(System.Byte[],System.Int32,System.Int32)" /> is not supported on the current node.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
+ </member>
+ <member name="M:System.Xml.XmlValidatingReader.ReadContentAsBinHex(System.Byte[],System.Int32,System.Int32)">
+ <summary>Reads the content and returns the BinHex decoded binary bytes.</summary>
+ <param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
+ <param name="index">The offset into the buffer where to start copying the result.</param>
+ <param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
+ <exception cref="T:System.InvalidOperationException">
+ <see cref="M:System.Xml.XmlValidatingReader.ReadContentAsBinHex(System.Byte[],System.Int32,System.Int32)" /> is not supported on the current node.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
+ <exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlValidatingReader" /> implementation does not support this method.</exception>
</member>
- <member name="P:System.Xml.XmlValidatingReader.Prefix">
- <summary>Gets the namespace prefix associated with the current node.</summary>
- <returns>The namespace prefix associated with the current node.</returns>
+ <member name="M:System.Xml.XmlValidatingReader.ReadElementContentAsBase64(System.Byte[],System.Int32,System.Int32)">
+ <summary>Reads the element and decodes the Base64 content.</summary>
+ <param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
+ <param name="index">The offset into the buffer where to start copying the result.</param>
+ <param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
+ <exception cref="T:System.InvalidOperationException">The current node is not an element node.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
+ <exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlValidatingReader" /> implementation does not support this method.</exception>
+ <exception cref="T:System.Xml.XmlException">The element contains mixed-content.</exception>
+ <exception cref="T:System.FormatException">The content cannot be converted to the requested type.</exception>
</member>
- <member name="P:System.Xml.XmlValidatingReader.QuoteChar">
- <summary>Gets the quotation mark character used to enclose the value of an attribute node.</summary>
- <returns>The quotation mark character (" or ') used to enclose the value of an attribute node.</returns>
+ <member name="M:System.Xml.XmlValidatingReader.ReadElementContentAsBinHex(System.Byte[],System.Int32,System.Int32)">
+ <summary>Reads the element and decodes the BinHex content.</summary>
+ <param name="buffer">The buffer into which to copy the resulting text. This value cannot be <see langword="null" />.</param>
+ <param name="index">The offset into the buffer where to start copying the result.</param>
+ <param name="count">The maximum number of bytes to copy into the buffer. The actual number of bytes copied is returned from this method.</param>
+ <returns>The number of bytes written to the buffer.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> value is <see langword="null" />.</exception>
+ <exception cref="T:System.InvalidOperationException">The current node is not an element node.</exception>
+ <exception cref="T:System.ArgumentOutOfRangeException">The index into the buffer or index + count is larger than the allocated buffer size.</exception>
+ <exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XmlValidatingReader" /> implementation does not support this method.</exception>
+ <exception cref="T:System.Xml.XmlException">The element contains mixed-content.</exception>
+ <exception cref="T:System.FormatException">The content cannot be converted to the requested type.</exception>
</member>
<member name="P:System.Xml.XmlValidatingReader.Reader">
<summary>Gets the <see cref="T:System.Xml.XmlReader" /> used to construct this <see langword="XmlValidatingReader" />.</summary>
<summary>Gets the state of the reader.</summary>
<returns>One of the <see cref="T:System.Xml.ReadState" /> values.</returns>
</member>
+ <member name="M:System.Xml.XmlValidatingReader.ReadString">
+ <summary>Reads the contents of an element or text node as a string.</summary>
+ <returns>The contents of the element or text node. This can be an empty string if the reader is positioned on something other than an element or text node, or if there is no more text content to return in the current context.
+
+The text node can be either an element or an attribute text node.</returns>
+ </member>
+ <member name="M:System.Xml.XmlValidatingReader.ReadTypedValue">
+ <summary>Gets the common language runtime type for the specified XML Schema definition language (XSD) type.</summary>
+ <returns>The common language runtime type for the specified XML Schema type.</returns>
+ </member>
+ <member name="M:System.Xml.XmlValidatingReader.ResolveEntity">
+ <summary>Resolves the entity reference for <see langword="EntityReference" /> nodes.</summary>
+ <exception cref="T:System.InvalidOperationException">The reader is not positioned on an <see langword="EntityReference" /> node.</exception>
+ </member>
<member name="P:System.Xml.XmlValidatingReader.Schemas">
<summary>Gets a <see cref="T:System.Xml.Schema.XmlSchemaCollection" /> to use for validation.</summary>
<returns>The <see langword="XmlSchemaCollection" /> to use for validation.</returns>
<returns>
<see cref="T:System.Xml.Schema.XmlSchemaDatatype" />, <see cref="T:System.Xml.Schema.XmlSchemaSimpleType" />, or <see cref="T:System.Xml.Schema.XmlSchemaComplexType" /> depending whether the node value is a built in XML Schema definition language (XSD) type or a user defined simpleType or complexType; <see langword="null" /> if the current node has no schema type.</returns>
</member>
+ <member name="M:System.Xml.XmlValidatingReader.System#Xml#IXmlNamespaceResolver#GetNamespacesInScope(System.Xml.XmlNamespaceScope)">
+ <summary>For a description of this member, see <see cref="M:System.Xml.IXmlNamespaceResolver.GetNamespacesInScope(System.Xml.XmlNamespaceScope)" />.</summary>
+ <param name="scope">An <see cref="T:System.Xml.XmlNamespaceScope" /> object that identifies the scope of the reader.</param>
+ <returns>An T:System.Collections.IDictionary object that identifies the namespaces in scope.</returns>
+ </member>
+ <member name="M:System.Xml.XmlValidatingReader.System#Xml#IXmlNamespaceResolver#LookupNamespace(System.String)">
+ <summary>For a description of this member, see <see cref="M:System.Xml.IXmlNamespaceResolver.LookupNamespace(System.String)" />.</summary>
+ <param name="prefix">The namespace prefix.</param>
+ <returns>A string value that contains the namespace Uri that is associated with the prefix.</returns>
+ </member>
+ <member name="M:System.Xml.XmlValidatingReader.System#Xml#IXmlNamespaceResolver#LookupPrefix(System.String)">
+ <summary>For a description of this member, see <see cref="M:System.Xml.IXmlNamespaceResolver.LookupPrefix(System.String)" />.</summary>
+ <param name="namespaceName">The namespace that is associated with the prefix.</param>
+ <returns>A string value that contains the namespace prefix that is associated with the <paramref name="namespaceName" />.</returns>
+ </member>
+ <member name="E:System.Xml.XmlValidatingReader.ValidationEventHandler">
+ <summary>Sets an event handler for receiving information about document type definition (DTD), XML-Data Reduced (XDR) schema, and XML Schema definition language (XSD) schema validation errors.</summary>
+ </member>
<member name="P:System.Xml.XmlValidatingReader.ValidationType">
<summary>Gets or sets a value indicating the type of validation to perform.</summary>
- <exception cref="T:System.InvalidOperationException">Setting the property after a Read has been called.</exception>
<returns>One of the <see cref="T:System.Xml.ValidationType" /> values. If this property is not set, it defaults to ValidationType.Auto.</returns>
+ <exception cref="T:System.InvalidOperationException">Setting the property after a Read has been called.</exception>
</member>
<member name="P:System.Xml.XmlValidatingReader.Value">
<summary>Gets the text value of the current node.</summary>
- <returns>The value returned depends on the <see cref="P:System.Xml.XmlValidatingReader.NodeType" /> of the node. The following table lists node types that have a value to return. All other node types return String.Empty.
+ <returns>The value returned depends on the <see cref="P:System.Xml.XmlValidatingReader.NodeType" /> of the node. The following table lists node types that have a value to return. All other node types return String.Empty.
+ Node Type
+
+ Value
+
+ <see langword="Attribute" /> The value of the attribute.
- <list type="table"><listheader><term> Node Type</term><description> Value</description></listheader><item><term><see langword="Attribute" /></term><description> The value of the attribute.</description></item><item><term><see langword="CDATA" /></term><description> The content of the CDATA section.</description></item><item><term><see langword="Comment" /></term><description> The content of the comment.</description></item><item><term><see langword="DocumentType" /></term><description> The internal subset.</description></item><item><term><see langword="ProcessingInstruction" /></term><description> The entire content, excluding the target.</description></item><item><term><see langword="SignificantWhitespace" /></term><description> The white space between markup in a mixed content model.</description></item><item><term><see langword="Text" /></term><description> The content of the text node.</description></item><item><term><see langword="Whitespace" /></term><description> The white space between markup.</description></item><item><term><see langword="XmlDeclaration" /></term><description> The content of the declaration.</description></item></list></returns>
+ <see langword="CDATA" /> The content of the CDATA section.
+
+ <see langword="Comment" /> The content of the comment.
+
+ <see langword="DocumentType" /> The internal subset.
+
+ <see langword="ProcessingInstruction" /> The entire content, excluding the target.
+
+ <see langword="SignificantWhitespace" /> The white space between markup in a mixed content model.
+
+ <see langword="Text" /> The content of the text node.
+
+ <see langword="Whitespace" /> The white space between markup.
+
+ <see langword="XmlDeclaration" /> The content of the declaration.</returns>
</member>
<member name="P:System.Xml.XmlValidatingReader.XmlLang">
<summary>Gets the current <see langword="xml:lang" /> scope.</summary>
</member>
<member name="P:System.Xml.XmlValidatingReader.XmlResolver">
<summary>Sets the <see cref="T:System.Xml.XmlResolver" /> used for resolving external document type definition (DTD) and schema location references. The <see langword="XmlResolver" /> is also used to handle any import or include elements found in XML Schema definition language (XSD) schemas.</summary>
- <returns>The <see langword="XmlResolver" /> to use. If set to <see langword="null" />, external resources are not resolved.
-
- In version 1.1 of the .NET Framework, the caller must be fully trusted to specify an <see langword="XmlResolver" />.</returns>
+ <returns>The <see langword="XmlResolver" /> to use. If set to <see langword="null" />, external resources are not resolved.
+In version 1.1 of the .NET Framework, the caller must be fully trusted to specify an <see langword="XmlResolver" />.</returns>
</member>
<member name="P:System.Xml.XmlValidatingReader.XmlSpace">
<summary>Gets the current <see langword="xml:space" /> scope.</summary>
<see langword="true" /> to recursively clone the subtree under the specified node; <see langword="false" /> to clone only the node itself. For white space nodes, the cloned node always includes the data value, regardless of the parameter setting.</param>
<returns>The cloned node.</returns>
</member>
- <member name="M:System.Xml.XmlWhitespace.WriteContentTo(System.Xml.XmlWriter)">
- <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see cref="T:System.Xml.XmlWriter" /> to which you want to save.</param>
- </member>
- <member name="M:System.Xml.XmlWhitespace.WriteTo(System.Xml.XmlWriter)">
- <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
- <param name="w">The <see cref="T:System.Xml.XmlWriter" /> to which you want to save.</param>
- </member>
<member name="P:System.Xml.XmlWhitespace.LocalName">
<summary>Gets the local name of the node.</summary>
<returns>For <see langword="XmlWhitespace" /> nodes, this property returns <see langword="#whitespace" />.</returns>
</member>
<member name="P:System.Xml.XmlWhitespace.Value">
<summary>Gets or sets the value of the node.</summary>
- <exception cref="T:System.ArgumentException">Setting <see cref="P:System.Xml.XmlWhitespace.Value" /> to invalid white space characters.</exception>
<returns>The white space characters found in the node.</returns>
+ <exception cref="T:System.ArgumentException">Setting <see cref="P:System.Xml.XmlWhitespace.Value" /> to invalid white space characters.</exception>
+ </member>
+ <member name="M:System.Xml.XmlWhitespace.WriteContentTo(System.Xml.XmlWriter)">
+ <summary>Saves all the children of the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see cref="T:System.Xml.XmlWriter" /> to which you want to save.</param>
+ </member>
+ <member name="M:System.Xml.XmlWhitespace.WriteTo(System.Xml.XmlWriter)">
+ <summary>Saves the node to the specified <see cref="T:System.Xml.XmlWriter" />.</summary>
+ <param name="w">The <see cref="T:System.Xml.XmlWriter" /> to which you want to save.</param>
</member>
<member name="T:System.Xml.XmlWriter">
<summary>Represents a writer that provides a fast, non-cached, forward-only way to generate streams or files that contain XML data.</summary>
<member name="M:System.Xml.XmlWriter.Close">
<summary>When overridden in a derived class, closes this stream and the underlying stream.</summary>
<exception cref="T:System.InvalidOperationException">A call is made to write more output after <see langword="Close" /> has been called or the result of this call is an invalid XML document.
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlWriter.Create(System.IO.Stream)">
<summary>Creates a new <see cref="T:System.Xml.XmlWriter" /> instance using the specified stream.</summary>
<param name="output">The stream to which you want to write. The <see cref="T:System.Xml.XmlWriter" /> writes XML 1.0 text syntax and appends it to the specified stream.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="stream" /> value is <see langword="null" />.</exception>
<returns>An <see cref="T:System.Xml.XmlWriter" /> object.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="stream" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlWriter.Create(System.IO.Stream,System.Xml.XmlWriterSettings)">
<summary>Creates a new <see cref="T:System.Xml.XmlWriter" /> instance using the stream and <see cref="T:System.Xml.XmlWriterSettings" /> object.</summary>
<param name="output">The stream to which you want to write. The <see cref="T:System.Xml.XmlWriter" /> writes XML 1.0 text syntax and appends it to the specified stream.</param>
- <param name="settings">The <see cref="T:System.Xml.XmlWriterSettings" /> object used to configure the new <see cref="T:System.Xml.XmlWriter" /> instance. If this is <see langword="null" />, a <see cref="T:System.Xml.XmlWriterSettings" /> with default settings is used.
-
- If the <see cref="T:System.Xml.XmlWriter" /> is being used with the <see cref="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.String,System.Xml.XmlWriter)" /> method, you should use the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property to obtain an <see cref="T:System.Xml.XmlWriterSettings" /> object with the correct settings. This ensures that the created <see cref="T:System.Xml.XmlWriter" /> object has the correct output settings.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="stream" /> value is <see langword="null" />.</exception>
+ <param name="settings">The <see cref="T:System.Xml.XmlWriterSettings" /> object used to configure the new <see cref="T:System.Xml.XmlWriter" /> instance. If this is <see langword="null" />, a <see cref="T:System.Xml.XmlWriterSettings" /> with default settings is used.
+If the <see cref="T:System.Xml.XmlWriter" /> is being used with the <see cref="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.String,System.Xml.XmlWriter)" /> method, you should use the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property to obtain an <see cref="T:System.Xml.XmlWriterSettings" /> object with the correct settings. This ensures that the created <see cref="T:System.Xml.XmlWriter" /> object has the correct output settings.</param>
<returns>An <see cref="T:System.Xml.XmlWriter" /> object.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="stream" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlWriter.Create(System.IO.TextWriter)">
<summary>Creates a new <see cref="T:System.Xml.XmlWriter" /> instance using the specified <see cref="T:System.IO.TextWriter" />.</summary>
<param name="output">The <see cref="T:System.IO.TextWriter" /> to which you want to write. The <see cref="T:System.Xml.XmlWriter" /> writes XML 1.0 text syntax and appends it to the specified <see cref="T:System.IO.TextWriter" />.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="text" /> value is <see langword="null" />.</exception>
<returns>An <see cref="T:System.Xml.XmlWriter" /> object.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="text" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlWriter.Create(System.IO.TextWriter,System.Xml.XmlWriterSettings)">
<summary>Creates a new <see cref="T:System.Xml.XmlWriter" /> instance using the <see cref="T:System.IO.TextWriter" /> and <see cref="T:System.Xml.XmlWriterSettings" /> objects.</summary>
<param name="output">The <see cref="T:System.IO.TextWriter" /> to which you want to write. The <see cref="T:System.Xml.XmlWriter" /> writes XML 1.0 text syntax and appends it to the specified <see cref="T:System.IO.TextWriter" />.</param>
- <param name="settings">The <see cref="T:System.Xml.XmlWriterSettings" /> object used to configure the new <see cref="T:System.Xml.XmlWriter" /> instance. If this is <see langword="null" />, a <see cref="T:System.Xml.XmlWriterSettings" /> with default settings is used.
-
- If the <see cref="T:System.Xml.XmlWriter" /> is being used with the <see cref="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.String,System.Xml.XmlWriter)" /> method, you should use the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property to obtain an <see cref="T:System.Xml.XmlWriterSettings" /> object with the correct settings. This ensures that the created <see cref="T:System.Xml.XmlWriter" /> object has the correct output settings.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="text" /> value is <see langword="null" />.</exception>
+ <param name="settings">The <see cref="T:System.Xml.XmlWriterSettings" /> object used to configure the new <see cref="T:System.Xml.XmlWriter" /> instance. If this is <see langword="null" />, a <see cref="T:System.Xml.XmlWriterSettings" /> with default settings is used.
+If the <see cref="T:System.Xml.XmlWriter" /> is being used with the <see cref="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.String,System.Xml.XmlWriter)" /> method, you should use the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property to obtain an <see cref="T:System.Xml.XmlWriterSettings" /> object with the correct settings. This ensures that the created <see cref="T:System.Xml.XmlWriter" /> object has the correct output settings.</param>
<returns>An <see cref="T:System.Xml.XmlWriter" /> object.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="text" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlWriter.Create(System.String)">
<summary>Creates a new <see cref="T:System.Xml.XmlWriter" /> instance using the specified filename.</summary>
<param name="outputFileName">The file to which you want to write. The <see cref="T:System.Xml.XmlWriter" /> creates a file at the specified path and writes to it in XML 1.0 text syntax. The <paramref name="outputFileName" /> must be a file system path.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="url" /> value is <see langword="null" />.</exception>
<returns>An <see cref="T:System.Xml.XmlWriter" /> object.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="url" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlWriter.Create(System.String,System.Xml.XmlWriterSettings)">
<summary>Creates a new <see cref="T:System.Xml.XmlWriter" /> instance using the filename and <see cref="T:System.Xml.XmlWriterSettings" /> object.</summary>
<param name="outputFileName">The file to which you want to write. The <see cref="T:System.Xml.XmlWriter" /> creates a file at the specified path and writes to it in XML 1.0 text syntax. The <paramref name="outputFileName" /> must be a file system path.</param>
- <param name="settings">The <see cref="T:System.Xml.XmlWriterSettings" /> object used to configure the new <see cref="T:System.Xml.XmlWriter" /> instance. If this is <see langword="null" />, a <see cref="T:System.Xml.XmlWriterSettings" /> with default settings is used.
-
- If the <see cref="T:System.Xml.XmlWriter" /> is being used with the <see cref="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.String,System.Xml.XmlWriter)" /> method, you should use the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property to obtain an <see cref="T:System.Xml.XmlWriterSettings" /> object with the correct settings. This ensures that the created <see cref="T:System.Xml.XmlWriter" /> object has the correct output settings.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="url" /> value is <see langword="null" />.</exception>
+ <param name="settings">The <see cref="T:System.Xml.XmlWriterSettings" /> object used to configure the new <see cref="T:System.Xml.XmlWriter" /> instance. If this is <see langword="null" />, a <see cref="T:System.Xml.XmlWriterSettings" /> with default settings is used.
+If the <see cref="T:System.Xml.XmlWriter" /> is being used with the <see cref="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.String,System.Xml.XmlWriter)" /> method, you should use the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property to obtain an <see cref="T:System.Xml.XmlWriterSettings" /> object with the correct settings. This ensures that the created <see cref="T:System.Xml.XmlWriter" /> object has the correct output settings.</param>
<returns>An <see cref="T:System.Xml.XmlWriter" /> object.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="url" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlWriter.Create(System.Text.StringBuilder)">
<summary>Creates a new <see cref="T:System.Xml.XmlWriter" /> instance using the specified <see cref="T:System.Text.StringBuilder" />.</summary>
<param name="output">The <see cref="T:System.Text.StringBuilder" /> to which to write to. Content written by the <see cref="T:System.Xml.XmlWriter" /> is appended to the <see cref="T:System.Text.StringBuilder" />.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="builder" /> value is <see langword="null" />.</exception>
<returns>An <see cref="T:System.Xml.XmlWriter" /> object.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="builder" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlWriter.Create(System.Text.StringBuilder,System.Xml.XmlWriterSettings)">
<summary>Creates a new <see cref="T:System.Xml.XmlWriter" /> instance using the <see cref="T:System.Text.StringBuilder" /> and <see cref="T:System.Xml.XmlWriterSettings" /> objects.</summary>
<param name="output">The <see cref="T:System.Text.StringBuilder" /> to which to write to. Content written by the <see cref="T:System.Xml.XmlWriter" /> is appended to the <see cref="T:System.Text.StringBuilder" />.</param>
- <param name="settings">The <see cref="T:System.Xml.XmlWriterSettings" /> object used to configure the new <see cref="T:System.Xml.XmlWriter" /> instance. If this is <see langword="null" />, a <see cref="T:System.Xml.XmlWriterSettings" /> with default settings is used.
-
- If the <see cref="T:System.Xml.XmlWriter" /> is being used with the <see cref="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.String,System.Xml.XmlWriter)" /> method, you should use the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property to obtain an <see cref="T:System.Xml.XmlWriterSettings" /> object with the correct settings. This ensures that the created <see cref="T:System.Xml.XmlWriter" /> object has the correct output settings.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="builder" /> value is <see langword="null" />.</exception>
+ <param name="settings">The <see cref="T:System.Xml.XmlWriterSettings" /> object used to configure the new <see cref="T:System.Xml.XmlWriter" /> instance. If this is <see langword="null" />, a <see cref="T:System.Xml.XmlWriterSettings" /> with default settings is used.
+If the <see cref="T:System.Xml.XmlWriter" /> is being used with the <see cref="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.String,System.Xml.XmlWriter)" /> method, you should use the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property to obtain an <see cref="T:System.Xml.XmlWriterSettings" /> object with the correct settings. This ensures that the created <see cref="T:System.Xml.XmlWriter" /> object has the correct output settings.</param>
<returns>An <see cref="T:System.Xml.XmlWriter" /> object.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="builder" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlWriter.Create(System.Xml.XmlWriter)">
<summary>Creates a new <see cref="T:System.Xml.XmlWriter" /> instance using the specified <see cref="T:System.Xml.XmlWriter" /> object.</summary>
<param name="output">The <see cref="T:System.Xml.XmlWriter" /> object that you want to use as the underlying writer.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> value is <see langword="null" />.</exception>
<returns>An <see cref="T:System.Xml.XmlWriter" /> object that is wrapped around the specified <see cref="T:System.Xml.XmlWriter" /> object.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlWriter.Create(System.Xml.XmlWriter,System.Xml.XmlWriterSettings)">
<summary>Creates a new <see cref="T:System.Xml.XmlWriter" /> instance using the specified <see cref="T:System.Xml.XmlWriter" /> and <see cref="T:System.Xml.XmlWriterSettings" /> objects.</summary>
<param name="output">The <see cref="T:System.Xml.XmlWriter" /> object that you want to use as the underlying writer.</param>
- <param name="settings">The <see cref="T:System.Xml.XmlWriterSettings" /> object used to configure the new <see cref="T:System.Xml.XmlWriter" /> instance. If this is <see langword="null" />, a <see cref="T:System.Xml.XmlWriterSettings" /> with default settings is used.
-
- If the <see cref="T:System.Xml.XmlWriter" /> is being used with the <see cref="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.String,System.Xml.XmlWriter)" /> method, you should use the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property to obtain an <see cref="T:System.Xml.XmlWriterSettings" /> object with the correct settings. This ensures that the created <see cref="T:System.Xml.XmlWriter" /> object has the correct output settings.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> value is <see langword="null" />.</exception>
+ <param name="settings">The <see cref="T:System.Xml.XmlWriterSettings" /> object used to configure the new <see cref="T:System.Xml.XmlWriter" /> instance. If this is <see langword="null" />, a <see cref="T:System.Xml.XmlWriterSettings" /> with default settings is used.
+If the <see cref="T:System.Xml.XmlWriter" /> is being used with the <see cref="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.String,System.Xml.XmlWriter)" /> method, you should use the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property to obtain an <see cref="T:System.Xml.XmlWriterSettings" /> object with the correct settings. This ensures that the created <see cref="T:System.Xml.XmlWriter" /> object has the correct output settings.</param>
<returns>An <see cref="T:System.Xml.XmlWriter" /> object that is wrapped around the specified <see cref="T:System.Xml.XmlWriter" /> object.</returns>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="writer" /> value is <see langword="null" />.</exception>
</member>
<member name="M:System.Xml.XmlWriter.Dispose">
<summary>Releases all resources used by the current instance of the <see cref="T:System.Xml.XmlWriter" /> class.</summary>
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
- <member name="M:System.Xml.XmlWriter.DisposeAsync">
- <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.</summary>
- <returns>A task that represents the asynchronous dispose operation.</returns>
- </member>
- <member name="M:System.Xml.XmlWriter.DisposeAsyncCore">
- <summary>Performs application-defined tasks associated with freeing, releasing, or resetting managed resources asynchronously.</summary>
- <returns>A task that represents the asynchronous dispose operation.</returns>
- </member>
<member name="M:System.Xml.XmlWriter.Flush">
<summary>When overridden in a derived class, flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream.</summary>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlWriter.FlushAsync">
<summary>Asynchronously flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream.</summary>
+ <returns>The task that represents the asynchronous <see langword="Flush" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="Flush" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.LookupPrefix(System.String)">
<summary>When overridden in a derived class, returns the closest prefix defined in the current namespace scope for the namespace URI.</summary>
<param name="ns">The namespace URI whose prefix you want to find.</param>
+ <returns>The matching prefix or <see langword="null" /> if no matching namespace URI is found in the current scope.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="ns" /> is either <see langword="null" /> or <see langword="String.Empty" />.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The matching prefix or <see langword="null" /> if no matching namespace URI is found in the current scope.</returns>
+ </member>
+ <member name="P:System.Xml.XmlWriter.Settings">
+ <summary>Gets the <see cref="T:System.Xml.XmlWriterSettings" /> object used to create this <see cref="T:System.Xml.XmlWriter" /> instance.</summary>
+ <returns>The <see cref="T:System.Xml.XmlWriterSettings" /> object used to create this writer instance. If this writer was not created using the <see cref="Overload:System.Xml.XmlWriter.Create" /> method, this property returns <see langword="null" />.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlWriter.WriteAttributes(System.Xml.XmlReader,System.Boolean)">
<summary>When overridden in a derived class, writes out all the attributes found at the current position in the <see cref="T:System.Xml.XmlReader" />.</summary>
<param name="reader">The <see langword="XmlReader" /> from which to copy the attributes.</param>
<param name="defattr">
<see langword="true" /> to copy the default attributes from the <see langword="XmlReader" />; otherwise, <see langword="false" />.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteAttributes" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteAttributes" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteAttributeString(System.String,System.String)">
<summary>When overridden in a derived class, writes out the attribute with the specified local name and value.</summary>
<param name="localName">The local name of the attribute.</param>
<param name="value">The value of the attribute.</param>
<exception cref="T:System.InvalidOperationException">The state of writer is not <see langword="WriteState.Element" /> or writer is closed.
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.ArgumentException">The <see langword="xml:space" /> or <see langword="xml:lang" /> attribute value is invalid.</exception>
</member>
<param name="ns">The namespace URI to associate with the attribute.</param>
<param name="value">The value of the attribute.</param>
<exception cref="T:System.InvalidOperationException">The state of writer is not <see langword="WriteState.Element" /> or writer is closed.
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.ArgumentException">The <see langword="xml:space" /> or <see langword="xml:lang" /> attribute value is invalid.</exception>
</member>
<param name="ns">The namespace URI of the attribute.</param>
<param name="value">The value of the attribute.</param>
<exception cref="T:System.InvalidOperationException">The state of writer is not <see langword="WriteState.Element" /> or writer is closed.
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.ArgumentException">The <see langword="xml:space" /> or <see langword="xml:lang" /> attribute value is invalid.</exception>
<exception cref="T:System.Xml.XmlException">The <paramref name="localName" /> or <paramref name="ns" /> is <see langword="null" />.</exception>
<param name="localName">The local name of the attribute.</param>
<param name="ns">The namespace URI of the attribute.</param>
<param name="value">The value of the attribute.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteAttributeString" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteAttributeString" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteBase64(System.Byte[],System.Int32,System.Int32)">
<summary>When overridden in a derived class, encodes the specified binary bytes as Base64 and writes out the resulting text.</summary>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index" /> or <paramref name="count" /> is less than zero.
-
- -or-
-
- The buffer length minus <paramref name="index" /> is less than <paramref name="count" />.</exception>
+ <paramref name="index" /> or <paramref name="count" /> is less than zero.
+-or-
+The buffer length minus <paramref name="index" /> is less than <paramref name="count" />.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlWriter.WriteBase64Async(System.Byte[],System.Int32,System.Int32)">
<param name="buffer">Byte array to encode.</param>
<param name="index">The position in the buffer indicating the start of the bytes to write.</param>
<param name="count">The number of bytes to write.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteBase64" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteBase64" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteBinHex(System.Byte[],System.Int32,System.Int32)">
<summary>When overridden in a derived class, encodes the specified binary bytes as <see langword="BinHex" /> and writes out the resulting text.</summary>
<paramref name="buffer" /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The writer is closed or in error state.
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index" /> or <paramref name="count" /> is less than zero.
-
- -or-
-
- The buffer length minus <paramref name="index" /> is less than <paramref name="count" />.</exception>
+ <paramref name="index" /> or <paramref name="count" /> is less than zero.
+-or-
+The buffer length minus <paramref name="index" /> is less than <paramref name="count" />.</exception>
</member>
<member name="M:System.Xml.XmlWriter.WriteBinHexAsync(System.Byte[],System.Int32,System.Int32)">
<summary>Asynchronously encodes the specified binary bytes as <see langword="BinHex" /> and writes out the resulting text.</summary>
<param name="buffer">Byte array to encode.</param>
<param name="index">The position in the buffer indicating the start of the bytes to write.</param>
<param name="count">The number of bytes to write.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteBinHex" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteBinHex" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteCData(System.String)">
<summary>When overridden in a derived class, writes out a <![CDATA[...]]> block containing the specified text.</summary>
<member name="M:System.Xml.XmlWriter.WriteCDataAsync(System.String)">
<summary>Asynchronously writes out a <![CDATA[...]]> block containing the specified text.</summary>
<param name="text">The text to place inside the CDATA block.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteCData" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteCData" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteCharEntity(System.Char)">
<summary>When overridden in a derived class, forces the generation of a character entity for the specified Unicode character value.</summary>
<member name="M:System.Xml.XmlWriter.WriteCharEntityAsync(System.Char)">
<summary>Asynchronously forces the generation of a character entity for the specified Unicode character value.</summary>
<param name="ch">The Unicode character for which to generate a character entity.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteCharEntity" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteCharEntity" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteChars(System.Char[],System.Int32,System.Int32)">
<summary>When overridden in a derived class, writes text one buffer at a time.</summary>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index" /> or <paramref name="count" /> is less than zero.
-
- -or-
-
- The buffer length minus <paramref name="index" /> is less than <paramref name="count" />; the call results in surrogate pair characters being split or an invalid surrogate pair being written.</exception>
+ <paramref name="index" /> or <paramref name="count" /> is less than zero.
+-or-
+The buffer length minus <paramref name="index" /> is less than <paramref name="count" />; the call results in surrogate pair characters being split or an invalid surrogate pair being written.</exception>
<exception cref="T:System.ArgumentException">The <paramref name="buffer" /> parameter value is not valid.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<param name="buffer">Character array containing the text to write.</param>
<param name="index">The position in the buffer indicating the start of the text to write.</param>
<param name="count">The number of characters to write.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteChars" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteChars" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteComment(System.String)">
<summary>When overridden in a derived class, writes out a comment <!--...--> containing the specified text.</summary>
<member name="M:System.Xml.XmlWriter.WriteCommentAsync(System.String)">
<summary>Asynchronously writes out a comment <!--...--> containing the specified text.</summary>
<param name="text">Text to place inside the comment.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteComment" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteComment" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteDocType(System.String,System.String,System.String,System.String)">
<summary>When overridden in a derived class, writes the DOCTYPE declaration with the specified name and optional attributes.</summary>
<param name="sysid">If <paramref name="pubid" /> is <see langword="null" /> and <paramref name="sysid" /> is non-null it writes SYSTEM "sysid" where <paramref name="sysid" /> is replaced with the value of this argument.</param>
<param name="subset">If non-null it writes [subset] where subset is replaced with the value of this argument.</param>
<exception cref="T:System.InvalidOperationException">This method was called outside the prolog (after the root element).
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.ArgumentException">The value for <paramref name="name" /> would result in invalid XML.</exception>
</member>
<param name="pubid">If non-null it also writes PUBLIC "pubid" "sysid" where <paramref name="pubid" /> and <paramref name="sysid" /> are replaced with the value of the given arguments.</param>
<param name="sysid">If <paramref name="pubid" /> is <see langword="null" /> and <paramref name="sysid" /> is non-null it writes SYSTEM "sysid" where <paramref name="sysid" /> is replaced with the value of this argument.</param>
<param name="subset">If non-null it writes [subset] where subset is replaced with the value of this argument.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteDocType" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteDocType" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteElementString(System.String,System.String)">
<summary>Writes an element with the specified local name and value.</summary>
<param name="localName">The local name of the element.</param>
<param name="value">The value of the element.</param>
- <exception cref="T:System.ArgumentException">The <paramref name="localName" /> value is <see langword="null" /> or an empty string.
-
- -or-
-
- The parameter values are not valid.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="localName" /> value is <see langword="null" /> or an empty string.
+-or-
+The parameter values are not valid.</exception>
<exception cref="T:System.Text.EncoderFallbackException">There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII, you should only use characters from the range of 0 to 127 for element and attribute names. The invalid character might be in the argument of this method or in an argument of previous methods that were writing to the buffer. Such characters are escaped by character entity references when possible (for example, in text nodes or attribute values). However, the character entity reference is not allowed in element and attribute names, comments, processing instructions, or CDATA sections.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<param name="localName">The local name of the element.</param>
<param name="ns">The namespace URI to associate with the element.</param>
<param name="value">The value of the element.</param>
- <exception cref="T:System.ArgumentException">The <paramref name="localName" /> value is <see langword="null" /> or an empty string.
-
- -or-
-
- The parameter values are not valid.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="localName" /> value is <see langword="null" /> or an empty string.
+-or-
+The parameter values are not valid.</exception>
<exception cref="T:System.Text.EncoderFallbackException">There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII, you should only use characters from the range of 0 to 127 for element and attribute names. The invalid character might be in the argument of this method or in an argument of previous methods that were writing to the buffer. Such characters are escaped by character entity references when possible (for example, in text nodes or attribute values). However, the character entity reference is not allowed in element and attribute names, comments, processing instructions, or CDATA sections.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<param name="localName">The local name of the element.</param>
<param name="ns">The namespace URI of the element.</param>
<param name="value">The value of the element.</param>
- <exception cref="T:System.ArgumentException">The <paramref name="localName" /> value is <see langword="null" /> or an empty string.
-
- -or-
-
- The parameter values are not valid.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="localName" /> value is <see langword="null" /> or an empty string.
+-or-
+The parameter values are not valid.</exception>
<exception cref="T:System.Text.EncoderFallbackException">There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII, you should only use characters from the range of 0 to 127 for element and attribute names. The invalid character might be in the argument of this method or in an argument of previous methods that were writing to the buffer. Such characters are escaped by character entity references when possible (for example, in text nodes or attribute values). However, the character entity reference is not allowed in element and attribute names, comments, processing instructions, or CDATA sections.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<param name="localName">The local name of the element.</param>
<param name="ns">The namespace URI of the element.</param>
<param name="value">The value of the element.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteElementString" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteElementString" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteEndAttribute">
<summary>When overridden in a derived class, closes the previous <see cref="M:System.Xml.XmlWriter.WriteStartAttribute(System.String,System.String)" /> call.</summary>
</member>
<member name="M:System.Xml.XmlWriter.WriteEndAttributeAsync">
<summary>Asynchronously closes the previous <see cref="M:System.Xml.XmlWriter.WriteStartAttribute(System.String,System.String)" /> call.</summary>
+ <returns>The task that represents the asynchronous <see langword="WriteEndAttribute" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteEndAttribute" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteEndDocument">
<summary>When overridden in a derived class, closes any open elements or attributes and puts the writer back in the Start state.</summary>
</member>
<member name="M:System.Xml.XmlWriter.WriteEndDocumentAsync">
<summary>Asynchronously closes any open elements or attributes and puts the writer back in the Start state.</summary>
+ <returns>The task that represents the asynchronous <see langword="WriteEndDocument" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteEndDocument" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteEndElement">
<summary>When overridden in a derived class, closes one element and pops the corresponding namespace scope.</summary>
<exception cref="T:System.InvalidOperationException">This results in an invalid XML document.
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlWriter.WriteEndElementAsync">
<summary>Asynchronously closes one element and pops the corresponding namespace scope.</summary>
+ <returns>The task that represents the asynchronous <see langword="WriteEndElement" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteEndElement" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteEntityRef(System.String)">
<summary>When overridden in a derived class, writes out an entity reference as <see langword="&name;" />.</summary>
<member name="M:System.Xml.XmlWriter.WriteEntityRefAsync(System.String)">
<summary>Asynchronously writes out an entity reference as <see langword="&name;" />.</summary>
<param name="name">The name of the entity reference.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteEntityRef" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteEntityRef" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteFullEndElement">
<summary>When overridden in a derived class, closes one element and pops the corresponding namespace scope.</summary>
</member>
<member name="M:System.Xml.XmlWriter.WriteFullEndElementAsync">
<summary>Asynchronously closes one element and pops the corresponding namespace scope.</summary>
+ <returns>The task that represents the asynchronous <see langword="WriteFullEndElement" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteFullEndElement" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteName(System.String)">
<summary>When overridden in a derived class, writes out the specified name, ensuring it is a valid name according to the W3C XML 1.0 recommendation (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).</summary>
<member name="M:System.Xml.XmlWriter.WriteNameAsync(System.String)">
<summary>Asynchronously writes out the specified name, ensuring it is a valid name according to the W3C XML 1.0 recommendation (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).</summary>
<param name="name">The name to write.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteName" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteName" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteNmToken(System.String)">
<summary>When overridden in a derived class, writes out the specified name, ensuring it is a valid NmToken according to the W3C XML 1.0 recommendation (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).</summary>
<member name="M:System.Xml.XmlWriter.WriteNmTokenAsync(System.String)">
<summary>Asynchronously writes out the specified name, ensuring it is a valid NmToken according to the W3C XML 1.0 recommendation (https://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).</summary>
<param name="name">The name to write.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteNmToken" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteNmToken" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteNode(System.Xml.XmlReader,System.Boolean)">
<summary>When overridden in a derived class, copies everything from the reader to the writer and moves the reader to the start of the next sibling.</summary>
<param name="reader">The <see cref="T:System.Xml.XmlReader" /> to read from.</param>
<param name="defattr">
<see langword="true" /> to copy the default attributes from the <see langword="XmlReader" />; otherwise, <see langword="false" />.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteNode" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteNode" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteNodeAsync(System.Xml.XPath.XPathNavigator,System.Boolean)">
<summary>Asynchronously copies everything from the <see cref="T:System.Xml.XPath.XPathNavigator" /> object to the writer. The position of the <see cref="T:System.Xml.XPath.XPathNavigator" /> remains unchanged.</summary>
<param name="navigator">The <see cref="T:System.Xml.XPath.XPathNavigator" /> to copy from.</param>
<param name="defattr">
<see langword="true" /> to copy the default attributes; otherwise, <see langword="false" />.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteNode" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteNode" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteProcessingInstruction(System.String,System.String)">
<summary>When overridden in a derived class, writes out a processing instruction with a space between the name and text as follows: <?name text?>.</summary>
<param name="name">The name of the processing instruction.</param>
<param name="text">The text to include in the processing instruction.</param>
- <exception cref="T:System.ArgumentException">The text would result in a non-well formed XML document.
-
- <paramref name="name" /> is either <see langword="null" /> or <see langword="String.Empty" />.
-
- This method is being used to create an XML declaration after <see cref="M:System.Xml.XmlWriter.WriteStartDocument" /> has already been called.</exception>
+ <exception cref="T:System.ArgumentException">The text would result in a non-well formed XML document.
+<paramref name="name" /> is either <see langword="null" /> or <see langword="String.Empty" />.
+This method is being used to create an XML declaration after <see cref="M:System.Xml.XmlWriter.WriteStartDocument" /> has already been called.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlWriter.WriteProcessingInstructionAsync(System.String,System.String)">
<summary>Asynchronously writes out a processing instruction with a space between the name and text as follows: <?name text?>.</summary>
<param name="name">The name of the processing instruction.</param>
<param name="text">The text to include in the processing instruction.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteProcessingInstruction" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteProcessingInstruction" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteQualifiedName(System.String,System.String)">
<summary>When overridden in a derived class, writes out the namespace-qualified name. This method looks up the prefix that is in scope for the given namespace.</summary>
<param name="localName">The local name to write.</param>
<param name="ns">The namespace URI for the name.</param>
<exception cref="T:System.ArgumentException">
- <paramref name="localName" /> is either <see langword="null" /> or <see langword="String.Empty" />.
-
- <paramref name="localName" /> is not a valid name.</exception>
+ <paramref name="localName" /> is either <see langword="null" /> or <see langword="String.Empty" />.
+<paramref name="localName" /> is not a valid name.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlWriter.WriteQualifiedNameAsync(System.String,System.String)">
<summary>Asynchronously writes out the namespace-qualified name. This method looks up the prefix that is in scope for the given namespace.</summary>
<param name="localName">The local name to write.</param>
<param name="ns">The namespace URI for the name.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteQualifiedName" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteQualifiedName" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteRaw(System.Char[],System.Int32,System.Int32)">
<summary>When overridden in a derived class, writes raw markup manually from a character buffer.</summary>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index" /> or <paramref name="count" /> is less than zero.
-
- -or-
-
- The buffer length minus <paramref name="index" /> is less than <paramref name="count" />.</exception>
+ <paramref name="index" /> or <paramref name="count" /> is less than zero.
+-or-
+The buffer length minus <paramref name="index" /> is less than <paramref name="count" />.</exception>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlWriter.WriteRaw(System.String)">
<param name="buffer">Character array containing the text to write.</param>
<param name="index">The position within the buffer indicating the start of the text to write.</param>
<param name="count">The number of characters to write.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteRaw" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteRaw" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteRawAsync(System.String)">
<summary>Asynchronously writes raw markup manually from a string.</summary>
<param name="data">String containing the text to write.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteRaw" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteRaw" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteStartAttribute(System.String)">
<summary>Writes the start of an attribute with the specified local name.</summary>
<param name="localName">The local name of the attribute.</param>
<exception cref="T:System.InvalidOperationException">The writer is closed.
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.Text.EncoderFallbackException">There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII, you should only use characters from the range of 0 to 127 for element and attribute names. The invalid character might be in the argument of this method or in an argument of previous methods that were writing to the buffer. Such characters are escaped by character entity references when possible (for example, in text nodes or attribute values). However, the character entity reference is not allowed in element and attribute names, comments, processing instructions, or CDATA sections.</exception>
</member>
<param name="prefix">The namespace prefix of the attribute.</param>
<param name="localName">The local name of the attribute.</param>
<param name="ns">The namespace URI for the attribute.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteStartAttribute" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteStartAttribute" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteStartDocument">
<summary>When overridden in a derived class, writes the XML declaration with the version "1.0".</summary>
<exception cref="T:System.InvalidOperationException">This is not the first write method called after the constructor.
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlWriter.WriteStartDocument(System.Boolean)">
<summary>When overridden in a derived class, writes the XML declaration with the version "1.0" and the standalone attribute.</summary>
<param name="standalone">If <see langword="true" />, it writes "standalone=yes"; if <see langword="false" />, it writes "standalone=no".</param>
<exception cref="T:System.InvalidOperationException">This is not the first write method called after the constructor.
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlWriter.WriteStartDocumentAsync">
<summary>Asynchronously writes the XML declaration with the version "1.0".</summary>
+ <returns>The task that represents the asynchronous <see langword="WriteStartDocument" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteStartDocument" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteStartDocumentAsync(System.Boolean)">
<summary>Asynchronously writes the XML declaration with the version "1.0" and the standalone attribute.</summary>
<param name="standalone">If <see langword="true" />, it writes "standalone=yes"; if <see langword="false" />, it writes "standalone=no".</param>
+ <returns>The task that represents the asynchronous <see langword="WriteStartDocument" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteStartDocument" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteStartElement(System.String)">
<summary>When overridden in a derived class, writes out a start tag with the specified local name.</summary>
<param name="localName">The local name of the element.</param>
<exception cref="T:System.InvalidOperationException">The writer is closed.
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.Text.EncoderFallbackException">There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII, you should only use characters from the range of 0 to 127 for element and attribute names. The invalid character might be in the argument of this method or in an argument of previous methods that were writing to the buffer. Such characters are escaped by character entity references when possible (for example, in text nodes or attribute values). However, the character entity reference is not allowed in element and attribute names, comments, processing instructions, or CDATA sections.</exception>
</member>
<param name="localName">The local name of the element.</param>
<param name="ns">The namespace URI to associate with the element. If this namespace is already in scope and has an associated prefix, the writer automatically writes that prefix also.</param>
<exception cref="T:System.InvalidOperationException">The writer is closed.
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.Text.EncoderFallbackException">There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII, you should only use characters from the range of 0 to 127 for element and attribute names. The invalid character might be in the argument of this method or in an argument of previous methods that were writing to the buffer. Such characters are escaped by character entity references when possible (for example, in text nodes or attribute values). However, the character entity reference is not allowed in element and attribute names, comments, processing instructions, or CDATA sections.</exception>
</member>
<param name="localName">The local name of the element.</param>
<param name="ns">The namespace URI to associate with the element.</param>
<exception cref="T:System.InvalidOperationException">The writer is closed.
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<exception cref="T:System.Text.EncoderFallbackException">There is a character in the buffer that is a valid XML character but is not valid for the output encoding. For example, if the output encoding is ASCII, you should only use characters from the range of 0 to 127 for element and attribute names. The invalid character might be in the argument of this method or in an argument of previous methods that were writing to the buffer. Such characters are escaped by character entity references when possible (for example, in text nodes or attribute values). However, the character entity reference is not allowed in element and attribute names, comments, processing instructions, or CDATA sections.</exception>
</member>
<param name="prefix">The namespace prefix of the element.</param>
<param name="localName">The local name of the element.</param>
<param name="ns">The namespace URI to associate with the element.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteStartElement" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteStartElement" /> operation.</returns>
+ </member>
+ <member name="P:System.Xml.XmlWriter.WriteState">
+ <summary>When overridden in a derived class, gets the state of the writer.</summary>
+ <returns>One of the <see cref="T:System.Xml.WriteState" /> values.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlWriter.WriteString(System.String)">
<summary>When overridden in a derived class, writes the given text content.</summary>
<member name="M:System.Xml.XmlWriter.WriteStringAsync(System.String)">
<summary>Asynchronously writes the given text content.</summary>
<param name="text">The text to write.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteString" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteString" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteSurrogateCharEntity(System.Char,System.Char)">
<summary>When overridden in a derived class, generates and writes the surrogate character entity for the surrogate character pair.</summary>
<summary>Asynchronously generates and writes the surrogate character entity for the surrogate character pair.</summary>
<param name="lowChar">The low surrogate. This must be a value between 0xDC00 and 0xDFFF.</param>
<param name="highChar">The high surrogate. This must be a value between 0xD800 and 0xDBFF.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteSurrogateCharEntity" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteSurrogateCharEntity" /> operation.</returns>
</member>
<member name="M:System.Xml.XmlWriter.WriteValue(System.Boolean)">
<summary>Writes a <see cref="T:System.Boolean" /> value.</summary>
</member>
<member name="M:System.Xml.XmlWriter.WriteValue(System.Object)">
<summary>Writes the object value.</summary>
- <param name="value">The object value to write.
-
- Note With the release of the .NET Framework 3.5, this method accepts <see cref="T:System.DateTimeOffset" /> as a parameter.</param>
+ <param name="value">The object value to write.
+Note With the release of the .NET Framework 3.5, this method accepts <see cref="T:System.DateTimeOffset" /> as a parameter.</param>
<exception cref="T:System.ArgumentException">An invalid value was specified.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="value" /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The writer is closed or in error state.
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="M:System.Xml.XmlWriter.WriteValue(System.Single)">
<member name="M:System.Xml.XmlWriter.WriteWhitespaceAsync(System.String)">
<summary>Asynchronously writes out the given white space.</summary>
<param name="ws">The string of white space characters.</param>
+ <returns>The task that represents the asynchronous <see langword="WriteWhitespace" /> operation.</returns>
<exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."
-
-or-
-
An <see cref="T:System.Xml.XmlWriter" /> asynchronous method was called without setting the <see cref="P:System.Xml.XmlWriterSettings.Async" /> flag to <see langword="true" />. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "Set XmlWriterSettings.Async to true if you want to use Async Methods."</exception>
- <returns>The task that represents the asynchronous <see langword="WriteWhitespace" /> operation.</returns>
- </member>
- <member name="P:System.Xml.XmlWriter.Settings">
- <summary>Gets the <see cref="T:System.Xml.XmlWriterSettings" /> object used to create this <see cref="T:System.Xml.XmlWriter" /> instance.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>The <see cref="T:System.Xml.XmlWriterSettings" /> object used to create this writer instance. If this writer was not created using the <see cref="Overload:System.Xml.XmlWriter.Create" /> method, this property returns <see langword="null" />.</returns>
- </member>
- <member name="P:System.Xml.XmlWriter.WriteState">
- <summary>When overridden in a derived class, gets the state of the writer.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>One of the <see cref="T:System.Xml.WriteState" /> values.</returns>
</member>
<member name="P:System.Xml.XmlWriter.XmlLang">
<summary>When overridden in a derived class, gets the current <see langword="xml:lang" /> scope.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
<returns>The current <see langword="xml:lang" /> scope.</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="P:System.Xml.XmlWriter.XmlSpace">
<summary>When overridden in a derived class, gets an <see cref="T:System.Xml.XmlSpace" /> representing the current <see langword="xml:space" /> scope.</summary>
- <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
- <returns>An <see langword="XmlSpace" /> representing the current <see langword="xml:space" /> scope.
+ <returns>An <see langword="XmlSpace" /> representing the current <see langword="xml:space" /> scope.
+ Value
+
+ Meaning
- <list type="table"><listheader><term> Value</term><description> Meaning</description></listheader><item><term><see langword="None" /></term><description> This is the default if no <see langword="xml:space" /> scope exists.</description></item><item><term><see langword="Default" /></term><description> The current scope is <see langword="xml:space" />="default".</description></item><item><term><see langword="Preserve" /></term><description> The current scope is <see langword="xml:space" />="preserve".</description></item></list></returns>
+ <see langword="None" /> This is the default if no <see langword="xml:space" /> scope exists.
+
+ <see langword="Default" /> The current scope is <see langword="xml:space" />="default".
+
+ <see langword="Preserve" /> The current scope is <see langword="xml:space" />="preserve".</returns>
+ <exception cref="T:System.InvalidOperationException">An <see cref="T:System.Xml.XmlWriter" /> method was called before a previous asynchronous operation finished. In this case, <see cref="T:System.InvalidOperationException" /> is thrown with the message "An asynchronous operation is already in progress."</exception>
</member>
<member name="T:System.Xml.XmlWriterSettings">
<summary>Specifies a set of features to support on the <see cref="T:System.Xml.XmlWriter" /> object created by the <see cref="Overload:System.Xml.XmlWriter.Create" /> method.</summary>
<member name="M:System.Xml.XmlWriterSettings.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.XmlWriterSettings" /> class.</summary>
</member>
- <member name="M:System.Xml.XmlWriterSettings.Clone">
- <summary>Creates a copy of the <see cref="T:System.Xml.XmlWriterSettings" /> instance.</summary>
- <returns>The cloned <see cref="T:System.Xml.XmlWriterSettings" /> object.</returns>
- </member>
- <member name="M:System.Xml.XmlWriterSettings.Reset">
- <summary>Resets the members of the settings class to their default values.</summary>
- </member>
<member name="P:System.Xml.XmlWriterSettings.Async">
<summary>Gets or sets a value that indicates whether asynchronous <see cref="T:System.Xml.XmlWriter" /> methods can be used on a particular <see cref="T:System.Xml.XmlWriter" /> instance.</summary>
<returns>
<returns>
<see langword="true" /> to do character checking; otherwise, <see langword="false" />. The default is <see langword="true" />.</returns>
</member>
+ <member name="M:System.Xml.XmlWriterSettings.Clone">
+ <summary>Creates a copy of the <see cref="T:System.Xml.XmlWriterSettings" /> instance.</summary>
+ <returns>The cloned <see cref="T:System.Xml.XmlWriterSettings" /> object.</returns>
+ </member>
<member name="P:System.Xml.XmlWriterSettings.CloseOutput">
<summary>Gets or sets a value indicating whether the <see cref="T:System.Xml.XmlWriter" /> should also close the underlying stream or <see cref="T:System.IO.TextWriter" /> when the <see cref="M:System.Xml.XmlWriter.Close" /> method is called.</summary>
<returns>
</member>
<member name="P:System.Xml.XmlWriterSettings.IndentChars">
<summary>Gets or sets the character string to use when indenting. This setting is used when the <see cref="P:System.Xml.XmlWriterSettings.Indent" /> property is set to <see langword="true" />.</summary>
- <exception cref="T:System.ArgumentNullException">The value assigned to the <see cref="P:System.Xml.XmlWriterSettings.IndentChars" /> is <see langword="null" />.</exception>
<returns>The character string to use when indenting. This can be set to any string value. However, to ensure valid XML, you should specify only valid white space characters, such as space characters, tabs, carriage returns, or line feeds. The default is two spaces.</returns>
+ <exception cref="T:System.ArgumentNullException">The value assigned to the <see cref="P:System.Xml.XmlWriterSettings.IndentChars" /> is <see langword="null" />.</exception>
</member>
<member name="P:System.Xml.XmlWriterSettings.NamespaceHandling">
<summary>Gets or sets a value that indicates whether the <see cref="T:System.Xml.XmlWriter" /> should remove duplicate namespace declarations when writing XML content. The default behavior is for the writer to output all namespace declarations that are present in the writer's namespace resolver.</summary>
</member>
<member name="P:System.Xml.XmlWriterSettings.NewLineChars">
<summary>Gets or sets the character string to use for line breaks.</summary>
- <exception cref="T:System.ArgumentNullException">The value assigned to the <see cref="P:System.Xml.XmlWriterSettings.NewLineChars" /> is <see langword="null" />.</exception>
<returns>The character string to use for line breaks. This can be set to any string value. However, to ensure valid XML, you should specify only valid white space characters, such as space characters, tabs, carriage returns, or line feeds. The default is <c>\r\n</c> (carriage return, new line).</returns>
+ <exception cref="T:System.ArgumentNullException">The value assigned to the <see cref="P:System.Xml.XmlWriterSettings.NewLineChars" /> is <see langword="null" />.</exception>
</member>
<member name="P:System.Xml.XmlWriterSettings.NewLineHandling">
<summary>Gets or sets a value indicating whether to normalize line breaks in the output.</summary>
<member name="P:System.Xml.XmlWriterSettings.NewLineOnAttributes">
<summary>Gets or sets a value indicating whether to write attributes on a new line.</summary>
<returns>
- <see langword="true" /> to write attributes on individual lines; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
+ <see langword="true" /> to write attributes on individual lines; otherwise, <see langword="false" />. The default is <see langword="false" />.
+
+This setting has no effect when the <see cref="P:System.Xml.XmlWriterSettings.Indent" /> property value is <see langword="false" />.
+
+
+ When <see cref="P:System.Xml.XmlWriterSettings.NewLineOnAttributes" /> is set to <see langword="true" />, each attribute is pre-pended with a new line and one extra level of indentation.</returns>
</member>
<member name="P:System.Xml.XmlWriterSettings.OmitXmlDeclaration">
<summary>Gets or sets a value indicating whether to omit an XML declaration.</summary>
<summary>Gets the method used to serialize the <see cref="T:System.Xml.XmlWriter" /> output.</summary>
<returns>One of the <see cref="T:System.Xml.XmlOutputMethod" /> values. The default is <see cref="F:System.Xml.XmlOutputMethod.Xml" />.</returns>
</member>
+ <member name="M:System.Xml.XmlWriterSettings.Reset">
+ <summary>Resets the members of the settings class to their default values.</summary>
+ </member>
<member name="P:System.Xml.XmlWriterSettings.WriteEndDocumentOnClose">
<summary>Gets or sets a value that indicates whether the <see cref="T:System.Xml.XmlWriter" /> will add closing tags to all unclosed element tags when the <see cref="M:System.Xml.XmlWriter.Close" /> method is called.</summary>
<returns>
<member name="M:System.Xml.XPath.XPathExpression.Compile(System.String)">
<summary>Compiles the XPath expression specified and returns an <see cref="T:System.Xml.XPath.XPathExpression" /> object representing the XPath expression.</summary>
<param name="xpath">An XPath expression.</param>
+ <returns>An <see cref="T:System.Xml.XPath.XPathExpression" /> object.</returns>
<exception cref="T:System.ArgumentException">The XPath expression parameter is not a valid XPath expression.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
- <returns>An <see cref="T:System.Xml.XPath.XPathExpression" /> object.</returns>
</member>
<member name="M:System.Xml.XPath.XPathExpression.Compile(System.String,System.Xml.IXmlNamespaceResolver)">
<summary>Compiles the specified XPath expression, with the <see cref="T:System.Xml.IXmlNamespaceResolver" /> object specified for namespace resolution, and returns an <see cref="T:System.Xml.XPath.XPathExpression" /> object that represents the XPath expression.</summary>
<param name="xpath">An XPath expression.</param>
<param name="nsResolver">An object that implements the <see cref="T:System.Xml.IXmlNamespaceResolver" /> interface for namespace resolution.</param>
+ <returns>An <see cref="T:System.Xml.XPath.XPathExpression" /> object.</returns>
<exception cref="T:System.ArgumentException">The XPath expression parameter is not a valid XPath expression.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
- <returns>An <see cref="T:System.Xml.XPath.XPathExpression" /> object.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathExpression.Expression">
+ <summary>When overridden in a derived class, gets a <see langword="string" /> representation of the <see cref="T:System.Xml.XPath.XPathExpression" />.</summary>
+ <returns>A <see langword="string" /> representation of the <see cref="T:System.Xml.XPath.XPathExpression" />.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathExpression.ReturnType">
+ <summary>When overridden in a derived class, gets the result type of the XPath expression.</summary>
+ <returns>An <see cref="T:System.Xml.XPath.XPathResultType" /> value representing the result type of the XPath expression.</returns>
</member>
<member name="M:System.Xml.XPath.XPathExpression.SetContext(System.Xml.IXmlNamespaceResolver)">
<summary>When overridden in a derived class, specifies the <see cref="T:System.Xml.IXmlNamespaceResolver" /> object to use for namespace resolution.</summary>
<param name="nsManager">An <see cref="T:System.Xml.XmlNamespaceManager" /> object to use for namespace resolution.</param>
<exception cref="T:System.Xml.XPath.XPathException">The <see cref="T:System.Xml.XmlNamespaceManager" /> object parameter is not derived from the <see cref="T:System.Xml.XmlNamespaceManager" /> class.</exception>
</member>
- <member name="P:System.Xml.XPath.XPathExpression.Expression">
- <summary>When overridden in a derived class, gets a <see langword="string" /> representation of the <see cref="T:System.Xml.XPath.XPathExpression" />.</summary>
- <returns>A <see langword="string" /> representation of the <see cref="T:System.Xml.XPath.XPathExpression" />.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathExpression.ReturnType">
- <summary>When overridden in a derived class, gets the result type of the XPath expression.</summary>
- <returns>An <see cref="T:System.Xml.XPath.XPathResultType" /> value representing the result type of the XPath expression.</returns>
- </member>
<member name="T:System.Xml.XPath.XPathItem">
<summary>Represents an item in the XQuery 1.0 and XPath 2.0 Data Model.</summary>
</member>
<member name="M:System.Xml.XPath.XPathItem.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.Xml.XPath.XPathItem" /> class.</summary>
</member>
+ <member name="P:System.Xml.XPath.XPathItem.IsNode">
+ <summary>When overridden in a derived class, gets a value indicating whether the item represents an XPath node or an atomic value.</summary>
+ <returns>
+ <see langword="true" /> if the item represents an XPath node; <see langword="false" /> if the item represents an atomic value.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathItem.TypedValue">
+ <summary>When overridden in a derived class, gets the current item as a boxed object of the most appropriate .NET Framework 2.0 type according to its schema type.</summary>
+ <returns>The current item as a boxed object of the most appropriate .NET Framework type.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathItem.Value">
+ <summary>When overridden in a derived class, gets the <see langword="string" /> value of the item.</summary>
+ <returns>The <see langword="string" /> value of the item.</returns>
+ </member>
<member name="M:System.Xml.XPath.XPathItem.ValueAs(System.Type)">
<summary>Returns the item's value as the specified type.</summary>
<param name="returnType">The type to return the item value as.</param>
+ <returns>The value of the item as the type requested.</returns>
<exception cref="T:System.FormatException">The item's value is not in the correct format for the target type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.OverflowException">The attempted cast resulted in an overflow.</exception>
- <returns>The value of the item as the type requested.</returns>
</member>
<member name="M:System.Xml.XPath.XPathItem.ValueAs(System.Type,System.Xml.IXmlNamespaceResolver)">
<summary>When overridden in a derived class, returns the item's value as the type specified using the <see cref="T:System.Xml.IXmlNamespaceResolver" /> object specified to resolve namespace prefixes.</summary>
<param name="returnType">The type to return the item's value as.</param>
<param name="nsResolver">The <see cref="T:System.Xml.IXmlNamespaceResolver" /> object used to resolve namespace prefixes.</param>
+ <returns>The value of the item as the type requested.</returns>
<exception cref="T:System.FormatException">The item's value is not in the correct format for the target type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
<exception cref="T:System.OverflowException">The attempted cast resulted in an overflow.</exception>
- <returns>The value of the item as the type requested.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathItem.IsNode">
- <summary>When overridden in a derived class, gets a value indicating whether the item represents an XPath node or an atomic value.</summary>
- <returns>
- <see langword="true" /> if the item represents an XPath node; <see langword="false" /> if the item represents an atomic value.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathItem.TypedValue">
- <summary>When overridden in a derived class, gets the current item as a boxed object of the most appropriate .NET Framework 2.0 type according to its schema type.</summary>
- <returns>The current item as a boxed object of the most appropriate .NET Framework type.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathItem.Value">
- <summary>When overridden in a derived class, gets the <see langword="string" /> value of the item.</summary>
- <returns>The <see langword="string" /> value of the item.</returns>
</member>
<member name="P:System.Xml.XPath.XPathItem.ValueAsBoolean">
<summary>When overridden in a derived class, gets the item's value as a <see cref="T:System.Boolean" />.</summary>
+ <returns>The item's value as a <see cref="T:System.Boolean" />.</returns>
<exception cref="T:System.FormatException">The item's value is not in the correct format for the <see cref="T:System.Boolean" /> type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.Boolean" /> is not valid.</exception>
- <returns>The item's value as a <see cref="T:System.Boolean" />.</returns>
</member>
<member name="P:System.Xml.XPath.XPathItem.ValueAsDateTime">
<summary>When overridden in a derived class, gets the item's value as a <see cref="T:System.DateTime" />.</summary>
+ <returns>The item's value as a <see cref="T:System.DateTime" />.</returns>
<exception cref="T:System.FormatException">The item's value is not in the correct format for the <see cref="T:System.DateTime" /> type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.DateTime" /> is not valid.</exception>
- <returns>The item's value as a <see cref="T:System.DateTime" />.</returns>
</member>
<member name="P:System.Xml.XPath.XPathItem.ValueAsDouble">
<summary>When overridden in a derived class, gets the item's value as a <see cref="T:System.Double" />.</summary>
+ <returns>The item's value as a <see cref="T:System.Double" />.</returns>
<exception cref="T:System.FormatException">The item's value is not in the correct format for the <see cref="T:System.Double" /> type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.Double" /> is not valid.</exception>
<exception cref="T:System.OverflowException">The attempted cast resulted in an overflow.</exception>
- <returns>The item's value as a <see cref="T:System.Double" />.</returns>
</member>
<member name="P:System.Xml.XPath.XPathItem.ValueAsInt">
<summary>When overridden in a derived class, gets the item's value as an <see cref="T:System.Int32" />.</summary>
+ <returns>The item's value as an <see cref="T:System.Int32" />.</returns>
<exception cref="T:System.FormatException">The item's value is not in the correct format for the <see cref="T:System.Int32" /> type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.Int32" /> is not valid.</exception>
<exception cref="T:System.OverflowException">The attempted cast resulted in an overflow.</exception>
- <returns>The item's value as an <see cref="T:System.Int32" />.</returns>
</member>
<member name="P:System.Xml.XPath.XPathItem.ValueAsLong">
<summary>When overridden in a derived class, gets the item's value as an <see cref="T:System.Int64" />.</summary>
+ <returns>The item's value as an <see cref="T:System.Int64" />.</returns>
<exception cref="T:System.FormatException">The item's value is not in the correct format for the <see cref="T:System.Int64" /> type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.Int64" /> is not valid.</exception>
<exception cref="T:System.OverflowException">The attempted cast resulted in an overflow.</exception>
- <returns>The item's value as an <see cref="T:System.Int64" />.</returns>
</member>
<member name="P:System.Xml.XPath.XPathItem.ValueType">
<summary>When overridden in a derived class, gets the .NET Framework 2.0 type of the item.</summary>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.AppendChild">
<summary>Returns an <see cref="T:System.Xml.XmlWriter" /> object used to create one or more new child nodes at the end of the list of child nodes of the current node.</summary>
+ <returns>An <see cref="T:System.Xml.XmlWriter" /> object used to create new child nodes at the end of the list of child nodes of the current node.</returns>
<exception cref="T:System.InvalidOperationException">The current node the <see cref="T:System.Xml.XPath.XPathNavigator" /> is positioned on is not the root node or an element node.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> does not support editing.</exception>
- <returns>An <see cref="T:System.Xml.XmlWriter" /> object used to create new child nodes at the end of the list of child nodes of the current node.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.AppendChild(System.String)">
<summary>Creates a new child node at the end of the list of child nodes of the current node using the XML data string specified.</summary>
<exception cref="T:System.InvalidOperationException">The current node the <see cref="T:System.Xml.XPath.XPathNavigator" /> is positioned on is not the root node or an element node.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> does not support editing.</exception>
</member>
+ <member name="P:System.Xml.XPath.XPathNavigator.BaseURI">
+ <summary>When overridden in a derived class, gets the base URI for the current node.</summary>
+ <returns>The location from which the node was loaded, or <see cref="F:System.String.Empty" /> if there is no value.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathNavigator.CanEdit">
+ <summary>Gets a value that indicates whether the <see cref="T:System.Xml.XPath.XPathNavigator" /> can edit the underlying XML data.</summary>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Xml.XPath.XPathNavigator" /> can edit the underlying XML data; otherwise, <see langword="false" />.</returns>
+ </member>
<member name="M:System.Xml.XPath.XPathNavigator.CheckValidity(System.Xml.Schema.XmlSchemaSet,System.Xml.Schema.ValidationEventHandler)">
<summary>Verifies that the XML data in the <see cref="T:System.Xml.XPath.XPathNavigator" /> conforms to the XML Schema definition language (XSD) schema provided.</summary>
<param name="schemas">The <see cref="T:System.Xml.Schema.XmlSchemaSet" /> containing the schemas used to validate the XML data contained in the <see cref="T:System.Xml.XPath.XPathNavigator" />.</param>
<param name="validationEventHandler">The <see cref="T:System.Xml.Schema.ValidationEventHandler" /> that receives information about schema validation warnings and errors.</param>
+ <returns>
+ <see langword="true" /> if no schema validation errors occurred; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.Xml.Schema.XmlSchemaValidationException">A schema validation error occurred, and no <see cref="T:System.Xml.Schema.ValidationEventHandler" /> was specified to handle validation errors.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> is positioned on a node that is not an element, attribute, or the root node or there is not type information to perform validation.</exception>
<exception cref="T:System.ArgumentException">The <see cref="M:System.Xml.XPath.XPathNavigator.CheckValidity(System.Xml.Schema.XmlSchemaSet,System.Xml.Schema.ValidationEventHandler)" /> method was called with an <see cref="T:System.Xml.Schema.XmlSchemaSet" /> parameter when the <see cref="T:System.Xml.XPath.XPathNavigator" /> was not positioned on the root node of the XML data.</exception>
- <returns>
- <see langword="true" /> if no schema validation errors occurred; otherwise, <see langword="false" />.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.Clone">
<summary>When overridden in a derived class, creates a new <see cref="T:System.Xml.XPath.XPathNavigator" /> positioned at the same node as this <see cref="T:System.Xml.XPath.XPathNavigator" />.</summary>
<member name="M:System.Xml.XPath.XPathNavigator.Compile(System.String)">
<summary>Compiles a string representing an XPath expression and returns an <see cref="T:System.Xml.XPath.XPathExpression" /> object.</summary>
<param name="xpath">A string representing an XPath expression.</param>
+ <returns>An <see cref="T:System.Xml.XPath.XPathExpression" /> object representing the XPath expression.</returns>
<exception cref="T:System.ArgumentException">The <paramref name="xpath" /> parameter contains an XPath expression that is not valid.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
- <returns>An <see cref="T:System.Xml.XPath.XPathExpression" /> object representing the XPath expression.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.CreateAttribute(System.String,System.String,System.String,System.String)">
<summary>Creates an attribute node on the current element node using the namespace prefix, local name and namespace URI specified with the value specified.</summary>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.CreateAttributes">
<summary>Returns an <see cref="T:System.Xml.XmlWriter" /> object used to create new attributes on the current element.</summary>
+ <returns>An <see cref="T:System.Xml.XmlWriter" /> object used to create new attributes on the current element.</returns>
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> is not positioned on an element node.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> does not support editing.</exception>
- <returns>An <see cref="T:System.Xml.XmlWriter" /> object used to create new attributes on the current element.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.CreateNavigator">
<summary>Returns a copy of the <see cref="T:System.Xml.XPath.XPathNavigator" />.</summary>
<member name="M:System.Xml.XPath.XPathNavigator.Evaluate(System.String)">
<summary>Evaluates the specified XPath expression and returns the typed result.</summary>
<param name="xpath">A string representing an XPath expression that can be evaluated.</param>
+ <returns>The result of the expression (Boolean, number, string, or node set). This maps to <see cref="T:System.Boolean" />, <see cref="T:System.Double" />, <see cref="T:System.String" />, or <see cref="T:System.Xml.XPath.XPathNodeIterator" /> objects respectively.</returns>
<exception cref="T:System.ArgumentException">The return type of the XPath expression is a node set.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
- <returns>The result of the expression (Boolean, number, string, or node set). This maps to <see cref="T:System.Boolean" />, <see cref="T:System.Double" />, <see cref="T:System.String" />, or <see cref="T:System.Xml.XPath.XPathNodeIterator" /> objects respectively.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.Evaluate(System.String,System.Xml.IXmlNamespaceResolver)">
<summary>Evaluates the specified XPath expression and returns the typed result, using the <see cref="T:System.Xml.IXmlNamespaceResolver" /> object specified to resolve namespace prefixes in the XPath expression.</summary>
<param name="xpath">A string representing an XPath expression that can be evaluated.</param>
<param name="resolver">The <see cref="T:System.Xml.IXmlNamespaceResolver" /> object used to resolve namespace prefixes in the XPath expression.</param>
+ <returns>The result of the expression (Boolean, number, string, or node set). This maps to <see cref="T:System.Boolean" />, <see cref="T:System.Double" />, <see cref="T:System.String" />, or <see cref="T:System.Xml.XPath.XPathNodeIterator" /> objects respectively.</returns>
<exception cref="T:System.ArgumentException">The return type of the XPath expression is a node set.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
- <returns>The result of the expression (Boolean, number, string, or node set). This maps to <see cref="T:System.Boolean" />, <see cref="T:System.Double" />, <see cref="T:System.String" />, or <see cref="T:System.Xml.XPath.XPathNodeIterator" /> objects respectively.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.Evaluate(System.Xml.XPath.XPathExpression)">
<summary>Evaluates the <see cref="T:System.Xml.XPath.XPathExpression" /> and returns the typed result.</summary>
<param name="expr">An <see cref="T:System.Xml.XPath.XPathExpression" /> that can be evaluated.</param>
+ <returns>The result of the expression (Boolean, number, string, or node set). This maps to <see cref="T:System.Boolean" />, <see cref="T:System.Double" />, <see cref="T:System.String" />, or <see cref="T:System.Xml.XPath.XPathNodeIterator" /> objects respectively.</returns>
<exception cref="T:System.ArgumentException">The return type of the XPath expression is a node set.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
- <returns>The result of the expression (Boolean, number, string, or node set). This maps to <see cref="T:System.Boolean" />, <see cref="T:System.Double" />, <see cref="T:System.String" />, or <see cref="T:System.Xml.XPath.XPathNodeIterator" /> objects respectively.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.Evaluate(System.Xml.XPath.XPathExpression,System.Xml.XPath.XPathNodeIterator)">
<summary>Uses the supplied context to evaluate the <see cref="T:System.Xml.XPath.XPathExpression" />, and returns the typed result.</summary>
<param name="expr">An <see cref="T:System.Xml.XPath.XPathExpression" /> that can be evaluated.</param>
<param name="context">An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> that points to the selected node set that the evaluation is to be performed on.</param>
+ <returns>The result of the expression (Boolean, number, string, or node set). This maps to <see cref="T:System.Boolean" />, <see cref="T:System.Double" />, <see cref="T:System.String" />, or <see cref="T:System.Xml.XPath.XPathNodeIterator" /> objects respectively.</returns>
<exception cref="T:System.ArgumentException">The return type of the XPath expression is a node set.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
- <returns>The result of the expression (Boolean, number, string, or node set). This maps to <see cref="T:System.Boolean" />, <see cref="T:System.Double" />, <see cref="T:System.String" />, or <see cref="T:System.Xml.XPath.XPathNodeIterator" /> objects respectively.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.GetAttribute(System.String,System.String)">
<summary>Gets the value of the attribute with the specified local name and namespace URI.</summary>
<param name="scope">An <see cref="T:System.Xml.XmlNamespaceScope" /> value specifying the namespaces to return.</param>
<returns>An <see cref="T:System.Collections.Generic.IDictionary`2" /> collection of namespace names keyed by prefix.</returns>
</member>
+ <member name="P:System.Xml.XPath.XPathNavigator.HasAttributes">
+ <summary>Gets a value that indicates whether the current node has any attributes.</summary>
+ <returns>
+ <see langword="true" /> if the current node has attributes; returns <see langword="false" /> if the current node has no attributes, or if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is not positioned on an element node.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathNavigator.HasChildren">
+ <summary>Gets a value that indicates whether the current node has any child nodes.</summary>
+ <returns>
+ <see langword="true" /> if the current node has any child nodes; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathNavigator.InnerXml">
+ <summary>Gets or sets the markup representing the child nodes of the current node.</summary>
+ <returns>A <see cref="T:System.String" /> that contains the markup of the child nodes of the current node.</returns>
+ <exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XPath.XPathNavigator.InnerXml" /> property cannot be set.</exception>
+ </member>
<member name="M:System.Xml.XPath.XPathNavigator.InsertAfter">
<summary>Returns an <see cref="T:System.Xml.XmlWriter" /> object used to create a new sibling node after the currently selected node.</summary>
+ <returns>An <see cref="T:System.Xml.XmlWriter" /> object used to create a new sibling node after the currently selected node.</returns>
<exception cref="T:System.InvalidOperationException">The position of the <see cref="T:System.Xml.XPath.XPathNavigator" /> does not allow a new sibling node to be inserted after the current node.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> does not support editing.</exception>
- <returns>An <see cref="T:System.Xml.XmlWriter" /> object used to create a new sibling node after the currently selected node.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.InsertAfter(System.String)">
<summary>Creates a new sibling node after the currently selected node using the XML string specified.</summary>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.InsertBefore">
<summary>Returns an <see cref="T:System.Xml.XmlWriter" /> object used to create a new sibling node before the currently selected node.</summary>
+ <returns>An <see cref="T:System.Xml.XmlWriter" /> object used to create a new sibling node before the currently selected node.</returns>
<exception cref="T:System.InvalidOperationException">The position of the <see cref="T:System.Xml.XPath.XPathNavigator" /> does not allow a new sibling node to be inserted before the current node.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> does not support editing.</exception>
- <returns>An <see cref="T:System.Xml.XmlWriter" /> object used to create a new sibling node before the currently selected node.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.InsertBefore(System.String)">
<summary>Creates a new sibling node before the currently selected node using the XML string specified.</summary>
<returns>
<see langword="true" /> if the specified <see cref="T:System.Xml.XPath.XPathNavigator" /> is a descendant of the current <see cref="T:System.Xml.XPath.XPathNavigator" />; otherwise, <see langword="false" />.</returns>
</member>
+ <member name="P:System.Xml.XPath.XPathNavigator.IsEmptyElement">
+ <summary>When overridden in a derived class, gets a value that indicates whether the current node is an empty element without an end element tag.</summary>
+ <returns>
+ <see langword="true" /> if the current node is an empty element; otherwise, <see langword="false" />.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathNavigator.IsNode">
+ <summary>Gets a value that indicates if the current node represents an XPath node.</summary>
+ <returns>Always returns <see langword="true" />.</returns>
+ </member>
<member name="M:System.Xml.XPath.XPathNavigator.IsSamePosition(System.Xml.XPath.XPathNavigator)">
<summary>When overridden in a derived class, determines whether the current <see cref="T:System.Xml.XPath.XPathNavigator" /> is at the same position as the specified <see cref="T:System.Xml.XPath.XPathNavigator" />.</summary>
<param name="other">The <see cref="T:System.Xml.XPath.XPathNavigator" /> to compare to this <see cref="T:System.Xml.XPath.XPathNavigator" />.</param>
<returns>
<see langword="true" /> if the two <see cref="T:System.Xml.XPath.XPathNavigator" /> objects have the same position; otherwise, <see langword="false" />.</returns>
</member>
+ <member name="P:System.Xml.XPath.XPathNavigator.LocalName">
+ <summary>When overridden in a derived class, gets the <see cref="P:System.Xml.XPath.XPathNavigator.Name" /> of the current node without any namespace prefix.</summary>
+ <returns>A <see cref="T:System.String" /> that contains the local name of the current node, or <see cref="F:System.String.Empty" /> if the current node does not have a name (for example, text or comment nodes).</returns>
+ </member>
<member name="M:System.Xml.XPath.XPathNavigator.LookupNamespace(System.String)">
<summary>Gets the namespace URI for the specified prefix.</summary>
<param name="prefix">The prefix whose namespace URI you want to resolve. To match the default namespace, pass <see cref="F:System.String.Empty" />.</param>
<member name="M:System.Xml.XPath.XPathNavigator.Matches(System.String)">
<summary>Determines whether the current node matches the specified XPath expression.</summary>
<param name="xpath">The XPath expression.</param>
- <exception cref="T:System.ArgumentException">The XPath expression cannot be evaluated.</exception>
- <exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
<returns>
<see langword="true" /> if the current node matches the specified XPath expression; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentException">The XPath expression cannot be evaluated.</exception>
+ <exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.Matches(System.Xml.XPath.XPathExpression)">
<summary>Determines whether the current node matches the specified <see cref="T:System.Xml.XPath.XPathExpression" />.</summary>
<param name="expr">An <see cref="T:System.Xml.XPath.XPathExpression" /> object containing the compiled XPath expression.</param>
- <exception cref="T:System.ArgumentException">The XPath expression cannot be evaluated.</exception>
- <exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
<returns>
<see langword="true" /> if the current node matches the <see cref="T:System.Xml.XPath.XPathExpression" />; otherwise, <see langword="false" />.</returns>
+ <exception cref="T:System.ArgumentException">The XPath expression cannot be evaluated.</exception>
+ <exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.MoveTo(System.Xml.XPath.XPathNavigator)">
<summary>When overridden in a derived class, moves the <see cref="T:System.Xml.XPath.XPathNavigator" /> to the same position as the specified <see cref="T:System.Xml.XPath.XPathNavigator" />.</summary>
<member name="M:System.Xml.XPath.XPathNavigator.MoveToFirst">
<summary>Moves the <see cref="T:System.Xml.XPath.XPathNavigator" /> to the first sibling node of the current node.</summary>
<returns>
- <see langword="true" /> if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is successful moving to the first sibling node of the current node; <see langword="false" /> if there is no first sibling, or if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is currently positioned on an attribute node. If the <see cref="T:System.Xml.XPath.XPathNavigator" /> is already positioned on the first sibling, <see cref="T:System.Xml.XPath.XPathNavigator" /> will return <see langword="true" /> and will not move its position.
-
- If <see cref="M:System.Xml.XPath.XPathNavigator.MoveToFirst" /> returns <see langword="false" /> because there is no first sibling, or if <see cref="T:System.Xml.XPath.XPathNavigator" /> is currently positioned on an attribute, the position of the <see cref="T:System.Xml.XPath.XPathNavigator" /> is unchanged.</returns>
+ <see langword="true" /> if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is successful moving to the first sibling node of the current node; <see langword="false" /> if there is no first sibling, or if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is currently positioned on an attribute node. If the <see cref="T:System.Xml.XPath.XPathNavigator" /> is already positioned on the first sibling, <see cref="T:System.Xml.XPath.XPathNavigator" /> will return <see langword="true" /> and will not move its position.
+If <see cref="M:System.Xml.XPath.XPathNavigator.MoveToFirst" /> returns <see langword="false" /> because there is no first sibling, or if <see cref="T:System.Xml.XPath.XPathNavigator" /> is currently positioned on an attribute, the position of the <see cref="T:System.Xml.XPath.XPathNavigator" /> is unchanged.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.MoveToFirstAttribute">
<summary>When overridden in a derived class, moves the <see cref="T:System.Xml.XPath.XPathNavigator" /> to the first attribute of the current node.</summary>
<returns>
<see langword="true" /> if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is successful moving to the next namespace node; otherwise, <see langword="false" />. If <see langword="false" />, the position of the <see cref="T:System.Xml.XPath.XPathNavigator" /> is unchanged.</returns>
</member>
- <member name="M:System.Xml.XPath.XPathNavigator.MoveToParent">
- <summary>When overridden in a derived class, moves the <see cref="T:System.Xml.XPath.XPathNavigator" /> to the parent node of the current node.</summary>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is successful moving to the parent node of the current node; otherwise, <see langword="false" />. If <see langword="false" />, the position of the <see cref="T:System.Xml.XPath.XPathNavigator" /> is unchanged.</returns>
+ <member name="M:System.Xml.XPath.XPathNavigator.MoveToParent">
+ <summary>When overridden in a derived class, moves the <see cref="T:System.Xml.XPath.XPathNavigator" /> to the parent node of the current node.</summary>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is successful moving to the parent node of the current node; otherwise, <see langword="false" />. If <see langword="false" />, the position of the <see cref="T:System.Xml.XPath.XPathNavigator" /> is unchanged.</returns>
+ </member>
+ <member name="M:System.Xml.XPath.XPathNavigator.MoveToPrevious">
+ <summary>When overridden in a derived class, moves the <see cref="T:System.Xml.XPath.XPathNavigator" /> to the previous sibling node of the current node.</summary>
+ <returns>
+ <see langword="true" /> if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is successful moving to the previous sibling node; otherwise, <see langword="false" /> if there is no previous sibling node or if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is currently positioned on an attribute node. If <see langword="false" />, the position of the <see cref="T:System.Xml.XPath.XPathNavigator" /> is unchanged.</returns>
+ </member>
+ <member name="M:System.Xml.XPath.XPathNavigator.MoveToRoot">
+ <summary>Moves the <see cref="T:System.Xml.XPath.XPathNavigator" /> to the root node that the current node belongs to.</summary>
+ </member>
+ <member name="P:System.Xml.XPath.XPathNavigator.Name">
+ <summary>When overridden in a derived class, gets the qualified name of the current node.</summary>
+ <returns>A <see cref="T:System.String" /> that contains the qualified <see cref="P:System.Xml.XPath.XPathNavigator.Name" /> of the current node, or <see cref="F:System.String.Empty" /> if the current node does not have a name (for example, text or comment nodes).</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathNavigator.NamespaceURI">
+ <summary>When overridden in a derived class, gets the namespace URI of the current node.</summary>
+ <returns>A <see cref="T:System.String" /> that contains the namespace URI of the current node, or <see cref="F:System.String.Empty" /> if the current node has no namespace URI.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathNavigator.NameTable">
+ <summary>When overridden in a derived class, gets the <see cref="T:System.Xml.XmlNameTable" /> of the <see cref="T:System.Xml.XPath.XPathNavigator" />.</summary>
+ <returns>An <see cref="T:System.Xml.XmlNameTable" /> object enabling you to get the atomized version of a <see cref="T:System.String" /> within the XML document.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathNavigator.NavigatorComparer">
+ <summary>Gets an <see cref="T:System.Collections.IEqualityComparer" /> used for equality comparison of <see cref="T:System.Xml.XPath.XPathNavigator" /> objects.</summary>
+ <returns>An <see cref="T:System.Collections.IEqualityComparer" /> used for equality comparison of <see cref="T:System.Xml.XPath.XPathNavigator" /> objects.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathNavigator.NodeType">
+ <summary>When overridden in a derived class, gets the <see cref="T:System.Xml.XPath.XPathNodeType" /> of the current node.</summary>
+ <returns>One of the <see cref="T:System.Xml.XPath.XPathNodeType" /> values representing the current node.</returns>
</member>
- <member name="M:System.Xml.XPath.XPathNavigator.MoveToPrevious">
- <summary>When overridden in a derived class, moves the <see cref="T:System.Xml.XPath.XPathNavigator" /> to the previous sibling node of the current node.</summary>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is successful moving to the previous sibling node; otherwise, <see langword="false" /> if there is no previous sibling node or if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is currently positioned on an attribute node. If <see langword="false" />, the position of the <see cref="T:System.Xml.XPath.XPathNavigator" /> is unchanged.</returns>
+ <member name="P:System.Xml.XPath.XPathNavigator.OuterXml">
+ <summary>Gets or sets the markup representing the opening and closing tags of the current node and its child nodes.</summary>
+ <returns>A <see cref="T:System.String" /> that contains the markup representing the opening and closing tags of the current node and its child nodes.</returns>
</member>
- <member name="M:System.Xml.XPath.XPathNavigator.MoveToRoot">
- <summary>Moves the <see cref="T:System.Xml.XPath.XPathNavigator" /> to the root node that the current node belongs to.</summary>
+ <member name="P:System.Xml.XPath.XPathNavigator.Prefix">
+ <summary>When overridden in a derived class, gets the namespace prefix associated with the current node.</summary>
+ <returns>A <see cref="T:System.String" /> that contains the namespace prefix associated with the current node.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.PrependChild">
<summary>Returns an <see cref="T:System.Xml.XmlWriter" /> object used to create a new child node at the beginning of the list of child nodes of the current node.</summary>
+ <returns>An <see cref="T:System.Xml.XmlWriter" /> object used to create a new child node at the beginning of the list of child nodes of the current node.</returns>
<exception cref="T:System.InvalidOperationException">The current node the <see cref="T:System.Xml.XPath.XPathNavigator" /> is positioned on does not allow a new child node to be prepended.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> does not support editing.</exception>
- <returns>An <see cref="T:System.Xml.XmlWriter" /> object used to create a new child node at the beginning of the list of child nodes of the current node.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.PrependChild(System.String)">
<summary>Creates a new child node at the beginning of the list of child nodes of the current node using the XML string specified.</summary>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.ReadSubtree">
<summary>Returns an <see cref="T:System.Xml.XmlReader" /> object that contains the current node and its child nodes.</summary>
- <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> is not positioned on an element node or the root node.</exception>
<returns>An <see cref="T:System.Xml.XmlReader" /> object that contains the current node and its child nodes.</returns>
+ <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> is not positioned on an element node or the root node.</exception>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.ReplaceRange(System.Xml.XPath.XPathNavigator)">
<summary>Replaces a range of sibling nodes from the current node to the node specified.</summary>
<param name="lastSiblingToReplace">An <see cref="T:System.Xml.XPath.XPathNavigator" /> positioned on the last sibling node in the range to replace.</param>
+ <returns>An <see cref="T:System.Xml.XmlWriter" /> object used to specify the replacement range.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> specified is <see langword="null" />.</exception>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> does not support editing.</exception>
<exception cref="T:System.InvalidOperationException">The last node to replace specified is not a valid sibling node of the current node.</exception>
- <returns>An <see cref="T:System.Xml.XmlWriter" /> object used to specify the replacement range.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.ReplaceSelf(System.String)">
<summary>Replaces the current node with the content of the string specified.</summary>
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Xml.XPath.XPathNavigator" /> does not support editing.</exception>
<exception cref="T:System.Xml.XmlException">The XML contents of the <see cref="T:System.Xml.XPath.XPathNavigator" /> object parameter is not well-formed.</exception>
</member>
+ <member name="P:System.Xml.XPath.XPathNavigator.SchemaInfo">
+ <summary>Gets the schema information that has been assigned to the current node as a result of schema validation.</summary>
+ <returns>An <see cref="T:System.Xml.Schema.IXmlSchemaInfo" /> object that contains the schema information for the current node.</returns>
+ </member>
<member name="M:System.Xml.XPath.XPathNavigator.Select(System.String)">
<summary>Selects a node set, using the specified XPath expression.</summary>
<param name="xpath">A <see cref="T:System.String" /> representing an XPath expression.</param>
+ <returns>An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> pointing to the selected node set.</returns>
<exception cref="T:System.ArgumentException">The XPath expression contains an error or its return type is not a node set.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
- <returns>An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> pointing to the selected node set.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.Select(System.String,System.Xml.IXmlNamespaceResolver)">
<summary>Selects a node set using the specified XPath expression with the <see cref="T:System.Xml.IXmlNamespaceResolver" /> object specified to resolve namespace prefixes.</summary>
<param name="xpath">A <see cref="T:System.String" /> representing an XPath expression.</param>
<param name="resolver">The <see cref="T:System.Xml.IXmlNamespaceResolver" /> object used to resolve namespace prefixes.</param>
+ <returns>An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> that points to the selected node set.</returns>
<exception cref="T:System.ArgumentException">The XPath expression contains an error or its return type is not a node set.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
- <returns>An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> that points to the selected node set.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.Select(System.Xml.XPath.XPathExpression)">
<summary>Selects a node set using the specified <see cref="T:System.Xml.XPath.XPathExpression" />.</summary>
<param name="expr">An <see cref="T:System.Xml.XPath.XPathExpression" /> object containing the compiled XPath query.</param>
+ <returns>An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> that points to the selected node set.</returns>
<exception cref="T:System.ArgumentException">The XPath expression contains an error or its return type is not a node set.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath expression is not valid.</exception>
- <returns>An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> that points to the selected node set.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.SelectAncestors(System.String,System.String,System.Boolean)">
<summary>Selects all the ancestor nodes of the current node that have the specified local name and namespace URI.</summary>
<param name="name">The local name of the ancestor nodes.</param>
<param name="namespaceURI">The namespace URI of the ancestor nodes.</param>
<param name="matchSelf">To include the context node in the selection, <see langword="true" />; otherwise, <see langword="false" />.</param>
+ <returns>An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> that contains the selected nodes. The returned nodes are in reverse document order.</returns>
<exception cref="T:System.ArgumentNullException">
<see langword="null" /> cannot be passed as a parameter.</exception>
- <returns>An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> that contains the selected nodes. The returned nodes are in reverse document order.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.SelectAncestors(System.Xml.XPath.XPathNodeType,System.Boolean)">
<summary>Selects all the ancestor nodes of the current node that have a matching <see cref="T:System.Xml.XPath.XPathNodeType" />.</summary>
<summary>Selects all the child nodes of the current node that have the local name and namespace URI specified.</summary>
<param name="name">The local name of the child nodes.</param>
<param name="namespaceURI">The namespace URI of the child nodes.</param>
+ <returns>An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> that contains the selected nodes.</returns>
<exception cref="T:System.ArgumentNullException">
<see langword="null" /> cannot be passed as a parameter.</exception>
- <returns>An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> that contains the selected nodes.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.SelectChildren(System.Xml.XPath.XPathNodeType)">
<summary>Selects all the child nodes of the current node that have the matching <see cref="T:System.Xml.XPath.XPathNodeType" />.</summary>
<param name="namespaceURI">The namespace URI of the descendant nodes.</param>
<param name="matchSelf">
<see langword="true" /> to include the context node in the selection; otherwise, <see langword="false" />.</param>
+ <returns>An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> that contains the selected nodes.</returns>
<exception cref="T:System.ArgumentNullException">
<see langword="null" /> cannot be passed as a parameter.</exception>
- <returns>An <see cref="T:System.Xml.XPath.XPathNodeIterator" /> that contains the selected nodes.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.SelectDescendants(System.Xml.XPath.XPathNodeType,System.Boolean)">
<summary>Selects all the descendant nodes of the current node that have a matching <see cref="T:System.Xml.XPath.XPathNodeType" />.</summary>
<member name="M:System.Xml.XPath.XPathNavigator.SelectSingleNode(System.String)">
<summary>Selects a single node in the <see cref="T:System.Xml.XPath.XPathNavigator" /> using the specified XPath query.</summary>
<param name="xpath">A <see cref="T:System.String" /> representing an XPath expression.</param>
+ <returns>An <see cref="T:System.Xml.XPath.XPathNavigator" /> object that contains the first matching node for the XPath query specified; otherwise, <see langword="null" /> if there are no query results.</returns>
<exception cref="T:System.ArgumentException">An error was encountered in the XPath query or the return type of the XPath expression is not a node.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath query is not valid.</exception>
- <returns>An <see cref="T:System.Xml.XPath.XPathNavigator" /> object that contains the first matching node for the XPath query specified; otherwise, <see langword="null" /> if there are no query results.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.SelectSingleNode(System.String,System.Xml.IXmlNamespaceResolver)">
<summary>Selects a single node in the <see cref="T:System.Xml.XPath.XPathNavigator" /> object using the specified XPath query with the <see cref="T:System.Xml.IXmlNamespaceResolver" /> object specified to resolve namespace prefixes.</summary>
<param name="xpath">A <see cref="T:System.String" /> representing an XPath expression.</param>
<param name="resolver">The <see cref="T:System.Xml.IXmlNamespaceResolver" /> object used to resolve namespace prefixes in the XPath query.</param>
+ <returns>An <see cref="T:System.Xml.XPath.XPathNavigator" /> object that contains the first matching node for the XPath query specified; otherwise <see langword="null" /> if there are no query results.</returns>
<exception cref="T:System.ArgumentException">An error was encountered in the XPath query or the return type of the XPath expression is not a node.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath query is not valid.</exception>
- <returns>An <see cref="T:System.Xml.XPath.XPathNavigator" /> object that contains the first matching node for the XPath query specified; otherwise <see langword="null" /> if there are no query results.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.SelectSingleNode(System.Xml.XPath.XPathExpression)">
<summary>Selects a single node in the <see cref="T:System.Xml.XPath.XPathNavigator" /> using the specified <see cref="T:System.Xml.XPath.XPathExpression" /> object.</summary>
<param name="expression">An <see cref="T:System.Xml.XPath.XPathExpression" /> object containing the compiled XPath query.</param>
+ <returns>An <see cref="T:System.Xml.XPath.XPathNavigator" /> object that contains the first matching node for the XPath query specified; otherwise <see langword="null" /> if there are no query results.</returns>
<exception cref="T:System.ArgumentException">An error was encountered in the XPath query or the return type of the XPath expression is not a node.</exception>
<exception cref="T:System.Xml.XPath.XPathException">The XPath query is not valid.</exception>
- <returns>An <see cref="T:System.Xml.XPath.XPathNavigator" /> object that contains the first matching node for the XPath query specified; otherwise <see langword="null" /> if there are no query results.</returns>
</member>
<member name="M:System.Xml.XPath.XPathNavigator.SetTypedValue(System.Object)">
<summary>Sets the typed value of the current node.</summary>
<summary>Gets the text value of the current node.</summary>
<returns>A <see langword="string" /> that contains the text value of the current node.</returns>
</member>
+ <member name="P:System.Xml.XPath.XPathNavigator.TypedValue">
+ <summary>Gets the current node as a boxed object of the most appropriate .NET Framework type.</summary>
+ <returns>The current node as a boxed object of the most appropriate .NET Framework type.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathNavigator.UnderlyingObject">
+ <summary>Used by <see cref="T:System.Xml.XPath.XPathNavigator" /> implementations which provide a "virtualized" XML view over a store, to provide access to underlying objects.</summary>
+ <returns>The default is <see langword="null" />.</returns>
+ </member>
<member name="M:System.Xml.XPath.XPathNavigator.ValueAs(System.Type,System.Xml.IXmlNamespaceResolver)">
<summary>Gets the current node's value as the <see cref="T:System.Type" /> specified, using the <see cref="T:System.Xml.IXmlNamespaceResolver" /> object specified to resolve namespace prefixes.</summary>
<param name="returnType">The <see cref="T:System.Type" /> to return the current node's value as.</param>
<param name="nsResolver">The <see cref="T:System.Xml.IXmlNamespaceResolver" /> object used to resolve namespace prefixes.</param>
+ <returns>The value of the current node as the <see cref="T:System.Type" /> requested.</returns>
<exception cref="T:System.FormatException">The current node's value is not in the correct format for the target type.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast is not valid.</exception>
- <returns>The value of the current node as the <see cref="T:System.Type" /> requested.</returns>
- </member>
- <member name="M:System.Xml.XPath.XPathNavigator.WriteSubtree(System.Xml.XmlWriter)">
- <summary>Streams the current node and its child nodes to the <see cref="T:System.Xml.XmlWriter" /> object specified.</summary>
- <param name="writer">The <see cref="T:System.Xml.XmlWriter" /> object to stream to.</param>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.BaseURI">
- <summary>When overridden in a derived class, gets the base URI for the current node.</summary>
- <returns>The location from which the node was loaded, or <see cref="F:System.String.Empty" /> if there is no value.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.CanEdit">
- <summary>Gets a value that indicates whether the <see cref="T:System.Xml.XPath.XPathNavigator" /> can edit the underlying XML data.</summary>
- <returns>
- <see langword="true" /> if the <see cref="T:System.Xml.XPath.XPathNavigator" /> can edit the underlying XML data; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.HasAttributes">
- <summary>Gets a value that indicates whether the current node has any attributes.</summary>
- <returns>
- <see langword="true" /> if the current node has attributes; returns <see langword="false" /> if the current node has no attributes, or if the <see cref="T:System.Xml.XPath.XPathNavigator" /> is not positioned on an element node.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.HasChildren">
- <summary>Gets a value that indicates whether the current node has any child nodes.</summary>
- <returns>
- <see langword="true" /> if the current node has any child nodes; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.InnerXml">
- <summary>Gets or sets the markup representing the child nodes of the current node.</summary>
- <exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XPath.XPathNavigator.InnerXml" /> property cannot be set.</exception>
- <returns>A <see cref="T:System.String" /> that contains the markup of the child nodes of the current node.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.IsEmptyElement">
- <summary>When overridden in a derived class, gets a value that indicates whether the current node is an empty element without an end element tag.</summary>
- <returns>
- <see langword="true" /> if the current node is an empty element; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.IsNode">
- <summary>Gets a value that indicates if the current node represents an XPath node.</summary>
- <returns>Always returns <see langword="true" />.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.LocalName">
- <summary>When overridden in a derived class, gets the <see cref="P:System.Xml.XPath.XPathNavigator.Name" /> of the current node without any namespace prefix.</summary>
- <returns>A <see cref="T:System.String" /> that contains the local name of the current node, or <see cref="F:System.String.Empty" /> if the current node does not have a name (for example, text or comment nodes).</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.Name">
- <summary>When overridden in a derived class, gets the qualified name of the current node.</summary>
- <returns>A <see cref="T:System.String" /> that contains the qualified <see cref="P:System.Xml.XPath.XPathNavigator.Name" /> of the current node, or <see cref="F:System.String.Empty" /> if the current node does not have a name (for example, text or comment nodes).</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.NamespaceURI">
- <summary>When overridden in a derived class, gets the namespace URI of the current node.</summary>
- <returns>A <see cref="T:System.String" /> that contains the namespace URI of the current node, or <see cref="F:System.String.Empty" /> if the current node has no namespace URI.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.NameTable">
- <summary>When overridden in a derived class, gets the <see cref="T:System.Xml.XmlNameTable" /> of the <see cref="T:System.Xml.XPath.XPathNavigator" />.</summary>
- <returns>An <see cref="T:System.Xml.XmlNameTable" /> object enabling you to get the atomized version of a <see cref="T:System.String" /> within the XML document.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.NavigatorComparer">
- <summary>Gets an <see cref="T:System.Collections.IEqualityComparer" /> used for equality comparison of <see cref="T:System.Xml.XPath.XPathNavigator" /> objects.</summary>
- <returns>An <see cref="T:System.Collections.IEqualityComparer" /> used for equality comparison of <see cref="T:System.Xml.XPath.XPathNavigator" /> objects.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.NodeType">
- <summary>When overridden in a derived class, gets the <see cref="T:System.Xml.XPath.XPathNodeType" /> of the current node.</summary>
- <returns>One of the <see cref="T:System.Xml.XPath.XPathNodeType" /> values representing the current node.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.OuterXml">
- <summary>Gets or sets the markup representing the opening and closing tags of the current node and its child nodes.</summary>
- <returns>A <see cref="T:System.String" /> that contains the markup representing the opening and closing tags of the current node and its child nodes.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.Prefix">
- <summary>When overridden in a derived class, gets the namespace prefix associated with the current node.</summary>
- <returns>A <see cref="T:System.String" /> that contains the namespace prefix associated with the current node.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.SchemaInfo">
- <summary>Gets the schema information that has been assigned to the current node as a result of schema validation.</summary>
- <returns>An <see cref="T:System.Xml.Schema.IXmlSchemaInfo" /> object that contains the schema information for the current node.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.TypedValue">
- <summary>Gets the current node as a boxed object of the most appropriate .NET type.</summary>
- <returns>The current node as a boxed object of the most appropriate .NET type.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNavigator.UnderlyingObject">
- <summary>Used by <see cref="T:System.Xml.XPath.XPathNavigator" /> implementations which provide a "virtualized" XML view over a store, to provide access to underlying objects.</summary>
- <returns>The default is <see langword="null" />.</returns>
</member>
<member name="P:System.Xml.XPath.XPathNavigator.ValueAsBoolean">
<summary>Gets the current node's value as a <see cref="T:System.Boolean" />.</summary>
+ <returns>The current node's value as a <see cref="T:System.Boolean" />.</returns>
<exception cref="T:System.FormatException">The current node's string value cannot be converted to a <see cref="T:System.Boolean" />.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.Boolean" /> is not valid.</exception>
- <returns>The current node's value as a <see cref="T:System.Boolean" />.</returns>
</member>
<member name="P:System.Xml.XPath.XPathNavigator.ValueAsDateTime">
<summary>Gets the current node's value as a <see cref="T:System.DateTime" />.</summary>
+ <returns>The current node's value as a <see cref="T:System.DateTime" />.</returns>
<exception cref="T:System.FormatException">The current node's string value cannot be converted to a <see cref="T:System.DateTime" />.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.DateTime" /> is not valid.</exception>
- <returns>The current node's value as a <see cref="T:System.DateTime" />.</returns>
</member>
<member name="P:System.Xml.XPath.XPathNavigator.ValueAsDouble">
<summary>Gets the current node's value as a <see cref="T:System.Double" />.</summary>
+ <returns>The current node's value as a <see cref="T:System.Double" />.</returns>
<exception cref="T:System.FormatException">The current node's string value cannot be converted to a <see cref="T:System.Double" />.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.Double" /> is not valid.</exception>
- <returns>The current node's value as a <see cref="T:System.Double" />.</returns>
</member>
<member name="P:System.Xml.XPath.XPathNavigator.ValueAsInt">
<summary>Gets the current node's value as an <see cref="T:System.Int32" />.</summary>
+ <returns>The current node's value as an <see cref="T:System.Int32" />.</returns>
<exception cref="T:System.FormatException">The current node's string value cannot be converted to a <see cref="T:System.Int32" />.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.Int32" /> is not valid.</exception>
- <returns>The current node's value as an <see cref="T:System.Int32" />.</returns>
</member>
<member name="P:System.Xml.XPath.XPathNavigator.ValueAsLong">
<summary>Gets the current node's value as an <see cref="T:System.Int64" />.</summary>
+ <returns>The current node's value as an <see cref="T:System.Int64" />.</returns>
<exception cref="T:System.FormatException">The current node's string value cannot be converted to a <see cref="T:System.Int64" />.</exception>
<exception cref="T:System.InvalidCastException">The attempted cast to <see cref="T:System.Int64" /> is not valid.</exception>
- <returns>The current node's value as an <see cref="T:System.Int64" />.</returns>
</member>
<member name="P:System.Xml.XPath.XPathNavigator.ValueType">
- <summary>Gets the .NET <see cref="T:System.Type" /> of the current node.</summary>
- <returns>The .NET <see cref="T:System.Type" /> of the current node. The default value is <see cref="T:System.String" />.</returns>
+ <summary>Gets the .NET Framework <see cref="T:System.Type" /> of the current node.</summary>
+ <returns>The .NET Framework <see cref="T:System.Type" /> of the current node. The default value is <see cref="T:System.String" />.</returns>
+ </member>
+ <member name="M:System.Xml.XPath.XPathNavigator.WriteSubtree(System.Xml.XmlWriter)">
+ <summary>Streams the current node and its child nodes to the <see cref="T:System.Xml.XmlWriter" /> object specified.</summary>
+ <param name="writer">The <see cref="T:System.Xml.XmlWriter" /> object to stream to.</param>
</member>
<member name="P:System.Xml.XPath.XPathNavigator.XmlLang">
<summary>Gets the <c>xml:lang</c> scope for the current node.</summary>
<summary>When overridden in a derived class, returns a clone of this <see cref="T:System.Xml.XPath.XPathNodeIterator" /> object.</summary>
<returns>A new <see cref="T:System.Xml.XPath.XPathNodeIterator" /> object clone of this <see cref="T:System.Xml.XPath.XPathNodeIterator" /> object.</returns>
</member>
+ <member name="P:System.Xml.XPath.XPathNodeIterator.Count">
+ <summary>Gets the index of the last node in the selected set of nodes.</summary>
+ <returns>The index of the last node in the selected set of nodes, or 0 if there are no selected nodes.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathNodeIterator.Current">
+ <summary>When overridden in a derived class, gets the <see cref="T:System.Xml.XPath.XPathNavigator" /> object for this <see cref="T:System.Xml.XPath.XPathNodeIterator" />, positioned on the current context node.</summary>
+ <returns>An <see cref="T:System.Xml.XPath.XPathNavigator" /> object positioned on the context node from which the node set was selected. The <see cref="M:System.Xml.XPath.XPathNodeIterator.MoveNext" /> method must be called to move the <see cref="T:System.Xml.XPath.XPathNodeIterator" /> to the first node in the selected set.</returns>
+ </member>
+ <member name="P:System.Xml.XPath.XPathNodeIterator.CurrentPosition">
+ <summary>When overridden in a derived class, gets the index of the current position in the selected set of nodes.</summary>
+ <returns>The index of the current position.</returns>
+ </member>
<member name="M:System.Xml.XPath.XPathNodeIterator.GetEnumerator">
<summary>Returns an <see cref="T:System.Collections.IEnumerator" /> object to iterate through the selected node set.</summary>
<returns>An <see cref="T:System.Collections.IEnumerator" /> object to iterate through the selected node set.</returns>
<summary>Creates a new object that is a copy of the current instance.</summary>
<returns>A new object that is a copy of this instance.</returns>
</member>
- <member name="P:System.Xml.XPath.XPathNodeIterator.Count">
- <summary>Gets the index of the last node in the selected set of nodes.</summary>
- <returns>The index of the last node in the selected set of nodes, or 0 if there are no selected nodes.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNodeIterator.Current">
- <summary>When overridden in a derived class, gets the <see cref="T:System.Xml.XPath.XPathNavigator" /> object for this <see cref="T:System.Xml.XPath.XPathNodeIterator" />, positioned on the current context node.</summary>
- <returns>An <see cref="T:System.Xml.XPath.XPathNavigator" /> object positioned on the context node from which the node set was selected. The <see cref="M:System.Xml.XPath.XPathNodeIterator.MoveNext" /> method must be called to move the <see cref="T:System.Xml.XPath.XPathNodeIterator" /> to the first node in the selected set.</returns>
- </member>
- <member name="P:System.Xml.XPath.XPathNodeIterator.CurrentPosition">
- <summary>When overridden in a derived class, gets the index of the current position in the selected set of nodes.</summary>
- <returns>The index of the current position.</returns>
- </member>
<member name="T:System.Xml.XPath.XPathNodeType">
<summary>Defines the XPath node types that can be returned from the <see cref="T:System.Xml.XPath.XPathNavigator" /> class.</summary>
</member>
<summary>An attribute, such as <c>id='123'</c>.</summary>
</member>
<member name="F:System.Xml.XPath.XPathNodeType.Comment">
- <summary>A comment, such as <c><!-- my comment --></c>.</summary>
+ <summary>A comment, such as <c><!-- my comment --></c></summary>
</member>
<member name="F:System.Xml.XPath.XPathNodeType.Element">
<summary>An element, such as <c><element></c>.</summary>
<member name="T:System.Xml.Xsl.IXsltContextFunction">
<summary>Provides an interface to a given function defined in the Extensible Stylesheet Language for Transformations (XSLT) style sheet during runtime execution.</summary>
</member>
+ <member name="P:System.Xml.Xsl.IXsltContextFunction.ArgTypes">
+ <summary>Gets the supplied XML Path Language (XPath) types for the function's argument list. This information can be used to discover the signature of the function which allows you to differentiate between overloaded functions.</summary>
+ <returns>An array of <see cref="T:System.Xml.XPath.XPathResultType" /> representing the types for the function's argument list.</returns>
+ </member>
<member name="M:System.Xml.Xsl.IXsltContextFunction.Invoke(System.Xml.Xsl.XsltContext,System.Object[],System.Xml.XPath.XPathNavigator)">
<summary>Provides the method to invoke the function with the given arguments in the given context.</summary>
<param name="xsltContext">The XSLT context for the function call.</param>
<param name="docContext">The context node for the function call.</param>
<returns>An <see cref="T:System.Object" /> representing the return value of the function.</returns>
</member>
- <member name="P:System.Xml.Xsl.IXsltContextFunction.ArgTypes">
- <summary>Gets the supplied XML Path Language (XPath) types for the function's argument list. This information can be used to discover the signature of the function which allows you to differentiate between overloaded functions.</summary>
- <returns>An array of <see cref="T:System.Xml.XPath.XPathResultType" /> representing the types for the function's argument list.</returns>
- </member>
<member name="P:System.Xml.Xsl.IXsltContextFunction.Maxargs">
<summary>Gets the maximum number of arguments for the function. This enables the user to differentiate between overloaded functions.</summary>
<returns>The maximum number of arguments for the function.</returns>
</member>
<member name="P:System.Xml.Xsl.IXsltContextFunction.ReturnType">
<summary>Gets the <see cref="T:System.Xml.XPath.XPathResultType" /> representing the XPath type returned by the function.</summary>
- <returns>An <see cref="T:System.Xml.XPath.XPathResultType" /> representing the XPath type returned by the function.</returns>
+ <returns>An <see cref="T:System.Xml.XPath.XPathResultType" /> representing the XPath type returned by the function</returns>
</member>
<member name="T:System.Xml.Xsl.IXsltContextVariable">
<summary>Provides an interface to a given variable that is defined in the style sheet during runtime execution.</summary>
<exception cref="T:System.Xml.Xsl.XsltException">The style sheet contains an error.</exception>
<exception cref="T:System.IO.FileNotFoundException">The style sheet cannot be found.</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">The <paramref name="stylesheetUri" /> value includes a filename or directory that cannot be found.</exception>
- <exception cref="T:System.Net.WebException">The <paramref name="stylesheetUri" /> value cannot be resolved.
-
- -or-
-
- An error occurred while processing the request.</exception>
+ <exception cref="T:System.Net.WebException">The <paramref name="stylesheetUri" /> value cannot be resolved.
+-or-
+An error occurred while processing the request.</exception>
<exception cref="T:System.UriFormatException">
<paramref name="stylesheetUri" /> is not a valid URI.</exception>
<exception cref="T:System.Xml.XmlException">There was a parsing error loading the style sheet.</exception>
<exception cref="T:System.Xml.Xsl.XsltException">The style sheet contains an error.</exception>
<exception cref="T:System.IO.FileNotFoundException">The style sheet cannot be found.</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">The <paramref name="stylesheetUri" /> value includes a filename or directory that cannot be found.</exception>
- <exception cref="T:System.Net.WebException">The <paramref name="stylesheetUri" /> value cannot be resolved.
-
- -or-
-
- An error occurred while processing the request.</exception>
+ <exception cref="T:System.Net.WebException">The <paramref name="stylesheetUri" /> value cannot be resolved.
+-or-
+An error occurred while processing the request.</exception>
<exception cref="T:System.UriFormatException">
<paramref name="stylesheetUri" /> is not a valid URI.</exception>
<exception cref="T:System.Xml.XmlException">There was a parsing error loading the style sheet.</exception>
</member>
<member name="M:System.Xml.Xsl.XslCompiledTransform.Load(System.Type)">
<summary>Loads the compiled style sheet that was created using the XSLT Compiler (xsltc.exe).</summary>
- <param name="compiledStylesheet">The name of the class that contains the compiled style sheet.
-
- This is usually the name of the style sheet. Unless otherwise specified, the xsltc.exe tool uses the name of the style sheet for the class and assembly names.</param>
+ <param name="compiledStylesheet">The name of the class that contains the compiled style sheet.
+This is usually the name of the style sheet. Unless otherwise specified, the xsltc.exe tool uses the name of the style sheet for the class and assembly names.</param>
</member>
<member name="M:System.Xml.Xsl.XslCompiledTransform.Load(System.Xml.XmlReader)">
<summary>Compiles the style sheet contained in the <see cref="T:System.Xml.XmlReader" />.</summary>
<exception cref="T:System.ArgumentNullException">The <paramref name="stylesheet" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Xml.Xsl.XsltException">The style sheet contains an error.</exception>
</member>
+ <member name="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings">
+ <summary>Gets an <see cref="T:System.Xml.XmlWriterSettings" /> object that contains the output information derived from the <c>xsl:output</c> element of the style sheet.</summary>
+ <returns>A read-only <see cref="T:System.Xml.XmlWriterSettings" /> object that contains the output information derived from the <c>xsl:output</c> element of the style sheet. This value can be <see langword="null" />.</returns>
+ </member>
<member name="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.String,System.String)">
<summary>Executes the transform using the input document specified by the URI and outputs the results to a file.</summary>
<param name="inputUri">The URI of the input document.</param>
<exception cref="T:System.Xml.Xsl.XsltException">There was an error executing the XSLT transform.</exception>
<exception cref="T:System.IO.FileNotFoundException">The input document cannot be found.</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">The <paramref name="inputUri" /> or <paramref name="resultsFile" /> value includes a filename or directory cannot be found.</exception>
- <exception cref="T:System.Net.WebException">The <paramref name="inputUri" /> or <paramref name="resultsFile" /> value cannot be resolved.
-
- -or-
-
- An error occurred while processing the request.</exception>
+ <exception cref="T:System.Net.WebException">The <paramref name="inputUri" /> or <paramref name="resultsFile" /> value cannot be resolved.
+-or-
+An error occurred while processing the request</exception>
<exception cref="T:System.UriFormatException">
<paramref name="inputUri" /> or <paramref name="resultsFile" /> is not a valid URI.</exception>
<exception cref="T:System.Xml.XmlException">There was a parsing error loading the input document.</exception>
<member name="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.String,System.Xml.XmlWriter)">
<summary>Executes the transform using the input document specified by the URI and outputs the results to an <see cref="T:System.Xml.XmlWriter" />.</summary>
<param name="inputUri">The URI of the input document.</param>
- <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
-
- If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
+ <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
+If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="inputUri" /> or <paramref name="results" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Xml.Xsl.XsltException">There was an error executing the XSLT transform.</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">The <paramref name="inputUri" /> value includes a filename or directory cannot be found.</exception>
- <exception cref="T:System.Net.WebException">The <paramref name="inputUri" /> value cannot be resolved.
-
- -or-
-
- An error occurred while processing the request.</exception>
+ <exception cref="T:System.Net.WebException">The <paramref name="inputUri" /> value cannot be resolved.
+-or-
+An error occurred while processing the request.</exception>
<exception cref="T:System.UriFormatException">
<paramref name="inputUri" /> is not a valid URI.</exception>
<exception cref="T:System.Xml.XmlException">There was a parsing error loading the input document.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="inputUri" /> or <paramref name="results" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Xml.Xsl.XsltException">There was an error executing the XSLT transform.</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">The <paramref name="inputUri" /> value includes a filename or directory cannot be found.</exception>
- <exception cref="T:System.Net.WebException">The <paramref name="inputUri" /> value cannot be resolved.
-
- -or-
-
- An error occurred while processing the request.</exception>
+ <exception cref="T:System.Net.WebException">The <paramref name="inputUri" /> value cannot be resolved.
+-or-
+An error occurred while processing the request</exception>
<exception cref="T:System.UriFormatException">
<paramref name="inputUri" /> is not a valid URI.</exception>
<exception cref="T:System.Xml.XmlException">There was a parsing error loading the input document.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="inputUri" /> or <paramref name="results" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Xml.Xsl.XsltException">There was an error executing the XSLT transform.</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">The <paramref name="inputUri" /> value includes a filename or directory cannot be found.</exception>
- <exception cref="T:System.Net.WebException">The <paramref name="inputUri" /> value cannot be resolved.
-
- -or-
-
- An error occurred while processing the request.</exception>
+ <exception cref="T:System.Net.WebException">The <paramref name="inputUri" /> value cannot be resolved.
+-or-
+An error occurred while processing the request</exception>
<exception cref="T:System.UriFormatException">
<paramref name="inputUri" /> is not a valid URI.</exception>
<exception cref="T:System.Xml.XmlException">There was a parsing error loading the input document.</exception>
<summary>Executes the transform using the input document specified by the URI and outputs the results to an <see cref="T:System.Xml.XmlWriter" />. The <see cref="T:System.Xml.Xsl.XsltArgumentList" /> provides additional run-time arguments.</summary>
<param name="inputUri">The URI of the input document.</param>
<param name="arguments">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transform. This value can be <see langword="null" />.</param>
- <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
-
- If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
+ <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
+If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="inputUri" /> or <paramref name="results" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Xml.Xsl.XsltException">There was an error executing the XSLT transform.</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">The <paramref name="inputtUri" /> value includes a filename or directory cannot be found.</exception>
- <exception cref="T:System.Net.WebException">The <paramref name="inputUri" /> value cannot be resolved.
-
- -or-
-
- An error occurred while processing the request.</exception>
+ <exception cref="T:System.Net.WebException">The <paramref name="inputUri" /> value cannot be resolved.
+-or-
+An error occurred while processing the request.</exception>
<exception cref="T:System.UriFormatException">
<paramref name="inputUri" /> is not a valid URI.</exception>
<exception cref="T:System.Xml.XmlException">There was a parsing error loading the input document.</exception>
<member name="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.Xml.XmlReader,System.Xml.XmlWriter)">
<summary>Executes the transform using the input document specified by the <see cref="T:System.Xml.XmlReader" /> object and outputs the results to an <see cref="T:System.Xml.XmlWriter" />.</summary>
<param name="input">The <see cref="T:System.Xml.XmlReader" /> containing the input document.</param>
- <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
-
- If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
+ <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
+If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="input" /> or <paramref name="results" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Xml.Xsl.XsltException">There was an error executing the XSLT transform.</exception>
</member>
<summary>Executes the transform using the input document specified by the <see cref="T:System.Xml.XmlReader" /> object and outputs the results to an <see cref="T:System.Xml.XmlWriter" />. The <see cref="T:System.Xml.Xsl.XsltArgumentList" /> provides additional run-time arguments.</summary>
<param name="input">An <see cref="T:System.Xml.XmlReader" /> containing the input document.</param>
<param name="arguments">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transform. This value can be <see langword="null" />.</param>
- <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
-
- If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
+ <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
+If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="input" /> or <paramref name="results" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Xml.Xsl.XsltException">There was an error executing the XSLT transform.</exception>
</member>
<summary>Executes the transform using the input document specified by the <see cref="T:System.Xml.XmlReader" /> object and outputs the results to an <see cref="T:System.Xml.XmlWriter" />. The <see cref="T:System.Xml.Xsl.XsltArgumentList" /> provides additional run-time arguments and the XmlResolver resolves the XSLT <c>document()</c> function.</summary>
<param name="input">An <see cref="T:System.Xml.XmlReader" /> containing the input document.</param>
<param name="arguments">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transform. This value can be <see langword="null" />.</param>
- <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
-
- If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
+ <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
+If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
<param name="documentResolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="input" /> or <paramref name="results" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Xml.Xsl.XsltException">There was an error executing the XSLT transform.</exception>
<member name="M:System.Xml.Xsl.XslCompiledTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.XmlWriter)">
<summary>Executes the transform using the input document specified by the <see cref="T:System.Xml.XPath.IXPathNavigable" /> object and outputs the results to an <see cref="T:System.Xml.XmlWriter" />.</summary>
<param name="input">An object implementing the <see cref="T:System.Xml.XPath.IXPathNavigable" /> interface. In the Microsoft .NET Framework, this can be either an <see cref="T:System.Xml.XmlNode" /> (typically an <see cref="T:System.Xml.XmlDocument" />), or an <see cref="T:System.Xml.XPath.XPathDocument" /> containing the data to be transformed.</param>
- <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
-
- If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
+ <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
+If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="input" /> or <paramref name="results" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Xml.Xsl.XsltException">There was an error executing the XSLT transform.</exception>
</member>
<summary>Executes the transform using the input document specified by the <see cref="T:System.Xml.XPath.IXPathNavigable" /> object and outputs the results to an <see cref="T:System.Xml.XmlWriter" />. The <see cref="T:System.Xml.Xsl.XsltArgumentList" /> provides additional run-time arguments.</summary>
<param name="input">An object implementing the <see cref="T:System.Xml.XPath.IXPathNavigable" /> interface. In the Microsoft .NET Framework, this can be either an <see cref="T:System.Xml.XmlNode" /> (typically an <see cref="T:System.Xml.XmlDocument" />), or an <see cref="T:System.Xml.XPath.XPathDocument" /> containing the data to be transformed.</param>
<param name="arguments">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transform. This value can be <see langword="null" />.</param>
- <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
-
- If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
+ <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
+If the style sheet contains an <c>xsl:output</c> element, you should create the <see cref="T:System.Xml.XmlWriter" /> using the <see cref="T:System.Xml.XmlWriterSettings" /> object returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="input" /> or <paramref name="results" /> value is <see langword="null" />.</exception>
<exception cref="T:System.Xml.Xsl.XsltException">There was an error executing the XSLT transform.</exception>
</member>
<summary>Executes the transform by using the input document that is specified by the <see cref="T:System.Xml.XPath.IXPathNavigable" /> object and outputs the results to an <see cref="T:System.Xml.XmlWriter" />. The <see cref="T:System.Xml.Xsl.XsltArgumentList" /> provides additional run-time arguments and the <see cref="T:System.Xml.XmlResolver" /> resolves the XSLT <see langword="document()" /> function.</summary>
<param name="input">The document to transform that is specified by the <see cref="T:System.Xml.XPath.IXPathNavigable" /> object.</param>
<param name="arguments">Argument list as <see cref="T:System.Xml.Xsl.XsltArgumentList" />.</param>
- <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
-
- If the style sheet contains an <see langword="xsl:output" /> element, you should create the <see cref="T:System.Xml.XmlWriter" /> by using the <see cref="T:System.Xml.XmlWriterSettings" /> object that is returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
+ <param name="results">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.
+If the style sheet contains an <see langword="xsl:output" /> element, you should create the <see cref="T:System.Xml.XmlWriter" /> by using the <see cref="T:System.Xml.XmlWriterSettings" /> object that is returned from the <see cref="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings" /> property. This ensures that the <see cref="T:System.Xml.XmlWriter" /> has the correct output settings.</param>
<param name="documentResolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <see langword="document()" /> function. If this is <see langword="null" />, the <see langword="document()" /> function is not resolved.</param>
</member>
- <member name="P:System.Xml.Xsl.XslCompiledTransform.OutputSettings">
- <summary>Gets an <see cref="T:System.Xml.XmlWriterSettings" /> object that contains the output information derived from the <c>xsl:output</c> element of the style sheet.</summary>
- <returns>A read-only <see cref="T:System.Xml.XmlWriterSettings" /> object that contains the output information derived from the <c>xsl:output</c> element of the style sheet. This value can be <see langword="null" />.</returns>
- </member>
<member name="T:System.Xml.Xsl.XsltArgumentList">
<summary>Contains a variable number of arguments which are either XSLT parameters or extension objects.</summary>
</member>
- <member name="E:System.Xml.Xsl.XsltArgumentList.XsltMessageEncountered">
- <summary>Occurs when a message is specified in the style sheet by the <c>xsl:message</c> element.</summary>
- </member>
<member name="M:System.Xml.Xsl.XsltArgumentList.#ctor">
<summary>Implements a new instance of the <see cref="T:System.Xml.Xsl.XsltArgumentList" />.</summary>
</member>
<summary>Adds a new object to the <see cref="T:System.Xml.Xsl.XsltArgumentList" /> and associates it with the namespace URI.</summary>
<param name="namespaceUri">The namespace URI to associate with the object. To use the default namespace, specify an empty string.</param>
<param name="extension">The object to add to the list.</param>
- <exception cref="T:System.ArgumentException">The <paramref name="namespaceUri" /> is either <see langword="null" /> or http://www.w3.org/1999/XSL/Transform
-
- The <paramref name="namespaceUri" /> already has an extension object associated with it.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="namespaceUri" /> is either <see langword="null" /> or http://www.w3.org/1999/XSL/Transform
+The <paramref name="namespaceUri" /> already has an extension object associated with it.</exception>
<exception cref="T:System.Security.SecurityException">The caller does not have sufficient permissions to call this method.</exception>
</member>
<member name="M:System.Xml.Xsl.XsltArgumentList.AddParam(System.String,System.String,System.Object)">
<param name="name">The name to associate with the parameter.</param>
<param name="namespaceUri">The namespace URI to associate with the parameter. To use the default namespace, specify an empty string.</param>
<param name="parameter">The parameter value or object to add to the list.</param>
- <exception cref="T:System.ArgumentException">The <paramref name="namespaceUri" /> is either <see langword="null" /> or http://www.w3.org/1999/XSL/Transform.
-
- The <paramref name="name" /> is not a valid name according to the W3C XML specification.
-
- The <paramref name="namespaceUri" /> already has a parameter associated with it.</exception>
+ <exception cref="T:System.ArgumentException">The <paramref name="namespaceUri" /> is either <see langword="null" /> or http://www.w3.org/1999/XSL/Transform.
+The <paramref name="name" /> is not a valid name according to the W3C XML specification.
+The <paramref name="namespaceUri" /> already has a parameter associated with it.</exception>
</member>
<member name="M:System.Xml.Xsl.XsltArgumentList.Clear">
<summary>Removes all parameters and extension objects from the <see cref="T:System.Xml.Xsl.XsltArgumentList" />.</summary>
<param name="namespaceUri">The namespace URI of the parameter to remove.</param>
<returns>The parameter object or <see langword="null" /> if one was not found.</returns>
</member>
+ <member name="E:System.Xml.Xsl.XsltArgumentList.XsltMessageEncountered">
+ <summary>Occurs when a message is specified in the style sheet by the <c>xsl:message</c> element.</summary>
+ </member>
<member name="T:System.Xml.Xsl.XsltCompileException">
<summary>The exception that is thrown by the Load method when an error is found in the XSLT style sheet.</summary>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Load(System.String,System.Xml.XmlResolver)">
<summary>Loads the XSLT style sheet specified by a URL.</summary>
<param name="url">The URL that specifies the XSLT style sheet to load.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> to use to load the style sheet and any style sheet(s) referenced in <c>xsl:import</c> and <c>xsl:include</c> elements.
-
- If this is <see langword="null" />, a default <see cref="T:System.Xml.XmlUrlResolver" /> with no user credentials is used to open the style sheet. The default <see cref="T:System.Xml.XmlUrlResolver" /> is not used to resolve any external resources in the style sheet, so <c>xsl:import</c> and <c>xsl:include</c> elements are not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Load(System.String,System.Xml.XmlResolver)" /> method completes.</param>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> to use to load the style sheet and any style sheet(s) referenced in <c>xsl:import</c> and <c>xsl:include</c> elements.
+If this is <see langword="null" />, a default <see cref="T:System.Xml.XmlUrlResolver" /> with no user credentials is used to open the style sheet. The default <see cref="T:System.Xml.XmlUrlResolver" /> is not used to resolve any external resources in the style sheet, so <c>xsl:import</c> and <c>xsl:include</c> elements are not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Load(System.String,System.Xml.XmlResolver)" /> method completes.</param>
<exception cref="T:System.Xml.Xsl.XsltCompileException">The loaded resource is not a valid style sheet.</exception>
<exception cref="T:System.Security.SecurityException">The style sheet contains embedded script, and the caller does not have <see langword="UnmanagedCode" /> permission.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Load(System.Xml.XmlReader,System.Xml.XmlResolver)">
<summary>Loads the XSLT style sheet contained in the <see cref="T:System.Xml.XmlReader" />.</summary>
<param name="stylesheet">An <see cref="T:System.Xml.XmlReader" /> object that contains the XSLT style sheet.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to load any style sheets referenced in <c>xsl:import</c> and <c>xsl:include</c> elements. If this is <see langword="null" />, external resources are not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Load(System.Xml.XmlReader,System.Xml.XmlResolver)" /> method completes.</param>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to load any style sheets referenced in <c>xsl:import</c> and <c>xsl:include</c> elements. If this is <see langword="null" />, external resources are not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Load(System.Xml.XmlReader,System.Xml.XmlResolver)" /> method completes.</param>
<exception cref="T:System.Xml.Xsl.XsltCompileException">The current node does not conform to a valid style sheet.</exception>
<exception cref="T:System.Security.SecurityException">The style sheet contains embedded scripts, and the caller does not have <see langword="UnmanagedCode" /> permission.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Load(System.Xml.XPath.IXPathNavigable,System.Xml.XmlResolver)">
<summary>Loads the XSLT style sheet contained in the <see cref="T:System.Xml.XPath.IXPathNavigable" />.</summary>
<param name="stylesheet">An object implementing the <see cref="T:System.Xml.XPath.IXPathNavigable" /> interface. In the .NET Framework, this can be either an <see cref="T:System.Xml.XmlNode" /> (typically an <see cref="T:System.Xml.XmlDocument" />), or an <see cref="T:System.Xml.XPath.XPathDocument" /> containing the XSLT style sheet.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to load any style sheets referenced in <c>xsl:import</c> and <c>xsl:include</c> elements. If this is <see langword="null" />, external resources are not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="Overload:System.Xml.Xsl.XslTransform.Load" /> method completes.</param>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to load any style sheets referenced in <c>xsl:import</c> and <c>xsl:include</c> elements. If this is <see langword="null" />, external resources are not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="Overload:System.Xml.Xsl.XslTransform.Load" /> method completes.</param>
<exception cref="T:System.Xml.Xsl.XsltCompileException">The loaded resource is not a valid style sheet.</exception>
<exception cref="T:System.Security.SecurityException">The style sheet contains embedded scripts, and the caller does not have <see langword="UnmanagedCode" /> permission.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Load(System.Xml.XPath.XPathNavigator,System.Xml.XmlResolver)">
<summary>Loads the XSLT style sheet contained in the <see cref="T:System.Xml.XPath.XPathNavigator" />.</summary>
<param name="stylesheet">An <see cref="T:System.Xml.XPath.XPathNavigator" /> object that contains the XSLT style sheet.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to load any style sheets referenced in <c>xsl:import</c> and <c>xsl:include</c> elements. If this is <see langword="null" />, external resources are not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="Overload:System.Xml.Xsl.XslTransform.Load" /> method completes.</param>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to load any style sheets referenced in <c>xsl:import</c> and <c>xsl:include</c> elements. If this is <see langword="null" />, external resources are not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="Overload:System.Xml.Xsl.XslTransform.Load" /> method completes.</param>
<exception cref="T:System.Xml.Xsl.XsltCompileException">The current node does not conform to a valid style sheet.</exception>
<exception cref="T:System.Security.SecurityException">The style sheet contains embedded scripts, and the caller does not have <see langword="UnmanagedCode" /> permission.</exception>
</member>
<summary>Transforms the XML data in the input file and outputs the result to an output file.</summary>
<param name="inputfile">The URL of the source document to be transformed.</param>
<param name="outputfile">The URL of the output file.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="Overload:System.Xml.Xsl.XslTransform.Transform" /> method completes.</param>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="Overload:System.Xml.Xsl.XslTransform.Transform" /> method completes.</param>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.IXPathNavigable" /> using the specified <paramref name="args" /> and outputs the result to an <see cref="T:System.Xml.XmlReader" />.</summary>
<param name="input">An object implementing the <see cref="T:System.Xml.XPath.IXPathNavigable" /> interface. In the .NET Framework, this can be either an <see cref="T:System.Xml.XmlNode" /> (typically an <see cref="T:System.Xml.XmlDocument" />), or an <see cref="T:System.Xml.XPath.XPathDocument" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
<param name="output">The stream to which you want to output.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList,System.IO.Stream,System.Xml.XmlResolver)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.IXPathNavigable" /> using the specified <paramref name="args" /> and outputs the result to a <see cref="T:System.IO.Stream" />.</summary>
<param name="input">An object implementing the <see cref="T:System.Xml.XPath.IXPathNavigable" /> interface. In the .NET Framework, this can be either an <see cref="T:System.Xml.XmlNode" /> (typically an <see cref="T:System.Xml.XmlDocument" />), or an <see cref="T:System.Xml.XPath.XPathDocument" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
<param name="output">The stream to which you want to output.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="Overload:System.Xml.Xsl.XslTransform.Transform" /> method completes.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="Overload:System.Xml.Xsl.XslTransform.Transform" /> method completes.</param>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList,System.IO.TextWriter)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.IXPathNavigable" /> using the specified <paramref name="args" /> and outputs the result to a <see cref="T:System.IO.TextWriter" />.</summary>
<param name="input">An object implementing the <see cref="T:System.Xml.XPath.IXPathNavigable" /> interface. In the .NET Framework, this can be either an <see cref="T:System.Xml.XmlNode" /> (typically an <see cref="T:System.Xml.XmlDocument" />), or an <see cref="T:System.Xml.XPath.XPathDocument" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
<param name="output">The <see cref="T:System.IO.TextWriter" /> to which you want to output.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList,System.IO.TextWriter,System.Xml.XmlResolver)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.IXPathNavigable" /> using the specified <paramref name="args" /> and outputs the result to a <see cref="T:System.IO.TextWriter" />.</summary>
<param name="input">An object implementing the <see cref="T:System.Xml.XPath.IXPathNavigable" /> interface. In the .NET Framework, this can be either an <see cref="T:System.Xml.XmlNode" /> (typically an <see cref="T:System.Xml.XmlDocument" />), or an <see cref="T:System.Xml.XPath.XPathDocument" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
<param name="output">The <see cref="T:System.IO.TextWriter" /> to which you want to output.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList,System.IO.TextWriter,System.Xml.XmlResolver)" /> method completes.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList,System.IO.TextWriter,System.Xml.XmlResolver)" /> method completes.</param>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlResolver)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.IXPathNavigable" /> using the specified <paramref name="args" /> and outputs the result to an <see cref="T:System.Xml.XmlReader" />.</summary>
<param name="input">An object implementing the <see cref="T:System.Xml.XPath.IXPathNavigable" /> interface. In the .NET Framework, this can be either an <see cref="T:System.Xml.XmlNode" /> (typically an <see cref="T:System.Xml.XmlDocument" />), or an <see cref="T:System.Xml.XPath.XPathDocument" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlResolver)" /> method completes.</param>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlResolver)" /> method completes.</param>
<returns>An <see cref="T:System.Xml.XmlReader" /> containing the results of the transformation.</returns>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlWriter)">
<param name="input">An object implementing the <see cref="T:System.Xml.XPath.IXPathNavigable" /> interface. In the .NET Framework, this can be either an <see cref="T:System.Xml.XmlNode" /> (typically an <see cref="T:System.Xml.XmlDocument" />), or an <see cref="T:System.Xml.XPath.XPathDocument" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
<param name="output">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlWriter,System.Xml.XmlResolver)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.IXPathNavigable" /> using the specified <paramref name="args" /> and outputs the result to an <see cref="T:System.Xml.XmlWriter" />.</summary>
<param name="input">An object implementing the <see cref="T:System.Xml.XPath.IXPathNavigable" /> interface. In the .NET Framework, this can be either an <see cref="T:System.Xml.XmlNode" /> (typically an <see cref="T:System.Xml.XmlDocument" />), or an <see cref="T:System.Xml.XPath.XPathDocument" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
<param name="output">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlWriter,System.Xml.XmlResolver)" /> method completes.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.IXPathNavigable,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlWriter,System.Xml.XmlResolver)" /> method completes.</param>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.XPathNavigator" /> using the specified <paramref name="args" /> and outputs the result to an <see cref="T:System.Xml.XmlReader" />.</summary>
<param name="input">An <see cref="T:System.Xml.XPath.XPathNavigator" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
<returns>An <see cref="T:System.Xml.XmlReader" /> containing the results of the transformation.</returns>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.IO.Stream)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.XPathNavigator" /> using the specified <paramref name="args" /> and outputs the result to a <see cref="T:System.IO.Stream" />.</summary>
<param name="input">An <see cref="T:System.Xml.XPath.XPathNavigator" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
<param name="output">The stream to which you want to output.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.IO.Stream,System.Xml.XmlResolver)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.XPathNavigator" /> using the specified <paramref name="args" /> and outputs the result to a <see cref="T:System.IO.Stream" />.</summary>
<param name="input">An <see cref="T:System.Xml.XPath.XPathNavigator" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
<param name="output">The stream to which you want to output.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.IO.Stream,System.Xml.XmlResolver)" /> method completes.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.IO.Stream,System.Xml.XmlResolver)" /> method completes.</param>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.IO.TextWriter)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.XPathNavigator" /> using the specified <paramref name="args" /> and outputs the result to a <see cref="T:System.IO.TextWriter" />.</summary>
<param name="input">An <see cref="T:System.Xml.XPath.XPathNavigator" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
<param name="output">The <see cref="T:System.IO.TextWriter" /> to which you want to output.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.IO.TextWriter,System.Xml.XmlResolver)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.XPathNavigator" /> using the specified <paramref name="args" /> and outputs the result to a <see cref="T:System.IO.TextWriter" />.</summary>
<param name="input">An <see cref="T:System.Xml.XPath.XPathNavigator" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
<param name="output">The <see cref="T:System.IO.TextWriter" /> to which you want to output.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.IO.TextWriter,System.Xml.XmlResolver)" /> method completes.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.IO.TextWriter,System.Xml.XmlResolver)" /> method completes.</param>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlResolver)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.XPathNavigator" /> using the specified <paramref name="args" /> and outputs the result to an <see cref="T:System.Xml.XmlReader" />.</summary>
<param name="input">An <see cref="T:System.Xml.XPath.XPathNavigator" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlResolver)" /> method completes.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlResolver)" /> method completes.</param>
<returns>An <see cref="T:System.Xml.XmlReader" /> containing the results of the transformation.</returns>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlWriter)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.XPathNavigator" /> using the specified args and outputs the result to an <see cref="T:System.Xml.XmlWriter" />.</summary>
<param name="input">An <see cref="T:System.Xml.XPath.XPathNavigator" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
<param name="output">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlWriter,System.Xml.XmlResolver)">
<summary>Transforms the XML data in the <see cref="T:System.Xml.XPath.XPathNavigator" /> using the specified args and outputs the result to an <see cref="T:System.Xml.XmlWriter" />.</summary>
<param name="input">An <see cref="T:System.Xml.XPath.XPathNavigator" /> containing the data to be transformed.</param>
<param name="args">An <see cref="T:System.Xml.Xsl.XsltArgumentList" /> containing the namespace-qualified arguments used as input to the transformation.</param>
<param name="output">The <see cref="T:System.Xml.XmlWriter" /> to which you want to output.</param>
- <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
-
- The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlWriter,System.Xml.XmlResolver)" /> method completes.</param>
- <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
-
- Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
+ <param name="resolver">The <see cref="T:System.Xml.XmlResolver" /> used to resolve the XSLT <c>document()</c> function. If this is <see langword="null" />, the <c>document()</c> function is not resolved.
+The <see cref="T:System.Xml.XmlResolver" /> is not cached after the <see cref="M:System.Xml.Xsl.XslTransform.Transform(System.Xml.XPath.XPathNavigator,System.Xml.Xsl.XsltArgumentList,System.Xml.XmlWriter,System.Xml.XmlResolver)" /> method completes.</param>
+ <exception cref="T:System.InvalidOperationException">There was an error processing the XSLT transformation.
+Note: This is a change in behavior from earlier versions. An <see cref="T:System.Xml.Xsl.XsltException" /> is thrown if you are using Microsoft .NET Framework version 1.1 or earlier.</exception>
</member>
<member name="P:System.Xml.Xsl.XslTransform.XmlResolver">
<summary>Sets the <see cref="T:System.Xml.XmlResolver" /> used to resolve external resources when the <see cref="Overload:System.Xml.Xsl.XslTransform.Transform" /> method is called.</summary>
projects / platform / core / csapi / tizenfx.git / blobdiff