1 <?xml version="1.0" encoding="utf-8"?>
4 <name>System.Runtime.Serialization.Primitives</name>
7 <member name="T:System.Runtime.Serialization.CollectionDataContractAttribute">
8 <summary>When applied to a collection type, enables custom specification of the collection item elements. This attribute can be applied only to types that are recognized by the <see cref="T:System.Runtime.Serialization.DataContractSerializer" /> as valid, serializable collections. </summary>
10 <member name="M:System.Runtime.Serialization.CollectionDataContractAttribute.#ctor">
11 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.CollectionDataContractAttribute" /> class. </summary>
13 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsItemNameSetExplicitly"></member>
14 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsKeyNameSetExplicitly"></member>
15 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsNameSetExplicitly"></member>
16 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsNamespaceSetExplicitly"></member>
17 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsReference">
18 <summary>Gets or sets a value that indicates whether to preserve object reference data.</summary>
19 <returns>true to keep object reference data; otherwise, false. The default is false.</returns>
21 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsReferenceSetExplicitly"></member>
22 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsValueNameSetExplicitly"></member>
23 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.ItemName">
24 <summary>Gets or sets a custom name for a collection element.</summary>
25 <returns>The name to apply to collection elements.</returns>
27 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.KeyName">
28 <summary>Gets or sets the custom name for a dictionary key name.</summary>
29 <returns>The name to use instead of the default dictionary key name.</returns>
31 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.Name">
32 <summary>Gets or sets the data contract name for the collection type.</summary>
33 <returns>The data contract name for the collection type.</returns>
35 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.Namespace">
36 <summary>Gets or sets the namespace for the data contract.</summary>
37 <returns>The namespace of the data contract.</returns>
39 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.ValueName">
40 <summary>Gets or sets the custom name for a dictionary value name.</summary>
41 <returns>The name to use instead of the default dictionary value name.</returns>
43 <member name="T:System.Runtime.Serialization.ContractNamespaceAttribute">
44 <summary>Specifies the CLR namespace and XML namespace of the data contract. </summary>
46 <member name="M:System.Runtime.Serialization.ContractNamespaceAttribute.#ctor(System.String)">
47 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.ContractNamespaceAttribute" /> class using the supplied namespace. </summary>
48 <param name="contractNamespace">The namespace of the contract.</param>
50 <member name="P:System.Runtime.Serialization.ContractNamespaceAttribute.ClrNamespace">
51 <summary>Gets or sets the CLR namespace of the data contract type. </summary>
52 <returns>The CLR-legal namespace of a type.</returns>
54 <member name="P:System.Runtime.Serialization.ContractNamespaceAttribute.ContractNamespace">
55 <summary>Gets the namespace of the data contract members.</summary>
56 <returns>The namespace of the data contract members.</returns>
58 <member name="T:System.Runtime.Serialization.DataContractAttribute">
59 <summary>Specifies that the type defines or implements a data contract and is serializable by a serializer, such as the <see cref="T:System.Runtime.Serialization.DataContractSerializer" />. To make their type serializable, type authors must define a data contract for their type. </summary>
61 <member name="M:System.Runtime.Serialization.DataContractAttribute.#ctor">
62 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.DataContractAttribute" /> class. </summary>
64 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsNameSetExplicitly"></member>
65 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsNamespaceSetExplicitly"></member>
66 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsReference">
67 <summary>Gets or sets a value that indicates whether to preserve object reference data.</summary>
68 <returns>true to keep object reference data using standard XML; otherwise, false. The default is false.</returns>
70 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsReferenceSetExplicitly"></member>
71 <member name="P:System.Runtime.Serialization.DataContractAttribute.Name">
72 <summary>Gets or sets the name of the data contract for the type.</summary>
73 <returns>The local name of a data contract. The default is the name of the class that the attribute is applied to. </returns>
75 <member name="P:System.Runtime.Serialization.DataContractAttribute.Namespace">
76 <summary>Gets or sets the namespace for the data contract for the type.</summary>
77 <returns>The namespace of the contract. </returns>
79 <member name="T:System.Runtime.Serialization.DataMemberAttribute">
80 <summary>When applied to the member of a type, specifies that the member is part of a data contract and is serializable by the <see cref="T:System.Runtime.Serialization.DataContractSerializer" />.</summary>
82 <member name="M:System.Runtime.Serialization.DataMemberAttribute.#ctor">
83 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.DataMemberAttribute" /> class. </summary>
85 <member name="P:System.Runtime.Serialization.DataMemberAttribute.EmitDefaultValue">
86 <summary>Gets or sets a value that specifies whether to serialize the default value for a field or property being serialized. </summary>
87 <returns>true if the default value for a member should be generated in the serialization stream; otherwise, false. The default is true.</returns>
89 <member name="P:System.Runtime.Serialization.DataMemberAttribute.IsNameSetExplicitly"></member>
90 <member name="P:System.Runtime.Serialization.DataMemberAttribute.IsRequired">
91 <summary>Gets or sets a value that instructs the serialization engine that the member must be present when reading or deserializing.</summary>
92 <returns>true, if the member is required; otherwise, false.</returns>
93 <exception cref="T:System.Runtime.Serialization.SerializationException">the member is not present.</exception>
95 <member name="P:System.Runtime.Serialization.DataMemberAttribute.Name">
96 <summary>Gets or sets a data member name. </summary>
97 <returns>The name of the data member. The default is the name of the target that the attribute is applied to. </returns>
99 <member name="P:System.Runtime.Serialization.DataMemberAttribute.Order">
100 <summary>Gets or sets the order of serialization and deserialization of a member.</summary>
101 <returns>The numeric order of serialization or deserialization.</returns>
103 <member name="T:System.Runtime.Serialization.EnumMemberAttribute">
104 <summary>Specifies that the field is an enumeration member and should be serialized.</summary>
106 <member name="M:System.Runtime.Serialization.EnumMemberAttribute.#ctor">
107 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.EnumMemberAttribute" /> class. </summary>
109 <member name="P:System.Runtime.Serialization.EnumMemberAttribute.IsValueSetExplicitly"></member>
110 <member name="P:System.Runtime.Serialization.EnumMemberAttribute.Value">
111 <summary>Gets or sets the value associated with the enumeration member the attribute is applied to. </summary>
112 <returns>The value associated with the enumeration member.</returns>
114 <member name="T:System.Runtime.Serialization.IgnoreDataMemberAttribute">
115 <summary>When applied to the member of a type, specifies that the member is not part of a data contract and is not serialized.</summary>
117 <member name="M:System.Runtime.Serialization.IgnoreDataMemberAttribute.#ctor">
118 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.IgnoreDataMemberAttribute" /> class. </summary>
120 <member name="T:System.Runtime.Serialization.InvalidDataContractException">
121 <summary>The exception that is thrown when the <see cref="T:System.Runtime.Serialization.DataContractSerializer" /> or <see cref="T:System.Runtime.Serialization.NetDataContractSerializer" /> encounters an invalid data contract during serialization and deserialization. </summary>
123 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor">
124 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException" /> class. </summary>
126 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.String)">
127 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException" /> class with the specified error message. </summary>
128 <param name="message">A description of the error. </param>
130 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.String,System.Exception)">
131 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException" /> class with the specified error message and inner exception. </summary>
132 <param name="message">A description of the error. </param>
133 <param name="innerException">The original <see cref="T:System.Exception" />. </param>
135 <member name="T:System.Runtime.Serialization.KnownTypeAttribute">
136 <summary>Specifies types that should be recognized by the <see cref="T:System.Runtime.Serialization.DataContractSerializer" /> when serializing or deserializing a given type. </summary>
138 <member name="M:System.Runtime.Serialization.KnownTypeAttribute.#ctor(System.String)">
139 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.KnownTypeAttribute" /> class with the name of a method that returns an <see cref="T:System.Collections.IEnumerable" /> of known types. </summary>
140 <param name="methodName">The name of the method that returns an <see cref="T:System.Collections.IEnumerable" /> of types used when serializing or deserializing data.</param>
142 <member name="M:System.Runtime.Serialization.KnownTypeAttribute.#ctor(System.Type)">
143 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.KnownTypeAttribute" /> class with the specified type. </summary>
144 <param name="type">The <see cref="T:System.Type" /> that is included as a known type when serializing or deserializing data.</param>
146 <member name="P:System.Runtime.Serialization.KnownTypeAttribute.MethodName">
147 <summary>Gets the name of a method that will return a list of types that should be recognized during serialization or deserialization. </summary>
148 <returns>A <see cref="T:System.String" /> that contains the name of the method on the type defined by the <see cref="T:System.Runtime.Serialization.KnownTypeAttribute" /> class. </returns>
150 <member name="P:System.Runtime.Serialization.KnownTypeAttribute.Type">
151 <summary>Gets the type that should be recognized during serialization or deserialization by the <see cref="T:System.Runtime.Serialization.DataContractSerializer" />. </summary>
152 <returns>The <see cref="T:System.Type" /> that is used during serialization or deserialization. </returns>
154 <member name="T:System.Runtime.Serialization.OnDeserializedAttribute">
155 <summary>When applied to a method, specifies that the method is called immediately after deserialization of an object in an object graph. The order of deserialization relative to other objects in the graph is non-deterministic.</summary>
157 <member name="M:System.Runtime.Serialization.OnDeserializedAttribute.#ctor">
158 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnDeserializedAttribute" /> class. </summary>
160 <member name="T:System.Runtime.Serialization.OnDeserializingAttribute">
161 <summary>When applied to a method, specifies that the method is called during deserialization of an object in an object graph. The order of deserialization relative to other objects in the graph is non-deterministic.</summary>
163 <member name="M:System.Runtime.Serialization.OnDeserializingAttribute.#ctor">
164 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnDeserializingAttribute" /> class. </summary>
166 <member name="T:System.Runtime.Serialization.OnSerializedAttribute">
167 <summary>When applied to a method, specifies that the method is called after serialization of an object in an object graph. The order of serialization relative to other objects in the graph is non-deterministic.</summary>
169 <member name="M:System.Runtime.Serialization.OnSerializedAttribute.#ctor">
170 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnSerializedAttribute" /> class. </summary>
172 <member name="T:System.Runtime.Serialization.OnSerializingAttribute">
173 <summary>When applied to a method, specifies that the method is during serialization of an object in an object graph. The order of serialization relative to other objects in the graph is non-deterministic.</summary>
175 <member name="M:System.Runtime.Serialization.OnSerializingAttribute.#ctor">
176 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnSerializingAttribute" /> class. </summary>
178 <member name="T:System.Runtime.Serialization.SerializationException">
179 <summary>The exception thrown when an error occurs during serialization or deserialization.</summary>
181 <member name="M:System.Runtime.Serialization.SerializationException.#ctor">
182 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.SerializationException" /> class with default properties.</summary>
184 <member name="M:System.Runtime.Serialization.SerializationException.#ctor(System.String)">
185 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.SerializationException" /> class with a specified message.</summary>
186 <param name="message">Indicates the reason why the exception occurred. </param>
188 <member name="M:System.Runtime.Serialization.SerializationException.#ctor(System.String,System.Exception)">
189 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.SerializationException" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
190 <param name="message">The error message that explains the reason for the exception. </param>
191 <param name="innerException">The exception that is the cause of the current exception. If the <paramref name="innerException" /> parameter is not null, the current exception is raised in a catch block that handles the inner exception. </param>
193 <member name="T:System.Runtime.Serialization.StreamingContext">
194 <summary>Describes the source and destination of a given serialized stream, and provides an additional caller-defined context.</summary>
196 <member name="M:System.Runtime.Serialization.StreamingContext.Equals(System.Object)">
197 <summary>Determines whether two <see cref="T:System.Runtime.Serialization.StreamingContext" /> instances contain the same values.</summary>
198 <returns>true if the specified object is an instance of <see cref="T:System.Runtime.Serialization.StreamingContext" /> and equals the value of the current instance; otherwise, false.</returns>
199 <param name="obj">An object to compare with the current instance. </param>
201 <member name="M:System.Runtime.Serialization.StreamingContext.GetHashCode">
202 <summary>Returns a hash code of this object.</summary>
203 <returns>The <see cref="T:System.Runtime.Serialization.StreamingContextStates" /> value that contains the source or destination of the serialization for this <see cref="T:System.Runtime.Serialization.StreamingContext" />.</returns>