Skip to content

Commit a95433d

Browse files
authored
move serialization docs (dotnet#2780)
* move serialization docs * addressed feedback * added missing space * fixing link
1 parent d019d1c commit a95433d

File tree

240 files changed

+584
-586
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

240 files changed

+584
-586
lines changed

docs/framework/serialization/serialization-how-to-topics.md

-45
This file was deleted.

docs/framework/wcf/feature-details/serialization-and-deserialization.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ manager: "erikre"
257257

258258
- The <xref:System.Runtime.Serialization.NetDataContractSerializer.Serialize%2A> and <xref:System.Runtime.Serialization.NetDataContractSerializer.Deserialize%2A> methods are aliases for the <xref:System.Runtime.Serialization.XmlObjectSerializer.WriteObject%2A> and <xref:System.Runtime.Serialization.XmlObjectSerializer.ReadObject%2A> methods. These exist to provide a more consistent programming model with binary or SOAP serialization.
259259

260-
[!INCLUDE[crabout](../../../../includes/crabout-md.md)] these features, see [Binary Serialization](../../../../docs/framework/serialization/binary-serialization.md).
260+
[!INCLUDE[crabout](../../../../includes/crabout-md.md)] these features, see [Binary Serialization](../../../../docs/standard/serialization/binary-serialization.md).
261261

262262
The XML formats that the `NetDataContractSerializer` and the `DataContractSerializer` use are normally not compatible. That is, attempting to serialize with one of these serializers and deserialize with the other is not a supported scenario.
263263

@@ -267,5 +267,5 @@ manager: "erikre"
267267
<xref:System.Runtime.Serialization.DataContractSerializer>
268268
<xref:System.Runtime.Serialization.NetDataContractSerializer>
269269
<xref:System.Runtime.Serialization.XmlObjectSerializer>
270-
[Binary Serialization](../../../../docs/framework/serialization/binary-serialization.md)
270+
[Binary Serialization](../../../../docs/standard/serialization/binary-serialization.md)
271271
[Types Supported by the Data Contract Serializer](../../../../docs/framework/wcf/feature-details/types-supported-by-the-data-contract-serializer.md)

docs/framework/wcf/feature-details/version-tolerant-serialization-callbacks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ The data contract programming model fully supports the version-tolerant serializ
5353
<xref:System.Runtime.Serialization.OnDeserializingAttribute>
5454
<xref:System.Runtime.Serialization.OnDeserializedAttribute>
5555
<xref:System.Runtime.Serialization.StreamingContext>
56-
[Version Tolerant Serialization](../../../../docs/framework/serialization/version-tolerant-serialization.md)
56+
[Version Tolerant Serialization](../../../../docs/standard/serialization/version-tolerant-serialization.md)

docs/standard/application-essentials.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ This section of the .NET Framework documentation provides information about basi
4747
[Application Domains and Assemblies](../../docs/framework/app-domains/index.md)
4848
Describes how to create and work with assemblies and application domains.
4949

50-
[Serialization](../../docs/framework/serialization/index.md)
50+
[Serialization](../../docs/standard/serialization/index.md)
5151
Discusses the process of converting the state of an object into a form that can be persisted or transported.
5252

5353
[Resources in Desktop Apps](../../docs/framework/resources/index.md)

docs/framework/serialization/add-element-for-xmlschemaimporterextensions.md renamed to docs/standard/serialization/add-element-for-xmlschemaimporterextensions.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "&lt;add&gt; Element for &lt;xmlSchemaImporterExtensions&gt;"
33
ms.custom: ""
44
ms.date: "03/30/2017"
5-
ms.prod: ".net-framework"
5+
ms.prod: ".net"
66
ms.reviewer: ""
77
ms.suite: ""
88
ms.tgt_pltfrm: ""
@@ -71,5 +71,5 @@ Adds types used by the <xref:System.Xml.Serialization.XmlSchemaImporter> for map
7171

7272
## See Also
7373
<xref:System.Xml.Serialization.XmlSchemaImporter>
74-
[\<system.xml.serialization> Element](../../../docs/framework/serialization/system-xml-serialization-element.md)
75-
[\<schemaImporterExtensions> Element](../../../docs/framework/serialization/schemaimporterextensions-element.md)
74+
[\<system.xml.serialization> Element](../../../docs/standard/serialization/system-xml-serialization-element.md)
75+
[\<schemaImporterExtensions> Element](../../../docs/standard/serialization/schemaimporterextensions-element.md)

docs/framework/serialization/attributes-that-control-encoded-soap-serialization.md renamed to docs/standard/serialization/attributes-that-control-encoded-soap-serialization.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Attributes That Control Encoded SOAP Serialization"
33
ms.custom: ""
44
ms.date: "03/30/2017"
5-
ms.prod: ".net-framework"
5+
ms.prod: ".net"
66
ms.reviewer: ""
77
ms.suite: ""
88
ms.tgt_pltfrm: ""
@@ -24,10 +24,10 @@ author: "Erikre"
2424
ms.author: "erikre"
2525
manager: "erikre"
2626
---
27-
# Attributes That Control Encoded SOAP Serialization
28-
The World Wide Web Consortium (www.w3.org) document named "Simple Object Access Protocol (SOAP) 1.1" contains an optional section (section 5) that describes how SOAP parameters can be encoded. To conform to section 5 of the specification, you must use a special set of attributes found in the <xref:System.Xml.Serialization> namespace. Apply those attributes as appropriate to classes and members of classes, and then use the [XmlSerializer](https://msdn.microsoft.com/en-us/library/system.xml.serialization.xmlserializer.aspx) to serialize instances of the class or classes.
27+
# Attributes That Control Encoded SOAP Serialization
28+
The World Wide Web Consortium (www.w3.org) document named "Simple Object Access Protocol (SOAP) 1.1" contains an optional section (section 5) that describes how SOAP parameters can be encoded. To conform to section 5 of the specification, you must use a special set of attributes found in the <xref:System.Xml.Serialization> namespace. Apply those attributes as appropriate to classes and members of classes, and then use the <xref:System.Xml.Serialization.XmlSerializer> to serialize instances of the class or classes.
2929

30-
The following table shows the attributes, where they can be applied, and what they do. For more information about using these attributes to control XML serialization, see [How to: Serialize an Object as a SOAP-Encoded XML Stream](../../../docs/framework/serialization/how-to-serialize-an-object-as-a-soap-encoded-xml-stream.md) and [How to: Override Encoded SOAP XML Serialization](../../../docs/framework/serialization/how-to-override-encoded-soap-xml-serialization.md).
30+
The following table shows the attributes, where they can be applied, and what they do. For more information about using these attributes to control XML serialization, see [How to: Serialize an Object as a SOAP-Encoded XML Stream](../../../docs/standard/serialization/how-to-serialize-an-object-as-a-soap-encoded-xml-stream.md) and [How to: Override Encoded SOAP XML Serialization](../../../docs/standard/serialization/how-to-override-encoded-soap-xml-serialization.md).
3131

3232
For more information about attributes, see [Attributes](../../../docs/standard/attributes/index.md).
3333

@@ -41,10 +41,10 @@ The World Wide Web Consortium (www.w3.org) document named "Simple Object Access
4141
|<xref:System.Xml.Serialization.SoapTypeAttribute>|Public class declarations.|The class should be serialized as an XML type.|
4242

4343
## See Also
44-
[XML and SOAP Serialization](../../../docs/framework/serialization/xml-and-soap-serialization.md)
45-
[How to: Serialize an Object as a SOAP-Encoded XML Stream](../../../docs/framework/serialization/how-to-serialize-an-object-as-a-soap-encoded-xml-stream.md)
46-
[How to: Override Encoded SOAP XML Serialization](../../../docs/framework/serialization/how-to-override-encoded-soap-xml-serialization.md)
44+
[XML and SOAP Serialization](../../../docs/standard/serialization/xml-and-soap-serialization.md)
45+
[How to: Serialize an Object as a SOAP-Encoded XML Stream](../../../docs/standard/serialization/how-to-serialize-an-object-as-a-soap-encoded-xml-stream.md)
46+
[How to: Override Encoded SOAP XML Serialization](../../../docs/standard/serialization/how-to-override-encoded-soap-xml-serialization.md)
4747
[Attributes](../../../docs/standard/attributes/index.md)
48-
[XmlSerializer](https://msdn.microsoft.com/en-us/library/system.xml.serialization.xmlserializer.aspx)
49-
[How to: Serialize an Object](../../../docs/framework/serialization/how-to-serialize-an-object.md)
50-
[How to: Deserialize an Object](../../../docs/framework/serialization/how-to-deserialize-an-object.md)
48+
<xref:System.Xml.Serialization.XmlSerializer>
49+
[How to: Serialize an Object](../../../docs/standard/serialization/how-to-serialize-an-object.md)
50+
[How to: Deserialize an Object](../../../docs/standard/serialization/how-to-deserialize-an-object.md)

docs/framework/serialization/attributes-that-control-xml-serialization.md renamed to docs/standard/serialization/attributes-that-control-xml-serialization.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Attributes That Control XML Serialization"
33
ms.custom: ""
44
ms.date: "03/30/2017"
5-
ms.prod: ".net-framework"
5+
ms.prod: ".net"
66
ms.reviewer: ""
77
ms.suite: ""
88
ms.tgt_pltfrm: ""
@@ -26,9 +26,9 @@ ms.author: "erikre"
2626
manager: "erikre"
2727
---
2828
# Attributes That Control XML Serialization
29-
You can apply the attributes in the following table to classes and class members to control the way in which the [XmlSerializer](https://msdn.microsoft.com/en-us/library/system.xml.serialization.xmlserializer.aspx) serializes or deserializes an instance of the class. To understand how these attributes control XML serialization, see [Controlling XML Serialization Using Attributes](../../../docs/framework/serialization/controlling-xml-serialization-using-attributes.md).
29+
You can apply the attributes in the following table to classes and class members to control the way in which the <xref:System.Xml.Serialization.XmlSerializer> serializes or deserializes an instance of the class. To understand how these attributes control XML serialization, see [Controlling XML Serialization Using Attributes](../../../docs/standard/serialization/controlling-xml-serialization-using-attributes.md).
3030

31-
These attributes can also be used to control the literal style SOAP messages generated by an XML Web service. For more information about applying these attributes to an XML Web services method, see [XML Serialization with XML Web Services](../../../docs/framework/serialization/xml-serialization-with-xml-web-services.md).
31+
These attributes can also be used to control the literal style SOAP messages generated by an XML Web service. For more information about applying these attributes to an XML Web services method, see [XML Serialization with XML Web Services](../../../docs/standard/serialization/xml-serialization-with-xml-web-services.md).
3232

3333
For more information about attributes, see [Attributes](../../../docs/standard/attributes/index.md).
3434

@@ -50,12 +50,12 @@ You can apply the attributes in the following table to classes and class members
5050

5151
In addition to these attributes, which are all found in the <xref:System.Xml.Serialization> namespace, you can also apply the <xref:System.ComponentModel.DefaultValueAttribute> attribute to a field. The **DefaultValueAttribute** sets the value that will be automatically assigned to the member if no value is specified.
5252

53-
To control encoded SOAP XML serialization, see [Attributes That Control Encoded SOAP Serialization](../../../docs/framework/serialization/attributes-that-control-encoded-soap-serialization.md).
53+
To control encoded SOAP XML serialization, see [Attributes That Control Encoded SOAP Serialization](../../../docs/standard/serialization/attributes-that-control-encoded-soap-serialization.md).
5454

5555
## See Also
56-
[XML and SOAP Serialization](../../../docs/framework/serialization/xml-and-soap-serialization.md)
57-
[XmlSerializer](https://msdn.microsoft.com/en-us/library/system.xml.serialization.xmlserializer.aspx)
58-
[Controlling XML Serialization Using Attributes](../../../docs/framework/serialization/controlling-xml-serialization-using-attributes.md)
59-
[How to: Specify an Alternate Element Name for an XML Stream](../../../docs/framework/serialization/how-to-specify-an-alternate-element-name-for-an-xml-stream.md)
60-
[How to: Serialize an Object](../../../docs/framework/serialization/how-to-serialize-an-object.md)
61-
[How to: Deserialize an Object](../../../docs/framework/serialization/how-to-deserialize-an-object.md)
56+
[XML and SOAP Serialization](../../../docs/standard/serialization/xml-and-soap-serialization.md)
57+
<xref:System.Xml.Serialization.XmlSerializer>
58+
[Controlling XML Serialization Using Attributes](../../../docs/standard/serialization/controlling-xml-serialization-using-attributes.md)
59+
[How to: Specify an Alternate Element Name for an XML Stream](../../../docs/standard/serialization/how-to-specify-an-alternate-element-name-for-an-xml-stream.md)
60+
[How to: Serialize an Object](../../../docs/standard/serialization/how-to-serialize-an-object.md)
61+
[How to: Deserialize an Object](../../../docs/standard/serialization/how-to-deserialize-an-object.md)

docs/framework/serialization/basic-serialization-technology-sample.md renamed to docs/standard/serialization/basic-serialization-technology-sample.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Basic Serialization Technology Sample"
33
ms.custom: ""
44
ms.date: "03/30/2017"
5-
ms.prod: ".net-framework"
5+
ms.prod: ".net"
66
ms.reviewer: ""
77
ms.suite: ""
88
ms.tgt_pltfrm: ""
@@ -83,20 +83,20 @@ manager: "erikre"
8383
- <xref:System.IO.FileStream> Used to serialize and deserialize linked lists.
8484

8585
## See Also
86-
<xref:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter>
86+
<xref:System.IO>
8787
<xref:System.IO.File>
8888
<xref:System.IO.FileStream>
89-
<xref:System.Runtime.Serialization.IFormatter>
90-
<xref:System.SerializableAttribute>
91-
<xref:System.Runtime.Serialization.Formatters.Soap.SoapFormatter>
9289
<xref:System.IO.Stream>
90+
<xref:System.Random>
9391
<xref:System.Runtime.Serialization>
92+
<xref:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter>
93+
<xref:System.Runtime.Serialization.Formatters.Soap.SoapFormatter>
94+
<xref:System.Runtime.Serialization.IFormatter>
95+
<xref:System.SerializableAttribute>
9496
<xref:System.Xml.Serialization>
95-
[Random class](https://msdn.microsoft.com/en-us/library/system.random.aspx)
96-
[System.IO namespace](https://msdn.microsoft.com/en-us/library/system.io.aspx)
97-
[Basic Serialization](../../../docs/framework/serialization/basic-serialization.md)
98-
[Binary Serialization](../../../docs/framework/serialization/binary-serialization.md)
99-
[Controlling XML Serialization Using Attributes](../../../docs/framework/serialization/controlling-xml-serialization-using-attributes.md)
100-
[Introducing XML Serialization](../../../docs/framework/serialization/introducing-xml-serialization.md)
101-
[Serialization](../../../docs/framework/serialization/index.md)
102-
[XML and SOAP Serialization](../../../docs/framework/serialization/xml-and-soap-serialization.md)
97+
[Basic Serialization](../../../docs/standard/serialization/basic-serialization.md)
98+
[Binary Serialization](../../../docs/standard/serialization/binary-serialization.md)
99+
[Controlling XML Serialization Using Attributes](../../../docs/standard/serialization/controlling-xml-serialization-using-attributes.md)
100+
[Introducing XML Serialization](../../../docs/standard/serialization/introducing-xml-serialization.md)
101+
[Serialization](../../../docs/standard/serialization/index.md)
102+
[XML and SOAP Serialization](../../../docs/standard/serialization/xml-and-soap-serialization.md)

docs/framework/serialization/basic-serialization.md renamed to docs/standard/serialization/basic-serialization.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Basic Serialization"
33
ms.custom: ""
44
ms.date: "03/30/2017"
5-
ms.prod: ".net-framework"
5+
ms.prod: ".net"
66
ms.reviewer: ""
77
ms.suite: ""
88
ms.tgt_pltfrm: ""
@@ -46,7 +46,7 @@ formatter.Serialize(stream, obj);
4646
stream.Close();
4747
```
4848

49-
This example uses a binary formatter to do the serialization. All you need to do is create an instance of the stream and the formatter you intend to use, and then call the **Serialize** method on the formatter. The stream and the object to serialize are provided as parameters to this call. Although it is not explicitly demonstrated in this example, all member variables of a class will be serialized—even variables marked as private. In this aspect, binary serialization differs from the [XMLSerializer Class](https://msdn.microsoft.com/en-us/library/system.xml.serialization.xmlserializer.aspx), which only serializes public fields. For information on excluding member variables from binary serialization, see [Selective Serialization](../../../docs/framework/serialization/selective-serialization.md).
49+
This example uses a binary formatter to do the serialization. All you need to do is create an instance of the stream and the formatter you intend to use, and then call the **Serialize** method on the formatter. The stream and the object to serialize are provided as parameters to this call. Although it is not explicitly demonstrated in this example, all member variables of a class will be serialized—even variables marked as private. In this aspect, binary serialization differs from the <xref:System.Xml.Serialization.XmlSerializer> class, which only serializes public fields. For information on excluding member variables from binary serialization, see [Selective Serialization](../../../docs/standard/serialization/selective-serialization.md).
5050

5151
Restoring the object back to its former state is just as easy. First, create a stream for reading and a <xref:System.Runtime.Serialization.Formatter>, and then instruct the formatter to deserialize the object. The code example below shows how this is done.
5252

@@ -96,8 +96,8 @@ public class MyStuff : MyObject
9696
}
9797
```
9898

99-
Using the **Serializable** attribute is convenient, but it has limitations as demonstrated above. Refer to the [Serialization Guidelines](../../../docs/framework/serialization/serialization-guidelines.md) for information about when you should mark a class for serialization; serialization cannot be added to a class after it has been compiled.
99+
Using the **Serializable** attribute is convenient, but it has limitations as demonstrated above. Refer to the [Serialization Guidelines](../../../docs/standard/serialization/serialization-guidelines.md) for information about when you should mark a class for serialization; serialization cannot be added to a class after it has been compiled.
100100

101101
## See Also
102-
[Binary Serialization](../../../docs/framework/serialization/binary-serialization.md)
103-
[XML and SOAP Serialization](../../../docs/framework/serialization/xml-and-soap-serialization.md)
102+
[Binary Serialization](../../../docs/standard/serialization/binary-serialization.md)
103+
[XML and SOAP Serialization](../../../docs/standard/serialization/xml-and-soap-serialization.md)

0 commit comments

Comments
 (0)