231 lines
17 KiB
XML
231 lines
17 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="SoapAttributes" FullName="System.Xml.Serialization.SoapAttributes">
|
|
<TypeSignature Maintainer="auto" Language="C#" Value="public class SoapAttributes" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SoapAttributes 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>Creating a <see cref="T:System.Xml.Serialization.SoapAttributes" /> is part of a process that overrides the default way the <see cref="T:System.Xml.Serialization.XmlSerializer" /> serializes class instances. For example, suppose you want to serialize an object that is created from a DLL that has an inaccessible source. By using the <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" /> class, you can augment or otherwise control how the object is serialized.</para>
|
|
<para>The members of the <see cref="T:System.Xml.Serialization.SoapAttributes" /> class correspond directly to a family of attribute classes that control serialization. For example, the <see cref="P:System.Xml.Serialization.SoapAttributes.SoapAttribute" /> property must be set to a <see cref="T:System.Xml.Serialization.SoapAttributeAttribute" />, which allows you to override serialization of a field or property by instructing the <see cref="T:System.Xml.Serialization.XmlSerializer" /> to serialize the property value as an encoded SOAP attribute. For a complete list of attributes that control encoded SOAP serialization, see <format type="text/html"><a href="93EE258C-9C0F-4A08-897C-C10DB7A00F91">[<topic://cpconAttributesThatControlSOAPEncodedSerialization>]</a></format>.</para>
|
|
<para>For more details about adding an instance of the <see cref="T:System.Xml.Serialization.SoapAttributes" /> class to an instance of the <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" /> class, see the <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" /> class overview.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Represents a collection of attribute objects that control how the <see cref="T:System.Xml.Serialization.XmlSerializer" /> serializes and deserializes SOAP methods.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public SoapAttributes ();" />
|
|
<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>For each member or class instance whose serialization is being overridden, you must create a new <see cref="T:System.Xml.Serialization.SoapAttributes" />. Set the properties for the <see cref="T:System.Xml.Serialization.SoapAttributes" /> as appropriate to the member or object, then add the <see cref="T:System.Xml.Serialization.SoapAttributes" /> to an instance of the <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" /> class.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Xml.Serialization.SoapAttributes" /> class.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public SoapAttributes (System.Reflection.ICustomAttributeProvider provider);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Reflection.ICustomAttributeProvider provider) 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="provider" Type="System.Reflection.ICustomAttributeProvider" />
|
|
</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.SoapAttributes" /> class using the specified custom type.</para>
|
|
</summary>
|
|
<param name="provider">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />Any object that implements the <see cref="T:System.Reflection.ICustomAttributeProvider" /> interface, such as the <see cref="T:System.Type" /> class.</param>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SoapAttribute">
|
|
<MemberSignature Language="C#" Value="public System.Xml.Serialization.SoapAttributeAttribute SoapAttribute { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Xml.Serialization.SoapAttributeAttribute SoapAttribute" />
|
|
<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.Xml.Serialization.SoapAttributeAttribute</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'SoapAttributeAttribute'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>By default, if no attribute is applied to a public field or public read/write property, it is serialized as an XML element. You can also instruct the <see cref="T:System.Xml.Serialization.XmlSerializer" /> to serialize a member as an encoded SOAP XML attribute by applying a <see cref="T:System.Xml.Serialization.SoapAttributeAttribute" /> to the field or property. (The <see cref="T:System.Xml.Serialization.XmlSerializer" /> must be created with an <see cref="T:System.Xml.Serialization.XmlTypeMapping" /> in order to serialize an object as an encoded SOAP XML stream.)</para>
|
|
<para>The <see cref="P:System.Xml.Serialization.SoapAttributes.SoapAttribute" /> property allows you to override the serialization controlled by applying a <see cref="T:System.Xml.Serialization.SoapAttributeAttribute" /> to the member. For more details on this process, see the <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" /> class overview.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the <see cref="T:System.Xml.Serialization.SoapAttributeAttribute" /> to override.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SoapDefaultValue">
|
|
<MemberSignature Language="C#" Value="public object SoapDefaultValue { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance object SoapDefaultValue" />
|
|
<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.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'object'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The default value of a member can be set by applying a <see cref="T:System.ComponentModel.DefaultValueAttribute" /> attribute to the member. If the member is being serialized as an encoded SOAP message, you can change the default value by creating a new <see cref="T:System.ComponentModel.DefaultValueAttribute" />, setting its <see cref="P:System.ComponentModel.DefaultValueAttribute.Value" /> property, and setting the <see cref="P:System.Xml.Serialization.SoapAttributes.SoapDefaultValue" /> property to the object. Add the <see cref="T:System.Xml.Serialization.SoapAttributes" /> to a <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" />. For more details, see the <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" /> class overview.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the default value of an XML element or attribute.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SoapElement">
|
|
<MemberSignature Language="C#" Value="public System.Xml.Serialization.SoapElementAttribute SoapElement { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Xml.Serialization.SoapElementAttribute SoapElement" />
|
|
<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.Xml.Serialization.SoapElementAttribute</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'SoapElementAttribute'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Xml.Serialization.SoapElementAttribute" /> is used to control the serialization of a class member as an XML element. Set the <see cref="P:System.Xml.Serialization.SoapAttributes.SoapElement" /> property to a new <see cref="T:System.Xml.Serialization.SoapElementAttribute" /> to override the serialization of a class member as an XML element by creating a new <see cref="T:System.Xml.Serialization.SoapElementAttribute" /> and assigning it to the property. Then add the <see cref="T:System.Xml.Serialization.SoapAttributes" /> to a <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" />. Create an <see cref="T:System.Xml.Serialization.XmlTypeMapping" /> with the <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" />, then construct an <see cref="T:System.Xml.Serialization.XmlSerializer" /> with the <see cref="T:System.Xml.Serialization.XmlTypeMapping" />.</para>
|
|
<para>For more information, see the <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" /> class overview.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a <see cref="T:System.Xml.Serialization.SoapElementAttribute" /> to override.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SoapEnum">
|
|
<MemberSignature Language="C#" Value="public System.Xml.Serialization.SoapEnumAttribute SoapEnum { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Xml.Serialization.SoapEnumAttribute SoapEnum" />
|
|
<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.Xml.Serialization.SoapEnumAttribute</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'SoapEnumAttribute'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Xml.Serialization.SoapEnumAttribute" /> is used to control the serialization of an enumeration member. Set the <see cref="P:System.Xml.Serialization.SoapAttributes.SoapEnum" /> property to a new <see cref="T:System.Xml.Serialization.SoapEnumAttribute" /> to override the serialization of such a member.</para>
|
|
<para>For more information, see the <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" /> class overview.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets an object that specifies how the <see cref="T:System.Xml.Serialization.XmlSerializer" /> serializes a SOAP enumeration.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SoapIgnore">
|
|
<MemberSignature Language="C#" Value="public bool SoapIgnore { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool SoapIgnore" />
|
|
<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.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'bool'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>By default, all public fields and public read/write properties are serialized by the <see cref="T:System.Xml.Serialization.XmlSerializer" />. That is, the value of each public field or property is persisted as an XML element or XML attribute in an XML document.</para>
|
|
<para>To override the default serialization of a field or property, create a <see cref="T:System.Xml.Serialization.SoapAttributes" />, and set its <see cref="P:System.Xml.Serialization.SoapAttributes.SoapIgnore" /> property to true. Use the <see cref="M:System.Xml.Serialization.SoapAttributeOverrides.Add(System.Type,System.Xml.Serialization.SoapAttributes)" /> method to add the object to a <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" /> and specify the type of the object that contains the field or property to ignore and the name of the field or property to ignore.</para>
|
|
<para>If a <see cref="T:System.Xml.Serialization.SoapIgnoreAttribute" /> is applied to a field or property, the field or property is ignored. However you can override that behavior by creating a <see cref="T:System.Xml.Serialization.SoapAttributes" />, setting its <see cref="P:System.Xml.Serialization.SoapAttributes.SoapIgnore" /> property to false, and adding it to a <see cref="T:System.Xml.Serialization.SoapAttributeOverrides" />, specifying the type of the object that contains the field or property and the name of the field or property.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value that specifies whether the <see cref="T:System.Xml.Serialization.XmlSerializer" /> serializes a public field or property as encoded SOAP XML.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SoapType">
|
|
<MemberSignature Language="C#" Value="public System.Xml.Serialization.SoapTypeAttribute SoapType { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Xml.Serialization.SoapTypeAttribute SoapType" />
|
|
<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.Xml.Serialization.SoapTypeAttribute</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<value>To be added: an object of type 'SoapTypeAttribute'</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Xml.Serialization.SoapTypeAttribute" /> can be used to control the XML stream generated by the <see cref="T:System.Xml.Serialization.XmlSerializer" />. Set the <see cref="P:System.Xml.Serialization.SoapAttributes.SoapType" /> property to a new <see cref="T:System.Xml.Serialization.SoapTypeAttribute" /> to control the schema for the XML that is generated when a class is serialized.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets an object that instructs the <see cref="T:System.Xml.Serialization.XmlSerializer" /> how to serialize an object type into encoded SOAP XML.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |