234 lines
12 KiB
XML
234 lines
12 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="XmlSerializerNamespaces" FullName="System.Xml.Serialization.XmlSerializerNamespaces">
|
|
<TypeSignature Maintainer="auto" Language="C#" Value="public class XmlSerializerNamespaces" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit XmlSerializerNamespaces extends System.Object" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Xml</AssemblyName>
|
|
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> contains a collection of XML namespaces, each with an associated prefix. The <see cref="T:System.Xml.Serialization.XmlSerializer" /> uses an instance of the <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> class to create qualified names in an XML document.</para>
|
|
<para>XML namespaces contained by the <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> must conform to the www.w3.org specification named <paramref name="Namespaces in XML" />.</para>
|
|
<para>XML namespaces provide a way to qualify the names of XML elements and attributes in XML documents. A qualified name consists of a prefix and a local name, separated by a colon. The prefix functions only as a placeholder; it is mapped to a URI that specifies a namespace. The combination of the universally-managed URI namespace and the local name produces a name that is guaranteed to be universally unique.</para>
|
|
<para>To create qualified names in an XML document: </para>
|
|
<list type="ordered">
|
|
<item>
|
|
<para>Create an <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> instance.</para>
|
|
</item>
|
|
<item>
|
|
<para>
|
|
<see cref="M:System.Xml.Serialization.XmlSerializerNamespaces.Add(System.String,System.String)" /> each prefix and namespace pair that you want to the instance.</para>
|
|
</item>
|
|
<item>
|
|
<para>Apply the appropriate.NET attribute to each property or class that the <see cref="T:System.Xml.Serialization.XmlSerializer" /> serializes into an XML document. The available attributes are: </para>
|
|
</item>
|
|
</list>
|
|
<list type="bullet">
|
|
<item>
|
|
<para>
|
|
<see cref="T:System.Xml.Serialization.XmlArrayAttribute" />
|
|
</para>
|
|
</item>
|
|
<item>
|
|
<para>
|
|
<see cref="T:System.Xml.Serialization.XmlArrayItemAttribute" />
|
|
</para>
|
|
</item>
|
|
<item>
|
|
<para>
|
|
<see cref="T:System.Xml.Serialization.XmlAttributeAttribute" />
|
|
</para>
|
|
</item>
|
|
<item>
|
|
<para>
|
|
<see cref="T:System.Xml.Serialization.XmlElementAttribute" />
|
|
</para>
|
|
</item>
|
|
<item>
|
|
<para>
|
|
<see cref="T:System.Xml.Serialization.XmlRootAttribute" />
|
|
</para>
|
|
</item>
|
|
<item>
|
|
<para>
|
|
<see cref="T:System.Xml.Serialization.XmlTypeAttribute" />
|
|
</para>
|
|
</item>
|
|
</list>
|
|
<list type="ordered">
|
|
<item>
|
|
<para>Set the Namespace property of each attribute to one of the namespace values from the <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> object.</para>
|
|
</item>
|
|
<item>
|
|
<para>Pass the <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> to the <see cref="M:System.Xml.Serialization.XmlSerializer.Serialize(System.IO.TextWriter,System.Object)" /> method of the <see cref="T:System.Xml.Serialization.XmlSerializer" />.</para>
|
|
</item>
|
|
</list>
|
|
<block subset="none" type="note">
|
|
<para>The creation of an empty namespace and prefix pair is not supported. That is, you cannot create a pair using the following code:</para>
|
|
</block>
|
|
<code>XmlSerializerNamespaces ns = new XmlSerializerNamespaces();
|
|
ns.Add("", "");</code>
|
|
<code>Dim ns As XmlSerializerNamespaces ns = New XmlSerializerNamespaces()
|
|
ns.Add("", "")</code>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Contains the XML namespaces and prefixes that the <see cref="T:System.Xml.Serialization.XmlSerializer" /> uses to generate qualified names in an XML-document instance.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public XmlSerializerNamespaces ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> class.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public XmlSerializerNamespaces (System.Xml.Serialization.XmlSerializerNamespaces namespaces);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Xml.Serialization.XmlSerializerNamespaces namespaces) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="namespaces" Type="System.Xml.Serialization.XmlSerializerNamespaces" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> class, using the specified instance of XmlSerializerNamespaces containing the collection of prefix and namespace pairs.</para>
|
|
</summary>
|
|
<param name="namespaces">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An instance of the <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" />containing the namespace and prefix pairs. </param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public XmlSerializerNamespaces (System.Xml.XmlQualifiedName[] namespaces);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Xml.XmlQualifiedName[] namespaces) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="namespaces" Type="System.Xml.XmlQualifiedName[]" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> class.</para>
|
|
</summary>
|
|
<param name="namespaces">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An array of <see cref="T:System.Xml.XmlQualifiedName" /> objects. </param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Add">
|
|
<MemberSignature Language="C#" Value="public void Add (string prefix, string ns);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Add(string prefix, string ns) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="prefix" Type="System.String" />
|
|
<Parameter Name="ns" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If you want the <see cref="T:System.Xml.Serialization.XmlSerializer" /> to qualify the element and attribute names in an XML document, you must <see cref="M:System.Xml.Serialization.XmlSerializerNamespaces.Add(System.String,System.String)" /> the prefix and namespace pairs to an <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> object.</para>
|
|
<para>Any namespaces that you add must conform to the www.w3.org specification <paramref name="Namespaces in XML" />.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Adds a prefix and namespace pair to an <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> object.</para>
|
|
</summary>
|
|
<param name="prefix">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The prefix associated with an XML namespace. </param>
|
|
<param name="ns">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An XML namespace. </param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Count">
|
|
<MemberSignature Language="C#" Value="public int Count { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 Count" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added: an object of type 'int'</value>
|
|
<remarks>To be added</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the number of prefix and namespace pairs in the collection.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ToArray">
|
|
<MemberSignature Language="C#" Value="public System.Xml.XmlQualifiedName[] ToArray ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Xml.XmlQualifiedName[] ToArray() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Xml.XmlQualifiedName[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the array of prefix and namespace pairs in an <see cref="T:System.Xml.Serialization.XmlSerializerNamespaces" /> object.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>An array of <see cref="T:System.Xml.XmlQualifiedName" /> objects that are used as qualified names in an XML document.</para>
|
|
</returns>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |