1 <?xml version="1.0" encoding="utf-8"?><doc>
3 <name>System.Runtime.Serialization.Primitives</name>
6 <member name="T:System.Runtime.Serialization.IgnoreDataMemberAttribute">
7 <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>
9 <member name="M:System.Runtime.Serialization.IgnoreDataMemberAttribute.#ctor">
10 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.IgnoreDataMemberAttribute"></see> class.</summary>
12 <member name="T:System.Runtime.Serialization.InvalidDataContractException">
13 <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>
15 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor">
16 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException"></see> class.</summary>
18 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.String)">
19 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException"></see> class with the specified error message.</summary>
20 <param name="message">A description of the error.</param>
22 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
23 <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>
24 <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"></see> that contains data needed to serialize and deserialize an object.</param>
25 <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"></see> that specifies user context during serialization and deserialization.</param>
27 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.String,System.Exception)">
28 <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>
29 <param name="message">A description of the error.</param>
30 <param name="innerException">The original <see cref="T:System.Exception"></see>.</param>
32 <member name="T:System.Runtime.Serialization.ISerializationSurrogateProvider">
33 <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>
35 <member name="M:System.Runtime.Serialization.ISerializationSurrogateProvider.GetDeserializedObject(System.Object,System.Type)">
36 <summary>During deserialization, returns an object that is a substitute for the specified object.</summary>
37 <param name="obj">The deserialized object to be substituted.</param>
38 <param name="targetType">The <see cref="T:System.Type"></see> that the substituted object should be assigned to.</param>
39 <returns>The substituted deserialized object.</returns>
41 <member name="M:System.Runtime.Serialization.ISerializationSurrogateProvider.GetObjectToSerialize(System.Object,System.Type)">
42 <summary>During serialization, returns an object that substitutes the specified object.</summary>
43 <param name="obj">The object to substitute.</param>
44 <param name="targetType">The <see cref="T:System.Type"></see> that the substituted object should be assigned to.</param>
45 <returns>The substituted object that will be serialized.</returns>
47 <member name="M:System.Runtime.Serialization.ISerializationSurrogateProvider.GetSurrogateType(System.Type)">
48 <summary>During serialization, deserialization, and schema import and export, returns a data contract type that substitutes the specified type.</summary>
49 <param name="type">The type to substitute.</param>
50 <returns>The <see cref="System.Type"></see> to substitute for the <paramref name="type">type</paramref> value.</returns>
52 <member name="T:System.Runtime.Serialization.KnownTypeAttribute">
53 <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>
55 <member name="M:System.Runtime.Serialization.KnownTypeAttribute.#ctor(System.String)">
56 <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>
57 <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>
59 <member name="M:System.Runtime.Serialization.KnownTypeAttribute.#ctor(System.Type)">
60 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.KnownTypeAttribute"></see> class with the specified type.</summary>
61 <param name="type">The <see cref="T:System.Type"></see> that is included as a known type when serializing or deserializing data.</param>
63 <member name="P:System.Runtime.Serialization.KnownTypeAttribute.MethodName">
64 <summary>Gets the name of a method that will return a list of types that should be recognized during serialization or deserialization.</summary>
65 <returns>A <see cref="System.String"></see> that contains the name of the method on the type defined by the <see cref="System.Runtime.Serialization.KnownTypeAttribute"></see> class.</returns>
67 <member name="P:System.Runtime.Serialization.KnownTypeAttribute.Type">
68 <summary>Gets the type that should be recognized during serialization or deserialization by the <see cref="T:System.Runtime.Serialization.DataContractSerializer"></see>.</summary>
69 <returns>The <see cref="System.Type"></see> that is used during serialization or deserialization.</returns>
71 <member name="T:System.Runtime.Serialization.OnDeserializedAttribute">
72 <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>
74 <member name="M:System.Runtime.Serialization.OnDeserializedAttribute.#ctor">
75 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnDeserializedAttribute"></see> class.</summary>
77 <member name="T:System.Runtime.Serialization.OnDeserializingAttribute">
78 <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>
80 <member name="M:System.Runtime.Serialization.OnDeserializingAttribute.#ctor">
81 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnDeserializingAttribute"></see> class.</summary>
83 <member name="T:System.Runtime.Serialization.OnSerializedAttribute">
84 <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>
86 <member name="M:System.Runtime.Serialization.OnSerializedAttribute.#ctor">
87 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnSerializedAttribute"></see> class.</summary>
89 <member name="T:System.Runtime.Serialization.OnSerializingAttribute">
90 <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>
92 <member name="M:System.Runtime.Serialization.OnSerializingAttribute.#ctor">
93 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnSerializingAttribute"></see> class.</summary>
95 <member name="T:System.Runtime.Serialization.SerializationException">
96 <summary>The exception thrown when an error occurs during serialization or deserialization.</summary>
98 <member name="M:System.Runtime.Serialization.SerializationException.#ctor">
99 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.SerializationException"></see> class with default properties.</summary>
101 <member name="M:System.Runtime.Serialization.SerializationException.#ctor(System.String)">
102 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.SerializationException"></see> class with a specified message.</summary>
103 <param name="message">Indicates the reason why the exception occurred.</param>
105 <member name="M:System.Runtime.Serialization.SerializationException.#ctor(System.String,System.Exception)">
106 <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>
107 <param name="message">The error message that explains the reason for the exception.</param>
108 <param name="innerException">The exception that is the cause of the current exception. If the innerException parameter is not null, the current exception is raised in a catch block that handles the inner exception.</param>
110 <member name="T:System.Runtime.Serialization.StreamingContext">
111 <summary>Describes the source and destination of a given serialized stream, and provides an additional caller-defined context.</summary>
113 <member name="M:System.Runtime.Serialization.StreamingContext.Equals(System.Object)">
114 <summary>Determines whether two <see cref="T:System.Runtime.Serialization.StreamingContext"></see> instances contain the same values.</summary>
115 <param name="obj">An object to compare with the current instance.</param>
116 <returns>true if the specified object is an instance of <see cref="System.Runtime.Serialization.StreamingContext"></see> and equals the value of the current instance; otherwise, false.</returns>
118 <member name="M:System.Runtime.Serialization.StreamingContext.GetHashCode">
119 <summary>Returns a hash code of this object.</summary>
120 <returns>The <see cref="System.Runtime.Serialization.StreamingContextStates"></see> value that contains the source or destination of the serialization for this <see cref="System.Runtime.Serialization.StreamingContext"></see>.</returns>
122 <member name="T:System.Runtime.Serialization.CollectionDataContractAttribute">
123 <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>
125 <member name="M:System.Runtime.Serialization.CollectionDataContractAttribute.#ctor">
126 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.CollectionDataContractAttribute"></see> class.</summary>
128 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsItemNameSetExplicitly">
129 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.ItemName"></see> has been explicitly set.</summary>
130 <returns>Returns true if the item name has been explicitly set; otherwise, false.</returns>
132 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsKeyNameSetExplicitly">
133 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.KeyName"></see> has been explicitly set.</summary>
134 <returns>Returns true if the key name has been explicitly set; otherwise, false.</returns>
136 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsNameSetExplicitly">
137 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.Name"></see> has been explicitly set.</summary>
138 <returns>Returns true if the name has been explicitly set; otherwise, false.</returns>
140 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsNamespaceSetExplicitly">
141 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.Namespace"></see> has been explicitly set.</summary>
142 <returns>Returns true if the item namespace has been explicitly set; otherwise, false.</returns>
144 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsReference">
145 <summary>Gets or sets a value that indicates whether to preserve object reference data.</summary>
146 <returns>true to keep object reference data; otherwise, false. The default is false.</returns>
148 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsReferenceSetExplicitly">
149 <summary>Gets whether reference has been explicitly set.</summary>
150 <returns>Returns true if the reference has been explicitly set; otherwise, false.</returns>
152 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsValueNameSetExplicitly">
153 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.ValueName"></see> has been explicitly set.</summary>
154 <returns>Returns true if the value name has been explicitly set; otherwise, false.</returns>
156 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.ItemName">
157 <summary>Gets or sets a custom name for a collection element.</summary>
158 <returns>The name to apply to collection elements.</returns>
160 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.KeyName">
161 <summary>Gets or sets the custom name for a dictionary key name.</summary>
162 <returns>The name to use instead of the default dictionary key name.</returns>
164 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.Name">
165 <summary>Gets or sets the data contract name for the collection type.</summary>
166 <returns>The data contract name for the collection type.</returns>
168 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.Namespace">
169 <summary>Gets or sets the namespace for the data contract.</summary>
170 <returns>The namespace of the data contract.</returns>
172 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.ValueName">
173 <summary>Gets or sets the custom name for a dictionary value name.</summary>
174 <returns>The name to use instead of the default dictionary value name.</returns>
176 <member name="T:System.Runtime.Serialization.ContractNamespaceAttribute">
177 <summary>Specifies the CLR namespace and XML namespace of the data contract.</summary>
179 <member name="M:System.Runtime.Serialization.ContractNamespaceAttribute.#ctor(System.String)">
180 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.ContractNamespaceAttribute"></see> class using the supplied namespace.</summary>
181 <param name="contractNamespace">The namespace of the contract.</param>
183 <member name="P:System.Runtime.Serialization.ContractNamespaceAttribute.ClrNamespace">
184 <summary>Gets or sets the CLR namespace of the data contract type.</summary>
185 <returns>The CLR-legal namespace of a type.</returns>
187 <member name="P:System.Runtime.Serialization.ContractNamespaceAttribute.ContractNamespace">
188 <summary>Gets the namespace of the data contract members.</summary>
189 <returns>The namespace of the data contract members.</returns>
191 <member name="T:System.Runtime.Serialization.DataContractAttribute">
192 <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>
194 <member name="M:System.Runtime.Serialization.DataContractAttribute.#ctor">
195 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.DataContractAttribute"></see> class.</summary>
197 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsNameSetExplicitly">
198 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataContractAttribute.Name"></see> has been explicitly set.</summary>
199 <returns>Returns true if the name has been explicitly set; otherwise, false.</returns>
201 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsNamespaceSetExplicitly">
202 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataContractAttribute.Namespace"></see> has been explicitly set.</summary>
203 <returns>Returns true if the namespace has been explicitly set; otherwise, false.</returns>
205 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsReference">
206 <summary>Gets or sets a value that indicates whether to preserve object reference data.</summary>
207 <returns>true to keep object reference data using standard XML; otherwise, false. The default is false.</returns>
209 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsReferenceSetExplicitly">
210 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataContractAttribute.IsReference"></see> has been explicitly set.</summary>
211 <returns>true if the reference has been explicitly set; otherwise, false.</returns>
213 <member name="P:System.Runtime.Serialization.DataContractAttribute.Name">
214 <summary>Gets or sets the name of the data contract for the type.</summary>
215 <returns>The local name of a data contract. The default is the name of the class that the attribute is applied to.</returns>
217 <member name="P:System.Runtime.Serialization.DataContractAttribute.Namespace">
218 <summary>Gets or sets the namespace for the data contract for the type.</summary>
219 <returns>The namespace of the contract.</returns>
221 <member name="T:System.Runtime.Serialization.DataMemberAttribute">
222 <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>
224 <member name="M:System.Runtime.Serialization.DataMemberAttribute.#ctor">
225 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.DataMemberAttribute"></see> class.</summary>
227 <member name="P:System.Runtime.Serialization.DataMemberAttribute.EmitDefaultValue">
228 <summary>Gets or sets a value that specifies whether to serialize the default value for a field or property being serialized.</summary>
229 <returns>true if the default value for a member should be generated in the serialization stream; otherwise, false. The default is true.</returns>
231 <member name="P:System.Runtime.Serialization.DataMemberAttribute.IsNameSetExplicitly">
232 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataMemberAttribute.Name"></see> has been explicitly set.</summary>
233 <returns>Returns true if the name has been explicitly set; otherwise, false.</returns>
235 <member name="P:System.Runtime.Serialization.DataMemberAttribute.IsRequired">
236 <summary>Gets or sets a value that instructs the serialization engine that the member must be present when reading or deserializing.</summary>
237 <returns>true, if the member is required; otherwise, false.</returns>
238 <exception cref="T:System.Runtime.Serialization.SerializationException">the member is not present.</exception>
240 <member name="P:System.Runtime.Serialization.DataMemberAttribute.Name">
241 <summary>Gets or sets a data member name.</summary>
242 <returns>The name of the data member. The default is the name of the target that the attribute is applied to.</returns>
244 <member name="P:System.Runtime.Serialization.DataMemberAttribute.Order">
245 <summary>Gets or sets the order of serialization and deserialization of a member.</summary>
246 <returns>The numeric order of serialization or deserialization.</returns>
248 <member name="T:System.Runtime.Serialization.EnumMemberAttribute">
249 <summary>Specifies that the field is an enumeration member and should be serialized.</summary>
251 <member name="M:System.Runtime.Serialization.EnumMemberAttribute.#ctor">
252 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.EnumMemberAttribute"></see> class.</summary>
254 <member name="P:System.Runtime.Serialization.EnumMemberAttribute.IsValueSetExplicitly">
255 <summary>Gets whether the <see cref="P:System.Runtime.Serialization.EnumMemberAttribute.Value"></see> has been explicitly set.</summary>
256 <returns>true if the value has been explicitly set; otherwise, false.</returns>
258 <member name="P:System.Runtime.Serialization.EnumMemberAttribute.Value">
259 <summary>Gets or sets the value associated with the enumeration member the attribute is applied to.</summary>
260 <returns>The value associated with the enumeration member.</returns>