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">
14 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.ItemName" /> has been explicitly set.</summary>
16 <see langword="true" /> if the item name has been explicitly set; otherwise, <see langword="false" />.</returns>
18 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsKeyNameSetExplicitly">
19 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.KeyName" /> has been explicitly set.</summary>
21 <see langword="true" /> if the key name has been explicitly set; otherwise, <see langword="false" />.</returns>
23 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsNameSetExplicitly">
24 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.Name" /> has been explicitly set.</summary>
26 <see langword="true" /> if the name has been explicitly set; otherwise, <see langword="false" />.</returns>
28 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsNamespaceSetExplicitly">
29 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.Namespace" /> has been explicitly set.</summary>
31 <see langword="true" /> if the item namespace has been explicitly set; otherwise, <see langword="false" />.</returns>
33 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsReference">
34 <summary>Gets or sets a value that indicates whether to preserve object reference data.</summary>
36 <see langword="true" /> to keep object reference data; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
38 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsReferenceSetExplicitly">
39 <summary>Gets whether reference has been explicitly set.</summary>
41 <see langword="true" /> if the reference has been explicitly set; otherwise, <see langword="false" />.</returns>
43 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.IsValueNameSetExplicitly">
44 <summary>Gets whether <see cref="P:System.Runtime.Serialization.CollectionDataContractAttribute.ValueName" /> has been explicitly set.</summary>
46 <see langword="true" /> if the value name has been explicitly set; otherwise, <see langword="false" />.</returns>
48 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.ItemName">
49 <summary>Gets or sets a custom name for a collection element.</summary>
50 <returns>The name to apply to collection elements.</returns>
52 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.KeyName">
53 <summary>Gets or sets the custom name for a dictionary key name.</summary>
54 <returns>The name to use instead of the default dictionary key name.</returns>
56 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.Name">
57 <summary>Gets or sets the data contract name for the collection type.</summary>
58 <returns>The data contract name for the collection type.</returns>
60 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.Namespace">
61 <summary>Gets or sets the namespace for the data contract.</summary>
62 <returns>The namespace of the data contract.</returns>
64 <member name="P:System.Runtime.Serialization.CollectionDataContractAttribute.ValueName">
65 <summary>Gets or sets the custom name for a dictionary value name.</summary>
66 <returns>The name to use instead of the default dictionary value name.</returns>
68 <member name="T:System.Runtime.Serialization.ContractNamespaceAttribute">
69 <summary>Specifies the CLR namespace and XML namespace of the data contract.</summary>
71 <member name="M:System.Runtime.Serialization.ContractNamespaceAttribute.#ctor(System.String)">
72 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.ContractNamespaceAttribute" /> class using the supplied namespace.</summary>
73 <param name="contractNamespace">The namespace of the contract.</param>
75 <member name="P:System.Runtime.Serialization.ContractNamespaceAttribute.ClrNamespace">
76 <summary>Gets or sets the CLR namespace of the data contract type.</summary>
77 <returns>The CLR-legal namespace of a type.</returns>
79 <member name="P:System.Runtime.Serialization.ContractNamespaceAttribute.ContractNamespace">
80 <summary>Gets the namespace of the data contract members.</summary>
81 <returns>The namespace of the data contract members.</returns>
83 <member name="T:System.Runtime.Serialization.DataContractAttribute">
84 <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>
86 <member name="M:System.Runtime.Serialization.DataContractAttribute.#ctor">
87 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.DataContractAttribute" /> class.</summary>
89 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsNameSetExplicitly">
90 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataContractAttribute.Name" /> has been explicitly set.</summary>
92 <see langword="true" /> if the name has been explicitly set; otherwise, <see langword="false" />.</returns>
94 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsNamespaceSetExplicitly">
95 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataContractAttribute.Namespace" /> has been explicitly set.</summary>
97 <see langword="true" /> if the namespace has been explicitly set; otherwise, <see langword="false" />.</returns>
99 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsReference">
100 <summary>Gets or sets a value that indicates whether to preserve object reference data.</summary>
102 <see langword="true" /> to keep object reference data using standard XML; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
104 <member name="P:System.Runtime.Serialization.DataContractAttribute.IsReferenceSetExplicitly">
105 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataContractAttribute.IsReference" /> has been explicitly set.</summary>
107 <see langword="true" /> if the reference has been explicitly set; otherwise, <see langword="false" />.</returns>
109 <member name="P:System.Runtime.Serialization.DataContractAttribute.Name">
110 <summary>Gets or sets the name of the data contract for the type.</summary>
111 <returns>The local name of a data contract. The default is the name of the class that the attribute is applied to.</returns>
113 <member name="P:System.Runtime.Serialization.DataContractAttribute.Namespace">
114 <summary>Gets or sets the namespace for the data contract for the type.</summary>
115 <returns>The namespace of the contract.</returns>
117 <member name="T:System.Runtime.Serialization.DataMemberAttribute">
118 <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>
120 <member name="M:System.Runtime.Serialization.DataMemberAttribute.#ctor">
121 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.DataMemberAttribute" /> class.</summary>
123 <member name="P:System.Runtime.Serialization.DataMemberAttribute.EmitDefaultValue">
124 <summary>Gets or sets a value that specifies whether to serialize the default value for a field or property being serialized.</summary>
126 <see langword="true" /> if the default value for a member should be generated in the serialization stream; otherwise, <see langword="false" />. The default is <see langword="true" />.</returns>
128 <member name="P:System.Runtime.Serialization.DataMemberAttribute.IsNameSetExplicitly">
129 <summary>Gets whether <see cref="P:System.Runtime.Serialization.DataMemberAttribute.Name" /> has been explicitly set.</summary>
131 <see langword="true" /> if the name has been explicitly set; otherwise, <see langword="false" />.</returns>
133 <member name="P:System.Runtime.Serialization.DataMemberAttribute.IsRequired">
134 <summary>Gets or sets a value that instructs the serialization engine that the member must be present when reading or deserializing.</summary>
135 <exception cref="T:System.Runtime.Serialization.SerializationException">the member is not present.</exception>
137 <see langword="true" />, if the member is required; otherwise, <see langword="false" />.</returns>
139 <member name="P:System.Runtime.Serialization.DataMemberAttribute.Name">
140 <summary>Gets or sets a data member name.</summary>
141 <returns>The name of the data member. The default is the name of the target that the attribute is applied to.</returns>
143 <member name="P:System.Runtime.Serialization.DataMemberAttribute.Order">
144 <summary>Gets or sets the order of serialization and deserialization of a member.</summary>
145 <returns>The numeric order of serialization or deserialization.</returns>
147 <member name="T:System.Runtime.Serialization.EnumMemberAttribute">
148 <summary>Specifies that the field is an enumeration member and should be serialized.</summary>
150 <member name="M:System.Runtime.Serialization.EnumMemberAttribute.#ctor">
151 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.EnumMemberAttribute" /> class.</summary>
153 <member name="P:System.Runtime.Serialization.EnumMemberAttribute.IsValueSetExplicitly">
154 <summary>Gets whether the <see cref="P:System.Runtime.Serialization.EnumMemberAttribute.Value" /> has been explicitly set.</summary>
156 <see langword="true" /> if the value has been explicitly set; otherwise, <see langword="false" />.</returns>
158 <member name="P:System.Runtime.Serialization.EnumMemberAttribute.Value">
159 <summary>Gets or sets the value associated with the enumeration member the attribute is applied to.</summary>
160 <returns>The value associated with the enumeration member.</returns>
162 <member name="T:System.Runtime.Serialization.IgnoreDataMemberAttribute">
163 <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>
165 <member name="M:System.Runtime.Serialization.IgnoreDataMemberAttribute.#ctor">
166 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.IgnoreDataMemberAttribute" /> class.</summary>
168 <member name="T:System.Runtime.Serialization.InvalidDataContractException">
169 <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>
171 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor">
172 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException" /> class.</summary>
174 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
175 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException" /> class with the specified <see cref="T:System.Runtime.Serialization.SerializationInfo" /> and <see cref="T:System.Runtime.Serialization.StreamingContext" />.</summary>
176 <param name="info">A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that contains data needed to serialize and deserialize an object.</param>
177 <param name="context">A <see cref="T:System.Runtime.Serialization.StreamingContext" /> that specifies user context during serialization and deserialization.</param>
179 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.String)">
180 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException" /> class with the specified error message.</summary>
181 <param name="message">A description of the error.</param>
183 <member name="M:System.Runtime.Serialization.InvalidDataContractException.#ctor(System.String,System.Exception)">
184 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.InvalidDataContractException" /> class with the specified error message and inner exception.</summary>
185 <param name="message">A description of the error.</param>
186 <param name="innerException">The original <see cref="T:System.Exception" />.</param>
188 <member name="T:System.Runtime.Serialization.ISerializationSurrogateProvider">
189 <summary>Provides the methods needed to construct a serialization surrogate that extends the <see cref="T:System.Runtime.Serialization.DataContractSerializer" />. A serialization surrogate is used during serialization and deserialization to substitute one type for another.</summary>
191 <member name="M:System.Runtime.Serialization.ISerializationSurrogateProvider.GetDeserializedObject(System.Object,System.Type)">
192 <summary>During deserialization, returns an object that is a substitute for the specified object.</summary>
193 <param name="obj">The deserialized object to be substituted.</param>
194 <param name="targetType">The <see cref="T:System.Type" /> that the substituted object should be assigned to.</param>
195 <returns>The substituted deserialized object.</returns>
197 <member name="M:System.Runtime.Serialization.ISerializationSurrogateProvider.GetObjectToSerialize(System.Object,System.Type)">
198 <summary>During serialization, returns an object that substitutes the specified object.</summary>
199 <param name="obj">The object to substitute.</param>
200 <param name="targetType">The <see cref="T:System.Type" /> that the substituted object should be assigned to.</param>
201 <returns>The substituted object that will be serialized.</returns>
203 <member name="M:System.Runtime.Serialization.ISerializationSurrogateProvider.GetSurrogateType(System.Type)">
204 <summary>During serialization, deserialization, and schema import and export, returns a data contract type that substitutes the specified type.</summary>
205 <param name="type">The type to substitute.</param>
206 <returns>The <see cref="T:System.Type" /> to substitute for the <paramref name="type" /> value.</returns>
208 <member name="T:System.Runtime.Serialization.KnownTypeAttribute">
209 <summary>Specifies types that should be recognized by the <see cref="T:System.Runtime.Serialization.DataContractSerializer" /> when serializing or deserializing a given type.</summary>
211 <member name="M:System.Runtime.Serialization.KnownTypeAttribute.#ctor(System.String)">
212 <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>
213 <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>
215 <member name="M:System.Runtime.Serialization.KnownTypeAttribute.#ctor(System.Type)">
216 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Serialization.KnownTypeAttribute" /> class with the specified type.</summary>
217 <param name="type">The <see cref="T:System.Type" /> that is included as a known type when serializing or deserializing data.</param>
219 <member name="P:System.Runtime.Serialization.KnownTypeAttribute.MethodName">
220 <summary>Gets the name of a method that will return a list of types that should be recognized during serialization or deserialization.</summary>
221 <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>
223 <member name="P:System.Runtime.Serialization.KnownTypeAttribute.Type">
224 <summary>Gets the type that should be recognized during serialization or deserialization by the <see cref="T:System.Runtime.Serialization.DataContractSerializer" />.</summary>
225 <returns>The <see cref="T:System.Type" /> that is used during serialization or deserialization.</returns>