Parent Directory
|
Revision Log
add debug files
1 | william | 11 | <?xml version="1.0"?> |
2 | <doc> | ||
3 | <assembly> | ||
4 | <name>s3pi.Interfaces</name> | ||
5 | </assembly> | ||
6 | <members> | ||
7 | <member name="T:s3pi.Interfaces.TGIBlock"> | ||
8 | <summary> | ||
9 | An implementation of AResourceKey that supports storing the Type, Group and Instance in any order. | ||
10 | </summary> | ||
11 | <remarks>An explicit implementation of <see cref="T:System.IEquatable`1"/> is required by | ||
12 | <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/> and <see cref="T:s3pi.Interfaces.TGIBlockList"/>.</remarks> | ||
13 | </member> | ||
14 | <member name="T:s3pi.Interfaces.AResourceKey"> | ||
15 | <summary> | ||
16 | An abstract class, extending <see cref="T:s3pi.Interfaces.AHandlerElement"/> and implementing <see cref="T:s3pi.Interfaces.IResourceKey"/>. | ||
17 | </summary> | ||
18 | </member> | ||
19 | <member name="T:s3pi.Interfaces.AHandlerElement"> | ||
20 | <summary> | ||
21 | A useful extension to <see cref="T:s3pi.Interfaces.AApiVersionedFields"/> where a change handler is required | ||
22 | </summary> | ||
23 | </member> | ||
24 | <member name="T:s3pi.Interfaces.AApiVersionedFields"> | ||
25 | <summary> | ||
26 | API Objects should all descend from this Abstract class. | ||
27 | It will provide versioning support -- when implemented. | ||
28 | It provides ContentFields support | ||
29 | </summary> | ||
30 | </member> | ||
31 | <member name="T:s3pi.Interfaces.IApiVersion"> | ||
32 | <summary> | ||
33 | Support for API versioning | ||
34 | </summary> | ||
35 | </member> | ||
36 | <member name="P:s3pi.Interfaces.IApiVersion.RequestedApiVersion"> | ||
37 | <summary> | ||
38 | The version of the API in use | ||
39 | </summary> | ||
40 | </member> | ||
41 | <member name="P:s3pi.Interfaces.IApiVersion.RecommendedApiVersion"> | ||
42 | <summary> | ||
43 | The best supported version of the API available | ||
44 | </summary> | ||
45 | </member> | ||
46 | <member name="T:s3pi.Interfaces.IContentFields"> | ||
47 | <summary> | ||
48 | Standardised interface to API objects (hiding the reflection) | ||
49 | </summary> | ||
50 | </member> | ||
51 | <member name="P:s3pi.Interfaces.IContentFields.ContentFields"> | ||
52 | <summary> | ||
53 | A <c>List<string></c> of available field names on object | ||
54 | </summary> | ||
55 | </member> | ||
56 | <member name="P:s3pi.Interfaces.IContentFields.Item(System.String)"> | ||
57 | <summary> | ||
58 | A <see cref="T:s3pi.Interfaces.TypedValue"/> on this object | ||
59 | </summary> | ||
60 | <param name="index">The <seealso cref="T:System.String"/> representing the name of the field | ||
61 | (i.e. one of the values from <see cref="P:s3pi.Interfaces.IContentFields.ContentFields"/>)</param> | ||
62 | <returns>The <see cref="T:s3pi.Interfaces.TypedValue"/> of field <paramref name="index"/> on this API object.</returns> | ||
63 | <exception cref="T:System.ArgumentOutOfRangeException">Thrown when an unknown index name is requested</exception> | ||
64 | </member> | ||
65 | <member name="F:s3pi.Interfaces.AApiVersionedFields.requestedApiVersion"> | ||
66 | <summary> | ||
67 | Versioning is not currently implemented | ||
68 | Set this to the version of the API requested on object creation | ||
69 | </summary> | ||
70 | </member> | ||
71 | <member name="M:s3pi.Interfaces.AApiVersionedFields.GetContentFields(System.Int32,System.Type)"> | ||
72 | <summary> | ||
73 | Versioning is not currently implemented | ||
74 | Return the list of fields for a given API Class | ||
75 | </summary> | ||
76 | <param name="APIversion">Set to 0 (== "best")</param> | ||
77 | <param name="t">The class type for which to get the fields</param> | ||
78 | <returns>List of field names for the given API version</returns> | ||
79 | </member> | ||
80 | <member name="M:s3pi.Interfaces.AApiVersionedFields.GetPriority(System.Type,System.String)"> | ||
81 | <summary> | ||
82 | Return the ElementPriority value for a Content Field | ||
83 | </summary> | ||
84 | <param name="t">Type on which Content Field exists</param> | ||
85 | <param name="index">Content Field name</param> | ||
86 | <returns>Int32.MaxValue if no ElementPriorityAttribute or Content Field not found; | ||
87 | otherwise the value of the ElementPriorityAttribute Priority field.</returns> | ||
88 | </member> | ||
89 | <member name="M:s3pi.Interfaces.AApiVersionedFields.ToString"> | ||
90 | <summary> | ||
91 | Returns a <see cref="T:System.String"/> that represents the current <see cref="T:s3pi.Interfaces.AApiVersionedFields"/> object. | ||
92 | </summary> | ||
93 | <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:s3pi.Interfaces.AApiVersionedFields"/> object.</returns> | ||
94 | </member> | ||
95 | <member name="M:s3pi.Interfaces.AApiVersionedFields.CompareByPriority(System.String,System.String)"> | ||
96 | <summary> | ||
97 | Sorts Content Field names by their <see cref="T:s3pi.Interfaces.ElementPriorityAttribute"/> (if set) | ||
98 | </summary> | ||
99 | <param name="x">First content field name</param> | ||
100 | <param name="y">Second content field name</param> | ||
101 | <returns>A signed number indicating the relative values of this instance and value.</returns> | ||
102 | </member> | ||
103 | <member name="M:s3pi.Interfaces.AApiVersionedFields.GetContentFieldTypes(System.Int32,System.Type)"> | ||
104 | <summary> | ||
105 | Gets a lookup table from fieldname to type. | ||
106 | </summary> | ||
107 | <param name="APIversion">Version of API to use</param> | ||
108 | <param name="t">API data type to query</param> | ||
109 | <returns></returns> | ||
110 | </member> | ||
111 | <member name="M:s3pi.Interfaces.AApiVersionedFields.FOURCC(System.String)"> | ||
112 | <summary> | ||
113 | Convert a string (up to 8 characters) to a UInt64 | ||
114 | </summary> | ||
115 | <param name="s">String to convert</param> | ||
116 | <returns>UInt64 packed representation of <paramref name="s"/></returns> | ||
117 | </member> | ||
118 | <member name="M:s3pi.Interfaces.AApiVersionedFields.FOURCC(System.UInt64)"> | ||
119 | <summary> | ||
120 | Convert a UInt64 to a string (up to 8 characters, high-order zeros omitted) | ||
121 | </summary> | ||
122 | <param name="i">Bytes to convert</param> | ||
123 | <returns>String representation of <paramref name="i"/></returns> | ||
124 | </member> | ||
125 | <member name="M:s3pi.Interfaces.AApiVersionedFields.FlagNames(System.Type)"> | ||
126 | <summary> | ||
127 | Return a space-separated string containing valid enumeration names for the given type | ||
128 | </summary> | ||
129 | <param name="t">Enum type</param> | ||
130 | <returns>Valid enum names</returns> | ||
131 | </member> | ||
132 | <member name="P:s3pi.Interfaces.AApiVersionedFields.RequestedApiVersion"> | ||
133 | <summary> | ||
134 | The version of the API in use | ||
135 | </summary> | ||
136 | </member> | ||
137 | <member name="P:s3pi.Interfaces.AApiVersionedFields.RecommendedApiVersion"> | ||
138 | <summary> | ||
139 | The best supported version of the API available | ||
140 | </summary> | ||
141 | </member> | ||
142 | <member name="P:s3pi.Interfaces.AApiVersionedFields.ContentFields"> | ||
143 | <summary> | ||
144 | The list of available field names on this API object | ||
145 | </summary> | ||
146 | </member> | ||
147 | <member name="P:s3pi.Interfaces.AApiVersionedFields.Item(System.String)"> | ||
148 | <summary> | ||
149 | A typed value on this object | ||
150 | </summary> | ||
151 | <param name="index">The name of the field (i.e. one of the values from ContentFields)</param> | ||
152 | <returns>The typed value of the named field</returns> | ||
153 | <exception cref="T:System.ArgumentOutOfRangeException">Thrown when an unknown index name is requested</exception> | ||
154 | </member> | ||
155 | <member name="P:s3pi.Interfaces.AApiVersionedFields.ValueBuilderFields"> | ||
156 | <summary> | ||
157 | The fields ValueBuilder will return; used to eliminate those that should not be used. | ||
158 | </summary> | ||
159 | </member> | ||
160 | <member name="P:s3pi.Interfaces.AApiVersionedFields.ValueBuilder"> | ||
161 | <summary> | ||
162 | Returns a string representing the value of the field (and any contained sub-fields) | ||
163 | </summary> | ||
164 | </member> | ||
165 | <member name="T:s3pi.Interfaces.AApiVersionedFields.Comparer`1"> | ||
166 | <summary> | ||
167 | A class enabling sorting API objects by a ContentFields name | ||
168 | </summary> | ||
169 | <typeparam name="T">API object type</typeparam> | ||
170 | </member> | ||
171 | <member name="M:s3pi.Interfaces.AApiVersionedFields.Comparer`1.#ctor(System.String)"> | ||
172 | <summary> | ||
173 | Sort API Objects by <paramref name="field"/> | ||
174 | </summary> | ||
175 | <param name="field">ContentField name to sort by</param> | ||
176 | </member> | ||
177 | <member name="M:s3pi.Interfaces.AApiVersionedFields.Comparer`1.Compare(`0,`0)"> | ||
178 | <summary> | ||
179 | Compares two objects of type T and returns a value indicating whether one is less than, | ||
180 | equal to, or greater than the other. | ||
181 | </summary> | ||
182 | <param name="x">The first IContentFields object to compare.</param> | ||
183 | <param name="y">The second IContentFields object to compare.</param> | ||
184 | <returns>Value Condition Less than zero -- x is less than y. | ||
185 | Zero -- x equals y. | ||
186 | Greater than zero -- x is greater than y.</returns> | ||
187 | </member> | ||
188 | <member name="F:s3pi.Interfaces.AHandlerElement.handler"> | ||
189 | <summary> | ||
190 | Holds the <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes. | ||
191 | </summary> | ||
192 | </member> | ||
193 | <member name="F:s3pi.Interfaces.AHandlerElement.dirty"> | ||
194 | <summary> | ||
195 | Indicates if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> has been changed by OnElementChanged() | ||
196 | </summary> | ||
197 | </member> | ||
198 | <member name="M:s3pi.Interfaces.AHandlerElement.#ctor(System.Int32,System.EventHandler)"> | ||
199 | <summary> | ||
200 | Initialize a new instance | ||
201 | </summary> | ||
202 | <param name="APIversion">The requested API version.</param> | ||
203 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
204 | </member> | ||
205 | <member name="M:s3pi.Interfaces.AHandlerElement.Clone(System.EventHandler)"> | ||
206 | <summary> | ||
207 | Get a copy of the <see cref="T:s3pi.Interfaces.AHandlerElement"/> but with a new change <see cref="T:System.EventHandler"/>. | ||
208 | </summary> | ||
209 | <param name="handler">The replacement <see cref="T:System.EventHandler"/> delegate.</param> | ||
210 | <returns>Return a copy of the <see cref="T:s3pi.Interfaces.AHandlerElement"/> but with a new change <see cref="T:System.EventHandler"/>.</returns> | ||
211 | </member> | ||
212 | <member name="M:s3pi.Interfaces.AHandlerElement.OnElementChanged"> | ||
213 | <summary> | ||
214 | Flag the <see cref="T:s3pi.Interfaces.AHandlerElement"/> as dirty and invoke the <see cref="T:System.EventHandler"/> delegate. | ||
215 | </summary> | ||
216 | </member> | ||
217 | <member name="T:s3pi.Interfaces.IResourceKey"> | ||
218 | <summary> | ||
219 | Exposes a standard set of properties to identify a resource | ||
220 | </summary> | ||
221 | </member> | ||
222 | <member name="P:s3pi.Interfaces.IResourceKey.ResourceType"> | ||
223 | <summary> | ||
224 | The "type" of the resource | ||
225 | </summary> | ||
226 | </member> | ||
227 | <member name="P:s3pi.Interfaces.IResourceKey.ResourceGroup"> | ||
228 | <summary> | ||
229 | The "group" the resource is part of | ||
230 | </summary> | ||
231 | </member> | ||
232 | <member name="P:s3pi.Interfaces.IResourceKey.Instance"> | ||
233 | <summary> | ||
234 | The "instance" number of the resource | ||
235 | </summary> | ||
236 | </member> | ||
237 | <member name="F:s3pi.Interfaces.AResourceKey.resourceType"> | ||
238 | <summary> | ||
239 | The "type" of the resource | ||
240 | </summary> | ||
241 | </member> | ||
242 | <member name="F:s3pi.Interfaces.AResourceKey.resourceGroup"> | ||
243 | <summary> | ||
244 | The "group" the resource is part of | ||
245 | </summary> | ||
246 | </member> | ||
247 | <member name="F:s3pi.Interfaces.AResourceKey.instance"> | ||
248 | <summary> | ||
249 | The "instance" number of the resource | ||
250 | </summary> | ||
251 | </member> | ||
252 | <member name="M:s3pi.Interfaces.AResourceKey.#ctor(System.Int32,System.EventHandler)"> | ||
253 | <summary> | ||
254 | Initialize a new instance | ||
255 | </summary> | ||
256 | <param name="APIversion">The requested API version.</param> | ||
257 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AResourceKey"/> changes.</param> | ||
258 | </member> | ||
259 | <member name="M:s3pi.Interfaces.AResourceKey.#ctor(System.Int32,System.EventHandler,s3pi.Interfaces.IResourceKey)"> | ||
260 | <summary> | ||
261 | Initialize a new instance | ||
262 | </summary> | ||
263 | <param name="APIversion">The requested API version.</param> | ||
264 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AResourceKey"/> changes.</param> | ||
265 | <param name="basis">The <see cref="T:s3pi.Interfaces.IResourceKey"/> values to use to initialise the instance.</param> | ||
266 | </member> | ||
267 | <member name="M:s3pi.Interfaces.AResourceKey.#ctor(System.Int32,System.EventHandler,System.UInt32,System.UInt32,System.UInt64)"> | ||
268 | <summary> | ||
269 | Initialize a new instance | ||
270 | </summary> | ||
271 | <param name="APIversion">The requested API version.</param> | ||
272 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AResourceKey"/> changes.</param> | ||
273 | <param name="resourceType">The type of the resource.</param> | ||
274 | <param name="resourceGroup">The group of the resource.</param> | ||
275 | <param name="instance">The instance of the resource.</param> | ||
276 | </member> | ||
277 | <member name="M:s3pi.Interfaces.AResourceKey.Equals(s3pi.Interfaces.IResourceKey,s3pi.Interfaces.IResourceKey)"> | ||
278 | <summary> | ||
279 | Determines whether the specified <see cref="T:s3pi.Interfaces.IResourceKey"/> instances are equal. | ||
280 | </summary> | ||
281 | <param name="x">The first <see cref="T:s3pi.Interfaces.IResourceKey"/> to compare.</param> | ||
282 | <param name="y">The second <see cref="T:s3pi.Interfaces.IResourceKey"/> to compare.</param> | ||
283 | <returns>true if the specified <see cref="T:s3pi.Interfaces.IResourceKey"/> instances are equal; otherwise, false.</returns> | ||
284 | </member> | ||
285 | <member name="M:s3pi.Interfaces.AResourceKey.GetHashCode(s3pi.Interfaces.IResourceKey)"> | ||
286 | <summary> | ||
287 | Returns a hash code for the specified <see cref="T:s3pi.Interfaces.IResourceKey"/>. | ||
288 | </summary> | ||
289 | <param name="obj">The <see cref="T:s3pi.Interfaces.IResourceKey"/> for which a hash code is to be returned.</param> | ||
290 | <returns>A hash code for the specified object.</returns> | ||
291 | <exception cref="T:System.ArgumentNullException">The type of <paramref name="obj"/> is a reference type and | ||
292 | <paramref name="obj"/> is null.</exception> | ||
293 | <seealso cref="M:s3pi.Interfaces.AResourceKey.GetHashCode"/> | ||
294 | </member> | ||
295 | <member name="M:s3pi.Interfaces.AResourceKey.GetHashCode"> | ||
296 | <summary> | ||
297 | Serves as a hash function for an <see cref="T:s3pi.Interfaces.AResourceKey"/>. | ||
298 | </summary> | ||
299 | <returns>A hash code for the current <see cref="T:s3pi.Interfaces.AResourceKey"/>.</returns> | ||
300 | </member> | ||
301 | <member name="M:s3pi.Interfaces.AResourceKey.Equals(s3pi.Interfaces.IResourceKey)"> | ||
302 | <summary> | ||
303 | Indicates whether the current <see cref="T:s3pi.Interfaces.AResourceKey"/> instance is equal to another <see cref="T:s3pi.Interfaces.IResourceKey"/> instance. | ||
304 | </summary> | ||
305 | <param name="other">An <see cref="T:s3pi.Interfaces.IResourceKey"/> instance to compare with this instance.</param> | ||
306 | <returns>true if the current instance is equal to the <paramref name="other"/> parameter; otherwise, false.</returns> | ||
307 | </member> | ||
308 | <member name="M:s3pi.Interfaces.AResourceKey.Equals(System.Object)"> | ||
309 | <summary> | ||
310 | Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:s3pi.Interfaces.AResourceKey"/>. | ||
311 | </summary> | ||
312 | <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:s3pi.Interfaces.AResourceKey"/>.</param> | ||
313 | <returns>true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:s3pi.Interfaces.AResourceKey"/>; otherwise, false.</returns> | ||
314 | </member> | ||
315 | <member name="M:s3pi.Interfaces.AResourceKey.CompareTo(s3pi.Interfaces.IResourceKey)"> | ||
316 | <summary> | ||
317 | Compare this <see cref="T:s3pi.Interfaces.AResourceKey"/> to another <see cref="T:s3pi.Interfaces.IResourceKey"/> for sort order purposes | ||
318 | </summary> | ||
319 | <param name="other">Target <see cref="T:s3pi.Interfaces.IResourceKey"/></param> | ||
320 | <returns>A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: | ||
321 | <table> | ||
322 | <thead><tr><td><strong>Value</strong></td><td><strong>Meaning</strong></td></tr></thead> | ||
323 | <tbody> | ||
324 | <tr><td>Less than zero</td><td>This instance is less than <paramref name="other"/>.</td></tr> | ||
325 | <tr><td>Zero</td><td>This instance is equal to <paramref name="other"/>.</td></tr> | ||
326 | <tr><td>Greater than zero</td><td>This instance is greater than <paramref name="other"/>.</td></tr> | ||
327 | </tbody> | ||
328 | </table> | ||
329 | </returns> | ||
330 | <exception cref="T:System.NotImplementedException">Either this object's Type or the target's is not comparable</exception> | ||
331 | <exception cref="T:System.ArgumentException">The target is not comparable with this object</exception> | ||
332 | </member> | ||
333 | <member name="M:s3pi.Interfaces.AResourceKey.op_Implicit(s3pi.Interfaces.AResourceKey)~System.String"> | ||
334 | <summary> | ||
335 | Converts an <see cref="T:s3pi.Interfaces.AResourceKey"/> to a string representation. | ||
336 | </summary> | ||
337 | <param name="value">The <see cref="T:s3pi.Interfaces.AResourceKey"/> to convert</param> | ||
338 | <returns>The 42 character string representation of this resource key, | ||
339 | of the form 0xXXXXXXXX-0xXXXXXXXX-0xXXXXXXXXXXXXXXXX.</returns> | ||
340 | </member> | ||
341 | <member name="M:s3pi.Interfaces.AResourceKey.ToString"> | ||
342 | <summary> | ||
343 | Returns a string representation of this <see cref="T:s3pi.Interfaces.AResourceKey"/>. | ||
344 | </summary> | ||
345 | <returns>The 42 character string representation of this resource key, | ||
346 | of the form 0xXXXXXXXX-0xXXXXXXXX-0xXXXXXXXXXXXXXXXX.</returns> | ||
347 | </member> | ||
348 | <member name="P:s3pi.Interfaces.AResourceKey.ResourceType"> | ||
349 | <summary> | ||
350 | The "type" of the resource | ||
351 | </summary> | ||
352 | </member> | ||
353 | <member name="P:s3pi.Interfaces.AResourceKey.ResourceGroup"> | ||
354 | <summary> | ||
355 | The "group" the resource is part of | ||
356 | </summary> | ||
357 | </member> | ||
358 | <member name="P:s3pi.Interfaces.AResourceKey.Instance"> | ||
359 | <summary> | ||
360 | The "instance" number of the resource | ||
361 | </summary> | ||
362 | </member> | ||
363 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler,s3pi.Interfaces.TGIBlock)"> | ||
364 | <summary> | ||
365 | Initialize a new TGIBlock | ||
366 | with the order and values | ||
367 | based on <paramref name="basis"/>. | ||
368 | </summary> | ||
369 | <param name="APIversion">The requested API version.</param> | ||
370 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
371 | <param name="basis">The TGIBlock to use for the <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> and <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
372 | </member> | ||
373 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler)"> | ||
374 | <summary> | ||
375 | Initialize a new TGIBlock | ||
376 | with the default order ("TGI"). | ||
377 | </summary> | ||
378 | <param name="APIversion">The requested API version.</param> | ||
379 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
380 | </member> | ||
381 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler,System.String)"> | ||
382 | <summary> | ||
383 | Initialize a new TGIBlock | ||
384 | with the specified order. | ||
385 | </summary> | ||
386 | <param name="APIversion">The requested API version.</param> | ||
387 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
388 | <param name="order">A <see cref="T:System.String"/> representing the <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> to use to store the <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
389 | </member> | ||
390 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler,s3pi.Interfaces.TGIBlock.Order)"> | ||
391 | <summary> | ||
392 | Initialize a new TGIBlock | ||
393 | with the specified order. | ||
394 | </summary> | ||
395 | <param name="APIversion">The requested API version.</param> | ||
396 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
397 | <param name="order">The <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> to use to store the <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
398 | </member> | ||
399 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler,System.UInt32,System.UInt32,System.UInt64)"> | ||
400 | <summary> | ||
401 | Initialize a new TGIBlock | ||
402 | with the default order ("TGI") and specified values. | ||
403 | </summary> | ||
404 | <param name="APIversion">The requested API version.</param> | ||
405 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
406 | <param name="resourceType">The resource type value.</param> | ||
407 | <param name="resourceGroup">The resource group value.</param> | ||
408 | <param name="instance">The resource instance value.</param> | ||
409 | </member> | ||
410 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler,System.String,System.UInt32,System.UInt32,System.UInt64)"> | ||
411 | <summary> | ||
412 | Initialize a new TGIBlock | ||
413 | with the specified order and values. | ||
414 | </summary> | ||
415 | <param name="APIversion">The requested API version.</param> | ||
416 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
417 | <param name="order">A <see cref="T:System.String"/> representing the <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> to use to store the <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
418 | <param name="resourceType">The resource type value.</param> | ||
419 | <param name="resourceGroup">The resource group value.</param> | ||
420 | <param name="instance">The resource instance value.</param> | ||
421 | </member> | ||
422 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler,s3pi.Interfaces.TGIBlock.Order,System.UInt32,System.UInt32,System.UInt64)"> | ||
423 | <summary> | ||
424 | Initialize a new TGIBlock | ||
425 | with the specified order and values. | ||
426 | </summary> | ||
427 | <param name="APIversion">The requested API version.</param> | ||
428 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
429 | <param name="order">The <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> to use to store the <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
430 | <param name="resourceType">The resource type value.</param> | ||
431 | <param name="resourceGroup">The resource group value.</param> | ||
432 | <param name="instance">The resource instance value.</param> | ||
433 | </member> | ||
434 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler,s3pi.Interfaces.IResourceKey)"> | ||
435 | <summary> | ||
436 | Initialize a new TGIBlock | ||
437 | with the default order ("TGI") and specified <see cref="T:s3pi.Interfaces.IResourceKey"/> values. | ||
438 | </summary> | ||
439 | <param name="APIversion">The requested API version.</param> | ||
440 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
441 | <param name="rk">The <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
442 | </member> | ||
443 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler,System.String,s3pi.Interfaces.IResourceKey)"> | ||
444 | <summary> | ||
445 | Initialize a new TGIBlock | ||
446 | with the specified order and <see cref="T:s3pi.Interfaces.IResourceKey"/> values. | ||
447 | </summary> | ||
448 | <param name="APIversion">The requested API version.</param> | ||
449 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
450 | <param name="order">A <see cref="T:System.String"/> representing the <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> to use to store the <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
451 | <param name="rk">The <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
452 | </member> | ||
453 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler,s3pi.Interfaces.TGIBlock.Order,s3pi.Interfaces.IResourceKey)"> | ||
454 | <summary> | ||
455 | Initialize a new TGIBlock | ||
456 | with the specified order and <see cref="T:s3pi.Interfaces.IResourceKey"/> values. | ||
457 | </summary> | ||
458 | <param name="APIversion">The requested API version.</param> | ||
459 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
460 | <param name="order">The <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> to use to store the <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
461 | <param name="rk">The <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
462 | </member> | ||
463 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler,System.IO.Stream)"> | ||
464 | <summary> | ||
465 | Initialize a new TGIBlock | ||
466 | with the default order ("TGI") and values read from the specified <see cref="T:System.IO.Stream"/>. | ||
467 | </summary> | ||
468 | <param name="APIversion">The requested API version.</param> | ||
469 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
470 | <param name="s">The <see cref="T:System.IO.Stream"/> from which to read the <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
471 | </member> | ||
472 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler,System.String,System.IO.Stream)"> | ||
473 | <summary> | ||
474 | Initialize a new TGIBlock | ||
475 | with the specified order and values read from the specified <see cref="T:System.IO.Stream"/>. | ||
476 | </summary> | ||
477 | <param name="APIversion">The requested API version.</param> | ||
478 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
479 | <param name="order">A <see cref="T:System.String"/> representing the <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> of the <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
480 | <param name="s">The <see cref="T:System.IO.Stream"/> from which to read the <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
481 | </member> | ||
482 | <member name="M:s3pi.Interfaces.TGIBlock.#ctor(System.Int32,System.EventHandler,s3pi.Interfaces.TGIBlock.Order,System.IO.Stream)"> | ||
483 | <summary> | ||
484 | Initialize a new TGIBlock | ||
485 | with the specified order and values read from the specified <see cref="T:System.IO.Stream"/>. | ||
486 | </summary> | ||
487 | <param name="APIversion">The requested API version.</param> | ||
488 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
489 | <param name="order">The <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> of the <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
490 | <param name="s">The <see cref="T:System.IO.Stream"/> from which to read the <see cref="T:s3pi.Interfaces.IResourceKey"/> values.</param> | ||
491 | </member> | ||
492 | <member name="M:s3pi.Interfaces.TGIBlock.Parse(System.IO.Stream)"> | ||
493 | <summary> | ||
494 | Used by the <see cref="T:s3pi.Interfaces.TGIBlock"/> constructor to inialise a new <see cref="T:s3pi.Interfaces.TGIBlock"/> from a <see cref="T:System.IO.Stream"/>. | ||
495 | </summary> | ||
496 | <param name="s"><see cref="T:System.IO.Stream"/> containing <see cref="T:s3pi.Interfaces.TGIBlock"/> values in known order.</param> | ||
497 | </member> | ||
498 | <member name="M:s3pi.Interfaces.TGIBlock.UnParse(System.IO.Stream)"> | ||
499 | <summary> | ||
500 | Writes the <see cref="T:s3pi.Interfaces.TGIBlock"/> to the specified <see cref="T:System.IO.Stream"/> in known order. | ||
501 | </summary> | ||
502 | <param name="s"><see cref="T:System.IO.Stream"/> to write <see cref="T:s3pi.Interfaces.TGIBlock"/> values to.</param> | ||
503 | </member> | ||
504 | <member name="M:s3pi.Interfaces.TGIBlock.Clone(System.EventHandler)"> | ||
505 | <summary> | ||
506 | Get a copy of the <see cref="T:s3pi.Interfaces.TGIBlock"/> but with a new change <see cref="T:System.EventHandler"/>. | ||
507 | </summary> | ||
508 | <param name="handler">The replacement <see cref="T:System.EventHandler"/> delegate.</param> | ||
509 | <returns>Return a copy of the <see cref="T:s3pi.Interfaces.TGIBlock"/> but with a new change <see cref="T:System.EventHandler"/>.</returns> | ||
510 | </member> | ||
511 | <member name="M:s3pi.Interfaces.TGIBlock.Equals(s3pi.Interfaces.TGIBlock)"> | ||
512 | <summary> | ||
513 | Indicates whether the current <see cref="T:s3pi.Interfaces.TGIBlock"/> instance is equal to another <see cref="T:s3pi.Interfaces.TGIBlock"/> instance. | ||
514 | </summary> | ||
515 | <param name="other">An <see cref="T:s3pi.Interfaces.TGIBlock"/> instance to compare with this instance.</param> | ||
516 | <returns>true if the current instance is equal to the <paramref name="other"/> parameter; otherwise, false.</returns> | ||
517 | </member> | ||
518 | <member name="P:s3pi.Interfaces.TGIBlock.ContentFields"> | ||
519 | <summary> | ||
520 | The list of available field names on this API object | ||
521 | </summary> | ||
522 | </member> | ||
523 | <member name="P:s3pi.Interfaces.TGIBlock.RecommendedApiVersion"> | ||
524 | <summary> | ||
525 | The best supported version of the API available | ||
526 | </summary> | ||
527 | </member> | ||
528 | <member name="P:s3pi.Interfaces.TGIBlock.Value"> | ||
529 | <summary> | ||
530 | A display-ready string representing the <see cref="T:s3pi.Interfaces.TGIBlock"/>. | ||
531 | </summary> | ||
532 | </member> | ||
533 | <member name="T:s3pi.Interfaces.TGIBlock.Order"> | ||
534 | <summary> | ||
535 | Options for the order of the Type, Group and Instance elements of a TGIBlock | ||
536 | </summary> | ||
537 | </member> | ||
538 | <member name="F:s3pi.Interfaces.TGIBlock.Order.TGI"> | ||
539 | <summary> | ||
540 | Type, Group, Instance | ||
541 | </summary> | ||
542 | </member> | ||
543 | <member name="F:s3pi.Interfaces.TGIBlock.Order.TIG"> | ||
544 | <summary> | ||
545 | Type, Instance, Group | ||
546 | </summary> | ||
547 | </member> | ||
548 | <member name="F:s3pi.Interfaces.TGIBlock.Order.GTI"> | ||
549 | <summary> | ||
550 | Group, Type, Instance | ||
551 | </summary> | ||
552 | </member> | ||
553 | <member name="F:s3pi.Interfaces.TGIBlock.Order.GIT"> | ||
554 | <summary> | ||
555 | Group, Instance, Type | ||
556 | </summary> | ||
557 | </member> | ||
558 | <member name="F:s3pi.Interfaces.TGIBlock.Order.ITG"> | ||
559 | <summary> | ||
560 | Instance, Type, Group | ||
561 | </summary> | ||
562 | </member> | ||
563 | <member name="F:s3pi.Interfaces.TGIBlock.Order.IGT"> | ||
564 | <summary> | ||
565 | Instance, Group, Type | ||
566 | </summary> | ||
567 | </member> | ||
568 | <member name="T:s3pi.Interfaces.ConstructorParametersAttribute"> | ||
569 | <summary> | ||
570 | Specify the constructor parameters for a descendant of an abstract class | ||
571 | </summary> | ||
572 | </member> | ||
573 | <member name="F:s3pi.Interfaces.ConstructorParametersAttribute.parameters"> | ||
574 | <summary> | ||
575 | The constructor parameters | ||
576 | </summary> | ||
577 | </member> | ||
578 | <member name="M:s3pi.Interfaces.ConstructorParametersAttribute.#ctor(System.Object[])"> | ||
579 | <summary> | ||
580 | Specify the constructor parameters for a descendant of an abstract class | ||
581 | </summary> | ||
582 | <param name="parameters">The constructor parameters</param> | ||
583 | </member> | ||
584 | <member name="T:s3pi.Interfaces.VersionAttribute"> | ||
585 | <summary> | ||
586 | Base class for versioning support. Not directly used by the API. | ||
587 | </summary> | ||
588 | </member> | ||
589 | <member name="M:s3pi.Interfaces.VersionAttribute.#ctor(System.Int32)"> | ||
590 | <summary> | ||
591 | Version number attribute (base) | ||
592 | </summary> | ||
593 | <param name="Version">Version number</param> | ||
594 | </member> | ||
595 | <member name="P:s3pi.Interfaces.VersionAttribute.Version"> | ||
596 | <summary> | ||
597 | Version number | ||
598 | </summary> | ||
599 | </member> | ||
600 | <member name="T:s3pi.Interfaces.MinimumVersionAttribute"> | ||
601 | <summary> | ||
602 | Specify the Minumum version from which a field or method is supported | ||
603 | </summary> | ||
604 | </member> | ||
605 | <member name="M:s3pi.Interfaces.MinimumVersionAttribute.#ctor(System.Int32)"> | ||
606 | <summary> | ||
607 | Specify the Minumum version from which a field or method is supported | ||
608 | </summary> | ||
609 | <param name="Version">Version number</param> | ||
610 | </member> | ||
611 | <member name="T:s3pi.Interfaces.MaximumVersionAttribute"> | ||
612 | <summary> | ||
613 | Specify the Maximum version up to which a field or method is supported | ||
614 | </summary> | ||
615 | </member> | ||
616 | <member name="M:s3pi.Interfaces.MaximumVersionAttribute.#ctor(System.Int32)"> | ||
617 | <summary> | ||
618 | Specify the Maximum version up to which a field or method is supported | ||
619 | </summary> | ||
620 | <param name="Version">Version number</param> | ||
621 | </member> | ||
622 | <member name="T:s3pi.Interfaces.DependentList`1"> | ||
623 | <summary> | ||
624 | Abstract extension to <see cref="T:System.Collections.Generic.AHandlerList`1"/> adding support for <see cref="T:System.IO.Stream"/> IO | ||
625 | and partially implementing <see cref="T:s3pi.Interfaces.IGenericAdd"/>. | ||
626 | </summary> | ||
627 | <typeparam name="T"><see cref="T:System.Type"/> of list element</typeparam> | ||
628 | <seealso cref="T:System.Collections.Generic.AHandlerList`1"/> | ||
629 | <seealso cref="T:s3pi.Interfaces.IGenericAdd"/> | ||
630 | </member> | ||
631 | <member name="T:s3pi.Interfaces.IGenericAdd"> | ||
632 | <summary> | ||
633 | Classes implementing this interface can have elements added with | ||
634 | an empty parameter list or | ||
635 | the list of arguments to a generic class' constructor. | ||
636 | </summary> | ||
637 | <seealso cref="T:s3pi.Interfaces.DependentList`1"/> | ||
638 | </member> | ||
639 | <member name="M:s3pi.Interfaces.IGenericAdd.Add"> | ||
640 | <summary> | ||
641 | Add a default element to an <see cref="T:System.Collections.IList"/> that implements this interface. | ||
642 | </summary> | ||
643 | <exception cref="T:System.NotImplementedException">Lists of abstract classes will fail | ||
644 | with a NotImplementedException.</exception> | ||
645 | <seealso cref="T:s3pi.Interfaces.DependentList`1"/> | ||
646 | </member> | ||
647 | <member name="M:s3pi.Interfaces.IGenericAdd.Add(System.Object[])"> | ||
648 | <summary> | ||
649 | Adds an entry to an <see cref="T:System.Collections.IList"/> that implements this interface. | ||
650 | </summary> | ||
651 | <param name="fields"> | ||
652 | Either the object to add or the generic type's constructor arguments. | ||
653 | </param> | ||
654 | <returns>True on success</returns> | ||
655 | <seealso cref="T:s3pi.Interfaces.DependentList`1"/> | ||
656 | </member> | ||
657 | <member name="F:s3pi.Interfaces.DependentList`1.elementHandler"> | ||
658 | <summary> | ||
659 | Holds the <see cref="T:System.EventHandler"/> delegate to invoke if an element in the <see cref="T:s3pi.Interfaces.DependentList`1"/> changes. | ||
660 | </summary> | ||
661 | <remarks>Work around for list event handler triggering during stream constructor and other places.</remarks> | ||
662 | </member> | ||
663 | <member name="M:s3pi.Interfaces.DependentList`1.#ctor(System.EventHandler,System.Int64)"> | ||
664 | <summary> | ||
665 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.DependentList`1"/> class | ||
666 | that is empty. | ||
667 | </summary> | ||
668 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
669 | <param name="size">Optional; -1 for unlimited size, otherwise the maximum number of elements in the list.</param> | ||
670 | </member> | ||
671 | <member name="M:s3pi.Interfaces.DependentList`1.#ctor(System.EventHandler,System.Collections.Generic.IEnumerable{`0},System.Int64)"> | ||
672 | <summary> | ||
673 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.DependentList`1"/> class | ||
674 | filled with the content of <paramref name="ilt"/>. | ||
675 | </summary> | ||
676 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
677 | <param name="ilt">The initial content of the list.</param> | ||
678 | <param name="size">Optional; -1 for unlimited size, otherwise the maximum number of elements in the list.</param> | ||
679 | <exception cref="T:System.InvalidOperationException">Thrown when list size exceeded.</exception> | ||
680 | <remarks>Calls <c>this.Add(...)</c> to ensure a fresh instance is created, rather than passing <paramref name="ilt"/> to the base constructor.</remarks> | ||
681 | </member> | ||
682 | <member name="M:s3pi.Interfaces.DependentList`1.#ctor(System.EventHandler,System.IO.Stream,System.Int64)"> | ||
683 | <summary> | ||
684 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.DependentList`1"/> class | ||
685 | filled from <see cref="T:System.IO.Stream"/> <paramref name="s"/>. | ||
686 | </summary> | ||
687 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
688 | <param name="s">The <see cref="T:System.IO.Stream"/> to read for the initial content of the list.</param> | ||
689 | <param name="size">Optional; -1 for unlimited size, otherwise the maximum number of elements in the list.</param> | ||
690 | <exception cref="T:System.InvalidOperationException">Thrown when list size exceeded.</exception> | ||
691 | </member> | ||
692 | <member name="M:s3pi.Interfaces.DependentList`1.Parse(System.IO.Stream)"> | ||
693 | <summary> | ||
694 | Read list entries from a stream | ||
695 | </summary> | ||
696 | <param name="s">Stream containing list entries</param> | ||
697 | <remarks>This method bypasses <see cref="M:s3pi.Interfaces.DependentList`1.Add(System.Object[])"/> | ||
698 | because <see cref="M:s3pi.Interfaces.DependentList`1.CreateElement(System.IO.Stream,System.Boolean@)"/> must take care of the same issues.</remarks> | ||
699 | </member> | ||
700 | <member name="M:s3pi.Interfaces.DependentList`1.ReadCount(System.IO.Stream)"> | ||
701 | <summary> | ||
702 | Return the number of elements to be created. | ||
703 | </summary> | ||
704 | <param name="s"><see cref="T:System.IO.Stream"/> being processed.</param> | ||
705 | <returns>The number of elements to be created.</returns> | ||
706 | </member> | ||
707 | <member name="M:s3pi.Interfaces.DependentList`1.CreateElement(System.IO.Stream)"> | ||
708 | <summary> | ||
709 | Create a new element from the <see cref="T:System.IO.Stream"/>. | ||
710 | </summary> | ||
711 | <param name="s">Stream containing element data.</param> | ||
712 | <returns>A new element.</returns> | ||
713 | </member> | ||
714 | <member name="M:s3pi.Interfaces.DependentList`1.CreateElement(System.IO.Stream,System.Boolean@)"> | ||
715 | <summary> | ||
716 | Create a new element from the <see cref="T:System.IO.Stream"/> and indicates whether it counts towards the number of elements to be created. | ||
717 | </summary> | ||
718 | <param name="s"><see cref="T:System.IO.Stream"/> containing element data.</param> | ||
719 | <param name="inc">Whether this call towards the number of elements to be created.</param> | ||
720 | <returns>A new element.</returns> | ||
721 | </member> | ||
722 | <member name="M:s3pi.Interfaces.DependentList`1.UnParse(System.IO.Stream)"> | ||
723 | <summary> | ||
724 | Write list entries to a stream | ||
725 | </summary> | ||
726 | <param name="s">Stream to receive list entries</param> | ||
727 | </member> | ||
728 | <member name="M:s3pi.Interfaces.DependentList`1.WriteCount(System.IO.Stream,System.Int32)"> | ||
729 | <summary> | ||
730 | Write the count of list elements to the stream. | ||
731 | </summary> | ||
732 | <param name="s"><see cref="T:System.IO.Stream"/> to write <paramref name="count"/> to.</param> | ||
733 | <param name="count">Value to write to <see cref="T:System.IO.Stream"/> <paramref name="s"/>.</param> | ||
734 | </member> | ||
735 | <member name="M:s3pi.Interfaces.DependentList`1.WriteElement(System.IO.Stream,`0)"> | ||
736 | <summary> | ||
737 | Write an element to the stream. | ||
738 | </summary> | ||
739 | <param name="s"><see cref="T:System.IO.Stream"/> to write <paramref name="element"/> to.</param> | ||
740 | <param name="element">Value to write to <see cref="T:System.IO.Stream"/> <paramref name="s"/>.</param> | ||
741 | </member> | ||
742 | <member name="M:s3pi.Interfaces.DependentList`1.Add"> | ||
743 | <summary> | ||
744 | Add a default element to a <see cref="T:s3pi.Interfaces.DependentList`1"/>. | ||
745 | </summary> | ||
746 | <exception cref="T:System.NotImplementedException">Lists of abstract classes will fail | ||
747 | with a NotImplementedException.</exception> | ||
748 | <exception cref="T:System.InvalidOperationException">Thrown when list size exceeded.</exception> | ||
749 | <exception cref="T:System.NotSupportedException">The <see cref="T:s3pi.Interfaces.DependentList`1"/> is read-only.</exception> | ||
750 | </member> | ||
751 | <member name="M:s3pi.Interfaces.DependentList`1.Add(System.Object[])"> | ||
752 | <summary> | ||
753 | Adds an entry to an <see cref="T:s3pi.Interfaces.DependentList`1"/>. | ||
754 | </summary> | ||
755 | <param name="fields"> | ||
756 | Either the object to add or the generic type's constructor arguments. | ||
757 | </param> | ||
758 | <returns>True on success</returns> | ||
759 | <exception cref="T:System.InvalidOperationException">Thrown when list size exceeded.</exception> | ||
760 | <exception cref="T:System.NotSupportedException">The <see cref="T:s3pi.Interfaces.DependentList`1"/> is read-only.</exception> | ||
761 | </member> | ||
762 | <member name="M:s3pi.Interfaces.DependentList`1.GetElementType(System.Object[])"> | ||
763 | <summary> | ||
764 | Return the type to get the constructor from, for the given set of fields. | ||
765 | </summary> | ||
766 | <param name="fields">Constructor parameters</param> | ||
767 | <returns>Class on which to invoke constructor</returns> | ||
768 | <remarks><paramref name="fields"/>[0] could be an instance of the abstract class: it should provide a constructor that accepts a "template" | ||
769 | object and creates a new instance on that basis.</remarks> | ||
770 | </member> | ||
771 | <member name="T:s3pi.Interfaces.CountedTGIBlockList"> | ||
772 | <summary> | ||
773 | A TGIBlock list class where the count of elements is separate from the stored list | ||
774 | </summary> | ||
775 | </member> | ||
776 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.#ctor(System.EventHandler,System.Int64)"> | ||
777 | <summary> | ||
778 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/> class | ||
779 | that is empty | ||
780 | with <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> of "TGI". | ||
781 | </summary> | ||
782 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
783 | <param name="size">Optional; -1 for unlimited size, otherwise the maximum number of elements in the list.</param> | ||
784 | </member> | ||
785 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.#ctor(System.EventHandler,System.Collections.Generic.IEnumerable{s3pi.Interfaces.TGIBlock},System.Int64)"> | ||
786 | <summary> | ||
787 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/> class | ||
788 | filled with the content of <paramref name="ilt"/> | ||
789 | with <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> of "TGI". | ||
790 | </summary> | ||
791 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
792 | <param name="ilt">The <see cref="T:System.Collections.Generic.IEnumerable`1"/> to use as the initial content of the list.</param> | ||
793 | <param name="size">Optional; -1 for unlimited size, otherwise the maximum number of elements in the list.</param> | ||
794 | </member> | ||
795 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.#ctor(System.EventHandler,System.Int32,System.IO.Stream,System.Int64)"> | ||
796 | <summary> | ||
797 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/> class | ||
798 | filled with <paramref name="count"/> elements from <see cref="T:System.IO.Stream"/> <paramref name="s"/> | ||
799 | with <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> of "TGI". | ||
800 | </summary> | ||
801 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
802 | <param name="count">The number of list elements to read.</param> | ||
803 | <param name="s">The <see cref="T:System.IO.Stream"/> to read for the initial content of the list.</param> | ||
804 | <param name="size">Optional; -1 for unlimited size, otherwise the maximum number of elements in the list.</param> | ||
805 | </member> | ||
806 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.#ctor(System.EventHandler,s3pi.Interfaces.TGIBlock.Order,System.Int64)"> | ||
807 | <summary> | ||
808 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/> class | ||
809 | that is empty | ||
810 | with the specified <see cref="T:s3pi.Interfaces.TGIBlock.Order"/>. | ||
811 | </summary> | ||
812 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
813 | <param name="order">The <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> of the <see cref="T:s3pi.Interfaces.TGIBlock"/> values.</param> | ||
814 | <param name="size">Optional; -1 for unlimited size, otherwise the maximum number of elements in the list.</param> | ||
815 | </member> | ||
816 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.#ctor(System.EventHandler,s3pi.Interfaces.TGIBlock.Order,System.Collections.Generic.IEnumerable{s3pi.Interfaces.TGIBlock},System.Int64)"> | ||
817 | <summary> | ||
818 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/> class | ||
819 | filled with the content of <paramref name="ilt"/> | ||
820 | with the specified <see cref="T:s3pi.Interfaces.TGIBlock.Order"/>. | ||
821 | </summary> | ||
822 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
823 | <param name="order">The <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> of the <see cref="T:s3pi.Interfaces.TGIBlock"/> values.</param> | ||
824 | <param name="ilt">The <see cref="T:System.Collections.Generic.IEnumerable`1"/> to use as the initial content of the list.</param> | ||
825 | <param name="size">Optional; -1 for unlimited size, otherwise the maximum number of elements in the list.</param> | ||
826 | </member> | ||
827 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.#ctor(System.EventHandler,s3pi.Interfaces.TGIBlock.Order,System.Int32,System.IO.Stream,System.Int64)"> | ||
828 | <summary> | ||
829 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/> class | ||
830 | filled with <paramref name="count"/> elements from <see cref="T:System.IO.Stream"/> <paramref name="s"/> | ||
831 | with the specified <see cref="T:s3pi.Interfaces.TGIBlock.Order"/>. | ||
832 | </summary> | ||
833 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
834 | <param name="order">The <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> of the <see cref="T:s3pi.Interfaces.TGIBlock"/> values.</param> | ||
835 | <param name="count">The number of list elements to read.</param> | ||
836 | <param name="s">The <see cref="T:System.IO.Stream"/> to read for the initial content of the list.</param> | ||
837 | <param name="size">Optional; -1 for unlimited size, otherwise the maximum number of elements in the list.</param> | ||
838 | </member> | ||
839 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.#ctor(System.EventHandler,System.String,System.Int64)"> | ||
840 | <summary> | ||
841 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/> class | ||
842 | that is empty | ||
843 | with the specified <see cref="T:s3pi.Interfaces.TGIBlock.Order"/>. | ||
844 | </summary> | ||
845 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
846 | <param name="order">A string representing the <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> of the <see cref="T:s3pi.Interfaces.TGIBlock"/> values.</param> | ||
847 | <param name="size">Optional; -1 for unlimited size, otherwise the maximum number of elements in the list.</param> | ||
848 | </member> | ||
849 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.#ctor(System.EventHandler,System.String,System.Collections.Generic.IEnumerable{s3pi.Interfaces.TGIBlock},System.Int64)"> | ||
850 | <summary> | ||
851 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/> class | ||
852 | filled with the content of <paramref name="ilt"/> | ||
853 | with the specified <see cref="T:s3pi.Interfaces.TGIBlock.Order"/>. | ||
854 | </summary> | ||
855 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
856 | <param name="order">A string representing the <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> of the <see cref="T:s3pi.Interfaces.TGIBlock"/> values.</param> | ||
857 | <param name="ilt">The <see cref="T:System.Collections.Generic.IEnumerable`1"/> to use as the initial content of the list.</param> | ||
858 | <param name="size">Optional; -1 for unlimited size, otherwise the maximum number of elements in the list.</param> | ||
859 | </member> | ||
860 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.#ctor(System.EventHandler,System.String,System.Int32,System.IO.Stream,System.Int64)"> | ||
861 | <summary> | ||
862 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/> class | ||
863 | filled with <paramref name="count"/> elements from <see cref="T:System.IO.Stream"/> <paramref name="s"/> | ||
864 | with the specified <see cref="T:s3pi.Interfaces.TGIBlock.Order"/>. | ||
865 | </summary> | ||
866 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
867 | <param name="order">A string representing the <see cref="T:s3pi.Interfaces.TGIBlock.Order"/> of the <see cref="T:s3pi.Interfaces.TGIBlock"/> values.</param> | ||
868 | <param name="count">The number of list elements to read.</param> | ||
869 | <param name="s">The <see cref="T:System.IO.Stream"/> to read for the initial content of the list.</param> | ||
870 | <param name="size">Optional; -1 for unlimited size, otherwise the maximum number of elements in the list.</param> | ||
871 | </member> | ||
872 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.CreateElement(System.IO.Stream)"> | ||
873 | <summary> | ||
874 | Create a new element from the <see cref="T:System.IO.Stream"/>. | ||
875 | </summary> | ||
876 | <param name="s">Stream containing element data.</param> | ||
877 | <returns>A new element.</returns> | ||
878 | </member> | ||
879 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.WriteElement(System.IO.Stream,s3pi.Interfaces.TGIBlock)"> | ||
880 | <summary> | ||
881 | Write an element to the stream. | ||
882 | </summary> | ||
883 | <param name="s"><see cref="T:System.IO.Stream"/> to write <paramref name="element"/> to.</param> | ||
884 | <param name="element">Value to write to <see cref="T:System.IO.Stream"/> <paramref name="s"/>.</param> | ||
885 | </member> | ||
886 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.ReadCount(System.IO.Stream)"> | ||
887 | <summary> | ||
888 | Return the number of elements to be created. | ||
889 | </summary> | ||
890 | <param name="s"><see cref="T:System.IO.Stream"/> being processed -- ignored.</param> | ||
891 | <returns>The number of elements to be created, as provided to the <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/> constructor.</returns> | ||
892 | </member> | ||
893 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.WriteCount(System.IO.Stream,System.Int32)"> | ||
894 | <summary> | ||
895 | This list does not manage a count within the <see cref="T:System.IO.Stream"/>. | ||
896 | </summary> | ||
897 | <param name="s">Ignored.</param> | ||
898 | <param name="count">Ignored.</param> | ||
899 | </member> | ||
900 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.Add"> | ||
901 | <summary> | ||
902 | Add a new default element to the list. | ||
903 | </summary> | ||
904 | </member> | ||
905 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.Add(s3pi.Interfaces.TGIBlock)"> | ||
906 | <summary> | ||
907 | Adds a new <see cref="T:s3pi.Interfaces.TGIBlock"/> to the list using the values of the specified <see cref="T:s3pi.Interfaces.TGIBlock"/>. | ||
908 | </summary> | ||
909 | <param name="item">The <see cref="T:s3pi.Interfaces.TGIBlock"/> to use as a basis for the new <see cref="T:s3pi.Interfaces.TGIBlock"/>.</param> | ||
910 | <exception cref="T:System.InvalidOperationException">Thrown when list size exceeded.</exception> | ||
911 | <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.AHandlerList`1"/> is read-only.</exception> | ||
912 | <remarks>A new element is created rather than using the element passed | ||
913 | as the order (TGI/ITG/etc) may be different.</remarks> | ||
914 | </member> | ||
915 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.Add(s3pi.Interfaces.IResourceKey)"> | ||
916 | <summary> | ||
917 | Adds a new TGIBlock to the list using the values of the IResourceKey. | ||
918 | </summary> | ||
919 | <param name="rk">The ResourceKey values to use for the TGIBlock.</param> | ||
920 | <remarks>A new element is created rather than using the element passed | ||
921 | as the order (TGI/ITG/etc) may be different.</remarks> | ||
922 | </member> | ||
923 | <member name="M:s3pi.Interfaces.CountedTGIBlockList.Insert(System.Int32,s3pi.Interfaces.TGIBlock)"> | ||
924 | <summary> | ||
925 | Inserts a new <see cref="T:s3pi.Interfaces.TGIBlock"/> to the list at the specified index using the values of the specified <see cref="T:s3pi.Interfaces.TGIBlock"/>. | ||
926 | </summary> | ||
927 | <param name="index">The zero-based index at which the new <see cref="T:s3pi.Interfaces.TGIBlock"/> should be inserted.</param> | ||
928 | <param name="item">The <see cref="T:s3pi.Interfaces.TGIBlock"/> to use as a basis for the new <see cref="T:s3pi.Interfaces.TGIBlock"/>.</param> | ||
929 | <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is not a valid index | ||
930 | in the <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/>.</exception> | ||
931 | <exception cref="T:System.InvalidOperationException">Thrown when list size exceeded.</exception> | ||
932 | <exception cref="T:System.NotSupportedException">The <see cref="T:s3pi.Interfaces.CountedTGIBlockList"/> is read-only.</exception> | ||
933 | <remarks>A new element is created rather than using the element passed | ||
934 | as the order (TGI/ITG/etc) may be different.</remarks> | ||
935 | </member> | ||
936 | <member name="T:s3pi.Interfaces.TGIBlockList"> | ||
937 | <summary> | ||
938 | A TGIBlock list class where the count and size of the list are stored separately (but managed by this class) | ||
939 | </summary> | ||
940 | </member> | ||
941 | <member name="M:s3pi.Interfaces.TGIBlockList.#ctor(System.EventHandler,System.Boolean)"> | ||
942 | <summary> | ||
943 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.TGIBlockList"/> class | ||
944 | that is empty. | ||
945 | </summary> | ||
946 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
947 | <param name="addEight">When true, invoke fudge factor in parse/unparse</param> | ||
948 | </member> | ||
949 | <member name="M:s3pi.Interfaces.TGIBlockList.#ctor(System.EventHandler,System.Collections.Generic.IEnumerable{s3pi.Interfaces.TGIBlock},System.Boolean)"> | ||
950 | <summary> | ||
951 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.TGIBlockList"/> class | ||
952 | filled with the content of <paramref name="ilt"/>. | ||
953 | </summary> | ||
954 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
955 | <param name="ilt">The <see cref="T:System.Collections.Generic.IEnumerable`1"/> to use as the initial content of the list.</param> | ||
956 | <param name="addEight">When true, invoke fudge factor in parse/unparse</param> | ||
957 | </member> | ||
958 | <member name="M:s3pi.Interfaces.TGIBlockList.#ctor(System.EventHandler,System.IO.Stream,System.Int64,System.Int64,System.Boolean)"> | ||
959 | <summary> | ||
960 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.TGIBlockList"/> class | ||
961 | filled with elements from <see cref="T:System.IO.Stream"/> <paramref name="s"/>. | ||
962 | </summary> | ||
963 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
964 | <param name="s">The <see cref="T:System.IO.Stream"/> to read for the initial content of the list.</param> | ||
965 | <param name="tgiPosn">Position in the <see cref="T:System.IO.Stream"/> where the list of <see cref="T:s3pi.Interfaces.TGIBlock"/>s starts.</param> | ||
966 | <param name="tgiSize">Size (in bytes) of the stored list.</param> | ||
967 | <param name="addEight">When true, invoke fudge factor in parse/unparse</param> | ||
968 | </member> | ||
969 | <member name="M:s3pi.Interfaces.TGIBlockList.CreateElement(System.IO.Stream)"> | ||
970 | <summary> | ||
971 | Create a new element from the <see cref="T:System.IO.Stream"/>. | ||
972 | </summary> | ||
973 | <param name="s">Stream containing element data.</param> | ||
974 | <returns>A new element.</returns> | ||
975 | </member> | ||
976 | <member name="M:s3pi.Interfaces.TGIBlockList.WriteElement(System.IO.Stream,s3pi.Interfaces.TGIBlock)"> | ||
977 | <summary> | ||
978 | Write an element to the stream. | ||
979 | </summary> | ||
980 | <param name="s"><see cref="T:System.IO.Stream"/> to write <paramref name="element"/> to.</param> | ||
981 | <param name="element">Value to write to <see cref="T:System.IO.Stream"/> <paramref name="s"/>.</param> | ||
982 | </member> | ||
983 | <member name="M:s3pi.Interfaces.TGIBlockList.Parse(System.IO.Stream,System.Int64,System.Int64)"> | ||
984 | <summary> | ||
985 | Read list entries from a stream | ||
986 | </summary> | ||
987 | <param name="s">Stream containing list entries</param> | ||
988 | <param name="tgiPosn">Position in the <see cref="T:System.IO.Stream"/> where the list of <see cref="T:s3pi.Interfaces.TGIBlock"/>s starts.</param> | ||
989 | <param name="tgiSize">Size (in bytes) of the stored list.</param> | ||
990 | </member> | ||
991 | <member name="M:s3pi.Interfaces.TGIBlockList.UnParse(System.IO.Stream,System.Int64)"> | ||
992 | <summary> | ||
993 | Write list entries to a stream | ||
994 | </summary> | ||
995 | <param name="s">Stream to receive list entries</param> | ||
996 | <param name="ptgiO">Position in <see cref="T:System.IO.Stream"/> to write list position and size values.</param> | ||
997 | </member> | ||
998 | <member name="M:s3pi.Interfaces.TGIBlockList.Add"> | ||
999 | <summary> | ||
1000 | Add a new default element to the list | ||
1001 | </summary> | ||
1002 | </member> | ||
1003 | <member name="T:s3pi.Interfaces.APackage"> | ||
1004 | <summary> | ||
1005 | Abstract definition of a package | ||
1006 | </summary> | ||
1007 | </member> | ||
1008 | <member name="T:s3pi.Interfaces.IPackage"> | ||
1009 | <summary> | ||
1010 | Representation of a Sims 3 Package | ||
1011 | </summary> | ||
1012 | </member> | ||
1013 | <member name="M:s3pi.Interfaces.IPackage.SavePackage"> | ||
1014 | <summary> | ||
1015 | Tell the package to save itself to wherever it believes it came from | ||
1016 | </summary> | ||
1017 | </member> | ||
1018 | <member name="M:s3pi.Interfaces.IPackage.SaveAs(System.IO.Stream)"> | ||
1019 | <summary> | ||
1020 | Tell the package to save itself to the <see cref="T:System.IO.Stream"/> <paramref name="s"/> | ||
1021 | </summary> | ||
1022 | <param name="s">A <see cref="T:System.IO.Stream"/> to which the package should be saved</param> | ||
1023 | </member> | ||
1024 | <member name="M:s3pi.Interfaces.IPackage.SaveAs(System.String)"> | ||
1025 | <summary> | ||
1026 | Tell the package to save itself to a file with the name in <paramref name="path"/> | ||
1027 | </summary> | ||
1028 | <param name="path">A fully-qualified file name</param> | ||
1029 | </member> | ||
1030 | <member name="M:s3pi.Interfaces.IPackage.Find(System.UInt32,s3pi.Interfaces.IResourceIndexEntry)"> | ||
1031 | <summary> | ||
1032 | Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/> | ||
1033 | for the first <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> that matches the conditions defined by | ||
1034 | <paramref name="flags"/> and <paramref name="values"/>. | ||
1035 | </summary> | ||
1036 | <param name="flags">True bits enable matching against numerically equivalent <paramref name="values"/> entry.</param> | ||
1037 | <param name="values">Field values to compare against.</param> | ||
1038 | <returns>The first matching <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>, if any; otherwise null.</returns> | ||
1039 | </member> | ||
1040 | <member name="M:s3pi.Interfaces.IPackage.Find(System.String[],s3pi.Interfaces.TypedValue[])"> | ||
1041 | <summary> | ||
1042 | Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/> | ||
1043 | for the first <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> that matches the conditions defined by | ||
1044 | <paramref name="names"/> and <paramref name="values"/>. | ||
1045 | </summary> | ||
1046 | <param name="names">Names of <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> fields to compare.</param> | ||
1047 | <param name="values">Field values to compare against.</param> | ||
1048 | <returns>The first matching <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>, if any; otherwise null.</returns> | ||
1049 | </member> | ||
1050 | <member name="M:s3pi.Interfaces.IPackage.Find(System.Predicate{s3pi.Interfaces.IResourceIndexEntry})"> | ||
1051 | <summary> | ||
1052 | Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/> | ||
1053 | for the first <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> that matches the conditions defined by | ||
1054 | the <c>Predicate<IResourceIndexEntry></c> <paramref name="Match"/>. | ||
1055 | </summary> | ||
1056 | <param name="Match"><c>Predicate<IResourceIndexEntry></c> defining matching conditions.</param> | ||
1057 | <returns>The first matching <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>, if any; otherwise null.</returns> | ||
1058 | <remarks>Note that entries marked as deleted will not be returned.</remarks> | ||
1059 | </member> | ||
1060 | <member name="M:s3pi.Interfaces.IPackage.FindAll(System.UInt32,s3pi.Interfaces.IResourceIndexEntry)"> | ||
1061 | <summary> | ||
1062 | Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/> | ||
1063 | for all <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>s that matches the conditions defined by | ||
1064 | <paramref name="flags"/> and <paramref name="values"/>. | ||
1065 | </summary> | ||
1066 | <param name="flags">True bits enable matching against numerically equivalent <paramref name="values"/> entry.</param> | ||
1067 | <param name="values">Field values to compare against.</param> | ||
1068 | <returns>An <c>IList<IResourceIndexEntry></c> of zero or more matches.</returns> | ||
1069 | </member> | ||
1070 | <member name="M:s3pi.Interfaces.IPackage.FindAll(System.String[],s3pi.Interfaces.TypedValue[])"> | ||
1071 | <summary> | ||
1072 | Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/> | ||
1073 | for all <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>s that matches the conditions defined by | ||
1074 | <paramref name="names"/> and <paramref name="values"/>. | ||
1075 | </summary> | ||
1076 | <param name="names">Names of <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> fields to compare.</param> | ||
1077 | <param name="values">Field values to compare against.</param> | ||
1078 | <returns>An <c>IList<IResourceIndexEntry></c> of zero or more matches.</returns> | ||
1079 | </member> | ||
1080 | <member name="M:s3pi.Interfaces.IPackage.FindAll(System.Predicate{s3pi.Interfaces.IResourceIndexEntry})"> | ||
1081 | <summary> | ||
1082 | Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/> | ||
1083 | for all <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>s that matches the conditions defined by | ||
1084 | the <c>Predicate<IResourceIndexEntry></c> <paramref name="Match"/>. | ||
1085 | </summary> | ||
1086 | <param name="Match"><c>Predicate<IResourceIndexEntry></c> defining matching conditions.</param> | ||
1087 | <returns>Zero or more matches.</returns> | ||
1088 | <remarks>Note that entries marked as deleted will not be returned.</remarks> | ||
1089 | </member> | ||
1090 | <member name="M:s3pi.Interfaces.IPackage.AddResource(s3pi.Interfaces.IResourceKey,System.IO.Stream,System.Boolean)"> | ||
1091 | <summary> | ||
1092 | Add a resource to the <see cref="T:s3pi.Interfaces.IPackage"/>. | ||
1093 | </summary> | ||
1094 | <param name="rk">The resource's <see cref="T:s3pi.Interfaces.IResourceKey"/></param> | ||
1095 | <param name="stream">The <see cref="T:System.IO.Stream"/> that contains the resource's data</param> | ||
1096 | <param name="rejectDups">If true, fail if the <see cref="T:s3pi.Interfaces.IResourceKey"/> already exists</param> | ||
1097 | <returns>Null if rejectDups and the <see cref="T:s3pi.Interfaces.IResourceKey"/> exists; else the new <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/></returns> | ||
1098 | </member> | ||
1099 | <member name="M:s3pi.Interfaces.IPackage.ReplaceResource(s3pi.Interfaces.IResourceIndexEntry,s3pi.Interfaces.IResource)"> | ||
1100 | <summary> | ||
1101 | Tell the <see cref="T:s3pi.Interfaces.IPackage"/> to replace the data for the resource indexed by <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> <paramref name="rc"/> | ||
1102 | with the data from the <see cref="T:s3pi.Interfaces.IResource"/> <paramref name="res"/>. | ||
1103 | </summary> | ||
1104 | <param name="rc">Target <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>.</param> | ||
1105 | <param name="res">Source <see cref="T:s3pi.Interfaces.IResource"/>.</param> | ||
1106 | </member> | ||
1107 | <member name="M:s3pi.Interfaces.IPackage.DeleteResource(s3pi.Interfaces.IResourceIndexEntry)"> | ||
1108 | <summary> | ||
1109 | Tell the package to delete the resource indexed by <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> <paramref name="rc"/>. | ||
1110 | </summary> | ||
1111 | <param name="rc">Target <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>.</param> | ||
1112 | </member> | ||
1113 | <member name="P:s3pi.Interfaces.IPackage.Magic"> | ||
1114 | <summary> | ||
1115 | Package header: "DBPF" bytes | ||
1116 | </summary> | ||
1117 | </member> | ||
1118 | <member name="P:s3pi.Interfaces.IPackage.Major"> | ||
1119 | <summary> | ||
1120 | Package header: 0x00000002 | ||
1121 | </summary> | ||
1122 | </member> | ||
1123 | <member name="P:s3pi.Interfaces.IPackage.Minor"> | ||
1124 | <summary> | ||
1125 | Package header: 0x00000000 | ||
1126 | </summary> | ||
1127 | </member> | ||
1128 | <member name="P:s3pi.Interfaces.IPackage.Unknown1"> | ||
1129 | <summary> | ||
1130 | Package header: unused | ||
1131 | </summary> | ||
1132 | </member> | ||
1133 | <member name="P:s3pi.Interfaces.IPackage.Indexcount"> | ||
1134 | <summary> | ||
1135 | Package header: number of entries in the package index | ||
1136 | </summary> | ||
1137 | </member> | ||
1138 | <member name="P:s3pi.Interfaces.IPackage.Unknown2"> | ||
1139 | <summary> | ||
1140 | Package header: unused | ||
1141 | </summary> | ||
1142 | </member> | ||
1143 | <member name="P:s3pi.Interfaces.IPackage.Indexsize"> | ||
1144 | <summary> | ||
1145 | Package header: index size on disk in bytes | ||
1146 | </summary> | ||
1147 | </member> | ||
1148 | <member name="P:s3pi.Interfaces.IPackage.Unknown3"> | ||
1149 | <summary> | ||
1150 | Package header: unused | ||
1151 | </summary> | ||
1152 | </member> | ||
1153 | <member name="P:s3pi.Interfaces.IPackage.Indexversion"> | ||
1154 | <summary> | ||
1155 | Package header: always 3? | ||
1156 | </summary> | ||
1157 | </member> | ||
1158 | <member name="P:s3pi.Interfaces.IPackage.Indexposition"> | ||
1159 | <summary> | ||
1160 | Package header: index position in file | ||
1161 | </summary> | ||
1162 | </member> | ||
1163 | <member name="P:s3pi.Interfaces.IPackage.Unknown4"> | ||
1164 | <summary> | ||
1165 | Package header: unused | ||
1166 | </summary> | ||
1167 | </member> | ||
1168 | <member name="P:s3pi.Interfaces.IPackage.HeaderStream"> | ||
1169 | <summary> | ||
1170 | A <see cref="T:System.IO.MemoryStream"/> covering the package header bytes | ||
1171 | </summary> | ||
1172 | </member> | ||
1173 | <member name="E:s3pi.Interfaces.IPackage.ResourceIndexInvalidated"> | ||
1174 | <summary> | ||
1175 | Package index: raised when the result of a previous call to GetResourceList becomes invalid | ||
1176 | </summary> | ||
1177 | </member> | ||
1178 | <member name="P:s3pi.Interfaces.IPackage.Indextype"> | ||
1179 | <summary> | ||
1180 | Package index: the index format in use | ||
1181 | </summary> | ||
1182 | </member> | ||
1183 | <member name="P:s3pi.Interfaces.IPackage.GetResourceList"> | ||
1184 | <summary> | ||
1185 | Package index: the index as a <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> list | ||
1186 | </summary> | ||
1187 | </member> | ||
1188 | <member name="M:s3pi.Interfaces.APackage.SavePackage"> | ||
1189 | <summary> | ||
1190 | Tell the package to save itself to wherever it believes it came from | ||
1191 | </summary> | ||
1192 | </member> | ||
1193 | <member name="M:s3pi.Interfaces.APackage.SaveAs(System.IO.Stream)"> | ||
1194 | <summary> | ||
1195 | Tell the package to save itself to the stream <paramref name="s"/> | ||
1196 | </summary> | ||
1197 | <param name="s">A stream to which the package should be saved</param> | ||
1198 | </member> | ||
1199 | <member name="M:s3pi.Interfaces.APackage.SaveAs(System.String)"> | ||
1200 | <summary> | ||
1201 | Tell the package to save itself to a file with the name in <paramref name="path"/> | ||
1202 | </summary> | ||
1203 | <param name="path">A fully-qualified file name</param> | ||
1204 | </member> | ||
1205 | <member name="M:s3pi.Interfaces.APackage.Find(System.UInt32,s3pi.Interfaces.IResourceIndexEntry)"> | ||
1206 | <summary> | ||
1207 | Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/> | ||
1208 | for the first <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> that matches the conditions defined by | ||
1209 | <paramref name="flags"/> and <paramref name="values"/>. | ||
1210 | </summary> | ||
1211 | <param name="flags">True bits enable matching against numerically equivalent <paramref name="values"/> entry.</param> | ||
1212 | <param name="values">Field values to compare against.</param> | ||
1213 | <returns>The first matching <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>, if any; otherwise null.</returns> | ||
1214 | </member> | ||
1215 | <member name="M:s3pi.Interfaces.APackage.Find(System.String[],s3pi.Interfaces.TypedValue[])"> | ||
1216 | <summary> | ||
1217 | Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/> | ||
1218 | for the first <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> that matches the conditions defined by | ||
1219 | <paramref name="names"/> and <paramref name="values"/>. | ||
1220 | </summary> | ||
1221 | <param name="names">Names of <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> fields to compare.</param> | ||
1222 | <param name="values">Field values to compare against.</param> | ||
1223 | <returns>The first matching <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>, if any; otherwise null.</returns> | ||
1224 | </member> | ||
1225 | <member name="M:s3pi.Interfaces.APackage.Find(System.Predicate{s3pi.Interfaces.IResourceIndexEntry})"> | ||
1226 | <summary> | ||
1227 | Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/> | ||
1228 | for the first <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> that matches the conditions defined by | ||
1229 | the <c>Predicate<IResourceIndexEntry></c> <paramref name="Match"/>. | ||
1230 | </summary> | ||
1231 | <param name="Match"><c>Predicate<IResourceIndexEntry></c> defining matching conditions.</param> | ||
1232 | <returns>The first matching <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>, if any; otherwise null.</returns> | ||
1233 | <remarks>Note that entries marked as deleted will not be returned.</remarks> | ||
1234 | </member> | ||
1235 | <member name="M:s3pi.Interfaces.APackage.FindAll(System.UInt32,s3pi.Interfaces.IResourceIndexEntry)"> | ||
1236 | <summary> | ||
1237 | Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/> | ||
1238 | for all <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>s that matches the conditions defined by | ||
1239 | <paramref name="flags"/> and <paramref name="values"/>. | ||
1240 | </summary> | ||
1241 | <param name="flags">True bits enable matching against numerically equivalent <paramref name="values"/> entry.</param> | ||
1242 | <param name="values">Field values to compare against.</param> | ||
1243 | <returns>An <c>IList<IResourceIndexEntry></c> of zero or more matches.</returns> | ||
1244 | </member> | ||
1245 | <member name="M:s3pi.Interfaces.APackage.FindAll(System.String[],s3pi.Interfaces.TypedValue[])"> | ||
1246 | <summary> | ||
1247 | Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/> | ||
1248 | for all <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>s that matches the conditions defined by | ||
1249 | <paramref name="names"/> and <paramref name="values"/>. | ||
1250 | </summary> | ||
1251 | <param name="names">Names of <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> fields to compare.</param> | ||
1252 | <param name="values">Field values to compare against.</param> | ||
1253 | <returns>An <c>IList<IResourceIndexEntry></c> of zero or more matches.</returns> | ||
1254 | </member> | ||
1255 | <member name="M:s3pi.Interfaces.APackage.FindAll(System.Predicate{s3pi.Interfaces.IResourceIndexEntry})"> | ||
1256 | <summary> | ||
1257 | Searches the entire <see cref="T:s3pi.Interfaces.IPackage"/> | ||
1258 | for all <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>s that matches the conditions defined by | ||
1259 | the <c>Predicate<IResourceIndexEntry></c> <paramref name="Match"/>. | ||
1260 | </summary> | ||
1261 | <param name="Match"><c>Predicate<IResourceIndexEntry></c> defining matching conditions.</param> | ||
1262 | <returns>Zero or more matches.</returns> | ||
1263 | <remarks>Note that entries marked as deleted will not be returned.</remarks> | ||
1264 | </member> | ||
1265 | <member name="M:s3pi.Interfaces.APackage.AddResource(s3pi.Interfaces.IResourceKey,System.IO.Stream,System.Boolean)"> | ||
1266 | <summary> | ||
1267 | Add a resource to the package | ||
1268 | </summary> | ||
1269 | <param name="rk">The resource key</param> | ||
1270 | <param name="stream">The stream that contains the resource data</param> | ||
1271 | <param name="rejectDups">If true, fail if the resource key already exists</param> | ||
1272 | <returns>Null if rejectDups and the resource key exists; else the new IResourceIndexEntry</returns> | ||
1273 | </member> | ||
1274 | <member name="M:s3pi.Interfaces.APackage.ReplaceResource(s3pi.Interfaces.IResourceIndexEntry,s3pi.Interfaces.IResource)"> | ||
1275 | <summary> | ||
1276 | Tell the package to replace the data for the resource indexed by <paramref name="rc"/> | ||
1277 | with the data from the resource <paramref name="res"/> | ||
1278 | </summary> | ||
1279 | <param name="rc">Target resource index</param> | ||
1280 | <param name="res">Source resource</param> | ||
1281 | </member> | ||
1282 | <member name="M:s3pi.Interfaces.APackage.DeleteResource(s3pi.Interfaces.IResourceIndexEntry)"> | ||
1283 | <summary> | ||
1284 | Tell the package to delete the resource indexed by <paramref name="rc"/> | ||
1285 | </summary> | ||
1286 | <param name="rc">Target resource index</param> | ||
1287 | </member> | ||
1288 | <member name="M:s3pi.Interfaces.APackage.NewPackage(System.Int32)"> | ||
1289 | <summary> | ||
1290 | Initialise a new, empty package and return the IPackage reference | ||
1291 | </summary> | ||
1292 | <param name="APIversion">(unused)</param> | ||
1293 | <returns>IPackage reference to an empty package</returns> | ||
1294 | </member> | ||
1295 | <member name="M:s3pi.Interfaces.APackage.OpenPackage(System.Int32,System.String)"> | ||
1296 | <summary> | ||
1297 | Open an existing package by filename, read only | ||
1298 | </summary> | ||
1299 | <param name="APIversion">(unused)</param> | ||
1300 | <param name="packagePath">Fully qualified filename of the package</param> | ||
1301 | <returns>IPackage reference to an existing package on disk</returns> | ||
1302 | </member> | ||
1303 | <member name="M:s3pi.Interfaces.APackage.OpenPackage(System.Int32,System.String,System.Boolean)"> | ||
1304 | <summary> | ||
1305 | Open an existing package by filename, optionally readwrite | ||
1306 | </summary> | ||
1307 | <param name="APIversion">(unused)</param> | ||
1308 | <param name="packagePath">Fully qualified filename of the package</param> | ||
1309 | <param name="readwrite">True to open for update</param> | ||
1310 | <returns>IPackage reference to an existing package on disk</returns> | ||
1311 | </member> | ||
1312 | <member name="M:s3pi.Interfaces.APackage.ClosePackage(System.Int32,s3pi.Interfaces.IPackage)"> | ||
1313 | <summary> | ||
1314 | Releases any internal references associated with the given package | ||
1315 | </summary> | ||
1316 | <param name="APIversion">(unused)</param> | ||
1317 | <param name="pkg">IPackage reference to close</param> | ||
1318 | </member> | ||
1319 | <member name="M:s3pi.Interfaces.APackage.GetResource(s3pi.Interfaces.IResourceIndexEntry)"> | ||
1320 | <summary> | ||
1321 | Used by WrapperDealer to get the data for a resource | ||
1322 | </summary> | ||
1323 | <param name="rie">IResourceIndexEntry of resource</param> | ||
1324 | <returns>The resource data (uncompressed, if necessary)</returns> | ||
1325 | </member> | ||
1326 | <member name="M:s3pi.Interfaces.APackage.OnResourceIndexInvalidated(System.Object,System.EventArgs)"> | ||
1327 | <summary> | ||
1328 | Used to indicate a resource index returned by GetResourceList is no longer valid (as a whole) | ||
1329 | </summary> | ||
1330 | <param name="sender">Object causing the list to become invalid</param> | ||
1331 | <param name="e">(not used)</param> | ||
1332 | </member> | ||
1333 | <member name="P:s3pi.Interfaces.APackage.ContentFields"> | ||
1334 | <summary> | ||
1335 | The list of available field names on this API object | ||
1336 | </summary> | ||
1337 | </member> | ||
1338 | <member name="P:s3pi.Interfaces.APackage.Magic"> | ||
1339 | <summary> | ||
1340 | Package header: "DBPF" bytes | ||
1341 | </summary> | ||
1342 | </member> | ||
1343 | <member name="P:s3pi.Interfaces.APackage.Major"> | ||
1344 | <summary> | ||
1345 | Package header: 0x00000002 | ||
1346 | </summary> | ||
1347 | </member> | ||
1348 | <member name="P:s3pi.Interfaces.APackage.Minor"> | ||
1349 | <summary> | ||
1350 | Package header: 0x00000000 | ||
1351 | </summary> | ||
1352 | </member> | ||
1353 | <member name="P:s3pi.Interfaces.APackage.Unknown1"> | ||
1354 | <summary> | ||
1355 | Package header: unused | ||
1356 | </summary> | ||
1357 | </member> | ||
1358 | <member name="P:s3pi.Interfaces.APackage.Indexcount"> | ||
1359 | <summary> | ||
1360 | Package header: number of entries in the package index | ||
1361 | </summary> | ||
1362 | </member> | ||
1363 | <member name="P:s3pi.Interfaces.APackage.Unknown2"> | ||
1364 | <summary> | ||
1365 | Package header: unused | ||
1366 | </summary> | ||
1367 | </member> | ||
1368 | <member name="P:s3pi.Interfaces.APackage.Indexsize"> | ||
1369 | <summary> | ||
1370 | Package header: index size on disk in bytes | ||
1371 | </summary> | ||
1372 | </member> | ||
1373 | <member name="P:s3pi.Interfaces.APackage.Unknown3"> | ||
1374 | <summary> | ||
1375 | Package header: unused | ||
1376 | </summary> | ||
1377 | </member> | ||
1378 | <member name="P:s3pi.Interfaces.APackage.Indexversion"> | ||
1379 | <summary> | ||
1380 | Package header: always 3? | ||
1381 | </summary> | ||
1382 | </member> | ||
1383 | <member name="P:s3pi.Interfaces.APackage.Indexposition"> | ||
1384 | <summary> | ||
1385 | Package header: index position in file | ||
1386 | </summary> | ||
1387 | </member> | ||
1388 | <member name="P:s3pi.Interfaces.APackage.Unknown4"> | ||
1389 | <summary> | ||
1390 | Package header: unused | ||
1391 | </summary> | ||
1392 | </member> | ||
1393 | <member name="P:s3pi.Interfaces.APackage.HeaderStream"> | ||
1394 | <summary> | ||
1395 | A MemoryStream covering the package header bytes | ||
1396 | </summary> | ||
1397 | </member> | ||
1398 | <member name="E:s3pi.Interfaces.APackage.ResourceIndexInvalidated"> | ||
1399 | <summary> | ||
1400 | Package index: raised when the result of a previous call to GetResourceList becomes invalid | ||
1401 | </summary> | ||
1402 | </member> | ||
1403 | <member name="P:s3pi.Interfaces.APackage.Indextype"> | ||
1404 | <summary> | ||
1405 | Package index: the index format in use | ||
1406 | </summary> | ||
1407 | </member> | ||
1408 | <member name="P:s3pi.Interfaces.APackage.GetResourceList"> | ||
1409 | <summary> | ||
1410 | Package index: the index | ||
1411 | </summary> | ||
1412 | </member> | ||
1413 | <member name="T:s3pi.Interfaces.AResourceHandler"> | ||
1414 | <summary> | ||
1415 | Used by WrapperDealer to identify "interesting" classes and assemblies. | ||
1416 | The class maps implementers of AResource to string representations of ResourceType. | ||
1417 | Hence each "wrapper" assembly can contain multiple wrapper types (Type key) each of which | ||
1418 | supports one or more ResourceTypes (List<string> value). The single | ||
1419 | AResourceHandler implementation summarises what the assembly provides. | ||
1420 | </summary> | ||
1421 | </member> | ||
1422 | <member name="T:s3pi.Interfaces.IResourceHandler"> | ||
1423 | <summary> | ||
1424 | Used by <see cref="T:s3pi.Interfaces.AResourceHandler"/>, which is used by <c>WrapperDealer</c> | ||
1425 | to identify "interesting" classes within assemblies | ||
1426 | </summary> | ||
1427 | </member> | ||
1428 | <member name="M:s3pi.Interfaces.AResourceHandler.#ctor"> | ||
1429 | <summary> | ||
1430 | Create the content of the Dictionary | ||
1431 | </summary> | ||
1432 | </member> | ||
1433 | <member name="T:s3pi.Interfaces.HandlerElement`1"> | ||
1434 | <summary> | ||
1435 | An extension to <see cref="T:s3pi.Interfaces.AHandlerElement"/>, for simple data types (such as <see cref="T:System.UInt32"/>). | ||
1436 | </summary> | ||
1437 | <typeparam name="T">A simple data type (such as <see cref="T:System.UInt32"/>).</typeparam> | ||
1438 | <remarks>For an example of use, see <see cref="T:s3pi.Interfaces.SimpleList`1"/>.</remarks> | ||
1439 | <seealso cref="T:s3pi.Interfaces.SimpleList`1"/> | ||
1440 | </member> | ||
1441 | <member name="M:s3pi.Interfaces.HandlerElement`1.#ctor(System.Int32,System.EventHandler)"> | ||
1442 | <summary> | ||
1443 | Initialize a new instance with a default value. | ||
1444 | </summary> | ||
1445 | <param name="APIversion">The requested API version.</param> | ||
1446 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
1447 | </member> | ||
1448 | <member name="M:s3pi.Interfaces.HandlerElement`1.#ctor(System.Int32,System.EventHandler,`0)"> | ||
1449 | <summary> | ||
1450 | Initialize a new instance with an initial value of <paramref name="basis"/>. | ||
1451 | </summary> | ||
1452 | <param name="APIversion">The requested API version.</param> | ||
1453 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
1454 | <param name="basis">Initial value for instance.</param> | ||
1455 | </member> | ||
1456 | <member name="M:s3pi.Interfaces.HandlerElement`1.#ctor(System.Int32,System.EventHandler,s3pi.Interfaces.HandlerElement{`0})"> | ||
1457 | <summary> | ||
1458 | Initialize a new instance with an initial value from <paramref name="basis"/>. | ||
1459 | </summary> | ||
1460 | <param name="APIversion">The requested API version.</param> | ||
1461 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
1462 | <param name="basis">Element containing the initial value for instance.</param> | ||
1463 | </member> | ||
1464 | <member name="M:s3pi.Interfaces.HandlerElement`1.Clone(System.EventHandler)"> | ||
1465 | <summary> | ||
1466 | Get a copy of the HandlerElement but with a new change <see cref="T:System.EventHandler"/>. | ||
1467 | </summary> | ||
1468 | <param name="handler">The replacement HandlerElement delegate.</param> | ||
1469 | <returns>Return a copy of the HandlerElement but with a new change <see cref="T:System.EventHandler"/>.</returns> | ||
1470 | </member> | ||
1471 | <member name="M:s3pi.Interfaces.HandlerElement`1.Equals(s3pi.Interfaces.HandlerElement{`0})"> | ||
1472 | <summary> | ||
1473 | Indicates whether the current object is equal to another object of the same type. | ||
1474 | </summary> | ||
1475 | <param name="other">An object to compare with this object.</param> | ||
1476 | <returns>true if the current object is equal to the other parameter; otherwise, false.</returns> | ||
1477 | </member> | ||
1478 | <member name="M:s3pi.Interfaces.HandlerElement`1.Equals(System.Object)"> | ||
1479 | <summary> | ||
1480 | Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:s3pi.Interfaces.HandlerElement`1"/>. | ||
1481 | </summary> | ||
1482 | <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:s3pi.Interfaces.HandlerElement`1"/>.</param> | ||
1483 | <returns>true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:s3pi.Interfaces.HandlerElement`1"/>; otherwise, false.</returns> | ||
1484 | <exception cref="T:System.NullReferenceException">The obj parameter is null.</exception> | ||
1485 | </member> | ||
1486 | <member name="M:s3pi.Interfaces.HandlerElement`1.GetHashCode"> | ||
1487 | <summary> | ||
1488 | Returns the hash code for this instance. | ||
1489 | </summary> | ||
1490 | <returns>A 32-bit signed integer that is the hash code for this instance.</returns> | ||
1491 | </member> | ||
1492 | <member name="M:s3pi.Interfaces.HandlerElement`1.op_Implicit(s3pi.Interfaces.HandlerElement{`0})~`0"> | ||
1493 | <summary> | ||
1494 | Implicit cast from <see cref="T:s3pi.Interfaces.HandlerElement`1"/> to <typeparamref name="T"/>. | ||
1495 | </summary> | ||
1496 | <param name="value">Value to cast.</param> | ||
1497 | <returns>Cast value.</returns> | ||
1498 | </member> | ||
1499 | <member name="P:s3pi.Interfaces.HandlerElement`1.RecommendedApiVersion"> | ||
1500 | <summary> | ||
1501 | The best supported version of the API available | ||
1502 | </summary> | ||
1503 | </member> | ||
1504 | <member name="P:s3pi.Interfaces.HandlerElement`1.ContentFields"> | ||
1505 | <summary> | ||
1506 | The list of available field names on this API object. | ||
1507 | </summary> | ||
1508 | </member> | ||
1509 | <member name="P:s3pi.Interfaces.HandlerElement`1.Val"> | ||
1510 | <summary> | ||
1511 | The value of the object. | ||
1512 | </summary> | ||
1513 | </member> | ||
1514 | <member name="T:s3pi.Interfaces.ElementPriorityAttribute"> | ||
1515 | <summary> | ||
1516 | Element priority is used when displaying elements | ||
1517 | </summary> | ||
1518 | </member> | ||
1519 | <member name="M:s3pi.Interfaces.ElementPriorityAttribute.#ctor(System.Int32)"> | ||
1520 | <summary> | ||
1521 | Element priority is used when displaying elements | ||
1522 | </summary> | ||
1523 | <param name="priority">Element priority, lower values are higher priority</param> | ||
1524 | </member> | ||
1525 | <member name="P:s3pi.Interfaces.ElementPriorityAttribute.Priority"> | ||
1526 | <summary> | ||
1527 | Element priority, lower values are higher priority | ||
1528 | </summary> | ||
1529 | </member> | ||
1530 | <member name="T:s3pi.Interfaces.TypedValue"> | ||
1531 | <summary> | ||
1532 | A tuple associating a data type (or class) with a value object (of the given type) | ||
1533 | </summary> | ||
1534 | </member> | ||
1535 | <member name="F:s3pi.Interfaces.TypedValue.Type"> | ||
1536 | <summary> | ||
1537 | The data type | ||
1538 | </summary> | ||
1539 | </member> | ||
1540 | <member name="F:s3pi.Interfaces.TypedValue.Value"> | ||
1541 | <summary> | ||
1542 | The value | ||
1543 | </summary> | ||
1544 | </member> | ||
1545 | <member name="M:s3pi.Interfaces.TypedValue.#ctor(System.Type,System.Object)"> | ||
1546 | <summary> | ||
1547 | Create a new <see cref="T:s3pi.Interfaces.TypedValue"/> | ||
1548 | </summary> | ||
1549 | <param name="t">The data type</param> | ||
1550 | <param name="v">The value</param> | ||
1551 | </member> | ||
1552 | <member name="M:s3pi.Interfaces.TypedValue.#ctor(System.Type,System.Object,System.String)"> | ||
1553 | <summary> | ||
1554 | Create a new <see cref="T:s3pi.Interfaces.TypedValue"/> | ||
1555 | </summary> | ||
1556 | <param name="t">The data type</param> | ||
1557 | <param name="v">The value</param> | ||
1558 | <param name="f">The default format for <see cref="M:s3pi.Interfaces.TypedValue.ToString"/></param> | ||
1559 | </member> | ||
1560 | <member name="M:s3pi.Interfaces.TypedValue.op_Implicit(s3pi.Interfaces.TypedValue)~System.String"> | ||
1561 | <summary> | ||
1562 | Return a string representing the <see cref="T:s3pi.Interfaces.TypedValue"/> | ||
1563 | <paramref name="tv"/>. | ||
1564 | </summary> | ||
1565 | <param name="tv">The value to convert.</param> | ||
1566 | <returns>A string representing <paramref name="tv"/>.</returns> | ||
1567 | </member> | ||
1568 | <member name="M:s3pi.Interfaces.TypedValue.ToString"> | ||
1569 | <summary> | ||
1570 | Return the Value as a string using the default format | ||
1571 | </summary> | ||
1572 | <returns>String representation of Value in default format</returns> | ||
1573 | </member> | ||
1574 | <member name="M:s3pi.Interfaces.TypedValue.ToString(System.String)"> | ||
1575 | <summary> | ||
1576 | Return the Value as a string using the given format | ||
1577 | </summary> | ||
1578 | <param name="format">Format to use for result</param> | ||
1579 | <returns>String representation of Value in given format</returns> | ||
1580 | </member> | ||
1581 | <member name="M:s3pi.Interfaces.TypedValue.CompareTo(s3pi.Interfaces.TypedValue)"> | ||
1582 | <summary> | ||
1583 | Compare this <see cref="T:s3pi.Interfaces.TypedValue"/> to another for sort order purposes | ||
1584 | </summary> | ||
1585 | <param name="other">Target <see cref="T:s3pi.Interfaces.TypedValue"/></param> | ||
1586 | <returns>A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: | ||
1587 | <table> | ||
1588 | <thead><tr><td><strong>Value</strong></td><td><strong>Meaning</strong></td></tr></thead> | ||
1589 | <tbody> | ||
1590 | <tr><td>Less than zero</td><td>This instance is less than <paramref name="other"/>.</td></tr> | ||
1591 | <tr><td>Zero</td><td>This instance is equal to <paramref name="other"/>.</td></tr> | ||
1592 | <tr><td>Greater than zero</td><td>This instance is greater than <paramref name="other"/>.</td></tr> | ||
1593 | </tbody> | ||
1594 | </table> | ||
1595 | </returns> | ||
1596 | <exception cref="T:System.NotImplementedException">Either this object's Type or the target's is not comparable</exception> | ||
1597 | <exception cref="T:System.ArgumentException">The target is not comparable with this object</exception> | ||
1598 | </member> | ||
1599 | <member name="M:s3pi.Interfaces.TypedValue.Equals(s3pi.Interfaces.TypedValue,s3pi.Interfaces.TypedValue)"> | ||
1600 | <summary> | ||
1601 | Determines whether the specified <see cref="T:s3pi.Interfaces.TypedValue"/> instances are equal. | ||
1602 | </summary> | ||
1603 | <param name="x">The first <see cref="T:s3pi.Interfaces.TypedValue"/> to compare.</param> | ||
1604 | <param name="y">The second <see cref="T:s3pi.Interfaces.TypedValue"/> to compare.</param> | ||
1605 | <returns>true if the specified <see cref="T:s3pi.Interfaces.TypedValue"/> instances are equal; otherwise, false.</returns> | ||
1606 | </member> | ||
1607 | <member name="M:s3pi.Interfaces.TypedValue.GetHashCode(s3pi.Interfaces.TypedValue)"> | ||
1608 | <summary> | ||
1609 | Returns a hash code for the specified <see cref="T:s3pi.Interfaces.TypedValue"/>. | ||
1610 | </summary> | ||
1611 | <param name="obj">The <see cref="T:s3pi.Interfaces.TypedValue"/> for which a hash code is to be returned.</param> | ||
1612 | <returns>A hash code for the specified object.</returns> | ||
1613 | <exception cref="T:System.ArgumentNullException">The type of <paramref name="obj"/> is a reference type and | ||
1614 | <paramref name="obj"/> is null.</exception> | ||
1615 | </member> | ||
1616 | <member name="M:s3pi.Interfaces.TypedValue.Equals(s3pi.Interfaces.TypedValue)"> | ||
1617 | <summary> | ||
1618 | Indicates whether the current <see cref="T:s3pi.Interfaces.TypedValue"/> instance is equal to another <see cref="T:s3pi.Interfaces.TypedValue"/> instance. | ||
1619 | </summary> | ||
1620 | <param name="other">An <see cref="T:s3pi.Interfaces.TypedValue"/> instance to compare with this instance.</param> | ||
1621 | <returns>true if the current instance is equal to the <paramref name="other"/> parameter; otherwise, false.</returns> | ||
1622 | </member> | ||
1623 | <member name="M:s3pi.Interfaces.TypedValue.Equals(System.Object)"> | ||
1624 | <summary> | ||
1625 | Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:s3pi.Interfaces.TypedValue"/>. | ||
1626 | </summary> | ||
1627 | <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:s3pi.Interfaces.TypedValue"/>.</param> | ||
1628 | <returns>true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:s3pi.Interfaces.TypedValue"/>; otherwise, false.</returns> | ||
1629 | </member> | ||
1630 | <member name="M:s3pi.Interfaces.TypedValue.GetHashCode"> | ||
1631 | <summary> | ||
1632 | Returns the hash code for this instance. | ||
1633 | </summary> | ||
1634 | <returns>A 32-bit signed integer that is the hash code for this instance.</returns> | ||
1635 | </member> | ||
1636 | <member name="M:s3pi.Interfaces.TypedValue.GetTypeCode"> | ||
1637 | <summary> | ||
1638 | Returns the <see cref="T:System.TypeCode"/> for this instance. | ||
1639 | </summary> | ||
1640 | <returns>The enumerated constant that is the <see cref="T:System.TypeCode"/> of the <see cref="T:s3pi.Interfaces.TypedValue"/> class.</returns> | ||
1641 | </member> | ||
1642 | <member name="M:s3pi.Interfaces.TypedValue.ToBoolean(System.IFormatProvider)"> | ||
1643 | <summary> | ||
1644 | Converts the value of this instance to an equivalent <see cref="T:System.Boolean"/> value | ||
1645 | (ignoring the specified culture-specific formatting information). | ||
1646 | </summary> | ||
1647 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1648 | that supplies culture-specific formatting information.</param> | ||
1649 | <returns>A <see cref="T:System.Boolean"/> value equivalent to the value of this instance.</returns> | ||
1650 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1651 | cannot be assigned to a <see cref="T:System.Boolean"/>.</exception> | ||
1652 | </member> | ||
1653 | <member name="M:s3pi.Interfaces.TypedValue.ToByte(System.IFormatProvider)"> | ||
1654 | <summary> | ||
1655 | Converts the value of this instance to an equivalent <see cref="T:System.Byte"/> value | ||
1656 | (ignoring the specified culture-specific formatting information). | ||
1657 | </summary> | ||
1658 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1659 | that supplies culture-specific formatting information.</param> | ||
1660 | <returns>A <see cref="T:System.Byte"/> value equivalent to the value of this instance.</returns> | ||
1661 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1662 | cannot be assigned to a <see cref="T:System.Byte"/>.</exception> | ||
1663 | </member> | ||
1664 | <member name="M:s3pi.Interfaces.TypedValue.ToChar(System.IFormatProvider)"> | ||
1665 | <summary> | ||
1666 | Converts the value of this instance to an equivalent <see cref="T:System.Char"/> value | ||
1667 | (ignoring the specified culture-specific formatting information). | ||
1668 | </summary> | ||
1669 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1670 | that supplies culture-specific formatting information.</param> | ||
1671 | <returns>A <see cref="T:System.Char"/> value equivalent to the value of this instance.</returns> | ||
1672 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1673 | cannot be assigned to a <see cref="T:System.Char"/>.</exception> | ||
1674 | </member> | ||
1675 | <member name="M:s3pi.Interfaces.TypedValue.ToDateTime(System.IFormatProvider)"> | ||
1676 | <summary> | ||
1677 | Converts the value of this instance to an equivalent <see cref="T:System.DateTime"/> value | ||
1678 | (ignoring the specified culture-specific formatting information). | ||
1679 | </summary> | ||
1680 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1681 | that supplies culture-specific formatting information.</param> | ||
1682 | <returns>A <see cref="T:System.DateTime"/> value equivalent to the value of this instance.</returns> | ||
1683 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1684 | cannot be assigned to a <see cref="T:System.DateTime"/>.</exception> | ||
1685 | </member> | ||
1686 | <member name="M:s3pi.Interfaces.TypedValue.ToDecimal(System.IFormatProvider)"> | ||
1687 | <summary> | ||
1688 | Converts the value of this instance to an equivalent <see cref="T:System.Decimal"/> value | ||
1689 | (ignoring the specified culture-specific formatting information). | ||
1690 | </summary> | ||
1691 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1692 | that supplies culture-specific formatting information.</param> | ||
1693 | <returns>A <see cref="T:System.Decimal"/> value equivalent to the value of this instance.</returns> | ||
1694 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1695 | cannot be assigned to a <see cref="T:System.Decimal"/>.</exception> | ||
1696 | </member> | ||
1697 | <member name="M:s3pi.Interfaces.TypedValue.ToDouble(System.IFormatProvider)"> | ||
1698 | <summary> | ||
1699 | Converts the value of this instance to an equivalent <see cref="T:System.Double"/> value | ||
1700 | (ignoring the specified culture-specific formatting information). | ||
1701 | </summary> | ||
1702 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1703 | that supplies culture-specific formatting information.</param> | ||
1704 | <returns>A <see cref="T:System.Double"/> value equivalent to the value of this instance.</returns> | ||
1705 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1706 | cannot be assigned to a <see cref="T:System.Double"/>.</exception> | ||
1707 | </member> | ||
1708 | <member name="M:s3pi.Interfaces.TypedValue.ToInt16(System.IFormatProvider)"> | ||
1709 | <summary> | ||
1710 | Converts the value of this instance to an equivalent <see cref="T:System.Int16"/> value | ||
1711 | (ignoring the specified culture-specific formatting information). | ||
1712 | </summary> | ||
1713 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1714 | that supplies culture-specific formatting information.</param> | ||
1715 | <returns>A <see cref="T:System.Int16"/> value equivalent to the value of this instance.</returns> | ||
1716 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1717 | cannot be assigned to a <see cref="T:System.Int16"/>.</exception> | ||
1718 | </member> | ||
1719 | <member name="M:s3pi.Interfaces.TypedValue.ToInt32(System.IFormatProvider)"> | ||
1720 | <summary> | ||
1721 | Converts the value of this instance to an equivalent <see cref="T:System.Int32"/> value | ||
1722 | (ignoring the specified culture-specific formatting information). | ||
1723 | </summary> | ||
1724 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1725 | that supplies culture-specific formatting information.</param> | ||
1726 | <returns>A <see cref="T:System.Int32"/> value equivalent to the value of this instance.</returns> | ||
1727 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1728 | cannot be assigned to a <see cref="T:System.Int32"/>.</exception> | ||
1729 | </member> | ||
1730 | <member name="M:s3pi.Interfaces.TypedValue.ToInt64(System.IFormatProvider)"> | ||
1731 | <summary> | ||
1732 | Converts the value of this instance to an equivalent <see cref="T:System.Int64"/> value | ||
1733 | (ignoring the specified culture-specific formatting information). | ||
1734 | </summary> | ||
1735 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1736 | that supplies culture-specific formatting information.</param> | ||
1737 | <returns>A <see cref="T:System.Int64"/> value equivalent to the value of this instance.</returns> | ||
1738 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1739 | cannot be assigned to a <see cref="T:System.Int64"/>.</exception> | ||
1740 | </member> | ||
1741 | <member name="M:s3pi.Interfaces.TypedValue.ToSByte(System.IFormatProvider)"> | ||
1742 | <summary> | ||
1743 | Converts the value of this instance to an equivalent <see cref="T:System.SByte"/> value | ||
1744 | (ignoring the specified culture-specific formatting information). | ||
1745 | </summary> | ||
1746 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1747 | that supplies culture-specific formatting information.</param> | ||
1748 | <returns>A <see cref="T:System.SByte"/> value equivalent to the value of this instance.</returns> | ||
1749 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1750 | cannot be assigned to a <see cref="T:System.SByte"/>.</exception> | ||
1751 | </member> | ||
1752 | <member name="M:s3pi.Interfaces.TypedValue.ToSingle(System.IFormatProvider)"> | ||
1753 | <summary> | ||
1754 | Converts the value of this instance to an equivalent <see cref="T:System.Single"/> value | ||
1755 | (ignoring the specified culture-specific formatting information). | ||
1756 | </summary> | ||
1757 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1758 | that supplies culture-specific formatting information.</param> | ||
1759 | <returns>A <see cref="T:System.Single"/> value equivalent to the value of this instance.</returns> | ||
1760 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1761 | cannot be assigned to a <see cref="T:System.Single"/>.</exception> | ||
1762 | </member> | ||
1763 | <member name="M:s3pi.Interfaces.TypedValue.ToString(System.IFormatProvider)"> | ||
1764 | <summary> | ||
1765 | Converts the value of this instance to an equivalent <see cref="T:System.String"/> value | ||
1766 | (ignoring the specified culture-specific formatting information). | ||
1767 | </summary> | ||
1768 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1769 | that supplies culture-specific formatting information.</param> | ||
1770 | <returns>A <see cref="T:System.String"/> value equivalent to the value of this instance.</returns> | ||
1771 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1772 | cannot be assigned to a <see cref="T:System.String"/>.</exception> | ||
1773 | </member> | ||
1774 | <member name="M:s3pi.Interfaces.TypedValue.ToType(System.Type,System.IFormatProvider)"> | ||
1775 | <summary> | ||
1776 | Converts the value of this instance to an <see cref="T:System.Object"/> of the specified <see cref="F:s3pi.Interfaces.TypedValue.Type"/> | ||
1777 | that has an equivalent value, using the specified culture-specific formatting information. | ||
1778 | </summary> | ||
1779 | <param name="conversionType">The <see cref="F:s3pi.Interfaces.TypedValue.Type"/> to which the value of this instance is converted.</param> | ||
1780 | <param name="provider">An <see cref="T:System.IFormatProvider"/> interface implementation that supplies culture-specific formatting information.</param> | ||
1781 | <returns>An <see cref="T:System.Object"/> instance of type <paramref name="conversionType"/> whose value is equivalent to the value of this instance.</returns> | ||
1782 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1783 | cannot be assigned to a <paramref name="conversionType"/> object.</exception> | ||
1784 | </member> | ||
1785 | <member name="M:s3pi.Interfaces.TypedValue.ToUInt16(System.IFormatProvider)"> | ||
1786 | <summary> | ||
1787 | Converts the value of this instance to an equivalent <see cref="T:System.UInt16"/> value | ||
1788 | (ignoring the specified culture-specific formatting information). | ||
1789 | </summary> | ||
1790 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1791 | that supplies culture-specific formatting information.</param> | ||
1792 | <returns>A <see cref="T:System.UInt16"/> value equivalent to the value of this instance.</returns> | ||
1793 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1794 | cannot be assigned to a <see cref="T:System.UInt16"/>.</exception> | ||
1795 | </member> | ||
1796 | <member name="M:s3pi.Interfaces.TypedValue.ToUInt32(System.IFormatProvider)"> | ||
1797 | <summary> | ||
1798 | Converts the value of this instance to an equivalent <see cref="T:System.UInt32"/> value | ||
1799 | (ignoring the specified culture-specific formatting information). | ||
1800 | </summary> | ||
1801 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1802 | that supplies culture-specific formatting information.</param> | ||
1803 | <returns>A <see cref="T:System.UInt32"/> value equivalent to the value of this instance.</returns> | ||
1804 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1805 | cannot be assigned to a <see cref="T:System.UInt32"/>.</exception> | ||
1806 | </member> | ||
1807 | <member name="M:s3pi.Interfaces.TypedValue.ToUInt64(System.IFormatProvider)"> | ||
1808 | <summary> | ||
1809 | Converts the value of this instance to an equivalent <see cref="T:System.UInt64"/> value | ||
1810 | (ignoring the specified culture-specific formatting information). | ||
1811 | </summary> | ||
1812 | <param name="provider">(unused, may be null) An <see cref="T:System.IFormatProvider"/> interface implementation | ||
1813 | that supplies culture-specific formatting information.</param> | ||
1814 | <returns>A <see cref="T:System.UInt64"/> value equivalent to the value of this instance.</returns> | ||
1815 | <exception cref="T:System.NotImplementedException">Thrown if the <see cref="T:s3pi.Interfaces.TypedValue"/> value | ||
1816 | cannot be assigned to a <see cref="T:System.UInt64"/>.</exception> | ||
1817 | </member> | ||
1818 | <member name="M:s3pi.Interfaces.TypedValue.Clone"> | ||
1819 | <summary> | ||
1820 | Creates a new object that is a copy of the current instance. | ||
1821 | </summary> | ||
1822 | <returns>A new object that is a copy of this instance.</returns> | ||
1823 | <exception cref="T:System.NotImplementedException">Thrown if the value cannot be cloned.</exception> | ||
1824 | </member> | ||
1825 | <member name="M:s3pi.Interfaces.TypedValue.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> | ||
1826 | <summary> | ||
1827 | Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize the target object. | ||
1828 | </summary> | ||
1829 | <param name="info">The System.Runtime.Serialization.SerializationInfo to populate with data.</param> | ||
1830 | <param name="context">The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.</param> | ||
1831 | <exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception> | ||
1832 | </member> | ||
1833 | <member name="T:s3pi.Interfaces.AResource"> | ||
1834 | <summary> | ||
1835 | A resource contained in a package. | ||
1836 | </summary> | ||
1837 | </member> | ||
1838 | <member name="T:s3pi.Interfaces.IResource"> | ||
1839 | <summary> | ||
1840 | Minimal resource interface | ||
1841 | </summary> | ||
1842 | </member> | ||
1843 | <member name="P:s3pi.Interfaces.IResource.Stream"> | ||
1844 | <summary> | ||
1845 | The resource content as a <see cref="T:System.IO.Stream"/>. | ||
1846 | </summary> | ||
1847 | </member> | ||
1848 | <member name="P:s3pi.Interfaces.IResource.AsBytes"> | ||
1849 | <summary> | ||
1850 | The resource content as a <see cref="T:System.Byte"/> array | ||
1851 | </summary> | ||
1852 | </member> | ||
1853 | <member name="E:s3pi.Interfaces.IResource.ResourceChanged"> | ||
1854 | <summary> | ||
1855 | Raised if the resource is changed | ||
1856 | </summary> | ||
1857 | </member> | ||
1858 | <member name="F:s3pi.Interfaces.AResource.stream"> | ||
1859 | <summary> | ||
1860 | Resource data <see cref="T:System.IO.Stream"/> | ||
1861 | </summary> | ||
1862 | </member> | ||
1863 | <member name="F:s3pi.Interfaces.AResource.dirty"> | ||
1864 | <summary> | ||
1865 | Indicates the resource stream may no longer reflect the resource content | ||
1866 | </summary> | ||
1867 | </member> | ||
1868 | <member name="M:s3pi.Interfaces.AResource.#ctor(System.Int32,System.IO.Stream)"> | ||
1869 | <summary> | ||
1870 | Create a new instance of the resource | ||
1871 | </summary> | ||
1872 | <param name="APIversion">Requested API version</param> | ||
1873 | <param name="s"><see cref="T:System.IO.Stream"/> to use, or null to create from scratch.</param> | ||
1874 | </member> | ||
1875 | <member name="M:s3pi.Interfaces.AResource.UnParse"> | ||
1876 | <summary> | ||
1877 | AResource classes must supply an <see cref="M:s3pi.Interfaces.AResource.UnParse"/> method that serializes the class to a <see cref="T:System.IO.Stream"/> that is returned. | ||
1878 | </summary> | ||
1879 | <returns><see cref="T:System.IO.Stream"/> containing serialized class data.</returns> | ||
1880 | </member> | ||
1881 | <member name="M:s3pi.Interfaces.AResource.OnResourceChanged(System.Object,System.EventArgs)"> | ||
1882 | <summary> | ||
1883 | AResource classes must use this to indicate the resource has changed. | ||
1884 | </summary> | ||
1885 | <param name="sender">The resource (or sub-class) that has changed.</param> | ||
1886 | <param name="e">(Empty) event data object.</param> | ||
1887 | </member> | ||
1888 | <member name="P:s3pi.Interfaces.AResource.ContentFields"> | ||
1889 | <summary> | ||
1890 | A <see cref="T:System.Collections.Generic.List`1"/> of available field names on object | ||
1891 | </summary> | ||
1892 | </member> | ||
1893 | <member name="P:s3pi.Interfaces.AResource.Stream"> | ||
1894 | <summary> | ||
1895 | The resource content as a <see cref="T:System.IO.Stream"/>. | ||
1896 | </summary> | ||
1897 | </member> | ||
1898 | <member name="P:s3pi.Interfaces.AResource.AsBytes"> | ||
1899 | <summary> | ||
1900 | The resource content as a <see cref="T:System.Byte"/> array | ||
1901 | </summary> | ||
1902 | </member> | ||
1903 | <member name="E:s3pi.Interfaces.AResource.ResourceChanged"> | ||
1904 | <summary> | ||
1905 | Raised if the resource is changed | ||
1906 | </summary> | ||
1907 | </member> | ||
1908 | <member name="T:s3pi.Interfaces.IResourceIndexEntry"> | ||
1909 | <summary> | ||
1910 | An index entry within a package | ||
1911 | </summary> | ||
1912 | </member> | ||
1913 | <member name="P:s3pi.Interfaces.IResourceIndexEntry.Chunkoffset"> | ||
1914 | <summary> | ||
1915 | If the resource was read from a package, the location in the package the resource was read from | ||
1916 | </summary> | ||
1917 | </member> | ||
1918 | <member name="P:s3pi.Interfaces.IResourceIndexEntry.Filesize"> | ||
1919 | <summary> | ||
1920 | The number of bytes the resource uses within the package | ||
1921 | </summary> | ||
1922 | </member> | ||
1923 | <member name="P:s3pi.Interfaces.IResourceIndexEntry.Memsize"> | ||
1924 | <summary> | ||
1925 | The number of bytes the resource uses in memory | ||
1926 | </summary> | ||
1927 | </member> | ||
1928 | <member name="P:s3pi.Interfaces.IResourceIndexEntry.Compressed"> | ||
1929 | <summary> | ||
1930 | 0xFFFF if Filesize != Memsize, else 0x0000 | ||
1931 | </summary> | ||
1932 | </member> | ||
1933 | <member name="P:s3pi.Interfaces.IResourceIndexEntry.Unknown2"> | ||
1934 | <summary> | ||
1935 | Always 0x0001 | ||
1936 | </summary> | ||
1937 | </member> | ||
1938 | <member name="P:s3pi.Interfaces.IResourceIndexEntry.Stream"> | ||
1939 | <summary> | ||
1940 | A <see cref="T:System.IO.MemoryStream"/> covering the index entry bytes | ||
1941 | </summary> | ||
1942 | </member> | ||
1943 | <member name="P:s3pi.Interfaces.IResourceIndexEntry.IsDeleted"> | ||
1944 | <summary> | ||
1945 | True if the index entry has been deleted from the package index | ||
1946 | </summary> | ||
1947 | </member> | ||
1948 | <member name="T:s3pi.Interfaces.Vertex"> | ||
1949 | <summary> | ||
1950 | Defines a vertex - a point in 3d space defined by three coordinates. | ||
1951 | </summary> | ||
1952 | </member> | ||
1953 | <member name="M:s3pi.Interfaces.Vertex.#ctor(System.Int32,System.EventHandler)"> | ||
1954 | <summary> | ||
1955 | Create a vertex at { 0, 0, 0 }. | ||
1956 | </summary> | ||
1957 | <param name="APIversion">The requested API version.</param> | ||
1958 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
1959 | </member> | ||
1960 | <member name="M:s3pi.Interfaces.Vertex.#ctor(System.Int32,System.EventHandler,System.IO.Stream)"> | ||
1961 | <summary> | ||
1962 | Create a vertex from a <see cref="T:System.IO.Stream"/>. | ||
1963 | </summary> | ||
1964 | <param name="APIversion">The requested API version.</param> | ||
1965 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
1966 | <param name="s"><see cref="T:System.IO.Stream"/> containing coordinates.</param> | ||
1967 | </member> | ||
1968 | <member name="M:s3pi.Interfaces.Vertex.#ctor(System.Int32,System.EventHandler,s3pi.Interfaces.Vertex)"> | ||
1969 | <summary> | ||
1970 | Create a vertex from a given value. | ||
1971 | </summary> | ||
1972 | <param name="APIversion">The requested API version.</param> | ||
1973 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
1974 | <param name="basis"><see cref="T:s3pi.Interfaces.Vertex"/> to copy.</param> | ||
1975 | </member> | ||
1976 | <member name="M:s3pi.Interfaces.Vertex.#ctor(System.Int32,System.EventHandler,System.Single,System.Single,System.Single)"> | ||
1977 | <summary> | ||
1978 | Create a vertex at { x, y, z }. | ||
1979 | </summary> | ||
1980 | <param name="APIversion">The requested API version.</param> | ||
1981 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
1982 | <param name="x">X coordinate.</param> | ||
1983 | <param name="y">Y coordinate.</param> | ||
1984 | <param name="z">Z coordinate.</param> | ||
1985 | </member> | ||
1986 | <member name="M:s3pi.Interfaces.Vertex.UnParse(System.IO.Stream)"> | ||
1987 | <summary> | ||
1988 | Write the vertex to the given <see cref="T:System.IO.Stream"/>. | ||
1989 | </summary> | ||
1990 | <param name="s"><see cref="T:System.IO.Stream"/> to contain coordinates.</param> | ||
1991 | </member> | ||
1992 | <member name="M:s3pi.Interfaces.Vertex.Clone(System.EventHandler)"> | ||
1993 | <summary> | ||
1994 | Get a copy of the <see cref="T:s3pi.Interfaces.Vertex"/> but with a new change <see cref="T:System.EventHandler"/>. | ||
1995 | </summary> | ||
1996 | <param name="handler">The replacement <see cref="T:System.EventHandler"/> delegate.</param> | ||
1997 | <returns>Return a copy of the <see cref="T:s3pi.Interfaces.Vertex"/> but with a new change <see cref="T:System.EventHandler"/>.</returns> | ||
1998 | </member> | ||
1999 | <member name="M:s3pi.Interfaces.Vertex.Equals(s3pi.Interfaces.Vertex)"> | ||
2000 | <summary> | ||
2001 | Indicates whether the current object is equal to another object of the same type. | ||
2002 | </summary> | ||
2003 | <param name="other">An object to compare with this object.</param> | ||
2004 | <returns>true if the current object is equal to the other parameter; otherwise, false.</returns> | ||
2005 | </member> | ||
2006 | <member name="M:s3pi.Interfaces.Vertex.Equals(System.Object)"> | ||
2007 | <summary> | ||
2008 | Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:s3pi.Interfaces.Vertex"/>. | ||
2009 | </summary> | ||
2010 | <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:s3pi.Interfaces.Vertex"/>.</param> | ||
2011 | <returns>true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:s3pi.Interfaces.Vertex"/>; otherwise, false.</returns> | ||
2012 | </member> | ||
2013 | <member name="M:s3pi.Interfaces.Vertex.GetHashCode"> | ||
2014 | <summary> | ||
2015 | Returns the hash code for this instance. | ||
2016 | </summary> | ||
2017 | <returns>A 32-bit signed integer that is the hash code for this instance.</returns> | ||
2018 | </member> | ||
2019 | <member name="P:s3pi.Interfaces.Vertex.RecommendedApiVersion"> | ||
2020 | <summary> | ||
2021 | The best supported version of the API available | ||
2022 | </summary> | ||
2023 | </member> | ||
2024 | <member name="P:s3pi.Interfaces.Vertex.ContentFields"> | ||
2025 | <summary> | ||
2026 | The list of available field names on this API object. | ||
2027 | </summary> | ||
2028 | </member> | ||
2029 | <member name="P:s3pi.Interfaces.Vertex.X"> | ||
2030 | <summary> | ||
2031 | X coordinate | ||
2032 | </summary> | ||
2033 | </member> | ||
2034 | <member name="P:s3pi.Interfaces.Vertex.Y"> | ||
2035 | <summary> | ||
2036 | Y coordinate | ||
2037 | </summary> | ||
2038 | </member> | ||
2039 | <member name="P:s3pi.Interfaces.Vertex.Z"> | ||
2040 | <summary> | ||
2041 | Z coordinate | ||
2042 | </summary> | ||
2043 | </member> | ||
2044 | <member name="P:s3pi.Interfaces.Vertex.Value"> | ||
2045 | <summary> | ||
2046 | A displayable representation of the object | ||
2047 | </summary> | ||
2048 | </member> | ||
2049 | <member name="T:s3pi.Interfaces.BoundingBox"> | ||
2050 | <summary> | ||
2051 | Defines a bounding box - a imaginary box large enough to completely contain an object | ||
2052 | - by its minimum and maximum vertices. | ||
2053 | </summary> | ||
2054 | </member> | ||
2055 | <member name="M:s3pi.Interfaces.BoundingBox.#ctor(System.Int32,System.EventHandler)"> | ||
2056 | <summary> | ||
2057 | Create an zero-sized bounding box. | ||
2058 | </summary> | ||
2059 | <param name="APIversion">The requested API version.</param> | ||
2060 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
2061 | </member> | ||
2062 | <member name="M:s3pi.Interfaces.BoundingBox.#ctor(System.Int32,System.EventHandler,System.IO.Stream)"> | ||
2063 | <summary> | ||
2064 | Create a bounding box from a <see cref="T:System.IO.Stream"/>. | ||
2065 | </summary> | ||
2066 | <param name="APIversion">The requested API version.</param> | ||
2067 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
2068 | <param name="s"><see cref="T:System.IO.Stream"/> containing vertices.</param> | ||
2069 | </member> | ||
2070 | <member name="M:s3pi.Interfaces.BoundingBox.#ctor(System.Int32,System.EventHandler,s3pi.Interfaces.BoundingBox)"> | ||
2071 | <summary> | ||
2072 | Create a bounding box from a given value. | ||
2073 | </summary> | ||
2074 | <param name="APIversion">The requested API version.</param> | ||
2075 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
2076 | <param name="basis"><see cref="T:s3pi.Interfaces.BoundingBox"/> to copy.</param> | ||
2077 | </member> | ||
2078 | <member name="M:s3pi.Interfaces.BoundingBox.#ctor(System.Int32,System.EventHandler,s3pi.Interfaces.Vertex,s3pi.Interfaces.Vertex)"> | ||
2079 | <summary> | ||
2080 | Create a bounding box with the specified minimum and maximum vertices. | ||
2081 | </summary> | ||
2082 | <param name="APIversion">The requested API version.</param> | ||
2083 | <param name="handler">The <see cref="T:System.EventHandler"/> delegate to invoke if the <see cref="T:s3pi.Interfaces.AHandlerElement"/> changes.</param> | ||
2084 | <param name="min">Minimum vertex.</param> | ||
2085 | <param name="max">Maximum vertex.</param> | ||
2086 | </member> | ||
2087 | <member name="M:s3pi.Interfaces.BoundingBox.UnParse(System.IO.Stream)"> | ||
2088 | <summary> | ||
2089 | Write the bounding box to the given <see cref="T:System.IO.Stream"/>. | ||
2090 | </summary> | ||
2091 | <param name="s"><see cref="T:System.IO.Stream"/> to contain vertices.</param> | ||
2092 | </member> | ||
2093 | <member name="M:s3pi.Interfaces.BoundingBox.Clone(System.EventHandler)"> | ||
2094 | <summary> | ||
2095 | Get a copy of the <see cref="T:s3pi.Interfaces.BoundingBox"/> but with a new change <see cref="T:System.EventHandler"/>. | ||
2096 | </summary> | ||
2097 | <param name="handler">The replacement <see cref="T:System.EventHandler"/> delegate.</param> | ||
2098 | <returns>Return a copy of the <see cref="T:s3pi.Interfaces.BoundingBox"/> but with a new change <see cref="T:System.EventHandler"/>.</returns> | ||
2099 | </member> | ||
2100 | <member name="M:s3pi.Interfaces.BoundingBox.Equals(s3pi.Interfaces.BoundingBox)"> | ||
2101 | <summary> | ||
2102 | Indicates whether the current object is equal to another object of the same type. | ||
2103 | </summary> | ||
2104 | <param name="other">An object to compare with this object.</param> | ||
2105 | <returns>true if the current object is equal to the other parameter; otherwise, false.</returns> | ||
2106 | </member> | ||
2107 | <member name="M:s3pi.Interfaces.BoundingBox.Equals(System.Object)"> | ||
2108 | <summary> | ||
2109 | Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:s3pi.Interfaces.BoundingBox"/>. | ||
2110 | </summary> | ||
2111 | <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:s3pi.Interfaces.BoundingBox"/>.</param> | ||
2112 | <returns>true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:s3pi.Interfaces.BoundingBox"/>; otherwise, false.</returns> | ||
2113 | </member> | ||
2114 | <member name="M:s3pi.Interfaces.BoundingBox.GetHashCode"> | ||
2115 | <summary> | ||
2116 | Returns the hash code for this instance. | ||
2117 | </summary> | ||
2118 | <returns>A 32-bit signed integer that is the hash code for this instance.</returns> | ||
2119 | </member> | ||
2120 | <member name="P:s3pi.Interfaces.BoundingBox.RecommendedApiVersion"> | ||
2121 | <summary> | ||
2122 | The best supported version of the API available | ||
2123 | </summary> | ||
2124 | </member> | ||
2125 | <member name="P:s3pi.Interfaces.BoundingBox.ContentFields"> | ||
2126 | <summary> | ||
2127 | The list of available field names on this API object. | ||
2128 | </summary> | ||
2129 | </member> | ||
2130 | <member name="P:s3pi.Interfaces.BoundingBox.Min"> | ||
2131 | <summary> | ||
2132 | Minimum vertex | ||
2133 | </summary> | ||
2134 | </member> | ||
2135 | <member name="P:s3pi.Interfaces.BoundingBox.Max"> | ||
2136 | <summary> | ||
2137 | Maximum vertex | ||
2138 | </summary> | ||
2139 | </member> | ||
2140 | <member name="P:s3pi.Interfaces.BoundingBox.Value"> | ||
2141 | <summary> | ||
2142 | A displayable representation of the object | ||
2143 | </summary> | ||
2144 | </member> | ||
2145 | <member name="T:s3pi.Interfaces.AResourceIndexEntry"> | ||
2146 | <summary> | ||
2147 | An abstract class, descended from <see cref="T:s3pi.Interfaces.AResourceKey"/>, providing an abstract implemention of <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/>, | ||
2148 | representing an index entry within a package. | ||
2149 | </summary> | ||
2150 | </member> | ||
2151 | <member name="M:s3pi.Interfaces.AResourceIndexEntry.#ctor"> | ||
2152 | <summary> | ||
2153 | Initialize a new instance with the default API version and no change <see cref="T:System.EventHandler"/>. | ||
2154 | </summary> | ||
2155 | </member> | ||
2156 | <member name="F:s3pi.Interfaces.AResourceIndexEntry.ResourceIndexEntryChanged"> | ||
2157 | <summary> | ||
2158 | Raised when the AResourceIndexEntry changes | ||
2159 | </summary> | ||
2160 | </member> | ||
2161 | <member name="M:s3pi.Interfaces.AResourceIndexEntry.Equals(s3pi.Interfaces.IResourceIndexEntry)"> | ||
2162 | <summary> | ||
2163 | Indicates whether the current <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> instance is equal to another <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> instance. | ||
2164 | </summary> | ||
2165 | <param name="other">An <see cref="T:s3pi.Interfaces.IResourceIndexEntry"/> instance to compare with this instance.</param> | ||
2166 | <returns>true if the current instance is equal to the <paramref name="other"/> parameter; otherwise, false.</returns> | ||
2167 | </member> | ||
2168 | <member name="M:s3pi.Interfaces.AResourceIndexEntry.Equals(System.Object)"> | ||
2169 | <summary> | ||
2170 | Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:s3pi.Interfaces.AResourceIndexEntry"/>. | ||
2171 | </summary> | ||
2172 | <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:s3pi.Interfaces.AResourceIndexEntry"/>.</param> | ||
2173 | <returns>true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:s3pi.Interfaces.AResourceIndexEntry"/>; otherwise, false.</returns> | ||
2174 | </member> | ||
2175 | <member name="M:s3pi.Interfaces.AResourceIndexEntry.GetHashCode"> | ||
2176 | <summary> | ||
2177 | Returns the hash code for this instance. | ||
2178 | </summary> | ||
2179 | <returns>A 32-bit signed integer that is the hash code for this instance.</returns> | ||
2180 | </member> | ||
2181 | <member name="P:s3pi.Interfaces.AResourceIndexEntry.ContentFields"> | ||
2182 | <summary> | ||
2183 | The list of available field names on this API object | ||
2184 | </summary> | ||
2185 | </member> | ||
2186 | <member name="P:s3pi.Interfaces.AResourceIndexEntry.Chunkoffset"> | ||
2187 | <summary> | ||
2188 | If the resource was read from a package, the location in the package the resource was read from | ||
2189 | </summary> | ||
2190 | </member> | ||
2191 | <member name="P:s3pi.Interfaces.AResourceIndexEntry.Filesize"> | ||
2192 | <summary> | ||
2193 | The number of bytes the resource uses within the package | ||
2194 | </summary> | ||
2195 | </member> | ||
2196 | <member name="P:s3pi.Interfaces.AResourceIndexEntry.Memsize"> | ||
2197 | <summary> | ||
2198 | The number of bytes the resource uses in memory | ||
2199 | </summary> | ||
2200 | </member> | ||
2201 | <member name="P:s3pi.Interfaces.AResourceIndexEntry.Compressed"> | ||
2202 | <summary> | ||
2203 | 0xFFFF if Filesize != Memsize, else 0x0000 | ||
2204 | </summary> | ||
2205 | </member> | ||
2206 | <member name="P:s3pi.Interfaces.AResourceIndexEntry.Unknown2"> | ||
2207 | <summary> | ||
2208 | Always 0x0001 | ||
2209 | </summary> | ||
2210 | </member> | ||
2211 | <member name="P:s3pi.Interfaces.AResourceIndexEntry.Stream"> | ||
2212 | <summary> | ||
2213 | A MemoryStream covering the index entry bytes | ||
2214 | </summary> | ||
2215 | </member> | ||
2216 | <member name="P:s3pi.Interfaces.AResourceIndexEntry.IsDeleted"> | ||
2217 | <summary> | ||
2218 | True if the index entry has been deleted from the package index | ||
2219 | </summary> | ||
2220 | </member> | ||
2221 | <member name="T:s3pi.Interfaces.SimpleList`1"> | ||
2222 | <summary> | ||
2223 | A flexible generic list that implements <see cref="T:s3pi.Interfaces.DependentList`1"/> for | ||
2224 | a simple data type (such as <see cref="T:System.UInt32"/>). | ||
2225 | </summary> | ||
2226 | <typeparam name="T">A simple data type (such as <see cref="T:System.UInt32"/>).</typeparam> | ||
2227 | <example> | ||
2228 | The following method shows a way to create a list of UInt32 values, with an Int32 entry count | ||
2229 | stored in the stream immediately before the list. | ||
2230 | <code> | ||
2231 | <![CDATA[ | ||
2232 | SimpleList<UInt32> ReadUInt32List(EventHandler e, Stream s) | ||
2233 | { | ||
2234 | return new SimpleList<UInt32>(e, s, | ||
2235 | s => new BinaryReader(s).ReadUInt32(), | ||
2236 | (s, value) => new BinaryWriter(s).Write(value)); | ||
2237 | } | ||
2238 | ]]> | ||
2239 | </code> | ||
2240 | For more complex cases, or where repeated use of the same kind of <see cref="T:s3pi.Interfaces.SimpleList`1"/> is needed in different contexts, | ||
2241 | it can be worthwhile extending the class, as shown below. This example is for a list of byte values prefixed | ||
2242 | by a one byte count. It shows that the list length can also be specified (here using <c>Byte.MaxValue</c> | ||
2243 | <code> | ||
2244 | <![CDATA[ | ||
2245 | public class ByteList : SimpleList<Byte> | ||
2246 | { | ||
2247 | public ByteList(EventHandler handler) : base(handler, ReadByte, WriteByte, Byte.MaxValue, ReadListCount, WriteListCount) { } | ||
2248 | public ByteList(EventHandler handler, Stream s) : base(handler, s, ReadByte, WriteByte, Byte.MaxValue, ReadListCount, WriteListCount) { } | ||
2249 | public ByteList(EventHandler handler, IList<Byte> le) : base(handler, le, ReadByte, WriteByte Byte.MaxValue, ReadListCount, WriteListCount) { } | ||
2250 | |||
2251 | static uint ReadListCount(Stream s) { return new BinaryReader(s).ReadByte(); } | ||
2252 | static void WriteListCount(Stream s, uint count) { new BinaryWriter(s).Write((byte)count); } | ||
2253 | static byte ReadByte(Stream s) { return new BinaryReader(s).ReadByte(); } | ||
2254 | static void WriteByte(Stream s, byte value) { new BinaryWriter(s).Write(value); } | ||
2255 | } | ||
2256 | ]]> | ||
2257 | </code> | ||
2258 | </example> | ||
2259 | <seealso cref="T:s3pi.Interfaces.HandlerElement`1"/> | ||
2260 | </member> | ||
2261 | <member name="M:s3pi.Interfaces.SimpleList`1.#ctor(System.EventHandler,s3pi.Interfaces.SimpleList{`0}.CreateElementMethod,s3pi.Interfaces.SimpleList{`0}.WriteElementMethod,System.Int64,s3pi.Interfaces.SimpleList{`0}.ReadCountMethod,s3pi.Interfaces.SimpleList{`0}.WriteCountMethod)"> | ||
2262 | <summary> | ||
2263 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.SimpleList`1"/> class | ||
2264 | that is empty. | ||
2265 | </summary> | ||
2266 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
2267 | <param name="createElement">Optional; the method to create a new element in the list from a stream. If null, return default{T}.</param> | ||
2268 | <param name="writeElement">Optional; the method to create a new element in the list from a stream. No operation if null.</param> | ||
2269 | <param name="size">Optional maximum number of elements in the list.</param> | ||
2270 | <param name="readCount">Optional; default is to read a <see cref="T:System.Int32"/> from the <see cref="T:System.IO.Stream"/>.</param> | ||
2271 | <param name="writeCount">Optional; default is to write a <see cref="T:System.Int32"/> to the <see cref="T:System.IO.Stream"/>.</param> | ||
2272 | </member> | ||
2273 | <member name="M:s3pi.Interfaces.SimpleList`1.#ctor(System.EventHandler,System.IO.Stream,s3pi.Interfaces.SimpleList{`0}.CreateElementMethod,s3pi.Interfaces.SimpleList{`0}.WriteElementMethod,System.Int64,s3pi.Interfaces.SimpleList{`0}.ReadCountMethod,s3pi.Interfaces.SimpleList{`0}.WriteCountMethod)"> | ||
2274 | <summary> | ||
2275 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.SimpleList`1"/> class | ||
2276 | from <paramref name="s"/>. | ||
2277 | </summary> | ||
2278 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
2279 | <param name="s">The <see cref="T:System.IO.Stream"/> to read for the initial content of the list.</param> | ||
2280 | <param name="createElement">Required; the method to create a new element in the list from a stream.</param> | ||
2281 | <param name="writeElement">Required; the method to create a new element in the list from a stream.</param> | ||
2282 | <param name="size">Optional maximum number of elements in the list.</param> | ||
2283 | <param name="readCount">Optional; default is to read a <see cref="T:System.Int32"/> from the <see cref="T:System.IO.Stream"/>.</param> | ||
2284 | <param name="writeCount">Optional; default is to write a <see cref="T:System.Int32"/> to the <see cref="T:System.IO.Stream"/>.</param> | ||
2285 | </member> | ||
2286 | <member name="M:s3pi.Interfaces.SimpleList`1.#ctor(System.EventHandler,System.Collections.Generic.IEnumerable{`0},s3pi.Interfaces.SimpleList{`0}.CreateElementMethod,s3pi.Interfaces.SimpleList{`0}.WriteElementMethod,System.Int64,s3pi.Interfaces.SimpleList{`0}.ReadCountMethod,s3pi.Interfaces.SimpleList{`0}.WriteCountMethod)"> | ||
2287 | <summary> | ||
2288 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.SimpleList`1"/> class | ||
2289 | from <paramref name="collection"/>, wrapping each entry in a <see cref="T:s3pi.Interfaces.HandlerElement`1"/> instance. | ||
2290 | </summary> | ||
2291 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
2292 | <param name="collection">The source to use as the initial content of the list.</param> | ||
2293 | <param name="createElement">Optional; the method to create a new element in the list from a stream. If null, return default{T}.</param> | ||
2294 | <param name="writeElement">Optional; the method to create a new element in the list from a stream. No operation if null.</param> | ||
2295 | <param name="size">Optional maximum number of elements in the list.</param> | ||
2296 | <param name="readCount">Optional; default is to read a <see cref="T:System.Int32"/> from the <see cref="T:System.IO.Stream"/>.</param> | ||
2297 | <param name="writeCount">Optional; default is to write a <see cref="T:System.Int32"/> to the <see cref="T:System.IO.Stream"/>.</param> | ||
2298 | </member> | ||
2299 | <member name="M:s3pi.Interfaces.SimpleList`1.#ctor(System.EventHandler,System.Collections.Generic.IEnumerable{s3pi.Interfaces.HandlerElement{`0}},s3pi.Interfaces.SimpleList{`0}.CreateElementMethod,s3pi.Interfaces.SimpleList{`0}.WriteElementMethod,System.Int64,s3pi.Interfaces.SimpleList{`0}.ReadCountMethod,s3pi.Interfaces.SimpleList{`0}.WriteCountMethod)"> | ||
2300 | <summary> | ||
2301 | Initializes a new instance of the <see cref="T:s3pi.Interfaces.SimpleList`1"/> class from the existing <paramref name="collection"/>. | ||
2302 | </summary> | ||
2303 | <param name="handler">The <see cref="T:System.EventHandler"/> to call on changes to the list or its elements.</param> | ||
2304 | <param name="collection">The source to use as the initial content of the list.</param> | ||
2305 | <param name="createElement">Optional; the method to create a new element in the list from a stream. If null, return default{T}.</param> | ||
2306 | <param name="writeElement">Optional; the method to create a new element in the list from a stream. No operation if null.</param> | ||
2307 | <param name="size">Optional maximum number of elements in the list.</param> | ||
2308 | <param name="readCount">Optional; default is to read a <see cref="T:System.Int32"/> from the <see cref="T:System.IO.Stream"/>.</param> | ||
2309 | <param name="writeCount">Optional; default is to write a <see cref="T:System.Int32"/> to the <see cref="T:System.IO.Stream"/>.</param> | ||
2310 | </member> | ||
2311 | <member name="M:s3pi.Interfaces.SimpleList`1.ReadCount(System.IO.Stream)"> | ||
2312 | <summary> | ||
2313 | Return the number of elements to be created. | ||
2314 | </summary> | ||
2315 | <param name="s"><see cref="T:System.IO.Stream"/> being processed.</param> | ||
2316 | <returns>The number of elements to be created.</returns> | ||
2317 | </member> | ||
2318 | <member name="M:s3pi.Interfaces.SimpleList`1.WriteCount(System.IO.Stream,System.Int32)"> | ||
2319 | <summary> | ||
2320 | Write the count of list elements to the stream. | ||
2321 | </summary> | ||
2322 | <param name="s"><see cref="T:System.IO.Stream"/> to write <paramref name="count"/> to.</param> | ||
2323 | <param name="count">Value to write to <see cref="T:System.IO.Stream"/> <paramref name="s"/>.</param> | ||
2324 | </member> | ||
2325 | <member name="M:s3pi.Interfaces.SimpleList`1.CreateElement(System.IO.Stream)"> | ||
2326 | <summary> | ||
2327 | Creates an new list element of type <typeparamref name="T"/> by reading <paramref name="s"/>. | ||
2328 | </summary> | ||
2329 | <param name="s"><see cref="T:System.IO.Stream"/> containing data.</param> | ||
2330 | <returns>New list element.</returns> | ||
2331 | </member> | ||
2332 | <member name="M:s3pi.Interfaces.SimpleList`1.WriteElement(System.IO.Stream,s3pi.Interfaces.HandlerElement{`0})"> | ||
2333 | <summary> | ||
2334 | Writes the value of a list element to <paramref name="s"/>. | ||
2335 | </summary> | ||
2336 | <param name="s"><see cref="T:System.IO.Stream"/> containing data.</param> | ||
2337 | <param name="element">List element for which to write the value to the <seealso cref="T:System.IO.Stream"/>.</param> | ||
2338 | </member> | ||
2339 | <member name="M:s3pi.Interfaces.SimpleList`1.Add"> | ||
2340 | <summary> | ||
2341 | Add a default element to a <see cref="T:s3pi.Interfaces.SimpleList`1"/>. | ||
2342 | </summary> | ||
2343 | <exception cref="T:System.NotImplementedException">Lists of abstract classes will fail | ||
2344 | with a NotImplementedException.</exception> | ||
2345 | <exception cref="T:System.InvalidOperationException">Thrown when list size exceeded.</exception> | ||
2346 | <exception cref="T:System.NotSupportedException">The <see cref="T:s3pi.Interfaces.SimpleList`1"/> is read-only.</exception> | ||
2347 | </member> | ||
2348 | <member name="M:s3pi.Interfaces.SimpleList`1.Add(`0)"> | ||
2349 | <summary> | ||
2350 | Adds an entry to a <see cref="T:s3pi.Interfaces.SimpleList`1"/>. | ||
2351 | </summary> | ||
2352 | <param name="item">The object to add.</param> | ||
2353 | <returns>True on success</returns> | ||
2354 | <exception cref="T:System.InvalidOperationException">Thrown when list size exceeded.</exception> | ||
2355 | <exception cref="T:System.NotSupportedException">The <see cref="T:s3pi.Interfaces.SimpleList`1"/> is read-only.</exception> | ||
2356 | </member> | ||
2357 | <member name="M:s3pi.Interfaces.SimpleList`1.AddRange(System.Collections.Generic.IEnumerable{`0})"> | ||
2358 | <summary> | ||
2359 | Adds the elements of the specified collection to the end of the <see cref="T:s3pi.Interfaces.SimpleList`1"/>. | ||
2360 | </summary> | ||
2361 | <param name="collection">The collection whose elements should be added to the end of the <see cref="T:s3pi.Interfaces.SimpleList`1"/>. | ||
2362 | The collection itself cannot be null, but it can contain elements that are null, if type <typeparamref name="T"/> is a reference type.</param> | ||
2363 | <exception cref="T:System.ArgumentNullException"><paramref name="collection"/> is null.</exception> | ||
2364 | <exception cref="T:System.InvalidOperationException">Thrown when list size would be exceeded.</exception> | ||
2365 | <exception cref="T:System.NotSupportedException">The <see cref="T:s3pi.Interfaces.SimpleList`1"/> is read-only.</exception> | ||
2366 | <remarks>Calls <see cref="M:s3pi.Interfaces.SimpleList`1.Add(`0)"/> for each item in <paramref name="collection"/>.</remarks> | ||
2367 | </member> | ||
2368 | <member name="M:s3pi.Interfaces.SimpleList`1.BinarySearch(`0)"> | ||
2369 | <summary> | ||
2370 | Searches a the entire sorted <see cref="T:s3pi.Interfaces.SimpleList`1"/> | ||
2371 | for an element using the default comparer and returns the zero-based index | ||
2372 | of the element. | ||
2373 | </summary> | ||
2374 | <param name="item"> | ||
2375 | The object to locate. | ||
2376 | </param> | ||
2377 | <returns> | ||
2378 | The zero-based index of item in the sorted <see cref="T:s3pi.Interfaces.SimpleList`1"/>, | ||
2379 | if item is found; otherwise, a negative number that is the bitwise complement | ||
2380 | of the index of the next element that is larger than item or, if there is | ||
2381 | no larger element, the bitwise complement of <see cref="T:s3pi.Interfaces.SimpleList`1"/>.Count. | ||
2382 | </returns> | ||
2383 | <exception cref="T:System.InvalidOperationException"> | ||
2384 | The default comparer <see cref="P:System.Collections.Generic.Comparer`1.Default"/> | ||
2385 | cannot find an implementation of the <see cref="T:System.IComparable`1"/> generic interface | ||
2386 | or the <see cref="T:System.IComparable"/> interface for type T. | ||
2387 | </exception> | ||
2388 | </member> | ||
2389 | <member name="M:s3pi.Interfaces.SimpleList`1.BinarySearch(`0,System.Collections.Generic.IComparer{`0})"> | ||
2390 | <summary> | ||
2391 | Searches a the entire sorted <see cref="T:s3pi.Interfaces.SimpleList`1"/> | ||
2392 | for an element using the specified comparer and returns the zero-based index | ||
2393 | of the element. | ||
2394 | </summary> | ||
2395 | <param name="item"> | ||
2396 | The object to locate. | ||
2397 | </param> | ||
2398 | <param name="comparer"> | ||
2399 | The <see cref="T:System.Collections.Generic.IComparer`1"/> implementation to use when comparing | ||
2400 | elements. | ||
2401 | <br/>-or-<br/> | ||
2402 | null to use the default comparer <see cref="P:System.Collections.Generic.Comparer`1.Default"/>. | ||
2403 | </param> | ||
2404 | <returns> | ||
2405 | The zero-based index of item in the sorted <see cref="T:s3pi.Interfaces.SimpleList`1"/>, | ||
2406 | if item is found; otherwise, a negative number that is the bitwise complement | ||
2407 | of the index of the next element that is larger than item or, if there is | ||
2408 | no larger element, the bitwise complement of <see cref="T:s3pi.Interfaces.SimpleList`1"/>.Count. | ||
2409 | </returns> | ||
2410 | <exception cref="T:System.InvalidOperationException"> | ||
2411 | <paramref name="comparer"/> is null, and the default comparer <see cref="P:System.Collections.Generic.Comparer`1.Default"/> | ||
2412 | cannot find an implementation of the <see cref="T:System.IComparable`1"/> generic interface | ||
2413 | or the <see cref="T:System.IComparable"/> interface for type T. | ||
2414 | </exception> | ||
2415 | </member> | ||
2416 | <member name="M:s3pi.Interfaces.SimpleList`1.BinarySearch(System.Int32,System.Int32,`0,System.Collections.Generic.IComparer{`0})"> | ||
2417 | <summary> | ||
2418 | Searches a range of elements in the sorted <see cref="T:s3pi.Interfaces.SimpleList`1"/> | ||
2419 | for an element using the specified comparer and returns the zero-based index | ||
2420 | of the element. | ||
2421 | </summary> | ||
2422 | <param name="index"> | ||
2423 | The zero-based starting index of the range to search. | ||
2424 | </param> | ||
2425 | <param name="count"> | ||
2426 | The length of the range to search. | ||
2427 | </param> | ||
2428 | <param name="item"> | ||
2429 | The object to locate. | ||
2430 | </param> | ||
2431 | <param name="comparer"> | ||
2432 | The <see cref="T:System.Collections.Generic.IComparer`1"/> implementation to use when comparing | ||
2433 | elements, or null to use the default comparer <see cref="P:System.Collections.Generic.Comparer`1.Default"/>. | ||
2434 | </param> | ||
2435 | <returns> | ||
2436 | The zero-based index of item in the sorted <see cref="T:s3pi.Interfaces.SimpleList`1"/>, | ||
2437 | if item is found; otherwise, a negative number that is the bitwise complement | ||
2438 | of the index of the next element that is larger than item or, if there is | ||
2439 | no larger element, the bitwise complement of <see cref="T:s3pi.Interfaces.SimpleList`1"/>.Count. | ||
2440 | </returns> | ||
2441 | <exception cref="T:System.ArgumentOutOfRangeException"> | ||
2442 | <paramref name="index"/> is less than 0. | ||
2443 | <br/>-or-<br/> | ||
2444 | <paramref name="count"/> is less than 0. | ||
2445 | </exception> | ||
2446 | <exception cref="T:System.ArgumentException"> | ||
2447 | <paramref name="index"/> and <paramref name="count"/> do not denote a valid range in the <see cref="T:s3pi.Interfaces.SimpleList`1"/>. | ||
2448 | </exception> | ||
2449 | <exception cref="T:System.InvalidOperationException"> | ||
2450 | <paramref name="comparer"/> is null, and the default comparer <see cref="P:System.Collections.Generic.Comparer`1.Default"/> | ||
2451 | cannot find an implementation of the <see cref="T:System.IComparable`1"/> generic interface | ||
2452 | or the <see cref="T:System.IComparable"/> interface for type T. | ||
2453 | </exception> | ||
2454 | </member> | ||
2455 | <member name="M:s3pi.Interfaces.SimpleList`1.ConvertAll``1(System.Converter{`0,``0})"> | ||
2456 | <summary> | ||
2457 | Converts the elements in the current <see cref="T:s3pi.Interfaces.SimpleList`1"/> to | ||
2458 | another type, and returns a list containing the converted elements. | ||
2459 | </summary> | ||
2460 | <typeparam name="TOutput"> | ||
2461 | The target type of the elements of the <see cref="T:System.Collections.Generic.List`1"/>. | ||
2462 | </typeparam> | ||
2463 | <param name="converter"> | ||
2464 | A <see cref="T:System.Converter`2"/> delegate that converts each element from | ||
2465 | one type to another type. | ||
2466 | </param> | ||
2467 | <returns> | ||
2468 | A <see cref="T:System.Collections.Generic.List`1"/> of the target type containing the converted | ||
2469 | elements from the current <see cref="T:s3pi.Interfaces.SimpleList`1"/>. | ||
2470 | </returns> | ||
2471 | <exception cref="T:System.ArgumentNullException"> | ||
2472 | <paramref name="converter"/> is null. | ||
2473 | </exception> | ||
2474 | </member> | ||
2475 | <member name="M:s3pi.Interfaces.SimpleList`1.CopyTo(`0[])"> | ||
2476 | <summary> | ||
2477 | Copies the entire <see cref="T:s3pi.Interfaces.SimpleList`1"/> to | ||
2478 | a compatible one-dimensional array, starting at the beginning of the target array. | ||
2479 | </summary> | ||
2480 | <param name="array"> | ||
2481 | The one-dimensional System.Array that is the destination of the elements | ||
2482 | copied from <see cref="T:s3pi.Interfaces.SimpleList`1"/>. The <see cref="T:System.Array"/> must have | ||
2483 | zero-based indexing. | ||
2484 | </param> | ||
2485 | <exception cref="T:System.ArgumentNullException"> | ||
2486 | <paramref name="array"/> is null. | ||
2487 | </exception> | ||
2488 | <exception cref="T:System.ArgumentException"> | ||
2489 | The number of elements in the source <see cref="T:s3pi.Interfaces.SimpleList`1"/> is | ||
2490 | greater than the number of elements that the destination <paramref name="array"/> can contain. | ||
2491 | </exception> | ||
2492 | </member> | ||
2493 | <member name="M:s3pi.Interfaces.SimpleList`1.CopyTo(`0[],System.Int32)"> | ||
2494 | <summary> | ||
2495 | Copies the entire <see cref="T:s3pi.Interfaces.SimpleList`1"/> to | ||
2496 | a compatible one-dimensional array. | ||
2497 | </summary> | ||
2498 | <param name="array"> | ||
2499 | The one-dimensional System.Array that is the destination of the elements | ||
2500 | copied from <see cref="T:s3pi.Interfaces.SimpleList`1"/>. The <see cref="T:System.Array"/> must have | ||
2501 | zero-based indexing. | ||
2502 | </param> | ||
2503 | <param name="arrayIndex"> | ||
2504 | The zero-based index in <paramref name="array"/> at which copying begins. | ||
2505 | </param> | ||
2506 | <exception cref="T:System.ArgumentNullException"> | ||
2507 | <paramref name="array"/> is null. | ||
2508 | </exception> | ||
2509 | <exception cref="T:System.ArgumentOutOfRangeException"> | ||
2510 | <paramref name="arrayIndex"/> is less than 0. | ||
2511 | </exception> | ||
2512 | <exception cref="T:System.ArgumentException"> | ||
2513 | <paramref name="arrayIndex"/> is equal to or greater than the length of array. | ||
2514 | <br/>-or-<br/> | ||
2515 | The number of elements in the source <see cref="T:s3pi.Interfaces.SimpleList`1"/> is greater | ||
2516 | than the available space from <paramref name="arrayIndex"/> to the end of the destination <paramref name="array"/>. | ||
2517 | </exception> | ||
2518 | </member> | ||
2519 | <member name="M:s3pi.Interfaces.SimpleList`1.CopyTo(System.Int32,`0[],System.Int32,System.Int32)"> | ||
2520 | <summary> | ||
2521 | Copies a range of elements from the <see cref="T:s3pi.Interfaces.SimpleList`1"/> to | ||
2522 | a compatible one-dimensional array, starting at the specified <paramref name="index"/> of the | ||
2523 | target <paramref name="array"/>. | ||
2524 | </summary> | ||
2525 | <param name="index"> | ||
2526 | The zero-based index in the source <see cref="T:s3pi.Interfaces.SimpleList`1"/> at | ||
2527 | which copying begins. | ||
2528 | </param> | ||
2529 | <param name="array"> | ||
2530 | The one-dimensional System.Array that is the destination of the elements | ||
2531 | copied from <see cref="T:s3pi.Interfaces.SimpleList`1"/>. The <see cref="T:System.Array"/> must have | ||
2532 | zero-based indexing. | ||
2533 | </param> | ||
2534 | <param name="arrayIndex"> | ||
2535 | The zero-based index in <paramref name="array"/> at which copying begins. | ||
2536 | </param> | ||
2537 | <param name="count"> | ||
2538 | The number of elements to copy. | ||
2539 | </param> | ||
2540 | <exception cref="T:System.ArgumentNullException"> | ||
2541 | <paramref name="array"/> is null. | ||
2542 | </exception> | ||
2543 | <exception cref="T:System.ArgumentOutOfRangeException"> | ||
2544 | <paramref name="index"/> is less than 0. | ||
2545 | <br/>-or-<br/> | ||
2546 | <paramref name="arrayIndex"/> is less than 0. | ||
2547 | <br/>-or-<br/> | ||
2548 | <paramref name="count"/> is less than 0. | ||
2549 | </exception> | ||
2550 | <exception cref="T:System.ArgumentException"> | ||
2551 | <paramref name="index"/> is equal to or greater than the <see cref="T:s3pi.Interfaces.SimpleList`1"/>.Count | ||
2552 | of the source <see cref="T:s3pi.Interfaces.SimpleList`1"/>. | ||
2553 | <br/>-or-<br/> | ||
2554 | <paramref name="arrayIndex"/> is equal to or greater than the length of array. | ||
2555 | <br/>-or-<br/> | ||
2556 | The number of elements from | ||
2557 | <paramref name="index"/> to the end of the source <see cref="T:s3pi.Interfaces.SimpleList`1"/> is greater | ||
2558 | than the available space from <paramref name="arrayIndex"/> to the end of the destination <paramref name="array"/>. | ||
2559 | </exception> | ||
2560 | </member> | ||
2561 | <member name="M:s3pi.Interfaces.SimpleList`1.Contains(`0)"> | ||
2562 | <summary> | ||
2563 | Determines whether an element is in the <see cref="T:s3pi.Interfaces.SimpleList`1"/>. | ||
2564 | </summary> | ||
2565 | <param name="item">The object to locate in the <see cref="T:s3pi.Interfaces.SimpleList`1"/>.</param> | ||
2566 | <returns>true if item is found in the <see cref="T:s3pi.Interfaces.SimpleList`1"/>; otherwise, false.</returns> | ||
2567 | </member> | ||
2568 | <member name="M:s3pi.Interfaces.SimpleList`1.Exists(System.Predicate{`0})"> | ||
2569 | <summary> | ||
2570 | Determines whether the <see cref="T:s3pi.Interfaces.SimpleList`1"/> contains elements | ||
2571 | that match the conditions defined by the specified predicate. | ||
2572 | </summary> | ||
2573 | <param name="match"> | ||
2574 | The <see cref="T:System.Predicate`1"/> delegate that defines the conditions of the elements | ||
2575 | to search for. | ||
2576 | </param> | ||
2577 | <returns> | ||
2578 | true if the <see cref="T:s3pi.Interfaces.SimpleList`1"/> contains one or more elements | ||
2579 | that match the conditions defined by the specified predicate; otherwise, | ||