1 <?xml version="1.0" encoding="utf-8"?><span>
4 <name>System.Runtime.Serialization.Primitives</name>
7 <member name="T:System.Runtime.Serialization.DataMemberAttribute">
8 <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>
10 <member name="M:System.Runtime.Serialization.DataMemberAttribute.#ctor">
11 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.DataMemberAttribute"></see> class.</summary>
13 <member name="P:System.Runtime.Serialization.DataMemberAttribute.EmitDefaultValue">
14 <summary>Gets or sets a value that specifies whether to serialize the default value for a field or property being serialized.</summary>
15 <returns>true if the default value for a member should be generated in the serialization stream; otherwise, false. The default is true.</returns>
17 <member name="P:System.Runtime.Serialization.DataMemberAttribute.IsNameSetExplicitly">
18 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataMemberAttribute.Name"></see> has been explicitly set.</summary>
19 <returns>Returns true if the name has been explicitly set; otherwise, false.</returns>
21 <member name="P:System.Runtime.Serialization.DataMemberAttribute.IsRequired">
22 <summary>Gets or sets a value that instructs the serialization engine that the member must be present when reading or deserializing.</summary>
23 <returns>true, if the member is required; otherwise, false.</returns>
24 <exception cref="T:System.Runtime.Serialization.SerializationException">the member is not present.</exception>
26 <member name="P:System.Runtime.Serialization.DataMemberAttribute.Name">
27 <summary>Gets or sets a data member name.</summary>
28 <returns>The name of the data member. The default is the name of the target that the attribute is applied to.</returns>
30 <member name="P:System.Runtime.Serialization.DataMemberAttribute.Order">
31 <summary>Gets or sets the order of serialization and deserialization of a member.</summary>
32 <returns>The numeric order of serialization or deserialization.</returns>
34 <member name="T:System.Runtime.Serialization.EnumMemberAttribute">
35 <summary>Specifies that the field is an enumeration member and should be serialized.</summary>
37 <member name="M:System.Runtime.Serialization.EnumMemberAttribute.#ctor">
38 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.EnumMemberAttribute"></see> class.</summary>
40 <member name="P:System.Runtime.Serialization.EnumMemberAttribute.IsValueSetExplicitly">
41 <summary>Gets whether the <see cref="P:System.Runtime.Serialization.EnumMemberAttribute.Value"></see> has been explicitly set.</summary>
42 <returns>true if the value has been explicitly set; otherwise, false.</returns>
44 <member name="P:System.Runtime.Serialization.EnumMemberAttribute.Value">
45 <summary>Gets or sets the value associated with the enumeration member the attribute is applied to.</summary>
46 <returns>The value associated with the enumeration member.</returns>
48 <member name="T:System.Runtime.Serialization.IgnoreDataMemberAttribute">
49 <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>
51 <member name="M:System.Runtime.Serialization.IgnoreDataMemberAttribute.#ctor">
52 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.IgnoreDataMemberAttribute"></see> class.</summary>
54 <member name="T:System.Runtime.Serialization.InvalidDataContractException">
55 <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>
57 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor">
58 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException"></see> class.</summary>
60 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.String)">
61 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException"></see> class with the specified error message.</summary>
62 <param name="message">A description of the error.</param>
64 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
65 <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>
66 <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo"></see> that contains data needed to serialize and deserialize an object.</param>
67 <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext"></see> that specifies user context during serialization and deserialization.</param>
69 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.String,System.Exception)">
70 <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>
71 <param name="message">A description of the error.</param>
72 <param name="innerException">The original <see cref="T:System.Exception"></see>.</param>
74 <member name="T:System.Runtime.Serialization.ISerializationSurrogateProvider">
77 <member name="M:System.Runtime.Serialization.ISerializationSurrogateProvider.GetDeserializedObject(System.Object,System.Type)">
78 <param name="obj"></param>
79 <param name="targetType"></param>
82 <member name="M:System.Runtime.Serialization.ISerializationSurrogateProvider.GetObjectToSerialize(System.Object,System.Type)">
83 <param name="obj"></param>
84 <param name="targetType"></param>
87 <member name="M:System.Runtime.Serialization.ISerializationSurrogateProvider.GetSurrogateType(System.Type)">
88 <param name="type"></param>
91 <member name="T:System.Runtime.Serialization.KnownTypeAttribute">
92 <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>
94 <member name="M:System.Runtime.Serialization.KnownTypeAttribute.#ctor(System.String)">
95 <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>
96 <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>
98 <member name="M:System.Runtime.Serialization.KnownTypeAttribute.#ctor(System.Type)">
99 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.KnownTypeAttribute"></see> class with the specified type.</summary>
100 <param name="type">The <see cref="T:System.Type"></see> that is included as a known type when serializing or deserializing data.</param>
102 <member name="P:System.Runtime.Serialization.KnownTypeAttribute.MethodName">
103 <summary>Gets the name of a method that will return a list of types that should be recognized during serialization or deserialization.</summary>
104 <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>
106 <member name="P:System.Runtime.Serialization.KnownTypeAttribute.Type">
107 <summary>Gets the type that should be recognized during serialization or deserialization by the <see cref="T:System.Runtime.Serialization.DataContractSerializer"></see>.</summary>
108 <returns>The <see cref="T:System.Type"></see> that is used during serialization or deserialization.</returns>
110 <member name="T:System.Runtime.Serialization.OnDeserializedAttribute">
111 <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>
113 <member name="M:System.Runtime.Serialization.OnDeserializedAttribute.#ctor">
114 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnDeserializedAttribute"></see> class.</summary>
116 <member name="T:System.Runtime.Serialization.OnDeserializingAttribute">
117 <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>
119 <member name="M:System.Runtime.Serialization.OnDeserializingAttribute.#ctor">
120 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnDeserializingAttribute"></see> class.</summary>
122 <member name="T:System.Runtime.Serialization.OnSerializedAttribute">
123 <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>
125 <member name="M:System.Runtime.Serialization.OnSerializedAttribute.#ctor">
126 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnSerializedAttribute"></see> class.</summary>
128 <member name="T:System.Runtime.Serialization.OnSerializingAttribute">
129 <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>
131 <member name="M:System.Runtime.Serialization.OnSerializingAttribute.#ctor">
132 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.OnSerializingAttribute"></see> class.</summary>
134 <member name="T:System.Runtime.Serialization.SerializationException">
135 <summary>The exception thrown when an error occurs during serialization or deserialization.</summary>
137 <member name="M:System.Runtime.Serialization.SerializationException.#ctor">
138 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.SerializationException"></see> class with default properties.</summary>
140 <member name="M:System.Runtime.Serialization.SerializationException.#ctor(System.String)">
141 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.SerializationException"></see> class with a specified message.</summary>
142 <param name="message">Indicates the reason why the exception occurred.</param>
144 <member name="M:System.Runtime.Serialization.SerializationException.#ctor(System.String,System.Exception)">
145 <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>
146 <param name="message">The error message that explains the reason for the exception.</param>
147 <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>
149 <member name="T:System.Runtime.Serialization.StreamingContext">
150 <summary>Describes the source and destination of a given serialized stream, and provides an additional caller-defined context.</summary>
152 <member name="M:System.Runtime.Serialization.StreamingContext.Equals(System.Object)">
153 <summary>Determines whether two <see cref="T:System.Runtime.Serialization.StreamingContext"></see> instances contain the same values.</summary>
154 <param name="obj">An object to compare with the current instance.</param>
155 <returns>true 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, false.</returns>
157 <member name="M:System.Runtime.Serialization.StreamingContext.GetHashCode">
158 <summary>Returns a hash code of this object.</summary>
159 <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>
161 <member name="T:System.Runtime.Serialization.CollectionDataContractAttribute">
162 <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>
164 <member name="M:System.Runtime.Serialization.CollectionDataContractAttribute.#ctor">
165 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.CollectionDataContractAttribute"></see> class.</summary>
167 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsItemNameSetExplicitly">
168 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.ItemName"></see> has been explicitly set.</summary>
169 <returns>Returns true if the item name has been explicitly set; otherwise, false.</returns>
171 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsKeyNameSetExplicitly">
172 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.KeyName"></see> has been explicitly set.</summary>
173 <returns>Returns true if the key name has been explicitly set; otherwise, false.</returns>
175 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsNameSetExplicitly">
176 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.Name"></see> has been explicitly set.</summary>
177 <returns>Returns true if the name has been explicitly set; otherwise, false.</returns>
179 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsNamespaceSetExplicitly">
180 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.Namespace"></see> has been explicitly set.</summary>
181 <returns>Returns true if the item namespace has been explicitly set; otherwise, false.</returns>
183 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsReference">
184 <summary>Gets or sets a value that indicates whether to preserve object reference data.</summary>
185 <returns>true to keep object reference data; otherwise, false. The default is false.</returns>
187 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsReferenceSetExplicitly">
188 <summary>Gets whether reference has been explicitly set.</summary>
189 <returns>Returns true if the reference has been explicitly set; otherwise, false.</returns>
191 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsValueNameSetExplicitly">
192 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.ValueName"></see> has been explicitly set.</summary>
193 <returns>Returns true if the value name has been explicitly set; otherwise, false.</returns>
195 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.ItemName">
196 <summary>Gets or sets a custom name for a collection element.</summary>
197 <returns>The name to apply to collection elements.</returns>
199 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.KeyName">
200 <summary>Gets or sets the custom name for a dictionary key name.</summary>
201 <returns>The name to use instead of the default dictionary key name.</returns>
203 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.Name">
204 <summary>Gets or sets the data contract name for the collection type.</summary>
205 <returns>The data contract name for the collection type.</returns>
207 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.Namespace">
208 <summary>Gets or sets the namespace for the data contract.</summary>
209 <returns>The namespace of the data contract.</returns>
211 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.ValueName">
212 <summary>Gets or sets the custom name for a dictionary value name.</summary>
213 <returns>The name to use instead of the default dictionary value name.</returns>
215 <member name="T:System.Runtime.Serialization.ContractNamespaceAttribute">
216 <summary>Specifies the CLR namespace and XML namespace of the data contract.</summary>
218 <member name="M:System.Runtime.Serialization.ContractNamespaceAttribute.#ctor(System.String)">
219 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.ContractNamespaceAttribute"></see> class using the supplied namespace.</summary>
220 <param name="contractNamespace">The namespace of the contract.</param>
222 <member name="P:System.Runtime.Serialization.ContractNamespaceAttribute.ClrNamespace">
223 <summary>Gets or sets the CLR namespace of the data contract type.</summary>
224 <returns>The CLR-legal namespace of a type.</returns>
226 <member name="P:System.Runtime.Serialization.ContractNamespaceAttribute.ContractNamespace">
227 <summary>Gets the namespace of the data contract members.</summary>
228 <returns>The namespace of the data contract members.</returns>
230 <member name="T:System.Runtime.Serialization.DataContractAttribute">
231 <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>
233 <member name="M:System.Runtime.Serialization.DataContractAttribute.#ctor">
234 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.DataContractAttribute"></see> class.</summary>
236 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsNameSetExplicitly">
237 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataContractAttribute.Name"></see> has been explicitly set.</summary>
238 <returns>Returns true if the name has been explicitly set; otherwise, false.</returns>
240 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsNamespaceSetExplicitly">
241 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataContractAttribute.Namespace"></see> has been explicitly set.</summary>
242 <returns>Returns true if the namespace has been explicitly set; otherwise, false.</returns>
244 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsReference">
245 <summary>Gets or sets a value that indicates whether to preserve object reference data.</summary>
246 <returns>true to keep object reference data using standard XML; otherwise, false. The default is false.</returns>
248 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsReferenceSetExplicitly">
249 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataContractAttribute.IsReference"></see> has been explicitly set.</summary>
250 <returns>true if the reference has been explicitly set; otherwise, false.</returns>
252 <member name="P:System.Runtime.Serialization.DataContractAttribute.Name">
253 <summary>Gets or sets the name of the data contract for the type.</summary>
254 <returns>The local name of a data contract. The default is the name of the class that the attribute is applied to.</returns>
256 <member name="P:System.Runtime.Serialization.DataContractAttribute.Namespace">
257 <summary>Gets or sets the namespace for the data contract for the type.</summary>
258 <returns>The namespace of the contract.</returns>