1 <?xml version="1.0" encoding="utf-8"?><doc>
3 <name>System.Runtime.Serialization.Primitives</name>
6 <member name="T:System.Runtime.Serialization.StreamingContext">
7 <summary>Describes the source and destination of a given serialized stream, and provides an additional caller-defined context.</summary>
9 <member name="M:System.Runtime.Serialization.StreamingContext.Equals(System.Object)">
10 <summary>Determines whether two <see cref="T:System.Runtime.Serialization.StreamingContext"></see> instances contain the same values.</summary>
11 <param name="obj">An object to compare with the current instance.</param>
12 <returns><see langword="true"></see> if the specified object is an instance of <see cref="T:System.Runtime.Serialization.StreamingContext"></see> and equals the value of the current instance; otherwise, <see langword="false"></see>.</returns>
14 <member name="M:System.Runtime.Serialization.StreamingContext.GetHashCode">
15 <summary>Returns a hash code of this object.</summary>
16 <returns>The <see cref="T:System.Runtime.Serialization.StreamingContextStates"></see> value that contains the source or destination of the serialization for this <see cref="T:System.Runtime.Serialization.StreamingContext"></see>.</returns>
18 <member name="T:System.Runtime.Serialization.SerializationException">
19 <summary>The exception thrown when an error occurs during serialization or deserialization.</summary>
21 <member name="M:System.Runtime.Serialization.SerializationException.#ctor">
22 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.SerializationException"></see> class with default properties.</summary>
24 <member name="M:System.Runtime.Serialization.SerializationException.#ctor(System.String)">
25 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.SerializationException"></see> class with a specified message.</summary>
26 <param name="message">Indicates the reason why the exception occurred.</param>
28 <member name="M:System.Runtime.Serialization.SerializationException.#ctor(System.String,System.Exception)">
29 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.SerializationException"></see> class with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
30 <param name="message">The error message that explains the reason for the exception.</param>
31 <param name="innerException">The exception that is the cause of the current exception. If the innerException parameter is not <see langword="null"></see>, the current exception is raised in a <see langword="catch"></see> block that handles the inner exception.</param>
33 <member name="T:System.Runtime.Serialization.OnSerializingAttribute">
34 <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>
36 <member name="M:System.Runtime.Serialization.OnSerializingAttribute.#ctor">
37 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnSerializingAttribute"></see> class.</summary>
39 <member name="T:System.Runtime.Serialization.OnSerializedAttribute">
40 <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>
42 <member name="M:System.Runtime.Serialization.OnSerializedAttribute.#ctor">
43 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnSerializedAttribute"></see> class.</summary>
45 <member name="T:System.Runtime.Serialization.OnDeserializingAttribute">
46 <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>
48 <member name="M:System.Runtime.Serialization.OnDeserializingAttribute.#ctor">
49 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnDeserializingAttribute"></see> class.</summary>
51 <member name="T:System.Runtime.Serialization.OnDeserializedAttribute">
52 <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>
54 <member name="M:System.Runtime.Serialization.OnDeserializedAttribute.#ctor">
55 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnDeserializedAttribute"></see> class.</summary>
57 <member name="T:System.Runtime.Serialization.KnownTypeAttribute">
58 <summary>Specifies types that should be recognized by the <see cref="T:System.Runtime.Serialization.DataContractSerializer"></see> when serializing or deserializing a given type.</summary>
60 <member name="M:System.Runtime.Serialization.KnownTypeAttribute.#ctor(System.String)">
61 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.KnownTypeAttribute"></see> class with the name of a method that returns an <see cref="T:System.Collections.IEnumerable"></see> of known types.</summary>
62 <param name="methodName">The name of the method that returns an <see cref="T:System.Collections.IEnumerable"></see> of types used when serializing or deserializing data.</param>
64 <member name="M:System.Runtime.Serialization.KnownTypeAttribute.#ctor(System.Type)">
65 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.KnownTypeAttribute"></see> class with the specified type.</summary>
66 <param name="type">The <see cref="T:System.Type"></see> that is included as a known type when serializing or deserializing data.</param>
68 <member name="P:System.Runtime.Serialization.KnownTypeAttribute.MethodName">
69 <summary>Gets the name of a method that will return a list of types that should be recognized during serialization or deserialization.</summary>
70 <returns>A <see cref="T:System.String"></see> that contains the name of the method on the type defined by the <see cref="T:System.Runtime.Serialization.KnownTypeAttribute"></see> class.</returns>
72 <member name="P:System.Runtime.Serialization.KnownTypeAttribute.Type">
73 <summary>Gets the type that should be recognized during serialization or deserialization by the <see cref="T:System.Runtime.Serialization.DataContractSerializer"></see>.</summary>
74 <returns>The <see cref="T:System.Type"></see> that is used during serialization or deserialization.</returns>
76 <member name="T:System.Runtime.Serialization.ISerializationSurrogateProvider">
77 <summary>Provides the methods needed to construct a serialization surrogate that extends the <see cref="T:System.Runtime.Serialization.DataContractSerializer"></see>. A serialization surrogate is used during serialization and deserialization to substitute one type for another.</summary>
79 <member name="M:System.Runtime.Serialization.ISerializationSurrogateProvider.GetDeserializedObject(System.Object,System.Type)">
80 <summary>During deserialization, returns an object that is a substitute for the specified object.</summary>
81 <param name="obj">The deserialized object to be substituted.</param>
82 <param name="targetType">The <see cref="T:System.Type"></see> that the substituted object should be assigned to.</param>
83 <returns>The substituted deserialized object.</returns>
85 <member name="M:System.Runtime.Serialization.ISerializationSurrogateProvider.GetObjectToSerialize(System.Object,System.Type)">
86 <summary>During serialization, returns an object that substitutes the specified object.</summary>
87 <param name="obj">The object to substitute.</param>
88 <param name="targetType">The <see cref="T:System.Type"></see> that the substituted object should be assigned to.</param>
89 <returns>The substituted object that will be serialized.</returns>
91 <member name="M:System.Runtime.Serialization.ISerializationSurrogateProvider.GetSurrogateType(System.Type)">
92 <summary>During serialization, deserialization, and schema import and export, returns a data contract type that substitutes the specified type.</summary>
93 <param name="type">The type to substitute.</param>
94 <returns>The <see cref="T:System.Type"></see> to substitute for the <paramref name="type">type</paramref> value.</returns>
96 <member name="T:System.Runtime.Serialization.InvalidDataContractException">
97 <summary>The exception that is thrown when the <see cref="T:System.Runtime.Serialization.DataContractSerializer"></see> or <see cref="T:System.Runtime.Serialization.NetDataContractSerializer"></see> encounters an invalid data contract during serialization and deserialization.</summary>
99 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor">
100 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException"></see> class.</summary>
102 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.String)">
103 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException"></see> class with the specified error message.</summary>
104 <param name="message">A description of the error.</param>
106 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
107 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException"></see> class with the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"></see> and <see cref="T:System.Runtime.Serialization.StreamingContext"></see>.</summary>
108 <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"></see> that contains data needed to serialize and deserialize an object.</param>
109 <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"></see> that specifies user context during serialization and deserialization.</param>
111 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.String,System.Exception)">
112 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException"></see> class with the specified error message and inner exception.</summary>
113 <param name="message">A description of the error.</param>
114 <param name="innerException">The original <see cref="T:System.Exception"></see>.</param>
116 <member name="T:System.Runtime.Serialization.IgnoreDataMemberAttribute">
117 <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>
119 <member name="M:System.Runtime.Serialization.IgnoreDataMemberAttribute.#ctor">
120 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.IgnoreDataMemberAttribute"></see> class.</summary>
122 <member name="T:System.Runtime.Serialization.EnumMemberAttribute">
123 <summary>Specifies that the field is an enumeration member and should be serialized.</summary>
125 <member name="M:System.Runtime.Serialization.EnumMemberAttribute.#ctor">
126 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.EnumMemberAttribute"></see> class.</summary>
128 <member name="P:System.Runtime.Serialization.EnumMemberAttribute.IsValueSetExplicitly">
129 <summary>Gets whether the <see cref="P:System.Runtime.Serialization.EnumMemberAttribute.Value"></see> has been explicitly set.</summary>
130 <returns><see langword="true"></see> if the value has been explicitly set; otherwise, <see langword="false"></see>.</returns>
132 <member name="P:System.Runtime.Serialization.EnumMemberAttribute.Value">
133 <summary>Gets or sets the value associated with the enumeration member the attribute is applied to.</summary>
134 <returns>The value associated with the enumeration member.</returns>
136 <member name="T:System.Runtime.Serialization.DataMemberAttribute">
137 <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"></see>.</summary>
139 <member name="M:System.Runtime.Serialization.DataMemberAttribute.#ctor">
140 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.DataMemberAttribute"></see> class.</summary>
142 <member name="P:System.Runtime.Serialization.DataMemberAttribute.EmitDefaultValue">
143 <summary>Gets or sets a value that specifies whether to serialize the default value for a field or property being serialized.</summary>
144 <returns><see langword="true"></see> if the default value for a member should be generated in the serialization stream; otherwise, <see langword="false"></see>. The default is <see langword="true"></see>.</returns>
146 <member name="P:System.Runtime.Serialization.DataMemberAttribute.IsNameSetExplicitly">
147 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataMemberAttribute.Name"></see> has been explicitly set.</summary>
148 <returns>Returns <see langword="true"></see> if the name has been explicitly set; otherwise, <see langword="false"></see>.</returns>
150 <member name="P:System.Runtime.Serialization.DataMemberAttribute.IsRequired">
151 <summary>Gets or sets a value that instructs the serialization engine that the member must be present when reading or deserializing.</summary>
152 <returns><see langword="true"></see>, if the member is required; otherwise, <see langword="false"></see>.</returns>
153 <exception cref="T:System.Runtime.Serialization.SerializationException">the member is not present.</exception>
155 <member name="P:System.Runtime.Serialization.DataMemberAttribute.Name">
156 <summary>Gets or sets a data member name.</summary>
157 <returns>The name of the data member. The default is the name of the target that the attribute is applied to.</returns>
159 <member name="P:System.Runtime.Serialization.DataMemberAttribute.Order">
160 <summary>Gets or sets the order of serialization and deserialization of a member.</summary>
161 <returns>The numeric order of serialization or deserialization.</returns>
163 <member name="T:System.Runtime.Serialization.DataContractAttribute">
164 <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"></see>. To make their type serializable, type authors must define a data contract for their type.</summary>
166 <member name="M:System.Runtime.Serialization.DataContractAttribute.#ctor">
167 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.DataContractAttribute"></see> class.</summary>
169 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsNameSetExplicitly">
170 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataContractAttribute.Name"></see> has been explicitly set.</summary>
171 <returns>Returns <see langword="true"></see> if the name has been explicitly set; otherwise, <see langword="false"></see>.</returns>
173 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsNamespaceSetExplicitly">
174 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataContractAttribute.Namespace"></see> has been explicitly set.</summary>
175 <returns>Returns <see langword="true"></see> if the namespace has been explicitly set; otherwise, <see langword="false"></see>.</returns>
177 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsReference">
178 <summary>Gets or sets a value that indicates whether to preserve object reference data.</summary>
179 <returns><see langword="true"></see> to keep object reference data using standard XML; otherwise, <see langword="false"></see>. The default is <see langword="false"></see>.</returns>
181 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsReferenceSetExplicitly">
182 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataContractAttribute.IsReference"></see> has been explicitly set.</summary>
183 <returns><see langword="true"></see> if the reference has been explicitly set; otherwise, <see langword="false"></see>.</returns>
185 <member name="P:System.Runtime.Serialization.DataContractAttribute.Name">
186 <summary>Gets or sets the name of the data contract for the type.</summary>
187 <returns>The local name of a data contract. The default is the name of the class that the attribute is applied to.</returns>
189 <member name="P:System.Runtime.Serialization.DataContractAttribute.Namespace">
190 <summary>Gets or sets the namespace for the data contract for the type.</summary>
191 <returns>The namespace of the contract.</returns>
193 <member name="T:System.Runtime.Serialization.ContractNamespaceAttribute">
194 <summary>Specifies the CLR namespace and XML namespace of the data contract.</summary>
196 <member name="M:System.Runtime.Serialization.ContractNamespaceAttribute.#ctor(System.String)">
197 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.ContractNamespaceAttribute"></see> class using the supplied namespace.</summary>
198 <param name="contractNamespace">The namespace of the contract.</param>
200 <member name="P:System.Runtime.Serialization.ContractNamespaceAttribute.ClrNamespace">
201 <summary>Gets or sets the CLR namespace of the data contract type.</summary>
202 <returns>The CLR-legal namespace of a type.</returns>
204 <member name="P:System.Runtime.Serialization.ContractNamespaceAttribute.ContractNamespace">
205 <summary>Gets the namespace of the data contract members.</summary>
206 <returns>The namespace of the data contract members.</returns>
208 <member name="T:System.Runtime.Serialization.CollectionDataContractAttribute">
209 <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"></see> as valid, serializable collections.</summary>
211 <member name="M:System.Runtime.Serialization.CollectionDataContractAttribute.#ctor">
212 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.CollectionDataContractAttribute"></see> class.</summary>
214 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsItemNameSetExplicitly">
215 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.ItemName"></see> has been explicitly set.</summary>
216 <returns>Returns <see langword="true"></see> if the item name has been explicitly set; otherwise, <see langword="false"></see>.</returns>
218 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsKeyNameSetExplicitly">
219 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.KeyName"></see> has been explicitly set.</summary>
220 <returns>Returns <see langword="true"></see> if the key name has been explicitly set; otherwise, <see langword="false"></see>.</returns>
222 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsNameSetExplicitly">
223 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.Name"></see> has been explicitly set.</summary>
224 <returns>Returns <see langword="true"></see> if the name has been explicitly set; otherwise, <see langword="false"></see>.</returns>
226 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsNamespaceSetExplicitly">
227 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.Namespace"></see> has been explicitly set.</summary>
228 <returns>Returns <see langword="true"></see> if the item namespace has been explicitly set; otherwise, <see langword="false"></see>.</returns>
230 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsReference">
231 <summary>Gets or sets a value that indicates whether to preserve object reference data.</summary>
232 <returns><see langword="true"></see> to keep object reference data; otherwise, <see langword="false"></see>. The default is <see langword="false"></see>.</returns>
234 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsReferenceSetExplicitly">
235 <summary>Gets whether reference has been explicitly set.</summary>
236 <returns>Returns <see langword="true"></see> if the reference has been explicitly set; otherwise, <see langword="false"></see>.</returns>
238 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsValueNameSetExplicitly">
239 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.ValueName"></see> has been explicitly set.</summary>
240 <returns>Returns <see langword="true"></see> if the value name has been explicitly set; otherwise, <see langword="false"></see>.</returns>
242 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.ItemName">
243 <summary>Gets or sets a custom name for a collection element.</summary>
244 <returns>The name to apply to collection elements.</returns>
246 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.KeyName">
247 <summary>Gets or sets the custom name for a dictionary key name.</summary>
248 <returns>The name to use instead of the default dictionary key name.</returns>
250 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.Name">
251 <summary>Gets or sets the data contract name for the collection type.</summary>
252 <returns>The data contract name for the collection type.</returns>
254 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.Namespace">
255 <summary>Gets or sets the namespace for the data contract.</summary>
256 <returns>The namespace of the data contract.</returns>
258 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.ValueName">
259 <summary>Gets or sets the custom name for a dictionary value name.</summary>
260 <returns>The name to use instead of the default dictionary value name.</returns>