124 lines
9.1 KiB
XML
124 lines
9.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="SoapEnumAttribute" FullName="System.Xml.Serialization.SoapEnumAttribute">
|
|
<TypeSignature Maintainer="auto" Language="C#" Value="public class SoapEnumAttribute : Attribute" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SoapEnumAttribute extends System.Attribute" />
|
|
<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.Attribute</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.AttributeUsage(System.AttributeTargets.Field)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Xml.Serialization.SoapEnumAttribute" /> class belongs to a family of attributes that controls how the <see cref="T:System.Xml.Serialization.XmlSerializer" /> serializes or deserializes an object as encoded SOAP XML. The resulting XML conforms to section 5 of the World Wide Web Consortium (www.w3.org) document "Simple Object Access Protocol (SOAP) 1.1". For a complete list of similar attributes, see <format type="text/html"><a href="93EE258C-9C0F-4A08-897C-C10DB7A00F91">[<topic://cpconAttributesThatControlSOAPEncodedSerialization>]</a></format>.</para>
|
|
<para>To serialize an object as an encoded SOAP message, you must construct the <see cref="T:System.Xml.Serialization.XmlSerializer" /> using an <see cref="T:System.Xml.Serialization.XmlTypeMapping" /> created with the <see cref="M:System.Xml.Serialization.SoapReflectionImporter.ImportTypeMapping(System.Type)" /> method of the <see cref="T:System.Xml.Serialization.SoapReflectionImporter" /> class.</para>
|
|
<para>Use the <see cref="T:System.Xml.Serialization.SoapEnumAttribute" /> to change the enumeration that the <see cref="T:System.Xml.Serialization.XmlSerializer" /> generates or recognizes (when it serializes or deserializes a class, respectively). For example, if an enumeration contains a member named One, but you prefer that the XML output be named Single, apply the <see cref="T:System.Xml.Serialization.SoapEnumAttribute" /> to the enumeration member and set the <see cref="P:System.Xml.Serialization.SoapEnumAttribute.Name" /> property to "Single".</para>
|
|
<para>You can override the <see cref="P:System.Xml.Serialization.SoapEnumAttribute.Name" /> property value of a <see cref="T:System.Xml.Serialization.SoapEnumAttribute" /> by creating an instance of the <see cref="T:System.Xml.Serialization.SoapEnumAttribute" /> class and assigning it to the <see cref="P:System.Xml.Serialization.SoapAttributes.SoapEnum" /> property of a <see cref="T:System.Xml.Serialization.SoapAttributes" />. For details, see the <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" /> class overview.</para>
|
|
<para>To serialize an object as an encoded SOAP message, you must construct the <see cref="T:System.Xml.Serialization.XmlSerializer" /> using an <see cref="T:System.Xml.Serialization.XmlTypeMapping" /> created with the <see cref="M:System.Xml.Serialization.SoapReflectionImporter.ImportTypeMapping(System.Type)" /> method of the <see cref="T:System.Xml.Serialization.SoapReflectionImporter" /> class.</para>
|
|
<block subset="none" type="note">
|
|
<para>You can use the word SoapEnum in your code instead of the longer <see cref="T:System.Xml.Serialization.SoapEnumAttribute" />.</para>
|
|
</block>
|
|
<para>For more information about using attributes, see <format type="text/html"><a href="30386922-1E00-4602-9EBF-526B271A8B87">[<topic://cpconExtendingMetadataUsingAttributes>]</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Controls how the <see cref="T:System.Xml.Serialization.XmlSerializer" /> serializes an enumeration member.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public SoapEnumAttribute ();" />
|
|
<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>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="M:System.Xml.Serialization.SoapEnumAttribute.#ctor" /> to override an existing enumeration. Create a new <see cref="T:System.Xml.Serialization.SoapEnumAttribute" />, set its properties and assign the object to the <see cref="P:System.Xml.Serialization.SoapAttributes.SoapEnum" /> property of a <see cref="T:System.Xml.Serialization.SoapAttributes" />. For each member of the enumeration, you must create a new <see cref="T:System.Xml.Serialization.SoapAttributes" /> and add it to the <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" />. For more details, see the <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" /> class overview.</para>
|
|
<block subset="none" type="note">
|
|
<para>You can use the word SoapEnum in your code instead of the longer <see cref="T:System.Xml.Serialization.SoapEnumAttribute" />.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Xml.Serialization.SoapEnumAttribute" /> class.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public SoapEnumAttribute (string name);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name) 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="name" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Specify the <see cref="P:System.Xml.Serialization.SoapEnumAttribute.Name" /> when you want the generated XML enumerator to differ from the enumerator found in the enumeration.</para>
|
|
<block subset="none" type="note">
|
|
<para>You can use the word SoapEnum in your code instead of the longer <see cref="T:System.Xml.Serialization.SoapEnumAttribute" />.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Xml.Serialization.SoapEnumAttribute" /> class using the specified element name.</para>
|
|
</summary>
|
|
<param name="name">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The XML element name generated by the <see cref="T:System.Xml.Serialization.XmlSerializer" />. </param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Name">
|
|
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
|
|
<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.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'string'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Specify the <see cref="P:System.Xml.Serialization.SoapEnumAttribute.Name" /> when you want the generated XML enumerator to differ from the enumerator found in the enumeration.</para>
|
|
<block subset="none" type="note">
|
|
<para>You can use the word SoapEnum instead of the longer <see cref="T:System.Xml.Serialization.SoapEnumAttribute" />.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the value generated in an XML document when the <see cref="T:System.Xml.Serialization.XmlSerializer" /> serializes an enumeration, or the value recognized when it deserializes the enumeration member.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |