master
1<?xml version="1.0"?>
2<doc>
3 <assembly>
4 <name>NAnt.Core</name>
5 </assembly>
6 <members>
7 <member name="T:NAnt.Core.Attributes.BooleanValidatorAttribute">
8 <summary>
9 Used to indicate that a property should be able to be converted into a
10 <see cref="T:System.Boolean"/>.
11 </summary>
12 </member>
13 <member name="T:NAnt.Core.Attributes.ValidatorAttribute">
14 <summary>
15 Base class for all validator attributes.
16 </summary>
17 </member>
18 <member name="M:NAnt.Core.Attributes.ValidatorAttribute.Validate(System.Object)">
19 <summary>
20 Validates the specified value.
21 </summary>
22 <param name="value">The value to be validated.</param>
23 <exception cref="T:NAnt.Core.ValidationException">The validation fails.</exception>
24 </member>
25 <member name="M:NAnt.Core.Attributes.BooleanValidatorAttribute.#ctor">
26 <summary>
27 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BooleanValidatorAttribute"/>
28 class.
29 </summary>
30 </member>
31 <member name="M:NAnt.Core.Attributes.BooleanValidatorAttribute.Validate(System.Object)">
32 <summary>
33 Checks if the specified value can be converted to a <see cref="T:System.Boolean"/>.
34 </summary>
35 <param name="value">The value to be checked.</param>
36 <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> cannot be converted to a <see cref="T:System.Boolean"/>.</exception>
37 </member>
38 <member name="T:NAnt.Core.Attributes.BuildAttributeAttribute">
39 <summary>
40 Indicates that property should be treated as a XML attribute for the
41 task.
42 </summary>
43 <example>
44 Examples of how to specify task attributes
45 <code>
46 #region Public Instance Properties
47
48 [BuildAttribute("out", Required=true)]
49 public string Output {
50 get { return _out; }
51 set { _out = value; }
52 }
53
54 [BuildAttribute("optimize")]
55 [BooleanValidator()]
56 public bool Optimize {
57 get { return _optimize; }
58 set { _optimize = value; }
59 }
60
61 [BuildAttribute("warnlevel")]
62 [Int32Validator(0,4)] // limit values to 0-4
63 public int WarnLevel {
64 get { return _warnLevel; }
65 set { _warnLevel = value; }
66 }
67
68 [BuildElement("sources")]
69 public FileSet Sources {
70 get { return _sources; }
71 set { _sources = value; }
72 }
73
74 #endregion Public Instance Properties
75
76 #region Private Instance Fields
77
78 private string _out = null;
79 private bool _optimize = false;
80 private int _warnLevel = 4;
81 private FileSet _sources = new FileSet();
82
83 #endregion Private Instance Fields
84 </code>
85 </example>
86 </member>
87 <member name="M:NAnt.Core.Attributes.BuildAttributeAttribute.#ctor(System.String)">
88 <summary>
89 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildAttributeAttribute"/> with the
90 specified name.
91 </summary>
92 <param name="name">The name of the attribute.</param>
93 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
94 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
95 </member>
96 <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Name">
97 <summary>
98 Gets or sets the name of the XML attribute.
99 </summary>
100 <value>
101 The name of the XML attribute.
102 </value>
103 </member>
104 <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Required">
105 <summary>
106 Gets or sets a value indicating whether the attribute is required.
107 </summary>
108 <value>
109 <see langword="true" /> if the attribute is required; otherwise,
110 <see langword="false" />. The default is <see langword="false" />.
111 </value>
112 </member>
113 <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ExpandProperties">
114 <summary>
115 Gets or sets a value indicating whether property references should
116 be expanded.
117 </summary>
118 <value>
119 <see langword="true" /> if properties should be expanded; otherwise
120 <see langword="false" />. The default is <see langword="true" />.
121 </value>
122 </member>
123 <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ProcessXml">
124 <summary>
125 Used to specify how this attribute will be handled as the XML is
126 parsed and given to the element.
127 </summary>
128 <value>
129 <see langword="true" /> if XML should be processed; otherwise
130 <see langword="false" />. The default is <see langword="true" />.
131 </value>
132 </member>
133 <member name="T:NAnt.Core.Attributes.BuildElementArrayAttribute">
134 <summary>
135 Indicates that property should be treated as a XML arrayList
136 </summary>
137 <remarks>
138 <para>
139 Should only be applied to properties exposing strongly typed arrays or
140 strongly typed collections.
141 </para>
142 <para>
143 The XML format is like this:
144 <code>
145 <![CDATA[
146 <task>
147 <elementName ... />
148 <elementName ... />
149 <elementName ... />
150 <elementName ... />
151 </task>
152 ]]>
153 </code>
154 </para>
155 </remarks>
156 </member>
157 <member name="T:NAnt.Core.Attributes.BuildElementAttribute">
158 <summary>
159 Indicates that the property should be treated as an XML element and
160 further processing should be done.
161 </summary>
162 <remarks>
163 <para>
164 The XML format is like this:
165 <code>
166 <![CDATA[
167 <task>
168 <elementName ...>
169 <morestuff />
170 </elementName>
171 </task>
172 ]]>
173 </code>
174 </para>
175 </remarks>
176 </member>
177 <member name="M:NAnt.Core.Attributes.BuildElementAttribute.#ctor(System.String)">
178 <summary>
179 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> with the
180 specified name.
181 </summary>
182 <param name="name">The name of the attribute.</param>
183 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
184 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
185 </member>
186 <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Name">
187 <summary>
188 Gets or sets the name of the attribute.
189 </summary>
190 <value>
191 The name of the attribute.
192 </value>
193 </member>
194 <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Required">
195 <summary>
196 Gets or sets a value indicating whether the attribute is required.
197 </summary>
198 <value>
199 <see langword="true" /> if the attribute is required; otherwise,
200 <see langword="false" />. The default is <see langword="false" />.
201 </value>
202 </member>
203 <member name="P:NAnt.Core.Attributes.BuildElementAttribute.ProcessXml">
204 <summary>
205 Used to specify how this element will be handled as the XML is parsed
206 and given to the element.
207 </summary>
208 <value>
209 <see langword="true" /> if XML should be processed; otherwise
210 <see langword="false" />. The default is <see langword="true" />.
211 </value>
212 </member>
213 <member name="M:NAnt.Core.Attributes.BuildElementArrayAttribute.#ctor(System.String)">
214 <summary>
215 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementArrayAttribute"/>
216 with the specified name.
217 </summary>
218 <param name="name">The name of the attribute.</param>
219 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
220 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
221 </member>
222 <member name="P:NAnt.Core.Attributes.BuildElementArrayAttribute.ElementType">
223 <summary>
224 Gets or sets the type of objects that this container holds.
225 </summary>
226 <value>
227 The type of the elements that this container holds.
228 </value>
229 <remarks>
230 <para>
231 This can be used for validation and schema generation.
232 </para>
233 <para>
234 If not specified, the type of the elements will be determined using
235 reflection.
236 </para>
237 </remarks>
238 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
239 </member>
240 <member name="T:NAnt.Core.Attributes.BuildElementCollectionAttribute">
241 <summary>
242 Indicates that the property should be treated as a container for a
243 collection of build elements.
244 </summary>
245 <remarks>
246 <para>
247 Should only be applied to properties exposing strongly typed arrays or
248 strongly typed collections.
249 </para>
250 <para>
251 The XML format is like this:
252 <code>
253 <![CDATA[
254 <task>
255 <collectionName>
256 <elementName ... />
257 <elementName ... />
258 <elementName ... />
259 <elementName ... />
260 </collectionName>
261 </task>
262 ]]>
263 </code>
264 </para>
265 </remarks>
266 </member>
267 <member name="M:NAnt.Core.Attributes.BuildElementCollectionAttribute.#ctor(System.String,System.String)">
268 <summary>
269 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementCollectionAttribute"/> with the
270 specified name and child element name.
271 </summary>
272 <param name="collectionName">The name of the collection.</param>
273 <param name="childName">The name of the child elements in the collection</param>
274 <exception cref="T:System.ArgumentNullException"><paramref name="childName"/> is <see langword="null"/>.</exception>
275 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="childName"/> is a zero-length <see cref="T:System.String"/>.</exception>
276 </member>
277 <member name="P:NAnt.Core.Attributes.BuildElementCollectionAttribute.ChildElementName">
278 <summary>
279 The name of the child element within the collection.
280 </summary>
281 <value>
282 The name to check for in the XML of the elements in the collection.
283 </value>
284 <remarks>
285 This can be used for validation and schema generation.
286 </remarks>
287 </member>
288 <member name="T:NAnt.Core.Attributes.DateTimeValidatorAttribute">
289 <summary>
290 Used to indicate that a property should be able to be converted into a
291 <see cref="T:System.DateTime"/>.
292 </summary>
293 </member>
294 <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.#ctor">
295 <summary>
296 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.DateTimeValidatorAttribute"/>
297 class.
298 </summary>
299 </member>
300 <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.Validate(System.Object)">
301 <summary>
302 Checks if the specified value can be converted to a <see cref="T:System.DateTime"/>.
303 </summary>
304 <param name="value">The value to be checked.</param>
305 <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> cannot be converted to a <see cref="T:System.DateTime"/>.</exception>
306 </member>
307 <member name="T:NAnt.Core.Attributes.ElementNameAttribute">
308 <summary>
309 Indicates that class should be treated as a NAnt element.
310 </summary>
311 <remarks>
312 Attach this attribute to a subclass of Element to have NAnt be able
313 to recognize it. The name should be short but must not confict
314 with any other element already in use.
315 </remarks>
316 </member>
317 <member name="M:NAnt.Core.Attributes.ElementNameAttribute.#ctor(System.String)">
318 <summary>
319 Initializes a new instance of the <see cre="ElementNameAttribute"/>
320 with the specified name.
321 </summary>
322 <param name="name">The name of the element.</param>
323 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
324 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
325 </member>
326 <member name="P:NAnt.Core.Attributes.ElementNameAttribute.Name">
327 <summary>
328 Gets or sets the name of the element.
329 </summary>
330 <value>
331 The name of the element.
332 </value>
333 </member>
334 <member name="T:NAnt.Core.Attributes.FileSetAttribute">
335 <summary>
336 Indicates that a property should be treated as a XML file set for the
337 task.
338 </summary>
339 </member>
340 <member name="M:NAnt.Core.Attributes.FileSetAttribute.#ctor(System.String)">
341 <summary>
342 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FileSetAttribute"/> with the
343 specified name.
344 </summary>
345 <param name="name">The name of the attribute.</param>
346 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
347 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
348 </member>
349 <member name="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute">
350 <summary>
351 Indicates that the value of the property to which the attribute is
352 assigned, can be configured on the framework-level in the NAnt application
353 configuration file.
354 </summary>
355 <example>
356 <para>
357 The following example shows a property of which the value can be
358 configured for a specific framework in the NAnt configuration file.
359 </para>
360 <code lang="C#">
361 [FrameworkConfigurable("exename", Required=true)]
362 public virtual string ExeName {
363 get { return _exeName; }
364 set { _exeName = value; }
365 }
366 </code>
367 </example>
368 </member>
369 <member name="M:NAnt.Core.Attributes.FrameworkConfigurableAttribute.#ctor(System.String)">
370 <summary>
371 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute"/>
372 with the specified attribute name.
373 </summary>
374 <param name="name">The name of the framework configuration attribute.</param>
375 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception>
376 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
377 </member>
378 <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Name">
379 <summary>
380 Gets or sets the name of the framework configuration attribute.
381 </summary>
382 <value>The name of the framework configuration attribute.</value>
383 </member>
384 <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Required">
385 <summary>
386 Gets or sets a value indicating whether the configuration attribute
387 is required.
388 </summary>
389 <value>
390 <see langword="true" /> if the configuration attribute is required;
391 otherwise, <see langword="true" />. The default is <see langword="false" />.
392 </value>
393 </member>
394 <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.ExpandProperties">
395 <summary>
396 Gets or sets a value indicating whether property references should
397 be expanded.
398 </summary>
399 <value>
400 <see langword="true" /> if properties should be expanded; otherwise
401 <see langword="false" />. The default is <see langword="true" />.
402 </value>
403 </member>
404 <member name="T:NAnt.Core.Attributes.FunctionAttribute">
405 <summary>
406 Indicates that the method should be exposed as a function in NAnt build
407 files.
408 </summary>
409 <remarks>
410 Attach this attribute to a method of a class that derives from
411 <see cref="T:NAnt.Core.FunctionSetBase"/> to have NAnt be able to recognize it.
412 </remarks>
413 </member>
414 <member name="M:NAnt.Core.Attributes.FunctionAttribute.#ctor(System.String)">
415 <summary>
416 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionAttribute"/>
417 class with the specified name.
418 </summary>
419 <param name="name">The name of the function.</param>
420 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
421 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
422 </member>
423 <member name="P:NAnt.Core.Attributes.FunctionAttribute.Name">
424 <summary>
425 Gets or sets the name of the function.
426 </summary>
427 <value>
428 The name of the function.
429 </value>
430 </member>
431 <member name="T:NAnt.Core.Attributes.FunctionSetAttribute">
432 <summary>
433 Indicates that class should be treated as a set of functions.
434 </summary>
435 <remarks>
436 Attach this attribute to a class that derives from <see cref="T:NAnt.Core.FunctionSetBase"/>
437 to have NAnt be able to recognize it as containing custom functions.
438 </remarks>
439 </member>
440 <member name="M:NAnt.Core.Attributes.FunctionSetAttribute.#ctor(System.String,System.String)">
441 <summary>
442 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionSetAttribute"/>
443 class with the specified name.
444 </summary>
445 <param name="prefix">The prefix used to distinguish the functions.</param>
446 <param name="category">The category of the functions.</param>
447 <exception cref="T:System.ArgumentNullException">
448 <para><paramref name="prefix"/> is <see langword="null"/>.</para>
449 <para>-or-</para>
450 <para><paramref name="category"/> is <see langword="null"/>.</para>
451 </exception>
452 <exception cref="T:System.ArgumentOutOfRangeException">
453 <para><paramref name="prefix"/> is a zero-length <see cref="T:System.String"/>.</para>
454 <para>-or-</para>
455 <para><paramref name="category"/> is a zero-length <see cref="T:System.String"/>.</para>
456 </exception>
457 </member>
458 <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Category">
459 <summary>
460 Gets or sets the category of the function set.
461 </summary>
462 <value>
463 The name of the category of the function set.
464 </value>
465 <remarks>
466 This will be displayed in the user docs.
467 </remarks>
468 </member>
469 <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Prefix">
470 <summary>
471 Gets or sets the prefix of all functions in this function set.
472 </summary>
473 <value>
474 The prefix of the functions in this function set.
475 </value>
476 </member>
477 <member name="T:NAnt.Core.Attributes.Int32ValidatorAttribute">
478 <summary>
479 Indicates that property should be able to be converted into a <see cref="T:System.Int32"/>
480 within the given range.
481 </summary>
482 </member>
483 <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor">
484 <summary>
485 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/>
486 class.
487 </summary>
488 </member>
489 <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor(System.Int32,System.Int32)">
490 <summary>
491 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/>
492 class with the specied minimum and maximum values.
493 </summary>
494 <param name="minValue">The minimum value.</param>
495 <param name="maxValue">The maximum value.</param>
496 </member>
497 <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.Validate(System.Object)">
498 <summary>
499 Checks whether the specified value can be converted to an <see cref="T:System.Int32"/>
500 and whether the value lies within the range defined by the <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/>
501 and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/> properties.
502 </summary>
503 <param name="value">The value to be checked.</param>
504 <exception cref="T:NAnt.Core.ValidationException">
505 <para>
506 <paramref name="value"/> cannot be converted to an <see cref="T:System.Int32"/>.
507 </para>
508 <para>-or-</para>
509 <para>
510 <paramref name="value"/> is not in the range defined by <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/>
511 and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/>.
512 </para>
513 </exception>
514 </member>
515 <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue">
516 <summary>
517 Gets or sets the minimum value.
518 </summary>
519 <value>
520 The minimum value. The default is <see cref="F:System.Int32.MinValue"/>.
521 </value>
522 </member>
523 <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue">
524 <summary>
525 Gets or sets the maximum value.
526 </summary>
527 <value>
528 The maximum value. The default is <see cref="F:System.Int32.MaxValue"/>.
529 </value>
530 </member>
531 <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.Base">
532 <summary>
533 The base of the number to validate, which must be 2, 8, 10, or 16.
534 </summary>
535 <value>
536 The base of the number to validate.
537 </value>
538 <remarks>
539 The default is 10.
540 </remarks>
541 </member>
542 <member name="T:NAnt.Core.Attributes.LocationType">
543 <summary>
544 Defines possible locations in which a task executable can be located.
545 </summary>
546 </member>
547 <member name="F:NAnt.Core.Attributes.LocationType.FrameworkDir">
548 <summary>
549 Locates the task executable in the current Framework directory.
550 </summary>
551 </member>
552 <member name="F:NAnt.Core.Attributes.LocationType.FrameworkSdkDir">
553 <summary>
554 Locates the task executable in the current Framework SDK directory.
555 </summary>
556 </member>
557 <member name="T:NAnt.Core.Attributes.ProgramLocationAttribute">
558 <summary>
559 Indicates the location that a task executable can be located in.
560 </summary>
561 <remarks>
562 <para>
563 When applied to a task deriving from <see cref="T:NAnt.Core.Tasks.ExternalProgramBase"/>,
564 the program to execute will first be searched for in the designated
565 location.
566 </para>
567 <para>
568 If the program does not exist in that location, and the file name is
569 not an absolute path then the list of tool paths of the current
570 target framework will be searched (in the order in which they are
571 defined in the NAnt configuration file).
572 </para>
573 </remarks>
574 </member>
575 <member name="M:NAnt.Core.Attributes.ProgramLocationAttribute.#ctor(NAnt.Core.Attributes.LocationType)">
576 <summary>
577 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/>
578 with the specified location.
579 </summary>
580 <param type="type">The <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the attribute.</param>
581 </member>
582 <member name="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType">
583 <summary>
584 Gets or sets the <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the task.
585 </summary>
586 <value>
587 The location type of the task to which the attribute is assigned.
588 </value>
589 </member>
590 <member name="T:NAnt.Core.Attributes.StringValidatorAttribute">
591 <summary>
592 Used to indicate whether a <see cref="T:System.String"/> property should allow
593 an empty string value or not.
594 </summary>
595 </member>
596 <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.#ctor">
597 <summary>
598 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>
599 class.
600 </summary>
601 </member>
602 <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.Validate(System.Object)">
603 <summary>
604 Checks if the specified value adheres to the rules defined by the
605 properties of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>.
606 </summary>
607 <param name="value">The value to be checked.</param>
608 <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> is an empty string value and <see cref="P:NAnt.Core.Attributes.StringValidatorAttribute.AllowEmpty"/> is set to <see langword="false"/>.</exception>
609 </member>
610 <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.AllowEmpty">
611 <summary>
612 Gets or sets a value indicating whether an empty string or
613 <see langword="null" /> should be a considered a valid value.
614 </summary>
615 <value>
616 <see langword="true" /> if an empty string or <see langword="null" />
617 should be considered a valid value; otherwise, <see langword="false" />.
618 The default is <see langword="true" />.
619 </value>
620 </member>
621 <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.Expression">
622 <summary>
623 Gets or sets a regular expression. The string will be validated to
624 determine if it matches the expression.
625 </summary>
626 <value>
627 <see cref="N:System.Text.RegularExpressions"/>
628 </value>
629 </member>
630 <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.ExpressionErrorMessage">
631 <summary>
632 An optional error message that can be used to better describe the
633 regular expression error.
634 </summary>
635 </member>
636 <member name="T:NAnt.Core.Attributes.TaskAttributeAttribute">
637 <summary>
638 Indicates that property should be treated as a XML attribute for the
639 task.
640 </summary>
641 <example>
642 Examples of how to specify task attributes
643 <code>
644 // task XmlType default is string
645 [TaskAttribute("out", Required=true)]
646 string _out = null; // assign default value here
647
648 [TaskAttribute("optimize")]
649 [BooleanValidator()]
650 // during ExecuteTask you can safely use Convert.ToBoolean(_optimize)
651 string _optimize = Boolean.FalseString;
652
653 [TaskAttribute("warnlevel")]
654 [Int32Validator(0,4)] // limit values to 0-4
655 // during ExecuteTask you can safely use Convert.ToInt32(_optimize)
656 string _warnlevel = "0";
657
658 [BuildElement("sources")]
659 FileSet _sources = new FileSet();
660 </code>
661 NOTE: Attribute values must be of type of string if you want
662 to be able to have macros. The field stores the exact value during
663 Initialize. Just before ExecuteTask is called NAnt will expand
664 all the macros with the current values.
665 </example>
666 </member>
667 <member name="M:NAnt.Core.Attributes.TaskAttributeAttribute.#ctor(System.String)">
668 <summary>
669 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskAttributeAttribute"/>
670 with the specified attribute name.
671 </summary>
672 <param name="name">The name of the task attribute.</param>
673 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception>
674 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
675 </member>
676 <member name="T:NAnt.Core.Attributes.TaskNameAttribute">
677 <summary>
678 Indicates that class should be treated as a task.
679 </summary>
680 <remarks>
681 Attach this attribute to a subclass of Task to have NAnt be able
682 to recognize it. The name should be short but must not confict
683 with any other task already in use.
684 </remarks>
685 </member>
686 <member name="M:NAnt.Core.Attributes.TaskNameAttribute.#ctor(System.String)">
687 <summary>
688 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskNameAttribute"/>
689 with the specified name.
690 </summary>
691 <param name="name">The name of the task.</param>
692 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
693 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
694 </member>
695 <member name="T:NAnt.Core.Configuration.DirList">
696 <summary>
697 Represents an explicitly named list of directories.
698 </summary>
699 <remarks>
700 A <see cref="T:NAnt.Core.Configuration.DirList"/> is useful when you want to capture a list of
701 directories regardless whether they currently exist.
702 </remarks>
703 </member>
704 <member name="T:NAnt.Core.Element">
705 <summary>
706 Models a NAnt XML element in the build file.
707 </summary>
708 <remarks>
709 <para>
710 Automatically validates attributes in the element based on attributes
711 applied to members in derived classes.
712 </para>
713 </remarks>
714 </member>
715 <member name="M:NAnt.Core.Element.#ctor">
716 <summary>
717 Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class.
718 </summary>
719 </member>
720 <member name="M:NAnt.Core.Element.#ctor(NAnt.Core.Element)">
721 <summary>
722 Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class
723 from the specified element.
724 </summary>
725 <param name="e">The element that should be used to create a new instance of the <see cref="T:NAnt.Core.Element"/> class.</param>
726 </member>
727 <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode)">
728 <summary>
729 Performs default initialization.
730 </summary>
731 <remarks>
732 Derived classes that wish to add custom initialization should override
733 the <see cref="M:NAnt.Core.Element.Initialize"/> method.
734 </remarks>
735 </member>
736 <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String)">
737 <summary>
738 Logs a message with the given priority.
739 </summary>
740 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
741 <param name="message">The message to be logged.</param>
742 <remarks>
743 The actual logging is delegated to the project.
744 </remarks>
745 </member>
746 <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String,System.Object[])">
747 <summary>
748 Logs a message with the given priority.
749 </summary>
750 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
751 <param name="message">The message to log, containing zero or more format items.</param>
752 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
753 <remarks>
754 The actual logging is delegated to the project.
755 </remarks>
756 </member>
757 <member name="M:NAnt.Core.Element.InitializeElement(System.Xml.XmlNode)">
758 <summary>
759 Derived classes should override to this method to provide extra
760 initialization and validation not covered by the base class.
761 </summary>
762 <param name="elementNode">The XML node of the element to use for initialization.</param>
763 </member>
764 <member name="M:NAnt.Core.Element.Initialize">
765 <summary>
766 Derived classes should override to this method to provide extra
767 initialization and validation not covered by the base class.
768 </summary>
769 <remarks>
770 Access to the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize
771 this <see cref="T:NAnt.Core.Element"/> is available through <see cref="P:NAnt.Core.Element.XmlNode"/>.
772 </remarks>
773 </member>
774 <member name="M:NAnt.Core.Element.CopyTo(NAnt.Core.Element)">
775 <summary>
776 Copies all instance data of the <see cref="T:NAnt.Core.Element"/> to a given
777 <see cref="T:NAnt.Core.Element"/>.
778 </summary>
779 </member>
780 <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
781 <summary>
782 Performs initialization using the given set of properties.
783 </summary>
784 </member>
785 <member name="M:NAnt.Core.Element.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
786 <summary>
787 Initializes all build attributes and child elements.
788 </summary>
789 </member>
790 <member name="M:NAnt.Core.Element.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)">
791 <summary>
792 Locates the XML node for the specified attribute in the project
793 configuration node.
794 </summary>
795 <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param>
796 <param name="framework">The framework to use to obtain framework specific information, or <see langword="null" /> if no framework specific information should be used.</param>
797 <returns>
798 The XML configuration node for the specified attribute, or
799 <see langword="null" /> if no corresponding XML node could be
800 located.
801 </returns>
802 <remarks>
803 If there's a valid current framework, the configuration section for
804 that framework will first be searched. If no corresponding
805 configuration node can be located in that section, the framework-neutral
806 section of the project configuration node will be searched.
807 </remarks>
808 </member>
809 <member name="M:NAnt.Core.Element.GetElementNameFromType(System.Type)">
810 <summary>
811 Returns the <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> of the
812 <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned to the specified
813 <see cref="T:System.Type"/>.
814 </summary>
815 <param name="type">The <see cref="T:System.Type"/> of which the assigned <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> should be retrieved.</param>
816 <returns>
817 The <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> assigned to the specified
818 <see cref="T:System.Type"/> or a null reference is no <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/>
819 is assigned to the <paramref name="type"/>.
820 </returns>
821 </member>
822 <member name="P:NAnt.Core.Element.Parent">
823 <summary>
824 Gets or sets the parent of the element.
825 </summary>
826 <value>
827 The parent of the element.
828 </value>
829 <remarks>
830 This will be the parent <see cref="T:NAnt.Core.Task"/>, <see cref="T:NAnt.Core.Target"/>, or
831 <see cref="P:NAnt.Core.Element.Project"/> depending on where the element is defined.
832 </remarks>
833 </member>
834 <member name="P:NAnt.Core.Element.Name">
835 <summary>
836 Gets the name of the XML element used to initialize this element.
837 </summary>
838 <value>
839 The name of the XML element used to initialize this element.
840 </value>
841 </member>
842 <member name="P:NAnt.Core.Element.Project">
843 <summary>
844 Gets or sets the <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs.
845 </summary>
846 <value>
847 The <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs.
848 </value>
849 </member>
850 <member name="P:NAnt.Core.Element.Properties">
851 <summary>
852 Gets the properties local to this <see cref="T:NAnt.Core.Element"/> and the
853 <see cref="P:NAnt.Core.Element.Project"/>.
854 </summary>
855 <value>
856 The properties local to this <see cref="T:NAnt.Core.Element"/> and the <see cref="P:NAnt.Core.Element.Project"/>.
857 </value>
858 </member>
859 <member name="P:NAnt.Core.Element.NamespaceManager">
860 <summary>
861 Gets or sets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
862 </summary>
863 <value>
864 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
865 </value>
866 <remarks>
867 The <see cref="P:NAnt.Core.Element.NamespaceManager"/> defines the current namespace
868 scope and provides methods for looking up namespace information.
869 </remarks>
870 </member>
871 <member name="P:NAnt.Core.Element.XmlNode">
872 <summary>
873 Gets or sets the XML node of the element.
874 </summary>
875 <value>
876 The XML node of the element.
877 </value>
878 </member>
879 <member name="P:NAnt.Core.Element.Location">
880 <summary>
881 Gets or sets the location in the build file where the element is
882 defined.
883 </summary>
884 <value>
885 The location in the build file where the element is defined.
886 </value>
887 </member>
888 <member name="P:NAnt.Core.Element.CustomXmlProcessing">
889 <summary>
890 Gets a value indicating whether the element is performing additional
891 processing using the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to
892 initialize the element.
893 </summary>
894 <value>
895 <see langword="false"/>.
896 </value>
897 <remarks>
898 <para>
899 Elements that need to perform additional processing of the
900 <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize the element, should
901 override this property and return <see langword="true"/>.
902 </para>
903 <para>
904 When <see langword="true"/>, no build errors will be reported for
905 unknown nested build elements.
906 </para>
907 </remarks>
908 </member>
909 <member name="T:NAnt.Core.Element.AttributeConfigurator">
910 <summary>
911 Configures an <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using meta-data provided by
912 assigned attributes.
913 </summary>
914 </member>
915 <member name="M:NAnt.Core.Element.AttributeConfigurator.#ctor(NAnt.Core.Element,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
916 <summary>
917 Initializes a new instance of the <see cref="T:NAnt.Core.Element.AttributeConfigurator"/>
918 class for the given <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>.
919 </summary>
920 <param name="element">The <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> for which an <see cref="T:NAnt.Core.Element.AttributeConfigurator"/> should be created.</param>
921 <param name="elementNode">The <see cref="P:NAnt.Core.Element.XmlNode"/> to initialize the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> with.</param>
922 <param name="properties">The <see cref="T:NAnt.Core.PropertyDictionary"/> to use for property expansion.</param>
923 <param name="targetFramework">The framework that the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> should target.</param>
924 <exception cref="T:System.ArgumentNullException">
925 <para><paramref name="element"/> is <see langword="null"/>.</para>
926 <para>-or-</para>
927 <para><paramref name="elementNode"/> is <see langword="null"/>.</para>
928 <para>-or-</para>
929 <para><paramref name="properties"/> is <see langword="null"/>.</para>
930 </exception>
931 </member>
932 <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateChildBuildElement(System.Reflection.PropertyInfo,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
933 <summary>
934 Creates a child <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using property set/get methods.
935 </summary>
936 <param name="propInf">The <see cref="T:System.Reflection.PropertyInfo"/> instance that represents the property of the current class.</param>
937 <param name="xml">The <see cref="P:NAnt.Core.Element.XmlNode"/> used to initialize the new <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> instance.</param>
938 <param name="properties">The collection of property values to use for macro expansion.</param>
939 <param name="framework">The <see cref="T:NAnt.Core.FrameworkInfo"/> from which to obtain framework-specific information.</param>
940 <returns>The <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> child.</returns>
941 </member>
942 <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateAttributeSetter(System.Type)">
943 <summary>
944 Creates an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given
945 <see cref="T:System.Type"/>.
946 </summary>
947 <param name="attributeType">The <see cref="T:System.Type"/> for which an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> should be created.</param>
948 <returns>
949 An <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given <see cref="T:System.Type"/>.
950 </returns>
951 </member>
952 <member name="F:NAnt.Core.Element.AttributeConfigurator._element">
953 <summary>
954 Holds the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that should be initialized.
955 </summary>
956 </member>
957 <member name="F:NAnt.Core.Element.AttributeConfigurator._elementXml">
958 <summary>
959 Holds the <see cref="P:NAnt.Core.Element.XmlNode"/> that should be used to initialize
960 the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>.
961 </summary>
962 </member>
963 <member name="F:NAnt.Core.Element.AttributeConfigurator._properties">
964 <summary>
965 Holds the dictionary that should be used for property
966 expansion.
967 </summary>
968 </member>
969 <member name="F:NAnt.Core.Element.AttributeConfigurator._targetFramework">
970 <summary>
971 Holds the framework that should be targeted by the
972 <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that we're configuring, or
973 <see langword="null"/> if there's no current target
974 framework.
975 </summary>
976 </member>
977 <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedAttributes">
978 <summary>
979 Holds the names of the attributes that still need to be
980 processed.
981 </summary>
982 </member>
983 <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedChildNodes">
984 <summary>
985 Holds the names of the child nodes that still need to be
986 processed.
987 </summary>
988 </member>
989 <member name="F:NAnt.Core.Element.AttributeConfigurator.logger">
990 <summary>
991 Holds the logger for the current class.
992 </summary>
993 </member>
994 <member name="F:NAnt.Core.Element.AttributeConfigurator.AttributeSetters">
995 <summary>
996 Holds the cache of <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> instances.
997 </summary>
998 </member>
999 <member name="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager">
1000 <summary>
1001 Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
1002 </summary>
1003 <value>
1004 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
1005 </value>
1006 <remarks>
1007 The <see cref="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager"/> defines the current namespace
1008 scope and provides methods for looking up namespace information.
1009 </remarks>
1010 </member>
1011 <member name="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter">
1012 <summary>
1013 Internal interface used for setting element attributes.
1014 </summary>
1015 </member>
1016 <member name="P:NAnt.Core.Configuration.DirList.Directory">
1017 <summary>
1018 The base of the directory of this dirlist. The default is the project
1019 base directory.
1020 </summary>
1021 </member>
1022 <member name="P:NAnt.Core.Configuration.ManagedExecutionMode.Environment">
1023 <summary>
1024 Gets the collection of environment variables that should be passed
1025 to external programs that are launched.
1026 </summary>
1027 <value>
1028 <summary>
1029 The collection of environment variables that should be passed
1030 to external programs that are launched.
1031 </summary>
1032 </value>
1033 </member>
1034 <member name="P:NAnt.Core.Configuration.RuntimeEngine.Arguments">
1035 <summary>
1036 The command-line arguments for the runtime engine.
1037 </summary>
1038 </member>
1039 <member name="T:NAnt.Core.Extensibility.ExtensionAssembly">
1040 <summary>
1041 Represents an <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> in which one or more extensions
1042 are found.
1043 </summary>
1044 </member>
1045 <member name="M:NAnt.Core.Extensibility.ExtensionAssembly.#ctor(System.Reflection.Assembly)">
1046 <summary>
1047 Initializes a new instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>
1048 class for a given <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/>.
1049 </summary>
1050 <param name="assembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> for which to construct an <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.</param>
1051 </member>
1052 <member name="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly">
1053 <summary>
1054 Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> containing extensions.
1055 </summary>
1056 </member>
1057 <member name="M:NAnt.Core.Extensibility.ExtensionBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly)">
1058 <summary>
1059 Initializes a instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionBuilder"/>
1060 class for an extension in a given <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/>.
1061 </summary>
1062 <param name="extensionAssembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/> in which the extension is found.</param>
1063 <exception cref="T:System.ArgumentNullException"><paramref name="extensionAssembly"/> is <see langword="null"/>.</exception>
1064 </member>
1065 <member name="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly">
1066 <summary>
1067 Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/> in which the extension
1068 was found.
1069 </summary>
1070 </member>
1071 <member name="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly">
1072 <summary>
1073 Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> from which the extension will
1074 be created.
1075 </summary>
1076 <value>
1077 The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> containing the extension.
1078 </value>
1079 </member>
1080 <member name="M:NAnt.Core.Extensibility.PluginConsumerAttribute.#ctor(System.Type)">
1081 <summary>
1082 Initializes a new instance of the <see cref="T:NAnt.Core.Extensibility.PluginConsumerAttribute"/>
1083 with the specified type.
1084 </summary>
1085 <param name="type">The type of the <see cref="T:NAnt.Core.Extensibility.IPlugin"/> to consume.</param>
1086 <exception cref="T:System.ArgumentNullException"><paramref name="type"/> is <see langword="null"/>.</exception>
1087 </member>
1088 <member name="T:NAnt.Core.Extensibility.PluginScanner">
1089 <summary>
1090 Responsible for scanning types for plugins, and maintaining a cache of
1091 <see cref="T:NAnt.Core.Extensibility.PluginBuilder"/> instances.
1092 </summary>
1093 </member>
1094 <member name="M:NAnt.Core.Extensibility.PluginScanner.ScanTypeForPlugins(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
1095 <summary>
1096 Scans a given <see cref="T:System.Type"/> for plugins.
1097 </summary>
1098 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
1099 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
1100 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
1101 <returns>
1102 <see langword="true"/> if <paramref name="type"/> represents a
1103 <see cref="T:NAnt.Core.Extensibility.IPlugin"/>; otherwise, <see langword="false"/>.
1104 </returns>
1105 </member>
1106 <member name="M:NAnt.Core.Extensibility.PluginScanner.RegisterPlugins(NAnt.Core.Extensibility.IPluginConsumer)">
1107 <summary>
1108 Registers matching plugins for the specified <see cref="T:NAnt.Core.Extensibility.IPluginConsumer"/>.
1109 </summary>
1110 <param name="consumer">The <see cref="T:NAnt.Core.Extensibility.IPluginConsumer"/> which plugins must be registered for.</param>
1111 <exception cref="T:System.ArgumentNullException"><paramref name="consumer"/> is <see langword="null"/>.</exception>
1112 </member>
1113 <member name="T:NAnt.Core.Filters.ChainableReader">
1114 <summary>
1115 Functions as a chainable TextReader
1116 </summary>
1117 <remarks>
1118 Implements a abstraction over a TextReader that allows the class to represent
1119 either a TextReader or another ChainableReader to which it is chained.
1120
1121 By passing a ChainableReader as a constructor paramater it is possiable to
1122 chain many ChainableReaders together. The last ChainableReader in the chain must
1123 be based on a TextReader.
1124 </remarks>
1125 </member>
1126 <member name="M:NAnt.Core.Filters.ChainableReader.Chain(NAnt.Core.Filters.ChainableReader)">
1127 <summary>
1128 Makes it so all calls to Read and Peek are passed the ChainableReader
1129 passed as a parameter.
1130 </summary>
1131 <param name="parentChainedReader">ChainableReader to forward calls to</param>
1132 </member>
1133 <member name="M:NAnt.Core.Filters.ChainableReader.Chain(System.IO.TextReader)">
1134 <summary>
1135 Makes it so all calls to Read and Peek are passed the TextReader
1136 passed as a parameter.
1137 </summary>
1138 <param name="baseReader">TextReader to forward calls to</param>
1139 </member>
1140 <member name="M:NAnt.Core.Filters.ChainableReader.Peek">
1141 <summary>
1142 Forwards Peek calls to the TextReader or ChainableReader passed in the corresponding constructor.
1143 </summary>
1144 <returns>Character or -1 if end of stream</returns>
1145 </member>
1146 <member name="M:NAnt.Core.Filters.ChainableReader.Read">
1147 <summary>
1148 Forwards Read calls to the TextReader or ChainableReader passed in the corresponding constructor.
1149 </summary>
1150 <returns>
1151 Character or -1 if end of stream.
1152 </returns>
1153 </member>
1154 <member name="M:NAnt.Core.Filters.ChainableReader.Close">
1155 <summary>
1156 Closes the reader.
1157 </summary>
1158 </member>
1159 <member name="M:NAnt.Core.Filters.ChainableReader.Dispose">
1160 <summary>
1161 Calls close and supresses the finalizer for the object.
1162 </summary>
1163 </member>
1164 <member name="P:NAnt.Core.Filters.ChainableReader.Base">
1165 <summary>
1166 Gets a value indicating if the reader is backed by a stream in the
1167 chain.
1168 </summary>
1169 <value>
1170 <see langword="true" /> if the reader is backed by a stream;
1171 otherwise, <see langword="false" />.
1172 </value>
1173 </member>
1174 <member name="T:NAnt.Core.Filters.Filter">
1175 <summary>
1176 Allows a file's content to be modified while performing an operation.
1177 </summary>
1178 </member>
1179 <member name="M:NAnt.Core.Filters.Filter.InitializeFilter">
1180 <summary>
1181 Called after construction and after properties are set. Allows
1182 for filter initialization.
1183 </summary>
1184 </member>
1185 <member name="P:NAnt.Core.Filters.Filter.IfDefined">
1186 <summary>
1187 If <see langword="true" /> then the filter will be used; otherwise,
1188 skipped. The default is <see langword="true" />.
1189 </summary>
1190 </member>
1191 <member name="P:NAnt.Core.Filters.Filter.UnlessDefined">
1192 <summary>
1193 Opposite of <see cref="P:NAnt.Core.Filters.Filter.IfDefined"/>. If <see langword="false"/>
1194 then the filter will be executed; otherwise, skipped. The default
1195 is <see langword="false"/>.
1196 </summary>
1197 </member>
1198 <member name="M:NAnt.Core.Filters.FilterBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
1199 <summary>
1200 Creates a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> class
1201 for the specified <see cref="T:NAnt.Core.Filters.Filter"/> class in the specified
1202 <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.
1203 </summary>
1204 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
1205 <param name="className">The class representing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
1206 </member>
1207 <member name="P:NAnt.Core.Filters.FilterBuilder.ClassName">
1208 <summary>
1209 Gets the name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created
1210 using this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>.
1211 </summary>
1212 <value>
1213 The name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created using
1214 this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>.
1215 </value>
1216 </member>
1217 <member name="P:NAnt.Core.Filters.FilterBuilder.FilterName">
1218 <summary>
1219 Gets the name of the filter which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/>
1220 can create.
1221 </summary>
1222 <value>
1223 The name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/> can
1224 create.
1225 </value>
1226 </member>
1227 <member name="T:NAnt.Core.Filters.FilterBuilderCollection">
1228 <summary>
1229 Contains a strongly typed collection of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> objects.
1230 </summary>
1231 </member>
1232 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor">
1233 <summary>
1234 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class.
1235 </summary>
1236 </member>
1237 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilderCollection)">
1238 <summary>
1239 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class
1240 with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> instance.
1241 </summary>
1242 </member>
1243 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilder[])">
1244 <summary>
1245 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class
1246 with the specified array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
1247 </summary>
1248 </member>
1249 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Add(NAnt.Core.Filters.FilterBuilder)">
1250 <summary>
1251 Adds a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to the end of the collection.
1252 </summary>
1253 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to be added to the end of the collection.</param>
1254 <returns>The position into which the new element was inserted.</returns>
1255 </member>
1256 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilder[])">
1257 <summary>
1258 Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> array to the end of the collection.
1259 </summary>
1260 <param name="items">The array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements to be added to the end of the collection.</param>
1261 </member>
1262 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilderCollection)">
1263 <summary>
1264 Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to the end of the collection.
1265 </summary>
1266 <param name="items">The <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to be added to the end of the collection.</param>
1267 </member>
1268 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(NAnt.Core.Filters.FilterBuilder)">
1269 <summary>
1270 Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> is in the collection.
1271 </summary>
1272 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to locate in the collection.</param>
1273 <returns>
1274 <see langword="true"/> if <paramref name="item"/> is found in the
1275 collection; otherwise, <see langword="false"/>.
1276 </returns>
1277 </member>
1278 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(System.String)">
1279 <summary>
1280 Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified
1281 task is in the collection.
1282 </summary>
1283 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> should be located in the collection.</param>
1284 <returns>
1285 <see langword="true"/> if a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for
1286 the specified task is found in the collection; otherwise,
1287 <see langword="false"/>.
1288 </returns>
1289 </member>
1290 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.CopyTo(NAnt.Core.Filters.FilterBuilder[],System.Int32)">
1291 <summary>
1292 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
1293 </summary>
1294 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
1295 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
1296 </member>
1297 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.IndexOf(NAnt.Core.Filters.FilterBuilder)">
1298 <summary>
1299 Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object in the collection.
1300 </summary>
1301 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object for which the index is returned.</param>
1302 <returns>
1303 The index of the specified <see cref="T:NAnt.Core.Filters.FilterBuilder"/>. If the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> is not currently a member of the collection, it returns -1.
1304 </returns>
1305 </member>
1306 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Insert(System.Int32,NAnt.Core.Filters.FilterBuilder)">
1307 <summary>
1308 Inserts a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> into the collection at the specified index.
1309 </summary>
1310 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
1311 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to insert.</param>
1312 </member>
1313 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.GetEnumerator">
1314 <summary>
1315 Returns an enumerator that can iterate through the collection.
1316 </summary>
1317 <returns>
1318 A <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> for the entire collection.
1319 </returns>
1320 </member>
1321 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Remove(NAnt.Core.Filters.FilterBuilder)">
1322 <summary>
1323 Removes a member from the collection.
1324 </summary>
1325 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to remove from the collection.</param>
1326 </member>
1327 <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.Int32)">
1328 <summary>
1329 Gets or sets the element at the specified index.
1330 </summary>
1331 <param name="index">The zero-based index of the element to get or set.</param>
1332 </member>
1333 <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.String)">
1334 <summary>
1335 Gets the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified task.
1336 </summary>
1337 <param name="filterName">The name of the filter for which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> should be located in the collection.</param>
1338 </member>
1339 <member name="T:NAnt.Core.Filters.FilterBuilderEnumerator">
1340 <summary>
1341 Enumerates the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>.
1342 </summary>
1343 </member>
1344 <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.#ctor(NAnt.Core.Filters.FilterBuilderCollection)">
1345 <summary>
1346 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> class
1347 with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>.
1348 </summary>
1349 <param name="arguments">The collection that should be enumerated.</param>
1350 </member>
1351 <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.MoveNext">
1352 <summary>
1353 Advances the enumerator to the next element of the collection.
1354 </summary>
1355 <returns>
1356 <see langword="true" /> if the enumerator was successfully advanced
1357 to the next element; <see langword="false" /> if the enumerator has
1358 passed the end of the collection.
1359 </returns>
1360 </member>
1361 <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.Reset">
1362 <summary>
1363 Sets the enumerator to its initial position, which is before the
1364 first element in the collection.
1365 </summary>
1366 </member>
1367 <member name="P:NAnt.Core.Filters.FilterBuilderEnumerator.Current">
1368 <summary>
1369 Gets the current element in the collection.
1370 </summary>
1371 <returns>
1372 The current element in the collection.
1373 </returns>
1374 </member>
1375 <member name="T:NAnt.Core.Filters.FilterChain">
1376 <summary>
1377 Represent a chain of NAnt filters that can be applied to a <see cref="T:NAnt.Core.Task"/>.
1378 </summary>
1379 <remarks>
1380 <para>
1381 A FilterChain represents a collection of one or more filters that can
1382 be appled to a <see cref="T:NAnt.Core.Task"/> such as the <see cref="T:NAnt.Core.Tasks.CopyTask"/>.
1383 In the case of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>, the contents of the copied
1384 files are filtered through each filter specified in the filter chain.
1385 Filtering occurs in the order the filters are specified with filtered
1386 output of one filter feeding into another.
1387 </para>
1388 <para>
1389 :--------:--->:----------:--->:----------: ... :----------:--->:--------:<br/>
1390 :.Source.:--->:.Filter 1.:--->:.Filter 2.: ... :.Filter n.:--->:.target.:<br/>
1391 :--------:--->:----------:--->:----------: ... :----------:--->:--------:<br/>
1392 </para>
1393 <para>
1394 A list of all filters that come with NAnt is available <see href="../filters/index.html">here</see>.
1395 </para>
1396 <para>
1397 The following tasks support filtering with a FilterChain:
1398 </para>
1399 <list type="bullet">
1400 <item>
1401 <description><see cref="T:NAnt.Core.Tasks.CopyTask"/></description>
1402 </item>
1403 <item>
1404 <description><see cref="T:NAnt.Core.Tasks.MoveTask"/></description>
1405 </item>
1406 </list>
1407 </remarks>
1408 <example>
1409 <para>
1410 Replace all occurrences of @NOW@ with the current date/time and
1411 replace tabs with spaces in all copied files.
1412 </para>
1413 <code>
1414 <![CDATA[
1415 <property name="NOW" value="${datetime::now()}" />
1416 <copy todir="out">
1417 <fileset basedir="in">
1418 <include name="**/*" />
1419 </fileset>
1420 <filterchain>
1421 <replacetokens>
1422 <token key="NOW" value="${TODAY}" />
1423 </replacetokens>
1424 <tabstospaces />
1425 </filterchain>
1426 </copy>
1427 ]]>
1428 </code>
1429 </example>
1430 </member>
1431 <member name="T:NAnt.Core.DataTypeBase">
1432 <summary>
1433 Provides the abstract base class for types.
1434 </summary>
1435 </member>
1436 <member name="M:NAnt.Core.DataTypeBase.Reset">
1437 <summary>
1438 Should be overridden by derived classes. clones the referenced types
1439 data into the current instance.
1440 </summary>
1441 </member>
1442 <member name="M:NAnt.Core.DataTypeBase.CopyTo(NAnt.Core.DataTypeBase)">
1443 <summary>
1444 Copies all instance data of the <see cref="T:NAnt.Core.DataTypeBase"/> to a given
1445 <see cref="T:NAnt.Core.DataTypeBase"/>.
1446 </summary>
1447 </member>
1448 <member name="P:NAnt.Core.DataTypeBase.ID">
1449 <summary>
1450 The ID used to be referenced later.
1451 </summary>
1452 </member>
1453 <member name="P:NAnt.Core.DataTypeBase.RefID">
1454 <summary>
1455 The ID to use as the reference.
1456 </summary>
1457 </member>
1458 <member name="P:NAnt.Core.DataTypeBase.CanBeReferenced">
1459 <summary>
1460 Gets a value indicating whether a reference to the type can be
1461 defined.
1462 </summary>
1463 <remarks>
1464 Only types with an <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned
1465 to it, can be referenced.
1466 </remarks>
1467 </member>
1468 <member name="P:NAnt.Core.DataTypeBase.Name">
1469 <summary>
1470 Gets the name of the datatype.
1471 </summary>
1472 <value>
1473 The name of the datatype.
1474 </value>
1475 </member>
1476 <member name="M:NAnt.Core.Filters.FilterChain.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
1477 <summary>
1478 Initializes all build attributes and child elements.
1479 </summary>
1480 <remarks>
1481 <see cref="T:NAnt.Core.Filters.FilterChain"/> needs to maintain the order in which the
1482 filters are specified in the build file.
1483 </remarks>
1484 </member>
1485 <member name="M:NAnt.Core.Filters.FilterChain.GetBaseFilter(NAnt.Core.Filters.PhysicalTextReader)">
1486 <summary>
1487 Used to to instantiate and return the chain of stream based filters.
1488 </summary>
1489 <param name="physicalTextReader">The <see cref="T:NAnt.Core.Filters.PhysicalTextReader"/> that is the source of input to the filter chain.</param>
1490 <remarks>
1491 The <paramref name="physicalTextReader"/> is the first <see cref="T:NAnt.Core.Filters.Filter"/>
1492 in the chain, which is based on a physical stream that feeds the chain.
1493 </remarks>
1494 <returns>
1495 The last <see cref="T:NAnt.Core.Filters.Filter"/> in the chain.
1496 </returns>
1497 </member>
1498 <member name="P:NAnt.Core.Filters.FilterChain.Filters">
1499 <summary>
1500 The filters to apply.
1501 </summary>
1502 </member>
1503 <member name="P:NAnt.Core.Filters.FilterChain.InputEncoding">
1504 <summary>
1505 The encoding to assume when filter-copying files. The default is
1506 system's current ANSI code page.
1507 </summary>
1508 </member>
1509 <member name="T:NAnt.Core.Filters.FilterChain.FilterChainConfigurator">
1510 <summary>
1511 Configurator that initializes filters in the order in which they've
1512 been specified in the build file.
1513 </summary>
1514 </member>
1515 <member name="T:NAnt.Core.Filters.FilterCollection">
1516 <summary>
1517 Contains a collection of <see cref="T:NAnt.Core.Filters.Filter"/> elements.
1518 </summary>
1519 </member>
1520 <member name="M:NAnt.Core.Filters.FilterCollection.#ctor">
1521 <summary>
1522 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class.
1523 </summary>
1524 </member>
1525 <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.FilterCollection)">
1526 <summary>
1527 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class
1528 with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/> instance.
1529 </summary>
1530 </member>
1531 <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.Filter[])">
1532 <summary>
1533 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class
1534 with the specified array of <see cref="T:NAnt.Core.Filters.Filter"/> instances.
1535 </summary>
1536 </member>
1537 <member name="M:NAnt.Core.Filters.FilterCollection.Add(NAnt.Core.Filters.Filter)">
1538 <summary>
1539 Adds a <see cref="T:NAnt.Core.Filters.Filter"/> to the end of the collection.
1540 </summary>
1541 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to be added to the end of the collection.</param>
1542 <returns>The position into which the new element was inserted.</returns>
1543 </member>
1544 <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.Filter[])">
1545 <summary>
1546 Adds the elements of a <see cref="T:NAnt.Core.Filters.Filter"/> array to the end of the collection.
1547 </summary>
1548 <param name="items">The array of <see cref="T:NAnt.Core.Filters.Filter"/> elements to be added to the end of the collection.</param>
1549 </member>
1550 <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.FilterCollection)">
1551 <summary>
1552 Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/> to the end of the collection.
1553 </summary>
1554 <param name="items">The <see cref="T:NAnt.Core.Filters.FilterCollection"/> to be added to the end of the collection.</param>
1555 </member>
1556 <member name="M:NAnt.Core.Filters.FilterCollection.Contains(NAnt.Core.Filters.Filter)">
1557 <summary>
1558 Determines whether a <see cref="T:NAnt.Core.Filters.Filter"/> is in the collection.
1559 </summary>
1560 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to locate in the collection.</param>
1561 <returns>
1562 <see langword="true"/> if <paramref name="item"/> is found in the
1563 collection; otherwise, <see langword="false"/>.
1564 </returns>
1565 </member>
1566 <member name="M:NAnt.Core.Filters.FilterCollection.CopyTo(NAnt.Core.Filters.Filter[],System.Int32)">
1567 <summary>
1568 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
1569 </summary>
1570 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
1571 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
1572 </member>
1573 <member name="M:NAnt.Core.Filters.FilterCollection.IndexOf(NAnt.Core.Filters.Filter)">
1574 <summary>
1575 Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.Filter"/> object in the collection.
1576 </summary>
1577 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> object for which the index is returned.</param>
1578 <returns>
1579 The index of the specified <see cref="T:NAnt.Core.Filters.Filter"/>. If the <see cref="T:NAnt.Core.Filters.Filter"/> is not currently a member of the collection, it returns -1.
1580 </returns>
1581 </member>
1582 <member name="M:NAnt.Core.Filters.FilterCollection.Insert(System.Int32,NAnt.Core.Filters.Filter)">
1583 <summary>
1584 Inserts a <see cref="T:NAnt.Core.Filters.Filter"/> into the collection at the specified index.
1585 </summary>
1586 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
1587 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to insert.</param>
1588 </member>
1589 <member name="M:NAnt.Core.Filters.FilterCollection.GetEnumerator">
1590 <summary>
1591 Returns an enumerator that can iterate through the collection.
1592 </summary>
1593 <returns>
1594 A <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> for the entire collection.
1595 </returns>
1596 </member>
1597 <member name="M:NAnt.Core.Filters.FilterCollection.Remove(NAnt.Core.Filters.Filter)">
1598 <summary>
1599 Removes a member from the collection.
1600 </summary>
1601 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to remove from the collection.</param>
1602 </member>
1603 <member name="P:NAnt.Core.Filters.FilterCollection.Item(System.Int32)">
1604 <summary>
1605 Gets or sets the element at the specified index.
1606 </summary>
1607 <param name="index">The zero-based index of the element to get or set.</param>
1608 </member>
1609 <member name="T:NAnt.Core.Filters.FilterEnumerator">
1610 <summary>
1611 Enumerates the <see cref="T:NAnt.Core.Filters.Filter"/> elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/>.
1612 </summary>
1613 </member>
1614 <member name="M:NAnt.Core.Filters.FilterEnumerator.#ctor(NAnt.Core.Filters.FilterCollection)">
1615 <summary>
1616 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> class
1617 with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/>.
1618 </summary>
1619 <param name="arguments">The collection that should be enumerated.</param>
1620 </member>
1621 <member name="M:NAnt.Core.Filters.FilterEnumerator.MoveNext">
1622 <summary>
1623 Advances the enumerator to the next element of the collection.
1624 </summary>
1625 <returns>
1626 <see langword="true" /> if the enumerator was successfully advanced
1627 to the next element; <see langword="false" /> if the enumerator has
1628 passed the end of the collection.
1629 </returns>
1630 </member>
1631 <member name="M:NAnt.Core.Filters.FilterEnumerator.Reset">
1632 <summary>
1633 Sets the enumerator to its initial position, which is before the
1634 first element in the collection.
1635 </summary>
1636 </member>
1637 <member name="P:NAnt.Core.Filters.FilterEnumerator.Current">
1638 <summary>
1639 Gets the current element in the collection.
1640 </summary>
1641 <returns>
1642 The current element in the collection.
1643 </returns>
1644 </member>
1645 <member name="T:NAnt.Core.Filters.PhysicalTextReader">
1646 <summary>
1647 Represents a physical <see cref="T:System.IO.TextReader"/>. That is a reader based
1648 on a stream.
1649 </summary>
1650 <remarks>
1651 Used by <see cref="T:NAnt.Core.Filters.ChainableReader"/> to represent a <see cref="T:NAnt.Core.Filters.Filter"/>
1652 based on a <see cref="T:System.IO.TextReader"/> in the chain.
1653 </remarks>
1654 </member>
1655 <member name="T:NAnt.Core.Filters.ExpandProperties">
1656 <summary>
1657 Parses NAnt properties and expressions
1658 </summary>
1659 <remarks>
1660 <para>
1661 This filter parses any NAnt properties or expressions found in its input,
1662 inlining their values in its output.
1663 </para>
1664 <para>
1665 Note: Due to limitations on buffering, expressions longer than 2048
1666 characters are not guaranteed to be expanded.
1667 </para>
1668 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
1669 </remarks>
1670 <example>
1671 <para>Replace all properties with their corresponding values.</para>
1672 <code>
1673 <![CDATA[
1674 <expandproperties />
1675 ]]>
1676 </code>
1677 </example>
1678 </member>
1679 <member name="F:NAnt.Core.Filters.ExpandProperties._buffer">
1680 <summary>
1681 Holds data for expression expansion between input and output.
1682 </summary>
1683 </member>
1684 <member name="M:NAnt.Core.Filters.ExpandProperties.InitializeFilter">
1685 <summary>
1686 Called after construction and after properties are set. Allows
1687 for filter initialization.
1688 </summary>
1689 </member>
1690 <member name="M:NAnt.Core.Filters.ExpandProperties.Read">
1691 <summary>
1692 Reads the next character applying the filter logic.
1693 </summary>
1694 <returns>Char as an int or -1 if at the end of the stream</returns>
1695 </member>
1696 <member name="M:NAnt.Core.Filters.ExpandProperties.Peek">
1697 <summary>
1698 Reads the next character applying the filter logic without advancing the current position in the stream.
1699 </summary>
1700 <returns>Char as an int or -1 if at the end of the stream</returns>
1701 </member>
1702 <member name="M:NAnt.Core.Filters.ExpandProperties.Advance">
1703 <summary>
1704 Moves to the next character.
1705 </summary>
1706 </member>
1707 <member name="M:NAnt.Core.Filters.ExpandProperties.ReplenishBuffer">
1708 <summary>
1709 Refills the buffer, running our input through
1710 <see cref="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location)"/>.)
1711 </summary>
1712 </member>
1713 <member name="P:NAnt.Core.Filters.ExpandProperties.AtEnd">
1714 <summary>
1715 Determines whether we've passed the end of our data.
1716 </summary>
1717 </member>
1718 <member name="T:NAnt.Core.Filters.ReplaceString">
1719 <summary>
1720 Replaces all occurrences of a given string in the original input with
1721 user-supplied replacement string.
1722 </summary>
1723 <remarks>
1724 <para>
1725 This filter replaces all occurrences of a given string in the original
1726 input stream with a user-supplied replacement string. By default string
1727 comparisons are case sensitive but this can be changed by setting the
1728 optional <see cref="P:NAnt.Core.Filters.ReplaceString.IgnoreCase"/> attribute to <see langword="true"/>.
1729 </para>
1730 <para>
1731 To use this filter specify the string to be replaced with the
1732 <see cref="P:NAnt.Core.Filters.ReplaceString.From"/> attribute and the string to replace it with using the
1733 <see cref="P:NAnt.Core.Filters.ReplaceString.To"/> attribute.
1734 </para>
1735 <para>
1736 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
1737 </para>
1738 </remarks>
1739 <example>
1740 <para>
1741 Replace all occurrences of "3.14" with "PI".
1742 </para>
1743 <code>
1744 <![CDATA[
1745 <replacestring from="3.14" to="PI" />
1746 ]]>
1747 </code>
1748 </example>
1749 <example>
1750 <para>
1751 Replace all occurrences of "string", "String", etc. with "System.String".
1752 </para>
1753 <code>
1754 <![CDATA[
1755 <replacestring from="String" to="System.String" ignorecase="true" />
1756 ]]>
1757 </code>
1758 </example>
1759 </member>
1760 <member name="M:NAnt.Core.Filters.ReplaceString.Chain(NAnt.Core.Filters.ChainableReader)">
1761 <summary>
1762 Construct that allows this filter to be chained to the one
1763 in the parameter chainedReader.
1764 </summary>
1765 <param name="chainedReader">Filter that the filter will be chained to</param>
1766 </member>
1767 <member name="M:NAnt.Core.Filters.ReplaceString.Read">
1768 <summary>
1769 Reads the next character applying the filter logic.
1770 </summary>
1771 <returns>Char as an int or -1 if at the end of the stream</returns>
1772 </member>
1773 <member name="M:NAnt.Core.Filters.ReplaceString.Peek">
1774 <summary>
1775 Reads the next character applying the filter logic without
1776 advancing the current position in the stream.
1777
1778 Peek currently is not supported.
1779 </summary>
1780 <returns>
1781 Char as an int or -1 if at the end of the stream.
1782 </returns>
1783 </member>
1784 <member name="M:NAnt.Core.Filters.ReplaceString.FindString(System.Int32,System.Boolean@,System.String@)">
1785 <summary>
1786 <para>
1787 Helper function used to search for the filter's traget string. If the string
1788 is found the result is true. If the string was not found false is returned and
1789 nonMatchingChars contains the characters that were read to determine if the
1790 string is present.
1791 </para>
1792
1793 <para>
1794 It is assumed the stream is positioned at the character after the first character
1795 in the target string.
1796 </para>
1797 </summary>
1798 <param name="startChar">First character in target string</param>
1799 <param name="streamEnded">Ture if the stream ended while search for the string.</param>
1800 <param name="nonMatchingChars">Characters that were read while searching for the string.</param>
1801 <returns></returns>
1802 </member>
1803 <member name="M:NAnt.Core.Filters.ReplaceString.GetNextCharacter(NAnt.Core.Filters.ReplaceString.AcquireCharDelegate)">
1804 <summary>
1805 Returns the next character in the stream replacing the specified character. Using the
1806 <see cref="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
1807 </summary>
1808 <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
1809 <returns>Char as an int or -1 if at the end of the stream</returns>
1810 </member>
1811 <member name="M:NAnt.Core.Filters.ReplaceString.CompareCharacters(System.Int32,System.Int32)">
1812 <summary>
1813 Compares to characters taking into account the _ignoreCase flag.
1814 </summary>
1815 <param name="char1"></param>
1816 <param name="char2"></param>
1817 <returns></returns>
1818 </member>
1819 <member name="P:NAnt.Core.Filters.ReplaceString.From">
1820 <summary>
1821 The string to be replaced.
1822 </summary>
1823 </member>
1824 <member name="P:NAnt.Core.Filters.ReplaceString.To">
1825 <summary>
1826 The new value for the replaced string.
1827 Am empty string is permissible.
1828 </summary>
1829 </member>
1830 <member name="P:NAnt.Core.Filters.ReplaceString.IgnoreCase">
1831 <summary>
1832 Determines if case will be ignored.
1833 The default is <see langword="false" />.
1834 </summary>
1835 </member>
1836 <member name="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate">
1837 <summary>
1838 Delegate for Read and Peek. Allows the same implementation
1839 to be used for both methods.
1840 </summary>
1841 </member>
1842 <member name="T:NAnt.Core.Filters.ReplaceTokens">
1843 <summary>
1844 Replaces tokens in the original input with user-supplied values.
1845 </summary>
1846 <remarks>
1847 <para>
1848 This filter replaces all token surrounded by a beginning and ending
1849 token. The default beginning and ending tokens both default to '@'. The
1850 optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.BeginToken"/> and <see cref="P:NAnt.Core.Filters.ReplaceTokens.EndToken"/> attributes
1851 can be specified to change either token. By default string
1852 comparisons are case sensitive but this can be changed by setting the
1853 optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> attribute to <see langword="true"/>.
1854 </para>
1855 <para>
1856 Tokens are specified by using the <see cref="T:NAnt.Core.Types.Token"/> element. It is
1857 possible to specify from 1 to n tokens and replacement values. Values can
1858 be any valid NAnt expression.
1859 </para>
1860 <para>
1861 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
1862 </para>
1863 </remarks>
1864 <example>
1865 <para>
1866 Replace all occurrences of the string @DATE@ with the value of property
1867 "TODAY".
1868 </para>
1869 <code>
1870 <![CDATA[
1871 <replacetokens>
1872 <token key="DATE" value="${TODAY}" />
1873 </replacetokens>
1874 ]]>
1875 </code>
1876 </example>
1877 <example>
1878 <para>
1879 Replace all occurrences of the string <DATE> with the value of
1880 property "TODAY".
1881 </para>
1882 <code>
1883 <![CDATA[
1884 <replacetokens begintoken="<" endtoken=">">
1885 <token key="DATE" value="${TODAY}" />
1886 </replacetokens>
1887 ]]>
1888 </code>
1889 </example>
1890 </member>
1891 <member name="M:NAnt.Core.Filters.ReplaceTokens.Chain(NAnt.Core.Filters.ChainableReader)">
1892 <summary>
1893 Construct that allows this filter to be chained to the one
1894 in the parameter chainedReader.
1895 </summary>
1896 <param name="chainedReader">Filter that the filter will be chained to</param>
1897 </member>
1898 <member name="M:NAnt.Core.Filters.ReplaceTokens.Read">
1899 <summary>
1900 Reads the next character applying the filter logic.
1901 </summary>
1902 <returns>Char as an int or -1 if at the end of the stream</returns>
1903 </member>
1904 <member name="M:NAnt.Core.Filters.ReplaceTokens.Peek">
1905 <summary>
1906 Reads the next character applying the filter logic without
1907 advancing the current position in the stream.
1908
1909 Peek currently is not supported.
1910 </summary>
1911 <returns>
1912 Char as an int or -1 if at the end of the stream.
1913 </returns>
1914 </member>
1915 <member name="M:NAnt.Core.Filters.ReplaceTokens.Initialize">
1916 <summary>
1917 Initialize the filter by setting its parameters.
1918 </summary>
1919 </member>
1920 <member name="M:NAnt.Core.Filters.ReplaceTokens.FindTokenContents(System.Boolean@,System.Boolean@,System.Boolean@)">
1921 <summary>
1922 Finds a token give that we are positioned at a beginning token character. Either a
1923 token replacement is returned or the characters that were read looking for the token.
1924 </summary>
1925 <param name="tokenNotFound">A token was not found</param>
1926 <param name="unknownToken">A token was found by there is no replacement</param>
1927 <param name="streamEnded">The stream ended while looking for the token</param>
1928 <returns>Either the replacement token or the characters that were read looking for the token</returns>
1929 </member>
1930 <member name="M:NAnt.Core.Filters.ReplaceTokens.GetNextCharacter(NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate)">
1931 <summary>
1932 Returns the next character in the stream replacing the specified character. Using the
1933 <see cref="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
1934 </summary>
1935 <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
1936 <returns>Char as an int or -1 if at the end of the stream</returns>
1937 </member>
1938 <member name="M:NAnt.Core.Filters.ReplaceTokens.CompareCharacters(System.Int32,System.Int32)">
1939 <summary>
1940 Compares to characters taking <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> into account.
1941 </summary>
1942 <param name="char1"></param>
1943 <param name="char2"></param>
1944 <returns>
1945 </returns>
1946 </member>
1947 <member name="P:NAnt.Core.Filters.ReplaceTokens.BeginToken">
1948 <summary>
1949 Marks the beginning of a token. The default is "@".
1950 </summary>
1951 </member>
1952 <member name="P:NAnt.Core.Filters.ReplaceTokens.EndToken">
1953 <summary>
1954 Marks the end of a token. The default is "@".
1955 </summary>
1956 </member>
1957 <member name="P:NAnt.Core.Filters.ReplaceTokens.Tokens">
1958 <summary>
1959 Tokens and replacement values.
1960 </summary>
1961 </member>
1962 <member name="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase">
1963 <summary>
1964 Determines if case will be ignored.
1965 The default is <see langword="false" />.
1966 </summary>
1967 </member>
1968 <member name="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate">
1969 <summary>
1970 Delegate for Read and Peek. Allows the same implementation
1971 to be used for both methods.
1972 </summary>
1973 </member>
1974 <member name="T:NAnt.Core.Filters.TabsToSpaces">
1975 <summary>
1976 Converts tabs to spaces.
1977 </summary>
1978 <remarks>
1979 <para>
1980 The <see cref="T:NAnt.Core.Filters.TabsToSpaces"/> filter replaces tabs in a text file
1981 with spaces.
1982 </para>
1983 <para>
1984 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
1985 </para>
1986 </remarks>
1987 <example>
1988 <para>Replace all tabs with four spaces.</para>
1989 <code>
1990 <![CDATA[
1991 <tabtospaces tablength="4" />
1992 ]]>
1993 </code>
1994 </example>
1995 </member>
1996 <member name="M:NAnt.Core.Filters.TabsToSpaces.Chain(NAnt.Core.Filters.ChainableReader)">
1997 <summary>
1998 Construct that allows this filter to be chained to the one
1999 in the parameter chainedReader.
2000 </summary>
2001 <param name="chainedReader">Filter that the filter will be chained to</param>
2002 </member>
2003 <member name="M:NAnt.Core.Filters.TabsToSpaces.Peek">
2004 <summary>
2005 <para>Retrieves the next character with moving the position in the stream.</para>
2006 <note>This method is not implemented</note>
2007 </summary>
2008 <returns>-1 if end of stream otherwise a character</returns>
2009 </member>
2010 <member name="M:NAnt.Core.Filters.TabsToSpaces.Read">
2011 <summary>
2012 <para>Retrieves the next character in the stream.</para>
2013 </summary>
2014 <returns>-1 if end of stream otherwise a character</returns>
2015 </member>
2016 <member name="M:NAnt.Core.Filters.TabsToSpaces.GetNextCharacter(NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate)">
2017 <summary>
2018 Returns the next character in the stream replacing the specified character. Using the
2019 <see cref="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
2020 </summary>
2021 <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
2022 <returns>Char as an int or -1 if at the end of the stream</returns>
2023 </member>
2024 <member name="P:NAnt.Core.Filters.TabsToSpaces.TabLength">
2025 <summary>
2026 The number of spaces used when converting a tab. The default is
2027 "8".
2028 </summary>
2029 </member>
2030 <member name="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate">
2031 <summary>
2032 Delegate for Read and Peek. Allows the same implementation
2033 to be used for both methods.
2034 </summary>
2035 </member>
2036 <member name="T:NAnt.Core.Functions.AssemblyFunctions">
2037 <summary>
2038 Functions to return information for a given assembly.
2039 </summary>
2040 </member>
2041 <member name="P:NAnt.Core.FunctionSetBase.Project">
2042 <summary>
2043 Gets or sets the <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will
2044 reference.
2045 </summary>
2046 <value>
2047 The <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will reference.
2048 </value>
2049 </member>
2050 <member name="M:NAnt.Core.Functions.AssemblyFunctions.LoadFromFile(System.String)">
2051 <summary>
2052 Loads an assembly given its file name or path.
2053 </summary>
2054 <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
2055 <returns>
2056 The loaded assembly.
2057 </returns>
2058 <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
2059 <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> is not found, or the module you are trying to load does not specify a filename extension.</exception>
2060 <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception>
2061 <exception cref="T:System.IO.PathTooLongException">An assembly or module was loaded twice with two different evidences, or the assembly name is longer than MAX_PATH characters.</exception>
2062 </member>
2063 <member name="M:NAnt.Core.Functions.AssemblyFunctions.Load(System.String)">
2064 <summary>
2065 Loads an assembly given the long form of its name.
2066 </summary>
2067 <param name="assemblyString">The long form of the assembly name.</param>
2068 <returns>
2069 The loaded assembly.
2070 </returns>
2071 <exception cref="T:System.ArgumentNullException"><paramref name="assemblyString"/> is a <see langword="null"/>.</exception>
2072 <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyString"/> is not found.</exception>
2073 <example>
2074 <para>
2075 Determine the location of the Microsoft Access 11 Primary Interop
2076 Assembly by loading it using its fully qualified name, and copy it
2077 to the build directory.
2078 </para>
2079 <code>
2080 <![CDATA[
2081 <property name="access.pia.path" value="${assembly::get-location(assembly::load('Microsoft.Office.Interop.Access, Version=11.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c'))}" />
2082 <copy file="${access.pia.path}" todir="${build.dir}" />
2083 ]]>
2084 </code>
2085 </example>
2086 </member>
2087 <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetFullName(System.Reflection.Assembly)">
2088 <summary>
2089 Gets the full name of the assembly, also known as the display name.
2090 </summary>
2091 <param name="assembly">The assembly to get the full name for.</param>
2092 <returns>
2093 The full name of the assembly, also known as the display name.
2094 </returns>
2095 </member>
2096 <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)">
2097 <summary>
2098 Gets an <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly.
2099 </summary>
2100 <param name="assembly">The assembly to get an <see cref="T:System.Reflection.AssemblyName"/> for.</param>
2101 <returns>
2102 An <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly.
2103 </returns>
2104 <seealso cref="T:NAnt.Core.Functions.AssemblyNameFunctions"/>
2105 </member>
2106 <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetLocation(System.Reflection.Assembly)">
2107 <summary>
2108 Gets the physical location, in codebase format, of the loaded file
2109 that contains the manifest.
2110 </summary>
2111 <param name="assembly">The assembly to get the location for.</param>
2112 <returns>
2113 The location of the specified assembly.
2114 </returns>
2115 </member>
2116 <member name="T:NAnt.Core.Functions.AssemblyNameFunctions">
2117 <summary>
2118 Functions that return information about an assembly's identity.
2119 </summary>
2120 </member>
2121 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetCodeBase(System.Reflection.AssemblyName)">
2122 <summary>
2123 Gets the location of the assembly as a URL.
2124 </summary>
2125 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2126 <returns>
2127 The location of the assembly as a URL.
2128 </returns>
2129 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2130 </member>
2131 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetEscapedCodeBase(System.Reflection.AssemblyName)">
2132 <summary>
2133 Gets the URI, including escape characters, that represents the codebase.
2134 </summary>
2135 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2136 <returns>
2137 The URI, including escape characters, that represents the codebase.
2138 </returns>
2139 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2140 </member>
2141 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetFullName(System.Reflection.AssemblyName)">
2142 <summary>
2143 Gets the full name of the assembly, also known as the display name.
2144 </summary>
2145 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2146 <returns>
2147 The full name of the assembly, also known as the display name.
2148 </returns>
2149 <example>
2150 <para>
2151 Output the full name of the <c>nunit.framework</c> assembly to the
2152 build log.
2153 </para>
2154 <code>
2155 <![CDATA[
2156 <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
2157 ]]>
2158 </code>
2159 </example>
2160 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2161 </member>
2162 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetName(System.Reflection.AssemblyName)">
2163 <summary>
2164 Gets the simple, unencrypted name of the assembly.
2165 </summary>
2166 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2167 <returns>
2168 The simple, unencrypted name of the assembly.
2169 </returns>
2170 <example>
2171 <para>
2172 Output the simple name of the <c>nunit.framework</c> assembly to
2173 the build log.
2174 </para>
2175 <code>
2176 <![CDATA[
2177 <echo message="${assemblyname::get-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
2178 ]]>
2179 </code>
2180 </example>
2181 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2182 </member>
2183 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)">
2184 <summary>
2185 Gets the version of the assembly.
2186 </summary>
2187 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2188 <returns>
2189 The version of the assembly.
2190 </returns>
2191 <example>
2192 <para>
2193 Output the major version of the <c>nunit.framework</c> assembly
2194 to the build log.
2195 </para>
2196 <code>
2197 <![CDATA[
2198 <echo message="${version::get-major-version(assemblyname::get-version(assemblyname::get-assembly-name('nunit.framework.dll')))}" />
2199 ]]>
2200 </code>
2201 </example>
2202 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2203 <seealso cref="T:NAnt.Core.Functions.VersionFunctions"/>
2204 </member>
2205 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetAssemblyName(System.String)">
2206 <summary>
2207 Gets the <see cref="T:System.Reflection.AssemblyName"/> for a given file.
2208 </summary>
2209 <param name="assemblyFile">The assembly file for which to get the <see cref="T:System.Reflection.AssemblyName"/>.</param>
2210 <returns>
2211 An <see cref="T:System.Reflection.AssemblyName"/> object representing the given file.
2212 </returns>
2213 <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
2214 <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> does not exist.</exception>
2215 <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception>
2216 <remarks>
2217 The assembly is not added to this domain.
2218 </remarks>
2219 <example>
2220 <para>
2221 Output the full name of the <c>nunit.framework</c> assembly to the
2222 build log.
2223 </para>
2224 <code>
2225 <![CDATA[
2226 <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
2227 ]]>
2228 </code>
2229 </example>
2230 </member>
2231 <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.Parse(System.String)">
2232 <summary>
2233 Converts the specified string representation of a logical value to
2234 its <see cref="T:System.Boolean"/> equivalent.
2235 </summary>
2236 <param name="s">A string containing the value to convert.</param>
2237 <returns>
2238 <see langword="true"/> if <paramref name="value"/> is equivalent to
2239 "True"; otherwise, <see langword="false"/>.
2240 </returns>
2241 <exception cref="T:System.FormatException"><paramref name="s"/> is not equivalent to <see cref="F:System.Boolean.TrueString"/> or <see cref="F:System.Boolean.FalseString"/>.</exception>
2242 </member>
2243 <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.ToString(System.Boolean)">
2244 <summary>
2245 Converts the specified <see cref="T:System.Boolean"/> to its equivalent string
2246 representation.
2247 </summary>
2248 <param name="value">A <see cref="T:System.Boolean"/> to convert.</param>
2249 <returns>
2250 "True" if <paramref name="value"/> is <see langword="true"/>, or
2251 "False" if <paramref name="value"/> is <see langword="false"/>.
2252 </returns>
2253 </member>
2254 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToInt(System.Int32)">
2255 <summary>
2256 Converts the argument to an integer.
2257 </summary>
2258 <param name="value">value to be converted</param>
2259 <returns><paramref name="value" /> converted to integer. The function fails with an exception when the conversion is not possible.</returns>
2260 </member>
2261 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDouble(System.Double)">
2262 <summary>
2263 Converts the argument to double
2264 </summary>
2265 <param name="value">The value to be converted.</param>
2266 <returns><paramref name="value" /> converted to double. The function fails with an exception when the conversion is not possible.</returns>
2267 </member>
2268 <member name="M:NAnt.Core.Functions.ConversionFunctions.ConvertToString(System.String)">
2269 <summary>
2270 Converts the argument to a string.
2271 </summary>
2272 <param name="value">The value to be converted.</param>
2273 <returns>
2274 <paramref name="value" /> converted to string. The function fails
2275 with an exception when the conversion is not possible.
2276 </returns>
2277 <remarks>
2278 Named method ConvertToString as a static ToString method would break
2279 CLS compliance.
2280 </remarks>
2281 </member>
2282 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDateTime(System.DateTime)">
2283 <summary>
2284 Converts the argument to a datetime.
2285 </summary>
2286 <param name="value">value to be converted</param>
2287 <returns><paramref name="value" /> converted to datetime. The function fails with an exception when the conversion is not possible.</returns>
2288 </member>
2289 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToBoolean(System.Boolean)">
2290 <summary>
2291 Converts the argument to a boolean
2292 </summary>
2293 <param name="value">The string value to be converted to boolean. Must be 'true' or 'false'.</param>
2294 <returns>
2295 <paramref name="value" /> converted to boolean. The function fails
2296 with an exception when the conversion is not possible.
2297 </returns>
2298 </member>
2299 <member name="M:NAnt.Core.Functions.DateTimeFunctions.Now">
2300 <summary>
2301 Gets a <see cref="T:System.DateTime"/> that is the current local date and
2302 time on this computer.
2303 </summary>
2304 <returns>
2305 A <see cref="T:System.DateTime"/> whose value is the current date and time.
2306 </returns>
2307 </member>
2308 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetYear(System.DateTime)">
2309 <summary>
2310 Gets the year component of the specified date.
2311 </summary>
2312 <param name="date">The date of which to get the year component.</param>
2313 <returns>
2314 The year, between 1 and 9999.
2315 </returns>
2316 </member>
2317 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMonth(System.DateTime)">
2318 <summary>
2319 Gets the month component of the specified date.
2320 </summary>
2321 <param name="date">The date of which to get the month component.</param>
2322 <returns>
2323 The month, between 1 and 12.
2324 </returns>
2325 </member>
2326 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDay(System.DateTime)">
2327 <summary>
2328 Gets the day of the month represented by the specified date.
2329 </summary>
2330 <param name="date">The date of which to get the day of the month.</param>
2331 <returns>
2332 The day value, between 1 and 31.
2333 </returns>
2334 </member>
2335 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetHour(System.DateTime)">
2336 <summary>
2337 Gets the hour component of the specified date.
2338 </summary>
2339 <param name="date">The date of which to get the hour component.</param>
2340 <returns>
2341 The hour, between 0 and 23.
2342 </returns>
2343 </member>
2344 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMinute(System.DateTime)">
2345 <summary>
2346 Gets the minute component of the specified date.
2347 </summary>
2348 <param name="date">The date of which to get the minute component.</param>
2349 <returns>
2350 The minute, between 0 and 59.
2351 </returns>
2352 </member>
2353 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetSecond(System.DateTime)">
2354 <summary>
2355 Gets the seconds component of the specified date.
2356 </summary>
2357 <param name="date">The date of which to get the seconds component.</param>
2358 <returns>
2359 The seconds, between 0 and 59.
2360 </returns>
2361 </member>
2362 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMillisecond(System.DateTime)">
2363 <summary>
2364 Gets the milliseconds component of the specified date.
2365 </summary>
2366 <param name="date">The date of which to get the milliseconds component.</param>
2367 <returns>
2368 The millisecond, between 0 and 999.
2369 </returns>
2370 </member>
2371 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetTicks(System.DateTime)">
2372 <summary>
2373 Gets the number of ticks that represent the specified date.
2374 </summary>
2375 <param name="date">The date of which to get the number of ticks.</param>
2376 <returns>
2377 The number of ticks that represent the date and time of the
2378 specified date.
2379 </returns>
2380 </member>
2381 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfWeek(System.DateTime)">
2382 <summary>
2383 Gets the day of the week represented by the specified date.
2384 </summary>
2385 <param name="date">The date of which to get the day of the week.</param>
2386 <returns>
2387 The day of the week, ranging from zero, indicating Sunday, to six,
2388 indicating Saturday.
2389 </returns>
2390 </member>
2391 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfYear(System.DateTime)">
2392 <summary>
2393 Gets the day of the year represented by the specified date.
2394 </summary>
2395 <param name="date">The date of which to get the day of the year.</param>
2396 <returns>
2397 The day of the year, between 1 and 366.
2398 </returns>
2399 </member>
2400 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDaysInMonth(System.Int32,System.Int32)">
2401 <summary>
2402 Returns the number of days in the specified month of the specified
2403 year.
2404 </summary>
2405 <param name="year">The year.</param>
2406 <param name="month">The month (a number ranging from 1 to 12).</param>
2407 <returns>
2408 The number of days in <paramref name="month"/> for the specified
2409 <paramref name="year"/>.
2410 </returns>
2411 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="month"/> is less than 1 or greater than 12.</exception>
2412 </member>
2413 <member name="M:NAnt.Core.Functions.DateTimeFunctions.IsLeapYear(System.Int32)">
2414 <summary>
2415 Returns an indication whether the specified year is a leap year.
2416 </summary>
2417 <param name="year">A 4-digit year.</param>
2418 <returns>
2419 <see langword="true" /> if <paramref name="year" /> is a leap year;
2420 otherwise, <see langword="false" />.
2421 </returns>
2422 </member>
2423 <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.Parse(System.String)">
2424 <summary>
2425 Converts the specified string representation of a date and time to
2426 its <see cref="T:System.DateTime"/> equivalent.
2427 </summary>
2428 <param name="s">A string containing a date and time to convert.</param>
2429 <returns>
2430 A <see cref="T:System.DateTime"/> equivalent to the date and time contained
2431 in <paramref name="s"/>.
2432 </returns>
2433 <exception cref="T:System.FormatException"><paramref name="s"/> does not contain a valid string representation of a date and time.</exception>
2434 <remarks>
2435 The <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture is
2436 used to supply formatting information about <paramref name="s"/>.
2437 </remarks>
2438 </member>
2439 <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.ToString(System.DateTime)">
2440 <summary>
2441 Converts the specified <see cref="T:System.DateTime"/> to its equivalent
2442 string representation.
2443 </summary>
2444 <param name="value">A <see cref="T:System.DateTime"/> to convert.</param>
2445 <returns>
2446 A string representation of <paramref name="value"/> formatted using
2447 the general format specifier ("G").
2448 </returns>
2449 <remarks>
2450 <paramref name="value"/> is formatted with the
2451 <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture.
2452 </remarks>
2453 </member>
2454 <member name="T:NAnt.Core.Functions.DirectoryFunctions">
2455 <summary>
2456 Groups a set of functions for dealing with directories.
2457 </summary>
2458 </member>
2459 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCreationTime(System.String)">
2460 <summary>
2461 Returns the creation date and time of the specified directory.
2462 </summary>
2463 <param name="path">The directory for which to obtain creation date and time information.</param>
2464 <returns>
2465 The creation date and time of the specified directory.
2466 </returns>
2467 <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
2468 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
2469 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2470 </member>
2471 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastWriteTime(System.String)">
2472 <summary>
2473 Returns the date and time the specified directory was last written to.
2474 </summary>
2475 <param name="path">The directory for which to obtain write date and time information.</param>
2476 <returns>
2477 The date and time the specified directory was last written to.
2478 </returns>
2479 <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
2480 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
2481 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2482 </member>
2483 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastAccessTime(System.String)">
2484 <summary>
2485 Returns the date and time the specified directory was last accessed.
2486 </summary>
2487 <param name="path">The directory for which to obtain access date and time information.</param>
2488 <returns>
2489 The date and time the specified directory was last accessed.
2490 </returns>
2491 <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
2492 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
2493 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2494 <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
2495 </member>
2496 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCurrentDirectory">
2497 <summary>
2498 Gets the current working directory.
2499 </summary>
2500 <returns>
2501 A <see cref="T:System.String"/> containing the path of the current working
2502 directory.
2503 </returns>
2504 </member>
2505 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetParentDirectory(System.String)">
2506 <summary>
2507 Retrieves the parent directory of the specified path.
2508 </summary>
2509 <param name="path">The path for which to retrieve the parent directory.</param>
2510 <returns>
2511 The parent directory, or an empty <see cref="T:System.String"/> if
2512 <paramref name="path"/> is the root directory, including the root
2513 of a UNC server or share name.
2514 </returns>
2515 <exception cref="T:System.IO.IOException">The directory specified by <paramref name="path"/> is read-only.</exception>
2516 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
2517 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2518 <exception cref="T:System.IO.DirectoryNotFoundException">The specified path was not found.</exception>
2519 <example>
2520 <para>
2521 Copy "readme.txt" from the current working directory to
2522 its parent directory.
2523 </para>
2524 <code>
2525 <![CDATA[
2526 <property name="current.dir" value="${directory::get-current-directory()}" />
2527 <property name="current.dir.parent" value="${directory::get-parent-directory(current.dir)}" />
2528 <copy file="${path::combine(current.dir, 'readme.txt')} todir="${current.dir.parent}" />
2529 ]]>
2530 </code>
2531 </example>
2532 </member>
2533 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetDirectoryRoot(System.String)">
2534 <summary>
2535 Returns the volume information, root information, or both for the
2536 specified path.
2537 </summary>
2538 <param name="path">The path for which to retrieve the parent directory.</param>
2539 <returns>
2540 A string containing the volume information, root information, or
2541 both for the specified path.
2542 </returns>
2543 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
2544 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2545 </member>
2546 <member name="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)">
2547 <summary>
2548 Determines whether the given path refers to an existing directory
2549 on disk.
2550 </summary>
2551 <param name="path">The path to test.</param>
2552 <returns>
2553 <see langword="true" /> if <paramref name="path" /> refers to an
2554 existing directory; otherwise, <see langword="false" />.
2555 </returns>
2556 <example>
2557 <para>Remove directory "test", if it exists.</para>
2558 <code>
2559 <![CDATA[
2560 <delete dir="test" if="${directory::exists('test')}" />
2561 ]]>
2562 </code>
2563 </example>
2564 </member>
2565 <member name="T:NAnt.Core.Functions.DnsFunctions">
2566 <summary>
2567 Functions for requesting information from DNS.
2568 </summary>
2569 </member>
2570 <member name="M:NAnt.Core.Functions.DnsFunctions.GetHostName">
2571 <summary>
2572 Gets the host name of the local computer.
2573 </summary>
2574 <returns>
2575 A string that contains the DNS host name of the local computer.
2576 </returns>
2577 <exception cref="T:System.Net.Sockets.SocketException">An error is encountered when resolving the local host name.</exception>
2578 </member>
2579 <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.Parse(System.String)">
2580 <summary>
2581 Converts the specified string representation of a number to its
2582 double-precision floating point number equivalent.
2583 </summary>
2584 <param name="s">A string containing a number to convert.</param>
2585 <returns>
2586 A double-precision floating point number equivalent to the numeric
2587 value or symbol specified in <paramref name="s"/>.
2588 </returns>
2589 <exception cref="T:System.FormatException"><paramref name="s"/> is not a number in a valid format.</exception>
2590 <exception cref="T:System.OverflowException"><paramref name="s"/> represents a number less than <see cref="F:System.Double.MinValue"/> or greater than <see cref="F:System.Double.MaxValue"/>.</exception>
2591 <remarks>
2592 The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
2593 used to supply formatting information about <paramref name="s"/>.
2594 </remarks>
2595 </member>
2596 <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.ToString(System.Double)">
2597 <summary>
2598 Converts the specified <see cref="T:System.Double"/> to its equivalent
2599 string representation.
2600 </summary>
2601 <param name="value">A <see cref="T:System.Double"/> to convert.</param>
2602 <returns>
2603 The string representation of <paramref name="value"/> formatted
2604 using the general format specifier ("G").
2605 </returns>
2606 <remarks>
2607 <paramref name="value"/> is formatted with the
2608 <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
2609 </remarks>
2610 </member>
2611 <member name="T:NAnt.Core.Functions.EnvironmentFunctions">
2612 <summary>
2613 Provide information about the current environment and platform.
2614 </summary>
2615 </member>
2616 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)">
2617 <summary>
2618 Gets the path to the system special folder identified by the
2619 specified enumeration.
2620 </summary>
2621 <param name="folder">An enumerated constant that identifies a system special folder.</param>
2622 <returns>
2623 The path to the specified system special folder, if that folder
2624 physically exists on your computer; otherwise, the empty string ("").
2625 </returns>
2626 <exception cref="T:System.ArgumentException"><paramref name="folder"/> is not a member of <see cref="T:System.Environment.SpecialFolder"/>.</exception>
2627 <example>
2628 <para>
2629 Copy "out.log" from the project base directory to the
2630 program files directory.
2631 </para>
2632 <code>
2633 <![CDATA[
2634 <copy file="out.log" todir="${environment::get-folder-path('ProgramFiles')}" />
2635 ]]>
2636 </code>
2637 </example>
2638 </member>
2639 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetMachineName">
2640 <summary>
2641 Gets the NetBIOS name of this local computer.
2642 </summary>
2643 <returns>
2644 The NetBIOS name of this local computer.
2645 </returns>
2646 <exception cref="T:System.InvalidOperationException">The name of this computer cannot be obtained.</exception>
2647 </member>
2648 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem">
2649 <summary>
2650 Gets an <see cref="T:System.OperatingSystem"/> object that represents the
2651 current operating system.
2652 </summary>
2653 <returns>
2654 An <see cref="T:System.OperatingSystem"/> object that contains the current
2655 platform identifier and version number.
2656 </returns>
2657 <example>
2658 <para>
2659 Output string representation of the current operating system.
2660 </para>
2661 <code>
2662 <![CDATA[
2663 <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" />
2664 ]]>
2665 </code>
2666 <para>If the operating system is Windows 2000, the output is:</para>
2667 <code>
2668 Microsoft Windows NT 5.0.2195.0
2669 </code>
2670 </example>
2671 <seealso cref="T:NAnt.Core.Functions.OperatingSystemFunctions"/>
2672 </member>
2673 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetUserName">
2674 <summary>
2675 Gets the user name of the person who started the current thread.
2676 </summary>
2677 <returns>
2678 The name of the person logged on to the system who started the
2679 current thread.
2680 </returns>
2681 <example>
2682 <para>
2683 Modify the home directory of the current user on unix-based systems.
2684 </para>
2685 <code>
2686 <![CDATA[
2687 <exec program="usermod">
2688 <arg value="-d" />
2689 <arg value="/home/temp" />
2690 <arg value="${environment::get-user-name()}" />
2691 </exec>
2692 ]]>
2693 </code>
2694 </example>
2695 </member>
2696 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)">
2697 <summary>
2698 Returns the value of the specified environment variable.
2699 </summary>
2700 <param name="name">The environment variable of which the value should be returned.</param>
2701 <returns>
2702 The value of the specified environment variable.
2703 </returns>
2704 <exception cref="T:System.ArgumentException">Environment variable <paramref name="name"/> does not exist.</exception>
2705 </member>
2706 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.VariableExists(System.String)">
2707 <summary>
2708 Gets a value indicating whether the specified environment variable
2709 exists.
2710 </summary>
2711 <param name="name">The environment variable that should be checked.</param>
2712 <returns>
2713 <see langword="true" /> if the environment variable exists; otherwise,
2714 <see langword="false" />.
2715 </returns>
2716 <example>
2717 <para>
2718 Execute a set of tasks only if the "BUILD_DEBUG" environment
2719 variable is set.
2720 </para>
2721 <code>
2722 <![CDATA[
2723 <if test="${environment::variable-exists('BUILD_DEBUG')}">
2724 ...
2725 </if>
2726 ]]>
2727 </code>
2728 </example>
2729 </member>
2730 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion">
2731 <summary>
2732 Gets a <see cref="T:System.Version"/> object that describes the major,
2733 minor, build, and revision numbers of the Common Language Runtime.
2734 </summary>
2735 <returns>
2736 A Version object.
2737 </returns>
2738 <example>
2739 <para>Output the major version of the CLR.</para>
2740 <code>
2741 <![CDATA[
2742 <echo message="Major version=${version::get-major(environment::get-version())}" />
2743 ]]>
2744 </code>
2745 </example>
2746 </member>
2747 <member name="T:NAnt.Core.Functions.FileFunctions">
2748 <summary>
2749 Groups a set of functions for dealing with files.
2750 </summary>
2751 </member>
2752 <member name="M:NAnt.Core.Functions.FileFunctions.GetCreationTime(System.String)">
2753 <summary>
2754 Returns the creation date and time of the specified file.
2755 </summary>
2756 <param name="path">The file for which to obtain creation date and time information.</param>
2757 <returns>
2758 The creation date and time of the specified file.
2759 </returns>
2760 <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
2761 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
2762 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2763 <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
2764 </member>
2765 <member name="M:NAnt.Core.Functions.FileFunctions.GetLastWriteTime(System.String)">
2766 <summary>
2767 Returns the date and time the specified file was last written to.
2768 </summary>
2769 <param name="path">The file for which to obtain write date and time information.</param>
2770 <returns>
2771 The date and time the specified file was last written to.
2772 </returns>
2773 <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
2774 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
2775 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2776 </member>
2777 <member name="M:NAnt.Core.Functions.FileFunctions.GetLastAccessTime(System.String)">
2778 <summary>
2779 Returns the date and time the specified file was last accessed.
2780 </summary>
2781 <param name="path">The file for which to obtain access date and time information.</param>
2782 <returns>
2783 The date and time the specified file was last accessed.
2784 </returns>
2785 <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
2786 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
2787 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2788 <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
2789 </member>
2790 <member name="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)">
2791 <summary>
2792 Determines whether the specified file exists.
2793 </summary>
2794 <param name="file">The file to check.</param>
2795 <returns>
2796 <see langword="true" /> if <paramref name="file" /> refers to an
2797 existing file; otherwise, <see langword="false" />.
2798 </returns>
2799 <example>
2800 <para>Execute a set of tasks, if file "output.xml" does not exist.</para>
2801 <code>
2802 <![CDATA[
2803 <if test="${not file::exists('output.xml')}">
2804 ...
2805 </if>
2806 ]]>
2807 </code>
2808 </example>
2809 </member>
2810 <member name="M:NAnt.Core.Functions.FileFunctions.UpToDate(System.String,System.String)">
2811 <summary>
2812 Determines whether <paramref name="targetFile"/> is more or equal
2813 up-to-date than <paramref name="srcFile"/>.
2814 </summary>
2815 <param name="srcFile">The file to check against the target file.</param>
2816 <param name="targetFile">The file for which we want to determine the status.</param>
2817 <returns>
2818 <see langword="true"/> if <paramref name="targetFile"/> is more
2819 or equal up-to-date than <paramref name="srcFile"/>; otherwise,
2820 <see langword="false"/>.
2821 </returns>
2822 <exception cref="T:System.ArgumentException"><paramref name="srcFile"/> or <paramref name="targetFile"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
2823 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both of either <paramref name="srcFile"/> or <paramref name="targetFile"/> exceed the system-defined maximum length.</exception>
2824 </member>
2825 <member name="M:NAnt.Core.Functions.FileFunctions.GetLength(System.String)">
2826 <summary>
2827 Gets the length of the file.
2828 </summary>
2829 <param name="file">filename</param>
2830 <returns>
2831 Length in bytes, of the file named <paramref name="file"/>.
2832 </returns>
2833 <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception>
2834 </member>
2835 <member name="M:NAnt.Core.Functions.FileFunctions.IsAssembly(System.String)">
2836 <summary>
2837 Checks if a given file is an assembly.
2838 </summary>
2839 <param name="assemblyFile">The name or path of the file to be checked.</param>
2840 <returns>True if the file is a valid assembly, false if it's not or if the assembly seems corrupted (invalid headers or metadata).</returns>
2841 <exception cref="T:System.ArgumentNullException"><paramref name="assemblyFile"/> is a null <see cref="T:System.String"/>.</exception>
2842 <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
2843 <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> is not found, or the file you are trying to check does not specify a filename extension.</exception>
2844 <exception cref="T:System.Security.SecurityException">The caller does not have path discovery permission.</exception>
2845 </member>
2846 <member name="T:NAnt.Core.Functions.FileVersionInfoFunctions">
2847 <summary>
2848 Functions that provide version information for a physical file on disk.
2849 </summary>
2850 </member>
2851 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetVersionInfo(System.String)">
2852 <summary>
2853 Returns a <see cref="T:System.Diagnostics.FileVersionInfo"/> representing the version
2854 information associated with the specified file.
2855 </summary>
2856 <param name="fileName">The file to retrieve the version information for.</param>
2857 <returns>
2858 A <see cref="T:System.Diagnostics.FileVersionInfo"/> containing information about the file.
2859 </returns>
2860 <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception>
2861 </member>
2862 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetCompanyName(System.Diagnostics.FileVersionInfo)">
2863 <summary>
2864 Gets the name of the company that produced the file.
2865 </summary>
2866 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
2867 <returns>
2868 The name of the company that produced the file.
2869 </returns>
2870 </member>
2871 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetFileVersion(System.Diagnostics.FileVersionInfo)">
2872 <summary>
2873 Gets the file version of a file.
2874 </summary>
2875 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
2876 <returns>
2877 The file version of a file.
2878 </returns>
2879 <see cref="T:NAnt.Core.Functions.VersionFunctions"/>
2880 </member>
2881 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductName(System.Diagnostics.FileVersionInfo)">
2882 <summary>
2883 Gets the name of the product the file is distributed with.
2884 </summary>
2885 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
2886 <returns>
2887 The name of the product the file is distributed with.
2888 </returns>
2889 </member>
2890 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductVersion(System.Diagnostics.FileVersionInfo)">
2891 <summary>
2892 Gets the product version of a file.
2893 </summary>
2894 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
2895 <returns>
2896 The product version of a file.
2897 </returns>
2898 <see cref="T:NAnt.Core.Functions.VersionFunctions"/>
2899 </member>
2900 <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.Parse(System.String)">
2901 <summary>
2902 Converts the specified string representation of a number to its
2903 32-bit signed integer equivalent.
2904 </summary>
2905 <param name="s">A string containing a number to convert.</param>
2906 <returns>
2907 A 32-bit signed integer equivalent to the number contained in
2908 <paramref name="s"/>.
2909 </returns>
2910 <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception>
2911 <exception cref="T:System.OverflowException"><paramref name="s"/> represents a number less than <see cref="F:System.Int32.MinValue"/> or greater than <see cref="F:System.Int32.MaxValue"/>.</exception>
2912 <remarks>
2913 The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
2914 used to supply formatting information about <paramref name="s"/>.
2915 </remarks>
2916 </member>
2917 <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.ToString(System.Int32)">
2918 <summary>
2919 Converts the specified <see cref="T:System.Int32"/> to its equivalent string
2920 representation.
2921 </summary>
2922 <param name="value">A <see cref="T:System.Int32"/> to convert.</param>
2923 <returns>
2924 The string representation of <paramref name="value"/>, consisting
2925 of a negative sign if the value is negative, and a sequence of
2926 digits ranging from 0 to 9 with no leading zeroes.
2927 </returns>
2928 <remarks>
2929 <paramref name="value"/> is formatted with the
2930 <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
2931 </remarks>
2932 </member>
2933 <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.Parse(System.String)">
2934 <summary>
2935 Converts the specified string representation of a number to its
2936 64-bit signed integer equivalent.
2937 </summary>
2938 <param name="s">A string containing a number to convert.</param>
2939 <returns>
2940 A 64-bit signed integer equivalent to the number contained in
2941 <paramref name="s"/>.
2942 </returns>
2943 <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception>
2944 <exception cref="T:System.OverflowException"><paramref name="s"/> represents a number less than <see cref="F:System.Int64.MinValue"/> or greater than <see cref="F:System.Int64.MaxValue"/>.</exception>
2945 <remarks>
2946 The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
2947 used to supply formatting information about <paramref name="s"/>.
2948 </remarks>
2949 </member>
2950 <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.ToString(System.Int64)">
2951 <summary>
2952 Converts the specified <see cref="T:System.Int64"/> to its equivalent string
2953 representation.
2954 </summary>
2955 <param name="value">A <see cref="T:System.Int64"/> to convert.</param>
2956 <returns>
2957 The string representation of <paramref name="value"/>, consisting
2958 of a negative sign if the value is negative, and a sequence of
2959 digits ranging from 0 to 9 with no leading zeroes.
2960 </returns>
2961 <remarks>
2962 <paramref name="value"/> is formatted with the
2963 <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
2964 </remarks>
2965 </member>
2966 <member name="M:NAnt.Core.Functions.MathFunctions.Round(System.Double)">
2967 <summary>
2968 Rounds the value to the nearest whole number
2969 </summary>
2970 <param name="value">Number to be rounded, can be anything convertible to a double.</param>
2971 <returns>
2972 Rounded value.
2973 </returns>
2974 </member>
2975 <member name="M:NAnt.Core.Functions.MathFunctions.Floor(System.Double)">
2976 <summary>
2977 Returns the largest whole number less than or equal to the specified
2978 number.
2979 </summary>
2980 <param name="value">value to be , can be anything convertible to a double</param>
2981 <returns>
2982 The largest whole number less than or equal to the specified number.
2983 </returns>
2984 </member>
2985 <member name="M:NAnt.Core.Functions.MathFunctions.Ceiling(System.Double)">
2986 <summary>
2987 Returns the smallest whole number greater than or equal to the specified number
2988 </summary>
2989 <param name="value">value</param>
2990 <returns>
2991 The smallest whole number greater than or equal to the specified number.
2992 </returns>
2993 </member>
2994 <member name="M:NAnt.Core.Functions.MathFunctions.Abs(System.Double)">
2995 <summary>
2996 Returns the absolute value of the specified number
2997 </summary>
2998 <param name="value">value to take the absolute value from</param>
2999 <returns>
3000 <paramref name="value" /> when <paramref name="value" /> is greater
3001 than or equal to zero; otherwise, -<paramref name="value" />.
3002 </returns>
3003 </member>
3004 <member name="M:NAnt.Core.Functions.NAntFunctions.GetBaseDirectory">
3005 <summary>
3006 Gets the base directory of the appdomain in which NAnt is running.
3007 </summary>
3008 <returns>
3009 The base directory of the appdomain in which NAnt is running.
3010 </returns>
3011 </member>
3012 <member name="M:NAnt.Core.Functions.NAntFunctions.GetAssembly">
3013 <summary>
3014 Gets the NAnt assembly.
3015 </summary>
3016 <returns>
3017 The NAnt assembly.
3018 </returns>
3019 </member>
3020 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetName">
3021 <summary>
3022 Gets the name of the current project.
3023 </summary>
3024 <returns>
3025 The name of the current project, or an empty <see cref="T:System.String"/>
3026 if no name is specified in the build file.
3027 </returns>
3028 </member>
3029 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFileUri">
3030 <summary>
3031 Gets the <see cref="T:System.Uri"/> form of the build file.
3032 </summary>
3033 <returns>
3034 The <see cref="T:System.Uri"/> form of the build file, or
3035 an empty <see cref="T:System.String"/> if the project is not file backed.
3036 </returns>
3037 </member>
3038 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFilePath">
3039 <summary>
3040 Gets the local path to the build file.
3041 </summary>
3042 <returns>
3043 The local path of the build file, or an empty <see cref="T:System.String"/>
3044 if the project is not file backed.
3045 </returns>
3046 </member>
3047 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetDefaultTarget">
3048 <summary>
3049 Gets the name of the target that will be executed when no other
3050 build targets are specified.
3051 </summary>
3052 <returns>
3053 The name of the target that will be executed when no other build
3054 targets are specified, or an empty <see cref="T:System.String"/> if no
3055 default target is defined for the project.
3056 </returns>
3057 </member>
3058 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBaseDirectory">
3059 <summary>
3060 Gets the base directory of the current project.
3061 </summary>
3062 <returns>
3063 The base directory of the current project.
3064 </returns>
3065 </member>
3066 <member name="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)">
3067 <summary>
3068 Checks whether the specified target exists.
3069 </summary>
3070 <param name="name">The target to test.</param>
3071 <returns>
3072 <see langword="true" /> if the specified target exists; otherwise,
3073 <see langword="false" />.
3074 </returns>
3075 <example>
3076 <para>
3077 Execute target "clean", if it exists.
3078 </para>
3079 <code>
3080 <![CDATA[
3081 <if test="${target::exists('clean')}">
3082 <call target="clean" />
3083 </if>
3084 ]]>
3085 </code>
3086 </example>
3087 </member>
3088 <member name="M:NAnt.Core.Functions.TargetFunctions.GetCurrentTarget">
3089 <summary>
3090 Gets the name of the target being executed.
3091 </summary>
3092 <returns>
3093 A <see cref="T:System.String"/> that contains the name of the target
3094 being executed.
3095 </returns>
3096 <exception cref="T:System.InvalidOperationException">No target is being executed.</exception>
3097 </member>
3098 <member name="M:NAnt.Core.Functions.TargetFunctions.HasExecuted(System.String)">
3099 <summary>
3100 Checks whether the specified target has already been executed.
3101 </summary>
3102 <param name="name">The target to test.</param>
3103 <returns>
3104 <see langword="true"/> if the specified target has already been
3105 executed; otherwise, <see langword="false"/>.
3106 </returns>
3107 <exception cref="T:System.ArgumentException">Target <paramref name="name"/> does not exist.</exception>
3108 </member>
3109 <member name="M:NAnt.Core.Functions.TaskFunctions.Exists(System.String)">
3110 <summary>
3111 Checks whether the specified task exists.
3112 </summary>
3113 <param name="name">The task to test.</param>
3114 <returns>
3115 <see langword="true" /> if the specified task exists; otherwise,
3116 <see langword="false" />.
3117 </returns>
3118 </member>
3119 <member name="M:NAnt.Core.Functions.TaskFunctions.GetAssembly(System.String)">
3120 <summary>
3121 Returns the <see cref="T:System.Reflection.Assembly"/> from which the specified task
3122 was loaded.
3123 </summary>
3124 <param name="name">The name of the task to get the <see cref="T:System.Reflection.Assembly"/> of.</param>
3125 <returns>
3126 The <see cref="T:System.Reflection.Assembly"/> from which the specified task was loaded.
3127 </returns>
3128 <exception cref="T:System.ArgumentException">Task <paramref name="name"/> is not available.</exception>
3129 </member>
3130 <member name="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)">
3131 <summary>
3132 Checks whether the specified property exists.
3133 </summary>
3134 <param name="name">The property to test.</param>
3135 <returns>
3136 <see langword="true" /> if the specified property exists; otherwise,
3137 <see langword="false" />.
3138 </returns>
3139 <example>
3140 <para>
3141 Execute a set of tasks if the "build.debug" property
3142 exists.
3143 </para>
3144 <code>
3145 <![CDATA[
3146 <if test="${property::exists('build.debug')}">
3147 <echo message="Starting debug build" />
3148 <call target="init-debug" />
3149 <call target="build" />
3150 </if>
3151 ]]>
3152 </code>
3153 </example>
3154 </member>
3155 <member name="M:NAnt.Core.Functions.PropertyFunctions.IsReadOnly(System.String)">
3156 <summary>
3157 Checks whether the specified property is read-only.
3158 </summary>
3159 <param name="name">The property to test.</param>
3160 <returns>
3161 <see langword="true"/> if the specified property is read-only;
3162 otherwise, <see langword="false"/>.
3163 </returns>
3164 <example>
3165 <para>Check whether the "debug" property is read-only.</para>
3166 <code>property::is-readonly('debug')</code>
3167 </example>
3168 <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception>
3169 </member>
3170 <member name="M:NAnt.Core.Functions.PropertyFunctions.IsDynamic(System.String)">
3171 <summary>
3172 Checks whether the specified property is a dynamic property.
3173 </summary>
3174 <param name="name">The property to test.</param>
3175 <returns>
3176 <see langword="true"/> if the specified property is a dynamic
3177 property; otherwise, <see langword="false"/>.
3178 </returns>
3179 <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception>
3180 <example>
3181 <para>
3182 Check whether the "debug" property is a dynamic property.
3183 </para>
3184 <code>property::is-dynamic('debug')</code>
3185 </example>
3186 </member>
3187 <member name="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)">
3188 <summary>
3189 Checks whether the specified framework exists, and is valid.
3190 </summary>
3191 <param name="framework">The framework to test.</param>
3192 <returns>
3193 <see langword="true" /> if the specified framework exists ; otherwise,
3194 <see langword="false" />.
3195 </returns>
3196 </member>
3197 <member name="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)">
3198 <summary>
3199 Checks whether the SDK for the specified framework is installed.
3200 </summary>
3201 <param name="framework">The framework to test.</param>
3202 <returns>
3203 <see langword="true"/> if the SDK for specified framework is installed;
3204 otherwise, <see langword="false"/>.
3205 </returns>
3206 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3207 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3208 </member>
3209 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework">
3210 <summary>
3211 Gets the identifier of the current target framework.
3212 </summary>
3213 <returns>
3214 The identifier of the current target framework.
3215 </returns>
3216 </member>
3217 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework">
3218 <summary>
3219 Gets the identifier of the runtime framework.
3220 </summary>
3221 <returns>
3222 The identifier of the runtime framework.
3223 </returns>
3224 </member>
3225 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFamily(System.String)">
3226 <summary>
3227 Gets the family of the specified framework.
3228 </summary>
3229 <param name="framework">The framework of which the family should be returned.</param>
3230 <returns>
3231 The family of the specified framework.
3232 </returns>
3233 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3234 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3235 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3236 </member>
3237 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetVersion(System.String)">
3238 <summary>
3239 Gets the version of the specified framework.
3240 </summary>
3241 <param name="framework">The framework of which the version should be returned.</param>
3242 <returns>
3243 The version of the specified framework.
3244 </returns>
3245 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3246 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3247 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3248 </member>
3249 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetDescription(System.String)">
3250 <summary>
3251 Gets the description of the specified framework.
3252 </summary>
3253 <param name="framework">The framework of which the description should be returned.</param>
3254 <returns>
3255 The description of the specified framework.
3256 </returns>
3257 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3258 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3259 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3260 </member>
3261 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetClrVersion(System.String)">
3262 <summary>
3263 Gets the Common Language Runtime version of the specified framework.
3264 </summary>
3265 <param name="framework">The framework of which the Common Language Runtime version should be returned.</param>
3266 <returns>
3267 The Common Language Runtime version of the specified framework.
3268 </returns>
3269 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3270 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3271 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3272 </member>
3273 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFrameworkDirectory(System.String)">
3274 <summary>
3275 Gets the framework directory of the specified framework.
3276 </summary>
3277 <param name="framework">The framework of which the framework directory should be returned.</param>
3278 <returns>
3279 The framework directory of the specified framework.
3280 </returns>
3281 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3282 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3283 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3284 </member>
3285 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetAssemblyDirectory(System.String)">
3286 <summary>
3287 Gets the assembly directory of the specified framework.
3288 </summary>
3289 <param name="framework">The framework of which the assembly directory should be returned.</param>
3290 <returns>
3291 The assembly directory of the specified framework.
3292 </returns>
3293 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3294 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3295 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3296 </member>
3297 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetSdkDirectory(System.String)">
3298 <summary>
3299 Gets the SDK directory of the specified framework.
3300 </summary>
3301 <param name="framework">The framework of which the SDK directory should be returned.</param>
3302 <returns>
3303 The SDK directory of the specified framework, or an empty
3304 <see cref="T:System.String"/> if the SDK of the specified framework is not
3305 installed.
3306 </returns>
3307 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3308 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3309 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3310 </member>
3311 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetToolPath(System.String)">
3312 <summary>
3313 Gets the absolute path of the specified tool for the current
3314 target framework.
3315 </summary>
3316 <param name="tool">The file name of the tool to search for.</param>
3317 <returns>
3318 The absolute path to <paramref name="tool"/> if found in one of the
3319 configured tool paths; otherwise, an error is reported.
3320 </returns>
3321 <exception cref="T:System.IO.FileNotFoundException"><paramref name="tool"/> could not be found in the configured tool paths.</exception>
3322 <remarks>
3323 <para>
3324 The configured tool paths are scanned in the order in which they
3325 are defined in the framework configuration.
3326 </para>
3327 <para>
3328 The file name of the tool to search should include the extension.
3329 </para>
3330 </remarks>
3331 <example>
3332 <para>Use <b>gacutil</b> to install an assembly in the GAC.</para>
3333 <code>
3334 <![CDATA[
3335 <exec program="${framework::get-tool-path('gacutil.exe')}" managed="strict">
3336 <arg value="/i" />
3337 <arg file="Cegeka.HealthFramework.dll" />
3338 </exec>
3339 ]]>
3340 </code>
3341 </example>
3342 </member>
3343 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeEngine(System.String)">
3344 <summary>
3345 Gets the runtime engine of the specified framework.
3346 </summary>
3347 <param name="framework">The framework of which the runtime engine should be returned.</param>
3348 <returns>
3349 The full path to the runtime engine of the specified framework, or
3350 an empty <see cref="T:System.String"/> if no runtime engine is defined
3351 for the specified framework.
3352 </returns>
3353 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3354 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3355 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3356 </member>
3357 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFramework(System.String)">
3358 <summary>
3359 Checks whether the specified framework is valid.
3360 </summary>
3361 <param name="framework">The framework to check.</param>
3362 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3363 </member>
3364 <member name="M:NAnt.Core.Functions.PlatformFunctions.GetName">
3365 <summary>
3366 Gets the name of the platform on which NAnt is running.
3367 </summary>
3368 <returns>
3369 The name of the platform on which NAnt is running.
3370 </returns>
3371 </member>
3372 <member name="M:NAnt.Core.Functions.PlatformFunctions.IsWin32">
3373 <summary>
3374 Checks whether NAnt is running on the win32 platform.
3375 </summary>
3376 <returns>
3377 <see langword="true" /> if NAnt is running on the win32 platform;
3378 otherwise, <see langword="false" />.
3379 </returns>
3380 </member>
3381 <member name="M:NAnt.Core.Functions.PlatformFunctions.IsUnix">
3382 <summary>
3383 Checks whether NAnt is running on unix.
3384 </summary>
3385 <returns>
3386 <see langword="true" /> if NAnt is running on unix;
3387 otherwise, <see langword="false" />.
3388 </returns>
3389 </member>
3390 <member name="T:NAnt.Core.Functions.OperatingSystemFunctions">
3391 <summary>
3392 Functions that return information about an operating system.
3393 </summary>
3394 </member>
3395 <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetPlatform(System.OperatingSystem)">
3396 <summary>
3397 Gets a <see cref="T:System.PlatformID"/> value that identifies the operating
3398 system platform.
3399 </summary>
3400 <param name="operatingSystem">The operating system.</param>
3401 <returns>
3402 <see cref="T:System.PlatformID"/> value that identifies the operating system
3403 platform.
3404 </returns>
3405 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
3406 </member>
3407 <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)">
3408 <summary>
3409 Gets a <see cref="T:System.Version"/> object that identifies this operating
3410 system.
3411 </summary>
3412 <param name="operatingSystem">The operating system.</param>
3413 <returns>
3414 A <see cref="T:System.Version"/> object that describes the major version,
3415 minor version, build, and revision of the operating system.
3416 </returns>
3417 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
3418 </member>
3419 <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.ToString(System.OperatingSystem)">
3420 <summary>
3421 Converts the value of the specified operating system to its equivalent
3422 <see cref="T:System.String"/> representation.
3423 </summary>
3424 <param name="operatingSystem">The operating system.</param>
3425 <returns>
3426 The <see cref="T:System.String"/> representation of
3427 <paramref name="operatingSystem"/>.
3428 </returns>
3429 <example>
3430 <para>
3431 Output string representation of the current operating system.
3432 </para>
3433 <code>
3434 <![CDATA[
3435 <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" />
3436 ]]>
3437 </code>
3438 <para>If the operating system is Windows 2000, the output is:</para>
3439 <code>
3440 Microsoft Windows NT 5.0.2195.0
3441 </code>
3442 </example>
3443 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
3444 </member>
3445 <member name="M:NAnt.Core.Functions.PathFunctions.GetFullPath(System.String)">
3446 <summary>
3447 Returns the fully qualified path.
3448 </summary>
3449 <param name="path">The file or directory for which to obtain absolute path information.</param>
3450 <returns>
3451 A string containing the fully qualified location of <paramref name="path"/>,
3452 such as "C:\MyFile.txt".
3453 </returns>
3454 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
3455 <exception cref="T:System.NotSupportedException"><paramref name="path"/> contains a colon (":").</exception>
3456 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
3457 </member>
3458 <member name="M:NAnt.Core.Functions.PathFunctions.Combine(System.String,System.String)">
3459 <summary>
3460 Combines two paths.
3461 </summary>
3462 <param name="path1">first path</param>
3463 <param name="path2">second path</param>
3464 <returns>
3465 A string containing the combined paths. If one of the specified paths
3466 is a zero-length string, this method returns the other path. If
3467 <paramref name="path2"/> contains an absolute path, this method
3468 returns <paramref name="path2"/>.
3469 </returns>
3470 <exception cref="T:System.ArgumentException"><paramref name="path1"/> or <paramref name="path2"/> contain one or more invalid characters.</exception>
3471 </member>
3472 <member name="M:NAnt.Core.Functions.PathFunctions.ChangeExtension(System.String,System.String)">
3473 <summary>
3474 Changes the extension of the path string.
3475 </summary>
3476 <param name="path">The path information to modify. The path cannot contain any of the characters
3477 defined in <see cref="F:System.IO.Path.InvalidPathChars"/>InvalidPathChars.</param>
3478 <param name="extension">The new extension (with a leading period). Specify a null reference
3479 to remove an existing extension from <paramref name="path"/>.</param>
3480 <returns>
3481 <para>
3482 A string containing the modified path information.
3483 </para>
3484 <para>
3485 On Windows-based desktop platforms, if <paramref name="path"/> is
3486 an empty <see cref="T:System.String"/>, the path information is returned
3487 unmodified. If <paramref name="path"/> has no extension, the returned
3488 path <see cref="T:System.String"/> contains <paramref name="extension"/>
3489 appended to the end of <paramref name="path"/>.
3490 </para>
3491 </returns>
3492 <remarks>
3493 For more information see the <see cref="T:System.IO.Path"/> documentation.
3494 </remarks>
3495 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3496 </member>
3497 <member name="M:NAnt.Core.Functions.PathFunctions.GetDirectoryName(System.String)">
3498 <summary>
3499 Returns the directory information for the specified path string.
3500 </summary>
3501 <param name="path">The path of a file or directory.</param>
3502 <returns>
3503 A <see cref="T:System.String"/> containing directory information for
3504 <paramref name="path"/>, or an empty <see cref="T:System.String"/> if
3505 <paramref name="path"/> denotes a root directory, or does not
3506 contain directory information.
3507 </returns>
3508 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, is empty, or contains only white spaces.</exception>
3509 </member>
3510 <member name="M:NAnt.Core.Functions.PathFunctions.GetExtension(System.String)">
3511 <summary>
3512 Returns the extension for the specified path string.
3513 </summary>
3514 <param name="path">The path string from which to get the extension.</param>
3515 <returns>
3516 A <see cref="T:System.String"/> containing the extension of the specified
3517 <paramref name="path"/> (including the "."), or an empty
3518 <see cref="T:System.String"/> if <paramref name="path"/> does not have
3519 extension information.
3520 </returns>
3521 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3522 </member>
3523 <member name="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)">
3524 <summary>
3525 Returns the filename for the specified path string.
3526 </summary>
3527 <param name="path">The path string from which to obtain the file name and extension.</param>
3528 <returns>
3529 <para>
3530 A <see cref="T:System.String"/> consisting of the characters after the last
3531 directory character in path.
3532 </para>
3533 <para>
3534 If the last character of <paramref name="path"/> is a directory or
3535 volume separator character, an empty <see cref="T:System.String"/> is returned.
3536 </para>
3537 </returns>
3538 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3539 </member>
3540 <member name="M:NAnt.Core.Functions.PathFunctions.GetFileNameWithoutExtension(System.String)">
3541 <summary>
3542 Returns the filename without extension for the specified path string.
3543 </summary>
3544 <param name="path">The path of the file.</param>
3545 <returns>
3546 A <see cref="T:System.String"/> containing the <see cref="T:System.String"/> returned
3547 by <see cref="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)"/>, minus the last period (.) and all
3548 characters following it.
3549 </returns>
3550 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3551 </member>
3552 <member name="M:NAnt.Core.Functions.PathFunctions.GetPathRoot(System.String)">
3553 <summary>
3554 Gets the root directory of the specified path.
3555 </summary>
3556 <param name="path">The path from which to obtain root directory information.</param>
3557 <returns>
3558 A <see cref="T:System.String"/> containing the root directory of
3559 <paramref name="path"/>, such as "C:\", or an empty <see cref="T:System.String"/>
3560 if <paramref name="path"/> does not contain root directory information.
3561 </returns>
3562 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, or is empty.</exception>
3563 </member>
3564 <member name="M:NAnt.Core.Functions.PathFunctions.GetTempFileName">
3565 <summary>
3566 Returns a uniquely named zero-byte temporary file on disk and returns the full path to that file.
3567 </summary>
3568 <returns>
3569 A <see cref="T:System.String"/> containing the name of the temporary file.
3570 </returns>
3571 </member>
3572 <member name="M:NAnt.Core.Functions.PathFunctions.GetTempPath">
3573 <summary>
3574 Gets the path to the temporary directory.
3575 </summary>
3576 <returns>
3577 A <see cref="T:System.String"/> containing the path information of a
3578 temporary directory.
3579 </returns>
3580 </member>
3581 <member name="M:NAnt.Core.Functions.PathFunctions.HasExtension(System.String)">
3582 <summary>
3583 Determines whether a path string includes an extension.
3584 </summary>
3585 <param name="path">The path to search for an extension.</param>
3586 <returns>
3587 <see langword="true"/>. if the characters that follow the last
3588 directory separator or volume separator in the <paramref name="path"/>
3589 include a period (.) followed by one or more characters;
3590 otherwise, <see langword="false"/>.
3591 </returns>
3592 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3593 </member>
3594 <member name="M:NAnt.Core.Functions.PathFunctions.IsPathRooted(System.String)">
3595 <summary>
3596 Determines whether a path string is absolute.
3597 </summary>
3598 <param name="path">The path to test.</param>
3599 <returns>
3600 <see langword="true"/> if path contains an absolute <paramref name="path"/>;
3601 otherwise, <see langword="false"/>.
3602 </returns>
3603 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3604 </member>
3605 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetVariable(System.String,System.String)">
3606 <summary>
3607 Gets the value of a variable for the specified package.
3608 </summary>
3609 <param name="package">The package for which the variable should be retrieved.</param>
3610 <param name="name">The name of the variable.</param>
3611 <returns>
3612 The value of variable <paramref name="name"/> for the specified
3613 package.
3614 </returns>
3615 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3616 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
3617 </member>
3618 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetLinkFlags(System.String)">
3619 <summary>
3620 Gets the link flags required to compile the package, including all
3621 its dependencies.
3622 </summary>
3623 <param name="package">The package for which the link flags should be retrieved.</param>
3624 <returns>
3625 The link flags required to compile the package.
3626 </returns>
3627 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3628 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
3629 </member>
3630 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetCompileFlags(System.String)">
3631 <summary>
3632 Gets the compile flags required to compile the package, including all
3633 its dependencies.
3634 </summary>
3635 <param name="package">The package for which the compile flags should be retrieved.</param>
3636 <returns>
3637 The pre-processor and compile flags required to compile the package.
3638 </returns>
3639 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3640 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
3641 </member>
3642 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetModVersion(System.String)">
3643 <summary>
3644 Determines the version of the given package.
3645 </summary>
3646 <param name="package">The package to get the version of.</param>
3647 <returns>
3648 The version of the given package.
3649 </returns>
3650 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3651 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
3652 </member>
3653 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsAtLeastVersion(System.String,System.String)">
3654 <summary>
3655 Determines whether the given package is at least version
3656 <paramref name="version"/>.
3657 </summary>
3658 <param name="package">The package to check.</param>
3659 <param name="version">The version the package should at least have.</param>
3660 <returns>
3661 <see langword="true"/> if the given package is at least version
3662 <paramref name="version"/>; otherwise, <see langword="false"/>.
3663 </returns>
3664 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3665 </member>
3666 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsExactVersion(System.String,System.String)">
3667 <summary>
3668 Determines whether the given package is exactly version
3669 <paramref name="version"/>.
3670 </summary>
3671 <param name="package">The package to check.</param>
3672 <param name="version">The version the package should have.</param>
3673 <returns>
3674 <see langword="true"/> if the given package is exactly version
3675 <paramref name="version"/>; otherwise, <see langword="false"/>.
3676 </returns>
3677 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3678 </member>
3679 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsMaxVersion(System.String,System.String)">
3680 <summary>
3681 Determines whether the given package is at no newer than version
3682 <paramref name="version"/>.
3683 </summary>
3684 <param name="package">The package to check.</param>
3685 <param name="version">The version the package should maximum have.</param>
3686 <returns>
3687 <see langword="true"/> if the given package is at no newer than
3688 version <paramref name="version"/>; otherwise, <see langword="false"/>.
3689 </returns>
3690 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3691 </member>
3692 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsBetweenVersion(System.String,System.String,System.String)">
3693 <summary>
3694 Determines whether the given package is between two versions.
3695 </summary>
3696 <param name="package">The package to check.</param>
3697 <param name="minVersion">The version the package should at least have.</param>
3698 <param name="maxVersion">The version the package should maximum have.</param>
3699 <returns>
3700 <see langword="true"/> if the given package is between <paramref name="minVersion"/>
3701 and <paramref name="maxVersion"/>; otherwise, <see langword="false"/>.
3702 </returns>
3703 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3704 </member>
3705 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.Exists(System.String)">
3706 <summary>
3707 Determines whether the given package exists.
3708 </summary>
3709 <param name="package">The package to check.</param>
3710 <returns>
3711 <see langword="true"/> if the package exists; otherwise,
3712 <see langword="false"/>.
3713 </returns>
3714 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3715 </member>
3716 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigBool(NAnt.Core.Types.Argument[])">
3717 <summary>
3718 Runs pkg-config with the specified arguments and returns a
3719 <see cref="T:System.Boolean"/> based on the exit code.
3720 </summary>
3721 <param name="args">The arguments to pass to pkg-config.</param>
3722 <returns>
3723 <see langword="true"/> if pkg-config exited with exit code 0;
3724 otherwise, <see langword="false"/>
3725 </returns>
3726 </member>
3727 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigString(NAnt.Core.Types.Argument[])">
3728 <summary>
3729 Runs pkg-config with the specified arguments and returns the result
3730 as a <see cref="T:System.String"/>.
3731 </summary>
3732 <param name="args">The arguments to pass to pkg-config.</param>
3733 <returns>
3734 The result of running pkg-config with the specified arguments.
3735 </returns>
3736 </member>
3737 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetTask(System.IO.Stream)">
3738 <summary>
3739 Factory method to return a new instance of ExecTask
3740 </summary>
3741 <param name="stream"></param>
3742 <returns></returns>
3743 </member>
3744 <member name="M:NAnt.Core.Functions.StringFunctions.GetLength(System.String)">
3745 <summary>
3746 Returns the length of the specified string.
3747 </summary>
3748 <param name="s">input string</param>
3749 <returns>
3750 The string's length.
3751 </returns>
3752 <example>
3753 <code>string::get-length('foo') ==> 3</code>
3754 </example>
3755 <example>
3756 <code>string::get-length('') ==> 0</code>
3757 </example>
3758 </member>
3759 <member name="M:NAnt.Core.Functions.StringFunctions.Substring(System.String,System.Int32,System.Int32)">
3760 <summary>
3761 Returns a substring of the specified string.
3762 </summary>
3763 <param name="str">input string</param>
3764 <param name="startIndex">position of the start of the substring</param>
3765 <param name="length">the length of the substring</param>
3766 <returns>
3767 <para>
3768 If the <paramref name="length"/> is greater than zero, the
3769 function returns a substring starting at character position
3770 <paramref name="startIndex"/> with a length of <paramref name="length"/>
3771 characters.
3772 </para>
3773 <para>
3774 If the <paramref name="length"/> is equal to zero, the function
3775 returns an empty string.
3776 </para>
3777 </returns>
3778 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> or <paramref name="length"/> is less than zero.</exception>
3779 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> is greater than the length of <paramref name="str"/>.</exception>
3780 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> plus <paramref name="length"/> indicates a position not within <paramref name="str"/>.</exception>
3781 <example>
3782 <code>string::substring('testing string', 0, 4) ==> 'test'</code>
3783 </example>
3784 <example>
3785 <code>string::substring('testing string', 8, 3) ==> 'str'</code>
3786 </example>
3787 <example>
3788 <code>string::substring('testing string', 8, 0) ==> ''</code>
3789 </example>
3790 <example>
3791 <code>string::substring('testing string', -1, 5) ==> ERROR</code>
3792 </example>
3793 <example>
3794 <code>string::substring('testing string', 8, -1) ==> ERROR</code>
3795 </example>
3796 <example>
3797 <code>string::substring('testing string', 5, 17) ==> ERROR</code>
3798 </example>
3799 </member>
3800 <member name="M:NAnt.Core.Functions.StringFunctions.StartsWith(System.String,System.String)">
3801 <summary>
3802 Tests whether the specified string starts with the specified prefix
3803 string.
3804 </summary>
3805 <param name="s1">test string</param>
3806 <param name="s2">prefix string</param>
3807 <returns>
3808 <see langword="true" /> when <paramref name="s2" /> is a prefix for
3809 the string <paramref name="s1" />. Meaning, the characters at the
3810 beginning of <paramref name="s1" /> are identical to
3811 <paramref name="s2" />; otherwise, <see langword="false" />.
3812 </returns>
3813 <remarks>
3814 This function performs a case-sensitive word search using the
3815 invariant culture.
3816 </remarks>
3817 <example>
3818 <code>string::starts-with('testing string', 'test') ==> true</code>
3819 </example>
3820 <example>
3821 <code>string::starts-with('testing string', 'testing') ==> true</code>
3822 </example>
3823 <example>
3824 <code>string::starts-with('testing string', 'string') ==> false</code>
3825 </example>
3826 <example>
3827 <code>string::starts-with('test', 'testing string') ==> false</code>
3828 </example>
3829 </member>
3830 <member name="M:NAnt.Core.Functions.StringFunctions.EndsWith(System.String,System.String)">
3831 <summary>
3832 Tests whether the specified string ends with the specified suffix
3833 string.
3834 </summary>
3835 <param name="s1">test string</param>
3836 <param name="s2">suffix string</param>
3837 <returns>
3838 <see langword="true" /> when <paramref name="s2" /> is a suffix for
3839 the string <paramref name="s1" />. Meaning, the characters at the
3840 end of <paramref name="s1" /> are identical to
3841 <paramref name="s2" />; otherwise, <see langword="false" />.
3842 </returns>
3843 <remarks>
3844 This function performs a case-sensitive word search using the
3845 invariant culture.
3846 </remarks>
3847 <example>
3848 <code>string::ends-with('testing string', 'string') ==> true</code>
3849 </example>
3850 <example>
3851 <code>string::ends-with('testing string', '') ==> true</code>
3852 </example>
3853 <example>
3854 <code>string::ends-with('testing string', 'bring') ==> false</code>
3855 </example>
3856 <example>
3857 <code>string::ends-with('string', 'testing string') ==> false</code>
3858 </example>
3859 </member>
3860 <member name="M:NAnt.Core.Functions.StringFunctions.ToLower(System.String)">
3861 <summary>
3862 Returns the specified string converted to lowercase.
3863 </summary>
3864 <param name="s">input string</param>
3865 <returns>
3866 The string <paramref name="s" /> in lowercase.
3867 </returns>
3868 <remarks>
3869 The casing rules of the invariant culture are used to convert the
3870 <paramref name="s" /> to lowercase.
3871 </remarks>
3872 <example>
3873 <code>string::to-lower('testing string') ==> 'testing string'</code>
3874 </example>
3875 <example>
3876 <code>string::to-lower('Testing String') ==> 'testing string'</code>
3877 </example>
3878 <example>
3879 <code>string::to-lower('Test 123') ==> 'test 123'</code>
3880 </example>
3881 </member>
3882 <member name="M:NAnt.Core.Functions.StringFunctions.ToUpper(System.String)">
3883 <summary>
3884 Returns the specified string converted to uppercase.
3885 </summary>
3886 <param name="s">input string</param>
3887 <returns>
3888 The string <paramref name="s" /> in uppercase.
3889 </returns>
3890 <remarks>
3891 The casing rules of the invariant culture are used to convert the
3892 <paramref name="s" /> to uppercase.
3893 </remarks>
3894 <example>
3895 <code>string::to-upper('testing string') ==> 'TESTING STRING'</code>
3896 </example>
3897 <example>
3898 <code>string::to-upper('Testing String') ==> 'TESTING STRING'</code>
3899 </example>
3900 <example>
3901 <code>string::to-upper('Test 123') ==> 'TEST 123'</code>
3902 </example>
3903 </member>
3904 <member name="M:NAnt.Core.Functions.StringFunctions.Replace(System.String,System.String,System.String)">
3905 <summary>
3906 Returns a string corresponding to the replacement of a given string
3907 with another in the specified string.
3908 </summary>
3909 <param name="str">input string</param>
3910 <param name="oldValue">A <see cref="T:System.String"/> to be replaced.</param>
3911 <param name="newValue">A <see cref="T:System.String"/> to replace all occurrences of <paramref name="oldValue"/>.</param>
3912 <returns>
3913 A <see cref="T:System.String"/> equivalent to <paramref name="str"/> but
3914 with all instances of <paramref name="oldValue"/> replaced with
3915 <paramref name="newValue"/>.
3916 </returns>
3917 <exception cref="T:System.ArgumentException"><paramref name="oldValue"/> is an empty string.</exception>
3918 <remarks>
3919 This function performs a word (case-sensitive and culture-sensitive)
3920 search to find <paramref name="oldValue"/>.
3921 </remarks>
3922 <example>
3923 <code>string::replace('testing string', 'test', 'winn') ==> 'winning string'</code>
3924 </example>
3925 <example>
3926 <code>string::replace('testing string', 'foo', 'winn') ==> 'testing string'</code>
3927 </example>
3928 <example>
3929 <code>string::replace('testing string', 'ing', '') ==> 'test str'</code>
3930 </example>
3931 <example>
3932 <code>string::replace('banana', 'ana', 'ana') ==> 'banana'</code>
3933 </example>
3934 </member>
3935 <member name="M:NAnt.Core.Functions.StringFunctions.Contains(System.String,System.String)">
3936 <summary>
3937 Tests whether the specified string contains the given search string.
3938 </summary>
3939 <param name="source">The string to search.</param>
3940 <param name="value">The string to locate within <paramref name="source" />.</param>
3941 <returns>
3942 <see langword="true" /> if <paramref name="value" /> is found in
3943 <paramref name="source" />; otherwise, <see langword="false" />.
3944 </returns>
3945 <remarks>
3946 This function performs a case-sensitive word search using the
3947 invariant culture.
3948 </remarks>
3949 <example>
3950 <code>string::contains('testing string', 'test') ==> true</code>
3951 </example>
3952 <example>
3953 <code>string::contains('testing string', '') ==> true</code>
3954 </example>
3955 <example>
3956 <code>string::contains('testing string', 'Test') ==> false</code>
3957 </example>
3958 <example>
3959 <code>string::contains('testing string', 'foo') ==> false</code>
3960 </example>
3961 </member>
3962 <member name="M:NAnt.Core.Functions.StringFunctions.IndexOf(System.String,System.String)">
3963 <summary>
3964 Returns the position of the first occurrence in the specified string
3965 of the given search string.
3966 </summary>
3967 <param name="source">The string to search.</param>
3968 <param name="value">The string to locate within <paramref name="source" />.</param>
3969 <returns>
3970 <para>
3971 The lowest-index position of <paramref name="value" /> in
3972 <paramref name="source" /> if it is found, or -1 if <paramref name="source" />
3973 does not contain <paramref name="value" />.
3974 </para>
3975 <para>
3976 If <paramref name="value" /> is an empty string, the return value
3977 will always be <c>0</c>.
3978 </para>
3979 </returns>
3980 <remarks>
3981 This function performs a case-sensitive word search using the
3982 invariant culture.
3983 </remarks>
3984 <example>
3985 <code>string::index-of('testing string', 'test') ==> 0</code>
3986 </example>
3987 <example>
3988 <code>string::index-of('testing string', '') ==> 0</code>
3989 </example>
3990 <example>
3991 <code>string::index-of('testing string', 'Test') ==> -1</code>
3992 </example>
3993 <example>
3994 <code>string::index-of('testing string', 'ing') ==> 4</code>
3995 </example>
3996 </member>
3997 <member name="M:NAnt.Core.Functions.StringFunctions.LastIndexOf(System.String,System.String)">
3998 <summary>
3999 Returns the position of the last occurrence in the specified string
4000 of the given search string.
4001 </summary>
4002 <param name="source">The string to search.</param>
4003 <param name="value">The string to locate within <paramref name="source" />.</param>
4004 <returns>
4005 <para>
4006 The highest-index position of <paramref name="value" /> in
4007 <paramref name="source" /> if it is found, or -1 if <paramref name="source" />
4008 does not contain <paramref name="value" />.
4009 </para>
4010 <para>
4011 If <paramref name="value" /> is an empty string, the return value
4012 is the last index position in <paramref name="source" />.
4013 </para>
4014 </returns>
4015 <remarks>
4016 This function performs a case-sensitive word search using the
4017 invariant culture.
4018 </remarks>
4019 <example>
4020 <code>string::last-index-of('testing string', 'test') ==> 0</code>
4021 </example>
4022 <example>
4023 <code>string::last-index-of('testing string', '') ==> 13</code>
4024 </example>
4025 <example>
4026 <code>string::last-index-of('testing string', 'Test') ==> -1</code>
4027 </example>
4028 <example>
4029 <code>string::last-index-of('testing string', 'ing') ==> 11</code>
4030 </example>
4031 </member>
4032 <member name="M:NAnt.Core.Functions.StringFunctions.PadLeft(System.String,System.Int32,System.String)">
4033 <summary>
4034 Returns the given string left-padded to the given length.
4035 </summary>
4036 <param name="s">The <see cref="T:System.String"/> that needs to be left-padded.</param>
4037 <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param>
4038 <param name="paddingChar">A Unicode padding character.</param>
4039 <returns>
4040 If the length of <paramref name="s"/> is at least
4041 <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical
4042 to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/>
4043 will be padded on the left with as many <paramref name="paddingChar"/>
4044 characters as needed to create a length of <paramref name="totalWidth"/>.
4045 </returns>
4046 <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception>
4047 <remarks>
4048 Note that only the first character of <paramref name="paddingChar"/>
4049 will be used when padding the result.
4050 </remarks>
4051 <example>
4052 <code>string::pad-left('test', 10, ' ') ==> ' test'</code>
4053 </example>
4054 <example>
4055 <code>string::pad-left('test', 10, 'test') ==> 'tttttttest'</code>
4056 </example>
4057 <example>
4058 <code>string::pad-left('test', 3, ' ') ==> 'test'</code>
4059 </example>
4060 <example>
4061 <code>string::pad-left('test', -4, ' ') ==> ERROR</code>
4062 </example>
4063 </member>
4064 <member name="M:NAnt.Core.Functions.StringFunctions.PadRight(System.String,System.Int32,System.String)">
4065 <summary>
4066 Returns the given string right-padded to the given length.
4067 </summary>
4068 <param name="s">The <see cref="T:System.String"/> that needs to be right-padded.</param>
4069 <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param>
4070 <param name="paddingChar">A Unicode padding character.</param>
4071 <returns>
4072 If the length of <paramref name="s"/> is at least
4073 <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical
4074 to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/>
4075 will be padded on the right with as many <paramref name="paddingChar"/>
4076 characters as needed to create a length of <paramref name="totalWidth"/>.
4077 </returns>
4078 <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception>
4079 <remarks>
4080 Note that only the first character of <paramref name="paddingChar"/>
4081 will be used when padding the result.
4082 </remarks>
4083 <example>
4084 <code>string::pad-right('test', 10, ' ') ==> 'test '</code>
4085 </example>
4086 <example>
4087 <code>string::pad-right('test', 10, 'abcd') ==> 'testaaaaaa'</code>
4088 </example>
4089 <example>
4090 <code>string::pad-right('test', 3, ' ') ==> 'test'</code>
4091 </example>
4092 <example>
4093 <code>string::pad-right('test', -3, ' ') ==> ERROR</code>
4094 </example>
4095 </member>
4096 <member name="M:NAnt.Core.Functions.StringFunctions.Trim(System.String)">
4097 <summary>
4098 Returns the given string trimmed of whitespace.
4099 </summary>
4100 <param name="s">input string</param>
4101 <returns>
4102 The string <paramref name="s" /> with any leading or trailing
4103 white space characters removed.
4104 </returns>
4105 <example>
4106 <code>string::trim(' test ') ==> 'test'</code>
4107 </example>
4108 <example>
4109 <code>string::trim('\t\tfoo \r\n') ==> 'foo'</code>
4110 </example>
4111 </member>
4112 <member name="M:NAnt.Core.Functions.StringFunctions.TrimStart(System.String)">
4113 <summary>
4114 Returns the given string trimmed of leading whitespace.
4115 </summary>
4116 <param name="s">input string</param>
4117 <returns>
4118 The string <paramref name="s" /> with any leading
4119 whites pace characters removed.
4120 </returns>
4121 <example>
4122 <code>string::trim-start(' test ') ==> 'test '</code>
4123 </example>
4124 <example>
4125 <code>string::trim-start('\t\tfoo \r\n') ==> 'foo \r\n'</code>
4126 </example>
4127 </member>
4128 <member name="M:NAnt.Core.Functions.StringFunctions.TrimEnd(System.String)">
4129 <summary>
4130 Returns the given string trimmed of trailing whitespace.
4131 </summary>
4132 <param name="s">input string</param>
4133 <returns>
4134 The string <paramref name="s" /> with any trailing
4135 white space characters removed.
4136 </returns>
4137 <example>
4138 <code>string::trim-end(' test ') ==> ' test'</code>
4139 </example>
4140 <example>
4141 <code>string::trim-end('\t\tfoo \r\n') ==> '\t\tfoo'</code>
4142 </example>
4143 </member>
4144 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalDays(System.TimeSpan)">
4145 <summary>
4146 Returns the total number of days represented by the specified
4147 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional days.
4148 </summary>
4149 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4150 <returns>
4151 The total number of days represented by the given <see cref="T:System.TimeSpan"/>.
4152 </returns>
4153 </member>
4154 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalHours(System.TimeSpan)">
4155 <summary>
4156 Returns the total number of hours represented by the specified
4157 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional hours.
4158 </summary>
4159 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4160 <returns>
4161 The total number of hours represented by the given <see cref="T:System.TimeSpan"/>.
4162 </returns>
4163 </member>
4164 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMinutes(System.TimeSpan)">
4165 <summary>
4166 Returns the total number of minutes represented by the specified
4167 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional minutes.
4168 </summary>
4169 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4170 <returns>
4171 The total number of minutes represented by the given <see cref="T:System.TimeSpan"/>.
4172 </returns>
4173 </member>
4174 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalSeconds(System.TimeSpan)">
4175 <summary>
4176 Returns the total number of seconds represented by the specified
4177 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional seconds.
4178 </summary>
4179 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4180 <returns>
4181 The total number of seconds represented by the given <see cref="T:System.TimeSpan"/>.
4182 </returns>
4183 </member>
4184 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMilliseconds(System.TimeSpan)">
4185 <summary>
4186 Returns the total number of milliseconds represented by the specified
4187 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional milliseconds.
4188 </summary>
4189 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4190 <returns>
4191 The total number of milliseconds represented by the given
4192 <see cref="T:System.TimeSpan"/>.
4193 </returns>
4194 </member>
4195 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetDays(System.TimeSpan)">
4196 <summary>
4197 Returns the number of whole days represented by the specified
4198 <see cref="T:System.TimeSpan"/>.
4199 </summary>
4200 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4201 <returns>
4202 The number of whole days represented by the given
4203 <see cref="T:System.TimeSpan"/>.
4204 </returns>
4205 <example>
4206 <para>
4207 Remove all files that have not been modified in the last 7 days from directory "binaries".</para>
4208 <code>
4209 <![CDATA[
4210 <foreach item="File" in="binaries" property="filename">
4211 <if test="${timespan::get-days(datetime::now() - file::get-last-write-time(filename)) >= 7}">
4212 <delete file="${filename}" />
4213 </if>
4214 </foreach>
4215 ]]>
4216 </code>
4217 </example>
4218 </member>
4219 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetHours(System.TimeSpan)">
4220 <summary>
4221 Returns the number of whole hours represented by the specified
4222 <see cref="T:System.TimeSpan"/>.
4223 </summary>
4224 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4225 <returns>
4226 The number of whole hours represented by the given
4227 <see cref="T:System.TimeSpan"/>.
4228 </returns>
4229 </member>
4230 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMinutes(System.TimeSpan)">
4231 <summary>
4232 Returns the number of whole minutes represented by the specified
4233 <see cref="T:System.TimeSpan"/>.
4234 </summary>
4235 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4236 <returns>
4237 The number of whole minutes represented by the given
4238 <see cref="T:System.TimeSpan"/>.
4239 </returns>
4240 </member>
4241 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetSeconds(System.TimeSpan)">
4242 <summary>
4243 Returns the number of whole seconds represented by the specified
4244 <see cref="T:System.TimeSpan"/>.
4245 </summary>
4246 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4247 <returns>
4248 The number of whole seconds represented by the given
4249 <see cref="T:System.TimeSpan"/>.
4250 </returns>
4251 </member>
4252 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMilliseconds(System.TimeSpan)">
4253 <summary>
4254 Returns the number of whole milliseconds represented by the specified
4255 <see cref="T:System.TimeSpan"/>.
4256 </summary>
4257 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4258 <returns>
4259 The number of whole milliseconds represented by the given
4260 <see cref="T:System.TimeSpan"/>.
4261 </returns>
4262 </member>
4263 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTicks(System.TimeSpan)">
4264 <summary>
4265 Returns the number of ticks contained in the specified
4266 <see cref="T:System.TimeSpan"/>.
4267 </summary>
4268 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4269 <returns>
4270 The number of ticks contained in the given <see cref="T:System.TimeSpan"/>.
4271 </returns>
4272 </member>
4273 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromDays(System.Double)">
4274 <summary>
4275 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4276 of days, where the specification is accurate to the nearest millisecond.
4277 </summary>
4278 <param name="value">A number of days, accurate to the nearest millisecond.</param>
4279 <returns>
4280 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4281 </returns>
4282 </member>
4283 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromHours(System.Double)">
4284 <summary>
4285 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4286 of hours, where the specification is accurate to the nearest
4287 millisecond.
4288 </summary>
4289 <param name="value">A number of hours, accurate to the nearest millisecond.</param>
4290 <returns>
4291 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4292 </returns>
4293 </member>
4294 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMinutes(System.Double)">
4295 <summary>
4296 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4297 of minutes, where the specification is accurate to the nearest
4298 millisecond.
4299 </summary>
4300 <param name="value">A number of minutes, accurate to the nearest millisecond.</param>
4301 <returns>
4302 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4303 </returns>
4304 </member>
4305 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromSeconds(System.Double)">
4306 <summary>
4307 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4308 of seconds, where the specification is accurate to the nearest
4309 millisecond.
4310 </summary>
4311 <param name="value">A number of seconds, accurate to the nearest millisecond.</param>
4312 <returns>
4313 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4314 </returns>
4315 </member>
4316 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMilliseconds(System.Double)">
4317 <summary>
4318 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4319 of milliseconds.
4320 </summary>
4321 <param name="value">A number of milliseconds.</param>
4322 <returns>
4323 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4324 </returns>
4325 </member>
4326 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromTicks(System.Int64)">
4327 <summary>
4328 Returns a <see cref="T:System.TimeSpan"/> that represents a specified time,
4329 where the specification is in units of ticks.
4330 </summary>
4331 <param name="value">A number of ticks that represent a time.</param>
4332 <returns>
4333 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4334 </returns>
4335 </member>
4336 <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.Parse(System.String)">
4337 <summary>
4338 Constructs a <see cref="T:System.TimeSpan"/> from a time indicated by a
4339 specified string.
4340 </summary>
4341 <param name="s">A string.</param>
4342 <returns>
4343 A <see cref="T:System.TimeSpan"/> that corresponds to <paramref name="s"/>.
4344 </returns>
4345 <exception cref="T:System.FormatException"><paramref name="s"/> has an invalid format.</exception>
4346 <exception cref="T:System.OverflowException">At least one of the hours, minutes, or seconds components is outside its valid range.</exception>
4347 </member>
4348 <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.ToString(System.TimeSpan)">
4349 <summary>
4350 Converts the specified <see cref="T:System.TimeSpan"/> to its equivalent
4351 string representation.
4352 </summary>
4353 <param name="value">A <see cref="T:System.TimeSpan"/> to convert.</param>
4354 <returns>
4355 The string representation of <paramref name="value"/>. The format
4356 of the return value is of the form: [-][d.]hh:mm:ss[.ff].
4357 </returns>
4358 </member>
4359 <member name="M:NAnt.Core.Functions.VersionFunctions.GetMajor(System.Version)">
4360 <summary>
4361 Gets the value of the major component of a given version.
4362 </summary>
4363 <param name="version">A version.</param>
4364 <returns>
4365 The major version number.
4366 </returns>
4367 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4368 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4369 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4370 </member>
4371 <member name="M:NAnt.Core.Functions.VersionFunctions.GetMinor(System.Version)">
4372 <summary>
4373 Gets the value of the minor component of a given version.
4374 </summary>
4375 <param name="version">A version.</param>
4376 <returns>
4377 The minor version number.
4378 </returns>
4379 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4380 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4381 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4382 </member>
4383 <member name="M:NAnt.Core.Functions.VersionFunctions.GetBuild(System.Version)">
4384 <summary>
4385 Gets the value of the build component of a given version.
4386 </summary>
4387 <param name="version">A version.</param>
4388 <returns>
4389 The build number, or -1 if the build number is undefined.
4390 </returns>
4391 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4392 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4393 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4394 </member>
4395 <member name="M:NAnt.Core.Functions.VersionFunctions.GetRevision(System.Version)">
4396 <summary>
4397 Gets the value of the revision component of a given version.
4398 </summary>
4399 <param name="version">A version.</param>
4400 <returns>
4401 The revision number, or -1 if the revision number is undefined.
4402 </returns>
4403 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4404 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4405 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4406 </member>
4407 <member name="M:NAnt.Core.Functions.VersionConversionFunctions.Parse(System.String)">
4408 <summary>
4409 Converts the specified string representation of a version to
4410 its <see cref="T:System.Version"/> equivalent.
4411 </summary>
4412 <param name="version">A string containing the major, minor, build, and revision numbers, where each number is delimited with a period character ('.').</param>
4413 <returns>
4414 A <see cref="T:System.Version"/> instance representing the specified
4415 <see cref="T:System.String"/>.
4416 </returns>
4417 <exception cref="T:System.ArgumentException"><paramref name="version"/> has fewer than two components or more than four components.</exception>
4418 <exception cref="T:System.ArgumentOutOfRangeException">A major, minor, build, or revision component is less than zero.</exception>
4419 <exception cref="T:System.FormatException">At least one component of <paramref name="version"/> does not parse to a decimal integer.</exception>
4420 </member>
4421 <member name="M:NAnt.Core.Functions.VersionConversionFunctions.ToString(System.Version)">
4422 <summary>
4423 Converts the specified <see cref="T:System.Version"/> to its equivalent
4424 string representation.
4425 </summary>
4426 <param name="value">A <see cref="T:System.Version"/> to convert.</param>
4427 <returns>
4428 The string representation of the values of the major, minor, build,
4429 and revision components of the specified <see cref="T:System.Version"/>.
4430 </returns>
4431 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4432 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4433 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4434 </member>
4435 <member name="T:NAnt.Core.Tasks.AttribTask">
4436 <summary>
4437 Changes the file attributes of a file or set of files and directories.
4438 </summary>
4439 <remarks>
4440 <para>
4441 <see cref="T:NAnt.Core.Tasks.AttribTask"/> does not have the concept of turning
4442 attributes off. Instead you specify all the attributes that you want
4443 turned on and the rest are turned off by default.
4444 </para>
4445 <para>
4446 Refer to the <see cref="T:System.IO.FileAttributes"/> enumeration in the .NET SDK
4447 for more information about file attributes.
4448 </para>
4449 </remarks>
4450 <example>
4451 <para>
4452 Set the <c>read-only</c> file attribute for the specified file in
4453 the project directory.
4454 </para>
4455 <code>
4456 <![CDATA[
4457 <attrib file="myfile.txt" readonly="true" />
4458 ]]>
4459 </code>
4460 </example>
4461 <example>
4462 <para>
4463 Set the <c>normal</c> file attribute for the specified file.
4464 </para>
4465 <code>
4466 <![CDATA[
4467 <attrib file="myfile.txt" normal="true" />
4468 ]]>
4469 </code>
4470 </example>
4471 <example>
4472 <para>
4473 Set the <c>normal</c> file attribute for all executable files in
4474 the current project directory and sub-directories.
4475 </para>
4476 <code>
4477 <![CDATA[
4478 <attrib normal="true">
4479 <fileset>
4480 <include name="**/*.exe" />
4481 <include name="bin" />
4482 </fileset>
4483 </attrib>
4484 ]]>
4485 </code>
4486 </example>
4487 </member>
4488 <member name="T:NAnt.Core.Task">
4489 <summary>
4490 Provides the abstract base class for tasks.
4491 </summary>
4492 <remarks>
4493 A task is a piece of code that can be executed.
4494 </remarks>
4495 </member>
4496 <member name="M:NAnt.Core.Task.Execute">
4497 <summary>
4498 Executes the task unless it is skipped.
4499 </summary>
4500 </member>
4501 <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String)">
4502 <summary>
4503 Logs a message with the given priority.
4504 </summary>
4505 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
4506 <param name="message">The message to be logged.</param>
4507 <remarks>
4508 <para>
4509 The actual logging is delegated to the project.
4510 </para>
4511 <para>
4512 If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a
4513 message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the
4514 priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>
4515 when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>.
4516 </para>
4517 <para>
4518 This will allow individual tasks to run in verbose mode while
4519 the build log itself is still configured with threshold
4520 <see cref="F:NAnt.Core.Level.Info"/>.
4521 </para>
4522 <para>
4523 The threshold of the project is not taken into account to determine
4524 whether a message should be passed to the logging infrastructure,
4525 as build listeners might be interested in receiving all messages.
4526 </para>
4527 </remarks>
4528 </member>
4529 <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String,System.Object[])">
4530 <summary>
4531 Logs a formatted message with the given priority.
4532 </summary>
4533 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
4534 <param name="message">The message to log, containing zero or more format items.</param>
4535 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
4536 <remarks>
4537 <para>
4538 The actual logging is delegated to the project.
4539 </para>
4540 <para>
4541 If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a
4542 message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the
4543 priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>.
4544 when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>.
4545 </para>
4546 <para>
4547 This will allow individual tasks to run in verbose mode while
4548 the build log itself is still configured with threshold
4549 <see cref="F:NAnt.Core.Level.Info"/>.
4550 </para>
4551 </remarks>
4552 </member>
4553 <member name="M:NAnt.Core.Task.IsLogEnabledFor(NAnt.Core.Level)">
4554 <summary>
4555 Determines whether build output is enabled for the given
4556 <see cref="T:NAnt.Core.Level"/>.
4557 </summary>
4558 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to check.</param>
4559 <returns>
4560 <see langword="true"/> if messages with the given <see cref="T:NAnt.Core.Level"/>
4561 should be passed on to the logging infrastructure; otherwise,
4562 <see langword="false"/>.
4563 </returns>
4564 <remarks>
4565 The threshold of the project is not taken into account to determine
4566 whether a message should be passed to the logging infrastructure,
4567 as build listeners might be interested in receiving all messages.
4568 </remarks>
4569 </member>
4570 <member name="M:NAnt.Core.Task.InitializeTaskConfiguration">
4571 <summary>
4572 Initializes the configuration of the task using configuration
4573 settings retrieved from the NAnt configuration file.
4574 </summary>
4575 <remarks>
4576 TO-DO : Remove this temporary hack when a permanent solution is
4577 available for loading the default values from the configuration
4578 file if a build element is constructed from code.
4579 </remarks>
4580 </member>
4581 <member name="M:NAnt.Core.Task.Initialize">
4582 <summary>Initializes the task.</summary>
4583 </member>
4584 <member name="M:NAnt.Core.Task.InitializeTask(System.Xml.XmlNode)">
4585 <summary>Initializes the task.</summary>
4586 </member>
4587 <member name="M:NAnt.Core.Task.ExecuteTask">
4588 <summary>Executes the task.</summary>
4589 </member>
4590 <member name="M:NAnt.Core.Task.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)">
4591 <summary>
4592 Locates the XML node for the specified attribute in either the
4593 configuration section of the extension assembly or the.project.
4594 </summary>
4595 <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param>
4596 <param name="framework">The framework to use to obtain framework specific information, or <see langword="null" /> if no framework specific information should be used.</param>
4597 <returns>
4598 The XML configuration node for the specified attribute, or
4599 <see langword="null" /> if no corresponding XML node could be
4600 located.
4601 </returns>
4602 <remarks>
4603 If there's a valid current framework, the configuration section for
4604 that framework will first be searched. If no corresponding
4605 configuration node can be located in that section, the framework-neutral
4606 section of the project configuration node will be searched.
4607 </remarks>
4608 </member>
4609 <member name="P:NAnt.Core.Task.FailOnError">
4610 <summary>
4611 Determines if task failure stops the build, or is just reported.
4612 The default is <see langword="true" />.
4613 </summary>
4614 </member>
4615 <member name="P:NAnt.Core.Task.Verbose">
4616 <summary>
4617 Determines whether the task should report detailed build log messages.
4618 The default is <see langword="false" />.
4619 </summary>
4620 </member>
4621 <member name="P:NAnt.Core.Task.IfDefined">
4622 <summary>
4623 If <see langword="true" /> then the task will be executed; otherwise,
4624 skipped. The default is <see langword="true" />.
4625 </summary>
4626 </member>
4627 <member name="P:NAnt.Core.Task.UnlessDefined">
4628 <summary>
4629 Opposite of <see cref="P:NAnt.Core.Task.IfDefined"/>. If <see langword="false"/>
4630 then the task will be executed; otherwise, skipped. The default is
4631 <see langword="false"/>.
4632 </summary>
4633 </member>
4634 <member name="P:NAnt.Core.Task.Name">
4635 <summary>
4636 The name of the task.
4637 </summary>
4638 </member>
4639 <member name="P:NAnt.Core.Task.LogPrefix">
4640 <summary>
4641 The prefix used when sending messages to the log.
4642 </summary>
4643 </member>
4644 <member name="P:NAnt.Core.Task.Threshold">
4645 <summary>
4646 Gets or sets the log threshold for this <see cref="T:NAnt.Core.Task"/>. By
4647 default the threshold of a task is <see cref="F:NAnt.Core.Level.Debug"/>,
4648 causing no messages to be filtered in the task itself.
4649 </summary>
4650 <value>
4651 The log threshold level for this <see cref="T:NAnt.Core.Task"/>.
4652 </value>
4653 <remarks>
4654 When the threshold of a <see cref="T:NAnt.Core.Task"/> is higher than the
4655 threshold of the <see cref="T:NAnt.Core.Project"/>, then all messages will
4656 still be delivered to the build listeners.
4657 </remarks>
4658 </member>
4659 <member name="P:NAnt.Core.Task.TaskBuilder">
4660 <summary>
4661 Returns the TaskBuilder used to construct an instance of this
4662 <see cref="T:NAnt.Core.Task"/>.
4663 </summary>
4664 </member>
4665 <member name="P:NAnt.Core.Tasks.AttribTask.File">
4666 <summary>
4667 The name of the file which will have its attributes set. This is
4668 provided as an alternate to using the task's fileset.
4669 </summary>
4670 </member>
4671 <member name="P:NAnt.Core.Tasks.AttribTask.AttribFileSet">
4672 <summary>
4673 All the matching files and directories in this fileset will have
4674 their attributes set.
4675 </summary>
4676 </member>
4677 <member name="P:NAnt.Core.Tasks.AttribTask.ArchiveAttrib">
4678 <summary>
4679 Set the archive attribute. The default is <see langword="false" />.
4680 </summary>
4681 </member>
4682 <member name="P:NAnt.Core.Tasks.AttribTask.HiddenAttrib">
4683 <summary>
4684 Set the hidden attribute. The default is <see langword="false" />.
4685 </summary>
4686 </member>
4687 <member name="P:NAnt.Core.Tasks.AttribTask.NormalAttrib">
4688 <summary>
4689 Set the normal file attributes. This attribute is only valid if used
4690 alone. The default is <see langword="false" />.
4691 </summary>
4692 </member>
4693 <member name="P:NAnt.Core.Tasks.AttribTask.ReadOnlyAttrib">
4694 <summary>
4695 Set the read-only attribute. The default is <see langword="false" />.
4696 </summary>
4697 </member>
4698 <member name="P:NAnt.Core.Tasks.AttribTask.SystemAttrib">
4699 <summary>
4700 Set the system attribute. The default is <see langword="false" />.
4701 </summary>
4702 </member>
4703 <member name="T:NAnt.Core.Tasks.AvailableTask">
4704 <summary>
4705 Checks if a resource is available at runtime.
4706 </summary>
4707 <remarks>
4708 <para>
4709 The specified property is set to <see langword="true"/> if the
4710 requested resource is available at runtime, and <see langword="false"/>
4711 if the resource is not available.
4712 </para>
4713 <note>
4714 we advise you to use the following functions instead:
4715 </note>
4716 <list type="table">
4717 <listheader>
4718 <term>Function</term>
4719 <description>Description</description>
4720 </listheader>
4721 <item>
4722 <term><see cref="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)"/></term>
4723 <description>Determines whether the specified file exists.</description>
4724 </item>
4725 <item>
4726 <term><see cref="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)"/></term>
4727 <description>Determines whether the given path refers to an existing directory on disk.</description>
4728 </item>
4729 <item>
4730 <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)"/></term>
4731 <description>Checks whether the specified framework exists..</description>
4732 </item>
4733 <item>
4734 <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)"/></term>
4735 <description>Checks whether the SDK for the specified framework is installed.</description>
4736 </item>
4737 </list>
4738 </remarks>
4739 <example>
4740 <para>
4741 Sets the <c>myfile.present</c> property to <see langword="true"/> if the
4742 file is available on the filesystem and <see langword="false"/> if the
4743 file is not available.
4744 </para>
4745 <code>
4746 <![CDATA[
4747 <available type="File" resource="myfile.txt" property="myfile.present" />
4748 ]]>
4749 </code>
4750 </example>
4751 <example>
4752 <para>
4753 Sets the <c>build.dir.present</c> property to <see langword="true"/>
4754 if the directory is available on the filesystem and <see langword="false"/>
4755 if the directory is not available.
4756 </para>
4757 <code>
4758 <![CDATA[
4759 <available type="Directory" resource="build" property="build.dir.present" />
4760 ]]>
4761 </code>
4762 </example>
4763 <example>
4764 <para>
4765 Sets the <c>mono-0.21.framework.present</c> property to <see langword="true"/>
4766 if the Mono 0.21 framework is available on the current system and
4767 <see langword="false"/> if the framework is not available.
4768 </para>
4769 <code>
4770 <![CDATA[
4771 <available type="Framework" resource="mono-0.21" property="mono-0.21.framework.present" />
4772 ]]>
4773 </code>
4774 </example>
4775 <example>
4776 <para>
4777 Sets the <c>net-1.1.frameworksdk.present</c> property to <see langword="true"/>
4778 if the .NET 1.1 Framework SDK is available on the current system and
4779 <see langword="false"/> if the SDK is not available.
4780 </para>
4781 <code>
4782 <![CDATA[
4783 <available type="FrameworkSDK" resource="net-1.1" property="net-1.1.frameworksdk.present" />
4784 ]]>
4785 </code>
4786 </example>
4787 </member>
4788 <member name="M:NAnt.Core.Tasks.AvailableTask.ExecuteTask">
4789 <summary>
4790 Executes the task.
4791 </summary>
4792 <remarks>
4793 <para>
4794 Sets the property identified by <see cref="P:NAnt.Core.Tasks.AvailableTask.PropertyName"/> to
4795 <see langword="true"/> when the resource exists and to <see langword="false"/>
4796 when the resource doesn't exist.
4797 </para>
4798 </remarks>
4799 <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception>
4800 </member>
4801 <member name="M:NAnt.Core.Tasks.AvailableTask.Evaluate">
4802 <summary>
4803 Evaluates the availability of a resource.
4804 </summary>
4805 <returns>
4806 <see langword="true"/> if the resource is available; otherwise,
4807 <see langword="false"/>.
4808 </returns>
4809 <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception>
4810 </member>
4811 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFile">
4812 <summary>
4813 Checks if the file specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/> property is
4814 available on the filesystem.
4815 </summary>
4816 <returns>
4817 <see langword="true"/> when the file exists; otherwise, <see langword="false"/>.
4818 </returns>
4819 </member>
4820 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckDirectory">
4821 <summary>
4822 Checks if the directory specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
4823 property is available on the filesystem.
4824 </summary>
4825 <returns>
4826 <see langword="true"/> when the directory exists; otherwise, <see langword="false"/>.
4827 </returns>
4828 </member>
4829 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFramework">
4830 <summary>
4831 Checks if the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
4832 property is available on the current system.
4833 </summary>
4834 <returns>
4835 <see langword="true"/> when the framework is available; otherwise,
4836 <see langword="false"/>.
4837 </returns>
4838 </member>
4839 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFrameworkSDK">
4840 <summary>
4841 Checks if the SDK for the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
4842 property is available on the current system.
4843 </summary>
4844 <returns>
4845 <see langword="true"/> when the SDK for the specified framework is
4846 available; otherwise, <see langword="false"/>.
4847 </returns>
4848 </member>
4849 <member name="P:NAnt.Core.Tasks.AvailableTask.Resource">
4850 <summary>
4851 The resource which must be available.
4852 </summary>
4853 </member>
4854 <member name="P:NAnt.Core.Tasks.AvailableTask.Type">
4855 <summary>
4856 The type of resource which must be present.
4857 </summary>
4858 </member>
4859 <member name="P:NAnt.Core.Tasks.AvailableTask.PropertyName">
4860 <summary>
4861 The property that must be set if the resource is available.
4862 </summary>
4863 </member>
4864 <member name="T:NAnt.Core.Tasks.AvailableTask.ResourceType">
4865 <summary>
4866 Defines the possible resource checks.
4867 </summary>
4868 </member>
4869 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.File">
4870 <summary>
4871 Determines whether a given file exists.
4872 </summary>
4873 </member>
4874 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Directory">
4875 <summary>
4876 Determines whether a given directory exists.
4877 </summary>
4878 </member>
4879 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Framework">
4880 <summary>
4881 Determines whether a given framework is available.
4882 </summary>
4883 </member>
4884 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.FrameworkSDK">
4885 <summary>
4886 Determines whether a given SDK is available.
4887 </summary>
4888 </member>
4889 <member name="T:NAnt.Core.Tasks.CallTask">
4890 <summary>
4891 Calls a NAnt target in the current project.
4892 </summary>
4893 <remarks>
4894 <para>
4895 When the <see cref="T:NAnt.Core.Tasks.CallTask"/> is used to execute a target, both that
4896 target and all its dependent targets will be re-executed.
4897 </para>
4898 <para>
4899 To avoid dependent targets from being executed more than once, two
4900 options are available:
4901 </para>
4902 <list type="bullet">
4903 <item>
4904 <description>
4905 Add an "unless" attribute with value "${<see href="../functions/target.has-executed.html">target::has-executed</see>('<c><target name></c>')}"
4906 to the dependent targets.
4907 </description>
4908 </item>
4909 <item>
4910 <description>
4911 Set the <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute on the
4912 <see cref="T:NAnt.Core.Tasks.CallTask"/> to <see langword="false "/> (<c>recommended</c>).
4913 </description>
4914 </item>
4915 </list>
4916 </remarks>
4917 <example>
4918 <para>
4919 Call the target "build".
4920 </para>
4921 <code>
4922 <![CDATA[
4923 <call target="build" />
4924 ]]>
4925 </code>
4926 </example>
4927 <example>
4928 <para>
4929 This shows how a project could 'compile' a debug and release build
4930 using a common compile target.
4931 </para>
4932 <code>
4933 <![CDATA[
4934 <project default="build">
4935 <property name="debug" value="false" />
4936 <target name="init">
4937 <echo message="initializing" />
4938 </target>
4939 <target name="compile" depends="init">
4940 <echo message="compiling with debug = ${debug}" />
4941 </target>
4942 <target name="build">
4943 <property name="debug" value="false" />
4944 <call target="compile" />
4945 <property name="debug" value="true" />
4946 <call target="compile" />
4947 </target>
4948 </project>
4949 ]]>
4950 </code>
4951 <para>
4952 The <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> parameter of the
4953 <see cref="T:NAnt.Core.Tasks.CallTask"/> defaults to <see langword="true"/>,
4954 causing the "init" target to be executed for both
4955 the "debug" and "release" build.
4956 </para>
4957 <para>
4958 This results in the following build log:
4959 </para>
4960 <code>
4961 build:
4962
4963 init:
4964
4965 [echo] initializing
4966
4967 compile:
4968
4969 [echo] compiling with debug = false
4970
4971 init:
4972
4973 [echo] initializing
4974
4975 compile:
4976
4977 [echo] compiling with debug = true
4978
4979 BUILD SUCCEEDED
4980 </code>
4981 <para>
4982 If the "init" should only be executed once, set the
4983 <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute of the <see cref="T:NAnt.Core.Tasks.CallTask"/>
4984 to <see langword="false"/>.
4985 </para>
4986 <para>
4987 The build log would then look like this:
4988 </para>
4989 <code>
4990 build:
4991
4992 init:
4993
4994 [echo] initializing
4995
4996 compile:
4997
4998 [echo] compiling with debug = false
4999
5000 compile:
5001
5002 [echo] compiling with debug = true
5003
5004 BUILD SUCCEEDED
5005 </code>
5006 </example>
5007 </member>
5008 <member name="M:NAnt.Core.Tasks.CallTask.ExecuteTask">
5009 <summary>
5010 Executes the specified target.
5011 </summary>
5012 </member>
5013 <member name="M:NAnt.Core.Tasks.CallTask.Initialize">
5014 <summary>
5015 Makes sure the <see cref="T:NAnt.Core.Tasks.CallTask"/> is not calling its own
5016 parent.
5017 </summary>
5018 </member>
5019 <member name="P:NAnt.Core.Tasks.CallTask.TargetName">
5020 <summary>
5021 NAnt target to call.
5022 </summary>
5023 </member>
5024 <member name="P:NAnt.Core.Tasks.CallTask.ForceExecute">
5025 <summary>
5026 Force an execute even if the target has already been executed. The
5027 default is <see langword="false" />.
5028 </summary>
5029 </member>
5030 <member name="P:NAnt.Core.Tasks.CallTask.CascadeDependencies">
5031 <summary>
5032 Execute the specified targets dependencies -- even if they have been
5033 previously executed. The default is <see langword="true" />.
5034 </summary>
5035 </member>
5036 <member name="T:NAnt.Core.Tasks.CopyTask">
5037 <summary>
5038 Copies a file or set of files to a new file or directory.
5039 </summary>
5040 <remarks>
5041 <para>
5042 Files are only copied if the source file is newer than the destination
5043 file, or if the destination file does not exist. However, you can
5044 explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/> attribute.
5045 </para>
5046 <para>
5047 When a <see cref="T:NAnt.Core.Types.FileSet"/> is used to select files to copy, the
5048 <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set. Files that are
5049 located under the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/> will
5050 be copied to a directory under the destination directory matching the
5051 path relative to the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/>,
5052 unless the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/> attribute is set to
5053 <see langword="true"/>.
5054 </para>
5055 <para>
5056 Files that are not located under the the base directory of the
5057 <see cref="T:NAnt.Core.Types.FileSet"/> will be copied directly under to the destination
5058 directory, regardless of the value of the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/>
5059 attribute.
5060 </para>
5061 <h4>Encoding</h4>
5062 <para>
5063 Unless an encoding is specified, the encoding associated with the
5064 system's current ANSI code page is used.
5065 </para>
5066 <para>
5067 An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
5068 file is automatically recognized, if the file starts with the
5069 appropriate byte order marks.
5070 </para>
5071 <note>
5072 If you employ filters in your copy operation, you should limit the copy
5073 to text files. Binary files will be corrupted by the copy operation.
5074 </note>
5075 </remarks>
5076 <example>
5077 <para>
5078 Copy a single file while changing its encoding from "latin1" to
5079 "utf-8".
5080 </para>
5081 <code>
5082 <![CDATA[
5083 <copy
5084 file="myfile.txt"
5085 tofile="mycopy.txt"
5086 inputencoding="latin1"
5087 outputencoding="utf-8" />
5088 ]]>
5089 </code>
5090 </example>
5091 <example>
5092 <para>Copy a set of files to a new directory.</para>
5093 <code>
5094 <![CDATA[
5095 <copy todir="${build.dir}">
5096 <fileset basedir="bin">
5097 <include name="*.dll" />
5098 </fileset>
5099 </copy>
5100 ]]>
5101 </code>
5102 </example>
5103 <example>
5104 <para>
5105 Copy a set of files to a directory, replacing <c>@TITLE@</c> with
5106 "Foo Bar" in all files.
5107 </para>
5108 <code>
5109 <![CDATA[
5110 <copy todir="../backup/dir">
5111 <fileset basedir="src_dir">
5112 <include name="**/*" />
5113 </fileset>
5114 <filterchain>
5115 <replacetokens>
5116 <token key="TITLE" value="Foo Bar" />
5117 </replacetokens>
5118 </filterchain>
5119 </copy>
5120 ]]>
5121 </code>
5122 </example>
5123 </member>
5124 <member name="M:NAnt.Core.Tasks.CopyTask.#ctor">
5125 <summary>
5126 Initialize new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>.
5127 </summary>
5128 </member>
5129 <member name="M:NAnt.Core.Tasks.CopyTask.Initialize">
5130 <summary>
5131 Checks whether the task is initialized with valid attributes.
5132 </summary>
5133 </member>
5134 <member name="M:NAnt.Core.Tasks.CopyTask.ExecuteTask">
5135 <summary>
5136 Executes the Copy task.
5137 </summary>
5138 <exception cref="T:NAnt.Core.BuildException">A file that has to be copied does not exist or could not be copied.</exception>
5139 </member>
5140 <member name="M:NAnt.Core.Tasks.CopyTask.DoFileOperations">
5141 <summary>
5142 Actually does the file copies.
5143 </summary>
5144 </member>
5145 <member name="P:NAnt.Core.Tasks.CopyTask.SourceFile">
5146 <summary>
5147 The file to copy.
5148 </summary>
5149 </member>
5150 <member name="P:NAnt.Core.Tasks.CopyTask.ToFile">
5151 <summary>
5152 The file to copy to.
5153 </summary>
5154 </member>
5155 <member name="P:NAnt.Core.Tasks.CopyTask.ToDirectory">
5156 <summary>
5157 The directory to copy to.
5158 </summary>
5159 </member>
5160 <member name="P:NAnt.Core.Tasks.CopyTask.Overwrite">
5161 <summary>
5162 Overwrite existing files even if the destination files are newer.
5163 The default is <see langword="false" />.
5164 </summary>
5165 </member>
5166 <member name="P:NAnt.Core.Tasks.CopyTask.Flatten">
5167 <summary>
5168 Ignore directory structure of source directory, copy all files into
5169 a single directory, specified by the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/>
5170 attribute. The default is <see langword="false"/>.
5171 </summary>
5172 </member>
5173 <member name="P:NAnt.Core.Tasks.CopyTask.IncludeEmptyDirs">
5174 <summary>
5175 Copy any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>.
5176 The default is <see langword="true"/>.
5177 </summary>
5178 </member>
5179 <member name="P:NAnt.Core.Tasks.CopyTask.CopyFileSet">
5180 <summary>
5181 Used to select the files to copy. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
5182 the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set.
5183 </summary>
5184 </member>
5185 <member name="P:NAnt.Core.Tasks.CopyTask.Filters">
5186 <summary>
5187 Chain of filters used to alter the file's content as it is copied.
5188 </summary>
5189 </member>
5190 <member name="P:NAnt.Core.Tasks.CopyTask.InputEncoding">
5191 <summary>
5192 The encoding to use when reading files. The default is the system's
5193 current ANSI code page.
5194 </summary>
5195 </member>
5196 <member name="P:NAnt.Core.Tasks.CopyTask.OutputEncoding">
5197 <summary>
5198 The encoding to use when writing the files. The default is
5199 the encoding of the input file.
5200 </summary>
5201 </member>
5202 <member name="P:NAnt.Core.Tasks.CopyTask.FileCopyMap">
5203 <summary>
5204 The set of files to perform a file operation on.
5205 </summary>
5206 <remarks>
5207 <para>
5208 The key of the <see cref="T:System.Collections.Hashtable"/> is the absolute path of
5209 the destination file and the value is a <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/>
5210 holding the path and last write time of the most recently updated
5211 source file that is selected to be copied or moved to the
5212 destination file.
5213 </para>
5214 <para>
5215 On Windows, the <see cref="T:System.Collections.Hashtable"/> is case-insensitive.
5216 </para>
5217 </remarks>
5218 </member>
5219 <member name="T:NAnt.Core.Tasks.CopyTask.FileDateInfo">
5220 <summary>
5221 Holds the absolute paths and last write time of a given file.
5222 </summary>
5223 </member>
5224 <member name="M:NAnt.Core.Tasks.CopyTask.FileDateInfo.#ctor(System.String,System.DateTime)">
5225 <summary>
5226 Initializes a new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/>
5227 class for the specified file and last write time.
5228 </summary>
5229 <param name="path">The absolute path of the file.</param>
5230 <param name="lastWriteTime">The last write time of the file.</param>
5231 </member>
5232 <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.Path">
5233 <summary>
5234 Gets the absolute path of the current file.
5235 </summary>
5236 <value>
5237 The absolute path of the current file.
5238 </value>
5239 </member>
5240 <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.LastWriteTime">
5241 <summary>
5242 Gets the time when the current file was last written to.
5243 </summary>
5244 <value>
5245 The time when the current file was last written to.
5246 </value>
5247 </member>
5248 <member name="T:NAnt.Core.Tasks.DeleteTask">
5249 <summary>
5250 Deletes a file, fileset or directory.
5251 </summary>
5252 <remarks>
5253 <para>
5254 Deletes either a single file, all files in a specified directory and
5255 its sub-directories, or a set of files specified by one or more filesets.
5256 </para>
5257 <para>
5258 If the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> or <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/> attribute is
5259 set then the fileset contents will be ignored. To delete the files
5260 in the fileset ommit the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> and <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/>
5261 attributes in the <c><delete></c> element.
5262 </para>
5263 <para>
5264 If the specified file or directory does not exist, no error is
5265 reported.
5266 </para>
5267 <note>
5268 Read-only files cannot be deleted. Use the <see cref="T:NAnt.Core.Tasks.AttribTask"/>
5269 first to remove the read-only attribute.
5270 </note>
5271 </remarks>
5272 <example>
5273 <para>Delete a single file.</para>
5274 <code>
5275 <![CDATA[
5276 <delete file="myfile.txt" />
5277 ]]>
5278 </code>
5279 </example>
5280 <example>
5281 <para>
5282 Delete a directory and the contents within. If the directory does not
5283 exist, no error is reported.
5284 </para>
5285 <code>
5286 <![CDATA[
5287 <delete dir="${build.dir}" />
5288 ]]>
5289 </code>
5290 </example>
5291 <example>
5292 <para>
5293 Delete a set of files.
5294 </para>
5295 <code>
5296 <![CDATA[
5297 <delete>
5298 <fileset>
5299 <include name="${basename}-??.exe" />
5300 <include name="${basename}-??.pdb" />
5301 </fileset>
5302 </delete>
5303 ]]>
5304 </code>
5305 </example>
5306 </member>
5307 <member name="M:NAnt.Core.Tasks.DeleteTask.Initialize">
5308 <summary>
5309 Ensures the supplied attributes are valid.
5310 </summary>
5311 </member>
5312 <member name="P:NAnt.Core.Tasks.DeleteTask.File">
5313 <summary>
5314 The file to delete.
5315 </summary>
5316 </member>
5317 <member name="P:NAnt.Core.Tasks.DeleteTask.Directory">
5318 <summary>
5319 The directory to delete.
5320 </summary>
5321 </member>
5322 <member name="P:NAnt.Core.Tasks.DeleteTask.IncludeEmptyDirs">
5323 <summary>
5324 Remove any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>.
5325 The default is <see langword="true"/>.
5326 </summary>
5327 </member>
5328 <member name="P:NAnt.Core.Tasks.DeleteTask.DeleteFileSet">
5329 <summary>
5330 All the files in the file set will be deleted.
5331 </summary>
5332 </member>
5333 <member name="P:NAnt.Core.Tasks.DeleteTask.Verbose">
5334 <summary>
5335 Controls whether to show the name of each deleted file or directory.
5336 The default is <see langword="false" />.
5337 </summary>
5338 </member>
5339 <member name="T:NAnt.Core.Tasks.DescriptionTask">
5340 <summary>
5341 An empty task that allows a build file to contain a description.
5342 </summary>
5343 <example>
5344 <para>Set a description.</para>
5345 <code>
5346 <![CDATA[
5347 <description>This is a description.</description>
5348 ]]>
5349 </code>
5350 </example>
5351 </member>
5352 <member name="T:NAnt.Core.Tasks.EchoTask">
5353 <summary>
5354 Writes a message to the build log or a specified file.
5355 </summary>
5356 <remarks>
5357 <para>
5358 The message can be specified using the <see cref="P:NAnt.Core.Tasks.EchoTask.Message"/> attribute
5359 or as inline content.
5360 </para>
5361 <para>
5362 Macros in the message will be expanded.
5363 </para>
5364 <para>
5365 When writing to a file, the <see cref="P:NAnt.Core.Tasks.EchoTask.MessageLevel"/> attribute is
5366 ignored.
5367 </para>
5368 </remarks>
5369 <example>
5370 <para>
5371 Writes a message with level <see cref="F:NAnt.Core.Level.Debug"/> to the build log.
5372 </para>
5373 <code>
5374 <![CDATA[
5375 <echo message="Hello, World!" level="Debug" />
5376 ]]>
5377 </code>
5378 </example>
5379 <example>
5380 <para>
5381 Writes a message with expanded macro to the build log.
5382 </para>
5383 <code>
5384 <![CDATA[
5385 <echo message="Base build directory = ${nant.project.basedir}" />
5386 ]]>
5387 </code>
5388 </example>
5389 <example>
5390 <para>
5391 Functionally equivalent to the previous example.
5392 </para>
5393 <code>
5394 <![CDATA[
5395 <echo>Base build directory = ${nant.project.basedir}</echo>
5396 ]]>
5397 </code>
5398 </example>
5399 <example>
5400 <para>
5401 Writes the previous message to a file in the project directory,
5402 overwriting the file if it exists.
5403 </para>
5404 <code>
5405 <![CDATA[
5406 <echo file="buildmessage.txt">Base build directory = ${nant.project.basedir}</echo>
5407 ]]>
5408 </code>
5409 </example>
5410 </member>
5411 <member name="M:NAnt.Core.Tasks.EchoTask.ExecuteTask">
5412 <summary>
5413 Outputs the message to the build log or the specified file.
5414 </summary>
5415 </member>
5416 <member name="P:NAnt.Core.Tasks.EchoTask.Message">
5417 <summary>
5418 The message to output.
5419 </summary>
5420 </member>
5421 <member name="P:NAnt.Core.Tasks.EchoTask.Contents">
5422 <summary>
5423 Gets or sets the inline content that should be output.
5424 </summary>
5425 <value>
5426 The inline content that should be output.
5427 </value>
5428 </member>
5429 <member name="P:NAnt.Core.Tasks.EchoTask.File">
5430 <summary>
5431 The file to write the message to.
5432 </summary>
5433 </member>
5434 <member name="P:NAnt.Core.Tasks.EchoTask.Append">
5435 <summary>
5436 Determines whether the <see cref="T:NAnt.Core.Tasks.EchoTask"/> should append to the
5437 file, or overwrite it. By default, the file will be overwritten.
5438 </summary>
5439 <value>
5440 <see langword="true"/> if output should be appended to the file;
5441 otherwise, <see langword="false"/>. The default is
5442 <see langword="false"/>.
5443 </value>
5444 </member>
5445 <member name="P:NAnt.Core.Tasks.EchoTask.MessageLevel">
5446 <summary>
5447 The logging level with which the message should be output. The default
5448 is <see cref="F:NAnt.Core.Level.Info"/>.
5449 </summary>
5450 </member>
5451 <member name="T:NAnt.Core.Tasks.ExecTask">
5452 <summary>
5453 Executes a system command.
5454 </summary>
5455 <remarks>
5456 <para>
5457 Use of nested <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"/> element(s)
5458 is advised over the <see cref="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments"/> parameter, as
5459 it supports automatic quoting and can resolve relative to absolute
5460 paths.
5461 </para>
5462 </remarks>
5463 <example>
5464 <para>Ping "nant.sourceforge.net".</para>
5465 <code>
5466 <![CDATA[
5467 <exec program="ping">
5468 <arg value="nant.sourceforge.net" />
5469 </exec>
5470 ]]>
5471 </code>
5472 </example>
5473 <example>
5474 <para>
5475 Execute a java application using <c>IKVM.NET</c> that requires the
5476 Apache FOP jars, and a set of custom jars.
5477 </para>
5478 <code>
5479 <![CDATA[
5480 <path id="fop-classpath">
5481 <pathelement file="${fop.dist.dir}/build/fop.jar" />
5482 <pathelement file="${fop.dist.dir}/lib/xercesImpl-2.2.1.jar" />
5483 <pathelement file="${fop.dist.dir}/lib/avalon-framework-cvs-20020806.jar" />
5484 <pathelement file="${fop.dist.dir}/lib/batik.jar" />
5485 </path>
5486 <exec program="ikvm.exe" useruntimeengine="true">
5487 <arg value="-cp" />
5488 <arg>
5489 <path>
5490 <pathelement dir="conf" />
5491 <path refid="fop-classpath" />
5492 <pathelement file="lib/mylib.jar" />
5493 <pathelement file="lib/otherlib.zip" />
5494 </path>
5495 </arg>
5496 <arg value="org.me.MyProg" />
5497 </exec>
5498 ]]>
5499 </code>
5500 <para>
5501 Assuming the base directory of the build file is "c:\ikvm-test" and
5502 the value of the "fop.dist.dir" property is "c:\fop", then the value
5503 of the <c>-cp</c> argument that is passed to<c>ikvm.exe</c> is
5504 "c:\ikvm-test\conf;c:\fop\build\fop.jar;conf;c:\fop\lib\xercesImpl-2.2.1.jar;c:\fop\lib\avalon-framework-cvs-20020806.jar;c:\fop\lib\batik.jar;c:\ikvm-test\lib\mylib.jar;c:\ikvm-test\lib\otherlib.zip"
5505 on a DOS-based system.
5506 </para>
5507 </example>
5508 </member>
5509 <member name="T:NAnt.Core.Tasks.ExternalProgramBase">
5510 <summary>
5511 Provides the abstract base class for tasks that execute external applications.
5512 </summary>
5513 <remarks>
5514 <para>
5515 When a <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/> is applied to the
5516 deriving class and <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName"/> does not return an
5517 absolute path, then the program to execute will first be searched for
5518 in the location specified by <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/>.
5519 </para>
5520 <para>
5521 If the program does not exist in that location, then the list of tool
5522 paths of the current target framework will be scanned in the order in
5523 which they are defined in the NAnt configuration file.
5524 </para>
5525 </remarks>
5526 </member>
5527 <member name="F:NAnt.Core.Tasks.ExternalProgramBase.UnknownExitCode">
5528 <summary>
5529 Defines the exit code that will be returned by <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode"/>
5530 if the process could not be started, or did not exit (in time).
5531 </summary>
5532 </member>
5533 <member name="F:NAnt.Core.Tasks.ExternalProgramBase._lockObject">
5534 <summary>
5535 Will be used to ensure thread-safe operations.
5536 </summary>
5537 </member>
5538 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.ExecuteTask">
5539 <summary>
5540 Starts the external process and captures its output.
5541 </summary>
5542 <exception cref="T:NAnt.Core.BuildException">
5543 <para>The external process did not finish within the configured timeout.</para>
5544 <para>-or-</para>
5545 <para>The exit code of the external process indicates a failure.</para>
5546 </exception>
5547 </member>
5548 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.PrepareProcess(System.Diagnostics.Process)">
5549 <summary>
5550 Updates the <see cref="T:System.Diagnostics.ProcessStartInfo"/> of the specified
5551 <see cref="T:System.Diagnostics.Process"/>.
5552 </summary>
5553 <param name="process">The <see cref="T:System.Diagnostics.Process"/> of which the <see cref="T:System.Diagnostics.ProcessStartInfo"/> should be updated.</param>
5554 </member>
5555 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StartProcess">
5556 <summary>
5557 Starts the process and handles errors.
5558 </summary>
5559 <returns>The <see cref="T:System.Diagnostics.Process"/> that was started.</returns>
5560 </member>
5561 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Output">
5562 <summary>
5563 Reads from the stream until the external program is ended.
5564 </summary>
5565 </member>
5566 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Error">
5567 <summary>
5568 Reads from the stream until the external program is ended.
5569 </summary>
5570 </member>
5571 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.DetermineFilePath">
5572 <summary>
5573 Determines the path of the external program that should be executed.
5574 </summary>
5575 <returns>
5576 A fully qualifies pathname including the program name.
5577 </returns>
5578 <exception cref="T:NAnt.Core.BuildException">The task is not available or not configured for the current framework.</exception>
5579 </member>
5580 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName">
5581 <summary>
5582 The name of the executable that should be used to launch the
5583 external program.
5584 </summary>
5585 <value>
5586 The name of the executable that should be used to launch the external
5587 program, or <see langword="null" /> if no name is specified.
5588 </value>
5589 <remarks>
5590 If available, the configured value in the NAnt configuration
5591 file will be used if no name is specified.
5592 </remarks>
5593 </member>
5594 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramFileName">
5595 <summary>
5596 Gets the filename of the external program to start.
5597 </summary>
5598 <value>
5599 The filename of the external program.
5600 </value>
5601 <remarks>
5602 Override in derived classes to explicitly set the location of the
5603 external tool.
5604 </remarks>
5605 </member>
5606 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramArguments">
5607 <summary>
5608 Gets the command-line arguments for the external program.
5609 </summary>
5610 <value>
5611 The command-line arguments for the external program.
5612 </value>
5613 </member>
5614 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Output">
5615 <summary>
5616 Gets the file to which the standard output should be redirected.
5617 </summary>
5618 <value>
5619 The file to which the standard output should be redirected, or
5620 <see langword="null" /> if the standard output should not be
5621 redirected.
5622 </value>
5623 <remarks>
5624 The default implementation will never allow the standard output
5625 to be redirected to a file. Deriving classes should override this
5626 property to change this behaviour.
5627 </remarks>
5628 </member>
5629 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputAppend">
5630 <summary>
5631 Gets a value indicating whether output will be appended to the
5632 <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>.
5633 </summary>
5634 <value>
5635 <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>;
5636 otherwise, <see langword="false"/>.
5637 </value>
5638 </member>
5639 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.BaseDirectory">
5640 <summary>
5641 Gets the working directory for the application.
5642 </summary>
5643 <value>
5644 The working directory for the application.
5645 </value>
5646 </member>
5647 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.TimeOut">
5648 <summary>
5649 The maximum amount of time the application is allowed to execute,
5650 expressed in milliseconds. Defaults to no time-out.
5651 </summary>
5652 </member>
5653 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments">
5654 <summary>
5655 The command-line arguments for the external program.
5656 </summary>
5657 </member>
5658 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine">
5659 <summary>
5660 Specifies whether the external program is a managed application
5661 which should be executed using a runtime engine, if configured.
5662 The default is <see langword="false" />.
5663 </summary>
5664 <value>
5665 <see langword="true" /> if the external program should be executed
5666 using a runtime engine; otherwise, <see langword="false" />.
5667 </value>
5668 </member>
5669 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Managed">
5670 <summary>
5671 Specifies whether the external program is a managed application
5672 which should be executed using a runtime engine, if configured.
5673 The default is <see langword="false" />.
5674 </summary>
5675 <value>
5676 <see langword="true" /> if the external program should be executed
5677 using a runtime engine; otherwise, <see langword="false" />.
5678 </value>
5679 </member>
5680 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputWriter">
5681 <summary>
5682 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which standard output
5683 messages of the external program will be written.
5684 </summary>
5685 <value>
5686 The <see cref="T:System.IO.TextWriter"/> to which standard output messages of
5687 the external program will be written.
5688 </value>
5689 <remarks>
5690 By default, standard output messages wil be written to the build log
5691 with level <see cref="F:NAnt.Core.Level.Info"/>.
5692 </remarks>
5693 </member>
5694 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ErrorWriter">
5695 <summary>
5696 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which error output
5697 of the external program will be written.
5698 </summary>
5699 <value>
5700 The <see cref="T:System.IO.TextWriter"/> to which error output of the external
5701 program will be written.
5702 </value>
5703 <remarks>
5704 By default, error output wil be written to the build log with level
5705 <see cref="F:NAnt.Core.Level.Warning"/>.
5706 </remarks>
5707 </member>
5708 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode">
5709 <summary>
5710 Gets the value that the process specified when it terminated.
5711 </summary>
5712 <value>
5713 The code that the associated process specified when it terminated,
5714 or <c>-1000</c> if the process could not be started or did not
5715 exit (in time).
5716 </value>
5717 </member>
5718 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProcessId">
5719 <summary>
5720 Gets the unique identifier for the spawned application.
5721 </summary>
5722 </member>
5723 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Spawn">
5724 <summary>
5725 Gets or sets a value indicating whether the application should be
5726 spawned. If you spawn an application, its output will not be logged
5727 by NAnt. The default is <see langword="false" />.
5728 </summary>
5729 </member>
5730 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.CommandLine">
5731 <summary>
5732 Gets the command-line arguments, separated by spaces.
5733 </summary>
5734 </member>
5735 <member name="M:NAnt.Core.Tasks.ExecTask.Initialize">
5736 <summary>
5737 Performs additional checks after the task has been initialized.
5738 </summary>
5739 <exception cref="T:NAnt.Core.BuildException"><see cref="P:NAnt.Core.Tasks.ExecTask.FileName"/> does not hold a valid file name.</exception>
5740 </member>
5741 <member name="M:NAnt.Core.Tasks.ExecTask.ExecuteTask">
5742 <summary>
5743 Executes the external program.
5744 </summary>
5745 </member>
5746 <member name="P:NAnt.Core.Tasks.ExecTask.FileName">
5747 <summary>
5748 The program to execute without command arguments.
5749 </summary>
5750 <remarks>
5751 The path will not be evaluated to a full path using the project
5752 base directory.
5753 </remarks>
5754 </member>
5755 <member name="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments">
5756 <summary>
5757 The command-line arguments for the program. These will be
5758 passed as is to the external program. When quoting is necessary,
5759 these must be explictly set as part of the value. Consider using
5760 nested <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"/> elements instead.
5761 </summary>
5762 </member>
5763 <member name="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet">
5764 <summary>
5765 Environment variables to pass to the program.
5766 </summary>
5767 </member>
5768 <member name="P:NAnt.Core.Tasks.ExecTask.WorkingDirectory">
5769 <summary>
5770 The directory in which the command will be executed.
5771 </summary>
5772 <value>
5773 The directory in which the command will be executed. The default
5774 is the project's base directory.
5775 </value>
5776 <remarks>
5777 <para>
5778 The working directory will be evaluated relative to the project's
5779 base directory if it is relative.
5780 </para>
5781 </remarks>
5782 </member>
5783 <member name="P:NAnt.Core.Tasks.ExecTask.ResultProperty">
5784 <summary>
5785 <para>
5786 The name of a property in which the exit code of the program should
5787 be stored. Only of interest if <see cref="P:NAnt.Core.Task.FailOnError"/> is
5788 <see langword="false"/>.
5789 </para>
5790 <para>
5791 If the exit code of the program is "-1000" then the program could
5792 not be started, or did not exit (in time).
5793 </para>
5794 </summary>
5795 </member>
5796 <member name="P:NAnt.Core.Tasks.ExecTask.UseRuntimeEngine">
5797 <summary>
5798 Specifies whether the external program should be executed using a
5799 runtime engine, if configured. The default is <see langword="false" />.
5800 </summary>
5801 <value>
5802 <see langword="true" /> if the external program should be executed
5803 using a runtime engine; otherwise, <see langword="false" />.
5804 </value>
5805 </member>
5806 <member name="P:NAnt.Core.Tasks.ExecTask.Managed">
5807 <summary>
5808 Specifies whether the external program is a managed application
5809 which should be executed using a runtime engine, if configured.
5810 The default is <see langword="false" />.
5811 </summary>
5812 <value>
5813 <see langword="true" /> if the external program should be executed
5814 using a runtime engine; otherwise, <see langword="false" />.
5815 </value>
5816 </member>
5817 <member name="P:NAnt.Core.Tasks.ExecTask.ProgramFileName">
5818 <summary>
5819 Gets the filename of the external program to start.
5820 </summary>
5821 <value>
5822 The filename of the external program.
5823 </value>
5824 </member>
5825 <member name="P:NAnt.Core.Tasks.ExecTask.ProgramArguments">
5826 <summary>
5827 Gets the command-line arguments for the external program.
5828 </summary>
5829 <value>
5830 The command-line arguments for the external program.
5831 </value>
5832 </member>
5833 <member name="P:NAnt.Core.Tasks.ExecTask.BaseDirectory">
5834 <summary>
5835 The directory the program is in.
5836 </summary>
5837 <remarks>
5838 <value>
5839 The directory the program is in. The default is the project's base
5840 directory.
5841 </value>
5842 <para>
5843 The basedir will be evaluated relative to the project's base
5844 directory if it is relative.
5845 </para>
5846 </remarks>
5847 </member>
5848 <member name="P:NAnt.Core.Tasks.ExecTask.Output">
5849 <summary>
5850 The file to which the standard output will be redirected.
5851 </summary>
5852 <remarks>
5853 By default, the standard output is redirected to the console.
5854 </remarks>
5855 </member>
5856 <member name="P:NAnt.Core.Tasks.ExecTask.OutputAppend">
5857 <summary>
5858 Gets or sets a value indicating whether output should be appended
5859 to the output file. The default is <see langword="false"/>.
5860 </summary>
5861 <value>
5862 <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExecTask.Output"/>;
5863 otherwise, <see langword="false"/>.
5864 </value>
5865 </member>
5866 <member name="P:NAnt.Core.Tasks.ExecTask.Spawn">
5867 <summary>
5868 Gets or sets a value indicating whether the application should be
5869 spawned. If you spawn an application, its output will not be logged
5870 by NAnt. The default is <see langword="false" />.
5871 </summary>
5872 </member>
5873 <member name="P:NAnt.Core.Tasks.ExecTask.ProcessIdProperty">
5874 <summary>
5875 The name of a property in which the unique identifier of the spawned
5876 application should be stored. Only of interest if <see cref="P:NAnt.Core.Tasks.ExecTask.Spawn"/>
5877 is <see langword="true"/>.
5878 </summary>
5879 </member>
5880 <member name="T:NAnt.Core.Tasks.FailTask">
5881 <summary>
5882 Exits the current build by throwing a <see cref="T:NAnt.Core.BuildException"/>,
5883 optionally printing additional information.
5884 </summary>
5885 <remarks>
5886 <para>
5887 The cause of the build failure can be specified using the <see cref="P:NAnt.Core.Tasks.FailTask.Message"/>
5888 attribute or as inline content.
5889 </para>
5890 <para>
5891 Macros in the message will be expanded.
5892 </para>
5893 </remarks>
5894 <example>
5895 <para>Exits the current build without giving further information.</para>
5896 <code>
5897 <![CDATA[
5898 <fail />
5899 ]]>
5900 </code>
5901 </example>
5902 <example>
5903 <para>Exits the current build and writes a message to the build log.</para>
5904 <code>
5905 <![CDATA[
5906 <fail message="Something wrong here." />
5907 ]]>
5908 </code>
5909 </example>
5910 <example>
5911 <para>Functionally equivalent to the previous example.</para>
5912 <code>
5913 <![CDATA[
5914 <fail>Something wrong here.</fail>
5915 ]]>
5916 </code>
5917 </example>
5918 </member>
5919 <member name="P:NAnt.Core.Tasks.FailTask.Message">
5920 <summary>
5921 A message giving further information on why the build exited.
5922 </summary>
5923 <remarks>
5924 Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive.
5925 </remarks>
5926 </member>
5927 <member name="P:NAnt.Core.Tasks.FailTask.Contents">
5928 <summary>
5929 Gets or sets the inline content that should be output in the build
5930 log, giving further information on why the build exited.
5931 </summary>
5932 <value>
5933 The inline content that should be output in the build log.
5934 </value>
5935 <remarks>
5936 Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive.
5937 </remarks>
5938 </member>
5939 <member name="T:NAnt.Core.Tasks.GetTask">
5940 <summary>
5941 Gets a particular file from a URL source.
5942 </summary>
5943 <remarks>
5944 <para>
5945 Options include verbose reporting and timestamp based fetches.
5946 </para>
5947 <para>
5948 Currently, only HTTP and UNC protocols are supported. FTP support may
5949 be added when more pluggable protocols are added to the System.Net
5950 assembly.
5951 </para>
5952 <para>
5953 The <see cref="P:NAnt.Core.Tasks.GetTask.UseTimeStamp"/> option enables you to control downloads
5954 so that the remote file is only fetched if newer than the local copy.
5955 If there is no local copy, the download always takes place. When a file
5956 is downloaded, the timestamp of the downloaded file is set to the remote
5957 timestamp.
5958 </para>
5959 <note>
5960 This timestamp facility only works on downloads using the HTTP protocol.
5961 </note>
5962 </remarks>
5963 <example>
5964 <para>
5965 Gets the index page of the NAnt home page, and stores it in the file
5966 <c>help/index.html</c> relative to the project base directory.
5967 </para>
5968 <code>
5969 <![CDATA[
5970 <get src="http://nant.sourceforge.org/" dest="help/index.html" />
5971 ]]>
5972 </code>
5973 </example>
5974 <example>
5975 <para>
5976 Gets the index page of a secured web site using the given credentials,
5977 while connecting using the specified password-protected proxy server.
5978 </para>
5979 <code>
5980 <![CDATA[
5981 <get src="http://password.protected.site/index.html" dest="secure/index.html">
5982 <credentials username="user" password="guess" domain="mydomain" />
5983 <proxy host="proxy.company.com" port="8080">
5984 <credentials username="proxyuser" password="dunno" />
5985 </proxy>
5986 </get>
5987 ]]>
5988 </code>
5989 </example>
5990 </member>
5991 <member name="M:NAnt.Core.Tasks.GetTask.Initialize">
5992 <summary>
5993 Initializes task and ensures the supplied attributes are valid.
5994 </summary>
5995 </member>
5996 <member name="M:NAnt.Core.Tasks.GetTask.ExecuteTask">
5997 <summary>
5998 This is where the work is done
5999 </summary>
6000 </member>
6001 <member name="M:NAnt.Core.Tasks.GetTask.TouchFile(System.IO.FileInfo,System.DateTime)">
6002 <summary>
6003 Sets the timestamp of a given file to a specified time.
6004 </summary>
6005 </member>
6006 <member name="P:NAnt.Core.Tasks.GetTask.Source">
6007 <summary>
6008 The URL from which to retrieve a file.
6009 </summary>
6010 </member>
6011 <member name="P:NAnt.Core.Tasks.GetTask.DestinationFile">
6012 <summary>
6013 The file where to store the retrieved file.
6014 </summary>
6015 </member>
6016 <member name="P:NAnt.Core.Tasks.GetTask.HttpProxy">
6017 <summary>
6018 If inside a firewall, proxy server/port information
6019 Format: {proxy server name}:{port number}
6020 Example: proxy.mycompany.com:8080
6021 </summary>
6022 </member>
6023 <member name="P:NAnt.Core.Tasks.GetTask.Proxy">
6024 <summary>
6025 The network proxy to use to access the Internet resource.
6026 </summary>
6027 </member>
6028 <member name="P:NAnt.Core.Tasks.GetTask.Credentials">
6029 <summary>
6030 The network credentials used for authenticating the request with
6031 the Internet resource.
6032 </summary>
6033 </member>
6034 <member name="P:NAnt.Core.Tasks.GetTask.IgnoreErrors">
6035 <summary>
6036 Log errors but don't treat as fatal. The default is <see langword="false" />.
6037 </summary>
6038 </member>
6039 <member name="P:NAnt.Core.Tasks.GetTask.UseTimeStamp">
6040 <summary>
6041 Conditionally download a file based on the timestamp of the local
6042 copy. HTTP only. The default is <see langword="false" />.
6043 </summary>
6044 </member>
6045 <member name="P:NAnt.Core.Tasks.GetTask.Timeout">
6046 <summary>
6047 The length of time, in milliseconds, until the request times out.
6048 The default is <c>100000</c> milliseconds.
6049 </summary>
6050 </member>
6051 <member name="P:NAnt.Core.Tasks.GetTask.Certificates">
6052 <summary>
6053 The security certificates to associate with the request.
6054 </summary>
6055 </member>
6056 <member name="T:NAnt.Core.Tasks.IfTask">
6057 <summary>
6058 Checks the conditional attributes and executes the children if
6059 <see langword="true"/>.
6060 </summary>
6061 <remarks>
6062 <para>
6063 If no conditions are checked, all child tasks are executed.
6064 </para>
6065 <para>
6066 If more than one attribute is used, they are &&'d. The first
6067 to fail stops the check.
6068 </para>
6069 <para>
6070 The order of condition evaluation is, <see cref="P:NAnt.Core.Tasks.IfTask.TargetNameExists"/>,
6071 <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameExists"/>, <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue"/>,
6072 <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>.
6073 </para>
6074 <note>
6075 instead of using the deprecated attributes, we advise you to use the
6076 following functions in combination with the <see cref="P:NAnt.Core.Tasks.IfTask.Test"/>
6077 attribute:
6078 </note>
6079 <list type="table">
6080 <listheader>
6081 <term>Function</term>
6082 <description>Description</description>
6083 </listheader>
6084 <item>
6085 <term><see cref="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)"/></term>
6086 <description>Checks whether the specified property exists.</description>
6087 </item>
6088 <item>
6089 <term><see cref="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)"/></term>
6090 <description>Checks whether the specified target exists.</description>
6091 </item>
6092 </list>
6093 </remarks>
6094 <example>
6095 <para>Tests the value of a property using expressions.</para>
6096 <code>
6097 <![CDATA[
6098 <if test="${build.configuration=='release'}">
6099 <echo>Build release configuration</echo>
6100 </if>
6101 ]]>
6102 </code>
6103 </example>
6104 <example>
6105 <para>Tests the the output of a function.</para>
6106 <code>
6107 <![CDATA[
6108 <if test="${not file::exists(filename) or file::get-length(filename) = 0}">
6109 <echo message="The version file ${filename} doesn't exist or is empty!" />
6110 </if>
6111 ]]>
6112 </code>
6113 </example>
6114 <example>
6115 <para><c>(Deprecated)</c> Check that a target exists.</para>
6116 <code>
6117 <![CDATA[
6118 <target name="myTarget" />
6119 <if targetexists="myTarget">
6120 <echo message="myTarget exists" />
6121 </if>
6122 ]]>
6123 </code>
6124 </example>
6125 <example>
6126 <para><c>(Deprecated)</c> Check existence of a property.</para>
6127 <code>
6128 <![CDATA[
6129 <if propertyexists="myProp">
6130 <echo message="myProp Exists. Value='${myProp}'" />
6131 </if>
6132 ]]>
6133 </code>
6134 </example>
6135 <example>
6136 <para><c>(Deprecated)</c> Check that a property value is true.</para>
6137 <code>
6138 <![CDATA[
6139 <if propertytrue="myProp">
6140 <echo message="myProp is true. Value='${myProp}'" />
6141 </if>
6142 ]]>
6143 </code>
6144 </example>
6145 <example>
6146 <para>
6147 <c>(Deprecated)</c> Check that a property exists and is <see langword="true"/>
6148 (uses multiple conditions).
6149 </para>
6150 <code>
6151 <![CDATA[
6152 <if propertyexists="myProp" propertytrue="myProp">
6153 <echo message="myProp is '${myProp}'" />
6154 </if>
6155 ]]>
6156 </code>
6157 <para>which is the same as</para>
6158 <code>
6159 <![CDATA[
6160 <if propertyexists="myProp">
6161 <if propertytrue="myProp">
6162 <echo message="myProp is '${myProp}'" />
6163 </if>
6164 </if>
6165 ]]>
6166 </code>
6167 </example>
6168 <example>
6169 <para>
6170 <c>(Deprecated)</c> Check file dates. If <c>myfile.dll</c> is uptodate,
6171 then do stuff.
6172 </para>
6173 <code>
6174 <![CDATA[
6175 <if uptodatefile="myfile.dll" comparefile="myfile.cs">
6176 <echo message="myfile.dll is newer/same-date as myfile.cs" />
6177 </if>
6178 ]]>
6179 </code>
6180 <para>or</para>
6181 <code>
6182 <![CDATA[
6183 <if uptodatefile="myfile.dll">
6184 <comparefiles>
6185 <include name="*.cs" />
6186 </comparefiles>
6187 <echo message="myfile.dll is newer/same-date as myfile.cs" />
6188 </if>
6189 ]]>
6190 </code>
6191 <para>or</para>
6192 <code>
6193 <![CDATA[
6194 <if>
6195 <uptodatefiles>
6196 <include name="myfile.dll" />
6197 </uptodatefiles>
6198 <comparefiles>
6199 <include name="*.cs" />
6200 </comparefiles>
6201 <echo message="myfile.dll is newer/same-date as myfile.cs" />
6202 </if>
6203 ]]>
6204 </code>
6205 </example>
6206 </member>
6207 <member name="T:NAnt.Core.TaskContainer">
6208 <summary>
6209 Executes embedded tasks in the order in which they are defined.
6210 </summary>
6211 </member>
6212 <member name="M:NAnt.Core.TaskContainer.Initialize">
6213 <summary>
6214 Automatically exclude build elements that are defined on the task
6215 from things that get executed, as they are evaluated normally during
6216 XML task initialization.
6217 </summary>
6218 </member>
6219 <member name="M:NAnt.Core.TaskContainer.ExecuteChildTasks">
6220 <summary>
6221 Creates and executes the embedded (child XML nodes) elements.
6222 </summary>
6223 <remarks>
6224 Skips any element defined by the host <see cref="T:NAnt.Core.Task"/> that has
6225 a <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> defined.
6226 </remarks>
6227 </member>
6228 <member name="P:NAnt.Core.TaskContainer.CustomXmlProcessing">
6229 <summary>
6230 Gets a value indicating whether the element is performing additional
6231 processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
6232 initialize the element.
6233 </summary>
6234 <value>
6235 <see langword="true"/>, as a <see cref="T:NAnt.Core.TaskContainer"/> is
6236 responsable for creating tasks from the nested build elements.
6237 </value>
6238 </member>
6239 <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFile">
6240 <summary>
6241 The file to compare if uptodate.
6242 </summary>
6243 </member>
6244 <member name="P:NAnt.Core.Tasks.IfTask.CompareFile">
6245 <summary>
6246 The file to check against for the uptodate file.
6247 </summary>
6248 </member>
6249 <member name="P:NAnt.Core.Tasks.IfTask.CompareFiles">
6250 <summary>
6251 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the comparison files for
6252 the <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>(s) check.
6253 </summary>
6254 </member>
6255 <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFiles">
6256 <summary>
6257 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the uptodate files for
6258 the <see cref="P:NAnt.Core.Tasks.IfTask.CompareFile"/>(s) check.
6259 </summary>
6260 </member>
6261 <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue">
6262 <summary>
6263 Used to test whether a property is true.
6264 </summary>
6265 </member>
6266 <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameExists">
6267 <summary>
6268 Used to test whether a property exists.
6269 </summary>
6270 </member>
6271 <member name="P:NAnt.Core.Tasks.IfTask.TargetNameExists">
6272 <summary>
6273 Used to test whether a target exists.
6274 </summary>
6275 </member>
6276 <member name="P:NAnt.Core.Tasks.IfTask.Test">
6277 <summary>
6278 Used to test arbitrary boolean expression.
6279 </summary>
6280 </member>
6281 <member name="T:NAnt.Core.Tasks.IfNotTask">
6282 <summary>
6283 The opposite of the <c>if</c> task.
6284 </summary>
6285 <example>
6286 <para>Check that a property does not exist.</para>
6287 <code>
6288 <![CDATA[
6289 <ifnot propertyexists="myProp">
6290 <echo message="myProp does not exist."/>
6291 </if>
6292 ]]>
6293 </code>
6294 <para>Check that a property value is not true.</para>
6295 <code>
6296 <![CDATA[
6297 <ifnot propertytrue="myProp">
6298 <echo message="myProp is not true."/>
6299 </if>
6300 ]]>
6301 </code>
6302 </example>
6303 <example>
6304 <para>Check that a target does not exist.</para>
6305 <code>
6306 <![CDATA[
6307 <ifnot targetexists="myTarget">
6308 <echo message="myTarget does not exist."/>
6309 </if>
6310 ]]>
6311 </code>
6312 </example>
6313 </member>
6314 <member name="T:NAnt.Core.Tasks.IncludeTask">
6315 <summary>
6316 Includes an external build file.
6317 </summary>
6318 <remarks>
6319 <para>
6320 This task is used to break your build file into smaller chunks. You
6321 can load a partial build file and have it included into the build file.
6322 </para>
6323 <note>
6324 Any global (project level) tasks in the included build file are executed
6325 when this task is executed. Tasks in target elements are only executed
6326 if that target is executed.
6327 </note>
6328 <note>
6329 The project element attributes are ignored.
6330 </note>
6331 <note>
6332 This task can only be in the global (project level) section of the
6333 build file.
6334 </note>
6335 <note>
6336 This task can only include files from the file system.
6337 </note>
6338 </remarks>
6339 <example>
6340 <para>
6341 Include a task that fetches the project version from the
6342 <c>GetProjectVersion.include</c> build file.
6343 </para>
6344 <code>
6345 <![CDATA[
6346 <include buildfile="GetProjectVersion.include" />
6347 ]]>
6348 </code>
6349 </example>
6350 </member>
6351 <member name="F:NAnt.Core.Tasks.IncludeTask._includedFileNames">
6352 <summary>
6353 Used to check for recursived includes.
6354 </summary>
6355 </member>
6356 <member name="M:NAnt.Core.Tasks.IncludeTask.Initialize">
6357 <summary>
6358 Verifies parameters.
6359 </summary>
6360 </member>
6361 <member name="P:NAnt.Core.Tasks.IncludeTask.BuildFileName">
6362 <summary>
6363 Build file to include.
6364 </summary>
6365 </member>
6366 <member name="T:NAnt.Core.Tasks.LoadFileTask">
6367 <summary>
6368 Load a text file into a single property.
6369 </summary>
6370 <remarks>
6371 <para>
6372 Unless an encoding is specified, the encoding associated with the
6373 system's current ANSI code page is used.
6374 </para>
6375 <para>
6376 An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
6377 file is automatically recognized, if the file starts with the appropriate
6378 byte order marks.
6379 </para>
6380 </remarks>
6381 <example>
6382 <para>
6383 Load file <c>message.txt</c> into property "message".
6384 </para>
6385 <code>
6386 <![CDATA[
6387 <loadfile
6388 file="message.txt"
6389 property="message" />
6390 ]]>
6391 </code>
6392 </example>
6393 <example>
6394 <para>
6395 Load a file using the "latin-1" encoding.
6396 </para>
6397 <code>
6398 <![CDATA[
6399 <loadfile
6400 file="loadfile.xml"
6401 property="encoded-file"
6402 encoding="iso-8859-1" />
6403 ]]>
6404 </code>
6405 </example>
6406 <example>
6407 <para>
6408 Load a file, replacing all <c>@NOW@</c> tokens with the current
6409 date/time.
6410 </para>
6411 <code>
6412 <![CDATA[
6413 <loadfile file="token.txt" property="token-file">
6414 <filterchain>
6415 <replacetokens>
6416 <token key="NOW" value="${datetime::now()}" />
6417 </replacetokens>
6418 </filterchain>
6419 </loadfile>
6420 ]]>
6421 </code>
6422 </example>
6423 </member>
6424 <member name="P:NAnt.Core.Tasks.LoadFileTask.File">
6425 <summary>
6426 The file to load.
6427 </summary>
6428 </member>
6429 <member name="P:NAnt.Core.Tasks.LoadFileTask.Property">
6430 <summary>
6431 The name of the property to save the content to.
6432 </summary>
6433 </member>
6434 <member name="P:NAnt.Core.Tasks.LoadFileTask.Encoding">
6435 <summary>
6436 The encoding to use when loading the file. The default is the encoding
6437 associated with the system's current ANSI code page.
6438 </summary>
6439 </member>
6440 <member name="P:NAnt.Core.Tasks.LoadFileTask.FilterChain">
6441 <summary>
6442 The filterchain definition to use.
6443 </summary>
6444 </member>
6445 <member name="T:NAnt.Core.Tasks.LoadTasksTask">
6446 <summary>
6447 Loads tasks form a given assembly or all assemblies in a given directory
6448 or <see cref="T:NAnt.Core.Types.FileSet"/>.
6449 </summary>
6450 <example>
6451 <para>
6452 Load tasks from a single assembly.
6453 </para>
6454 <code>
6455 <![CDATA[
6456 <loadtasks assembly="c:foo\NAnt.Contrib.Tasks.dll" />
6457 ]]>
6458 </code>
6459 </example>
6460 <example>
6461 <para>
6462 Scan a single directory for task assemblies.
6463 </para>
6464 <code>
6465 <![CDATA[
6466 <loadtasks path="c:\foo" />
6467 ]]>
6468 </code>
6469 </example>
6470 <example>
6471 <para>
6472 Use a <see cref="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet"/> containing both a directory and an
6473 assembly.
6474 </para>
6475 <code>
6476 <![CDATA[
6477 <loadtasks>
6478 <fileset>
6479 <include name="C:\cvs\NAntContrib\build" />
6480 <include name="C:\cvs\NAntContrib\build\NAnt.Contrib.Tasks.dll" />
6481 </fileset>
6482 </loadtasks>
6483 ]]>
6484 </code>
6485 </example>
6486 </member>
6487 <member name="M:NAnt.Core.Tasks.LoadTasksTask.ExecuteTask">
6488 <summary>
6489 Executes the Load Tasks task.
6490 </summary>
6491 <exception cref="T:NAnt.Core.BuildException">Specified assembly or path does not exist.</exception>
6492 </member>
6493 <member name="M:NAnt.Core.Tasks.LoadTasksTask.Initialize">
6494 <summary>
6495 Validates the attributes.
6496 </summary>
6497 <exception cref="T:NAnt.Core.BuildException">Both <see cref="P:NAnt.Core.Tasks.LoadTasksTask.AssemblyPath"/> and <see cref="P:NAnt.Core.Tasks.LoadTasksTask.Path"/> are set.</exception>
6498 </member>
6499 <member name="P:NAnt.Core.Tasks.LoadTasksTask.AssemblyPath">
6500 <summary>
6501 An assembly to load tasks from.
6502 </summary>
6503 </member>
6504 <member name="P:NAnt.Core.Tasks.LoadTasksTask.Path">
6505 <summary>
6506 A directory to scan for task assemblies.
6507 </summary>
6508 </member>
6509 <member name="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet">
6510 <summary>
6511 Used to select which directories or individual assemblies to scan.
6512 </summary>
6513 </member>
6514 <member name="T:NAnt.Core.Tasks.LoopTask">
6515 <summary>
6516 Loops over a set of items.
6517 </summary>
6518 <remarks>
6519 <para>
6520 Can loop over files in directory, lines in a file, etc.
6521 </para>
6522 <para>
6523 The property value is stored before the loop is done, and restored
6524 when the loop is finished.
6525 </para>
6526 <para>
6527 The property is returned to its normal value once it is used. Read-only
6528 parameters cannot be overridden in this loop.
6529 </para>
6530 </remarks>
6531 <example>
6532 <para>Loops over the files in <c>c:\</c>.</para>
6533 <code>
6534 <![CDATA[
6535 <foreach item="File" in="c:\" property="filename">
6536 <echo message="${filename}" />
6537 </foreach>
6538 ]]>
6539 </code>
6540 </example>
6541 <example>
6542 <para>Loops over all files in the project directory.</para>
6543 <code>
6544 <![CDATA[
6545 <foreach item="File" property="filename">
6546 <in>
6547 <items>
6548 <include name="**" />
6549 </items>
6550 </in>
6551 <do>
6552 <echo message="${filename}" />
6553 </do>
6554 </foreach>
6555 ]]>
6556 </code>
6557 </example>
6558 <example>
6559 <para>Loops over the folders in <c>c:\</c>.</para>
6560 <code>
6561 <![CDATA[
6562 <foreach item="Folder" in="c:\" property="foldername">
6563 <echo message="${foldername}" />
6564 </foreach>
6565 ]]>
6566 </code>
6567 </example>
6568 <example>
6569 <para>Loops over all folders in the project directory.</para>
6570 <code>
6571 <![CDATA[
6572 <foreach item="Folder" property="foldername">
6573 <in>
6574 <items>
6575 <include name="**" />
6576 </items>
6577 </in>
6578 <do>
6579 <echo message="${foldername}" />
6580 </do>
6581 </foreach>
6582 ]]>
6583 </code>
6584 </example>
6585 <example>
6586 <para>Loops over a list.</para>
6587 <code>
6588 <![CDATA[
6589 <foreach item="String" in="1 2,3" delim=" ," property="count">
6590 <echo message="${count}" />
6591 </foreach>
6592 ]]>
6593 </code>
6594 </example>
6595 <example>
6596 <para>
6597 Loops over lines in the file <c>properties.csv</c>, where each line
6598 is of the format name,value.
6599 </para>
6600 <code>
6601 <![CDATA[
6602 <foreach item="Line" in="properties.csv" delim="," property="x,y">
6603 <echo message="Read pair ${x}=${y}" />
6604 </foreach>
6605 ]]>
6606 </code>
6607 </example>
6608 </member>
6609 <member name="P:NAnt.Core.Tasks.LoopTask.Property">
6610 <summary>
6611 The NAnt property name(s) that should be used for the current
6612 iterated item.
6613 </summary>
6614 <remarks>
6615 If specifying multiple properties, separate them with a comma.
6616 </remarks>
6617 </member>
6618 <member name="P:NAnt.Core.Tasks.LoopTask.ItemType">
6619 <summary>
6620 The type of iteration that should be done.
6621 </summary>
6622 </member>
6623 <member name="P:NAnt.Core.Tasks.LoopTask.TrimType">
6624 <summary>
6625 The type of whitespace trimming that should be done. The default
6626 is <see cref="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None"/>.
6627 </summary>
6628 </member>
6629 <member name="P:NAnt.Core.Tasks.LoopTask.Source">
6630 <summary>
6631 The source of the iteration.
6632 </summary>
6633 </member>
6634 <member name="P:NAnt.Core.Tasks.LoopTask.Delimiter">
6635 <summary>
6636 The deliminator char.
6637 </summary>
6638 </member>
6639 <member name="P:NAnt.Core.Tasks.LoopTask.InElement">
6640 <summary>
6641 Stuff to operate in. Just like the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/>
6642 attribute, but supports more complicated things like a <see cref="T:NAnt.Core.Types.FileSet"/>
6643 and such.
6644 <note>
6645 Please remove the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/> attribute if you
6646 are using this element.
6647 </note>
6648 </summary>
6649 </member>
6650 <member name="P:NAnt.Core.Tasks.LoopTask.StuffToDo">
6651 <summary>
6652 Tasks to execute for each matching item.
6653 </summary>
6654 </member>
6655 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None">
6656 <summary>
6657 Do not remove any white space characters.
6658 </summary>
6659 </member>
6660 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.End">
6661 <summary>
6662 Remove all white space characters from the end of the current
6663 item.
6664 </summary>
6665 </member>
6666 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Start">
6667 <summary>
6668 Remove all white space characters from the beginning of the
6669 current item.
6670 </summary>
6671 </member>
6672 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Both">
6673 <summary>
6674 Remove all white space characters from the beginning and end of
6675 the current item.
6676 </summary>
6677 </member>
6678 <member name="T:NAnt.Core.Tasks.MailTask">
6679 <summary>
6680 Sends an SMTP message.
6681 </summary>
6682 <remarks>
6683 <para>
6684 Text and text files to include in the message body may be specified as
6685 well as binary attachments.
6686 </para>
6687 </remarks>
6688 <example>
6689 <para>
6690 Sends an email from <c>nant@sourceforge.net</c> to three recipients
6691 with a subject about the attachments. The body of the message will be
6692 the combined contents of all <c>.txt</c> files in the base directory.
6693 All zip files in the base directory will be included as attachments.
6694 The message will be sent using the <c>smtpserver.anywhere.com</c> SMTP
6695 server.
6696 </para>
6697 <code>
6698 <![CDATA[
6699 <mail
6700 from="nant@sourceforge.net"
6701 tolist="recipient1@sourceforge.net"
6702 cclist="recipient2@sourceforge.net"
6703 bcclist="recipient3@sourceforge.net"
6704 subject="Msg 7: With attachments"
6705 mailhost="smtpserver.anywhere.com">
6706 <files>
6707 <include name="*.txt" />
6708 </files>
6709 <attachments>
6710 <include name="*.zip" />
6711 </attachments>
6712 </mail>
6713 ]]>
6714 </code>
6715 </example>
6716 </member>
6717 <member name="M:NAnt.Core.Tasks.MailTask.Initialize">
6718 <summary>
6719 Initializes task and ensures the supplied attributes are valid.
6720 </summary>
6721 </member>
6722 <member name="M:NAnt.Core.Tasks.MailTask.ExecuteTask">
6723 <summary>
6724 This is where the work is done.
6725 </summary>
6726 </member>
6727 <member name="M:NAnt.Core.Tasks.MailTask.ReadFile(System.String)">
6728 <summary>
6729 Reads a text file and returns the content
6730 in a string.
6731 </summary>
6732 <param name="filename">The file to read content of.</param>
6733 <returns>
6734 The content of the specified file.
6735 </returns>
6736 </member>
6737 <member name="P:NAnt.Core.Tasks.MailTask.From">
6738 <summary>
6739 Email address of sender.
6740 </summary>
6741 </member>
6742 <member name="P:NAnt.Core.Tasks.MailTask.ToList">
6743 <summary>
6744 Semicolon-separated list of recipient email addresses.
6745 </summary>
6746 </member>
6747 <member name="P:NAnt.Core.Tasks.MailTask.CcList">
6748 <summary>
6749 Semicolon-separated list of CC: recipient email addresses.
6750 </summary>
6751 </member>
6752 <member name="P:NAnt.Core.Tasks.MailTask.BccList">
6753 <summary>
6754 Semicolon-separated list of BCC: recipient email addresses.
6755 </summary>
6756 </member>
6757 <member name="P:NAnt.Core.Tasks.MailTask.Mailhost">
6758 <summary>
6759 Host name of mail server. The default is <c>localhost</c>.
6760 </summary>
6761 </member>
6762 <member name="P:NAnt.Core.Tasks.MailTask.Message">
6763 <summary>
6764 Text to send in body of email message.
6765 </summary>
6766 </member>
6767 <member name="P:NAnt.Core.Tasks.MailTask.Subject">
6768 <summary>
6769 Text to send in subject line of email message.
6770 </summary>
6771 </member>
6772 <member name="P:NAnt.Core.Tasks.MailTask.Format">
6773 <summary>
6774 Format of the message. The default is <see cref="F:System.Web.Mail.MailFormat.Text"/>.
6775 </summary>
6776 </member>
6777 <member name="P:NAnt.Core.Tasks.MailTask.Files">
6778 <summary>
6779 Files that are transmitted as part of the body of the email message.
6780 </summary>
6781 </member>
6782 <member name="P:NAnt.Core.Tasks.MailTask.Attachments">
6783 <summary>
6784 Attachments that are transmitted with the message.
6785 </summary>
6786 </member>
6787 <member name="T:NAnt.Core.Tasks.MkDirTask">
6788 <summary>
6789 Creates a directory and any non-existent parent directory if necessary.
6790 </summary>
6791 <example>
6792 <para>Create the directory <c>build</c>.</para>
6793 <code>
6794 <![CDATA[
6795 <mkdir dir="build" />
6796 ]]>
6797 </code>
6798 </example>
6799 <example>
6800 <para>Create the directory tree <c>one/two/three</c>.</para>
6801 <code>
6802 <![CDATA[
6803 <mkdir dir="one/two/three" />
6804 ]]>
6805 </code>
6806 </example>
6807 </member>
6808 <member name="M:NAnt.Core.Tasks.MkDirTask.ExecuteTask">
6809 <summary>
6810 Creates the directory specified by the <see cref="P:NAnt.Core.Tasks.MkDirTask.Dir"/> property.
6811 </summary>
6812 <exception cref="T:NAnt.Core.BuildException">The directory could not be created.</exception>
6813 </member>
6814 <member name="P:NAnt.Core.Tasks.MkDirTask.Dir">
6815 <summary>
6816 The directory to create.
6817 </summary>
6818 </member>
6819 <member name="T:NAnt.Core.Tasks.MoveTask">
6820 <summary>
6821 Moves a file or set of files to a new file or directory.
6822 </summary>
6823 <remarks>
6824 <para>
6825 Files are only moved if the source file is newer than the destination
6826 file, or if the destination file does not exist. However, you can
6827 explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/>
6828 attribute.
6829 </para>
6830 <para>
6831 A <see cref="T:NAnt.Core.Types.FileSet"/> can be used to select files to move. To use
6832 a <see cref="T:NAnt.Core.Types.FileSet"/>, the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/>
6833 attribute must be set.
6834 </para>
6835 <h3>Encoding</h3>
6836 <para>
6837 Unless an encoding is specified, the encoding associated with the
6838 system's current ANSI code page is used.
6839 </para>
6840 <para>
6841 An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
6842 file is automatically recognized, if the file starts with the
6843 appropriate byte order marks.
6844 </para>
6845 <note>
6846 If you employ filters in your move operation, you should limit the
6847 move to text files. Binary files will be corrupted by the move
6848 operation.
6849 </note>
6850 </remarks>
6851 <example>
6852 <para>
6853 Move a single file while changing its encoding from "latin1" to
6854 "utf-8".
6855 </para>
6856 <code>
6857 <![CDATA[
6858 <move
6859 file="myfile.txt"
6860 tofile="mycopy.txt"
6861 inputencoding="latin1"
6862 outputencoding="utf-8" />
6863 ]]>
6864 </code>
6865 </example>
6866 <example>
6867 <para>Move a set of files.</para>
6868 <code>
6869 <![CDATA[
6870 <move todir="${build.dir}">
6871 <fileset basedir="bin">
6872 <include name="*.dll" />
6873 </fileset>
6874 </move>
6875 ]]>
6876 </code>
6877 </example>
6878 <example>
6879 <para>
6880 Move a set of files to a directory, replacing <c>@TITLE@</c> with
6881 "Foo Bar" in all files.
6882 </para>
6883 <code>
6884 <![CDATA[
6885 <move todir="../backup/dir">
6886 <fileset basedir="src_dir">
6887 <include name="**/*" />
6888 </fileset>
6889 <filterchain>
6890 <replacetokens>
6891 <token key="TITLE" value="Foo Bar" />
6892 </replacetokens>
6893 </filterchain>
6894 </move>
6895 ]]>
6896 </code>
6897 </example>
6898 </member>
6899 <member name="M:NAnt.Core.Tasks.MoveTask.DoFileOperations">
6900 <summary>
6901 Actually does the file moves.
6902 </summary>
6903 </member>
6904 <member name="P:NAnt.Core.Tasks.MoveTask.SourceFile">
6905 <summary>
6906 The file to move.
6907 </summary>
6908 </member>
6909 <member name="P:NAnt.Core.Tasks.MoveTask.ToFile">
6910 <summary>
6911 The file to move to.
6912 </summary>
6913 </member>
6914 <member name="P:NAnt.Core.Tasks.MoveTask.ToDirectory">
6915 <summary>
6916 The directory to move to.
6917 </summary>
6918 </member>
6919 <member name="P:NAnt.Core.Tasks.MoveTask.CopyFileSet">
6920 <summary>
6921 Used to select the files to move. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
6922 the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/> attribute must be set.
6923 </summary>
6924 </member>
6925 <member name="P:NAnt.Core.Tasks.MoveTask.Flatten">
6926 <summary>
6927 Ignore directory structure of source directory, move all files into
6928 a single directory, specified by the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/>
6929 attribute. The default is <see langword="false"/>.
6930 </summary>
6931 </member>
6932 <member name="P:NAnt.Core.Tasks.MoveTask.Filters">
6933 <summary>
6934 Chain of filters used to alter the file's content as it is moved.
6935 </summary>
6936 </member>
6937 <member name="T:NAnt.Core.Tasks.NAntSchemaTask">
6938 <summary>
6939 Creates an XSD File for all available tasks.
6940 </summary>
6941 <remarks>
6942 <para>
6943 This can be used in conjuntion with the command-line option to do XSD
6944 Schema validation on the build file.
6945 </para>
6946 </remarks>
6947 <example>
6948 <para>Creates a <c>NAnt.xsd</c> file in the current project directory.</para>
6949 <code>
6950 <![CDATA[
6951 <nantschema output="NAnt.xsd" />
6952 ]]>
6953 </code>
6954 </example>
6955 </member>
6956 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.WriteSchema(System.IO.Stream,System.Type[],System.Type[],System.String)">
6957 <summary>
6958 Creates a NAnt Schema for given types
6959 </summary>
6960 <param name="stream">The output stream to save the schema to. If <see langword="null" />, writing is ignored, no exception generated.</param>
6961 <param name="tasks">The list of tasks to generate XML Schema for.</param>
6962 <param name="dataTypes">The list of datatypes to generate XML Schema for.</param>
6963 <param name="targetNS">The target namespace to output.</param>
6964 <returns>The new NAnt Schema.</returns>
6965 </member>
6966 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdAttribute(System.String,System.Boolean)">
6967 <summary>
6968 Creates a new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.
6969 </summary>
6970 <param name="name">The name of the attribute.</param>
6971 <param name="required">Value indicating whether the attribute should be required.</param>
6972 <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.</returns>
6973 </member>
6974 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdSequence(System.Decimal,System.Decimal)">
6975 <summary>
6976 Creates a new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.
6977 </summary>
6978 <param name="min">The minimum value to allow for this choice</param>
6979 <param name="max">The maximum value to allow, Decimal.MaxValue sets it to 'unbound'</param>
6980 <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.</returns>
6981 </member>
6982 <member name="P:NAnt.Core.Tasks.NAntSchemaTask.OutputFile">
6983 <summary>
6984 The name of the output file to which the XSD should be written.
6985 </summary>
6986 </member>
6987 <member name="P:NAnt.Core.Tasks.NAntSchemaTask.TargetNamespace">
6988 <summary>
6989 The target namespace for the output. Defaults to "http://tempuri.org/nant-donotuse.xsd"
6990 </summary>
6991 </member>
6992 <member name="P:NAnt.Core.Tasks.NAntSchemaTask.ForType">
6993 <summary>
6994 The <see cref="T:System.Type"/> for which an XSD should be created. If not
6995 specified, an XSD will be created for all available tasks.
6996 </summary>
6997 </member>
6998 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator.#ctor(System.Type[],System.Type[],System.String)">
6999 <summary>
7000 Creates a new instance of the <see cref="T:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator"/>
7001 class.
7002 </summary>
7003 <param name="tasks">Tasks for which a schema should be generated.</param>
7004 <param name="dataTypes">Data Types for which a schema should be generated.</param>
7005 <param name="targetNS">The namespace to use.
7006 <example> http://tempuri.org/nant.xsd </example>
7007 </param>
7008 </member>
7009 <member name="T:NAnt.Core.Tasks.NAntTask">
7010 <summary>
7011 Runs NAnt on a supplied build file, or a set of build files.
7012 </summary>
7013 <remarks>
7014 <para>
7015 By default, all the properties of the current project will be available
7016 in the new project. Alternatively, you can set <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>
7017 to <see langword="false"/> to not copy any properties to the new
7018 project.
7019 </para>
7020 <para>
7021 You can also set properties in the new project from the old project by
7022 using nested property tags. These properties are always passed to the
7023 new project regardless of the setting of <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>.
7024 This allows you to parameterize your subprojects.
7025 </para>
7026 <para>
7027 References to data types can also be passed to the new project, but by
7028 default they are not. If you set the <see cref="P:NAnt.Core.Tasks.NAntTask.InheritRefs"/> to
7029 <see langword="true"/>, all references will be copied.
7030 </para>
7031 </remarks>
7032 <example>
7033 <para>
7034 Build a project located in a different directory if the <c>debug</c>
7035 property is not <see langword="true"/>.
7036 </para>
7037 <code>
7038 <![CDATA[
7039 <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build" unless="${debug}" />
7040 ]]>
7041 </code>
7042 </example>
7043 <example>
7044 <para>
7045 Build a project while adding a set of properties to that project.
7046 </para>
7047 <code>
7048 <![CDATA[
7049 <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build">
7050 <properties>
7051 <property name="build.dir" value="c:/buildserver" />
7052 <property name="build.debug" value="false" />
7053 <property name="lib.dir" value="c:/shared/lib" readonly="true" />
7054 </properties>
7055 </nant>
7056 ]]>
7057 </code>
7058 </example>
7059 <example>
7060 <para>
7061 Build all projects named <c>default.build</c> located anywhere under
7062 the project base directory.
7063 </para>
7064 <code>
7065 <![CDATA[
7066 <nant>
7067 <buildfiles>
7068 <include name="**/default.build" />
7069 <!-- avoid recursive execution of current build file -->
7070 <exclude name="${project::get-buildfile-path()}" />
7071 </buildfiles>
7072 </nant>
7073 ]]>
7074 </code>
7075 </example>
7076 </member>
7077 <member name="M:NAnt.Core.Tasks.NAntTask.Initialize">
7078 <summary>
7079 Validates the <see cref="T:NAnt.Core.Tasks.NAntTask"/> element.
7080 </summary>
7081 </member>
7082 <member name="P:NAnt.Core.Tasks.NAntTask.BuildFile">
7083 <summary>
7084 The build file to build.
7085 </summary>
7086 </member>
7087 <member name="P:NAnt.Core.Tasks.NAntTask.DefaultTarget">
7088 <summary>
7089 The target to execute. To specify more than one target seperate
7090 targets with a space. Targets are executed in order if possible.
7091 The default is to use target specified in the project's default
7092 attribute.
7093 </summary>
7094 </member>
7095 <member name="P:NAnt.Core.Tasks.NAntTask.BuildFiles">
7096 <summary>
7097 Used to specify a set of build files to process.
7098 </summary>
7099 </member>
7100 <member name="P:NAnt.Core.Tasks.NAntTask.InheritAll">
7101 <summary>
7102 Specifies whether current property values should be inherited by
7103 the executed project. The default is <see langword="true" />.
7104 </summary>
7105 </member>
7106 <member name="P:NAnt.Core.Tasks.NAntTask.InheritRefs">
7107 <summary>
7108 Specifies whether all references will be copied to the new project.
7109 The default is <see langword="false" />.
7110 </summary>
7111 </member>
7112 <member name="P:NAnt.Core.Tasks.NAntTask.OverrideProperties">
7113 <summary>
7114 Specifies a collection of properties that should be created in the
7115 executed project. Note, existing properties with identical names
7116 that are not read-only will be overwritten.
7117 </summary>
7118 </member>
7119 <member name="T:NAnt.Core.Tasks.PropertyTask">
7120 <summary>
7121 Sets a property in the current project.
7122 </summary>
7123 <remarks>
7124 <note>NAnt uses a number of predefined properties.</note>
7125 </remarks>
7126 <example>
7127 <para>
7128 Define a <c>debug</c> property with value <see langword="true" />.
7129 </para>
7130 <code>
7131 <![CDATA[
7132 <property name="debug" value="true" />
7133 ]]>
7134 </code>
7135 </example>
7136 <example>
7137 <para>
7138 Use the user-defined <c>debug</c> property.
7139 </para>
7140 <code>
7141 <![CDATA[
7142 <property name="trace" value="${debug}" />
7143 ]]>
7144 </code>
7145 </example>
7146 <example>
7147 <para>
7148 Define a read-only property. This is just like passing in the param
7149 on the command line.
7150 </para>
7151 <code>
7152 <![CDATA[
7153 <property name="do_not_touch_ME" value="hammer" readonly="true" />
7154 ]]>
7155 </code>
7156 </example>
7157 <example>
7158 <para>
7159 Define a property, but do not overwrite the value if the property already exists (eg. it was specified on the command line).
7160 </para>
7161 <code>
7162 <![CDATA[
7163 <project name="property-example">
7164 <property name="debug" value="true" overwrite="false" />
7165 <echo message="debug: ${debug}" />
7166 </project>
7167 ]]>
7168 </code>
7169 <para>
7170 Executing this build file with the command line option <c>-D:debug=false</c>,
7171 would cause the value specified on the command line to remain unaltered.
7172 </para>
7173 <code>
7174 <![CDATA[
7175 [echo] debug: false
7176 ]]>
7177 </code>
7178 </example>
7179 </member>
7180 <member name="P:NAnt.Core.Tasks.PropertyTask.PropertyName">
7181 <summary>
7182 The name of the NAnt property to set.
7183 </summary>
7184 </member>
7185 <member name="P:NAnt.Core.Tasks.PropertyTask.Value">
7186 <summary>
7187 The value to assign to the NAnt property.
7188 </summary>
7189 </member>
7190 <member name="P:NAnt.Core.Tasks.PropertyTask.ReadOnly">
7191 <summary>
7192 Specifies whether the property is read-only or not.
7193 The default is <see langword="false" />.
7194 </summary>
7195 </member>
7196 <member name="P:NAnt.Core.Tasks.PropertyTask.Dynamic">
7197 <summary>
7198 Specifies whether references to other properties should not be
7199 expanded when the value of the property is set, but expanded when
7200 the property is actually used. By default, properties will be
7201 expanded when set.
7202 </summary>
7203 </member>
7204 <member name="P:NAnt.Core.Tasks.PropertyTask.Overwrite">
7205 <summary>
7206 Specifies whether the value of a property should be overwritten if
7207 the property already exists (unless the property is read-only).
7208 The default is <see langword="true" />.
7209 </summary>
7210 </member>
7211 <member name="T:NAnt.Core.Tasks.RegexTask">
7212 <summary>
7213 Sets project properties based on the evaluatuion of a regular expression.
7214 </summary>
7215 <remarks>
7216 <para>
7217 The <see cref="P:NAnt.Core.Tasks.RegexTask.Pattern"/> attribute must contain one or more
7218 <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpcongroupingconstructs.asp">
7219 named grouping constructs</see>, which represents the names of the
7220 properties to be set. These named grouping constructs can be enclosed
7221 by angle brackets (?<name>) or single quotes (?'name').
7222 </para>
7223 <note>
7224 In the build file, use the XML element <![CDATA[<]]> to specify <,
7225 and <![CDATA[>]]> to specify >.
7226 </note>
7227 <note>
7228 The named grouping construct must not contain any punctuation and it
7229 cannot begin with a number.
7230 </note>
7231 </remarks>
7232 <example>
7233 <para>
7234 Find the last word in the given string and stores it in the property
7235 <c>lastword</c>.
7236 </para>
7237 <code>
7238 <![CDATA[
7239 <regex pattern="(?'lastword'\w+)$" input="This is a test sentence" />
7240 <echo message="${lastword}" />
7241 ]]>
7242 </code>
7243 </example>
7244 <example>
7245 <para>
7246 Split the full filename and extension of a filename.
7247 </para>
7248 <code>
7249 <![CDATA[
7250 <regex pattern="^(?'filename'.*)\.(?'extension'\w+)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" />
7251 ]]>
7252 </code>
7253 </example>
7254 <example>
7255 <para>
7256 Split the path and the filename. (This checks for <c>/</c> or <c>\</c>
7257 as the path separator).
7258 </para>
7259 <code>
7260 <![CDATA[
7261 <regex pattern="^(?'path'.*(\\|/)|(/|\\))(?'file'.*)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" />
7262 ]]>
7263 </code>
7264 <para>
7265 Results in path=<c>d:\Temp\SomeDir\SomeDir\</c> and file=<c>bla.xml</c>.
7266 </para>
7267 </example>
7268 </member>
7269 <member name="M:NAnt.Core.Tasks.RegexTask.ExecuteTask">
7270 <summary>
7271 Executes the task.
7272 </summary>
7273 </member>
7274 <member name="P:NAnt.Core.Tasks.RegexTask.Pattern">
7275 <summary>
7276 Represents the regular expression to be evalued.
7277 </summary>
7278 <value>
7279 The regular expression to be evalued.
7280 </value>
7281 <remarks>
7282 The pattern must contain one or more named constructs, which may
7283 not contain any punctuation and cannot begin with a number.
7284 </remarks>
7285 </member>
7286 <member name="P:NAnt.Core.Tasks.RegexTask.Options">
7287 <summary>
7288 A comma separated list of options to pass to the regex engine. The
7289 default is <see cref="F:System.Text.RegularExpressions.RegexOptions.None"/>.
7290 </summary>
7291 </member>
7292 <member name="P:NAnt.Core.Tasks.RegexTask.Input">
7293 <summary>
7294 Represents the input for the regular expression.
7295 </summary>
7296 <value>
7297 The input for the regular expression.
7298 </value>
7299 </member>
7300 <member name="T:NAnt.Core.Tasks.SetEnvTask">
7301 <summary>
7302 Sets an environment variable or a whole collection of them. Use an empty
7303 <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute to clear a variable.
7304 </summary>
7305 <remarks>
7306 <note>
7307 Variables will be set for the current NAnt process and all child
7308 processes that NAnt spawns (compilers, shell tools, etc). If the
7309 intention is to only set a variable for a single child process, then
7310 using the <see cref="T:NAnt.Core.Tasks.ExecTask"/> and its nested <see cref="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet"/>
7311 element might be a better option.
7312 </note>
7313 <note>
7314 Expansion of inline environment variables is performed using the syntax
7315 of the current platform. So on Windows platforms using the string %PATH%
7316 in the <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute will result in the value of
7317 the PATH variable being expanded in place before the variable is set.
7318 </note>
7319 </remarks>
7320 <example>
7321 <para>Set the MONO_PATH environment variable on a *nix platform.</para>
7322 <code>
7323 <![CDATA[
7324 <setenv name=="MONO_PATH" value="/home/jimbob/dev/foo:%MONO_PATH%"/>
7325 ]]>
7326 </code>
7327 </example>
7328 <example>
7329 <para>Set a collection of environment variables. Note the nested variable used to set var3.</para>
7330 <code>
7331 <![CDATA[
7332 <setenv>
7333 <variable name="var1" value="value2" />
7334 <variable name="var2" value="value2" />
7335 <variable name="var3" value="value3:%var2%" />
7336 </setenv>
7337 ]]>
7338 </code>
7339 </example>
7340 <example>
7341 <para>Set environment variables using nested path elements.</para>
7342 <code>
7343 <![CDATA[
7344 <path id="build.path">
7345 <pathelement dir="c:/windows" />
7346 <pathelement dir="c:/cygwin/usr/local/bin" />
7347 </path>
7348 <setenv>
7349 <variable name="build_path" >
7350 <path refid="build.path" />
7351 </variable>
7352 <variable name="path2">
7353 <path>
7354 <pathelement dir="c:/windows" />
7355 <pathelement dir="c:/cygwin/usr/local/bin" />
7356 </path>
7357 </variable>
7358 </setenv>
7359 ]]>
7360 </code>
7361 </example>
7362 </member>
7363 <member name="M:NAnt.Core.Tasks.SetEnvTask.SetEnvironmentVariable(System.String,System.String)">
7364 <summary>
7365 Win32 DllImport for the SetEnvironmentVariable function.
7366 </summary>
7367 <param name="lpName"></param>
7368 <param name="lpValue"></param>
7369 <returns></returns>
7370 </member>
7371 <member name="M:NAnt.Core.Tasks.SetEnvTask.setenv(System.String,System.String,System.Int32)">
7372 <summary>
7373 *nix dllimport for the setenv function.
7374 </summary>
7375 <param name="name"></param>
7376 <param name="value"></param>
7377 <param name="overwrite"></param>
7378 <returns></returns>
7379 </member>
7380 <member name="M:NAnt.Core.Tasks.SetEnvTask.Initialize">
7381 <summary>
7382 Checks whether the task is initialized with valid attributes.
7383 </summary>
7384 </member>
7385 <member name="M:NAnt.Core.Tasks.SetEnvTask.ExecuteTask">
7386 <summary>
7387 Set the environment variables
7388 </summary>
7389 </member>
7390 <member name="M:NAnt.Core.Tasks.SetEnvTask.SetSingleEnvironmentVariable(System.String,System.String)">
7391 <summary>
7392 Do the actual work here.
7393 </summary>
7394 <param name="name">The name of the environment variable.</param>
7395 <param name="value">The value of the environment variable.</param>
7396 </member>
7397 <member name="P:NAnt.Core.Tasks.SetEnvTask.EnvName">
7398 <summary>
7399 The name of a single Environment variable to set
7400 </summary>
7401 </member>
7402 <member name="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue">
7403 <summary>
7404 The literal value for the environment variable.
7405 </summary>
7406 </member>
7407 <member name="P:NAnt.Core.Tasks.SetEnvTask.File">
7408 <summary>
7409 The value for a file-based environment variable. NAnt will convert
7410 it to an absolute filename.
7411 </summary>
7412 </member>
7413 <member name="P:NAnt.Core.Tasks.SetEnvTask.Directory">
7414 <summary>
7415 The value for a directory-based environment variable. NAnt will
7416 convert it to an absolute path.
7417 </summary>
7418 </member>
7419 <member name="P:NAnt.Core.Tasks.SetEnvTask.Path">
7420 <summary>
7421 The value for a PATH like environment variable. You can use
7422 <c>:</c> or <c>;</c> as path separators and NAnt will convert it to
7423 the platform's local conventions.
7424 </summary>
7425 </member>
7426 <member name="T:NAnt.Core.Tasks.SleepTask">
7427 <summary>
7428 A task for sleeping a specified period of time, useful when a build or deployment process
7429 requires an interval between tasks.
7430 </summary>
7431 <example>
7432 <para>Sleep 1 hour, 2 minutes, 3 seconds and 4 milliseconds.</para>
7433 <code>
7434 <![CDATA[
7435 <sleep hours="1" minutes="2" seconds="3" milliseconds="4" />
7436 ]]>
7437 </code>
7438 </example>
7439 <example>
7440 <para>Sleep 123 milliseconds.</para>
7441 <code>
7442 <![CDATA[
7443 <sleep milliseconds="123" />
7444 ]]>
7445 </code>
7446 </example>
7447 </member>
7448 <member name="M:NAnt.Core.Tasks.SleepTask.Initialize">
7449 <summary>
7450 Verify parameters.
7451 </summary>
7452 </member>
7453 <member name="M:NAnt.Core.Tasks.SleepTask.GetSleepTime">
7454 <summary>
7455 Return time to sleep.
7456 </summary>
7457 </member>
7458 <member name="M:NAnt.Core.Tasks.SleepTask.DoSleep(System.Int32)">
7459 <summary>
7460 Sleeps for the specified number of milliseconds.
7461 </summary>
7462 <param name="millis">Number of milliseconds to sleep.</param>
7463 </member>
7464 <member name="P:NAnt.Core.Tasks.SleepTask.Hours">
7465 <summary>
7466 Hours to add to the sleep time.
7467 </summary>
7468 </member>
7469 <member name="P:NAnt.Core.Tasks.SleepTask.Minutes">
7470 <summary>
7471 Minutes to add to the sleep time.
7472 </summary>
7473 </member>
7474 <member name="P:NAnt.Core.Tasks.SleepTask.Seconds">
7475 <summary>
7476 Seconds to add to the sleep time.
7477 </summary>
7478 </member>
7479 <member name="P:NAnt.Core.Tasks.SleepTask.Milliseconds">
7480 <summary>
7481 Milliseconds to add to the sleep time.
7482 </summary>
7483 </member>
7484 <member name="T:NAnt.Core.Tasks.StyleTask">
7485 <summary>
7486 Processes a document via XSLT.
7487 </summary>
7488 <example>
7489 <para>Create a report in HTML.</para>
7490 <code>
7491 <![CDATA[
7492 <style style="report.xsl" in="data.xml" out="report.html" />
7493 ]]>
7494 </code>
7495 </example>
7496 <example>
7497 <para>Create a report in HTML, with a param.</para>
7498 <code>
7499 <![CDATA[
7500 <style style="report.xsl" in="data.xml" out="report.html">
7501 <parameters>
7502 <parameter name="reportType" namespaceuri="" value="Plain" />
7503 </parameters>
7504 </style>
7505 ]]>
7506 </code>
7507 </example>
7508 <example>
7509 <para>Create a report in HTML, with a expanded param.</para>
7510 <code>
7511 <![CDATA[
7512 <style style="report.xsl" in="data.xml" out="report.html">
7513 <parameters>
7514 <parameter name="reportType" namespaceuri="" value="${report.type}" />
7515 </parameters>
7516 </style>
7517 ]]>
7518 </code>
7519 </example>
7520 <example>
7521 <para>Create some code based on a directory of templates.</para>
7522 <code>
7523 <![CDATA[
7524 <style style="CodeGenerator.xsl" extension="java">
7525 <infiles>
7526 <include name="*.xml" />
7527 </infiles>
7528 <parameters>
7529 <parameter name="reportType" namespaceuri="" value="Plain" if="${report.plain}" />
7530 </parameters>
7531 <style>
7532 ]]>
7533 </code>
7534 </example>
7535 <example>
7536 <para>Create a report in HTML, with an extension object.</para>
7537 <code>
7538 <![CDATA[
7539 <style style="report.xsl" in="data.xml" out="report.html">
7540 <extensionobjects>
7541 <extensionobject namespaceuri="urn:Formatter" typename="XsltExtensionObjects.Formatter" assembly="XsltExtensionObjects.dll" />
7542 </extensionobjects>
7543 </style>
7544 ]]>
7545 </code>
7546 </example>
7547 </member>
7548 <member name="P:NAnt.Core.Tasks.StyleTask.DestDir">
7549 <summary>
7550 Directory in which to store the results. The default is the project
7551 base directory.
7552 </summary>
7553 </member>
7554 <member name="P:NAnt.Core.Tasks.StyleTask.Extension">
7555 <summary>
7556 Desired file extension to be used for the targets. The default is
7557 <c>html</c>.
7558 </summary>
7559 </member>
7560 <member name="P:NAnt.Core.Tasks.StyleTask.XsltFile">
7561 <summary>
7562 URI or path that points to the stylesheet to use. If given as path, it can
7563 be relative to the project's basedir or absolute.
7564 </summary>
7565 </member>
7566 <member name="P:NAnt.Core.Tasks.StyleTask.SrcFile">
7567 <summary>
7568 Specifies a single XML document to be styled. Should be used with
7569 the <see cref="P:NAnt.Core.Tasks.StyleTask.OutputFile"/> attribute.
7570 </summary>
7571 </member>
7572 <member name="P:NAnt.Core.Tasks.StyleTask.OutputFile">
7573 <summary>
7574 Specifies the output name for the styled result from the <see cref="P:NAnt.Core.Tasks.StyleTask.SrcFile"/>
7575 attribute.
7576 </summary>
7577 </member>
7578 <member name="P:NAnt.Core.Tasks.StyleTask.InFiles">
7579 <summary>
7580 Specifies a group of input files to which to apply the stylesheet.
7581 </summary>
7582 </member>
7583 <member name="P:NAnt.Core.Tasks.StyleTask.Parameters">
7584 <summary>
7585 XSLT parameters to be passed to the XSLT transformation.
7586 </summary>
7587 </member>
7588 <member name="P:NAnt.Core.Tasks.StyleTask.ExtensionObjects">
7589 <summary>
7590 XSLT extension objects to be passed to the XSLT transformation.
7591 </summary>
7592 </member>
7593 <member name="P:NAnt.Core.Tasks.StyleTask.Proxy">
7594 <summary>
7595 The network proxy to use to access the Internet resource.
7596 </summary>
7597 </member>
7598 <member name="T:NAnt.Core.Tasks.SysInfoTask">
7599 <summary>
7600 Sets properties with system information.
7601 </summary>
7602 <remarks>
7603 <para>Sets a number of properties with information about the system environment. The intent of this task is for nightly build logs to have a record of system information so that the build was performed on.</para>
7604 <list type="table">
7605 <listheader>
7606 <term>Property</term>
7607 <description>Value</description>
7608 </listheader>
7609 <item>
7610 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.clr.version</term>
7611 <description>Common Language Runtime version number.</description>
7612 </item>
7613 <item>
7614 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.env.*</term>
7615 <description>Environment variables (e.g., <<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.env.PATH).</description>
7616 </item>
7617 <item>
7618 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.platform</term>
7619 <description>Operating system platform ID.</description>
7620 </item>
7621 <item>
7622 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.version</term>
7623 <description>Operating system version.</description>
7624 </item>
7625 <item>
7626 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os</term>
7627 <description>Operating system version string.</description>
7628 </item>
7629 <item>
7630 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.applicationdata</term>
7631 <description>The directory that serves as a common repository for application-specific data for the current roaming user.</description>
7632 </item>
7633 <item>
7634 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.commonapplicationdata</term>
7635 <description>The directory that serves as a common repository for application-specific data that is used by all users.</description>
7636 </item>
7637 <item>
7638 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.commonprogramfiles</term>
7639 <description>The directory for components that are shared across applications.</description>
7640 </item>
7641 <item>
7642 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.desktopdirectory</term>
7643 <description>The directory used to physically store file objects on the desktop. Do not confuse this directory with the desktop folder itself, which is a virtual folder.</description>
7644 </item>
7645 <item>
7646 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.programfiles</term>
7647 <description>The Program Files directory.</description>
7648 </item>
7649 <item>
7650 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.system</term>
7651 <description>The System directory.</description>
7652 </item>
7653 <item>
7654 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.temp</term>
7655 <description>The temporary directory.</description>
7656 </item>
7657 </list>
7658 <para>
7659 When the name of an environment variable is not a valid property name,
7660 the task will fail. In that case, set <see cref="P:NAnt.Core.Task.FailOnError"/> to
7661 <see langword="true"/> to allow that environment variable to be
7662 skipped.
7663 </para>
7664 <note>
7665 we advise you to use the following functions instead:
7666 </note>
7667 <list type="table">
7668 <listheader>
7669 <term>Function</term>
7670 <description>Description</description>
7671 </listheader>
7672 <item>
7673 <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/></term>
7674 <description>Gets a <see cref="T:System.OperatingSystem"/> object that identifies this operating system.</description>
7675 </item>
7676 <item>
7677 <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)"/></term>
7678 <description>Gets the path to a system special folder.</description>
7679 </item>
7680 <item>
7681 <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)"/></term>
7682 <description>Returns the value of a environment variable.</description>
7683 </item>
7684 <item>
7685 <term><see cref="M:NAnt.Core.Functions.PathFunctions.GetTempPath"/></term>
7686 <description>Gets the path to the temporary directory.</description>
7687 </item>
7688 <item>
7689 <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/></term>
7690 <description>Gets the Common Language Runtime version.</description>
7691 </item>
7692 </list>
7693 </remarks>
7694 <example>
7695 <para>Register the properties with the default property prefix.</para>
7696 <code>
7697 <![CDATA[
7698 <sysinfo />
7699 ]]>
7700 </code>
7701 </example>
7702 <example>
7703 <para>Register the properties without a prefix.</para>
7704 <code>
7705 <![CDATA[
7706 <sysinfo prefix="" />
7707 ]]>
7708 </code>
7709 </example>
7710 <example>
7711 <para>Register properties and display a summary.</para>
7712 <code>
7713 <![CDATA[
7714 <sysinfo verbose="true" />
7715 ]]>
7716 </code>
7717 </example>
7718 </member>
7719 <member name="P:NAnt.Core.Tasks.SysInfoTask.Prefix">
7720 <summary>
7721 The string to prefix the property names with. The default is "sys.".
7722 </summary>
7723 </member>
7724 <member name="T:NAnt.Core.Tasks.TStampTask">
7725 <summary>
7726 Sets properties with the current date and time.
7727 </summary>
7728 <remarks>
7729 <para>
7730 By default the <see cref="T:NAnt.Core.Tasks.TStampTask"/> displays the current date
7731 and time and sets the following properties:
7732 </para>
7733 <list type="bullet">
7734 <item><description>tstamp.date to yyyyMMdd</description></item>
7735 <item><description>tstamp.time to HHmm</description></item>
7736 <item><description>tstamp.now using the default DateTime.ToString() method</description></item>
7737 </list>
7738 <para>
7739 To set an additional property with a custom date/time use the
7740 <see cref="P:NAnt.Core.Tasks.TStampTask.Property"/> and <see cref="P:NAnt.Core.Tasks.TStampTask.Pattern"/> attributes.
7741 To set a number of additional properties with the exact same date and
7742 time use the <see cref="P:NAnt.Core.Tasks.TStampTask.Formatters"/> nested element (see example).
7743 </para>
7744 <para>
7745 The date and time string displayed by the <see cref="T:NAnt.Core.Tasks.TStampTask"/>
7746 uses the computer's default long date and time string format. You
7747 might consider setting these to the
7748 <see href="http://www.cl.cam.ac.uk/~mgk25/iso-time.html">ISO 8601 standard
7749 for date and time notation</see>.
7750 </para>
7751 </remarks>
7752 <example>
7753 <para>Set the <c>build.date</c> property.</para>
7754 <code>
7755 <![CDATA[
7756 <tstamp property="build.date" pattern="yyyyMMdd" verbose="true" />
7757 ]]>
7758 </code>
7759 </example>
7760 <example>
7761 <para>Set a number of properties for Ant like compatibility.</para>
7762 <code>
7763 <![CDATA[
7764 <tstamp verbose="true">
7765 <formatter property="TODAY" pattern="dd MMM yyyy"/>
7766 <formatter property="DSTAMP" pattern="yyyyMMdd" unless="${date.not.needed}" />
7767 <formatter property="TSTAMP" pattern="HHmm" if="${need.hours}" />
7768 </tstamp>
7769 ]]>
7770 </code>
7771 </example>
7772 </member>
7773 <member name="P:NAnt.Core.Tasks.TStampTask.Property">
7774 <summary>
7775 The property to receive the date/time string in the given pattern.
7776 </summary>
7777 </member>
7778 <member name="P:NAnt.Core.Tasks.TStampTask.Pattern">
7779 <summary>The date/time pattern to be used.</summary>
7780 <remarks>
7781 <para>The following table lists the standard format characters for each standard pattern. The format characters are case-sensitive; for example, 'g' and 'G' represent slightly different patterns.</para>
7782 <list type="table">
7783 <listheader>
7784 <description>Format Character</description>
7785 <description>Description Example Format Pattern (en-US)</description>
7786 </listheader>
7787 <item><description>d</description><description>MM/dd/yyyy</description></item>
7788 <item><description>D</description><description>dddd, dd MMMM yyyy</description></item>
7789 <item><description>f</description><description>dddd, dd MMMM yyyy HH:mm</description></item>
7790 <item><description>F</description><description>dddd, dd MMMM yyyy HH:mm:ss</description></item>
7791 <item><description>g</description><description>MM/dd/yyyy HH:mm</description></item>
7792 <item><description>G</description><description>MM/dd/yyyy HH:mm:ss</description></item>
7793 <item><description>m, M</description><description>MMMM dd</description></item>
7794 <item><description>r, R</description><description>ddd, dd MMM yyyy HH':'mm':'ss 'GMT'</description></item>
7795 <item><description>s</description><description>yyyy'-'MM'-'dd'T'HH':'mm':'ss</description></item>
7796 <item><description>t</description><description>HH:mm</description></item>
7797 <item><description>T</description><description>HH:mm:ss</description></item>
7798 <item><description>u</description><description>yyyy'-'MM'-'dd HH':'mm':'ss'Z'</description></item>
7799 <item><description>U</description><description>dddd, dd MMMM yyyy HH:mm:ss</description></item>
7800 <item><description>y, Y</description><description>yyyy MMMM</description></item>
7801 </list>
7802 <para>The following table lists the patterns that can be combined to construct custom patterns. The patterns are case-sensitive; for example, "MM" is recognized, but "mm" is not. If the custom pattern contains white-space characters or characters enclosed in single quotation marks, the output string will also contain those characters. Characters not defined as part of a format pattern or as format characters are reproduced literally.</para>
7803 <list type="table">
7804 <listheader>
7805 <description>Format</description>
7806 <description>Pattern Description</description>
7807 </listheader>
7808 <item><description>d</description><description>The day of the month. Single-digit days will not have a leading zero.</description></item>
7809 <item><description>dd</description><description>The day of the month. Single-digit days will have a leading zero.</description></item>
7810 <item><description>ddd</description><description>The abbreviated name of the day of the week.</description></item>
7811 <item><description>dddd</description><description>The full name of the day of the week.</description></item>
7812 <item><description>M</description><description>The numeric month. Single-digit months will not have a leading zero.</description></item>
7813 <item><description>MM</description><description>The numeric month. Single-digit months will have a leading zero.</description></item>
7814 <item><description>MMM</description><description>The abbreviated name of the month.</description></item>
7815 <item><description>MMMM</description><description>The full name of the month.</description></item>
7816 <item><description>y</description><description>The year without the century. If the year without the century is less than 10, the year is displayed with no leading zero.</description></item>
7817 <item><description>yy</description><description>The year without the century. If the year without the century is less than 10, the year is displayed with a leading zero.</description></item>
7818 <item><description>yyyy</description><description>The year in four digits, including the century.</description></item>
7819 <item><description>gg</description><description>The period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string.</description></item>
7820 <item><description>h</description><description>The hour in a 12-hour clock. Single-digit hours will not have a leading zero.</description></item>
7821 <item><description>hh</description><description>The hour in a 12-hour clock. Single-digit hours will have a leading zero.</description></item>
7822 <item><description>H</description><description>The hour in a 24-hour clock. Single-digit hours will not have a leading zero.</description></item>
7823 <item><description>HH</description><description>The hour in a 24-hour clock. Single-digit hours will have a leading zero.</description></item>
7824 <item><description>m</description><description>The minute. Single-digit minutes will not have a leading zero.</description></item>
7825 <item><description>mm</description><description>The minute. Single-digit minutes will have a leading zero.</description></item>
7826 <item><description>s</description><description>The second. Single-digit seconds will not have a leading zero.</description></item>
7827 <item><description>ss</description><description>The second. Single-digit seconds will have a leading zero.</description></item>
7828 <item><description>f</description><description>The fraction of a second in single-digit precision. The remaining digits are truncated.</description></item>
7829 <item><description>ff</description><description>The fraction of a second in double-digit precision. The remaining digits are truncated.</description></item>
7830 <item><description>fff</description><description>The fraction of a second in three-digit precision. The remaining digits are truncated.</description></item>
7831 <item><description>ffff</description><description>The fraction of a second in four-digit precision. The remaining digits are truncated.</description></item>
7832 <item><description>fffff</description><description>The fraction of a second in five-digit precision. The remaining digits are truncated. </description></item>
7833 <item><description>ffffff</description><description>The fraction of a second in six-digit precision. The remaining digits are truncated. </description></item>
7834 <item><description>fffffff</description><description>The fraction of a second in seven-digit precision. The remaining digits are truncated. </description></item>
7835 <item><description>t</description><description>The first character in the AM/PM designator.</description></item>
7836 <item><description>tt</description><description>The AM/PM designator. </description></item>
7837 <item><description>z</description><description>The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will not have a leading zero. For example, Pacific Standard Time is "-8".</description></item>
7838 <item><description>zz</description><description>The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08".</description></item>
7839 <item><description>zzz</description><description>The full time zone offset ("+" or "-" followed by the hour and minutes). Single-digit hours and minutes will have leading zeros. For example, Pacific Standard Time is "-08:00".</description></item>
7840 <item><description>:</description><description>The default time separator.</description></item>
7841 <item><description>/</description><description>The default date separator.</description></item>
7842 <item><description>\ c</description><description>Pattern Where c is any character. Displays the character literally. To display the backslash character, use "\\". </description></item>
7843 </list>
7844 </remarks>
7845 </member>
7846 <member name="T:NAnt.Core.Tasks.TouchTask">
7847 <summary>
7848 Touches a file or set of files -- corresponds to the Unix touch command.
7849 </summary>
7850 <remarks>
7851 <para>
7852 If the file specified does not exist, the task will create it.
7853 </para>
7854 </remarks>
7855 <example>
7856 <para>Touch the <c>Main.cs</c> file. The current time is used.</para>
7857 <code>
7858 <![CDATA[
7859 <touch file="Main.cs" />
7860 ]]>
7861 </code>
7862 </example>
7863 <example>
7864 <para>
7865 Touch all executable files in the project base directory and its
7866 subdirectories.
7867 </para>
7868 <code>
7869 <![CDATA[
7870 <touch>
7871 <fileset>
7872 <include name="**/*.exe" />
7873 <include name="**/*.dll" />
7874 </fileset>
7875 </touch>
7876 ]]>
7877 </code>
7878 </example>
7879 </member>
7880 <member name="M:NAnt.Core.Tasks.TouchTask.Initialize">
7881 <summary>
7882 Ensures the supplied attributes are valid.
7883 </summary>
7884 </member>
7885 <member name="P:NAnt.Core.Tasks.TouchTask.File">
7886 <summary>
7887 The file to touch.
7888 </summary>
7889 </member>
7890 <member name="P:NAnt.Core.Tasks.TouchTask.Millis">
7891 <summary>
7892 Specifies the new modification time of the file(s) in milliseconds
7893 since midnight Jan 1 1970.
7894 </summary>
7895 </member>
7896 <member name="P:NAnt.Core.Tasks.TouchTask.Datetime">
7897 <summary>
7898 Specifies the new modification time of the file in the format
7899 MM/DD/YYYY HH:MM:SS.
7900 </summary>
7901 </member>
7902 <member name="P:NAnt.Core.Tasks.TouchTask.TouchFileSet">
7903 <summary>
7904 Used to select files that should be touched.
7905 </summary>
7906 </member>
7907 <member name="T:NAnt.Core.Tasks.UpToDateTask">
7908 <summary>
7909 Check modification dates on groups of files.
7910 </summary>
7911 <remarks>
7912 If all <see cref="P:NAnt.Core.Tasks.UpToDateTask.TargetFiles"/> are same or newer than all <see cref="P:NAnt.Core.Tasks.UpToDateTask.SourceFiles"/>, the specified property is set to <see langword="true"/>, otherwise it
7913 is set to <see langword="false"/>.
7914 </remarks>
7915 <example>
7916 <para>
7917 Check file dates. If <c>myfile.dll</c> is same or newer than <c>myfile.cs</c>, then set <c>myfile.dll.uptodate</c> property
7918 to either <see langword="true"/> or <see langword="false"/>.
7919 </para>
7920 <code>
7921 <![CDATA[
7922 <uptodate property="myfile.dll.uptodate">
7923 <sourcefiles>
7924 <include name="myfile.cs" />
7925 </sourcefiles>
7926 <targetfiles>
7927 <include name="myfile.dll" />
7928 </targetfiles>
7929 </uptodate>
7930 ]]>
7931 </code>
7932 </example>
7933 </member>
7934 <member name="P:NAnt.Core.Tasks.UpToDateTask.PropertyName">
7935 <summary>
7936 Property that will be set to <see langword="true" /> or <see langword="false" /> depending on the
7937 result of the date check.
7938 </summary>
7939 </member>
7940 <member name="P:NAnt.Core.Tasks.UpToDateTask.SourceFiles">
7941 <summary>
7942 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains list of source files.
7943 </summary>
7944 </member>
7945 <member name="P:NAnt.Core.Tasks.UpToDateTask.TargetFiles">
7946 <summary>
7947 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains list of target files.
7948 </summary>
7949 </member>
7950 <member name="T:NAnt.Core.Tasks.XmlPeekTask">
7951 <summary>
7952 Extracts text from an XML file at the location specified by an XPath
7953 expression.
7954 </summary>
7955 <remarks>
7956 <para>
7957 If the XPath expression specifies multiple nodes the node index is used
7958 to determine which of the nodes' text is returned.
7959 </para>
7960 </remarks>
7961 <example>
7962 <para>
7963 The example provided assumes that the following XML file (App.config)
7964 exists in the current build directory.
7965 </para>
7966 <code>
7967 <![CDATA[
7968 <?xml version="1.0" encoding="utf-8" ?>
7969 <configuration xmlns="http://www.gordic.cz/shared/project-config/v_1.0.0.0">
7970 <appSettings>
7971 <add key="server" value="testhost.somecompany.com" />
7972 </appSettings>
7973 </configuration>
7974 ]]>
7975 </code>
7976 </example>
7977 <example>
7978 <para>
7979 The example will read the server value from the above
7980 configuration file.
7981 </para>
7982 <code>
7983 <![CDATA[
7984 <xmlpeek
7985 file="App.config"
7986 xpath="/x:configuration/x:appSettings/x:add[@key = 'server']/@value"
7987 property="configuration.server">
7988 <namespaces>
7989 <namespace prefix="x" uri="http://www.gordic.cz/shared/project-config/v_1.0.0.0" />
7990 </namespaces>
7991 </xmlpeek>
7992 ]]>
7993 </code>
7994 </example>
7995 </member>
7996 <member name="M:NAnt.Core.Tasks.XmlPeekTask.ExecuteTask">
7997 <summary>
7998 Executes the XML peek task.
7999 </summary>
8000 </member>
8001 <member name="M:NAnt.Core.Tasks.XmlPeekTask.LoadDocument(System.String)">
8002 <summary>
8003 Loads an XML document from a file on disk.
8004 </summary>
8005 <param name="fileName">The file name of the file to load the XML document from.</param>
8006 <returns>
8007 A <see cref="T:System.Xml.XmlDocument">document</see> containing
8008 the document object representing the file.
8009 </returns>
8010 </member>
8011 <member name="M:NAnt.Core.Tasks.XmlPeekTask.GetNodeContents(System.String,System.Xml.XmlDocument,System.Int32)">
8012 <summary>
8013 Gets the contents of the node specified by the XPath expression.
8014 </summary>
8015 <param name="xpath">The XPath expression used to determine which nodes to choose from.</param>
8016 <param name="document">The XML document to select the nodes from.</param>
8017 <param name="nodeIndex">The node index in the case where multiple nodes satisfy the expression.</param>
8018 <returns>
8019 The contents of the node specified by the XPath expression.
8020 </returns>
8021 </member>
8022 <member name="P:NAnt.Core.Tasks.XmlPeekTask.XmlFile">
8023 <summary>
8024 The name of the file that contains the XML document
8025 that is going to be peeked at.
8026 </summary>
8027 </member>
8028 <member name="P:NAnt.Core.Tasks.XmlPeekTask.NodeIndex">
8029 <summary>
8030 The index of the node that gets its text returned when the query
8031 returns multiple nodes.
8032 </summary>
8033 </member>
8034 <member name="P:NAnt.Core.Tasks.XmlPeekTask.Property">
8035 <summary>
8036 The property that receives the text representation of the XML inside
8037 the node returned from the XPath expression.
8038 </summary>
8039 </member>
8040 <member name="P:NAnt.Core.Tasks.XmlPeekTask.XPath">
8041 <summary>
8042 The XPath expression used to select which node to read.
8043 </summary>
8044 </member>
8045 <member name="P:NAnt.Core.Tasks.XmlPeekTask.Namespaces">
8046 <summary>
8047 Namespace definitions to resolve prefixes in the XPath expression.
8048 </summary>
8049 </member>
8050 <member name="T:NAnt.Core.Tasks.XmlPokeTask">
8051 <summary>
8052 Replaces text in an XML file at the location specified by an XPath
8053 expression.
8054 </summary>
8055 <remarks>
8056 <para>
8057 The location specified by the XPath expression must exist, it will
8058 not create the parent elements for you. However, provided you have
8059 a root element you could use a series of the tasks to build the
8060 XML file up if necessary.
8061 </para>
8062 </remarks>
8063 <example>
8064 <para>
8065 Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
8066 to <c>productionhost.somecompany.com</c>.
8067 </para>
8068 <para>XML file:</para>
8069 <code>
8070 <![CDATA[
8071 <?xml version="1.0" encoding="utf-8" ?>
8072 <configuration>
8073 <appSettings>
8074 <add key="server" value="testhost.somecompany.com" />
8075 </appSettings>
8076 </configuration>
8077 ]]>
8078 </code>
8079 <para>Build fragment:</para>
8080 <code>
8081 <![CDATA[
8082 <xmlpoke
8083 file="App.config"
8084 xpath="/configuration/appSettings/add[@key = 'server']/@value"
8085 value="productionhost.somecompany.com" />
8086 ]]>
8087 </code>
8088 </example>
8089 <example>
8090 <para>
8091 Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
8092 </para>
8093 <para>XML file:</para>
8094 <code>
8095 <![CDATA[
8096 <?xml version="1.0" encoding="utf-8" ?>
8097 <Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
8098 </Commands>
8099 ]]>
8100 </code>
8101 <para>Build fragment:</para>
8102 <code>
8103 <![CDATA[
8104 <xmlpoke file="test.xml" xpath="/Commands/@xsi:noNamespaceSchemaLocation" value="d:\Commands.xsd">
8105 <namespaces>
8106 <namespace prefix="xsi" uri="http://www.w3.org/2001/XMLSchema-instance" />
8107 </namespaces>
8108 </xmlpoke>
8109 ]]>
8110 </code>
8111 </example>
8112 </member>
8113 <member name="M:NAnt.Core.Tasks.XmlPokeTask.ExecuteTask">
8114 <summary>
8115 Executes the XML poke task.
8116 </summary>
8117 </member>
8118 <member name="M:NAnt.Core.Tasks.XmlPokeTask.LoadDocument(System.String)">
8119 <summary>
8120 Loads an XML document from a file on disk.
8121 </summary>
8122 <param name="fileName">
8123 The file name of the file to load the XML document from.
8124 </param>
8125 <returns>
8126 An <see cref="T:System.Xml.XmlDocument"/> containing
8127 the document object model representing the file.
8128 </returns>
8129 </member>
8130 <member name="M:NAnt.Core.Tasks.XmlPokeTask.SelectNodes(System.String,System.Xml.XmlDocument,System.Xml.XmlNamespaceManager)">
8131 <summary>
8132 Given an XML document and an expression, returns a list of nodes
8133 which match the expression criteria.
8134 </summary>
8135 <param name="xpath">
8136 The XPath expression used to select the nodes.
8137 </param>
8138 <param name="document">
8139 The XML document that is searched.
8140 </param>
8141 <param name="nsMgr">
8142 An <see cref="T:System.Xml.XmlNamespaceManager"/> to use for resolving namespaces
8143 for prefixes in the XPath expression.
8144 </param>
8145 <returns>
8146 An <see cref="T:System.Xml.XmlNodeList"/> containing references to the nodes
8147 that matched the XPath expression.
8148 </returns>
8149 </member>
8150 <member name="M:NAnt.Core.Tasks.XmlPokeTask.UpdateNodes(System.Xml.XmlNodeList,System.String)">
8151 <summary>
8152 Given a node list, replaces the XML within those nodes.
8153 </summary>
8154 <param name="nodes">
8155 The list of nodes to replace the contents of.
8156 </param>
8157 <param name="value">
8158 The text to replace the contents with.
8159 </param>
8160 </member>
8161 <member name="M:NAnt.Core.Tasks.XmlPokeTask.SaveDocument(System.Xml.XmlDocument,System.String)">
8162 <summary>
8163 Saves the XML document to a file.
8164 </summary>
8165 <param name="document">The XML document to be saved.</param>
8166 <param name="fileName">The file name to save the XML document under.</param>
8167 </member>
8168 <member name="P:NAnt.Core.Tasks.XmlPokeTask.XmlFile">
8169 <summary>
8170 The name of the file that contains the XML document that is going
8171 to be poked.
8172 </summary>
8173 </member>
8174 <member name="P:NAnt.Core.Tasks.XmlPokeTask.XPath">
8175 <summary>
8176 The XPath expression used to select which nodes are to be modified.
8177 </summary>
8178 </member>
8179 <member name="P:NAnt.Core.Tasks.XmlPokeTask.Value">
8180 <summary>
8181 The value that replaces the contents of the selected nodes.
8182 </summary>
8183 </member>
8184 <member name="P:NAnt.Core.Tasks.XmlPokeTask.Namespaces">
8185 <summary>
8186 Namespace definitions to resolve prefixes in the XPath expression.
8187 </summary>
8188 </member>
8189 <member name="T:NAnt.Core.Types.Argument">
8190 <summary>
8191 Represents a command-line argument.
8192 </summary>
8193 <remarks>
8194 <para>
8195 When passed to an external application, the argument will be quoted
8196 when appropriate. This does not apply to the <see cref="P:NAnt.Core.Types.Argument.Line"/>
8197 parameter, which is always passed as is.
8198 </para>
8199 </remarks>
8200 <example>
8201 <para>
8202 A single command-line argument containing a space character.
8203 </para>
8204 <code>
8205 <![CDATA[
8206 <arg value="-l -a" />
8207 ]]>
8208 </code>
8209 </example>
8210 <example>
8211 <para>
8212 Two separate command-line arguments.
8213 </para>
8214 <code>
8215 <![CDATA[
8216 <arg line="-l -a" />
8217 ]]>
8218 </code>
8219 </example>
8220 <example>
8221 <para>
8222 A single command-line argument with the value <c>\dir;\dir2;\dir3</c>
8223 on DOS-based systems and <c>/dir:/dir2:/dir3</c> on Unix-like systems.
8224 </para>
8225 <code>
8226 <![CDATA[
8227 <arg path="/dir;/dir2:\dir3" />
8228 ]]>
8229 </code>
8230 </example>
8231 </member>
8232 <member name="M:NAnt.Core.Types.Argument.#ctor">
8233 <summary>
8234 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class.
8235 </summary>
8236 </member>
8237 <member name="M:NAnt.Core.Types.Argument.#ctor(System.String)">
8238 <summary>
8239 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
8240 with the specified command-line argument.
8241 </summary>
8242 </member>
8243 <member name="M:NAnt.Core.Types.Argument.#ctor(System.IO.FileInfo)">
8244 <summary>
8245 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
8246 with the given file.
8247 </summary>
8248 </member>
8249 <member name="M:NAnt.Core.Types.Argument.#ctor(NAnt.Core.Types.PathSet)">
8250 <summary>
8251 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
8252 with the given path.
8253 </summary>
8254 </member>
8255 <member name="M:NAnt.Core.Types.Argument.ToString">
8256 <summary>
8257 Returns the argument as a <see cref="T:System.String"/>.
8258 </summary>
8259 <returns>
8260 The argument as a <see cref="T:System.String"/>.
8261 </returns>
8262 <remarks>
8263 File and individual path elements will be quoted if necessary.
8264 </remarks>
8265 </member>
8266 <member name="M:NAnt.Core.Types.Argument.QuoteArgument(System.String)">
8267 <summary>
8268 Quotes a command line argument if it contains a single quote or a
8269 space.
8270 </summary>
8271 <param name="argument">The command line argument.</param>
8272 <returns>
8273 A quoted command line argument if <paramref name="argument" />
8274 contains a single quote or a space; otherwise,
8275 <paramref name="argument" />.
8276 </returns>
8277 </member>
8278 <member name="P:NAnt.Core.Types.Argument.Value">
8279 <summary>
8280 A single command-line argument; can contain space characters.
8281 </summary>
8282 </member>
8283 <member name="P:NAnt.Core.Types.Argument.File">
8284 <summary>
8285 The name of a file as a single command-line argument; will be
8286 replaced with the absolute filename of the file.
8287 </summary>
8288 </member>
8289 <member name="P:NAnt.Core.Types.Argument.Directory">
8290 <summary>
8291 The value for a directory-based command-line argument; will be
8292 replaced with the absolute path of the directory.
8293 </summary>
8294 </member>
8295 <member name="P:NAnt.Core.Types.Argument.Path">
8296 <summary>
8297 The value for a PATH-like command-line argument; you can use
8298 <c>:</c> or <c>;</c> as path separators and NAnt will convert it
8299 to the platform's local conventions, while resolving references to
8300 environment variables.
8301 </summary>
8302 <remarks>
8303 Individual parts will be replaced with the absolute path, resolved
8304 relative to the project base directory.
8305 </remarks>
8306 </member>
8307 <member name="P:NAnt.Core.Types.Argument.PathSet">
8308 <summary>
8309 Sets a single command-line argument and treats it like a PATH - ensures
8310 the right separator for the local platform is used.
8311 </summary>
8312 </member>
8313 <member name="P:NAnt.Core.Types.Argument.Line">
8314 <summary>
8315 List of command-line arguments; will be passed to the executable
8316 as is.
8317 </summary>
8318 </member>
8319 <member name="P:NAnt.Core.Types.Argument.IfDefined">
8320 <summary>
8321 Indicates if the argument should be passed to the external program.
8322 If <see langword="true" /> then the argument will be passed;
8323 otherwise, skipped. The default is <see langword="true" />.
8324 </summary>
8325 </member>
8326 <member name="P:NAnt.Core.Types.Argument.UnlessDefined">
8327 <summary>
8328 Indicates if the argument should not be passed to the external
8329 program. If <see langword="false" /> then the argument will be
8330 passed; otherwise, skipped. The default is <see langword="false" />.
8331 </summary>
8332 </member>
8333 <member name="P:NAnt.Core.Types.Argument.StringValue">
8334 <summary>
8335 Gets string value corresponding with the argument.
8336 </summary>
8337 </member>
8338 <member name="T:NAnt.Core.Types.ArgumentCollection">
8339 <summary>
8340 Contains a collection of <see cref="T:NAnt.Core.Types.Argument"/> elements.
8341 </summary>
8342 </member>
8343 <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor">
8344 <summary>
8345 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class.
8346 </summary>
8347 </member>
8348 <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor(NAnt.Core.Types.ArgumentCollection)">
8349 <summary>
8350 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class
8351 with the specified <see cref="T:NAnt.Core.Types.ArgumentCollection"/> instance.
8352 </summary>
8353 </member>
8354 <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor(NAnt.Core.Types.Argument[])">
8355 <summary>
8356 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class
8357 with the specified array of <see cref="T:NAnt.Core.Types.Argument"/> instances.
8358 </summary>
8359 </member>
8360 <member name="M:NAnt.Core.Types.ArgumentCollection.Add(NAnt.Core.Types.Argument)">
8361 <summary>
8362 Adds a <see cref="T:NAnt.Core.Types.Argument"/> to the end of the collection.
8363 </summary>
8364 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to be added to the end of the collection.</param>
8365 <returns>The position into which the new element was inserted.</returns>
8366 </member>
8367 <member name="M:NAnt.Core.Types.ArgumentCollection.AddRange(NAnt.Core.Types.Argument[])">
8368 <summary>
8369 Adds the elements of a <see cref="T:NAnt.Core.Types.Argument"/> array to the end of the collection.
8370 </summary>
8371 <param name="items">The array of <see cref="T:NAnt.Core.Types.Argument"/> elements to be added to the end of the collection.</param>
8372 </member>
8373 <member name="M:NAnt.Core.Types.ArgumentCollection.AddRange(NAnt.Core.Types.ArgumentCollection)">
8374 <summary>
8375 Adds the elements of a <see cref="T:NAnt.Core.Types.ArgumentCollection"/> to the end of the collection.
8376 </summary>
8377 <param name="items">The <see cref="T:NAnt.Core.Types.ArgumentCollection"/> to be added to the end of the collection.</param>
8378 </member>
8379 <member name="M:NAnt.Core.Types.ArgumentCollection.Contains(NAnt.Core.Types.Argument)">
8380 <summary>
8381 Determines whether a <see cref="T:NAnt.Core.Types.Argument"/> is in the collection.
8382 </summary>
8383 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to locate in the collection.</param>
8384 <returns>
8385 <see langword="true"/> if <paramref name="item"/> is found in the
8386 collection; otherwise, <see langword="false"/>.
8387 </returns>
8388 </member>
8389 <member name="M:NAnt.Core.Types.ArgumentCollection.Contains(System.String)">
8390 <summary>
8391 Determines whether a <see cref="T:NAnt.Core.Types.Argument"/> with the specified
8392 value is in the collection.
8393 </summary>
8394 <param name="value">The argument value to locate in the collection.</param>
8395 <returns>
8396 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.Argument"/> with value
8397 <paramref name="value"/> is found in the collection; otherwise,
8398 <see langword="false"/>.
8399 </returns>
8400 </member>
8401 <member name="M:NAnt.Core.Types.ArgumentCollection.CopyTo(NAnt.Core.Types.Argument[],System.Int32)">
8402 <summary>
8403 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
8404 </summary>
8405 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
8406 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
8407 </member>
8408 <member name="M:NAnt.Core.Types.ArgumentCollection.IndexOf(NAnt.Core.Types.Argument)">
8409 <summary>
8410 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Argument"/> object in the collection.
8411 </summary>
8412 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> object for which the index is returned.</param>
8413 <returns>
8414 The index of the specified <see cref="T:NAnt.Core.Types.Argument"/>. If the <see cref="T:NAnt.Core.Types.Argument"/> is not currently a member of the collection, it returns -1.
8415 </returns>
8416 </member>
8417 <member name="M:NAnt.Core.Types.ArgumentCollection.Insert(System.Int32,NAnt.Core.Types.Argument)">
8418 <summary>
8419 Inserts a <see cref="T:NAnt.Core.Types.Argument"/> into the collection at the specified index.
8420 </summary>
8421 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
8422 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to insert.</param>
8423 </member>
8424 <member name="M:NAnt.Core.Types.ArgumentCollection.GetEnumerator">
8425 <summary>
8426 Returns an enumerator that can iterate through the collection.
8427 </summary>
8428 <returns>
8429 A <see cref="T:NAnt.Core.Types.ArgumentEnumerator"/> for the entire collection.
8430 </returns>
8431 </member>
8432 <member name="M:NAnt.Core.Types.ArgumentCollection.Remove(NAnt.Core.Types.Argument)">
8433 <summary>
8434 Removes a member from the collection.
8435 </summary>
8436 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to remove from the collection.</param>
8437 </member>
8438 <member name="P:NAnt.Core.Types.ArgumentCollection.Item(System.Int32)">
8439 <summary>
8440 Gets or sets the element at the specified index.
8441 </summary>
8442 <param name="index">The zero-based index of the element to get or set.</param>
8443 </member>
8444 <member name="P:NAnt.Core.Types.ArgumentCollection.Item(System.String)">
8445 <summary>
8446 Gets the <see cref="T:NAnt.Core.Types.Argument"/> with the specified value.
8447 </summary>
8448 <param name="value">The value of the <see cref="T:NAnt.Core.Types.Argument"/> to get.</param>
8449 </member>
8450 <member name="T:NAnt.Core.Types.ArgumentEnumerator">
8451 <summary>
8452 Enumerates the <see cref="T:NAnt.Core.Types.Argument"/> elements of a <see cref="T:NAnt.Core.Types.ArgumentCollection"/>.
8453 </summary>
8454 </member>
8455 <member name="M:NAnt.Core.Types.ArgumentEnumerator.#ctor(NAnt.Core.Types.ArgumentCollection)">
8456 <summary>
8457 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentEnumerator"/> class
8458 with the specified <see cref="T:NAnt.Core.Types.ArgumentCollection"/>.
8459 </summary>
8460 <param name="arguments">The collection that should be enumerated.</param>
8461 </member>
8462 <member name="M:NAnt.Core.Types.ArgumentEnumerator.MoveNext">
8463 <summary>
8464 Advances the enumerator to the next element of the collection.
8465 </summary>
8466 <returns>
8467 <see langword="true" /> if the enumerator was successfully advanced
8468 to the next element; <see langword="false" /> if the enumerator has
8469 passed the end of the collection.
8470 </returns>
8471 </member>
8472 <member name="M:NAnt.Core.Types.ArgumentEnumerator.Reset">
8473 <summary>
8474 Sets the enumerator to its initial position, which is before the
8475 first element in the collection.
8476 </summary>
8477 </member>
8478 <member name="P:NAnt.Core.Types.ArgumentEnumerator.Current">
8479 <summary>
8480 Gets the current element in the collection.
8481 </summary>
8482 <returns>
8483 The current element in the collection.
8484 </returns>
8485 </member>
8486 <member name="T:NAnt.Core.Types.Credential">
8487 <summary>
8488 Provides credentials for password-based authentication schemes.
8489 </summary>
8490 </member>
8491 <member name="M:NAnt.Core.Types.Credential.#ctor">
8492 <summary>
8493 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Credential"/> class.
8494 </summary>
8495 </member>
8496 <member name="M:NAnt.Core.Types.Credential.GetCredential">
8497 <summary>
8498 Returns a <see cref="T:System.Net.NetworkCredential"/> instance representing
8499 the current <see cref="T:NAnt.Core.Types.Credential"/>.
8500 </summary>
8501 <returns>
8502 A <see cref="T:System.Net.NetworkCredential"/> instance representing the current
8503 <see cref="T:NAnt.Core.Types.Credential"/>, or <see langword="null"/> if the
8504 credentials should not be used to provide authentication information
8505 to the external resource.
8506 </returns>
8507 </member>
8508 <member name="P:NAnt.Core.Types.Credential.Domain">
8509 <summary>
8510 The domain or computer name that verifies the credentials.
8511 </summary>
8512 </member>
8513 <member name="P:NAnt.Core.Types.Credential.Password">
8514 <summary>
8515 The password for the user name associated with the credentials.
8516 </summary>
8517 </member>
8518 <member name="P:NAnt.Core.Types.Credential.UserName">
8519 <summary>
8520 The user name associated with the credentials.
8521 </summary>
8522 </member>
8523 <member name="P:NAnt.Core.Types.Credential.IfDefined">
8524 <summary>
8525 Indicates if the credentials should be used to provide authentication
8526 information to the external resource. If <see langword="true" /> then
8527 the credentials will be passed; otherwise, not. The default is
8528 <see langword="true" />.
8529 </summary>
8530 </member>
8531 <member name="P:NAnt.Core.Types.Credential.UnlessDefined">
8532 <summary>
8533 Indicates if the credentials should not be used to provide authentication
8534 information to the external resource. If <see langword="false" /> then the
8535 credentials will be passed; otherwise, not. The default is
8536 <see langword="false" />.
8537 </summary>
8538 </member>
8539 <member name="T:NAnt.Core.Types.DirSet">
8540 <summary>
8541 A specialized <see cref="T:NAnt.Core.Types.FileSet"/> used for specifying a set of
8542 directories.
8543 </summary>
8544 <remarks>
8545 Hint for supporting tasks that the included directories instead of
8546 files should be used.
8547 </remarks>
8548 </member>
8549 <member name="T:NAnt.Core.Types.FileSet">
8550 <summary>
8551 Filesets are groups of files. These files can be found in a directory
8552 tree starting in a base directory and are matched by patterns taken
8553 from a number of patterns. Filesets can appear inside tasks that support
8554 this feature or at the project level, i.e., as children of <c><project></c>.
8555 </summary>
8556 <remarks>
8557 <h3>Patterns</h3>
8558 <para>
8559 As described earlier, patterns are used for the inclusion and exclusion.
8560 These patterns look very much like the patterns used in DOS and UNIX:
8561 </para>
8562 <list type="bullet">
8563 <item>
8564 <description>
8565 <para>'<c>*</c>' matches zero or more characters</para>
8566 <para>For example:</para>
8567 <para>
8568 <c>*.cs</c> matches <c>.cs</c>, <c>x.cs</c> and <c>FooBar.cs</c>,
8569 but not <c>FooBar.xml</c> (does not end with <c>.cs</c>).
8570 </para>
8571 </description>
8572 </item>
8573 <item>
8574 <description>
8575 <para>'<c>?</c>' matches one character</para>
8576 <para>For example:</para>
8577 <para>
8578 <c>?.cs</c> matches <c>x.cs</c>, <c>A.cs</c>, but not
8579 <c>.cs</c> or <c>xyz.cs</c> (both don't have one character
8580 before <c>.cs</c>).
8581 </para>
8582 </description>
8583 </item>
8584 </list>
8585 <para>
8586 Combinations of <c>*</c>'s and <c>?</c>'s are allowed.
8587 </para>
8588 <para>
8589 Matching is done per-directory. This means that first the first directory
8590 in the pattern is matched against the first directory in the path to match.
8591 Then the second directory is matched, and so on. For example, when we have
8592 the pattern <c>/?abc/*/*.cs</c> and the path <c>/xabc/foobar/test.cs</c>,
8593 the first <c>?abc</c> is matched with <c>xabc</c>, then <c>*</c> is matched
8594 with <c>foobar</c>, and finally <c>*.cs</c> is matched with <c>test.cs</c>.
8595 They all match, so the path matches the pattern.
8596 </para>
8597 <para>
8598 To make things a bit more flexible, we added one extra feature, which makes
8599 it possible to match multiple directory levels. This can be used to match a
8600 complete directory tree, or a file anywhere in the directory tree. To do this,
8601 <c>**</c> must be used as the name of a directory. When <c>**</c> is used as
8602 the name of a directory in the pattern, it matches zero or more directories.
8603 For example: <c>/test/**</c> matches all files/directories under <c>/test/</c>,
8604 such as <c>/test/x.cs</c>, or <c>/test/foo/bar/xyz.html</c>, but not <c>/xyz.xml</c>.
8605 </para>
8606 <para>
8607 There is one "shorthand" - if a pattern ends with <c>/</c> or <c>\</c>, then
8608 <c>**</c> is appended. For example, <c>mypackage/test/</c> is interpreted as
8609 if it were <c>mypackage/test/**</c>.
8610 </para>
8611 <h3>Case-Sensitivity</h3>
8612 <para>
8613 By default, pattern matching is case-sensitive on Unix and case-insensitive
8614 on other platforms. The <see cref="P:NAnt.Core.Types.FileSet.CaseSensitive"/> parameter can be used
8615 to override this.
8616 </para>
8617 <h3>Default Excludes</h3>
8618 <para>
8619 There are a set of definitions that are excluded by default from all
8620 tasks that use filesets. They are:
8621 </para>
8622 <list type="bullet">
8623 <item>
8624 <description>
8625 **/*~
8626 </description>
8627 </item>
8628 <item>
8629 <description>
8630 **/#*#
8631 </description>
8632 </item>
8633 <item>
8634 <description>
8635 **/.#*
8636 </description>
8637 </item>
8638 <item>
8639 <description>
8640 **/%*%
8641 </description>
8642 </item>
8643 <item>
8644 <description>
8645 **/CVS
8646 </description>
8647 </item>
8648 <item>
8649 <description>
8650 **/CVS/**
8651 </description>
8652 </item>
8653 <item>
8654 <description>
8655 **/.cvsignore
8656 </description>
8657 </item>
8658 <item>
8659 <description>
8660 **/.svn
8661 </description>
8662 </item>
8663 <item>
8664 <description>
8665 **/.svn/**
8666 </description>
8667 </item>
8668 <item>
8669 <description>
8670 **/_svn
8671 </description>
8672 </item>
8673 <item>
8674 <description>
8675 **/_svn/**
8676 </description>
8677 </item>
8678 <item>
8679 <description>
8680 **/SCCS
8681 </description>
8682 </item>
8683 <item>
8684 <description>
8685 **/SCCS/**
8686 </description>
8687 </item>
8688 <item>
8689 <description>
8690 **/vssver.scc
8691 </description>
8692 </item>
8693 <item>
8694 <description>
8695 **/_vti_cnf/**
8696 </description>
8697 </item>
8698 </list>
8699 <para>
8700 If you do not want these default excludes applied, you may disable them
8701 by setting <see cref="P:NAnt.Core.Types.FileSet.DefaultExcludes"/> to <see langword="false"/>.
8702 </para>
8703 </remarks>
8704 <example>
8705 <list type="table">
8706 <listheader>
8707 <term>Pattern</term>
8708 <description>Match</description>
8709 </listheader>
8710 <item>
8711 <term><c>**/CVS/*</c></term>
8712 <description>
8713 <para>
8714 Matches all files in <c>CVS</c> directories that can be
8715 located anywhere in the directory tree.
8716 </para>
8717 <para>Matches:</para>
8718 <list type="bullet">
8719 <item>
8720 <description>CVS/Repository</description>
8721 </item>
8722 <item>
8723 <description>org/apache/CVS/Entries</description>
8724 </item>
8725 <item>
8726 <description>org/apache/jakarta/tools/ant/CVS/Entries</description>
8727 </item>
8728 </list>
8729 <para>But not:</para>
8730 <list type="bullet">
8731 <item>
8732 <description>org/apache/CVS/foo/bar/Entries (<c>foo/bar/</c> part does not match)</description>
8733 </item>
8734 </list>
8735 </description>
8736 </item>
8737 <item>
8738 <term><c>org/apache/jakarta/**</c></term>
8739 <description>
8740 <para>
8741 Matches all files in the <c>org/apache/jakarta</c> directory
8742 tree.
8743 </para>
8744 <para>Matches:</para>
8745 <list type="bullet">
8746 <item>
8747 <description>org/apache/jakarta/tools/ant/docs/index.html</description>
8748 </item>
8749 <item>
8750 <description>org/apache/jakarta/test.xml</description>
8751 </item>
8752 </list>
8753 <para>But not:</para>
8754 <list type="bullet">
8755 <item>
8756 <description>org/apache/xyz.java (<c>jakarta/</c> part is missing)</description>
8757 </item>
8758 </list>
8759 </description>
8760 </item>
8761 <item>
8762 <term><c>org/apache/**/CVS/*</c></term>
8763 <description>
8764 <para>
8765 Matches all files in <c>CVS</c> directories that are located
8766 anywhere in the directory tree under <c>org/apache</c>.
8767 </para>
8768 <para>Matches:</para>
8769 <list type="bullet">
8770 <item>
8771 <description>org/apache/CVS/Entries</description>
8772 </item>
8773 <item>
8774 <description>org/apache/jakarta/tools/ant/CVS/Entries</description>
8775 </item>
8776 </list>
8777 <para>But not:</para>
8778 <list type="bullet">
8779 <item>
8780 <description>org/apache/CVS/foo/bar/Entries (<c>foo/bar/</c> part does not match)</description>
8781 </item>
8782 </list>
8783 </description>
8784 </item>
8785 <item>
8786 <term><c>**/test/**</c></term>
8787 <description>
8788 <para>
8789 Matches all files that have a <c>test</c> element in their
8790 path, including <c>test</c> as a filename.
8791 </para>
8792 </description>
8793 </item>
8794 </list>
8795 </example>
8796 <seealso cref="T:NAnt.Core.Types.PatternSet"/>
8797 </member>
8798 <member name="M:NAnt.Core.Types.FileSet.#ctor">
8799 <summary>
8800 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FileSet"/> class.
8801 </summary>
8802 </member>
8803 <member name="M:NAnt.Core.Types.FileSet.#ctor(NAnt.Core.Types.FileSet)">
8804 <summary>
8805 copy constructor
8806 </summary>
8807 <param name="fs"></param>
8808 </member>
8809 <member name="M:NAnt.Core.Types.FileSet.Clone">
8810 <summary>
8811 Creates a shallow copy of the <see cref="T:NAnt.Core.Types.FileSet"/>.
8812 </summary>
8813 <returns>
8814 A shallow copy of the <see cref="T:NAnt.Core.Types.FileSet"/>.
8815 </returns>
8816 </member>
8817 <member name="M:NAnt.Core.Types.FileSet.AddPatternSet(NAnt.Core.Types.PatternSet)">
8818 <summary>
8819 Adds a nested set of patterns, or references a standalone patternset.
8820 </summary>
8821 </member>
8822 <member name="M:NAnt.Core.Types.FileSet.CopyTo(NAnt.Core.Types.FileSet)">
8823 <summary>
8824 Copies all instance data of the <see cref="T:NAnt.Core.Types.FileSet"/> to a given
8825 <see cref="T:NAnt.Core.Types.FileSet"/>.
8826 </summary>
8827 </member>
8828 <member name="M:NAnt.Core.Types.FileSet.FindMoreRecentLastWriteTime(System.String,System.DateTime)">
8829 <summary>
8830 Determines if a file has a more recent last write time than the
8831 given time, or no longer exists.
8832 </summary>
8833 <param name="fileName">A file to check the last write time against.</param>
8834 <param name="targetLastWriteTime">The datetime to compare against.</param>
8835 <returns>
8836 The name of the file that has a last write time greater than
8837 <paramref name="targetLastWriteTime" /> or that no longer exists;
8838 otherwise, <see langword="null" />.
8839 </returns>
8840 </member>
8841 <member name="M:NAnt.Core.Types.FileSet.FindMoreRecentLastWriteTime(System.Collections.Specialized.StringCollection,System.DateTime)">
8842 <summary>
8843 Determines if one of the given files has a more recent last write
8844 time than the given time. If one of the given files no longer exists,
8845 the target will be considered out-of-date.
8846 </summary>
8847 <param name="fileNames">A collection of filenames to check the last write time against.</param>
8848 <param name="targetLastWriteTime">The datetime to compare against.</param>
8849 <returns>
8850 The name of the first file that has a last write time greater than
8851 <paramref name="targetLastWriteTime" />; otherwise, null.
8852 </returns>
8853 </member>
8854 <member name="P:NAnt.Core.Types.FileSet.CaseSensitive">
8855 <summary>
8856 Indicates whether include and exclude patterns must be treated in a
8857 case-sensitive way. The default is <see langword="true" /> on Unix;
8858 otherwise, <see langword="false" />.
8859 </summary>
8860 </member>
8861 <member name="P:NAnt.Core.Types.FileSet.FailOnEmpty">
8862 <summary>
8863 When set to <see langword="true"/>, causes the fileset element to
8864 throw a <see cref="T:NAnt.Core.ValidationException"/> when no files match the
8865 includes and excludes criteria. The default is <see langword="false"/>.
8866 </summary>
8867 </member>
8868 <member name="P:NAnt.Core.Types.FileSet.DefaultExcludes">
8869 <summary>
8870 Indicates whether default excludes should be used or not.
8871 The default is <see langword="true" />.
8872 </summary>
8873 </member>
8874 <member name="P:NAnt.Core.Types.FileSet.BaseDirectory">
8875 <summary>
8876 The base of the directory of this fileset. The default is the project
8877 base directory.
8878 </summary>
8879 </member>
8880 <member name="P:NAnt.Core.Types.FileSet.Includes">
8881 <summary>
8882 Gets the collection of include patterns.
8883 </summary>
8884 </member>
8885 <member name="P:NAnt.Core.Types.FileSet.Excludes">
8886 <summary>
8887 Gets the collection of exclude patterns.
8888 </summary>
8889 </member>
8890 <member name="P:NAnt.Core.Types.FileSet.AsIs">
8891 <summary>
8892 Gets the collection of files that will be added to the
8893 <see cref="T:NAnt.Core.Types.FileSet"/> without pattern matching or checking if the
8894 file exists.
8895 </summary>
8896 </member>
8897 <member name="P:NAnt.Core.Types.FileSet.FileNames">
8898 <summary>
8899 Gets the collection of file names that match the fileset.
8900 </summary>
8901 <value>
8902 A collection that contains the file names that match the
8903 <see cref="T:NAnt.Core.Types.FileSet"/>.
8904 </value>
8905 </member>
8906 <member name="P:NAnt.Core.Types.FileSet.DirectoryNames">
8907 <summary>
8908 Gets the collection of directory names that match the fileset.
8909 </summary>
8910 <value>
8911 A collection that contains the directory names that match the
8912 <see cref="T:NAnt.Core.Types.FileSet"/>.
8913 </value>
8914 </member>
8915 <member name="P:NAnt.Core.Types.FileSet.ScannedDirectories">
8916 <summary>
8917 Gets the collection of directory names that were scanned for files.
8918 </summary>
8919 <value>
8920 A collection that contains the directory names that were scanned for
8921 files.
8922 </value>
8923 </member>
8924 <member name="P:NAnt.Core.Types.FileSet.SetIncludes">
8925 <summary>
8926 The items to include in the fileset.
8927 </summary>
8928 </member>
8929 <member name="P:NAnt.Core.Types.FileSet.IncludeElements">
8930 <summary>
8931 The items to include in the fileset.
8932 </summary>
8933 </member>
8934 <member name="P:NAnt.Core.Types.FileSet.SetExcludes">
8935 <summary>
8936 The items to exclude from the fileset.
8937 </summary>
8938 </member>
8939 <member name="P:NAnt.Core.Types.FileSet.ExcludeElements">
8940 <summary>
8941 The items to exclude from the fileset.
8942 </summary>
8943 </member>
8944 <member name="P:NAnt.Core.Types.FileSet.SetIncludesList">
8945 <summary>
8946 The files from which a list of patterns or files to include should
8947 be obtained.
8948 </summary>
8949 </member>
8950 <member name="P:NAnt.Core.Types.FileSet.IncludesFiles">
8951 <summary>
8952 The files from which a list of patterns or files to include should
8953 be obtained.
8954 </summary>
8955 </member>
8956 <member name="P:NAnt.Core.Types.FileSet.ExcludesFiles">
8957 <summary>
8958 The files from which a list of patterns or files to exclude should
8959 be obtained.
8960 </summary>
8961 </member>
8962 <member name="P:NAnt.Core.Types.FileSet.MostRecentLastWriteTimeFile">
8963 <summary>
8964 Determines the most recently modified file in the fileset (by LastWriteTime of the <see cref="T:System.IO.FileInfo"/>).
8965 </summary>
8966 <returns>
8967 The <see cref="T:System.IO.FileInfo"/> of the file that has the newest (closest to present) last write time.
8968 </returns>
8969 </member>
8970 <member name="P:NAnt.Core.Types.FileSet.Exclude.Pattern">
8971 <summary>
8972 The pattern or file name to exclude.
8973 </summary>
8974 </member>
8975 <member name="P:NAnt.Core.Types.FileSet.Exclude.IfDefined">
8976 <summary>
8977 If <see langword="true" /> then the pattern will be excluded;
8978 otherwise, skipped. The default is <see langword="true" />.
8979 </summary>
8980 </member>
8981 <member name="P:NAnt.Core.Types.FileSet.Exclude.UnlessDefined">
8982 <summary>
8983 Opposite of <see cref="P:NAnt.Core.Types.FileSet.Exclude.IfDefined"/>. If <see langword="false"/>
8984 then the pattern will be excluded; otherwise, skipped. The default
8985 is <see langword="false"/>.
8986 </summary>
8987 </member>
8988 <member name="P:NAnt.Core.Types.FileSet.Include.AsIs">
8989 <summary>
8990 If <see langword="true"/> then the file name will be added to
8991 the <see cref="T:NAnt.Core.Types.FileSet"/> without pattern matching or checking
8992 if the file exists. The default is <see langword="false"/>.
8993 </summary>
8994 </member>
8995 <member name="P:NAnt.Core.Types.FileSet.Include.FromPath">
8996 <summary>
8997 If <see langword="true" /> then the file will be searched for
8998 on the path. The default is <see langword="false" />.
8999 </summary>
9000 </member>
9001 <member name="P:NAnt.Core.Types.FileSet.Include.Pattern">
9002 <summary>
9003 The pattern or file name to include.
9004 </summary>
9005 </member>
9006 <member name="P:NAnt.Core.Types.FileSet.Include.IfDefined">
9007 <summary>
9008 If <see langword="true" /> then the pattern will be included;
9009 otherwise, skipped. The default is <see langword="true" />.
9010 </summary>
9011 </member>
9012 <member name="P:NAnt.Core.Types.FileSet.Include.UnlessDefined">
9013 <summary>
9014 Opposite of <see cref="P:NAnt.Core.Types.FileSet.Include.IfDefined"/>. If <see langword="false"/>
9015 then the pattern will be included; otherwise, skipped. The default
9016 is <see langword="false"/>.
9017 </summary>
9018 </member>
9019 <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.Patterns">
9020 <summary>
9021 Gets the list of patterns in <see cref="P:NAnt.Core.Types.FileSet.ExcludesFile.PatternFile"/>.
9022 </summary>
9023 </member>
9024 <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.IfDefined">
9025 <summary>
9026 If <see langword="true" /> then the patterns will be excluded;
9027 otherwise, skipped. The default is <see langword="true" />.
9028 </summary>
9029 </member>
9030 <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.UnlessDefined">
9031 <summary>
9032 Opposite of <see cref="P:NAnt.Core.Types.FileSet.ExcludesFile.IfDefined"/>. If <see langword="false"/>
9033 then the patterns will be excluded; otherwise, skipped. The default
9034 is <see langword="false"/>.
9035 </summary>
9036 </member>
9037 <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.PatternFile">
9038 <summary>
9039 The name of a file; each line of this file is taken to be a
9040 pattern.
9041 </summary>
9042 </member>
9043 <member name="P:NAnt.Core.Types.FileSet.IncludesFile.AsIs">
9044 <summary>
9045 If <see langword="true"/> then the patterns in the include file
9046 will be added to the <see cref="T:NAnt.Core.Types.FileSet"/> without pattern
9047 matching or checking if the file exists. The default is
9048 <see langword="false"/>.
9049 </summary>
9050 </member>
9051 <member name="P:NAnt.Core.Types.FileSet.IncludesFile.FromPath">
9052 <summary>
9053 If <see langword="true" /> then the patterns in the include file
9054 will be searched for on the path. The default is <see langword="false" />.
9055 </summary>
9056 </member>
9057 <member name="P:NAnt.Core.Types.FileSet.IncludesFile.IfDefined">
9058 <summary>
9059 If <see langword="true" /> then the patterns will be included;
9060 otherwise, skipped. The default is <see langword="true" />.
9061 </summary>
9062 </member>
9063 <member name="P:NAnt.Core.Types.FileSet.IncludesFile.UnlessDefined">
9064 <summary>
9065 Opposite of <see cref="P:NAnt.Core.Types.FileSet.IncludesFile.IfDefined"/>. If <see langword="false"/>
9066 then the patterns will be included; otherwise, skipped. The default
9067 is <see langword="false"/>.
9068 </summary>
9069 </member>
9070 <member name="M:NAnt.Core.Types.DirSet.#ctor">
9071 <summary>
9072 Initializes a new instance of the <see cref="T:NAnt.Core.Types.DirSet"/> class.
9073 </summary>
9074 </member>
9075 <member name="M:NAnt.Core.Types.DirSet.#ctor(NAnt.Core.Types.FileSet)">
9076 <summary>
9077 Copy constructor for <see cref="T:NAnt.Core.Types.FileSet"/>. Required in order to
9078 assign references of <see cref="T:NAnt.Core.Types.FileSet"/> type where
9079 <see cref="T:NAnt.Core.Types.DirSet"/> is used.
9080 </summary>
9081 <param name="fs">A <see cref="T:NAnt.Core.Types.FileSet"/> instance to create a <see cref="T:NAnt.Core.Types.DirSet"/> from.</param>
9082 </member>
9083 <member name="T:NAnt.Core.Types.EnvironmentVariable">
9084 <summary>
9085 Represents an environment variable.
9086 </summary>
9087 </member>
9088 <member name="M:NAnt.Core.Types.EnvironmentVariable.#ctor(System.String,System.String)">
9089 <summary>
9090 Initializes a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instance with the
9091 specified name and value.
9092 </summary>
9093 <param name="name">The name of the environment variable.</param>
9094 <param name="value">The value of the environment variable.</param>
9095 </member>
9096 <member name="M:NAnt.Core.Types.EnvironmentVariable.#ctor">
9097 <summary>
9098 Initializes a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instance.
9099 </summary>
9100 </member>
9101 <member name="P:NAnt.Core.Types.EnvironmentVariable.VariableName">
9102 <summary>
9103 The name of the environment variable.
9104 </summary>
9105 </member>
9106 <member name="P:NAnt.Core.Types.EnvironmentVariable.LiteralValue">
9107 <summary>
9108 The literal value for the environment variable.
9109 </summary>
9110 </member>
9111 <member name="P:NAnt.Core.Types.EnvironmentVariable.File">
9112 <summary>
9113 The value for a file-based environment variable. NAnt will convert
9114 it to an absolute filename.
9115 </summary>
9116 </member>
9117 <member name="P:NAnt.Core.Types.EnvironmentVariable.Directory">
9118 <summary>
9119 The value for a directory-based environment variable. NAnt will
9120 convert it to an absolute path.
9121 </summary>
9122 </member>
9123 <member name="P:NAnt.Core.Types.EnvironmentVariable.Path">
9124 <summary>
9125 The value for a PATH like environment variable. You can use
9126 <c>:</c> or <c>;</c> as path separators and NAnt will convert it to
9127 the platform's local conventions.
9128 </summary>
9129 </member>
9130 <member name="P:NAnt.Core.Types.EnvironmentVariable.PathSet">
9131 <summary>
9132 Sets a single environment variable and treats it like a PATH -
9133 ensures the right separator for the local platform is used.
9134 </summary>
9135 </member>
9136 <member name="P:NAnt.Core.Types.EnvironmentVariable.Value">
9137 <summary>
9138 Gets the value of the environment variable.
9139 </summary>
9140 </member>
9141 <member name="P:NAnt.Core.Types.EnvironmentVariable.IfDefined">
9142 <summary>
9143 Indicates if the environment variable should be passed to the
9144 external program. If <see langword="true" /> then the environment
9145 variable will be passed; otherwise, skipped. The default is
9146 <see langword="true" />.
9147 </summary>
9148 </member>
9149 <member name="P:NAnt.Core.Types.EnvironmentVariable.UnlessDefined">
9150 <summary>
9151 Indicates if the environment variable should not be passed to the
9152 external program. If <see langword="false" /> then the environment
9153 variable will be passed; otherwise, skipped. The default is
9154 <see langword="false" />.
9155 </summary>
9156 </member>
9157 <member name="T:NAnt.Core.Types.EnvironmentSet">
9158 <summary>
9159 A set of environment variables.
9160 </summary>
9161 </member>
9162 <member name="P:NAnt.Core.Types.EnvironmentSet.Options">
9163 <summary>
9164 Environment variable to pass to a program.
9165 </summary>
9166 </member>
9167 <member name="P:NAnt.Core.Types.EnvironmentSet.EnvironmentVariables">
9168 <summary>
9169 Environment variable to pass to a program.
9170 </summary>
9171 </member>
9172 <member name="T:NAnt.Core.Types.EnvironmentVariableCollection">
9173 <summary>
9174 Contains a collection of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements.
9175 </summary>
9176 </member>
9177 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor">
9178 <summary>
9179 Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class.
9180 </summary>
9181 </member>
9182 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor(NAnt.Core.Types.EnvironmentVariableCollection)">
9183 <summary>
9184 Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class
9185 with the specified <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> instance.
9186 </summary>
9187 </member>
9188 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor(NAnt.Core.Types.EnvironmentVariable[])">
9189 <summary>
9190 Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class
9191 with the specified array of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instances.
9192 </summary>
9193 </member>
9194 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Add(NAnt.Core.Types.EnvironmentVariable)">
9195 <summary>
9196 Adds a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to the end of the collection.
9197 </summary>
9198 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to be added to the end of the collection.</param>
9199 <returns>The position into which the new element was inserted.</returns>
9200 </member>
9201 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.AddRange(NAnt.Core.Types.EnvironmentVariable[])">
9202 <summary>
9203 Adds the elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> array to the end of the collection.
9204 </summary>
9205 <param name="items">The array of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements to be added to the end of the collection.</param>
9206 </member>
9207 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.AddRange(NAnt.Core.Types.EnvironmentVariableCollection)">
9208 <summary>
9209 Adds the elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> to the end of the collection.
9210 </summary>
9211 <param name="items">The <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> to be added to the end of the collection.</param>
9212 </member>
9213 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Contains(NAnt.Core.Types.EnvironmentVariable)">
9214 <summary>
9215 Determines whether a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> is in the collection.
9216 </summary>
9217 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to locate in the collection.</param>
9218 <returns>
9219 <see langword="true"/> if <paramref name="item"/> is found in the
9220 collection; otherwise, <see langword="false"/>.
9221 </returns>
9222 </member>
9223 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Contains(System.String)">
9224 <summary>
9225 Determines whether a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with the specified
9226 value is in the collection.
9227 </summary>
9228 <param name="value">The argument value to locate in the collection.</param>
9229 <returns>
9230 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with value
9231 <paramref name="value"/> is found in the collection; otherwise,
9232 <see langword="false"/>.
9233 </returns>
9234 </member>
9235 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.CopyTo(NAnt.Core.Types.EnvironmentVariable[],System.Int32)">
9236 <summary>
9237 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
9238 </summary>
9239 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
9240 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
9241 </member>
9242 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.IndexOf(NAnt.Core.Types.EnvironmentVariable)">
9243 <summary>
9244 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> object in the collection.
9245 </summary>
9246 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> object for which the index is returned.</param>
9247 <returns>
9248 The index of the specified <see cref="T:NAnt.Core.Types.EnvironmentVariable"/>. If the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> is not currently a member of the collection, it returns -1.
9249 </returns>
9250 </member>
9251 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Insert(System.Int32,NAnt.Core.Types.EnvironmentVariable)">
9252 <summary>
9253 Inserts a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> into the collection at the specified index.
9254 </summary>
9255 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
9256 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to insert.</param>
9257 </member>
9258 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.GetEnumerator">
9259 <summary>
9260 Returns an enumerator that can iterate through the collection.
9261 </summary>
9262 <returns>
9263 A <see cref="T:NAnt.Core.Types.EnvironmentVariableEnumerator"/> for the entire collection.
9264 </returns>
9265 </member>
9266 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Remove(NAnt.Core.Types.EnvironmentVariable)">
9267 <summary>
9268 Removes a member from the collection.
9269 </summary>
9270 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to remove from the collection.</param>
9271 </member>
9272 <member name="P:NAnt.Core.Types.EnvironmentVariableCollection.Item(System.Int32)">
9273 <summary>
9274 Gets or sets the element at the specified index.
9275 </summary>
9276 <param name="index">The zero-based index of the element to get or set.</param>
9277 </member>
9278 <member name="P:NAnt.Core.Types.EnvironmentVariableCollection.Item(System.String)">
9279 <summary>
9280 Gets the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with the specified name.
9281 </summary>
9282 <param name="name">The name of the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to get.</param>
9283 </member>
9284 <member name="T:NAnt.Core.Types.EnvironmentVariableEnumerator">
9285 <summary>
9286 Enumerates the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/>.
9287 </summary>
9288 </member>
9289 <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.#ctor(NAnt.Core.Types.EnvironmentVariableCollection)">
9290 <summary>
9291 Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableEnumerator"/> class
9292 with the specified <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/>.
9293 </summary>
9294 <param name="arguments">The collection that should be enumerated.</param>
9295 </member>
9296 <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.MoveNext">
9297 <summary>
9298 Advances the enumerator to the next element of the collection.
9299 </summary>
9300 <returns>
9301 <see langword="true" /> if the enumerator was successfully advanced
9302 to the next element; <see langword="false" /> if the enumerator has
9303 passed the end of the collection.
9304 </returns>
9305 </member>
9306 <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.Reset">
9307 <summary>
9308 Sets the enumerator to its initial position, which is before the
9309 first element in the collection.
9310 </summary>
9311 </member>
9312 <member name="P:NAnt.Core.Types.EnvironmentVariableEnumerator.Current">
9313 <summary>
9314 Gets the current element in the collection.
9315 </summary>
9316 <returns>
9317 The current element in the collection.
9318 </returns>
9319 </member>
9320 <member name="P:NAnt.Core.Types.Formatter.Property">
9321 <summary>
9322 The name of the NAnt property to set.
9323 </summary>
9324 </member>
9325 <member name="P:NAnt.Core.Types.Formatter.Pattern">
9326 <summary>
9327 The string pattern to use to format the property.
9328 </summary>
9329 </member>
9330 <member name="P:NAnt.Core.Types.Formatter.IfDefined">
9331 <summary>
9332 Indicates if the formatter should be used to format the timestamp.
9333 If <see langword="true" /> then the formatter will be used;
9334 otherwise, skipped. The default is <see langword="true" />.
9335 </summary>
9336 </member>
9337 <member name="P:NAnt.Core.Types.Formatter.UnlessDefined">
9338 <summary>
9339 Indicates if the formatter should be not used to format the
9340 timestamp. If <see langword="false" /> then the formatter will be
9341 used; otherwise, skipped. The default is <see langword="false" />.
9342 </summary>
9343 </member>
9344 <member name="T:NAnt.Core.Types.FormatterCollection">
9345 <summary>
9346 Contains a collection of <see cref="T:NAnt.Core.Types.Formatter"/> elements.
9347 </summary>
9348 </member>
9349 <member name="M:NAnt.Core.Types.FormatterCollection.#ctor">
9350 <summary>
9351 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class.
9352 </summary>
9353 </member>
9354 <member name="M:NAnt.Core.Types.FormatterCollection.#ctor(NAnt.Core.Types.FormatterCollection)">
9355 <summary>
9356 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class
9357 with the specified <see cref="T:NAnt.Core.Types.FormatterCollection"/> instance.
9358 </summary>
9359 </member>
9360 <member name="M:NAnt.Core.Types.FormatterCollection.#ctor(NAnt.Core.Types.Formatter[])">
9361 <summary>
9362 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class
9363 with the specified array of <see cref="T:NAnt.Core.Types.Formatter"/> instances.
9364 </summary>
9365 </member>
9366 <member name="M:NAnt.Core.Types.FormatterCollection.Add(NAnt.Core.Types.Formatter)">
9367 <summary>
9368 Adds a <see cref="T:NAnt.Core.Types.Formatter"/> to the end of the collection.
9369 </summary>
9370 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to be added to the end of the collection.</param>
9371 <returns>The position into which the new element was inserted.</returns>
9372 </member>
9373 <member name="M:NAnt.Core.Types.FormatterCollection.AddRange(NAnt.Core.Types.Formatter[])">
9374 <summary>
9375 Adds the elements of a <see cref="T:NAnt.Core.Types.Formatter"/> array to the end of the collection.
9376 </summary>
9377 <param name="items">The array of <see cref="T:NAnt.Core.Types.Formatter"/> elements to be added to the end of the collection.</param>
9378 </member>
9379 <member name="M:NAnt.Core.Types.FormatterCollection.AddRange(NAnt.Core.Types.FormatterCollection)">
9380 <summary>
9381 Adds the elements of a <see cref="T:NAnt.Core.Types.FormatterCollection"/> to the end of the collection.
9382 </summary>
9383 <param name="items">The <see cref="T:NAnt.Core.Types.FormatterCollection"/> to be added to the end of the collection.</param>
9384 </member>
9385 <member name="M:NAnt.Core.Types.FormatterCollection.Contains(NAnt.Core.Types.Formatter)">
9386 <summary>
9387 Determines whether a <see cref="T:NAnt.Core.Types.Formatter"/> is in the collection.
9388 </summary>
9389 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to locate in the collection.</param>
9390 <returns>
9391 <see langword="true"/> if <paramref name="item"/> is found in the
9392 collection; otherwise, <see langword="false"/>.
9393 </returns>
9394 </member>
9395 <member name="M:NAnt.Core.Types.FormatterCollection.CopyTo(NAnt.Core.Types.Formatter[],System.Int32)">
9396 <summary>
9397 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
9398 </summary>
9399 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
9400 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
9401 </member>
9402 <member name="M:NAnt.Core.Types.FormatterCollection.IndexOf(NAnt.Core.Types.Formatter)">
9403 <summary>
9404 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Formatter"/> object in the collection.
9405 </summary>
9406 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> object for which the index is returned.</param>
9407 <returns>
9408 The index of the specified <see cref="T:NAnt.Core.Types.Formatter"/>. If the <see cref="T:NAnt.Core.Types.Formatter"/> is not currently a member of the collection, it returns -1.
9409 </returns>
9410 </member>
9411 <member name="M:NAnt.Core.Types.FormatterCollection.Insert(System.Int32,NAnt.Core.Types.Formatter)">
9412 <summary>
9413 Inserts a <see cref="T:NAnt.Core.Types.Formatter"/> into the collection at the specified index.
9414 </summary>
9415 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
9416 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to insert.</param>
9417 </member>
9418 <member name="M:NAnt.Core.Types.FormatterCollection.GetEnumerator">
9419 <summary>
9420 Returns an enumerator that can iterate through the collection.
9421 </summary>
9422 <returns>
9423 A <see cref="T:NAnt.Core.Types.FormatterEnumerator"/> for the entire collection.
9424 </returns>
9425 </member>
9426 <member name="M:NAnt.Core.Types.FormatterCollection.Remove(NAnt.Core.Types.Formatter)">
9427 <summary>
9428 Removes a member from the collection.
9429 </summary>
9430 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to remove from the collection.</param>
9431 </member>
9432 <member name="P:NAnt.Core.Types.FormatterCollection.Item(System.Int32)">
9433 <summary>
9434 Gets or sets the element at the specified index.
9435 </summary>
9436 <param name="index">The zero-based index of the element to get or set.</param>
9437 </member>
9438 <member name="T:NAnt.Core.Types.FormatterEnumerator">
9439 <summary>
9440 Enumerates the <see cref="T:NAnt.Core.Types.Formatter"/> elements of a <see cref="T:NAnt.Core.Types.FormatterCollection"/>.
9441 </summary>
9442 </member>
9443 <member name="M:NAnt.Core.Types.FormatterEnumerator.#ctor(NAnt.Core.Types.FormatterCollection)">
9444 <summary>
9445 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterEnumerator"/> class
9446 with the specified <see cref="T:NAnt.Core.Types.FormatterCollection"/>.
9447 </summary>
9448 <param name="arguments">The collection that should be enumerated.</param>
9449 </member>
9450 <member name="M:NAnt.Core.Types.FormatterEnumerator.MoveNext">
9451 <summary>
9452 Advances the enumerator to the next element of the collection.
9453 </summary>
9454 <returns>
9455 <see langword="true" /> if the enumerator was successfully advanced
9456 to the next element; <see langword="false" /> if the enumerator has
9457 passed the end of the collection.
9458 </returns>
9459 </member>
9460 <member name="M:NAnt.Core.Types.FormatterEnumerator.Reset">
9461 <summary>
9462 Sets the enumerator to its initial position, which is before the
9463 first element in the collection.
9464 </summary>
9465 </member>
9466 <member name="P:NAnt.Core.Types.FormatterEnumerator.Current">
9467 <summary>
9468 Gets the current element in the collection.
9469 </summary>
9470 <returns>
9471 The current element in the collection.
9472 </returns>
9473 </member>
9474 <member name="T:NAnt.Core.Types.ManagedExecution">
9475 <summary>
9476 Specifies the execution mode for managed applications.
9477 </summary>
9478 <remarks>
9479 <para>
9480 For backward compatibility, the following string values can also be
9481 used in build files:
9482 </para>
9483 <list type="table">
9484 <listheader>
9485 <term>Value</term>
9486 <description>Corresponding field</description>
9487 </listheader>
9488 <item>
9489 <term>"true"</term>
9490 <description><see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/></description>
9491 </item>
9492 <item>
9493 <term>"false"</term>
9494 <description><see cref="F:NAnt.Core.Types.ManagedExecution.Default"/></description>
9495 </item>
9496 </list>
9497 <para>
9498 Even if set to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>, the operating system can still
9499 run the program as a managed application.
9500 </para>
9501 <para>On Linux this can be done through <b>binfmt_misc</b>, while on
9502 Windows installing the .NET Framework redistributable caused managed
9503 applications to run on the MS CLR by default.
9504 </para>
9505 </remarks>
9506 </member>
9507 <member name="F:NAnt.Core.Types.ManagedExecution.Default">
9508 <summary>
9509 Do not threat the program as a managed application.
9510 </summary>
9511 </member>
9512 <member name="F:NAnt.Core.Types.ManagedExecution.Auto">
9513 <summary>
9514 Leave it up to the CLR to determine which specific version of
9515 the CLR will be used to run the application.
9516 </summary>
9517 </member>
9518 <member name="F:NAnt.Core.Types.ManagedExecution.Strict">
9519 <summary>
9520 Forces an application to run against the currently targeted
9521 version of a given CLR.
9522 </summary>
9523 </member>
9524 <member name="T:NAnt.Core.Types.ManagedExecutionConverter">
9525 <summary>
9526 Specialized <see cref="T:System.ComponentModel.EnumConverter"/> that also supports
9527 case-insensitive conversion of "true" to
9528 <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/> and "false" to
9529 <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>.
9530 </summary>
9531 </member>
9532 <member name="M:NAnt.Core.Types.ManagedExecutionConverter.#ctor">
9533 <summary>
9534 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ManagedExecutionConverter"/>
9535 class.
9536 </summary>
9537 </member>
9538 <member name="M:NAnt.Core.Types.ManagedExecutionConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
9539 <summary>
9540 Converts the given object to the type of this converter, using the
9541 specified context and culture information.
9542 </summary>
9543 <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
9544 <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
9545 <param name="value">The <see cref="T:System.Object"/> to convert.</param>
9546 <returns>
9547 An <see cref="T:System.Object"/> that represents the converted value.
9548 </returns>
9549 </member>
9550 <member name="T:NAnt.Core.Types.Option">
9551 <summary>
9552 Represents an option.
9553 </summary>
9554 </member>
9555 <member name="M:NAnt.Core.Types.Option.#ctor(System.String,System.String)">
9556 <summary>
9557 name, value constructor
9558 </summary>
9559 <param name="name"></param>
9560 <param name="value"></param>
9561 </member>
9562 <member name="M:NAnt.Core.Types.Option.#ctor">
9563 <summary>
9564 Default constructor
9565 </summary>
9566 </member>
9567 <member name="P:NAnt.Core.Types.Option.OptionName">
9568 <summary>
9569 Name of the option.
9570 </summary>
9571 </member>
9572 <member name="P:NAnt.Core.Types.Option.Value">
9573 <summary>
9574 Value of the option. The default is <see langword="null" />.
9575 </summary>
9576 </member>
9577 <member name="P:NAnt.Core.Types.Option.IfDefined">
9578 <summary>
9579 Indicates if the option should be passed to the task.
9580 If <see langword="true" /> then the option will be passed;
9581 otherwise, skipped. The default is <see langword="true" />.
9582 </summary>
9583 </member>
9584 <member name="P:NAnt.Core.Types.Option.UnlessDefined">
9585 <summary>
9586 Indicates if the option should not be passed to the task.
9587 If <see langword="false" /> then the option will be passed;
9588 otherwise, skipped. The default is <see langword="false" />.
9589 </summary>
9590 </member>
9591 <member name="T:NAnt.Core.Types.OptionCollection">
9592 <summary>
9593 Contains a collection of <see cref="T:NAnt.Core.Types.Option"/> elements.
9594 </summary>
9595 </member>
9596 <member name="M:NAnt.Core.Types.OptionCollection.#ctor">
9597 <summary>
9598 Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class.
9599 </summary>
9600 </member>
9601 <member name="M:NAnt.Core.Types.OptionCollection.#ctor(NAnt.Core.Types.OptionCollection)">
9602 <summary>
9603 Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class
9604 with the specified <see cref="T:NAnt.Core.Types.OptionCollection"/> instance.
9605 </summary>
9606 </member>
9607 <member name="M:NAnt.Core.Types.OptionCollection.#ctor(NAnt.Core.Types.Option[])">
9608 <summary>
9609 Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class
9610 with the specified array of <see cref="T:NAnt.Core.Types.Option"/> instances.
9611 </summary>
9612 </member>
9613 <member name="M:NAnt.Core.Types.OptionCollection.Add(NAnt.Core.Types.Option)">
9614 <summary>
9615 Adds a <see cref="T:NAnt.Core.Types.Option"/> to the end of the collection.
9616 </summary>
9617 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to be added to the end of the collection.</param>
9618 <returns>The position into which the new element was inserted.</returns>
9619 </member>
9620 <member name="M:NAnt.Core.Types.OptionCollection.AddRange(NAnt.Core.Types.Option[])">
9621 <summary>
9622 Adds the elements of a <see cref="T:NAnt.Core.Types.Option"/> array to the end of the collection.
9623 </summary>
9624 <param name="items">The array of <see cref="T:NAnt.Core.Types.Option"/> elements to be added to the end of the collection.</param>
9625 </member>
9626 <member name="M:NAnt.Core.Types.OptionCollection.AddRange(NAnt.Core.Types.OptionCollection)">
9627 <summary>
9628 Adds the elements of a <see cref="T:NAnt.Core.Types.OptionCollection"/> to the end of the collection.
9629 </summary>
9630 <param name="items">The <see cref="T:NAnt.Core.Types.OptionCollection"/> to be added to the end of the collection.</param>
9631 </member>
9632 <member name="M:NAnt.Core.Types.OptionCollection.Contains(NAnt.Core.Types.Option)">
9633 <summary>
9634 Determines whether a <see cref="T:NAnt.Core.Types.Option"/> is in the collection.
9635 </summary>
9636 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to locate in the collection.</param>
9637 <returns>
9638 <see langword="true"/> if <paramref name="item"/> is found in the
9639 collection; otherwise, <see langword="false"/>.
9640 </returns>
9641 </member>
9642 <member name="M:NAnt.Core.Types.OptionCollection.Contains(System.String)">
9643 <summary>
9644 Determines whether a <see cref="T:NAnt.Core.Types.Option"/> for the specified
9645 task is in the collection.
9646 </summary>
9647 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Types.Option"/> should be located in the collection.</param>
9648 <returns>
9649 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.Option"/> for the specified
9650 task is found in the collection; otherwise, <see langword="false"/>.
9651 </returns>
9652 </member>
9653 <member name="M:NAnt.Core.Types.OptionCollection.CopyTo(NAnt.Core.Types.Option[],System.Int32)">
9654 <summary>
9655 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
9656 </summary>
9657 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
9658 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
9659 </member>
9660 <member name="M:NAnt.Core.Types.OptionCollection.IndexOf(NAnt.Core.Types.Option)">
9661 <summary>
9662 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Option"/> object in the collection.
9663 </summary>
9664 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> object for which the index is returned.</param>
9665 <returns>
9666 The index of the specified <see cref="T:NAnt.Core.Types.Option"/>. If the <see cref="T:NAnt.Core.Types.Option"/> is not currently a member of the collection, it returns -1.
9667 </returns>
9668 </member>
9669 <member name="M:NAnt.Core.Types.OptionCollection.Insert(System.Int32,NAnt.Core.Types.Option)">
9670 <summary>
9671 Inserts a <see cref="T:NAnt.Core.Types.Option"/> into the collection at the specified index.
9672 </summary>
9673 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
9674 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to insert.</param>
9675 </member>
9676 <member name="M:NAnt.Core.Types.OptionCollection.GetEnumerator">
9677 <summary>
9678 Returns an enumerator that can iterate through the collection.
9679 </summary>
9680 <returns>
9681 A <see cref="T:NAnt.Core.Types.OptionEnumerator"/> for the entire collection.
9682 </returns>
9683 </member>
9684 <member name="M:NAnt.Core.Types.OptionCollection.Remove(NAnt.Core.Types.Option)">
9685 <summary>
9686 Removes a member from the collection.
9687 </summary>
9688 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to remove from the collection.</param>
9689 </member>
9690 <member name="P:NAnt.Core.Types.OptionCollection.Item(System.Int32)">
9691 <summary>
9692 Gets or sets the element at the specified index.
9693 </summary>
9694 <param name="index">The zero-based index of the element to get or set.</param>
9695 </member>
9696 <member name="P:NAnt.Core.Types.OptionCollection.Item(System.String)">
9697 <summary>
9698 Gets the <see cref="T:NAnt.Core.Types.Option"/> with the specified name.
9699 </summary>
9700 <param name="name">The name of the option that should be located in the collection.</param>
9701 </member>
9702 <member name="T:NAnt.Core.Types.OptionEnumerator">
9703 <summary>
9704 Enumerates the <see cref="T:NAnt.Core.Types.Option"/> elements of a <see cref="T:NAnt.Core.Types.OptionCollection"/>.
9705 </summary>
9706 </member>
9707 <member name="M:NAnt.Core.Types.OptionEnumerator.#ctor(NAnt.Core.Types.OptionCollection)">
9708 <summary>
9709 Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionEnumerator"/> class
9710 with the specified <see cref="T:NAnt.Core.Types.OptionCollection"/>.
9711 </summary>
9712 <param name="arguments">The collection that should be enumerated.</param>
9713 </member>
9714 <member name="M:NAnt.Core.Types.OptionEnumerator.MoveNext">
9715 <summary>
9716 Advances the enumerator to the next element of the collection.
9717 </summary>
9718 <returns>
9719 <see langword="true" /> if the enumerator was successfully advanced
9720 to the next element; <see langword="false" /> if the enumerator has
9721 passed the end of the collection.
9722 </returns>
9723 </member>
9724 <member name="M:NAnt.Core.Types.OptionEnumerator.Reset">
9725 <summary>
9726 Sets the enumerator to its initial position, which is before the
9727 first element in the collection.
9728 </summary>
9729 </member>
9730 <member name="P:NAnt.Core.Types.OptionEnumerator.Current">
9731 <summary>
9732 Gets the current element in the collection.
9733 </summary>
9734 <returns>
9735 The current element in the collection.
9736 </returns>
9737 </member>
9738 <member name="T:NAnt.Core.Types.PathElement">
9739 <summary>
9740 Represents a nested path element.
9741 </summary>
9742 </member>
9743 <member name="P:NAnt.Core.Types.PathElement.File">
9744 <summary>
9745 The name of a file to add to the path. Will be replaced with
9746 the absolute path of the file.
9747 </summary>
9748 </member>
9749 <member name="P:NAnt.Core.Types.PathElement.Directory">
9750 <summary>
9751 The name of a directory to add to the path. Will be replaced with
9752 the absolute path of the directory.
9753 </summary>
9754 </member>
9755 <member name="P:NAnt.Core.Types.PathElement.Path">
9756 <summary>
9757 A string that will be treated as a path-like string. You can use
9758 <c>:</c> or <c>;</c> as path separators and NAnt will convert it
9759 to the platform's local conventions, while resolving references
9760 to environment variables.
9761 </summary>
9762 </member>
9763 <member name="P:NAnt.Core.Types.PathElement.IfDefined">
9764 <summary>
9765 If <see langword="true" /> then the entry will be added to the
9766 path; otherwise, skipped. The default is <see langword="true" />.
9767 </summary>
9768 </member>
9769 <member name="P:NAnt.Core.Types.PathElement.UnlessDefined">
9770 <summary>
9771 Opposite of <see cref="P:NAnt.Core.Types.PathElement.IfDefined"/>. If <see langword="false"/>
9772 then the entry will be added to the path; otherwise, skipped.
9773 The default is <see langword="false"/>.
9774 </summary>
9775 </member>
9776 <member name="P:NAnt.Core.Types.PathElement.Parts">
9777 <summary>
9778 Gets the parts of a path represented by this element.
9779 </summary>
9780 <value>
9781 A <see cref="T:System.Collections.Specialized.StringCollection"/> containing the parts of a path
9782 represented by this element.
9783 </value>
9784 </member>
9785 <member name="T:NAnt.Core.Types.PathSet">
9786 <summary>
9787 <para>
9788 Paths are groups of files and/or directories that need to be passed as a single
9789 unit. The order in which parts of the path are specified in the build file is
9790 retained, and duplicate parts are automatically suppressed.
9791 </para>
9792 </summary>
9793 <example>
9794 <para>
9795 Define a global <c><path></c> that can be referenced by other
9796 tasks or types.
9797 </para>
9798 <code>
9799 <![CDATA[
9800 <path id="includes-path">
9801 <pathelement path="%INCLUDE%" />
9802 <pathelement dir="${build.dir}/include" />
9803 </path>
9804 ]]>
9805 </code>
9806 </example>
9807 </member>
9808 <member name="M:NAnt.Core.Types.PathSet.#ctor">
9809 <summary>
9810 Initializes a new instance of the <see cref="T:NAnt.Core.Types.PathSet"/> class.
9811 </summary>
9812 </member>
9813 <member name="M:NAnt.Core.Types.PathSet.#ctor(NAnt.Core.Project,System.String)">
9814 <summary>
9815 Invoked by <see cref="T:NAnt.Core.Element.AttributeConfigurator"/> for build
9816 attributes with an underlying <see cref="T:NAnt.Core.Types.PathSet"/> type.
9817 </summary>
9818 <param name="project">The <see cref="T:NAnt.Core.Project"/> to be used to resolve relative paths.</param>
9819 <param name="path">The string representing a path.</param>
9820 </member>
9821 <member name="M:NAnt.Core.Types.PathSet.ToString">
9822 <summary>
9823 Returns a textual representation of the path, which can be used as
9824 PATH environment variable definition.
9825 </summary>
9826 <returns>
9827 A textual representation of the path.
9828 </returns>
9829 </member>
9830 <member name="M:NAnt.Core.Types.PathSet.AddPath(NAnt.Core.Types.PathSet)">
9831 <summary>
9832 Defines a set of path elements to add to the current path.
9833 </summary>
9834 <param name="path">The <see cref="T:NAnt.Core.Types.PathSet"/> to add.</param>
9835 </member>
9836 <member name="M:NAnt.Core.Types.PathSet.AddPathElement(NAnt.Core.Types.PathElement)">
9837 <summary>
9838 Defines a path element to add to the current path.
9839 </summary>
9840 <param name="pathElement">The <see cref="T:NAnt.Core.Types.PathElement"/> to add.</param>
9841 </member>
9842 <member name="M:NAnt.Core.Types.PathSet.GetElements">
9843 <summary>
9844 Returns all path elements defined by this path object.
9845 </summary>
9846 <returns>
9847 A list of path elements.
9848 </returns>
9849 </member>
9850 <member name="M:NAnt.Core.Types.PathSet.TranslatePath(NAnt.Core.Project,System.String)">
9851 <summary>
9852 Splits a PATH (with ; or : as separators) into its parts, while
9853 resolving references to environment variables.
9854 </summary>
9855 <param name="project">The <see cref="T:NAnt.Core.Project"/> to be used to resolve relative paths.</param>
9856 <param name="source">The path to translate.</param>
9857 <returns>
9858 A PATH split up its parts, with references to environment variables
9859 resolved and duplicate entries removed.
9860 </returns>
9861 </member>
9862 <member name="M:NAnt.Core.Types.Pattern.#ctor">
9863 <summary>
9864 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Pattern"/> class.
9865 </summary>
9866 </member>
9867 <member name="P:NAnt.Core.Types.Pattern.PatternName">
9868 <summary>
9869 The name pattern to include/exclude.
9870 </summary>
9871 </member>
9872 <member name="P:NAnt.Core.Types.Pattern.IfDefined">
9873 <summary>
9874 If <see langword="true" /> then the pattern will be used;
9875 otherwise, skipped. The default is <see langword="true" />.
9876 </summary>
9877 </member>
9878 <member name="P:NAnt.Core.Types.Pattern.UnlessDefined">
9879 <summary>
9880 If <see langword="false" /> then the pattern will be used;
9881 otherwise, skipped. The default is <see langword="false" />.
9882 </summary>
9883 </member>
9884 <member name="T:NAnt.Core.Types.PatternCollection">
9885 <summary>
9886 Contains a collection of <see cref="T:NAnt.Core.Types.Pattern"/> elements.
9887 </summary>
9888 </member>
9889 <member name="M:NAnt.Core.Types.PatternCollection.#ctor">
9890 <summary>
9891 Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternCollection"/> class.
9892 </summary>
9893 </member>
9894 <member name="M:NAnt.Core.Types.PatternCollection.Clear">
9895 <summary>
9896 Removes all items from the <see cref="T:NAnt.Core.Types.PatternCollection"/>.
9897 </summary>
9898 </member>
9899 <member name="M:NAnt.Core.Types.PatternCollection.Add(NAnt.Core.Types.Pattern)">
9900 <summary>
9901 Adds a <see cref="T:NAnt.Core.Types.Pattern"/> to the end of the collection.
9902 </summary>
9903 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to be added to the end of the collection.</param>
9904 <returns>The position into which the new element was inserted.</returns>
9905 </member>
9906 <member name="M:NAnt.Core.Types.PatternCollection.AddRange(NAnt.Core.Types.Pattern[])">
9907 <summary>
9908 Adds the elements of a <see cref="T:NAnt.Core.Types.Pattern"/> array to the end of the collection.
9909 </summary>
9910 <param name="items">The array of <see cref="T:NAnt.Core.Types.Pattern"/> elements to be added to the end of the collection.</param>
9911 </member>
9912 <member name="M:NAnt.Core.Types.PatternCollection.AddRange(NAnt.Core.Types.PatternCollection)">
9913 <summary>
9914 Adds the elements of a <see cref="T:NAnt.Core.Types.PatternCollection"/> to the end of the collection.
9915 </summary>
9916 <param name="items">The <see cref="T:NAnt.Core.Types.PatternCollection"/> to be added to the end of the collection.</param>
9917 </member>
9918 <member name="M:NAnt.Core.Types.PatternCollection.Contains(NAnt.Core.Types.Pattern)">
9919 <summary>
9920 Determines whether a <see cref="T:NAnt.Core.Types.Pattern"/> is in the collection.
9921 </summary>
9922 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to locate in the collection.</param>
9923 <returns>
9924 <see langword="true"/> if <paramref name="item"/> is found in the
9925 collection; otherwise, <see langword="false"/>.
9926 </returns>
9927 </member>
9928 <member name="M:NAnt.Core.Types.PatternCollection.CopyTo(NAnt.Core.Types.Pattern[],System.Int32)">
9929 <summary>
9930 Copies the entire collection to a compatible one-dimensional array,
9931 starting at the specified index of the target array.
9932 </summary>
9933 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
9934 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
9935 </member>
9936 <member name="M:NAnt.Core.Types.PatternCollection.IndexOf(NAnt.Core.Types.Pattern)">
9937 <summary>
9938 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Pattern"/> object in the collection.
9939 </summary>
9940 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> object for which the index is returned.</param>
9941 <returns>
9942 The index of the specified <see cref="T:NAnt.Core.Types.Pattern"/>. If the <see cref="T:NAnt.Core.Types.Pattern"/> is not currently a member of the collection, it returns -1.
9943 </returns>
9944 </member>
9945 <member name="M:NAnt.Core.Types.PatternCollection.Insert(System.Int32,NAnt.Core.Types.Pattern)">
9946 <summary>
9947 Inserts a <see cref="T:NAnt.Core.Types.Pattern"/> into the collection at the specified index.
9948 </summary>
9949 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
9950 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to insert.</param>
9951 </member>
9952 <member name="M:NAnt.Core.Types.PatternCollection.GetEnumerator">
9953 <summary>
9954 Returns an enumerator that can iterate through the collection.
9955 </summary>
9956 <returns>
9957 A <see cref="T:NAnt.Core.Types.PatternEnumerator"/> for the entire collection.
9958 </returns>
9959 </member>
9960 <member name="M:NAnt.Core.Types.PatternCollection.Remove(NAnt.Core.Types.Pattern)">
9961 <summary>
9962 Removes a member from the collection.
9963 </summary>
9964 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to remove from the collection.</param>
9965 </member>
9966 <member name="P:NAnt.Core.Types.PatternCollection.Item(System.Int32)">
9967 <summary>
9968 Gets or sets the element at the specified index.
9969 </summary>
9970 <param name="index">The zero-based index of the element to get or set.</param>
9971 </member>
9972 <member name="T:NAnt.Core.Types.PatternEnumerator">
9973 <summary>
9974 Enumerates the <see cref="T:NAnt.Core.Types.Pattern"/> elements of a <see cref="T:NAnt.Core.Types.PatternCollection"/>.
9975 </summary>
9976 </member>
9977 <member name="M:NAnt.Core.Types.PatternEnumerator.#ctor(NAnt.Core.Types.PatternCollection)">
9978 <summary>
9979 Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternEnumerator"/> class
9980 with the specified <see cref="T:NAnt.Core.Types.PatternCollection"/>.
9981 </summary>
9982 <param name="arguments">The collection that should be enumerated.</param>
9983 </member>
9984 <member name="M:NAnt.Core.Types.PatternEnumerator.MoveNext">
9985 <summary>
9986 Advances the enumerator to the next element of the collection.
9987 </summary>
9988 <returns>
9989 <see langword="true" /> if the enumerator was successfully advanced
9990 to the next element; <see langword="false" /> if the enumerator has
9991 passed the end of the collection.
9992 </returns>
9993 </member>
9994 <member name="M:NAnt.Core.Types.PatternEnumerator.Reset">
9995 <summary>
9996 Sets the enumerator to its initial position, which is before the
9997 first element in the collection.
9998 </summary>
9999 </member>
10000 <member name="P:NAnt.Core.Types.PatternEnumerator.Current">
10001 <summary>
10002 Gets the current element in the collection.
10003 </summary>
10004 <returns>
10005 The current element in the collection.
10006 </returns>
10007 </member>
10008 <member name="P:NAnt.Core.Types.PatternEnumerator.System#Collections#IEnumerator#Current">
10009 <summary>
10010 Gets the current element in the collection.
10011 </summary>
10012 <returns>
10013 The current element in the collection.
10014 </returns>
10015 </member>
10016 <member name="T:NAnt.Core.Types.PatternSet">
10017 <summary>
10018 A set of patterns, mostly used to include or exclude certain files.
10019 </summary>
10020 <remarks>
10021 <para>
10022 The individual patterns support <c>if</c> and <c>unless</c> attributes
10023 to specify that the element should only be used if or unless a given
10024 condition is met.
10025 </para>
10026 <para>
10027 The <see cref="P:NAnt.Core.Types.PatternSet.IncludesFile"/> and <see cref="P:NAnt.Core.Types.PatternSet.ExcludesFile"/>
10028 elements load patterns from a file. When the file is a relative path,
10029 it will be resolved relative to the project base directory in which
10030 the patternset is defined. Each line of this file is taken to be a
10031 pattern.
10032 </para>
10033 <para>
10034 Patterns can be grouped to sets, and later be referenced by their
10035 <see cref="P:NAnt.Core.DataTypeBase.ID"/>.
10036 </para>
10037 <para>
10038 When used as a standalone element (global type), any properties that
10039 are referenced will be resolved when the definition is processed, not
10040 when it actually used. Passing a reference to a nested build file
10041 will not cause the properties to be re-evaluated.
10042 </para>
10043 <para>
10044 To improve reuse of globally defined patternsets, avoid referencing
10045 any properties altogether.
10046 </para>
10047 </remarks>
10048 <example>
10049 <para>
10050 Define a set of patterns that matches all .cs files that do not contain
10051 the text <c>Test</c> in their name.
10052 </para>
10053 <code>
10054 <![CDATA[
10055 <patternset id="non.test.sources">
10056 <include name="**/*.cs" />
10057 <exclude name="**/*Test*" />
10058 </patternset>
10059 ]]>
10060 </code>
10061 </example>
10062 <example>
10063 <para>
10064 Define two sets. One holding C# sources, and one holding VB sources.
10065 Both sets only include test sources when the <c>test</c> property is
10066 set. A third set combines both C# and VB sources.
10067 </para>
10068 <code>
10069 <![CDATA[
10070 <patternset id="cs.sources">
10071 <include name="src/**/*.cs" />
10072 <include name="test/**/*.cs" if=${property::exist('test')}" />
10073 </patternset>
10074
10075 <patternset id="vb.sources">
10076 <include name="src/**/*.vb" />
10077 <include name="test/**/*.vb" if=${property::exist('test')}" />
10078 </patternset>
10079
10080 <patternset id="all.sources">
10081 <patternset refid="cs.sources" />
10082 <patternset refid="vb.sources" />
10083 </patternset>
10084 ]]>
10085 </code>
10086 </example>
10087 <example>
10088 <para>
10089 Define a set from patterns in a file.
10090 </para>
10091 <code>
10092 <![CDATA[
10093 <patternset id="sources">
10094 <includesfile name="test.sources" />
10095 <includesfile name="non.test.sources" />
10096 </patternset>
10097 ]]>
10098 </code>
10099 </example>
10100 <example>
10101 <para>
10102 Defines a patternset with patterns that are loaded from an external
10103 file, and shows the behavior when that patternset is passed as a
10104 reference to a nested build script.
10105 </para>
10106 <para>
10107 External file "c:\foo\build\service.lst" holding patterns
10108 of source files to include for the Foo.Service assembly:
10109 </para>
10110 <code>
10111 <![CDATA[
10112 AssemblyInfo.cs
10113 *Channel.cs
10114 ServiceFactory.cs]]></code>
10115 <para>
10116 Main build script located in "c:\foo\default.build":
10117 </para>
10118 <code>
10119 <![CDATA[
10120 <project name="main" default="build">
10121 <property name="build.debug" value="true" />
10122
10123 <patternset id="service.sources">
10124 <include name="TraceListener.cs" if="${build.debug}" />
10125 <includesfile name="build/service.lst" />
10126 </patternset>
10127
10128 <property name="build.debug" value="false" />
10129
10130 <target name="build">
10131 <nant buildfile="service/default.build" inheritrefs="true" />
10132 </target>
10133 </project>]]></code>
10134 <para>
10135 Nested build script located in "c:\foo\services\default.build"
10136 which uses the patternset to feed sources files to the C# compiler:
10137 </para>
10138 <code>
10139 <![CDATA[
10140 <project name="service" default="build">
10141 <target name="build">
10142 <csc output="../bin/Foo.Service.dll" target="library">
10143 <fileset basedir="src">
10144 <patternset refid="service.sources" />
10145 </fileset>
10146 </csc>
10147 </target>
10148 </project>]]></code>
10149 <para>
10150 At the time when the patternset is used in the "service"
10151 build script, the following source files in "c:\foo\services\src"
10152 match the defined patterns:
10153 </para>
10154 <code>
10155 <![CDATA[
10156 AssemblyInfo.cs
10157 MsmqChannel.cs
10158 SmtpChannel.cs
10159 ServiceFactory.cs
10160 TraceListener.cs]]></code>
10161 <para>
10162 You should have observed that:
10163 </para>
10164 <list type="bullet">
10165 <item>
10166 <description>
10167 although the patternset is used from the "service"
10168 build script, the path to the external file is resolved relative
10169 to the base directory of the "main" build script in
10170 which the patternset is defined.
10171 </description>
10172 </item>
10173 <item>
10174 <description>
10175 the "TraceListener.cs" file is included, even though
10176 the "build.debug" property was changed to <b>false</b>
10177 after the patternset was defined (but before it was passed to
10178 the nested build, and used).
10179 </description>
10180 </item>
10181 </list>
10182 </example>
10183 <seealso cref="T:NAnt.Core.Types.FileSet"/>
10184 </member>
10185 <member name="M:NAnt.Core.Types.PatternSet.#ctor">
10186 <summary>
10187 Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternSet"/> class.
10188 </summary>
10189 </member>
10190 <member name="M:NAnt.Core.Types.PatternSet.Append(NAnt.Core.Types.PatternSet)">
10191 <summary>
10192 Adds a nested set of patterns, or references other standalone
10193 patternset.
10194 </summary>
10195 <param name="patternSet">The <see cref="T:NAnt.Core.Types.PatternSet"/> to add.</param>
10196 </member>
10197 <member name="P:NAnt.Core.Types.PatternSet.Include">
10198 <summary>
10199 Defines a single pattern for files to include.
10200 </summary>
10201 </member>
10202 <member name="P:NAnt.Core.Types.PatternSet.IncludesFile">
10203 <summary>
10204 Loads multiple patterns of files to include from a given file, set
10205 using the <see cref="P:NAnt.Core.Types.Pattern.PatternName"/> parameter.
10206 </summary>
10207 </member>
10208 <member name="P:NAnt.Core.Types.PatternSet.Exclude">
10209 <summary>
10210 Defines a single pattern for files to exclude.
10211 </summary>
10212 </member>
10213 <member name="P:NAnt.Core.Types.PatternSet.ExcludesFile">
10214 <summary>
10215 Loads multiple patterns of files to exclude from a given file, set
10216 using the <see cref="P:NAnt.Core.Types.Pattern.PatternName"/> parameter.
10217 </summary>
10218 </member>
10219 <member name="T:NAnt.Core.Types.Proxy">
10220 <summary>
10221 Contains HTTP proxy settings used to process requests to Internet
10222 resources.
10223 </summary>
10224 </member>
10225 <member name="M:NAnt.Core.Types.Proxy.#ctor">
10226 <summary>
10227 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Proxy"/> class.
10228 </summary>
10229 </member>
10230 <member name="M:NAnt.Core.Types.Proxy.GetWebProxy">
10231 <summary>
10232 Gets a <see cref="T:System.Net.WebProxy"/> instance representing the current
10233 <see cref="T:NAnt.Core.Types.Proxy"/>.
10234 </summary>
10235 <returns>
10236 A <see cref="T:System.Net.WebProxy"/> instance representing the current
10237 <see cref="T:NAnt.Core.Types.Proxy"/>, or <see langword="GlobalProxySelection.Select"/>
10238 if this proxy should not be used to connect to the external resource.
10239 </returns>
10240 </member>
10241 <member name="P:NAnt.Core.Types.Proxy.Host">
10242 <summary>
10243 The name of the proxy host.
10244 </summary>
10245 </member>
10246 <member name="P:NAnt.Core.Types.Proxy.Port">
10247 <summary>
10248 The port number on <see cref="P:NAnt.Core.Types.Proxy.Host"/> to use.
10249 </summary>
10250 </member>
10251 <member name="P:NAnt.Core.Types.Proxy.BypassOnLocal">
10252 <summary>
10253 Specifies whether to bypass the proxy server for local addresses.
10254 The default is <see langword="false" />.
10255 </summary>
10256 </member>
10257 <member name="P:NAnt.Core.Types.Proxy.Credentials">
10258 <summary>
10259 The credentials to submit to the proxy server for authentication.
10260 </summary>
10261 </member>
10262 <member name="P:NAnt.Core.Types.Proxy.IfDefined">
10263 <summary>
10264 Indicates if the proxy should be used to connect to the external
10265 resource. If <see langword="true" /> then the proxy will be used;
10266 otherwise, not. The default is <see langword="true" />.
10267 </summary>
10268 </member>
10269 <member name="P:NAnt.Core.Types.Proxy.UnlessDefined">
10270 <summary>
10271 Indicates if the proxy should not be used to connect to the external
10272 resource. If <see langword="false" /> then the proxy will be used;
10273 otherwise, not. The default is <see langword="false" />.
10274 </summary>
10275 </member>
10276 <member name="T:NAnt.Core.Types.RawXml">
10277 <summary>
10278 Represents an element of which the XML is processed by its parent task
10279 or type.
10280 </summary>
10281 </member>
10282 <member name="P:NAnt.Core.Types.RawXml.Xml">
10283 <summary>
10284 Gets the XML that this element represents.
10285 </summary>
10286 </member>
10287 <member name="P:NAnt.Core.Types.RawXml.CustomXmlProcessing">
10288 <summary>
10289 Gets a value indicating whether the element is performing additional
10290 processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
10291 initialize the element.
10292 </summary>
10293 <value>
10294 <see langword="true"/>, as the XML that represents this build
10295 element is processed by the containing task or type.
10296 </value>
10297 </member>
10298 <member name="T:NAnt.Core.Types.Token">
10299 <summary>
10300 ReplaceTokens filter token.
10301 </summary>
10302 </member>
10303 <member name="P:NAnt.Core.Types.Token.Key">
10304 <summary>
10305 Token to be replaced.
10306 </summary>
10307 </member>
10308 <member name="P:NAnt.Core.Types.Token.Value">
10309 <summary>
10310 New value of token.
10311 </summary>
10312 </member>
10313 <member name="P:NAnt.Core.Types.Token.IfDefined">
10314 <summary>
10315 Indicates if the token should be used to replace values.
10316 If <see langword="true" /> then the token will be used;
10317 otherwise, not. The default is <see langword="true" />.
10318 </summary>
10319 </member>
10320 <member name="P:NAnt.Core.Types.Token.UnlessDefined">
10321 <summary>
10322 Indicates if the token should not be used to replace values.
10323 If <see langword="false" /> then the token will be used;
10324 otherwise, not. The default is <see langword="false" />.
10325 </summary>
10326 </member>
10327 <member name="T:NAnt.Core.Types.XmlNamespace">
10328 <summary>
10329 Represents an XML namespace.
10330 </summary>
10331 </member>
10332 <member name="P:NAnt.Core.Types.XmlNamespace.Prefix">
10333 <summary>
10334 The prefix to associate with the namespace.
10335 </summary>
10336 </member>
10337 <member name="P:NAnt.Core.Types.XmlNamespace.Uri">
10338 <summary>
10339 The associated XML namespace URI.
10340 </summary>
10341 </member>
10342 <member name="P:NAnt.Core.Types.XmlNamespace.IfDefined">
10343 <summary>
10344 Indicates if the namespace should be added to the <see cref="T:System.Xml.XmlNamespaceManager"/>.
10345 If <see langword="true"/> then the namespace will be added;
10346 otherwise, skipped. The default is <see langword="true"/>.
10347 </summary>
10348 </member>
10349 <member name="P:NAnt.Core.Types.XmlNamespace.UnlessDefined">
10350 <summary>
10351 Indicates if the namespace should not be added to the <see cref="T:System.Xml.XmlNamespaceManager"/>.
10352 list. If <see langword="false"/> then the parameter will be
10353 added; otherwise, skipped. The default is <see langword="false"/>.
10354 </summary>
10355 </member>
10356 <member name="T:NAnt.Core.Types.XmlNamespaceCollection">
10357 <summary>
10358 Contains a collection of <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements.
10359 </summary>
10360 </member>
10361 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor">
10362 <summary>
10363 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class.
10364 </summary>
10365 </member>
10366 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor(NAnt.Core.Types.XmlNamespaceCollection)">
10367 <summary>
10368 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class
10369 with the specified <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> instance.
10370 </summary>
10371 </member>
10372 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor(NAnt.Core.Types.XmlNamespace[])">
10373 <summary>
10374 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class
10375 with the specified array of <see cref="T:NAnt.Core.Types.XmlNamespace"/> instances.
10376 </summary>
10377 </member>
10378 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Add(NAnt.Core.Types.XmlNamespace)">
10379 <summary>
10380 Adds a <see cref="T:NAnt.Core.Types.XmlNamespace"/> to the end of the collection.
10381 </summary>
10382 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to be added to the end of the collection.</param>
10383 <returns>The position into which the new element was inserted.</returns>
10384 </member>
10385 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.AddRange(NAnt.Core.Types.XmlNamespace[])">
10386 <summary>
10387 Adds the elements of a <see cref="T:NAnt.Core.Types.XmlNamespace"/> array to the end of the collection.
10388 </summary>
10389 <param name="items">The array of <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements to be added to the end of the collection.</param>
10390 </member>
10391 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.AddRange(NAnt.Core.Types.XmlNamespaceCollection)">
10392 <summary>
10393 Adds the elements of a <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> to the end of the collection.
10394 </summary>
10395 <param name="items">The <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> to be added to the end of the collection.</param>
10396 </member>
10397 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Contains(NAnt.Core.Types.XmlNamespace)">
10398 <summary>
10399 Determines whether a <see cref="T:NAnt.Core.Types.XmlNamespace"/> is in the collection.
10400 </summary>
10401 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to locate in the collection.</param>
10402 <returns>
10403 <see langword="true"/> if <paramref name="item"/> is found in the
10404 collection; otherwise, <see langword="false"/>.
10405 </returns>
10406 </member>
10407 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Contains(System.String)">
10408 <summary>
10409 Determines whether a <see cref="T:NAnt.Core.Types.XmlNamespace"/> with the specified
10410 value is in the collection.
10411 </summary>
10412 <param name="value">The argument value to locate in the collection.</param>
10413 <returns>
10414 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XmlNamespace"/> with
10415 value <paramref name="value"/> is found in the collection; otherwise,
10416 <see langword="false"/>.
10417 </returns>
10418 </member>
10419 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.CopyTo(NAnt.Core.Types.XmlNamespace[],System.Int32)">
10420 <summary>
10421 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
10422 </summary>
10423 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
10424 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
10425 </member>
10426 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.IndexOf(NAnt.Core.Types.XmlNamespace)">
10427 <summary>
10428 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XmlNamespace"/> object in the collection.
10429 </summary>
10430 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> object for which the index is returned.</param>
10431 <returns>
10432 The index of the specified <see cref="T:NAnt.Core.Types.XmlNamespace"/>. If the <see cref="T:NAnt.Core.Types.XmlNamespace"/> is not currently a member of the collection, it returns -1.
10433 </returns>
10434 </member>
10435 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Insert(System.Int32,NAnt.Core.Types.XmlNamespace)">
10436 <summary>
10437 Inserts a <see cref="T:NAnt.Core.Types.XmlNamespace"/> into the collection at the specified index.
10438 </summary>
10439 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
10440 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to insert.</param>
10441 </member>
10442 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.GetEnumerator">
10443 <summary>
10444 Returns an enumerator that can iterate through the collection.
10445 </summary>
10446 <returns>
10447 A <see cref="T:NAnt.Core.Types.XmlNamespaceEnumerator"/> for the entire collection.
10448 </returns>
10449 </member>
10450 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Remove(NAnt.Core.Types.XmlNamespace)">
10451 <summary>
10452 Removes a member from the collection.
10453 </summary>
10454 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to remove from the collection.</param>
10455 </member>
10456 <member name="P:NAnt.Core.Types.XmlNamespaceCollection.Item(System.Int32)">
10457 <summary>
10458 Gets or sets the element at the specified index.
10459 </summary>
10460 <param name="index">The zero-based index of the element to get or set.</param>
10461 </member>
10462 <member name="P:NAnt.Core.Types.XmlNamespaceCollection.Item(System.String)">
10463 <summary>
10464 Gets the <see cref="T:NAnt.Core.Types.XmlNamespace"/> with the specified prefix.
10465 </summary>
10466 <param name="value">The prefix of the <see cref="T:NAnt.Core.Types.XmlNamespace"/> to get.</param>
10467 </member>
10468 <member name="T:NAnt.Core.Types.XmlNamespaceEnumerator">
10469 <summary>
10470 Enumerates the <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements of a <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/>.
10471 </summary>
10472 </member>
10473 <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.#ctor(NAnt.Core.Types.XmlNamespaceCollection)">
10474 <summary>
10475 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceEnumerator"/> class
10476 with the specified <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/>.
10477 </summary>
10478 <param name="arguments">The collection that should be enumerated.</param>
10479 </member>
10480 <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.MoveNext">
10481 <summary>
10482 Advances the enumerator to the next element of the collection.
10483 </summary>
10484 <returns>
10485 <see langword="true" /> if the enumerator was successfully advanced
10486 to the next element; <see langword="false" /> if the enumerator has
10487 passed the end of the collection.
10488 </returns>
10489 </member>
10490 <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.Reset">
10491 <summary>
10492 Sets the enumerator to its initial position, which is before the
10493 first element in the collection.
10494 </summary>
10495 </member>
10496 <member name="P:NAnt.Core.Types.XmlNamespaceEnumerator.Current">
10497 <summary>
10498 Gets the current element in the collection.
10499 </summary>
10500 <returns>
10501 The current element in the collection.
10502 </returns>
10503 </member>
10504 <member name="T:NAnt.Core.Types.XsltExtensionObject">
10505 <summary>
10506 Represents an XSLT extension object. The object should have a default
10507 parameterless constructor and the return value should be one of the
10508 four basic XPath data types of number, string, Boolean or node set.
10509 </summary>
10510 </member>
10511 <member name="M:NAnt.Core.Types.XsltExtensionObject.#ctor">
10512 <summary>
10513 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10514 class.
10515 </summary>
10516 </member>
10517 <member name="P:NAnt.Core.Types.XsltExtensionObject.NamespaceUri">
10518 <summary>
10519 The namespace URI to associate with the extension object.
10520 </summary>
10521 <value>
10522 The namespace URI to associate with the extension object, or
10523 <see cref="F:System.String.Empty"/> if not set.
10524 </value>
10525 </member>
10526 <member name="P:NAnt.Core.Types.XsltExtensionObject.TypeName">
10527 <summary>
10528 The full type name of the XSLT extension object.
10529 </summary>
10530 </member>
10531 <member name="P:NAnt.Core.Types.XsltExtensionObject.AssemblyPath">
10532 <summary>
10533 The assembly which contains the XSLT extension object.
10534 </summary>
10535 </member>
10536 <member name="P:NAnt.Core.Types.XsltExtensionObject.IfDefined">
10537 <summary>
10538 Indicates if the extension object should be added to the XSLT argument
10539 list. If <see langword="true" /> then the extension object will be
10540 added; otherwise, skipped. The default is <see langword="true" />.
10541 </summary>
10542 </member>
10543 <member name="P:NAnt.Core.Types.XsltExtensionObject.UnlessDefined">
10544 <summary>
10545 Indicates if the extension object should not be added to the XSLT argument
10546 list. If <see langword="false" /> then the extension object will be
10547 added; otherwise, skipped. The default is <see langword="false" />.
10548 </summary>
10549 </member>
10550 <member name="T:NAnt.Core.Types.XsltExtensionObjectCollection">
10551 <summary>
10552 Contains a collection of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> elements.
10553 </summary>
10554 </member>
10555 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor">
10556 <summary>
10557 Initializes a new instance of the
10558 <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class.
10559 </summary>
10560 </member>
10561 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor(NAnt.Core.Types.XsltExtensionObjectCollection)">
10562 <summary>
10563 Initializes a new instance of the
10564 <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class with the
10565 specified <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> instance.
10566 </summary>
10567 </member>
10568 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor(NAnt.Core.Types.XsltExtensionObject[])">
10569 <summary>
10570 Initializes a new instance of the
10571 <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class with the
10572 specified array of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> instances.
10573 </summary>
10574 </member>
10575 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Add(NAnt.Core.Types.XsltExtensionObject)">
10576 <summary>
10577 Adds a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to the end of the collection.
10578 </summary>
10579 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to be added
10580 to the end of the collection.</param>
10581 <returns>The position into which the new element was inserted.</returns>
10582 </member>
10583 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.AddRange(NAnt.Core.Types.XsltExtensionObject[])">
10584 <summary>
10585 Adds the elements of a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> array to the
10586 end of the collection.
10587 </summary>
10588 <param name="items">The array of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10589 elements to be added to the end of the collection.</param>
10590 </member>
10591 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.AddRange(NAnt.Core.Types.XsltExtensionObjectCollection)">
10592 <summary>
10593 Adds the elements of a <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>
10594 to the end of the collection.
10595 </summary>
10596 <param name="items">The <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>
10597 to be added to the end of the collection.</param>
10598 </member>
10599 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Contains(NAnt.Core.Types.XsltExtensionObject)">
10600 <summary>
10601 Determines whether a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> is in the
10602 collection.
10603 </summary>
10604 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to locate
10605 in the collection.</param>
10606 <returns>
10607 <see langword="true"/> if <paramref name="item"/> is found in the
10608 collection; otherwise, <see langword="false"/>.
10609 </returns>
10610 </member>
10611 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Contains(System.String)">
10612 <summary>
10613 Determines whether a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> with the
10614 specified value is in the collection.
10615 </summary>
10616 <param name="value">The argument value to locate in the
10617 collection.</param>
10618 <returns>
10619 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10620 with value <paramref name="value"/> is found in the collection;
10621 otherwise, <see langword="false"/>.
10622 </returns>
10623 </member>
10624 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.CopyTo(NAnt.Core.Types.XsltExtensionObject[],System.Int32)">
10625 <summary>
10626 Copies the entire collection to a compatible one-dimensional array,
10627 starting at the specified index of the target array.
10628 </summary>
10629 <param name="array">The one-dimensional array that is the
10630 destination of the elements copied from the collection. The array
10631 must have zero-based indexing.</param>
10632 <param name="index">The zero-based index in <paramref name="array"/>
10633 at which copying begins.</param>
10634 </member>
10635 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.IndexOf(NAnt.Core.Types.XsltExtensionObject)">
10636 <summary>
10637 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10638 object in the collection.
10639 </summary>
10640 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> object for
10641 which the index is returned.</param>
10642 <returns>
10643 The index of the specified <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>. If the
10644 <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> is not currently a member of the
10645 collection, it returns -1.
10646 </returns>
10647 </member>
10648 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Insert(System.Int32,NAnt.Core.Types.XsltExtensionObject)">
10649 <summary>
10650 Inserts a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> into the collection at
10651 the specified index.
10652 </summary>
10653 <param name="index">The zero-based index at which
10654 <paramref name="item"/> should be inserted.</param>
10655 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to
10656 insert.</param>
10657 </member>
10658 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.GetEnumerator">
10659 <summary>
10660 Returns an enumerator that can iterate through the collection.
10661 </summary>
10662 <returns>
10663 A <see cref="T:NAnt.Core.Types.XsltExtensionObjectEnumerator"/> for the entire
10664 collection.
10665 </returns>
10666 </member>
10667 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Remove(NAnt.Core.Types.XsltExtensionObject)">
10668 <summary>
10669 Removes a member from the collection.
10670 </summary>
10671 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to remove
10672 from the collection.</param>
10673 </member>
10674 <member name="P:NAnt.Core.Types.XsltExtensionObjectCollection.Item(System.Int32)">
10675 <summary>
10676 Gets or sets the element at the specified index.
10677 </summary>
10678 <param name="index">The zero-based index of the element to get
10679 or set.</param>
10680 </member>
10681 <member name="P:NAnt.Core.Types.XsltExtensionObjectCollection.Item(System.String)">
10682 <summary>
10683 Gets the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> with the specified name.
10684 </summary>
10685 <param name="value">The name of the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10686 to get.</param>
10687 </member>
10688 <member name="T:NAnt.Core.Types.XsltExtensionObjectEnumerator">
10689 <summary>
10690 Enumerates the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> elements of a
10691 <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>.
10692 </summary>
10693 </member>
10694 <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.#ctor(NAnt.Core.Types.XsltExtensionObjectCollection)">
10695 <summary>
10696 Initializes a new instance of the
10697 <see cref="T:NAnt.Core.Types.XsltExtensionObjectEnumerator"/> class
10698 with the specified <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>.
10699 </summary>
10700 <param name="arguments">The collection that should be
10701 enumerated.</param>
10702 </member>
10703 <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.MoveNext">
10704 <summary>
10705 Advances the enumerator to the next element of the collection.
10706 </summary>
10707 <returns>
10708 <see langword="true" /> if the enumerator was successfully advanced
10709 to the next element; <see langword="false" /> if the enumerator has
10710 passed the end of the collection.
10711 </returns>
10712 </member>
10713 <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.Reset">
10714 <summary>
10715 Sets the enumerator to its initial position, which is before the
10716 first element in the collection.
10717 </summary>
10718 </member>
10719 <member name="P:NAnt.Core.Types.XsltExtensionObjectEnumerator.Current">
10720 <summary>
10721 Gets the current element in the collection.
10722 </summary>
10723 <returns>
10724 The current element in the collection.
10725 </returns>
10726 </member>
10727 <member name="T:NAnt.Core.Types.XsltParameter">
10728 <summary>
10729 Represents an XSLT parameter.
10730 </summary>
10731 </member>
10732 <member name="M:NAnt.Core.Types.XsltParameter.#ctor">
10733 <summary>
10734 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameter"/>
10735 class.
10736 </summary>
10737 </member>
10738 <member name="P:NAnt.Core.Types.XsltParameter.ParameterName">
10739 <summary>
10740 The name of the XSLT parameter.
10741 </summary>
10742 <value>
10743 The name of the XSLT parameter, or <see cref="F:System.String.Empty"/> if
10744 not set.
10745 </value>
10746 </member>
10747 <member name="P:NAnt.Core.Types.XsltParameter.NamespaceUri">
10748 <summary>
10749 The namespace URI to associate with the parameter.
10750 </summary>
10751 <value>
10752 The namespace URI to associate with the parameter, or
10753 <see cref="F:System.String.Empty"/> if not set.
10754 </value>
10755 </member>
10756 <member name="P:NAnt.Core.Types.XsltParameter.Value">
10757 <summary>
10758 The value of the XSLT parameter.
10759 </summary>
10760 <value>
10761 The value of the XSLT parameter, or <see cref="F:System.String.Empty"/> if
10762 not set.
10763 </value>
10764 </member>
10765 <member name="P:NAnt.Core.Types.XsltParameter.IfDefined">
10766 <summary>
10767 Indicates if the parameter should be added to the XSLT argument list.
10768 If <see langword="true" /> then the parameter will be added;
10769 otherwise, skipped. The default is <see langword="true" />.
10770 </summary>
10771 </member>
10772 <member name="P:NAnt.Core.Types.XsltParameter.UnlessDefined">
10773 <summary>
10774 Indicates if the parameter should not be added to the XSLT argument
10775 list. If <see langword="false" /> then the parameter will be
10776 added; otherwise, skipped. The default is <see langword="false" />.
10777 </summary>
10778 </member>
10779 <member name="T:NAnt.Core.Types.XsltParameterCollection">
10780 <summary>
10781 Contains a collection of <see cref="T:NAnt.Core.Types.XsltParameter"/> elements.
10782 </summary>
10783 </member>
10784 <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor">
10785 <summary>
10786 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class.
10787 </summary>
10788 </member>
10789 <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor(NAnt.Core.Types.XsltParameterCollection)">
10790 <summary>
10791 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class
10792 with the specified <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> instance.
10793 </summary>
10794 </member>
10795 <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor(NAnt.Core.Types.XsltParameter[])">
10796 <summary>
10797 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class
10798 with the specified array of <see cref="T:NAnt.Core.Types.XsltParameter"/> instances.
10799 </summary>
10800 </member>
10801 <member name="M:NAnt.Core.Types.XsltParameterCollection.Add(NAnt.Core.Types.XsltParameter)">
10802 <summary>
10803 Adds a <see cref="T:NAnt.Core.Types.XsltParameter"/> to the end of the collection.
10804 </summary>
10805 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to be added to the end of the collection.</param>
10806 <returns>The position into which the new element was inserted.</returns>
10807 </member>
10808 <member name="M:NAnt.Core.Types.XsltParameterCollection.AddRange(NAnt.Core.Types.XsltParameter[])">
10809 <summary>
10810 Adds the elements of a <see cref="T:NAnt.Core.Types.XsltParameter"/> array to the end of the collection.
10811 </summary>
10812 <param name="items">The array of <see cref="T:NAnt.Core.Types.XsltParameter"/> elements to be added to the end of the collection.</param>
10813 </member>
10814 <member name="M:NAnt.Core.Types.XsltParameterCollection.AddRange(NAnt.Core.Types.XsltParameterCollection)">
10815 <summary>
10816 Adds the elements of a <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> to the end of the collection.
10817 </summary>
10818 <param name="items">The <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> to be added to the end of the collection.</param>
10819 </member>
10820 <member name="M:NAnt.Core.Types.XsltParameterCollection.Contains(NAnt.Core.Types.XsltParameter)">
10821 <summary>
10822 Determines whether a <see cref="T:NAnt.Core.Types.XsltParameter"/> is in the collection.
10823 </summary>
10824 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to locate in the collection.</param>
10825 <returns>
10826 <see langword="true"/> if <paramref name="item"/> is found in the
10827 collection; otherwise, <see langword="false"/>.
10828 </returns>
10829 </member>
10830 <member name="M:NAnt.Core.Types.XsltParameterCollection.Contains(System.String)">
10831 <summary>
10832 Determines whether a <see cref="T:NAnt.Core.Types.XsltParameter"/> with the specified
10833 value is in the collection.
10834 </summary>
10835 <param name="value">The argument value to locate in the collection.</param>
10836 <returns>
10837 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XsltParameter"/> with
10838 value <paramref name="value"/> is found in the collection; otherwise,
10839 <see langword="false"/>.
10840 </returns>
10841 </member>
10842 <member name="M:NAnt.Core.Types.XsltParameterCollection.CopyTo(NAnt.Core.Types.XsltParameter[],System.Int32)">
10843 <summary>
10844 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
10845 </summary>
10846 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
10847 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
10848 </member>
10849 <member name="M:NAnt.Core.Types.XsltParameterCollection.IndexOf(NAnt.Core.Types.XsltParameter)">
10850 <summary>
10851 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XsltParameter"/> object in the collection.
10852 </summary>
10853 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> object for which the index is returned.</param>
10854 <returns>
10855 The index of the specified <see cref="T:NAnt.Core.Types.XsltParameter"/>. If the <see cref="T:NAnt.Core.Types.XsltParameter"/> is not currently a member of the collection, it returns -1.
10856 </returns>
10857 </member>
10858 <member name="M:NAnt.Core.Types.XsltParameterCollection.Insert(System.Int32,NAnt.Core.Types.XsltParameter)">
10859 <summary>
10860 Inserts a <see cref="T:NAnt.Core.Types.XsltParameter"/> into the collection at the specified index.
10861 </summary>
10862 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
10863 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to insert.</param>
10864 </member>
10865 <member name="M:NAnt.Core.Types.XsltParameterCollection.GetEnumerator">
10866 <summary>
10867 Returns an enumerator that can iterate through the collection.
10868 </summary>
10869 <returns>
10870 A <see cref="T:NAnt.Core.Types.XsltParameterEnumerator"/> for the entire collection.
10871 </returns>
10872 </member>
10873 <member name="M:NAnt.Core.Types.XsltParameterCollection.Remove(NAnt.Core.Types.XsltParameter)">
10874 <summary>
10875 Removes a member from the collection.
10876 </summary>
10877 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to remove from the collection.</param>
10878 </member>
10879 <member name="P:NAnt.Core.Types.XsltParameterCollection.Item(System.Int32)">
10880 <summary>
10881 Gets or sets the element at the specified index.
10882 </summary>
10883 <param name="index">The zero-based index of the element to get or set.</param>
10884 </member>
10885 <member name="P:NAnt.Core.Types.XsltParameterCollection.Item(System.String)">
10886 <summary>
10887 Gets the <see cref="T:NAnt.Core.Types.XsltParameter"/> with the specified name.
10888 </summary>
10889 <param name="value">The name of the <see cref="T:NAnt.Core.Types.XsltParameter"/> to get.</param>
10890 </member>
10891 <member name="T:NAnt.Core.Types.XsltParameterEnumerator">
10892 <summary>
10893 Enumerates the <see cref="T:NAnt.Core.Types.XsltParameter"/> elements of a <see cref="T:NAnt.Core.Types.XsltParameterCollection"/>.
10894 </summary>
10895 </member>
10896 <member name="M:NAnt.Core.Types.XsltParameterEnumerator.#ctor(NAnt.Core.Types.XsltParameterCollection)">
10897 <summary>
10898 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterEnumerator"/> class
10899 with the specified <see cref="T:NAnt.Core.Types.XsltParameterCollection"/>.
10900 </summary>
10901 <param name="arguments">The collection that should be enumerated.</param>
10902 </member>
10903 <member name="M:NAnt.Core.Types.XsltParameterEnumerator.MoveNext">
10904 <summary>
10905 Advances the enumerator to the next element of the collection.
10906 </summary>
10907 <returns>
10908 <see langword="true" /> if the enumerator was successfully advanced
10909 to the next element; <see langword="false" /> if the enumerator has
10910 passed the end of the collection.
10911 </returns>
10912 </member>
10913 <member name="M:NAnt.Core.Types.XsltParameterEnumerator.Reset">
10914 <summary>
10915 Sets the enumerator to its initial position, which is before the
10916 first element in the collection.
10917 </summary>
10918 </member>
10919 <member name="P:NAnt.Core.Types.XsltParameterEnumerator.Current">
10920 <summary>
10921 Gets the current element in the collection.
10922 </summary>
10923 <returns>
10924 The current element in the collection.
10925 </returns>
10926 </member>
10927 <member name="T:NAnt.Core.Util.AssemblyResolver">
10928 <summary>
10929 Resolves assemblies by caching assemblies that were loaded.
10930 </summary>
10931 </member>
10932 <member name="M:NAnt.Core.Util.AssemblyResolver.#ctor">
10933 <summary>
10934 Initializes an instanse of the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
10935 class.
10936 </summary>
10937 </member>
10938 <member name="M:NAnt.Core.Util.AssemblyResolver.#ctor(NAnt.Core.Task)">
10939 <summary>
10940 Initializes an instanse of the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
10941 class in the context of the given <see cref="T:NAnt.Core.Task"/>.
10942 </summary>
10943 </member>
10944 <member name="M:NAnt.Core.Util.AssemblyResolver.Attach">
10945 <summary>
10946 Installs the assembly resolver by hooking up to the
10947 <see cref="F:System.AppDomain.AssemblyResolve"/> event.
10948 </summary>
10949 </member>
10950 <member name="M:NAnt.Core.Util.AssemblyResolver.Detach">
10951 <summary>
10952 Uninstalls the assembly resolver.
10953 </summary>
10954 </member>
10955 <member name="M:NAnt.Core.Util.AssemblyResolver.AssemblyResolve(System.Object,System.ResolveEventArgs)">
10956 <summary>
10957 Resolves an assembly not found by the system using the assembly
10958 cache.
10959 </summary>
10960 <param name="sender">The source of the event.</param>
10961 <param name="args">A <see cref="T:System.ResolveEventArgs"/> that contains the event data.</param>
10962 <returns>
10963 The loaded assembly, or <see langword="null"/> if not found.
10964 </returns>
10965 </member>
10966 <member name="M:NAnt.Core.Util.AssemblyResolver.AssemblyLoad(System.Object,System.AssemblyLoadEventArgs)">
10967 <summary>
10968 Occurs when an assembly is loaded. The loaded assembly is added
10969 to the assembly cache.
10970 </summary>
10971 <param name="sender">The source of the event.</param>
10972 <param name="args">An <see cref="T:System.AssemblyLoadEventArgs"/> that contains the event data.</param>
10973 </member>
10974 <member name="M:NAnt.Core.Util.AssemblyResolver.Log(NAnt.Core.Level,System.String,System.Object[])">
10975 <summary>
10976 Logs a message with the given priority.
10977 </summary>
10978 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
10979 <param name="message">The message to log, containing zero or more format items.</param>
10980 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
10981 <remarks>
10982 The actual logging is delegated to the <see cref="T:NAnt.Core.Task"/> in which
10983 the <see cref="T:NAnt.Core.Util.AssemblyResolver"/> is executing
10984 </remarks>
10985 </member>
10986 <member name="F:NAnt.Core.Util.AssemblyResolver._assemblyCache">
10987 <summary>
10988 Holds the loaded assemblies.
10989 </summary>
10990 </member>
10991 <member name="F:NAnt.Core.Util.AssemblyResolver._task">
10992 <summary>
10993 Holds the <see cref="T:NAnt.Core.Task"/> in which the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
10994 is executing.
10995 </summary>
10996 <value>
10997 The <see cref="T:NAnt.Core.Task"/> in which the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
10998 is executing or <see langword="null"/> if the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
10999 is not executing in the context of a <see cref="T:NAnt.Core.Task"/>.
11000 </value>
11001 </member>
11002 <member name="T:NAnt.Core.Util.CommandLineArgument">
11003 <summary>
11004 Represents a valid command-line argument.
11005 </summary>
11006 </member>
11007 <member name="M:NAnt.Core.Util.CommandLineArgument.Finish(System.Object)">
11008 <summary>
11009 Sets the value of the argument on the specified object.
11010 </summary>
11011 <param name="destination">The object on which the value of the argument should be set.</param>
11012 <exception cref="T:NAnt.Core.Util.CommandLineArgumentException">The argument is required and no value was specified.</exception>
11013 <exception cref="T:System.NotSupportedException">
11014 <para>
11015 The matching property is collection-based, but is not initialized
11016 and cannot be written to.
11017 </para>
11018 <para>-or-</para>
11019 <para>
11020 The matching property is collection-based, but has no strongly-typed
11021 Add method.
11022 </para>
11023 <para>-or-</para>
11024 <para>
11025 The matching property is collection-based, but the signature of the
11026 Add method is not supported.
11027 </para>
11028 </exception>
11029 </member>
11030 <member name="M:NAnt.Core.Util.CommandLineArgument.SetValue(System.String)">
11031 <summary>
11032 Assigns the specified value to the argument.
11033 </summary>
11034 <param name="value">The value that should be assigned to the argument.</param>
11035 <exception cref="T:NAnt.Core.Util.CommandLineArgumentException">
11036 <para>Duplicate argument.</para>
11037 <para>-or-</para>
11038 <para>Invalid value.</para>
11039 </exception>
11040 </member>
11041 <member name="M:NAnt.Core.Util.CommandLineArgument.IsNameValueCollectionType(System.Type)">
11042 <summary>
11043 Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is a
11044 <see cref="T:System.Collections.Specialized.NameValueCollection"/>.
11045 </summary>
11046 <value>
11047 <see langword="true"/> if <paramref name="type"/> can be assigned
11048 to <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise, <see langword="false"/>.
11049 </value>
11050 </member>
11051 <member name="M:NAnt.Core.Util.CommandLineArgument.IsCollectionType(System.Type)">
11052 <summary>
11053 Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is collection-based.
11054 </summary>
11055 <value>
11056 <see langword="true"/> if <paramref name="type"/> can be assigned
11057 to <see cref="T:System.Collections.ICollection"/> and is not backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
11058 that can be assigned to <see cref="T:System.Collections.Specialized.NameValueCollection"/>;
11059 otherwise, <see langword="false"/>.
11060 </value>
11061 </member>
11062 <member name="M:NAnt.Core.Util.CommandLineArgument.IsArrayType(System.Type)">
11063 <summary>
11064 Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is an array.
11065 </summary>
11066 <value>
11067 <see langword="true"/> if <paramref name="type"/> is an array;
11068 otherwise, <see langword="false"/>.
11069 </value>
11070 </member>
11071 <member name="P:NAnt.Core.Util.CommandLineArgument.Property">
11072 <summary>
11073 Gets the property that backs the argument.
11074 </summary>
11075 <value>
11076 The property that backs the arguments.
11077 </value>
11078 </member>
11079 <member name="P:NAnt.Core.Util.CommandLineArgument.ValueType">
11080 <summary>
11081 Gets the underlying <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument.
11082 </summary>
11083 <value>
11084 The underlying <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument.
11085 </value>
11086 <remarks>
11087 If the <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument is a collection type,
11088 this property will returns the underlying type of that collection.
11089 </remarks>
11090 </member>
11091 <member name="P:NAnt.Core.Util.CommandLineArgument.LongName">
11092 <summary>
11093 Gets the long name of the argument.
11094 </summary>
11095 <value>The long name of the argument.</value>
11096 </member>
11097 <member name="P:NAnt.Core.Util.CommandLineArgument.ShortName">
11098 <summary>
11099 Gets the short name of the argument.
11100 </summary>
11101 <value>The short name of the argument.</value>
11102 </member>
11103 <member name="P:NAnt.Core.Util.CommandLineArgument.Description">
11104 <summary>
11105 Gets the description of the argument.
11106 </summary>
11107 <value>The description of the argument.</value>
11108 </member>
11109 <member name="P:NAnt.Core.Util.CommandLineArgument.IsRequired">
11110 <summary>
11111 Gets a value indicating whether the argument is required.
11112 </summary>
11113 <value>
11114 <see langword="true" /> if the argument is required; otherwise,
11115 <see langword="false" />.
11116 </value>
11117 </member>
11118 <member name="P:NAnt.Core.Util.CommandLineArgument.SeenValue">
11119 <summary>
11120 Gets a value indicating whether a mathing command-line argument
11121 was already found.
11122 </summary>
11123 <value>
11124 <see langword="true" /> if a matching command-line argument was
11125 already found; otherwise, <see langword="false" />.
11126 </value>
11127 </member>
11128 <member name="P:NAnt.Core.Util.CommandLineArgument.AllowMultiple">
11129 <summary>
11130 Gets a value indicating whether the argument can be specified multiple
11131 times.
11132 </summary>
11133 <value>
11134 <see langword="true" /> if the argument may be specified multiple
11135 times; otherwise, <see langword="false" />.
11136 </value>
11137 </member>
11138 <member name="P:NAnt.Core.Util.CommandLineArgument.Unique">
11139 <summary>
11140 Gets a value indicating whether the argument can only be specified once
11141 with a certain value.
11142 </summary>
11143 <value>
11144 <see langword="true" /> if the argument should always have a unique
11145 value; otherwise, <see langword="false" />.
11146 </value>
11147 </member>
11148 <member name="P:NAnt.Core.Util.CommandLineArgument.Type">
11149 <summary>
11150 Gets the <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the property to which the argument
11151 is applied.
11152 </summary>
11153 <value>
11154 The <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the property to which the argument is
11155 applied.
11156 </value>
11157 </member>
11158 <member name="P:NAnt.Core.Util.CommandLineArgument.IsCollection">
11159 <summary>
11160 Gets a value indicating whether the argument is collection-based.
11161 </summary>
11162 <value>
11163 <see langword="true"/> if the argument is backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
11164 that can be assigned to <see cref="T:System.Collections.ICollection"/> and is not backed
11165 by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> that can be assigned to
11166 <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise, <see langword="false"/>.
11167 </value>
11168 </member>
11169 <member name="P:NAnt.Core.Util.CommandLineArgument.IsNameValueCollection">
11170 <summary>
11171 Gets a value indicating whether the argument is a set of name/value
11172 pairs.
11173 </summary>
11174 <value>
11175 <see langword="true"/> if the argument is backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
11176 that can be assigned to <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise,
11177 <see langword="false"/>.
11178 </value>
11179 </member>
11180 <member name="P:NAnt.Core.Util.CommandLineArgument.IsArray">
11181 <summary>
11182 Gets a value indicating whether the argument is array-based.
11183 </summary>
11184 <value>
11185 <see langword="true" /> if the argument is backed by an array;
11186 otherwise, <see langword="false" />.
11187 </value>
11188 </member>
11189 <member name="P:NAnt.Core.Util.CommandLineArgument.IsDefault">
11190 <summary>
11191 Gets a value indicating whether the argument is the default argument.
11192 </summary>
11193 <value>
11194 <see langword="true" /> if the argument is the default argument;
11195 otherwise, <see langword="false" />.
11196 </value>
11197 </member>
11198 <member name="P:NAnt.Core.Util.CommandLineArgument.IsExclusive">
11199 <summary>
11200 Gets a value indicating whether the argument cannot be combined with
11201 other arguments.
11202 </summary>
11203 <value>
11204 <see langword="true" /> if the argument cannot be combined with other
11205 arguments; otherwise, <see langword="false" />.
11206 </value>
11207 </member>
11208 <member name="T:NAnt.Core.Util.CommandLineArgumentAttribute">
11209 <summary>
11210 Allows control of command line parsing.
11211 </summary>
11212 </member>
11213 <member name="M:NAnt.Core.Util.CommandLineArgumentAttribute.#ctor(NAnt.Core.Util.CommandLineArgumentTypes)">
11214 <summary>
11215 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> class
11216 with the specified argument type.
11217 </summary>
11218 <param name="argumentType">Specifies the checking to be done on the argument.</param>
11219 </member>
11220 <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Type">
11221 <summary>
11222 Gets or sets the checking to be done on the argument.
11223 </summary>
11224 <value>The checking that should be done on the argument.</value>
11225 </member>
11226 <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Name">
11227 <summary>
11228 Gets or sets the long name of the argument.
11229 </summary>
11230 <value>The long name of the argument.</value>
11231 </member>
11232 <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.ShortName">
11233 <summary>
11234 Gets or sets the short name of the argument.
11235 </summary>
11236 <value>The short name of the argument.</value>
11237 </member>
11238 <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Description">
11239 <summary>
11240 Gets or sets the description of the argument.
11241 </summary>
11242 <value>The description of the argument.</value>
11243 </member>
11244 <member name="T:NAnt.Core.Util.CommandLineArgumentCollection">
11245 <summary>
11246 Contains a strongly typed collection of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> objects.
11247 </summary>
11248 </member>
11249 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor">
11250 <summary>
11251 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class.
11252 </summary>
11253 </member>
11254 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor(NAnt.Core.Util.CommandLineArgumentCollection)">
11255 <summary>
11256 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class
11257 with the specified <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> instance.
11258 </summary>
11259 </member>
11260 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor(NAnt.Core.Util.CommandLineArgument[])">
11261 <summary>
11262 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class
11263 with the specified array of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> instances.
11264 </summary>
11265 </member>
11266 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Add(NAnt.Core.Util.CommandLineArgument)">
11267 <summary>
11268 Adds a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to the end of the collection.
11269 </summary>
11270 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to be added to the end of the collection.</param>
11271 <returns>The position into which the new element was inserted.</returns>
11272 </member>
11273 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.AddRange(NAnt.Core.Util.CommandLineArgument[])">
11274 <summary>
11275 Adds the elements of a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> array to the end of the collection.
11276 </summary>
11277 <param name="items">The array of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> elements to be added to the end of the collection.</param>
11278 </member>
11279 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.AddRange(NAnt.Core.Util.CommandLineArgumentCollection)">
11280 <summary>
11281 Adds the elements of a <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> to the end of the collection.
11282 </summary>
11283 <param name="items">The <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> to be added to the end of the collection.</param>
11284 </member>
11285 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Contains(NAnt.Core.Util.CommandLineArgument)">
11286 <summary>
11287 Determines whether a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> is in the collection.
11288 </summary>
11289 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to locate in the collection.</param>
11290 <returns>
11291 <see langword="true"/> if <paramref name="item"/> is found in the
11292 collection; otherwise, <see langword="false"/>.
11293 </returns>
11294 </member>
11295 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.CopyTo(NAnt.Core.Util.CommandLineArgument[],System.Int32)">
11296 <summary>
11297 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
11298 </summary>
11299 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
11300 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
11301 </member>
11302 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.IndexOf(NAnt.Core.Util.CommandLineArgument)">
11303 <summary>
11304 Retrieves the index of a specified <see cref="T:NAnt.Core.Util.CommandLineArgument"/> object in the collection.
11305 </summary>
11306 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> object for which the index is returned.</param>
11307 <returns>
11308 The index of the specified <see cref="T:NAnt.Core.Util.CommandLineArgument"/>. If the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> is not currently a member of the collection, it returns -1.
11309 </returns>
11310 </member>
11311 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Insert(System.Int32,NAnt.Core.Util.CommandLineArgument)">
11312 <summary>
11313 Inserts a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> into the collection at the specified index.
11314 </summary>
11315 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
11316 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to insert.</param>
11317 </member>
11318 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.GetEnumerator">
11319 <summary>
11320 Returns an enumerator that can iterate through the collection.
11321 </summary>
11322 <returns>
11323 A <see cref="T:NAnt.Core.Util.CommandLineArgumentEnumerator"/> for the entire collection.
11324 </returns>
11325 </member>
11326 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Remove(NAnt.Core.Util.CommandLineArgument)">
11327 <summary>
11328 Removes a member from the collection.
11329 </summary>
11330 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to remove from the collection.</param>
11331 </member>
11332 <member name="P:NAnt.Core.Util.CommandLineArgumentCollection.Item(System.Int32)">
11333 <summary>
11334 Gets or sets the element at the specified index.
11335 </summary>
11336 <param name="index">The zero-based index of the element to get or set.</param>
11337 </member>
11338 <member name="P:NAnt.Core.Util.CommandLineArgumentCollection.Item(System.String)">
11339 <summary>
11340 Gets the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> with the specified name.
11341 </summary>
11342 <param name="name">The name of the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to get.</param>
11343 </member>
11344 <member name="T:NAnt.Core.Util.CommandLineArgumentEnumerator">
11345 <summary>
11346 Enumerates the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> elements of a <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/>.
11347 </summary>
11348 </member>
11349 <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.#ctor(NAnt.Core.Util.CommandLineArgumentCollection)">
11350 <summary>
11351 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentEnumerator"/> class
11352 with the specified <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/>.
11353 </summary>
11354 <param name="arguments">The collection that should be enumerated.</param>
11355 </member>
11356 <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.MoveNext">
11357 <summary>
11358 Advances the enumerator to the next element of the collection.
11359 </summary>
11360 <returns>
11361 <see langword="true" /> if the enumerator was successfully advanced
11362 to the next element; <see langword="false" /> if the enumerator has
11363 passed the end of the collection.
11364 </returns>
11365 </member>
11366 <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.Reset">
11367 <summary>
11368 Sets the enumerator to its initial position, which is before the
11369 first element in the collection.
11370 </summary>
11371 </member>
11372 <member name="P:NAnt.Core.Util.CommandLineArgumentEnumerator.Current">
11373 <summary>
11374 Gets the current element in the collection.
11375 </summary>
11376 <returns>
11377 The current element in the collection.
11378 </returns>
11379 </member>
11380 <member name="T:NAnt.Core.Util.CommandLineArgumentException">
11381 <summary>
11382 The exception that is thrown when one of the command-line arguments provided
11383 is not valid.
11384 </summary>
11385 </member>
11386 <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor">
11387 <summary>
11388 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class.
11389 </summary>
11390 </member>
11391 <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.String)">
11392 <summary>
11393 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
11394 with a descriptive message.
11395 </summary>
11396 <param name="message">A descriptive message to include with the exception.</param>
11397 </member>
11398 <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.String,System.Exception)">
11399 <summary>
11400 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
11401 with a descriptive message and an inner exception.
11402 </summary>
11403 <param name="message">A descriptive message to include with the exception.</param>
11404 <param name="innerException">A nested exception that is the cause of the current exception.</param>
11405 </member>
11406 <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
11407 <summary>
11408 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
11409 with serialized data.
11410 </summary>
11411 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
11412 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
11413 </member>
11414 <member name="T:NAnt.Core.Util.CommandLineArgumentTypes">
11415 <summary>
11416 Used to control parsing of command-line arguments.
11417 </summary>
11418 </member>
11419 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Required">
11420 <summary>
11421 Indicates that this field is required. An error will be displayed
11422 if it is not present when parsing arguments.
11423 </summary>
11424 </member>
11425 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Unique">
11426 <summary>
11427 Only valid in conjunction with Multiple.
11428 Duplicate values will result in an error.
11429 </summary>
11430 </member>
11431 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Multiple">
11432 <summary>
11433 Inidicates that the argument may be specified more than once.
11434 Only valid if the argument is a collection
11435 </summary>
11436 </member>
11437 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Exclusive">
11438 <summary>
11439 Inidicates that if this argument is specified, no other arguments may be specified.
11440 </summary>
11441 </member>
11442 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.AtMostOnce">
11443 <summary>
11444 The default type for non-collection arguments.
11445 The argument is not required, but an error will be reported if it is specified more than once.
11446 </summary>
11447 </member>
11448 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.MultipleUnique">
11449 <summary>
11450 The default type for collection arguments.
11451 The argument is permitted to occur multiple times, but duplicate
11452 values will cause an error to be reported.
11453 </summary>
11454 </member>
11455 <member name="T:NAnt.Core.Util.CommandLineParser">
11456 <summary>
11457 Commandline parser.
11458 </summary>
11459 </member>
11460 <member name="M:NAnt.Core.Util.CommandLineParser.#ctor(System.Type,System.Boolean)">
11461 <summary>
11462 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineParser"/> class
11463 using possible arguments deducted from the specific <see cref="T:System.Type"/>.
11464 </summary>
11465 <param name="argumentSpecification">The <see cref="T:System.Type"/> from which the possible command-line arguments should be retrieved.</param>
11466 <param name="supportsResponseFile">A <see cref="T:System.Boolean"/> value indicating whether or not a response file is able to be used. </param>
11467 <exception cref="T:System.ArgumentNullException"><paramref name="argumentSpecification"/> is a null reference.</exception>
11468 </member>
11469 <member name="M:NAnt.Core.Util.CommandLineParser.Parse(System.String[],System.Object)">
11470 <summary>
11471 Parses an argument list.
11472 </summary>
11473 <param name="args">The arguments to parse.</param>
11474 <param name="destination">The destination object on which properties will be set corresponding to the specified arguments.</param>
11475 <exception cref="T:System.ArgumentNullException"><paramref name="destination"/> is a null reference.</exception>
11476 <exception cref="T:System.ArgumentException">The <see cref="T:System.Type"/> of <paramref name="destination"/> does not match the argument specification that was used to initialize the parser.</exception>
11477 </member>
11478 <member name="M:NAnt.Core.Util.CommandLineParser.ParseArguments(System.String,System.Char[])">
11479 <summary>
11480 Splits a string and removes any empty strings from the
11481 result. Same functionality as the
11482 public string[] Split(char[] separator, StringSplitOptions options)
11483 method in .Net 2.0. Replace with that call when 2.0 is standard.
11484 </summary>
11485 <param name="sourceString"></param>
11486 <param name="delimiters"></param>
11487 <returns>the array of strings</returns>
11488 </member>
11489 <member name="M:NAnt.Core.Util.CommandLineParser.ProcessResponseFile(System.String)">
11490 <summary>
11491 Read a response file and parse the arguments as usual.
11492 </summary>
11493 <param name="file">The response file to load arguments</param>
11494 </member>
11495 <member name="M:NAnt.Core.Util.CommandLineParser.ParseArgumentList(System.String[])">
11496 <summary>
11497 Parse the argument list using the
11498 </summary>
11499 <param name="args"></param>
11500 </member>
11501 <member name="M:NAnt.Core.Util.CommandLineParser.GetCommandLineAttribute(System.Reflection.PropertyInfo)">
11502 <summary>
11503 Returns the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> that's applied
11504 on the specified property.
11505 </summary>
11506 <param name="propertyInfo">The property of which applied <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> should be returned.</param>
11507 <returns>
11508 The <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> that's applied to the
11509 <paramref name="propertyInfo"/>, or a null reference if none was applied.
11510 </returns>
11511 </member>
11512 <member name="P:NAnt.Core.Util.CommandLineParser.LogoBanner">
11513 <summary>
11514 Gets a logo banner using version and copyright attributes defined on the
11515 <see cref="M:System.Reflection.Assembly.GetEntryAssembly"/> or the
11516 <see cref="M:System.Reflection.Assembly.GetCallingAssembly"/>.
11517 </summary>
11518 <value>
11519 A logo banner.
11520 </value>
11521 </member>
11522 <member name="P:NAnt.Core.Util.CommandLineParser.Usage">
11523 <summary>
11524 Gets the usage instructions.
11525 </summary>
11526 <value>The usage instructions.</value>
11527 </member>
11528 <member name="P:NAnt.Core.Util.CommandLineParser.NoArgs">
11529 <summary>
11530 Gets a value indicating whether no arguments were specified on the
11531 command line.
11532 </summary>
11533 </member>
11534 <member name="T:NAnt.Core.Util.DefaultCommandLineArgumentAttribute">
11535 <summary>
11536 Marks a command-line option as being the default option. When the name of
11537 a command-line argument is not specified, this option will be assumed.
11538 </summary>
11539 </member>
11540 <member name="M:NAnt.Core.Util.DefaultCommandLineArgumentAttribute.#ctor(NAnt.Core.Util.CommandLineArgumentTypes)">
11541 <summary>
11542 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> class
11543 with the specified argument type.
11544 </summary>
11545 <param name="argumentType">Specifies the checking to be done on the argument.</param>
11546 </member>
11547 <member name="T:NAnt.Core.Util.FileUtils">
11548 <summary>
11549 Provides modified version for Copy and Move from the File class that
11550 allow for filter chain processing.
11551 </summary>
11552 </member>
11553 <member name="M:NAnt.Core.Util.FileUtils.CopyFile(System.String,System.String,NAnt.Core.Filters.FilterChain,System.Text.Encoding,System.Text.Encoding)">
11554 <summary>
11555 Copies a file filtering its content through the filter chain.
11556 </summary>
11557 <param name="sourceFileName">The file to copy</param>
11558 <param name="destFileName">The file to copy to</param>
11559 <param name="filterChain">Chain of filters to apply when copying, or <see langword="null" /> is no filters should be applied.</param>
11560 <param name="inputEncoding">The encoding used to read the soure file.</param>
11561 <param name="outputEncoding">The encoding used to write the destination file.</param>
11562 </member>
11563 <member name="M:NAnt.Core.Util.FileUtils.MoveFile(System.String,System.String,NAnt.Core.Filters.FilterChain,System.Text.Encoding,System.Text.Encoding)">
11564 <summary>
11565 Moves a file filtering its content through the filter chain.
11566 </summary>
11567 <param name="sourceFileName">The file to move</param>
11568 <param name="destFileName">The file to move move to</param>
11569 <param name="filterChain">Chain of filters to apply when moving, or <see langword="null" /> is no filters should be applied.</param>
11570 <param name="inputEncoding">The encoding used to read the soure file.</param>
11571 <param name="outputEncoding">The encoding used to write the destination file.</param>
11572 </member>
11573 <member name="M:NAnt.Core.Util.FileUtils.GetTempDirectory">
11574 <summary>
11575 Returns a uniquely named empty temporary directory on disk.
11576 </summary>
11577 <value>
11578 A <see cref="T:System.IO.DirectoryInfo"/> representing the temporary directory.
11579 </value>
11580 </member>
11581 <member name="M:NAnt.Core.Util.FileUtils.CombinePaths(System.String,System.String)">
11582 <summary>
11583 Combines two path strings.
11584 </summary>
11585 <param name="path1">The first path.</param>
11586 <param name="path2">The second path.</param>
11587 <returns>
11588 A string containing the combined paths. If one of the specified
11589 paths is a zero-length string, this method returns the other path.
11590 If <paramref name="path2"/> contains an absolute path, this method
11591 returns <paramref name="path2"/>.
11592 </returns>
11593 <remarks>
11594 <para>
11595 On *nix, processing is delegated to <see cref="M:System.IO.Path.Combine(System.String,System.String)"/>.
11596 </para>
11597 <para>
11598 On Windows, this method normalized the paths to avoid running into
11599 the 260 character limit of a path and converts forward slashes in
11600 both <paramref name="path1"/> and <paramref name="path2"/> to
11601 the platform's directory separator character.
11602 </para>
11603 </remarks>
11604 </member>
11605 <member name="M:NAnt.Core.Util.FileUtils.GetFullPath(System.String)">
11606 <summary>
11607 Returns Absolute Path (Fix for 260 Char Limit of Path.GetFullPath(...))
11608 </summary>
11609 <param name="path">The file or directory for which to obtain absolute path information.</param>
11610 <returns>Path Resolved</returns>
11611 <exception cref="T:System.ArgumentException">path is a zero-length string, contains only white space or contains one or more invalid characters as defined by <see cref="F:System.IO.Path.InvalidPathChars"/>.</exception>
11612 <exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
11613 </member>
11614 <member name="M:NAnt.Core.Util.FileUtils.GetHomeDirectory">
11615 <summary>
11616 Returns the home directory of the current user.
11617 </summary>
11618 <returns>
11619 The home directory of the current user.
11620 </returns>
11621 </member>
11622 <member name="T:NAnt.Core.Util.GacCache">
11623 <summary>
11624 Helper class for determining whether assemblies are located in the
11625 Global Assembly Cache.
11626 </summary>
11627 </member>
11628 <member name="M:NAnt.Core.Util.GacCache.#ctor(NAnt.Core.Project)">
11629 <summary>
11630 Initializes a new instance of the <see cref="T:NAnt.Core.Util.GacCache"/> class in
11631 the context of the given <see cref="P:NAnt.Core.Util.GacCache.Project"/>.
11632 </summary>
11633 </member>
11634 <member name="M:NAnt.Core.Util.GacCache.IsAssemblyInGac(System.String)">
11635 <summary>
11636 Determines whether an assembly is installed in the Global
11637 Assembly Cache given its file name or path.
11638 </summary>
11639 <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
11640 <returns>
11641 <see langword="true"/> if <paramref name="assemblyFile"/> is
11642 installed in the Global Assembly Cache; otherwise,
11643 <see langword="false"/>.
11644 </returns>
11645 <remarks>
11646 <para>
11647 To determine whether the specified assembly is installed in the
11648 Global Assembly Cache, the assembly is loaded into a separate
11649 <see cref="T:System.AppDomain"/>.
11650 </para>
11651 <para>
11652 If the family of the current runtime framework does not match the
11653 family of the current target framework, this method will return
11654 <see langword="false"/> for all assemblies as there's no way to
11655 determine whether a given assembly is in the Global Assembly Cache
11656 for another framework family than the family of the current runtime
11657 framework.
11658 </para>
11659 </remarks>
11660 </member>
11661 <member name="F:NAnt.Core.Util.GacCache._domain">
11662 <summary>
11663 Holds the <see cref="T:System.AppDomain"/> in which assemblies will be loaded
11664 to determine whether they are in the Global Assembly Cache.
11665 </summary>
11666 </member>
11667 <member name="F:NAnt.Core.Util.GacCache._project">
11668 <summary>
11669 Holds the <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
11670 </summary>
11671 </member>
11672 <member name="F:NAnt.Core.Util.GacCache._gacQueryCache">
11673 <summary>
11674 Holds a list of assembly files for which already has been determined
11675 whether they are located in the Global Assembly Cache.
11676 </summary>
11677 <remarks>
11678 <para>
11679 The key of the <see cref="T:System.Collections.Hashtable"/> is the full path to the
11680 assembly file and the value is a <see cref="T:System.Boolean"/> indicating
11681 whether the assembly is located in the Global Assembly Cache.
11682 </para>
11683 </remarks>
11684 </member>
11685 <member name="F:NAnt.Core.Util.GacCache._disposed">
11686 <summary>
11687 Holds a value indicating whether the object has been disposed.
11688 </summary>
11689 </member>
11690 <member name="P:NAnt.Core.Util.GacCache.Project">
11691 <summary>
11692 Gets the <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
11693 </summary>
11694 <value>
11695 The <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
11696 </value>
11697 </member>
11698 <member name="M:NAnt.Core.Util.GacCache.GacResolver.InitializeLifetimeService">
11699 <summary>
11700 Obtains a lifetime service object to control the lifetime policy for
11701 this instance.
11702 </summary>
11703 <returns>
11704 An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
11705 policy for this instance. This is the current lifetime service object
11706 for this instance if one exists; otherwise, a new lifetime service
11707 object initialized with a lease that will never time out.
11708 </returns>
11709 </member>
11710 <member name="M:NAnt.Core.Util.GacCache.GacResolver.IsAssemblyInGac(System.String)">
11711 <summary>
11712 Determines whether an assembly is installed in the Global
11713 Assembly Cache given its file name or path.
11714 </summary>
11715 <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
11716 <returns>
11717 <see langword="true" /> if <paramref name="assemblyFile" /> is
11718 installed in the Global Assembly Cache; otherwise,
11719 <see langword="false" />.
11720 </returns>
11721 </member>
11722 <member name="T:NAnt.Core.Util.ReflectionUtils">
11723 <summary>
11724 Provides a set of helper methods related to reflection.
11725 </summary>
11726 </member>
11727 <member name="M:NAnt.Core.Util.ReflectionUtils.#ctor">
11728 <summary>
11729 Initializes a new instance of the <see cref="T:NAnt.Core.Util.ReflectionUtils"/> class.
11730 </summary>
11731 <remarks>
11732 Uses a private access modifier to prevent instantiation of this class.
11733 </remarks>
11734 </member>
11735 <member name="M:NAnt.Core.Util.ReflectionUtils.GetTypeFromString(System.String,System.Boolean)">
11736 <summary>
11737 Loads the type specified in the type string with assembly qualified name.
11738 </summary>
11739 <param name="typeName">The assembly qualified name of the type to load.</param>
11740 <param name="throwOnError">Flag set to <see langword="true"/> to throw an exception if the type cannot be loaded.</param>
11741 <exception cref="T:System.TypeLoadException">
11742 <paramref name="throwOnError"/> is <see langword="true"/> and
11743 an error is encountered while loading the <see cref="T:System.Type"/>, or
11744 <paramref name="typeName"/> is not an assembly qualified name.
11745 </exception>
11746 <remarks>
11747 If the <see cref="T:System.Type"/> cannot be instantiated from the assembly
11748 qualified type name, then we'll try to instantiate the type using its
11749 simple type name from an already loaded assembly with an assembly
11750 name mathing the assembly in the assembly qualified type name.
11751 </remarks>
11752 <returns>
11753 The type loaded or <see langword="null"/> if it could not be loaded.
11754 </returns>
11755 </member>
11756 <member name="T:NAnt.Core.Util.ResourceUtils">
11757 <summary>
11758 Provides resource support to NAnt assemblies. This class cannot
11759 be inherited from.
11760 </summary>
11761 </member>
11762 <member name="M:NAnt.Core.Util.ResourceUtils.#ctor">
11763 <summary>
11764 Prevents the <see cref="T:NAnt.Core.Util.ResourceUtils"/> class from being
11765 instantiated explicitly.
11766 </summary>
11767 </member>
11768 <member name="M:NAnt.Core.Util.ResourceUtils.RegisterSharedAssembly(System.Reflection.Assembly)">
11769 <summary>
11770 Registers the assembly to be used as the fallback if resources
11771 aren't found in the local satellite assembly.
11772 </summary>
11773 <param name="assembly">
11774 A <see cref="T:System.Reflection.Assembly"/> that represents the
11775 assembly to register.
11776 </param>
11777 <example>
11778 The following example shows how to register a shared satellite
11779 assembly.
11780 <code>
11781 <![CDATA[
11782 Assembly sharedAssembly = Assembly.Load("MyResources.dll");
11783 ResourceUtils.RegisterSharedAssembly(sharedAssembly);
11784 ]]>
11785 </code>
11786 </example>
11787 </member>
11788 <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String)">
11789 <summary>
11790 Returns the value of the specified string resource.
11791 </summary>
11792 <param name="name">
11793 A <see cref="T:System.String"/> that contains the name of the
11794 resource to get.
11795 </param>
11796 <returns>
11797 A <see cref="T:System.String"/> that contains the value of the
11798 resource localized for the current culture.
11799 </returns>
11800 <remarks>
11801 The returned resource is localized for the cultural settings of the
11802 current <see cref="T:System.Threading.Thread"/>.
11803 <note>
11804 The <c>GetString</c> method is thread-safe.
11805 </note>
11806 </remarks>
11807 <example>
11808 The following example demonstrates the <c>GetString</c> method using
11809 the cultural settings of the current <see cref="T:System.Threading.Thread"/>.
11810 <code>
11811 <![CDATA[
11812 string localizedString = ResourceUtils.GetString("String_HelloWorld");
11813 ]]>
11814 </code>
11815 </example>
11816 </member>
11817 <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String,System.Globalization.CultureInfo)">
11818 <summary>
11819 Returns the value of the specified string resource localized for
11820 the specified culture.
11821 </summary>
11822 <param name="name"></param>
11823 <param name="culture"></param>
11824 <returns>
11825 A <see cref="T:System.String"/> that contains the value of the
11826 resource localized for the specified culture.
11827 </returns>
11828 <remarks>
11829 <note>
11830 The <c>GetString</c> method is thread-safe.
11831 </note>
11832 </remarks>
11833 <example>
11834 The following example demonstrates the <c>GetString</c> method using
11835 a specific culture.
11836 <code>
11837 <![CDATA[
11838 CultureInfo culture = CultureInfo.CreateSpecificCulture("en-US");
11839 string localizedString = ResourceUtils.GetString("String_HelloWorld", culture);
11840 ]]>
11841 </code>
11842 </example>
11843 </member>
11844 <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String,System.Globalization.CultureInfo,System.Reflection.Assembly)">
11845 <summary>
11846 Returns the value of the specified string resource localized for
11847 the specified culture for the specified assembly.
11848 </summary>
11849 <param name="name">
11850 A <see cref="T:System.String"/> that contains the name of the
11851 resource to get.
11852 </param>
11853 <param name="culture">
11854 A <see cref="T:System.Globalization.CultureInfo"/> that represents
11855 the culture for which the resource is localized.
11856 </param>
11857 <param name="assembly">
11858 A <see cref="T:System.Reflection.Assembly"/>
11859 </param>
11860 <returns>
11861 A <see cref="T:System.String"/> that contains the value of the
11862 resource localized for the specified culture.
11863 </returns>
11864 <remarks>
11865 <note>
11866 The <c>GetString</c> method is thread-safe.
11867 </note>
11868 </remarks>
11869 <example>
11870 The following example demonstrates the <c>GetString</c> method using
11871 specific culture and assembly.
11872 <code>
11873 <![CDATA[
11874 CultureInfo culture = CultureInfo.CreateSpecificCulture("en-US");
11875 Assembly assembly = Assembly.GetCallingAssembly();
11876 string localizedString = ResourceUtils.GetString("String_HelloWorld", culture, assembly);
11877 ]]>
11878 </code>
11879 </example>
11880 </member>
11881 <member name="M:NAnt.Core.Util.ResourceUtils.RegisterAssembly(System.Reflection.Assembly)">
11882 <summary>
11883 Registers the specified assembly.
11884 </summary>
11885 <param name="assembly">
11886 A <see cref="T:System.Reflection.Assembly"/> that represents the
11887 assembly to register.
11888 </param>
11889 </member>
11890 <member name="M:NAnt.Core.Util.ResourceUtils.GetResourceName(System.String)">
11891 <summary>
11892 Determines the manifest resource name of the resource holding the
11893 localized strings.
11894 </summary>
11895 <param name="assemblyName">The name of the assembly.</param>
11896 <returns>
11897 The manifest resource name of the resource holding the localized
11898 strings for the specified assembly.
11899 </returns>
11900 <remarks>
11901 The manifest resource name of the resource holding the localized
11902 strings should match the name of the assembly, minus <c>Tasks</c>
11903 suffix.
11904 </remarks>
11905 </member>
11906 <member name="T:NAnt.Core.Util.StringUtils">
11907 <summary>
11908 Groups a set of useful <see cref="T:System.String"/> manipulation and validation
11909 methods.
11910 </summary>
11911 </member>
11912 <member name="M:NAnt.Core.Util.StringUtils.#ctor">
11913 <summary>
11914 Initializes a new instance of the <see cref="T:NAnt.Core.Util.StringUtils"/> class.
11915 </summary>
11916 <remarks>
11917 Prevents instantiation of the <see cref="T:NAnt.Core.Util.StringUtils"/> class.
11918 </remarks>
11919 </member>
11920 <member name="M:NAnt.Core.Util.StringUtils.EndsWith(System.String,System.Char)">
11921 <summary>
11922 Determines whether the last character of the given <see cref="T:System.String"/>
11923 matches the specified character.
11924 </summary>
11925 <param name="value">The string.</param>
11926 <param name="c">The character.</param>
11927 <returns>
11928 <see langword="true"/> if the last character of <paramref name="value"/>
11929 matches <paramref name="c"/>; otherwise, <see langword="false"/>.
11930 </returns>
11931 <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null"/>.</exception>
11932 </member>
11933 <member name="M:NAnt.Core.Util.StringUtils.IsNullOrEmpty(System.String)">
11934 <summary>
11935 Indicates whether or not the specified <see cref="T:System.String"/> is
11936 <see langword="null"/> or an <see cref="F:System.String.Empty"/> string.
11937 </summary>
11938 <param name="value">The value to check.</param>
11939 <returns>
11940 <see langword="true"/> if <paramref name="value"/> is <see langword="null"/>
11941 or an empty string (""); otherwise, <see langword="false"/>.
11942 </returns>
11943 </member>
11944 <member name="M:NAnt.Core.Util.StringUtils.ConvertEmptyToNull(System.String)">
11945 <summary>
11946 Converts an empty string ("") to <see langword="null" />.
11947 </summary>
11948 <param name="value">The value to convert.</param>
11949 <returns>
11950 <see langword="null" /> if <paramref name="value" /> is an empty
11951 string ("") or <see langword="null" />; otherwise, <paramref name="value" />.
11952 </returns>
11953 </member>
11954 <member name="M:NAnt.Core.Util.StringUtils.ConvertNullToEmpty(System.String)">
11955 <summary>
11956 Converts <see langword="null" /> to an empty string.
11957 </summary>
11958 <param name="value">The value to convert.</param>
11959 <returns>
11960 An empty string if <paramref name="value" /> is <see langword="null" />;
11961 otherwise, <paramref name="value" />.
11962 </returns>
11963 </member>
11964 <member name="M:NAnt.Core.Util.StringUtils.Join(System.String,System.Collections.Specialized.StringCollection)">
11965 <summary>
11966 Concatenates a specified separator <see cref="T:System.String"/> between each
11967 element of a specified <see cref="T:System.Collections.Specialized.StringCollection"/>, yielding a
11968 single concatenated string.
11969 </summary>
11970 <param name="separator">A <see cref="T:System.String"/>.</param>
11971 <param name="value">A <see cref="T:System.Collections.Specialized.StringCollection"/>.</param>
11972 <returns>
11973 A <see cref="T:System.String"/> consisting of the elements of <paramref name="value"/>
11974 interspersed with the separator string.
11975 </returns>
11976 <remarks>
11977 <para>
11978 For example if <paramref name="separator"/> is ", " and the elements
11979 of <paramref name="value"/> are "apple", "orange", "grape", and "pear",
11980 <see cref="M:NAnt.Core.Util.StringUtils.Join(System.String,System.Collections.Specialized.StringCollection)"/> returns "apple, orange,
11981 grape, pear".
11982 </para>
11983 <para>
11984 If <paramref name="separator"/> is <see langword="null"/>, an empty
11985 string (<see cref="F:System.String.Empty"/>) is used instead.
11986 </para>
11987 </remarks>
11988 </member>
11989 <member name="M:NAnt.Core.Util.StringUtils.Clone(System.Collections.Specialized.StringCollection)">
11990 <summary>
11991 Creates a shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
11992 </summary>
11993 <param name="stringCollection">The <see cref="T:System.Collections.Specialized.StringCollection"/> that should be copied.</param>
11994 <returns>
11995 A shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
11996 </returns>
11997 </member>
11998 <member name="T:NAnt.Core.BuildException">
11999 <summary>
12000 Thrown whenever an error occurs during the build.
12001 </summary>
12002 </member>
12003 <member name="F:NAnt.Core.BuildException._location">
12004 <summary>
12005 The location of the exception in the build document (xml file).
12006 </summary>
12007 </member>
12008 <member name="M:NAnt.Core.BuildException.#ctor">
12009 <summary>
12010 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class.
12011 </summary>
12012 </member>
12013 <member name="M:NAnt.Core.BuildException.#ctor(System.String)">
12014 <summary>
12015 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12016 with a descriptive message.
12017 </summary>
12018 <param name="message">A descriptive message to include with the exception.</param>
12019 </member>
12020 <member name="M:NAnt.Core.BuildException.#ctor(System.String,System.Exception)">
12021 <summary>
12022 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12023 with the specified descriptive message and inner exception.
12024 </summary>
12025 <param name="message">A descriptive message to include with the exception.</param>
12026 <param name="innerException">A nested exception that is the cause of the current exception.</param>
12027 </member>
12028 <member name="M:NAnt.Core.BuildException.#ctor(System.String,NAnt.Core.Location)">
12029 <summary>
12030 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12031 with a descriptive message and the location in the build file that
12032 caused the exception.
12033 </summary>
12034 <param name="message">A descriptive message to include with the exception.</param>
12035 <param name="location">The location in the build file where the exception occured.</param>
12036 </member>
12037 <member name="M:NAnt.Core.BuildException.#ctor(System.String,NAnt.Core.Location,System.Exception)">
12038 <summary>
12039 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12040 with a descriptive message, the location in the build file and an
12041 instance of the exception that is the cause of the current exception.
12042 </summary>
12043 <param name="message">A descriptive message to include with the exception.</param>
12044 <param name="location">The location in the build file where the exception occured.</param>
12045 <param name="innerException">A nested exception that is the cause of the current exception.</param>
12046 </member>
12047 <member name="M:NAnt.Core.BuildException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
12048 <summary>
12049 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12050 with serialized data.
12051 </summary>
12052 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
12053 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
12054 </member>
12055 <member name="M:NAnt.Core.BuildException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
12056 <summary>
12057 Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
12058 </summary>
12059 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
12060 <param name="context">The destination for this serialization.</param>
12061 </member>
12062 <member name="M:NAnt.Core.BuildException.ToString">
12063 <summary>
12064 Creates and returns a string representation of the current
12065 exception.
12066 </summary>
12067 <returns>
12068 A string representation of the current exception.
12069 </returns>
12070 </member>
12071 <member name="P:NAnt.Core.BuildException.RawMessage">
12072 <summary>
12073 Gets the raw message as specified when the exception was
12074 constructed.
12075 </summary>
12076 <value>
12077 The raw message as specified when the exception was
12078 constructed.
12079 </value>
12080 </member>
12081 <member name="P:NAnt.Core.BuildException.Location">
12082 <summary>
12083 Gets the location in the build file of the element from which the
12084 exception originated.
12085 </summary>
12086 <value>
12087 The location in the build file of the element from which the
12088 exception originated.
12089 </value>
12090 </member>
12091 <member name="P:NAnt.Core.BuildException.Message">
12092 <summary>
12093 Gets a message that describes the current exception.
12094 </summary>
12095 <value>
12096 The error message that explains the reason for the exception.
12097 </value>
12098 <remarks>
12099 Adds location information to the message, if available.
12100 </remarks>
12101 </member>
12102 <member name="T:NAnt.Core.CommandLineOptions">
12103 <summary>
12104 Represents the set of command-line options supported by NAnt.
12105 </summary>
12106 </member>
12107 <member name="P:NAnt.Core.CommandLineOptions.TargetFramework">
12108 <summary>
12109 Gets or sets the target framework to use (overrides
12110 NAnt.exe.config settings)
12111 </summary>
12112 <value>
12113 The framework that should be used.
12114 </value>
12115 <remarks>
12116 For a list of possible frameworks, see NAnt.exe.config, possible
12117 values include "net-1.0", "net-1.1", etc.
12118 </remarks>
12119 </member>
12120 <member name="P:NAnt.Core.CommandLineOptions.DefaultFramework">
12121 <summary>
12122 Gets or sets the target framework to use (overrides
12123 NAnt.exe.config settings)
12124 </summary>
12125 <value>
12126 The framework that should be used.
12127 </value>
12128 <remarks>
12129 For a list of possible frameworks, see NAnt.exe.config, possible
12130 values include "net-1.0", "net-1.1", etc.
12131 </remarks>
12132 </member>
12133 <member name="P:NAnt.Core.CommandLineOptions.BuildFile">
12134 <summary>
12135 Gets or sets the buildfile that should be executed.
12136 </summary>
12137 <value>
12138 The buildfile that should be executed.
12139 </value>
12140 <remarks>
12141 Can be both a file or an URI.
12142 </remarks>
12143 </member>
12144 <member name="P:NAnt.Core.CommandLineOptions.Verbose">
12145 <summary>
12146 Gets or sets a value indicating whether more information should be
12147 displayed during the build process.
12148 </summary>
12149 <value>
12150 <see langword="true" /> if more information should be displayed;
12151 otherwise, <see langword="false" />. The default is <see langword="false" />.
12152 </value>
12153 </member>
12154 <member name="P:NAnt.Core.CommandLineOptions.Debug">
12155 <summary>
12156 Gets or sets a value indicating whether debug information should be
12157 displayed during the build process.
12158 </summary>
12159 <value>
12160 <see langword="true" /> if debug information should be displayed;
12161 otherwise, <see langword="false" />. The default is <see langword="false" />.
12162 </value>
12163 </member>
12164 <member name="P:NAnt.Core.CommandLineOptions.Quiet">
12165 <summary>
12166 Gets or sets a value indicating whether only error and debug debug messages should be
12167 displayed during the build process.
12168 </summary>
12169 <value>
12170 <see langword="true" /> if only error or warning messages should be
12171 displayed; otherwise, <see langword="false" />. The default is
12172 <see langword="false" />.
12173 </value>
12174 </member>
12175 <member name="P:NAnt.Core.CommandLineOptions.EmacsMode">
12176 <summary>
12177 Gets or sets a value indicating whether to produce emacs (and other
12178 editor) friendly output.
12179 </summary>
12180 <value>
12181 <see langword="true" /> if output is to be unadorned so that emacs
12182 and other editors can parse files names, etc. The default is
12183 <see langword="false" />.
12184 </value>
12185 </member>
12186 <member name="P:NAnt.Core.CommandLineOptions.FindInParent">
12187 <summary>
12188 Gets a value indicating whether parent directories should be searched
12189 for a buildfile.
12190 </summary>
12191 <value>
12192 <see langword="true" /> if parent directories should be searched for
12193 a build file; otherwise, <see langword="false" />. The default is
12194 <see langword="false" />.
12195 </value>
12196 </member>
12197 <member name="P:NAnt.Core.CommandLineOptions.IndentationLevel">
12198 <summary>
12199 Gets or sets the indentation level of the build output.
12200 </summary>
12201 <value>
12202 The indentation level of the build output. The default is <c>0</c>.
12203 </value>
12204 </member>
12205 <member name="P:NAnt.Core.CommandLineOptions.Properties">
12206 <summary>
12207 Gets or sets the list of properties that should be set.
12208 </summary>
12209 <value>
12210 The list of properties that should be set.
12211 </value>
12212 </member>
12213 <member name="P:NAnt.Core.CommandLineOptions.LoggerType">
12214 <summary>
12215 Gets or sets the <see cref="T:System.Type"/> of logger to add to the list
12216 of listeners.
12217 </summary>
12218 <value>
12219 The <see cref="T:System.Type"/> of logger to add to the list of
12220 listeners.
12221 </value>
12222 <remarks>
12223 The <see cref="P:NAnt.Core.CommandLineOptions.LoggerType"/> should derive from <see cref="T:NAnt.Core.IBuildLogger"/>.
12224 </remarks>
12225 </member>
12226 <member name="P:NAnt.Core.CommandLineOptions.LogFile">
12227 <summary>
12228 Gets or sets the name of the file to log output to.
12229 </summary>
12230 <value>
12231 The name of the file to log output to.
12232 </value>
12233 </member>
12234 <member name="P:NAnt.Core.CommandLineOptions.Listeners">
12235 <summary>
12236 Gets a collection containing fully qualified type names of classes
12237 implementating <see cref="T:NAnt.Core.IBuildListener"/> that should be added
12238 to the project as listeners.
12239 </summary>
12240 <value>
12241 A collection of fully qualified type names that should be added as
12242 listeners to the <see cref="T:NAnt.Core.Project"/>.
12243 </value>
12244 </member>
12245 <member name="P:NAnt.Core.CommandLineOptions.ExtensionAssemblies">
12246 <summary>
12247 Gets a collection of assemblies to load extensions from.
12248 </summary>
12249 <value>
12250 A collection of assemblies to load extensions from.
12251 </value>
12252 </member>
12253 <member name="P:NAnt.Core.CommandLineOptions.ShowProjectHelp">
12254 <summary>
12255 Gets or sets a value indicating whether <see cref="T:NAnt.Core.Project"/> help
12256 should be printed.
12257 </summary>
12258 <value>
12259 <see langword="true"/> if <see cref="T:NAnt.Core.Project"/> help should be
12260 printed; otherwise, <see langword="false"/>. The default is
12261 <see langword="false"/>.
12262 </value>
12263 </member>
12264 <member name="P:NAnt.Core.CommandLineOptions.NoLogo">
12265 <summary>
12266 Gets or sets a value indicating whether the logo banner should be
12267 printed.
12268 </summary>
12269 <value>
12270 <see langword="true" /> if the logo banner should be printed; otherwise,
12271 <see langword="false" />. The default is <see langword="false" />.
12272 </value>
12273 </member>
12274 <member name="P:NAnt.Core.CommandLineOptions.ShowHelp">
12275 <summary>
12276 Gets or sets a value indicating whether the NAnt help should be
12277 printed.
12278 </summary>
12279 <value>
12280 <see langword="true" /> if NAnt help should be printed; otherwise,
12281 <see langword="false" />. The default is <see langword="false" />.
12282 </value>
12283 </member>
12284 <member name="P:NAnt.Core.CommandLineOptions.Targets">
12285 <summary>
12286 Gets a collection containing the targets that should be executed.
12287 </summary>
12288 <value>
12289 A collection that contains the targets that should be executed.
12290 </value>
12291 </member>
12292 <member name="T:NAnt.Core.ConfigurationSection">
12293 <summary>
12294 Custom configuration section handler for the <nantsettings/> element.
12295 </summary>
12296 </member>
12297 <member name="M:NAnt.Core.ConfigurationSection.Create(System.Object,System.Object,System.Xml.XmlNode)">
12298 <summary>
12299 This just passed things through. Return the node read from the config file.
12300 </summary>
12301 </member>
12302 <member name="T:NAnt.Core.ConsoleDriver">
12303 <summary>
12304 Main entry point to NAnt that is called by the ConsoleStub.
12305 </summary>
12306 </member>
12307 <member name="M:NAnt.Core.ConsoleDriver.Main(System.String[])">
12308 <summary>
12309 Starts NAnt. This is the Main entry point.
12310 </summary>
12311 <param name="args">Command Line args, or whatever you want to pass it. They will treated as Command Line args.</param>
12312 <returns>
12313 The exit code.
12314 </returns>
12315 </member>
12316 <member name="M:NAnt.Core.ConsoleDriver.ShowProjectHelp(System.Xml.XmlDocument)">
12317 <summary>
12318 Prints the projecthelp to the console.
12319 </summary>
12320 <param name="buildDoc">The build file to show help for.</param>
12321 <remarks>
12322 <paramref name="buildDoc" /> is loaded and transformed with
12323 <c>ProjectHelp.xslt</c>, which is an embedded resource.
12324 </remarks>
12325 </member>
12326 <member name="M:NAnt.Core.ConsoleDriver.GetBuildFileName(System.String,System.String,System.Boolean)">
12327 <summary>
12328 Gets the file name for the build file in the specified directory.
12329 </summary>
12330 <param name="directory">The directory to look for a build file. When in doubt use Environment.CurrentDirectory for directory.</param>
12331 <param name="searchPattern">Look for a build file with this pattern or name. If null look for a file that matches the default build pattern (*.build).</param>
12332 <param name="findInParent">Whether or not to search the parent directories for a build file.</param>
12333 <returns>The path to the build file or <c>null</c> if no build file could be found.</returns>
12334 </member>
12335 <member name="M:NAnt.Core.ConsoleDriver.LoadExtensionAssemblies(System.Collections.Specialized.StringCollection,NAnt.Core.Project)">
12336 <summary>
12337 Loads the extension assemblies in the current <see cref="T:System.AppDomain"/>
12338 and scans them for extensions.
12339 </summary>
12340 <param name="extensionAssemblies">The extension assemblies to load.</param>
12341 <param name="project">The <see cref="T:NAnt.Core.Project"/> which will be used to output messages to the build log.</param>
12342 </member>
12343 <member name="M:NAnt.Core.ConsoleDriver.CreateLogger(System.String)">
12344 <summary>
12345 Dynamically constructs an <see cref="T:NAnt.Core.IBuildLogger"/> instance of
12346 the class specified.
12347 </summary>
12348 <remarks>
12349 <para>
12350 At this point, only looks in the assembly where <see cref="T:NAnt.Core.IBuildLogger"/>
12351 is defined.
12352 </para>
12353 </remarks>
12354 <param name="typeName">The fully qualified name of the logger that should be instantiated.</param>
12355 <exception cref="T:System.TypeLoadException">Type <paramref name="typeName"/> could not be loaded.</exception>
12356 <exception cref="T:System.ArgumentException"><paramref name="typeName"/> does not implement <see cref="T:NAnt.Core.IBuildLogger"/>.</exception>
12357 </member>
12358 <member name="M:NAnt.Core.ConsoleDriver.CreateListener(System.String)">
12359 <summary>
12360 Dynamically constructs an <see cref="T:NAnt.Core.IBuildListener"/> instance of
12361 the class specified.
12362 </summary>
12363 <remarks>
12364 <para>
12365 At this point, only looks in the assembly where <see cref="T:NAnt.Core.IBuildListener"/>
12366 is defined.
12367 </para>
12368 </remarks>
12369 <param name="typeName">The fully qualified name of the listener that should be instantiated.</param>
12370 <exception cref="T:System.TypeLoadException">Type <paramref name="typeName"/> could not be loaded.</exception>
12371 <exception cref="T:System.ArgumentException"><paramref name="typeName"/> does not implement <see cref="T:NAnt.Core.IBuildListener"/>.</exception>
12372 </member>
12373 <member name="M:NAnt.Core.ConsoleDriver.AddBuildListeners(NAnt.Core.CommandLineOptions,NAnt.Core.Project)">
12374 <summary>
12375 Add the listeners specified in the command line arguments,
12376 along with the default listener, to the specified project.
12377 </summary>
12378 <param name="cmdlineOptions">The command-line options.</param>
12379 <param name="project">The <see cref="T:NAnt.Core.Project"/> to add listeners to.</param>
12380 </member>
12381 <member name="M:NAnt.Core.ConsoleDriver.ShowHelp(NAnt.Core.Util.CommandLineParser)">
12382 <summary>
12383 Spits out generic help info to the console.
12384 </summary>
12385 </member>
12386 <member name="M:NAnt.Core.ConsoleDriver.WriteException(System.Exception)">
12387 <summary>
12388 Write the message of the specified <see cref="T:System.Exception"/> and
12389 the inner exceptions to <see cref="P:System.Console.Error"/>.
12390 </summary>
12391 <param name="cause">The <see cref="T:System.Exception"/> to write to <see cref="P:System.Console.Error"/>.</param>
12392 </member>
12393 <member name="M:NAnt.Core.DataTypeBaseBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
12394 <summary>
12395 Creates a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
12396 class for the specified <see cref="T:NAnt.Core.DataTypeBase"/> class in the
12397 <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> specified.
12398 </summary>
12399 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.DataTypeBase"/>.</param>
12400 <param name="className">The class representing the <see cref="T:NAnt.Core.DataTypeBase"/>.</param>
12401 </member>
12402 <member name="P:NAnt.Core.DataTypeBaseBuilder.ClassName">
12403 <summary>
12404 Gets the name of the <see cref="T:NAnt.Core.DataTypeBase"/> class that can be
12405 created using this <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>.
12406 </summary>
12407 <value>
12408 The name of the <see cref="T:NAnt.Core.DataTypeBase"/> class that can be created
12409 using this <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>.
12410 </value>
12411 </member>
12412 <member name="P:NAnt.Core.DataTypeBaseBuilder.DataTypeName">
12413 <summary>
12414 Gets the name of the data type which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
12415 can create.
12416 </summary>
12417 <value>
12418 The name of the data type which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
12419 can create.
12420 </value>
12421 </member>
12422 <member name="T:NAnt.Core.DataTypeBaseBuilderCollection">
12423 <summary>
12424 Contains a strongly typed collection of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> objects.
12425 </summary>
12426 </member>
12427 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor">
12428 <summary>
12429 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class.
12430 </summary>
12431 </member>
12432 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor(NAnt.Core.DataTypeBaseBuilderCollection)">
12433 <summary>
12434 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class
12435 with the specified <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> instance.
12436 </summary>
12437 </member>
12438 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor(NAnt.Core.DataTypeBaseBuilder[])">
12439 <summary>
12440 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class
12441 with the specified array of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
12442 </summary>
12443 </member>
12444 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Add(NAnt.Core.DataTypeBaseBuilder)">
12445 <summary>
12446 Adds a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to the end of the collection.
12447 </summary>
12448 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to be added to the end of the collection.</param>
12449 <returns>The position into which the new element was inserted.</returns>
12450 </member>
12451 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.AddRange(NAnt.Core.DataTypeBaseBuilder[])">
12452 <summary>
12453 Adds the elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> array to the end of the collection.
12454 </summary>
12455 <param name="items">The array of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> elements to be added to the end of the collection.</param>
12456 </member>
12457 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.AddRange(NAnt.Core.DataTypeBaseBuilderCollection)">
12458 <summary>
12459 Adds the elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> to the end of the collection.
12460 </summary>
12461 <param name="items">The <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> to be added to the end of the collection.</param>
12462 </member>
12463 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Contains(NAnt.Core.DataTypeBaseBuilder)">
12464 <summary>
12465 Determines whether a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> is in the collection.
12466 </summary>
12467 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to locate in the collection.</param>
12468 <returns>
12469 <see langword="true"/> if <paramref name="item"/> is found in the
12470 collection; otherwise, <see langword="false"/>.
12471 </returns>
12472 </member>
12473 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Contains(System.String)">
12474 <summary>
12475 Determines whether a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for the specified
12476 task is in the collection.
12477 </summary>
12478 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> should be located in the collection.</param>
12479 <returns>
12480 <see langword="true"/> if a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for
12481 the specified task is found in the collection; otherwise,
12482 <see langword="false"/>.
12483 </returns>
12484 </member>
12485 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.CopyTo(NAnt.Core.DataTypeBaseBuilder[],System.Int32)">
12486 <summary>
12487 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
12488 </summary>
12489 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
12490 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
12491 </member>
12492 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.IndexOf(NAnt.Core.DataTypeBaseBuilder)">
12493 <summary>
12494 Retrieves the index of a specified <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> object in the collection.
12495 </summary>
12496 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> object for which the index is returned.</param>
12497 <returns>
12498 The index of the specified <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>. If the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> is not currently a member of the collection, it returns -1.
12499 </returns>
12500 </member>
12501 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Insert(System.Int32,NAnt.Core.DataTypeBaseBuilder)">
12502 <summary>
12503 Inserts a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> into the collection at the specified index.
12504 </summary>
12505 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
12506 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to insert.</param>
12507 </member>
12508 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.GetEnumerator">
12509 <summary>
12510 Returns an enumerator that can iterate through the collection.
12511 </summary>
12512 <returns>
12513 A <see cref="T:NAnt.Core.DataTypeBaseBuilderEnumerator"/> for the entire collection.
12514 </returns>
12515 </member>
12516 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Remove(NAnt.Core.DataTypeBaseBuilder)">
12517 <summary>
12518 Removes a member from the collection.
12519 </summary>
12520 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to remove from the collection.</param>
12521 </member>
12522 <member name="P:NAnt.Core.DataTypeBaseBuilderCollection.Item(System.Int32)">
12523 <summary>
12524 Gets or sets the element at the specified index.
12525 </summary>
12526 <param name="index">The zero-based index of the element to get or set.</param>
12527 </member>
12528 <member name="P:NAnt.Core.DataTypeBaseBuilderCollection.Item(System.String)">
12529 <summary>
12530 Gets the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for the specified task.
12531 </summary>
12532 <param name="dataTypeName">The name of task for which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> should be located in the collection.</param>
12533 </member>
12534 <member name="T:NAnt.Core.DataTypeBaseBuilderEnumerator">
12535 <summary>
12536 Enumerates the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/>.
12537 </summary>
12538 </member>
12539 <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.#ctor(NAnt.Core.DataTypeBaseBuilderCollection)">
12540 <summary>
12541 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderEnumerator"/> class
12542 with the specified <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/>.
12543 </summary>
12544 <param name="arguments">The collection that should be enumerated.</param>
12545 </member>
12546 <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.MoveNext">
12547 <summary>
12548 Advances the enumerator to the next element of the collection.
12549 </summary>
12550 <returns>
12551 <see langword="true" /> if the enumerator was successfully advanced
12552 to the next element; <see langword="false" /> if the enumerator has
12553 passed the end of the collection.
12554 </returns>
12555 </member>
12556 <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.Reset">
12557 <summary>
12558 Sets the enumerator to its initial position, which is before the
12559 first element in the collection.
12560 </summary>
12561 </member>
12562 <member name="P:NAnt.Core.DataTypeBaseBuilderEnumerator.Current">
12563 <summary>
12564 Gets the current element in the collection.
12565 </summary>
12566 <returns>
12567 The current element in the collection.
12568 </returns>
12569 </member>
12570 <member name="M:NAnt.Core.DataTypeBaseDictionary.#ctor">
12571 <summary>
12572 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseDictionary"/> class.
12573 </summary>
12574 </member>
12575 <member name="M:NAnt.Core.DataTypeBaseDictionary.#ctor(System.Int32)">
12576 <summary>
12577 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseDictionary"/> class
12578 with the specified capacity.
12579 </summary>
12580 </member>
12581 <member name="M:NAnt.Core.DataTypeBaseDictionary.Inherit(NAnt.Core.DataTypeBaseDictionary)">
12582 <summary>
12583 Inherits Properties from an existing property
12584 dictionary Instance
12585 </summary>
12586 <param name="source">DataType list to inherit</param>
12587 </member>
12588 <member name="T:NAnt.Core.DirectoryScanner">
12589 <summary>
12590 Used for searching filesystem based on given include/exclude rules.
12591 </summary>
12592 <example>
12593 <para>Simple client code for testing the class.</para>
12594 <code>
12595 while (true) {
12596 DirectoryScanner scanner = new DirectoryScanner();
12597
12598 Console.Write("Scan Basedirectory : ");
12599 string s = Console.ReadLine();
12600 if (s.Length == 0) break;
12601 scanner.BaseDirectory = s;
12602
12603 while(true) {
12604 Console.Write("Include pattern : ");
12605 s = Console.ReadLine();
12606 if (s.Length == 0) break;
12607 scanner.Includes.Add(s);
12608 }
12609
12610 while(true) {
12611 Console.Write("Exclude pattern : ");
12612 s = Console.ReadLine();
12613 if (s.Length == 0) break;
12614 scanner.Excludes.Add(s);
12615 }
12616
12617 foreach (string name in scanner.FileNames)
12618 Console.WriteLine("file:" + name);
12619 foreach (string name in scanner.DirectoryNames)
12620 Console.WriteLine("dir :" + name);
12621
12622 Console.WriteLine("");
12623 }
12624 </code>
12625 </example>
12626 </member>
12627 <member name="M:NAnt.Core.DirectoryScanner.#ctor">
12628 <summary>
12629 Initializes a new instance of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
12630 </summary>
12631 <remarks>
12632 On unix, patterns are matching case-sensitively; otherwise, they
12633 are matched case-insensitively.
12634 </remarks>
12635 </member>
12636 <member name="M:NAnt.Core.DirectoryScanner.#ctor(System.Boolean)">
12637 <summary>
12638 Initializes a new instance of the <see cref="T:NAnt.Core.DirectoryScanner"/>
12639 specifying whether patterns are to be match case-sensitively.
12640 </summary>
12641 <param name="caseSensitive">Specifies whether patterns are to be matched case-sensititely.</param>
12642 </member>
12643 <member name="M:NAnt.Core.DirectoryScanner.Clone">
12644 <summary>
12645 Creates a shallow copy of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
12646 </summary>
12647 <returns>
12648 A shallow copy of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
12649 </returns>
12650 </member>
12651 <member name="M:NAnt.Core.DirectoryScanner.Scan">
12652 <summary>
12653 Uses <see cref="P:NAnt.Core.DirectoryScanner.Includes"/> and <see cref="P:NAnt.Core.DirectoryScanner.Excludes"/> search criteria (relative to
12654 <see cref="P:NAnt.Core.DirectoryScanner.BaseDirectory"/> or absolute), to search for filesystem objects.
12655 </summary>
12656 </member>
12657 <member name="M:NAnt.Core.DirectoryScanner.ConvertPatterns(System.Collections.Specialized.StringCollection,System.Collections.ArrayList,System.Collections.Specialized.StringCollection,System.Boolean)">
12658 <summary>
12659 Parses specified NAnt search patterns for search directories and
12660 corresponding regex patterns.
12661 </summary>
12662 <param name="nantPatterns">In. NAnt patterns. Absolute or relative paths.</param>
12663 <param name="regexPatterns">Out. Regex patterns. Absolute canonical paths.</param>
12664 <param name="nonRegexFiles">Out. Non-regex files. Absolute canonical paths.</param>
12665 <param name="addSearchDirectories">In. Whether to allow a pattern to add search directories.</param>
12666 </member>
12667 <member name="M:NAnt.Core.DirectoryScanner.ParseSearchDirectoryAndPattern(System.Boolean,System.String,System.String@,System.Boolean@,System.Boolean@,System.String@)">
12668 <summary>
12669 Given a NAnt search pattern returns a search directory and an regex
12670 search pattern.
12671 </summary>
12672 <param name="isInclude">Whether this pattern is an include or exclude pattern</param>
12673 <param name="originalNAntPattern">NAnt searh pattern (relative to the Basedirectory OR absolute, relative paths refering to parent directories ( ../ ) also supported)</param>
12674 <param name="searchDirectory">Out. Absolute canonical path to the directory to be searched</param>
12675 <param name="recursive">Out. Whether the pattern is potentially recursive or not</param>
12676 <param name="isRegex">Out. Whether this is a regex pattern or not</param>
12677 <param name="regexPattern">Out. Regex search pattern (absolute canonical path)</param>
12678 </member>
12679 <member name="M:NAnt.Core.DirectoryScanner.ScanDirectory(System.String,System.Boolean)">
12680 <summary>
12681 Searches a directory recursively for files and directories matching
12682 the search criteria.
12683 </summary>
12684 <param name="path">Directory in which to search (absolute canonical path)</param>
12685 <param name="recursive">Whether to scan recursively or not</param>
12686 </member>
12687 <member name="M:NAnt.Core.DirectoryScanner.ToRegexPattern(System.String)">
12688 <summary>
12689 Converts search pattern to a regular expression pattern.
12690 </summary>
12691 <param name="nantPattern">Search pattern relative to the search directory.</param>
12692 <returns>Regular expresssion</returns>
12693 </member>
12694 <member name="P:NAnt.Core.DirectoryScanner.CaseSensitive">
12695 <summary>
12696 Gets or set a value indicating whether or not to use case-sensitive
12697 pattern matching.
12698 </summary>
12699 </member>
12700 <member name="P:NAnt.Core.DirectoryScanner.Includes">
12701 <summary>
12702 Gets the collection of include patterns.
12703 </summary>
12704 </member>
12705 <member name="P:NAnt.Core.DirectoryScanner.Excludes">
12706 <summary>
12707 Gets the collection of exclude patterns.
12708 </summary>
12709 </member>
12710 <member name="P:NAnt.Core.DirectoryScanner.BaseDirectory">
12711 <summary>
12712 The base directory to scan. The default is the
12713 <see cref="P:System.Environment.CurrentDirectory">current directory</see>.
12714 </summary>
12715 </member>
12716 <member name="P:NAnt.Core.DirectoryScanner.FileNames">
12717 <summary>
12718 Gets the list of files that match the given patterns.
12719 </summary>
12720 </member>
12721 <member name="P:NAnt.Core.DirectoryScanner.DirectoryNames">
12722 <summary>
12723 Gets the list of directories that match the given patterns.
12724 </summary>
12725 </member>
12726 <member name="P:NAnt.Core.DirectoryScanner.ScannedDirectories">
12727 <summary>
12728 Gets the list of directories that were scanned for files.
12729 </summary>
12730 </member>
12731 <member name="M:NAnt.Core.StringCollectionWithGoodToString.Clone">
12732 <summary>
12733 Creates a shallow copy of the <see cref="T:NAnt.Core.StringCollectionWithGoodToString"/>.
12734 </summary>
12735 <returns>
12736 A shallow copy of the <see cref="T:NAnt.Core.StringCollectionWithGoodToString"/>.
12737 </returns>
12738 </member>
12739 <member name="M:NAnt.Core.StringCollectionWithGoodToString.ToString">
12740 <summary>
12741 Creates a string representing a list of the strings in the collection.
12742 </summary>
12743 <returns>
12744 A string that represents the contents.
12745 </returns>
12746 </member>
12747 <member name="M:NAnt.Core.DirScannerStringCollection.#ctor(System.Boolean)">
12748 <summary>
12749 Initialize a new instance of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
12750 class specifying whether or not string comparison should be
12751 case-sensitive.
12752 </summary>
12753 <param name="caseSensitive">Specifies whether or not string comparison should be case-sensitive.</param>
12754 </member>
12755 <member name="M:NAnt.Core.DirScannerStringCollection.Clone">
12756 <summary>
12757 Creates a shallow copy of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
12758 </summary>
12759 <returns>
12760 A shallow copy of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
12761 </returns>
12762 </member>
12763 <member name="M:NAnt.Core.DirScannerStringCollection.Contains(System.String)">
12764 <summary>
12765 Determines whether the specified string is in the
12766 <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
12767 </summary>
12768 <param name="value">The string to locate in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>. The value can be <see langword="null"/>.</param>
12769 <returns>
12770 <seee langword="true"/> if value is found in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>; otherwise, <see langword="false"/>.
12771 </returns>
12772 <remarks>
12773 String comparisons within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
12774 are only case-sensitive if <see cref="P:NAnt.Core.DirScannerStringCollection.CaseSensitive"/> is
12775 <see langword="true"/>
12776 </remarks>
12777 </member>
12778 <member name="M:NAnt.Core.DirScannerStringCollection.IndexOf(System.String)">
12779 <summary>
12780 Searches for the specified string and returns the zero-based index
12781 of the first occurrence within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
12782 </summary>
12783 <param name="value">The string to locate. The value can be <see langword="null"/>.</param>
12784 <returns>
12785 The zero-based index of the first occurrence of <paramref name="value"/>
12786 in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>, if found; otherwise, -1.
12787 </returns>
12788 <remarks>
12789 String comparisons within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
12790 are only case-sensitive if <see cref="P:NAnt.Core.DirScannerStringCollection.CaseSensitive"/> is
12791 <see langword="true"/>.
12792 </remarks>
12793 </member>
12794 <member name="P:NAnt.Core.DirScannerStringCollection.CaseSensitive">
12795 <summary>
12796 Gets a value indicating whether string comparison is case-sensitive.
12797 </summary>
12798 <value>
12799 A value indicating whether string comparison is case-sensitive.
12800 </value>
12801 </member>
12802 <member name="M:NAnt.Core.ExpressionEvaluator.GetPropertyValue(System.String)">
12803 <summary>
12804 Gets the value of the specified property.
12805 </summary>
12806 <param name="propertyName">The name of the property to get the value of.</param>
12807 <returns>
12808 The value of the specified property.
12809 </returns>
12810 </member>
12811 <member name="T:NAnt.Core.ExpressionTokenizer">
12812 <summary>
12813 Splits an input string into a sequence of tokens used during parsing.
12814 </summary>
12815 </member>
12816 <member name="T:NAnt.Core.ExpressionTokenizer.TokenType">
12817 <summary>
12818 Available tokens
12819 </summary>
12820 </member>
12821 <member name="T:NAnt.Core.FrameworkInfo">
12822 <summary>
12823 Encalsulates information about installed frameworks incuding version
12824 information and directory locations for finding tools.
12825 </summary>
12826 </member>
12827 <member name="M:NAnt.Core.FrameworkInfo.ResolveAssembly(System.String)">
12828 <summary>
12829 Resolves the specified assembly to a full path by matching it
12830 against the reference assemblies.
12831 </summary>
12832 <param name="fileName">The file name of the assembly to resolve (without path information).</param>
12833 <returns>
12834 An absolute path to the assembly, or <see langword="null" /> if the
12835 assembly could not be found.
12836 </returns>
12837 <remarks>
12838 Whether the file name is matched case-sensitive depends on the
12839 operating system.
12840 </remarks>
12841 </member>
12842 <member name="M:NAnt.Core.FrameworkInfo.GetToolPath(System.String)">
12843 <summary>
12844 Searches the list of tool paths of the current framework for the
12845 given file, and returns the absolute path if found.
12846 </summary>
12847 <param name="tool">The file name of the tool to search for.</param>
12848 <returns>
12849 The absolute path to <paramref name="tool"/> if found in one of the
12850 configured tool paths; otherwise, <see langword="null"/>.
12851 </returns>
12852 <exception cref="T:System.ArgumentNullException"><paramref name="tool"/> is <see langword="null"/>.</exception>
12853 <remarks>
12854 <para>
12855 The configured tool paths are scanned in the order in which they
12856 are defined in the framework configuration.
12857 </para>
12858 <para>
12859 The file name of the tool to search should include the extension.
12860 </para>
12861 </remarks>
12862 </member>
12863 <member name="M:NAnt.Core.FrameworkInfo.GetXmlAttributeValue(System.Xml.XmlNode,System.String)">
12864 <summary>
12865 Gets the value of the specified attribute from the specified node.
12866 </summary>
12867 <param name="xmlNode">The node of which the attribute value should be retrieved.</param>
12868 <param name="attributeName">The attribute of which the value should be returned.</param>
12869 <returns>
12870 The value of the attribute with the specified name or <see langword="null" />
12871 if the attribute does not exist or has no value.
12872 </returns>
12873 </member>
12874 <member name="P:NAnt.Core.FrameworkInfo.Name">
12875 <summary>
12876 Gets the name of the framework.
12877 </summary>
12878 <value>
12879 The name of the framework.
12880 </value>
12881 </member>
12882 <member name="P:NAnt.Core.FrameworkInfo.Family">
12883 <summary>
12884 Gets the family of the framework.
12885 </summary>
12886 <value>
12887 The family of the framework.
12888 </value>
12889 </member>
12890 <member name="P:NAnt.Core.FrameworkInfo.Description">
12891 <summary>
12892 Gets the description of the framework.
12893 </summary>
12894 <value>
12895 The description of the framework.
12896 </value>
12897 </member>
12898 <member name="P:NAnt.Core.FrameworkInfo.Version">
12899 <summary>
12900 Gets the version of the framework.
12901 </summary>
12902 <value>
12903 The version of the framework.
12904 </value>
12905 </member>
12906 <member name="P:NAnt.Core.FrameworkInfo.ClrVersion">
12907 <summary>
12908 Gets the Common Language Runtime version of the framework.
12909 </summary>
12910 <value>
12911 The Common Language Runtime version of the framework.
12912 </value>
12913 </member>
12914 <member name="P:NAnt.Core.FrameworkInfo.VisualStudioVersion">
12915 <summary>
12916 Gets the Visual Studio version that corresponds with this
12917 framework.
12918 </summary>
12919 <remarks>
12920 The Visual Studio version that corresponds with this framework.
12921 </remarks>
12922 <exception cref="T:NAnt.Core.BuildException">There is no version of Visual Studio .NET that corresponds with this framework.</exception>
12923 </member>
12924 <member name="P:NAnt.Core.FrameworkInfo.FrameworkDirectory">
12925 <summary>
12926 Gets the base directory of the framework tools for the framework.
12927 </summary>
12928 <value>
12929 The base directory of the framework tools for the framework.
12930 </value>
12931 </member>
12932 <member name="P:NAnt.Core.FrameworkInfo.Runtime">
12933 <summary>
12934 Gets the runtime information for this framework.
12935 </summary>
12936 <value>
12937 The runtime information for the framework or <see langword="null" />
12938 if no runtime information is configured for the framework.
12939 </value>
12940 </member>
12941 <member name="P:NAnt.Core.FrameworkInfo.FrameworkAssemblyDirectory">
12942 <summary>
12943 Gets the directory where the system assemblies for the framework
12944 are located.
12945 </summary>
12946 <value>
12947 The directory where the system assemblies for the framework are
12948 located.
12949 </value>
12950 </member>
12951 <member name="P:NAnt.Core.FrameworkInfo.SdkDirectory">
12952 <summary>
12953 Gets the directory containing the SDK tools for the framework.
12954 </summary>
12955 <value>
12956 The directory containing the SDK tools for the framework or a null
12957 reference if the configured sdk directory does not exist, or is not
12958 valid.
12959 </value>
12960 </member>
12961 <member name="P:NAnt.Core.FrameworkInfo.Project">
12962 <summary>
12963 Gets the <see cref="P:NAnt.Core.FrameworkInfo.Project"/> used to initialize this framework.
12964 </summary>
12965 <value>
12966 The <see cref="P:NAnt.Core.FrameworkInfo.Project"/> used to initialize this framework.
12967 </value>
12968 </member>
12969 <member name="P:NAnt.Core.FrameworkInfo.TaskAssemblies">
12970 <summary>
12971 Gets the set of assemblies and directories that should scanned for
12972 NAnt tasks, types or functions.
12973 </summary>
12974 <value>
12975 The set of assemblies and directories that should be scanned for
12976 NAnt tasks, types or functions.
12977 </value>
12978 </member>
12979 <member name="P:NAnt.Core.FrameworkInfo.IsValid">
12980 <summary>
12981 Returns a value indicating whether the current framework is valid.
12982 </summary>
12983 <value>
12984 <see langword="true" /> if the framework is installed and correctly
12985 configured; otherwise, <see langword="false" />.
12986 </value>
12987 </member>
12988 <member name="P:NAnt.Core.FrameworkInfo.NamespaceManager">
12989 <summary>
12990 Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
12991 </summary>
12992 <value>
12993 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
12994 </value>
12995 <remarks>
12996 The <see cref="P:NAnt.Core.FrameworkInfo.NamespaceManager"/> defines the current namespace
12997 scope and provides methods for looking up namespace information.
12998 </remarks>
12999 </member>
13000 <member name="M:NAnt.Core.FrameworkInfoDictionary.#ctor">
13001 <summary>
13002 Initializes a new instance of the <see cref="T:NAnt.Core.FrameworkInfoDictionary"/> class.
13003 </summary>
13004 </member>
13005 <member name="M:NAnt.Core.FrameworkInfoDictionary.#ctor(System.Int32)">
13006 <summary>
13007 Initializes a new instance of the <see cref="T:NAnt.Core.FrameworkInfoDictionary"/> class
13008 with the specified capacity.
13009 </summary>
13010 </member>
13011 <member name="T:NAnt.Core.Location">
13012 <summary>
13013 Stores the file name, line number and column number to record a position
13014 in a text file.
13015 </summary>
13016 </member>
13017 <member name="M:NAnt.Core.Location.#ctor(System.String,System.Int32,System.Int32)">
13018 <summary>
13019 Creates a location consisting of a file name, line number and
13020 column number.
13021 </summary>
13022 <remarks>
13023 <paramref name="fileName" /> can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt.
13024 </remarks>
13025 </member>
13026 <member name="M:NAnt.Core.Location.#ctor(System.String)">
13027 <summary>
13028 Creates a location consisting of a file name.
13029 </summary>
13030 <remarks>
13031 <paramref name="fileName" /> can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt.
13032 </remarks>
13033 </member>
13034 <member name="M:NAnt.Core.Location.#ctor">
13035 <summary>
13036 Creates an "unknown" location.
13037 </summary>
13038 </member>
13039 <member name="M:NAnt.Core.Location.Init(System.String,System.Int32,System.Int32)">
13040 <summary>Private Init function.</summary>
13041 </member>
13042 <member name="M:NAnt.Core.Location.ToString">
13043 <summary>
13044 Returns the file name, line number and a trailing space. An error
13045 message can be appended easily. For unknown locations, returns
13046 an empty string.
13047 </summary>
13048 </member>
13049 <member name="P:NAnt.Core.Location.FileName">
13050 <summary>
13051 Gets a string containing the file name for the location.
13052 </summary>
13053 <remarks>
13054 The file name includes both the file path and the extension.
13055 </remarks>
13056 </member>
13057 <member name="P:NAnt.Core.Location.LineNumber">
13058 <summary>
13059 Gets the line number for the location.
13060 </summary>
13061 <remarks>
13062 Lines start at 1. Will be zero if not specified.
13063 </remarks>
13064 </member>
13065 <member name="P:NAnt.Core.Location.ColumnNumber">
13066 <summary>
13067 Gets the column number for the location.
13068 </summary>
13069 <remarks>
13070 Columns start a 1. Will be zero if not specified.
13071 </remarks>
13072 </member>
13073 <member name="T:NAnt.Core.LocationMap">
13074 <summary>
13075 Maps XML nodes to the text positions from their original source.
13076 </summary>
13077 </member>
13078 <member name="M:NAnt.Core.LocationMap.#ctor">
13079 <summary>
13080 Initializes a new instance of the <see cref="T:NAnt.Core.LocationMap"/> class.
13081 </summary>
13082 </member>
13083 <member name="M:NAnt.Core.LocationMap.FileIsMapped(System.String)">
13084 <summary>
13085 Determines if a file has been loaded by the current project.
13086 </summary>
13087 <param name="fileOrUri">The file to check.</param>
13088 <returns>
13089 <see langword="true" /> if the specified file has already been loaded
13090 by the current project; otherwise, <see langword="false" />.
13091 </returns>
13092 </member>
13093 <member name="M:NAnt.Core.LocationMap.Add(System.Xml.XmlDocument)">
13094 <summary>
13095 Adds an <see cref="T:System.Xml.XmlDocument"/> to the map.
13096 </summary>
13097 <remarks>
13098 An <see cref="T:System.Xml.XmlDocument"/> can only be added to the map once.
13099 </remarks>
13100 </member>
13101 <member name="M:NAnt.Core.LocationMap.GetLocation(System.Xml.XmlNode)">
13102 <summary>
13103 Returns the <see cref="T:NAnt.Core.Location"/> in the XML file for the given node.
13104 </summary>
13105 <remarks>
13106 The <paramref name="node"/> must be from an <see cref="T:System.Xml.XmlDocument"/>
13107 that has been added to the map.
13108 </remarks>
13109 </member>
13110 <member name="T:NAnt.Core.LocationMap.TextPosition">
13111 <summary>
13112 Represents a position in the build file.
13113 </summary>
13114 </member>
13115 <member name="M:NAnt.Core.LocationMap.TextPosition.#ctor(System.Int32,System.Int32)">
13116 <summary>
13117 Initializes a new instance of the <see cref="T:NAnt.Core.LocationMap.TextPosition"/>
13118 with the speified line and column.
13119 </summary>
13120 <param name="line">The line coordinate of the position.</param>
13121 <param name="column">The column coordinate of the position.</param>
13122 </member>
13123 <member name="F:NAnt.Core.LocationMap.TextPosition.Line">
13124 <summary>
13125 The line coordinate of the position.
13126 </summary>
13127 </member>
13128 <member name="F:NAnt.Core.LocationMap.TextPosition.Column">
13129 <summary>
13130 The column coordinate of the position.
13131 </summary>
13132 </member>
13133 <member name="T:NAnt.Core.Level">
13134 <summary>
13135 Defines the set of levels recognised by the NAnt logging system.
13136 </summary>
13137 </member>
13138 <member name="F:NAnt.Core.Level.Debug">
13139 <summary>
13140 Designates fine-grained informational events that are most useful
13141 to debug a build process.
13142 </summary>
13143 </member>
13144 <member name="F:NAnt.Core.Level.Verbose">
13145 <summary>
13146 Designates events that offer a more detailed view of the build
13147 process.
13148 </summary>
13149 </member>
13150 <member name="F:NAnt.Core.Level.Info">
13151 <summary>
13152 Designates informational events that are useful for getting a
13153 high-level view of the build process.
13154 </summary>
13155 </member>
13156 <member name="F:NAnt.Core.Level.Warning">
13157 <summary>
13158 Designates potentionally harmful events.
13159 </summary>
13160 </member>
13161 <member name="F:NAnt.Core.Level.Error">
13162 <summary>
13163 Designates error events.
13164 </summary>
13165 </member>
13166 <member name="F:NAnt.Core.Level.None">
13167 <summary>
13168 Can be used to suppress all messages.
13169 </summary>
13170 <remarks>
13171 No events should be logged with this <see cref="T:NAnt.Core.Level"/>.
13172 </remarks>
13173 </member>
13174 <member name="T:NAnt.Core.BuildEventArgs">
13175 <summary>
13176 Class representing an event occurring during a build.
13177 </summary>
13178 <remarks>
13179 <para>
13180 An event is built by specifying either a project, a task or a target.
13181 </para>
13182 <para>
13183 A <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event will only have a <see cref="P:NAnt.Core.BuildEventArgs.Project"/>
13184 reference.
13185 </para>
13186 <para>
13187 A <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level event will have <see cref="P:NAnt.Core.BuildEventArgs.Project"/> and
13188 <see cref="P:NAnt.Core.BuildEventArgs.Target"/> references.
13189 </para>
13190 <para>
13191 A <see cref="P:NAnt.Core.BuildEventArgs.Task"/> level event will have <see cref="P:NAnt.Core.BuildEventArgs.Project"/>,
13192 <see cref="P:NAnt.Core.BuildEventArgs.Target"/> and <see cref="P:NAnt.Core.BuildEventArgs.Task"/> references.
13193 </para>
13194 </remarks>
13195 </member>
13196 <member name="M:NAnt.Core.BuildEventArgs.#ctor">
13197 <summary>
13198 Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
13199 class.
13200 </summary>
13201 </member>
13202 <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Project)">
13203 <summary>
13204 Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
13205 class for a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event.
13206 </summary>
13207 <param name="project">The <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that emitted the event.</param>
13208 </member>
13209 <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Target)">
13210 <summary>
13211 Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
13212 class for a <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level event.
13213 </summary>
13214 <param name="target">The <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that emitted the event.</param>
13215 </member>
13216 <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Task)">
13217 <summary>
13218 Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
13219 class for a <see cref="P:NAnt.Core.BuildEventArgs.Task"/> level event.
13220 </summary>
13221 <param name="task">The <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that emitted the event.</param>
13222 </member>
13223 <member name="P:NAnt.Core.BuildEventArgs.Message">
13224 <summary>
13225 Gets or sets the message associated with this event.
13226 </summary>
13227 <value>
13228 The message associated with this event.
13229 </value>
13230 </member>
13231 <member name="P:NAnt.Core.BuildEventArgs.MessageLevel">
13232 <summary>
13233 Gets or sets the priority level associated with this event.
13234 </summary>
13235 <value>
13236 The priority level associated with this event.
13237 </value>
13238 </member>
13239 <member name="P:NAnt.Core.BuildEventArgs.Exception">
13240 <summary>
13241 Gets or sets the <see cref="P:NAnt.Core.BuildEventArgs.Exception"/> associated with this event.
13242 </summary>
13243 <value>
13244 The <see cref="P:NAnt.Core.BuildEventArgs.Exception"/> associated with this event.
13245 </value>
13246 </member>
13247 <member name="P:NAnt.Core.BuildEventArgs.Project">
13248 <summary>
13249 Gets the <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that fired this event.
13250 </summary>
13251 <value>
13252 The <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that fired this event.
13253 </value>
13254 </member>
13255 <member name="P:NAnt.Core.BuildEventArgs.Target">
13256 <summary>
13257 Gets the <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that fired this event.
13258 </summary>
13259 <value>
13260 The <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that fired this event, or a null reference
13261 if this is a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event.
13262 </value>
13263 </member>
13264 <member name="P:NAnt.Core.BuildEventArgs.Task">
13265 <summary>
13266 Gets the <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that fired this event.
13267 </summary>
13268 <value>
13269 The <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that fired this event, or <see langword="null"/>
13270 if this is a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> or <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level
13271 event.
13272 </value>
13273 </member>
13274 <member name="T:NAnt.Core.BuildEventHandler">
13275 <summary>
13276 Represents the method that handles the build events.
13277 </summary>
13278 <param name="sender">The source of the event.</param>
13279 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
13280 </member>
13281 <member name="T:NAnt.Core.IBuildListener">
13282 <summary>
13283 Instances of classes that implement this interface can register to be
13284 notified when things happen during a build.
13285 </summary>
13286 </member>
13287 <member name="M:NAnt.Core.IBuildListener.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
13288 <summary>
13289 Signals that a build has started.
13290 </summary>
13291 <param name="sender">The source of the event.</param>
13292 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13293 <remarks>
13294 This event is fired before any targets have started.
13295 </remarks>
13296 </member>
13297 <member name="M:NAnt.Core.IBuildListener.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
13298 <summary>
13299 Signals that the last target has finished.
13300 </summary>
13301 <param name="sender">The source of the event.</param>
13302 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13303 <remarks>
13304 This event will still be fired if an error occurred during the build.
13305 </remarks>
13306 </member>
13307 <member name="M:NAnt.Core.IBuildListener.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
13308 <summary>
13309 Signals that a target has started.
13310 </summary>
13311 <param name="sender">The source of the event.</param>
13312 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13313 </member>
13314 <member name="M:NAnt.Core.IBuildListener.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
13315 <summary>
13316 Signals that a target has finished.
13317 </summary>
13318 <param name="sender">The source of the event.</param>
13319 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13320 <remarks>
13321 This event will still be fired if an error occurred during the build.
13322 </remarks>
13323 </member>
13324 <member name="M:NAnt.Core.IBuildListener.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
13325 <summary>
13326 Signals that a task has started.
13327 </summary>
13328 <param name="sender">The source of the event.</param>
13329 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13330 </member>
13331 <member name="M:NAnt.Core.IBuildListener.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
13332 <summary>
13333 Signals that a task has finished.
13334 </summary>
13335 <param name="sender">The source of the event.</param>
13336 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13337 <remarks>
13338 This event will still be fired if an error occurred during the build.
13339 </remarks>
13340 </member>
13341 <member name="M:NAnt.Core.IBuildListener.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
13342 <summary>
13343 Signals that a message has been logged.
13344 </summary>
13345 <param name="sender">The source of the event.</param>
13346 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13347 </member>
13348 <member name="T:NAnt.Core.IBuildLogger">
13349 <summary>
13350 Interface used by NAnt to log the build output.
13351 </summary>
13352 <remarks>
13353 Depending on the supplied command-line arguments, NAnt will set the
13354 <see cref="P:NAnt.Core.IBuildLogger.OutputWriter"/> to <see cref="P:System.Console.Out"/> or a
13355 <see cref="T:System.IO.StreamWriter"/> with a file as backend store.
13356 </remarks>
13357 </member>
13358 <member name="M:NAnt.Core.IBuildLogger.Flush">
13359 <summary>
13360 Flushes buffered build events or messages to the underlying storage.
13361 </summary>
13362 </member>
13363 <member name="P:NAnt.Core.IBuildLogger.Threshold">
13364 <summary>
13365 Gets or sets the highest level of message this logger should respond
13366 to.
13367 </summary>
13368 <value>The highest level of message this logger should respond to.</value>
13369 <remarks>
13370 Only messages with a message level higher than or equal to the given
13371 level should actually be written to the log.
13372 </remarks>
13373 </member>
13374 <member name="P:NAnt.Core.IBuildLogger.EmacsMode">
13375 <summary>
13376 Gets or sets a value indicating whether to produce emacs (and other
13377 editor) friendly output.
13378 </summary>
13379 <value>
13380 <see langword="true" /> if output is to be unadorned so that emacs
13381 and other editors can parse files names, etc.
13382 </value>
13383 </member>
13384 <member name="P:NAnt.Core.IBuildLogger.OutputWriter">
13385 <summary>
13386 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
13387 to send its output.
13388 </summary>
13389 </member>
13390 <member name="M:NAnt.Core.DefaultLogger.#ctor">
13391 <summary>
13392 Initializes a new instance of the <see cref="T:NAnt.Core.DefaultLogger"/>
13393 class.
13394 </summary>
13395 </member>
13396 <member name="M:NAnt.Core.DefaultLogger.Flush">
13397 <summary>
13398 Flushes buffered build events or messages to the underlying storage.
13399 </summary>
13400 </member>
13401 <member name="M:NAnt.Core.DefaultLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
13402 <summary>
13403 Signals that a build has started.
13404 </summary>
13405 <param name="sender">The source of the event.</param>
13406 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13407 <remarks>
13408 This event is fired before any targets have started.
13409 </remarks>
13410 </member>
13411 <member name="M:NAnt.Core.DefaultLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
13412 <summary>
13413 Signals that the last target has finished.
13414 </summary>
13415 <param name="sender">The source of the event.</param>
13416 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13417 <remarks>
13418 This event will still be fired if an error occurred during the build.
13419 </remarks>
13420 </member>
13421 <member name="M:NAnt.Core.DefaultLogger.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
13422 <summary>
13423 Signals that a target has started.
13424 </summary>
13425 <param name="sender">The source of the event.</param>
13426 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13427 </member>
13428 <member name="M:NAnt.Core.DefaultLogger.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
13429 <summary>
13430 Signals that a task has finished.
13431 </summary>
13432 <param name="sender">The source of the event.</param>
13433 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13434 <remarks>
13435 This event will still be fired if an error occurred during the build.
13436 </remarks>
13437 </member>
13438 <member name="M:NAnt.Core.DefaultLogger.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
13439 <summary>
13440 Signals that a task has started.
13441 </summary>
13442 <param name="sender">The source of the event.</param>
13443 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13444 </member>
13445 <member name="M:NAnt.Core.DefaultLogger.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
13446 <summary>
13447 Signals that a task has finished.
13448 </summary>
13449 <param name="sender">The source of the event.</param>
13450 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13451 <remarks>
13452 This event will still be fired if an error occurred during the build.
13453 </remarks>
13454 </member>
13455 <member name="M:NAnt.Core.DefaultLogger.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
13456 <summary>
13457 Signals that a message has been logged.
13458 </summary>
13459 <param name="sender">The source of the event.</param>
13460 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13461 <remarks>
13462 Only messages with a priority higher or equal to the threshold of
13463 the logger will actually be output in the build log.
13464 </remarks>
13465 </member>
13466 <member name="M:NAnt.Core.DefaultLogger.Log(System.String)">
13467 <summary>
13468 Empty implementation which allows derived classes to receive the
13469 output that is generated in this logger.
13470 </summary>
13471 <param name="message">The message being logged.</param>
13472 </member>
13473 <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.Level,System.String,System.Int32)">
13474 <summary>
13475 Outputs an indented message to the build log if its priority is
13476 greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
13477 logger.
13478 </summary>
13479 <param name="messageLevel">The priority of the message to output.</param>
13480 <param name="message">The message to output.</param>
13481 <param name="indentationLength">The number of characters that the message should be indented.</param>
13482 </member>
13483 <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.BuildEventArgs)">
13484 <summary>
13485 Outputs an indented message to the build log if its priority is
13486 greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
13487 logger.
13488 </summary>
13489 <param name="e">The event to output.</param>
13490 </member>
13491 <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.BuildEventArgs,System.Int32)">
13492 <summary>
13493 Outputs an indented message to the build log if its priority is
13494 greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
13495 logger.
13496 </summary>
13497 <param name="e">The event to output.</param>
13498 <param name="indentationLength">The number of characters that the message should be indented.</param>
13499 </member>
13500 <member name="F:NAnt.Core.DefaultLogger._buildReports">
13501 <summary>
13502 Holds a stack of reports for all running builds.
13503 </summary>
13504 </member>
13505 <member name="P:NAnt.Core.DefaultLogger.Threshold">
13506 <summary>
13507 Gets or sets the highest level of message this logger should respond
13508 to.
13509 </summary>
13510 <value>
13511 The highest level of message this logger should respond to.
13512 </value>
13513 <remarks>
13514 Only messages with a message level higher than or equal to the given
13515 level should be written to the log.
13516 </remarks>
13517 </member>
13518 <member name="P:NAnt.Core.DefaultLogger.EmacsMode">
13519 <summary>
13520 Gets or sets a value indicating whether to produce emacs (and other
13521 editor) friendly output.
13522 </summary>
13523 <value>
13524 <see langword="true" /> if output is to be unadorned so that emacs
13525 and other editors can parse files names, etc. The default is
13526 <see langword="false" />.
13527 </value>
13528 </member>
13529 <member name="P:NAnt.Core.DefaultLogger.OutputWriter">
13530 <summary>
13531 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
13532 to send its output.
13533 </summary>
13534 <value>
13535 The <see cref="T:System.IO.TextWriter"/> to which the logger sends its output.
13536 </value>
13537 </member>
13538 <member name="T:NAnt.Core.BuildReport">
13539 <summary>
13540 Used to store information about a build, to allow better reporting to
13541 the user.
13542 </summary>
13543 </member>
13544 <member name="F:NAnt.Core.BuildReport.Errors">
13545 <summary>
13546 Errors encountered so far.
13547 </summary>
13548 </member>
13549 <member name="F:NAnt.Core.BuildReport.Warnings">
13550 <summary>
13551 Warnings encountered so far.
13552 </summary>
13553 </member>
13554 <member name="F:NAnt.Core.BuildReport.StartTime">
13555 <summary>
13556 The start time of the build process.
13557 </summary>
13558 </member>
13559 <member name="T:NAnt.Core.MailLogger">
13560 <summary>
13561 Buffers log messages from DefaultLogger, and sends an e-mail with the
13562 results.
13563 </summary>
13564 <remarks>
13565 The following properties are used to send the mail :
13566 <list type="table">
13567 <listheader>
13568 <term>Property</term>
13569 <description>Description</description>
13570 </listheader>
13571 <item>
13572 <term>MailLogger.mailhost</term>
13573 <description>Mail server to use. [default: localhost]</description>
13574 </item>
13575 <item>
13576 <term>MailLogger.from</term>
13577 <description>The address of the e-mail sender.</description>
13578 </item>
13579 <item>
13580 <term>MailLogger.failure.notify</term>
13581 <description>Send build failure e-mails ? [default: true]</description>
13582 </item>
13583 <item>
13584 <term>MailLogger.success.notify</term>
13585 <description>Send build success e-mails ? [default: true]</description>
13586 </item>
13587 <item>
13588 <term>MailLogger.failure.to</term>
13589 <description>The address to send build failure messages to.</description>
13590 </item>
13591 <item>
13592 <term>MailLogger.success.to</term>
13593 <description>The address to send build success messages to.</description>
13594 </item>
13595 <item>
13596 <term>MailLogger.failure.subject</term>
13597 <description>The subject of build failure messages. [default: "Build Failure"]</description>
13598 </item>
13599 <item>
13600 <term>MailLogger.success.subject</term>
13601 <description>The subject of build success messages. [default: "Build Success"]</description>
13602 </item>
13603 <item>
13604 <term>MailLogger.success.attachments</term>
13605 <description>The ID of a fileset holdng set of files to attach when the build is successful.</description>
13606 </item>
13607 <item>
13608 <term>MailLogger.failure.attachments</term>
13609 <description>The ID of a fileset holdng set of files to attach when the build fails.</description>
13610 </item>
13611 <item>
13612 <term>MailLogger.body.encoding</term>
13613 <description>The encoding type of the body of the e-mail message. [default: system's ANSI code page]</description>
13614 </item>
13615 <item>
13616 <term>MailLogger.smtp.username</term>
13617 <description>The name of the user to login to the SMTP server.</description>
13618 </item>
13619 <item>
13620 <term>MailLogger.smtp.password</term>
13621 <description>The password of the specified user.</description>
13622 </item>
13623 <item>
13624 <term>MailLogger.smtp.enablessl</term>
13625 <description>Specifies whether to use SSL to encrypt the connection. [default: false]</description>
13626 </item>
13627 <item>
13628 <term>MailLogger.smtp.port</term>
13629 <description>The SMTP server port to connect to. [default: 25]</description>
13630 </item>
13631 </list>
13632 </remarks>
13633 </member>
13634 <member name="M:NAnt.Core.MailLogger.#ctor">
13635 <summary>
13636 Initializes a new instance of the <see cref="T:NAnt.Core.MailLogger"/>
13637 class.
13638 </summary>
13639 </member>
13640 <member name="M:NAnt.Core.MailLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
13641 <summary>
13642 Signals that a build has started.
13643 </summary>
13644 <param name="sender">The source of the event.</param>
13645 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13646 <remarks>
13647 This event is fired before any targets have started.
13648 </remarks>
13649 </member>
13650 <member name="M:NAnt.Core.MailLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
13651 <summary>
13652 Signals that the last target has finished, and send an e-mail with
13653 the build results.
13654 </summary>
13655 <param name="sender">The source of the event.</param>
13656 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13657 </member>
13658 <member name="M:NAnt.Core.MailLogger.Log(System.String)">
13659 <summary>
13660 Receives and buffers log messages.
13661 </summary>
13662 <param name="message">The message being logged.</param>
13663 </member>
13664 <member name="M:NAnt.Core.MailLogger.GetPropertyValue(NAnt.Core.PropertyDictionary,System.String,System.String,System.Boolean)">
13665 <summary>
13666 Gets the value of the specified property.
13667 </summary>
13668 <param name="properties">Properties to obtain value from.</param>
13669 <param name="name">Suffix of property name. "MailLogger" will be prepended internally.</param>
13670 <param name="defaultValue">Value returned if property is not present in <paramref name="properties"/>.</param>
13671 <param name="required">Value indicating whether the property should exist, or have a default value set.</param>
13672 <returns>
13673 The value of the specified property; or the default value if the
13674 property is not present in <paramref name="properties"/>.
13675 </returns>
13676 <exception cref="T:System.ArgumentNullException"><paramref name="required"/> is <see langword="true"/>, and the specified property is not present and no default value has been given.</exception>
13677 </member>
13678 <member name="F:NAnt.Core.MailLogger._buffer">
13679 <summary>
13680 Buffer in which the message is constructed prior to sending.
13681 </summary>
13682 </member>
13683 <member name="F:NAnt.Core.MailLogger._projectStack">
13684 <summary>
13685 Holds the stack of currently executing projects.
13686 </summary>
13687 </member>
13688 <member name="T:NAnt.Core.BuildListenerCollection">
13689 <summary>
13690 Contains a strongly typed collection of <see cref="T:NAnt.Core.IBuildListener"/>
13691 objects.
13692 </summary>
13693 </member>
13694 <member name="M:NAnt.Core.BuildListenerCollection.#ctor">
13695 <summary>
13696 Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
13697 class.
13698 </summary>
13699 </member>
13700 <member name="M:NAnt.Core.BuildListenerCollection.#ctor(NAnt.Core.BuildListenerCollection)">
13701 <summary>
13702 Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
13703 class with the specified <see cref="T:NAnt.Core.BuildListenerCollection"/> instance.
13704 </summary>
13705 </member>
13706 <member name="M:NAnt.Core.BuildListenerCollection.#ctor(NAnt.Core.IBuildListener[])">
13707 <summary>
13708 Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
13709 class with the specified array of <see cref="T:NAnt.Core.IBuildListener"/> instances.
13710 </summary>
13711 </member>
13712 <member name="M:NAnt.Core.BuildListenerCollection.Add(NAnt.Core.IBuildListener)">
13713 <summary>
13714 Adds a <see cref="T:NAnt.Core.IBuildListener"/> to the end of the collection.
13715 </summary>
13716 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to be added to the end of the collection.</param>
13717 <returns>The position into which the new element was inserted.</returns>
13718 </member>
13719 <member name="M:NAnt.Core.BuildListenerCollection.AddRange(NAnt.Core.IBuildListener[])">
13720 <summary>
13721 Adds the elements of a <see cref="T:NAnt.Core.IBuildListener"/> array to the end of the collection.
13722 </summary>
13723 <param name="items">The array of <see cref="T:NAnt.Core.IBuildListener"/> elements to be added to the end of the collection.</param>
13724 </member>
13725 <member name="M:NAnt.Core.BuildListenerCollection.AddRange(NAnt.Core.BuildListenerCollection)">
13726 <summary>
13727 Adds the elements of a <see cref="T:NAnt.Core.BuildListenerCollection"/> to the end of the collection.
13728 </summary>
13729 <param name="items">The <see cref="T:NAnt.Core.BuildListenerCollection"/> to be added to the end of the collection.</param>
13730 </member>
13731 <member name="M:NAnt.Core.BuildListenerCollection.Contains(NAnt.Core.IBuildListener)">
13732 <summary>
13733 Determines whether a <see cref="T:NAnt.Core.IBuildListener"/> is in the collection.
13734 </summary>
13735 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to locate in the collection.</param>
13736 <returns>
13737 <see langword="true"/> if <paramref name="item"/> is found in the
13738 collection; otherwise, <see langword="false"/>.
13739 </returns>
13740 </member>
13741 <member name="M:NAnt.Core.BuildListenerCollection.CopyTo(NAnt.Core.IBuildListener[],System.Int32)">
13742 <summary>
13743 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
13744 </summary>
13745 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
13746 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
13747 </member>
13748 <member name="M:NAnt.Core.BuildListenerCollection.IndexOf(NAnt.Core.IBuildListener)">
13749 <summary>
13750 Retrieves the index of a specified <see cref="T:NAnt.Core.IBuildListener"/> object in the collection.
13751 </summary>
13752 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> object for which the index is returned.</param>
13753 <returns>
13754 The index of the specified <see cref="T:NAnt.Core.IBuildListener"/>. If the <see cref="T:NAnt.Core.IBuildListener"/> is not currently a member of the collection, it returns -1.
13755 </returns>
13756 </member>
13757 <member name="M:NAnt.Core.BuildListenerCollection.Insert(System.Int32,NAnt.Core.IBuildListener)">
13758 <summary>
13759 Inserts a <see cref="T:NAnt.Core.IBuildListener"/> into the collection at the specified index.
13760 </summary>
13761 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
13762 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to insert.</param>
13763 </member>
13764 <member name="M:NAnt.Core.BuildListenerCollection.GetEnumerator">
13765 <summary>
13766 Returns an enumerator that can iterate through the collection.
13767 </summary>
13768 <returns>
13769 A <see cref="T:NAnt.Core.BuildListenerEnumerator"/> for the entire collection.
13770 </returns>
13771 </member>
13772 <member name="M:NAnt.Core.BuildListenerCollection.Remove(NAnt.Core.IBuildListener)">
13773 <summary>
13774 Removes a member from the collection.
13775 </summary>
13776 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to remove from the collection.</param>
13777 </member>
13778 <member name="P:NAnt.Core.BuildListenerCollection.Item(System.Int32)">
13779 <summary>
13780 Gets or sets the element at the specified index.
13781 </summary>
13782 <param name="index">The zero-based index of the element to get or set.</param>
13783 </member>
13784 <member name="T:NAnt.Core.BuildListenerEnumerator">
13785 <summary>
13786 Enumerates the <see cref="T:NAnt.Core.IBuildListener"/> elements of a <see cref="T:NAnt.Core.BuildListenerCollection"/>.
13787 </summary>
13788 </member>
13789 <member name="M:NAnt.Core.BuildListenerEnumerator.#ctor(NAnt.Core.BuildListenerCollection)">
13790 <summary>
13791 Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerEnumerator"/> class
13792 with the specified <see cref="T:NAnt.Core.BuildListenerCollection"/>.
13793 </summary>
13794 <param name="arguments">The collection that should be enumerated.</param>
13795 </member>
13796 <member name="M:NAnt.Core.BuildListenerEnumerator.MoveNext">
13797 <summary>
13798 Advances the enumerator to the next element of the collection.
13799 </summary>
13800 <returns>
13801 <see langword="true" /> if the enumerator was successfully advanced
13802 to the next element; <see langword="false" /> if the enumerator has
13803 passed the end of the collection.
13804 </returns>
13805 </member>
13806 <member name="M:NAnt.Core.BuildListenerEnumerator.Reset">
13807 <summary>
13808 Sets the enumerator to its initial position, which is before the
13809 first element in the collection.
13810 </summary>
13811 </member>
13812 <member name="P:NAnt.Core.BuildListenerEnumerator.Current">
13813 <summary>
13814 Gets the current element in the collection.
13815 </summary>
13816 <returns>
13817 The current element in the collection.
13818 </returns>
13819 </member>
13820 <member name="T:NAnt.Core.LogWriter">
13821 <summary>
13822 Implements a <see cref="T:System.IO.TextWriter"/> for writing information to
13823 the NAnt logging infrastructure.
13824 </summary>
13825 </member>
13826 <member name="M:NAnt.Core.LogWriter.#ctor(NAnt.Core.Task,NAnt.Core.Level,System.IFormatProvider)">
13827 <summary>
13828 Initializes a new instance of the <see cref="T:NAnt.Core.LogWriter"/> class
13829 for the specified <see cref="T:NAnt.Core.Task"/> with the specified output
13830 level and format provider.
13831 </summary>
13832 <param name="task">Determines the indentation level.</param>
13833 <param name="outputLevel">The <see cref="T:NAnt.Core.Level"/> with which messages will be output to the build log.</param>
13834 <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> object that controls formatting.</param>
13835 </member>
13836 <member name="M:NAnt.Core.LogWriter.Write(System.Char[])">
13837 <summary>
13838 Writes a character array to the buffer.
13839 </summary>
13840 <param name="chars">The character array to write to the text stream.</param>
13841 </member>
13842 <member name="M:NAnt.Core.LogWriter.Write(System.String)">
13843 <summary>
13844 Writes a string to the buffer.
13845 </summary>
13846 <param name="value"></param>
13847 </member>
13848 <member name="M:NAnt.Core.LogWriter.WriteLine">
13849 <summary>
13850 Writes an empty string to the logging infrastructure.
13851 </summary>
13852 </member>
13853 <member name="M:NAnt.Core.LogWriter.WriteLine(System.String)">
13854 <summary>
13855 Writes a string to the logging infrastructure.
13856 </summary>
13857 <param name="value">The string to write. If <paramref name="value" /> is a null reference, only the line termination characters are written.</param>
13858 </member>
13859 <member name="M:NAnt.Core.LogWriter.WriteLine(System.String,System.Object[])">
13860 <summary>
13861 Writes out a formatted string using the same semantics as
13862 <see cref="M:System.String.Format(System.String,System.Object[])"/>.
13863 </summary>
13864 <param name="line">The formatting string.</param>
13865 <param name="args">The object array to write into format string.</param>
13866 </member>
13867 <member name="M:NAnt.Core.LogWriter.Flush">
13868 <summary>
13869 Causes any buffered data to be written to the logging infrastructure.
13870 </summary>
13871 </member>
13872 <member name="M:NAnt.Core.LogWriter.Close">
13873 <summary>
13874 Closes the current writer and releases any system resources
13875 associated with the writer.
13876 </summary>
13877 </member>
13878 <member name="M:NAnt.Core.LogWriter.InitializeLifetimeService">
13879 <summary>
13880 Obtains a lifetime service object to control the lifetime policy for
13881 this instance.
13882 </summary>
13883 <returns>
13884 An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
13885 policy for this instance. This is the current lifetime service object
13886 for this instance if one exists; otherwise, a new lifetime service
13887 object initialized with a lease that will never time out.
13888 </returns>
13889 </member>
13890 <member name="P:NAnt.Core.LogWriter.Encoding">
13891 <summary>
13892 Gets the <see cref="P:NAnt.Core.LogWriter.Encoding"/> in which the output is written.
13893 </summary>
13894 <value>
13895 The <see cref="T:NAnt.Core.LogWriter"/> always writes output in UTF8
13896 encoding.
13897 </value>
13898 </member>
13899 <member name="P:NAnt.Core.LogWriter.OutputLevel">
13900 <summary>
13901 Gets the <see cref="T:NAnt.Core.Level"/> with which messages will be output to
13902 the build log.
13903 </summary>
13904 </member>
13905 <member name="T:NAnt.Core.PathScanner">
13906 <summary>
13907 Used to search for files on the PATH.
13908 </summary>
13909 <remarks>
13910 <para>
13911 The local directory is not searched (since this would already be covered
13912 by normal use of the includes element).
13913 </para>
13914 <para>
13915 Also, advanced pattern matching isn't supported: you need to know the
13916 exact name of the file.
13917 </para>
13918 </remarks>
13919 </member>
13920 <member name="M:NAnt.Core.PathScanner.System#ICloneable#Clone">
13921 <summary>
13922 Creates a shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
13923 </summary>
13924 <returns>
13925 A shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
13926 </returns>
13927 </member>
13928 <member name="M:NAnt.Core.PathScanner.Clone">
13929 <summary>
13930 Creates a shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
13931 </summary>
13932 <returns>
13933 A shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
13934 </returns>
13935 </member>
13936 <member name="M:NAnt.Core.PathScanner.Add(System.String)">
13937 <summary>
13938 Adds a file to the list of files to be scanned for.
13939 </summary>
13940 <param name="fileName">The filename or search pattern to add to the list.</param>
13941 </member>
13942 <member name="M:NAnt.Core.PathScanner.Scan">
13943 <summary>
13944 Scans all direcetories in the PATH environment variable for files.
13945 </summary>
13946 <returns>
13947 List of matching files found in the PATH.
13948 </returns>
13949 </member>
13950 <member name="M:NAnt.Core.PathScanner.Scan(System.String)">
13951 <summary>
13952 Scans all directories in the given environment variable for files.
13953 </summary>
13954 <param name="name">The environment variable of which the directories should be scanned.</param>
13955 <returns>
13956 List of matching files found in the directory of the given
13957 environment variable.
13958 </returns>
13959 </member>
13960 <member name="M:NAnt.Core.PathScanner.Clone(System.Collections.Specialized.StringCollection)">
13961 <summary>
13962 Creates a shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
13963 </summary>
13964 <param name="stringCollection">The <see cref="T:System.Collections.Specialized.StringCollection"/> that should be copied.</param>
13965 <returns>
13966 A shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
13967 </returns>
13968 </member>
13969 <member name="T:NAnt.Core.Project">
13970 <summary>
13971 Central representation of a NAnt project.
13972 </summary>
13973 <example>
13974 <para>
13975 The <see cref="M:NAnt.Core.Project.Run"/> method will initialize the project with the build
13976 file specified in the constructor and execute the default target.
13977 </para>
13978 <code>
13979 <![CDATA[
13980 Project p = new Project("foo.build", Level.Info);
13981 p.Run();
13982 ]]>
13983 </code>
13984 </example>
13985 <example>
13986 <para>
13987 If no target is given, the default target will be executed if specified
13988 in the project.
13989 </para>
13990 <code>
13991 <![CDATA[
13992 Project p = new Project("foo.build", Level.Info);
13993 p.Execute("build");
13994 ]]>
13995 </code>
13996 </example>
13997 </member>
13998 <member name="F:NAnt.Core.Project.Visiting">
13999 <summary>
14000 Constant for the "visiting" state, used when traversing a DFS of
14001 target dependencies.
14002 </summary>
14003 </member>
14004 <member name="F:NAnt.Core.Project.Visited">
14005 <summary>
14006 Constant for the "visited" state, used when traversing a DFS of
14007 target dependencies.
14008 </summary>
14009 </member>
14010 <member name="F:NAnt.Core.Project.logger">
14011 <summary>
14012 Holds the logger for this class.
14013 </summary>
14014 </member>
14015 <member name="F:NAnt.Core.Project._threshold">
14016 <summary>
14017 Holds the default threshold for build loggers.
14018 </summary>
14019 </member>
14020 <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32)">
14021 <summary>
14022 Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
14023 document, message threshold and indentation level.
14024 </summary>
14025 <param name="doc">Any valid build format will do.</param>
14026 <param name="threshold">The message threshold.</param>
14027 <param name="indentLevel">The project indentation level.</param>
14028 </member>
14029 <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32,System.Xml.XmlNode)">
14030 <summary>
14031 Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
14032 document, message threshold and indentation level, and using
14033 the specified <see cref="T:System.Xml.XmlNode"/> to load internal configuration
14034 settings.
14035 </summary>
14036 <param name="doc">Any valid build format will do.</param>
14037 <param name="threshold">The message threshold.</param>
14038 <param name="indentLevel">The project indentation level.</param>
14039 <param name="configurationNode">The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize configuration settings.</param>
14040 <remarks>
14041 This constructor is useful for developers using NAnt as a class
14042 library.
14043 </remarks>
14044 </member>
14045 <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Level,System.Int32)">
14046 <summary>
14047 Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
14048 source, message threshold and indentation level.
14049 </summary>
14050 <param name="uriOrFilePath">
14051 <para>The full path to the build file.</para>
14052 <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
14053 </param>
14054 <param name="threshold">The message threshold.</param>
14055 <param name="indentLevel">The project indentation level.</param>
14056 <remarks>
14057 If the source is a uri of form 'file:///path' then use the path part.
14058 </remarks>
14059 </member>
14060 <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Level,System.Int32,System.Xml.XmlNode)">
14061 <summary>
14062 Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
14063 source, message threshold and indentation level, and using
14064 the specified <see cref="T:System.Xml.XmlNode"/> to load internal configuration
14065 settings.
14066 </summary>
14067 <param name="uriOrFilePath">
14068 <para>The full path to the build file.</para>
14069 <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
14070 </param>
14071 <param name="threshold">The message threshold.</param>
14072 <param name="indentLevel">The project indentation level.</param>
14073 <param name="configurationNode">The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize configuration settings.</param>
14074 <exception cref="T:System.ArgumentNullException"><paramref name="configurationNode"/> is <see langword="null"/>.</exception>
14075 <remarks>
14076 If the source is a uri of form 'file:///path' then use the path part.
14077 </remarks>
14078 </member>
14079 <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Project)">
14080 <summary>
14081 Initializes a <see cref="T:NAnt.Core.Project"/> as subproject of the specified
14082 <see cref="T:NAnt.Core.Project"/>.
14083 </summary>
14084 <param name="uriOrFilePath">
14085 <para>The full path to the build file.</para>
14086 <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
14087 </param>
14088 <param name="parent">The parent <see cref="T:NAnt.Core.Project"/>.</param>
14089 <remarks>
14090 Optimized for framework initialization projects, by skipping automatic
14091 discovery of extension assemblies and framework configuration.
14092 </remarks>
14093 </member>
14094 <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument)">
14095 <summary>
14096 Initializes a <see cref="T:NAnt.Core.Project"/> with <see cref="P:NAnt.Core.Project.Threshold"/>
14097 set to <see cref="F:NAnt.Core.Level.None"/>, and <see cref="P:NAnt.Core.Project.IndentationLevel"/>
14098 set to 0.
14099 </summary>
14100 <param name="doc">An <see cref="T:System.Xml.XmlDocument"/> containing the build script.</param>
14101 <remarks>
14102 Optimized for framework initialization projects, by skipping automatic
14103 discovery of extension assemblies and framework configuration.
14104 </remarks>
14105 </member>
14106 <member name="M:NAnt.Core.Project.OnBuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
14107 <summary>
14108 Dispatches a <see cref="F:NAnt.Core.Project.BuildStarted"/> event to the build listeners
14109 for this <see cref="T:NAnt.Core.Project"/>.
14110 </summary>
14111 <param name="sender">The source of the event.</param>
14112 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14113 </member>
14114 <member name="M:NAnt.Core.Project.OnBuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
14115 <summary>
14116 Dispatches a <see cref="F:NAnt.Core.Project.BuildFinished"/> event to the build listeners
14117 for this <see cref="T:NAnt.Core.Project"/>.
14118 </summary>
14119 <param name="sender">The source of the event.</param>
14120 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14121 </member>
14122 <member name="M:NAnt.Core.Project.OnTargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
14123 <summary>
14124 Dispatches a <see cref="F:NAnt.Core.Project.TargetStarted"/> event to the build listeners
14125 for this <see cref="T:NAnt.Core.Project"/>.
14126 </summary>
14127 <param name="sender">The source of the event.</param>
14128 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14129 </member>
14130 <member name="M:NAnt.Core.Project.OnTargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
14131 <summary>
14132 Dispatches a <see cref="F:NAnt.Core.Project.TargetFinished"/> event to the build listeners
14133 for this <see cref="T:NAnt.Core.Project"/>.
14134 </summary>
14135 <param name="sender">The source of the event.</param>
14136 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14137 </member>
14138 <member name="M:NAnt.Core.Project.OnTaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
14139 <summary>
14140 Dispatches a <see cref="F:NAnt.Core.Project.TaskStarted"/> event to the build listeners
14141 for this <see cref="T:NAnt.Core.Project"/>.
14142 </summary>
14143 <param name="sender">The source of the event.</param>
14144 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14145 </member>
14146 <member name="M:NAnt.Core.Project.OnTaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
14147 <summary>
14148 Dispatches the <see cref="F:NAnt.Core.Project.TaskFinished"/> event to the build listeners
14149 for this <see cref="T:NAnt.Core.Project"/>.
14150 </summary>
14151 <param name="sender">The source of the event.</param>
14152 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14153 </member>
14154 <member name="M:NAnt.Core.Project.OnMessageLogged(NAnt.Core.BuildEventArgs)">
14155 <summary>
14156 Dispatches a <see cref="F:NAnt.Core.Project.MessageLogged"/> event to the build listeners
14157 for this <see cref="T:NAnt.Core.Project"/>.
14158 </summary>
14159 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14160 </member>
14161 <member name="M:NAnt.Core.Project.Log(NAnt.Core.Level,System.String)">
14162 <summary>
14163 Writes a <see cref="T:NAnt.Core.Project"/> level message to the build log with
14164 the given <see cref="T:NAnt.Core.Level"/>.
14165 </summary>
14166 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
14167 <param name="message">The message to log.</param>
14168 </member>
14169 <member name="M:NAnt.Core.Project.Log(NAnt.Core.Level,System.String,System.Object[])">
14170 <summary>
14171 Writes a <see cref="T:NAnt.Core.Project"/> level formatted message to the build
14172 log with the given <see cref="T:NAnt.Core.Level"/>.
14173 </summary>
14174 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
14175 <param name="message">The message to log, containing zero or more format items.</param>
14176 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
14177 </member>
14178 <member name="M:NAnt.Core.Project.Log(NAnt.Core.Task,NAnt.Core.Level,System.String)">
14179 <summary>
14180 Writes a <see cref="T:NAnt.Core.Task"/> task level message to the build log
14181 with the given <see cref="T:NAnt.Core.Level"/>.
14182 </summary>
14183 <param name="task">The <see cref="T:NAnt.Core.Task"/> from which the message originated.</param>
14184 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
14185 <param name="message">The message to log.</param>
14186 </member>
14187 <member name="M:NAnt.Core.Project.Log(NAnt.Core.Target,NAnt.Core.Level,System.String)">
14188 <summary>
14189 Writes a <see cref="T:NAnt.Core.Target"/> level message to the build log with
14190 the given <see cref="T:NAnt.Core.Level"/>.
14191 </summary>
14192 <param name="target">The <see cref="T:NAnt.Core.Target"/> from which the message orignated.</param>
14193 <param name="messageLevel">The level to log at.</param>
14194 <param name="message">The message to log.</param>
14195 </member>
14196 <member name="M:NAnt.Core.Project.Execute">
14197 <summary>
14198 Executes the default target.
14199 </summary>
14200 <remarks>
14201 No top level error handling is done. Any <see cref="T:NAnt.Core.BuildException"/>
14202 will be passed onto the caller.
14203 </remarks>
14204 </member>
14205 <member name="M:NAnt.Core.Project.Execute(System.String)">
14206 <summary>
14207 Executes a specific target, and its dependencies.
14208 </summary>
14209 <param name="targetName">The name of the target to execute.</param>
14210 <remarks>
14211 Global tasks are not executed.
14212 </remarks>
14213 </member>
14214 <member name="M:NAnt.Core.Project.Execute(System.String,System.Boolean)">
14215 <summary>
14216 Executes a specific target.
14217 </summary>
14218 <param name="targetName">The name of the target to execute.</param>
14219 <param name="forceDependencies">Whether dependencies should be forced to execute</param>
14220 <remarks>
14221 Global tasks are not executed.
14222 </remarks>
14223 </member>
14224 <member name="M:NAnt.Core.Project.Run">
14225 <summary>
14226 Executes the default target and wraps in error handling and time
14227 stamping.
14228 </summary>
14229 <returns>
14230 <see langword="true" /> if the build was successful; otherwise,
14231 <see langword="false" />.
14232 </returns>
14233 </member>
14234 <member name="M:NAnt.Core.Project.CreateTask(System.Xml.XmlNode)">
14235 <summary>
14236 Creates a new <see ref="Task"/> from the given <see cref="T:System.Xml.XmlNode"/>.
14237 </summary>
14238 <param name="taskNode">The <see cref="T:NAnt.Core.Task"/> definition.</param>
14239 <returns>The new <see cref="T:NAnt.Core.Task"/> instance.</returns>
14240 </member>
14241 <member name="M:NAnt.Core.Project.CreateTask(System.Xml.XmlNode,NAnt.Core.Target)">
14242 <summary>
14243 Creates a new <see cref="T:NAnt.Core.Task"/> from the given <see cref="T:System.Xml.XmlNode"/>
14244 within a <see cref="T:NAnt.Core.Target"/>.
14245 </summary>
14246 <param name="taskNode">The <see cref="T:NAnt.Core.Task"/> definition.</param>
14247 <param name="target">The owner <see cref="T:NAnt.Core.Target"/>.</param>
14248 <returns>The new <see cref="T:NAnt.Core.Task"/> instance.</returns>
14249 </member>
14250 <member name="M:NAnt.Core.Project.ExpandProperties(System.String,NAnt.Core.Location)">
14251 <summary>
14252 Expands a <see cref="T:System.String"/> from known properties.
14253 </summary>
14254 <param name="input">The <see cref="T:System.String"/> with replacement tokens.</param>
14255 <param name="location">The location in the build file. Used to throw more accurate exceptions.</param>
14256 <returns>The expanded and replaced <see cref="T:System.String"/>.</returns>
14257 </member>
14258 <member name="M:NAnt.Core.Project.GetFullPath(System.String)">
14259 <summary>
14260 Combines the specified path with the <see cref="P:NAnt.Core.Project.BaseDirectory"/> of
14261 the <see cref="T:NAnt.Core.Project"/> to form a full path to file or directory.
14262 </summary>
14263 <param name="path">The relative or absolute path.</param>
14264 <returns>
14265 A rooted path, or the <see cref="P:NAnt.Core.Project.BaseDirectory"/> of the <see cref="T:NAnt.Core.Project"/>
14266 if the <paramref name="path"/> parameter is a null reference.
14267 </returns>
14268 </member>
14269 <member name="M:NAnt.Core.Project.CreateDefaultLogger">
14270 <summary>
14271 Creates the default <see cref="T:NAnt.Core.IBuildLogger"/> and attaches it to
14272 the <see cref="T:NAnt.Core.Project"/>.
14273 </summary>
14274 </member>
14275 <member name="M:NAnt.Core.Project.Indent">
14276 <summary>
14277 Increases the <see cref="P:NAnt.Core.Project.IndentationLevel"/> of the <see cref="T:NAnt.Core.Project"/>.
14278 </summary>
14279 </member>
14280 <member name="M:NAnt.Core.Project.Unindent">
14281 <summary>
14282 Decreases the <see cref="P:NAnt.Core.Project.IndentationLevel"/> of the <see cref="T:NAnt.Core.Project"/>.
14283 </summary>
14284 </member>
14285 <member name="M:NAnt.Core.Project.DetachBuildListeners">
14286 <summary>
14287 Detaches the currently attached <see cref="T:NAnt.Core.IBuildListener"/> instances
14288 from the <see cref="T:NAnt.Core.Project"/>.
14289 </summary>
14290 </member>
14291 <member name="M:NAnt.Core.Project.AttachBuildListeners(NAnt.Core.BuildListenerCollection)">
14292 <summary>
14293 Attaches the specified build listeners to the <see cref="T:NAnt.Core.Project"/>.
14294 </summary>
14295 <param name="listeners">The <see cref="T:NAnt.Core.IBuildListener"/> instances to attach to the <see cref="T:NAnt.Core.Project"/>.</param>
14296 <remarks>
14297 The currently attached <see cref="T:NAnt.Core.IBuildListener"/> instances will
14298 be detached before the new <see cref="T:NAnt.Core.IBuildListener"/> instances
14299 are attached.
14300 </remarks>
14301 </member>
14302 <member name="M:NAnt.Core.Project.CtorHelper(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32,NAnt.Core.Optimizations)">
14303 <summary>
14304 Inits stuff:
14305 <para>TypeFactory: Calls Initialize and AddProject </para>
14306 <para>Log.IndentSize set to 12</para>
14307 <para>Project properties are initialized ("nant.* stuff set")</para>
14308 <list type="nant.items">
14309 <listheader>NAnt Props:</listheader>
14310 <item>nant.filename</item>
14311 <item>nant.version</item>
14312 <item>nant.location</item>
14313 <item>nant.project.name</item>
14314 <item>nant.project.buildfile (if doc has baseuri)</item>
14315 <item>nant.project.basedir</item>
14316 <item>nant.project.default = defaultTarget</item>
14317 </list>
14318 </summary>
14319 <param name="doc">An <see cref="T:System.Xml.XmlDocument"/> representing the project definition.</param>
14320 <param name="threshold">The project message threshold.</param>
14321 <param name="indentLevel">The project indentation level.</param>
14322 <param name="optimization">Optimization flags.</param>
14323 <exception cref="T:System.ArgumentNullException"><paramref name="doc"/> is <see langword="null"/>.</exception>
14324 </member>
14325 <member name="M:NAnt.Core.Project.InitializeProjectDocument(System.Xml.XmlDocument)">
14326 <summary>
14327 This method is only meant to be used by the <see cref="T:NAnt.Core.Project"/>
14328 class and <see cref="T:NAnt.Core.Tasks.IncludeTask"/>.
14329 </summary>
14330 </member>
14331 <member name="M:NAnt.Core.Project.LoadBuildFile(System.String)">
14332 <summary>
14333 Creates a new <see cref="T:System.Xml.XmlDocument"/> based on the project
14334 definition.
14335 </summary>
14336 <param name="uriOrFilePath">
14337 <para>The full path to the build file.</para>
14338 <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
14339 </param>
14340 <returns>
14341 An <see cref="T:System.Xml.XmlDocument"/> based on the specified project
14342 definition.
14343 </returns>
14344 </member>
14345 <member name="M:NAnt.Core.Project.ConfigurePlatformProperties">
14346 <summary>
14347 Configures the platform properties for the current platform.
14348 </summary>
14349 <exception cref="T:NAnt.Core.BuildException">NAnt does not support the current platform.</exception>
14350 </member>
14351 <member name="M:NAnt.Core.Project.UpdateTargetFrameworkProperties">
14352 <summary>
14353 Updates dependent properties when the <see cref="P:NAnt.Core.Project.TargetFramework"/>
14354 is set.
14355 </summary>
14356 </member>
14357 <member name="M:NAnt.Core.Project.TopologicalTargetSort(System.String,NAnt.Core.TargetCollection)">
14358 <summary>
14359 Topologically sorts a set of targets.
14360 </summary>
14361 <param name="root">The name of the root target. The sort is created in such a way that the sequence of targets up to the root target is the minimum possible such sequence. Must not be <see langword="null"/>.</param>
14362 <param name="targets">A collection of <see cref="T:NAnt.Core.Target"/> instances.</param>
14363 <returns>
14364 A collection of <see cref="T:NAnt.Core.Target"/> instances in sorted order.
14365 </returns>
14366 <exception cref="T:NAnt.Core.BuildException">There is a cyclic dependecy among the targets, or a named target does not exist.</exception>
14367 </member>
14368 <member name="M:NAnt.Core.Project.TopologicalTargetSort(System.String,NAnt.Core.TargetCollection,System.Collections.Hashtable,System.Collections.Stack,NAnt.Core.TargetCollection)">
14369 <summary>
14370 <para>
14371 Performs a single step in a recursive depth-first-search traversal
14372 of the target dependency tree.
14373 </para>
14374 <para>
14375 The current target is first set to the "visiting" state, and pushed
14376 onto the "visiting" stack.
14377 </para>
14378 <para>
14379 An exception is then thrown if any child of the current node is in
14380 the visiting state, as that implies a circular dependency. The
14381 exception contains details of the cycle, using elements of the
14382 "visiting" stack.
14383 </para>
14384 <para>
14385 If any child has not already been "visited", this method is called
14386 recursively on it.
14387 </para>
14388 <para>
14389 The current target is then added to the ordered list of targets.
14390 Note that this is performed after the children have been visited in
14391 order to get the correct order. The current target is set to the
14392 "visited" state.
14393 </para>
14394 <para>
14395 By the time this method returns, the ordered list contains the
14396 sequence of targets up to and including the current target.
14397 </para>
14398 </summary>
14399 <param name="root">The current target to inspect. Must not be <see langword="null"/>.</param>
14400 <param name="targets">A collection of <see cref="T:NAnt.Core.Target"/> instances.</param>
14401 <param name="state">A mapping from targets to states The states in question are "VISITING" and "VISITED". Must not be <see langword="null"/>.</param>
14402 <param name="visiting">A stack of targets which are currently being visited. Must not be <see langword="null"/>.</param>
14403 <param name="executeTargets">The list to add target names to. This will end up containing the complete list of depenencies in dependency order. Must not be <see langword="null"/>.</param>
14404 <exception cref="T:NAnt.Core.BuildException">
14405 <para>A non-existent target is specified</para>
14406 <para>-or-</para>
14407 <para>A circular dependency is detected.</para>
14408 </exception>
14409 </member>
14410 <member name="M:NAnt.Core.Project.CreateCircularException(System.String,System.Collections.Stack)">
14411 <summary>
14412 Builds an appropriate exception detailing a specified circular
14413 dependency.
14414 </summary>
14415 <param name="end">The dependency to stop at. Must not be <see langword="null"/>.</param>
14416 <param name="stack">A stack of dependencies. Must not be <see langword="null"/>.</param>
14417 <returns>
14418 A <see cref="T:NAnt.Core.BuildException"/> detailing the specified circular
14419 dependency.
14420 </returns>
14421 </member>
14422 <member name="P:NAnt.Core.Project.IndentationLevel">
14423 <summary>
14424 Gets or sets the indendation level of the build output.
14425 </summary>
14426 <value>
14427 The indentation level of the build output.
14428 </value>
14429 <remarks>
14430 To change the <see cref="P:NAnt.Core.Project.IndentationLevel"/>, the <see cref="M:NAnt.Core.Project.Indent"/>
14431 and <see cref="M:NAnt.Core.Project.Unindent"/> methods should be used.
14432 </remarks>
14433 </member>
14434 <member name="P:NAnt.Core.Project.IndentationSize">
14435 <summary>
14436 Gets or sets the indentation size of the build output.
14437 </summary>
14438 <value>
14439 The indendation size of the build output.
14440 </value>
14441 </member>
14442 <member name="P:NAnt.Core.Project.Threshold">
14443 <summary>
14444 Gets or sets the default threshold level for build loggers.
14445 </summary>
14446 <value>
14447 The default threshold level for build loggers.
14448 </value>
14449 </member>
14450 <member name="P:NAnt.Core.Project.ProjectName">
14451 <summary>
14452 Gets the name of the <see cref="T:NAnt.Core.Project"/>.
14453 </summary>
14454 <value>
14455 The name of the <see cref="T:NAnt.Core.Project"/> or an empty <see cref="T:System.String"/>
14456 if no name is specified.
14457 </value>
14458 </member>
14459 <member name="P:NAnt.Core.Project.BaseDirectory">
14460 <summary>
14461 Gets or sets the base directory used for relative references.
14462 </summary>
14463 <value>
14464 The base directory used for relative references.
14465 </value>
14466 <exception cref="T:NAnt.Core.BuildException">The directory is not rooted.</exception>
14467 <remarks>
14468 <para>
14469 The <see cref="P:NAnt.Core.Project.BaseDirectory"/> gets and sets the built-in property
14470 named "nant.project.basedir".
14471 </para>
14472 </remarks>
14473 </member>
14474 <member name="P:NAnt.Core.Project.NamespaceManager">
14475 <summary>
14476 Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
14477 </summary>
14478 <value>
14479 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
14480 </value>
14481 <remarks>
14482 The <see cref="P:NAnt.Core.Project.NamespaceManager"/> defines the current namespace
14483 scope and provides methods for looking up namespace information.
14484 </remarks>
14485 </member>
14486 <member name="P:NAnt.Core.Project.BuildFileUri">
14487 <summary>
14488 Gets the <see cref="T:System.Uri"/> form of the current project definition.
14489 </summary>
14490 <value>
14491 The <see cref="T:System.Uri"/> form of the current project definition.
14492 </value>
14493 </member>
14494 <member name="P:NAnt.Core.Project.Frameworks">
14495 <summary>
14496 Gets a collection of available .NET frameworks.
14497 </summary>
14498 <value>
14499 A collection of available .NET frameworks.
14500 </value>
14501 </member>
14502 <member name="P:NAnt.Core.Project.RuntimeFramework">
14503 <summary>
14504 Gets the framework in which NAnt is currently running.
14505 </summary>
14506 <value>
14507 The framework in which NAnt is currently running.
14508 </value>
14509 </member>
14510 <member name="P:NAnt.Core.Project.TargetFramework">
14511 <summary>
14512 Gets or sets the framework to use for compilation.
14513 </summary>
14514 <value>
14515 The framework to use for compilation.
14516 </value>
14517 <remarks>
14518 We will use compiler tools and system assemblies for this framework
14519 in framework-related tasks.
14520 </remarks>
14521 </member>
14522 <member name="P:NAnt.Core.Project.PlatformName">
14523 <summary>
14524 Gets the name of the platform on which NAnt is currently running.
14525 </summary>
14526 <value>
14527 The name of the platform on which NAnt is currently running.
14528 </value>
14529 <remarks>
14530 <para>
14531 Possible values are:
14532 </para>
14533 <list type="bullet">
14534 <item>
14535 <description>win32</description>
14536 </item>
14537 <item>
14538 <description>unix</description>
14539 </item>
14540 </list>
14541 </remarks>
14542 <exception cref="T:NAnt.Core.BuildException">NAnt does not support the current platform.</exception>
14543 </member>
14544 <member name="P:NAnt.Core.Project.CurrentTarget">
14545 <summary>
14546 Gets the current target.
14547 </summary>
14548 <value>
14549 The current target, or <see langword="null" /> if no target is
14550 executing.
14551 </value>
14552 </member>
14553 <member name="P:NAnt.Core.Project.BuildFileLocalName">
14554 <summary>
14555 Gets the path to the build file.
14556 </summary>
14557 <value>
14558 The path to the build file, or <see langword="null" /> if the build
14559 document is not file backed.
14560 </value>
14561 </member>
14562 <member name="P:NAnt.Core.Project.Document">
14563 <summary>
14564 Gets the active <see cref="T:NAnt.Core.Project"/> definition.
14565 </summary>
14566 <value>
14567 The active <see cref="T:NAnt.Core.Project"/> definition.
14568 </value>
14569 </member>
14570 <member name="P:NAnt.Core.Project.ConfigurationNode">
14571 <summary>
14572 Gets the <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize
14573 configuration settings.
14574 </summary>
14575 <value>
14576 The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize
14577 configuration settings.
14578 </value>
14579 </member>
14580 <member name="P:NAnt.Core.Project.DefaultTargetName">
14581 <remarks>
14582 Gets the name of the target that will be executed when no other
14583 build targets are specified.
14584 </remarks>
14585 <value>
14586 The name of the target that will be executed when no other
14587 build targets are specified, or <see langword="null" /> if no
14588 default target is specified in the build file.
14589 </value>
14590 </member>
14591 <member name="P:NAnt.Core.Project.Verbose">
14592 <summary>
14593 Gets a value indicating whether tasks should output more build log
14594 messages.
14595 </summary>
14596 <value>
14597 <see langword="true" /> if tasks should output more build log message;
14598 otherwise, <see langword="false" />.
14599 </value>
14600 </member>
14601 <member name="P:NAnt.Core.Project.BuildTargets">
14602 <summary>
14603 The list of targets to build.
14604 </summary>
14605 <remarks>
14606 Targets are built in the order they appear in the collection. If
14607 the collection is empty the default target will be built.
14608 </remarks>
14609 </member>
14610 <member name="P:NAnt.Core.Project.Properties">
14611 <summary>
14612 Gets the properties defined in this project.
14613 </summary>
14614 <value>The properties defined in this project.</value>
14615 <remarks>
14616 <para>
14617 This is the collection of properties that are defined by the system
14618 and property task statements.
14619 </para>
14620 <para>
14621 These properties can be used in expansion.
14622 </para>
14623 </remarks>
14624 </member>
14625 <member name="P:NAnt.Core.Project.FrameworkNeutralProperties">
14626 <summary>
14627 Gets the framework-neutral properties defined in the NAnt
14628 configuration file.
14629 </summary>
14630 <value>
14631 The framework-neutral properties defined in the NAnt configuration
14632 file.
14633 </value>
14634 <remarks>
14635 <para>
14636 This is the collection of read-only properties that are defined in
14637 the NAnt configuration file.
14638 </para>
14639 <para>
14640 These properties can only be used for expansion in framework-specific
14641 and framework-neutral configuration settings. These properties are
14642 not available for expansion in the build file.
14643 </para>
14644 </remarks>
14645 </member>
14646 <member name="P:NAnt.Core.Project.DataTypeReferences">
14647 <summary>
14648 Gets the <see cref="T:NAnt.Core.DataTypeBase"/> instances defined in this project.
14649 </summary>
14650 <value>
14651 The <see cref="T:NAnt.Core.DataTypeBase"/> instances defined in this project.
14652 </value>
14653 <remarks>
14654 <para>
14655 This is the collection of <see cref="T:NAnt.Core.DataTypeBase"/> instances that
14656 are defined by <see cref="T:NAnt.Core.DataTypeBase"/> (eg fileset) declarations.
14657 </para>
14658 </remarks>
14659 </member>
14660 <member name="P:NAnt.Core.Project.Targets">
14661 <summary>
14662 Gets the targets defined in this project.
14663 </summary>
14664 <value>
14665 The targets defined in this project.
14666 </value>
14667 </member>
14668 <member name="P:NAnt.Core.Project.BuildListeners">
14669 <summary>
14670 Gets the build listeners for this project.
14671 </summary>
14672 <value>
14673 The build listeners for this project.
14674 </value>
14675 </member>
14676 <member name="T:NAnt.Core.Optimizations">
14677 <summary>
14678 Allow the project construction to be optimized.
14679 </summary>
14680 <remarks>
14681 Use this with care!
14682 </remarks>
14683 </member>
14684 <member name="F:NAnt.Core.Optimizations.None">
14685 <summary>
14686 Do not perform any optimizations.
14687 </summary>
14688 </member>
14689 <member name="F:NAnt.Core.Optimizations.SkipAutomaticDiscovery">
14690 <summary>
14691 The project base directory must not be automatically scanned
14692 for extension assemblies.
14693 </summary>
14694 </member>
14695 <member name="F:NAnt.Core.Optimizations.SkipFrameworkConfiguration">
14696 <summary>
14697 Do not scan the project configuration for frameworks, and
14698 do not configure the runtime and target framework.
14699 </summary>
14700 </member>
14701 <member name="F:NAnt.Core.ProjectSettingsLoader.ScannedTasks">
14702 <summary>
14703 Holds a value indicating whether a scan for tasks, types and functions
14704 has already been performed for the current runtime framework.
14705 </summary>
14706 </member>
14707 <member name="M:NAnt.Core.ProjectSettingsLoader.#ctor(NAnt.Core.Project)">
14708 <summary>
14709 Initializes a new instance of the <see cref="T:NAnt.Core.ProjectSettingsLoader"/>
14710 class for the given <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/>.
14711 </summary>
14712 <param name="project">The <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> that should be configured.</param>
14713 </member>
14714 <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessSettings">
14715 <summary>
14716 Loads and processes settings from the specified <see cref="T:System.Xml.XmlNode"/>
14717 of the configuration file.
14718 </summary>
14719 </member>
14720 <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessFrameworks(System.Xml.XmlNode)">
14721 <summary>
14722 Processes the framework nodes of the given platform node.
14723 </summary>
14724 <param name="platformNode">An <see cref="T:System.Xml.XmlNode"/> representing the platform on which NAnt is running.</param>
14725 </member>
14726 <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessGlobalProperties(System.Xml.XmlNodeList)">
14727 <summary>
14728 Reads the list of global properties specified in the NAnt configuration
14729 file.
14730 </summary>
14731 <param name="propertyNodes">An <see cref="T:System.Xml.XmlNodeList"/> representing global properties.</param>
14732 </member>
14733 <member name="M:NAnt.Core.ProjectSettingsLoader.GetXmlAttributeValue(System.Xml.XmlNode,System.String)">
14734 <summary>
14735 Gets the value of the specified attribute from the specified node.
14736 </summary>
14737 <param name="xmlNode">The node of which the attribute value should be retrieved.</param>
14738 <param name="attributeName">The attribute of which the value should be returned.</param>
14739 <returns>
14740 The value of the attribute with the specified name or <see langword="null" />
14741 if the attribute does not exist or has no value.
14742 </returns>
14743 </member>
14744 <member name="P:NAnt.Core.ProjectSettingsLoader.Project">
14745 <summary>
14746 Gets the underlying <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> instance.
14747 </summary>
14748 <value>
14749 The underlying <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> instance.
14750 </value>
14751 </member>
14752 <member name="P:NAnt.Core.ProjectSettingsLoader.NamespaceManager">
14753 <summary>
14754 Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
14755 </summary>
14756 <value>
14757 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
14758 </value>
14759 <remarks>
14760 The <see cref="P:NAnt.Core.ProjectSettingsLoader.NamespaceManager"/> defines the current namespace
14761 scope and provides methods for looking up namespace information.
14762 </remarks>
14763 </member>
14764 <member name="F:NAnt.Core.PropertyDictionary.Visiting">
14765 <summary>
14766 Constant for the "visiting" state, used when traversing a DFS of
14767 property references.
14768 </summary>
14769 </member>
14770 <member name="F:NAnt.Core.PropertyDictionary.Visited">
14771 <summary>
14772 Constant for the "visited" state, used when travesing a DFS of
14773 property references.
14774 </summary>
14775 </member>
14776 <member name="M:NAnt.Core.PropertyDictionary.#ctor(NAnt.Core.Project)">
14777 <summary>
14778 Initializes a new instance of the <see cref="T:NAnt.Core.PropertyDictionary"/>
14779 class holding properties for the given <see cref="P:NAnt.Core.PropertyDictionary.Project"/>
14780 instance.
14781 </summary>
14782 <param name="project">The project for which the dictionary will hold properties.</param>
14783 </member>
14784 <member name="M:NAnt.Core.PropertyDictionary.OnInsert(System.Object,System.Object)">
14785 <summary>
14786 Performs additional custom processes before inserting a new element
14787 into the <see cref="T:System.Collections.DictionaryBase"/> instance.
14788 </summary>
14789 <param name="key">The key of the element to insert.</param>
14790 <param name="value">The value of the element to insert.</param>
14791 </member>
14792 <member name="M:NAnt.Core.PropertyDictionary.OnRemove(System.Object,System.Object)">
14793 <summary>
14794 Performs additional custom processes before removing an element
14795 from the <see cref="T:System.Collections.DictionaryBase"/> instance.
14796 </summary>
14797 <param name="key">The key of the element to remove.</param>
14798 <param name="value">The value of the element to remove.</param>
14799 </member>
14800 <member name="M:NAnt.Core.PropertyDictionary.OnValidate(System.Object,System.Object)">
14801 <summary>
14802 Performs additional custom processes when validating the element
14803 with the specified key and value.
14804 </summary>
14805 <param name="key">The key of the element to validate.</param>
14806 <param name="value">The value of the element to validate.</param>
14807 </member>
14808 <member name="M:NAnt.Core.PropertyDictionary.AddReadOnly(System.String,System.String)">
14809 <summary>
14810 Adds a property that cannot be changed.
14811 </summary>
14812 <param name="name">The name of the property.</param>
14813 <param name="value">The value to assign to the property.</param>
14814 <remarks>
14815 Properties added with this method can never be changed. Note that
14816 they are removed if the <see cref="M:System.Collections.DictionaryBase.Clear"/> method is called.
14817 </remarks>
14818 </member>
14819 <member name="M:NAnt.Core.PropertyDictionary.MarkDynamic(System.String)">
14820 <summary>
14821 Marks a property as a property of which the value is expanded at
14822 execution time.
14823 </summary>
14824 <param name="name">The name of the property to mark as dynamic.</param>
14825 </member>
14826 <member name="M:NAnt.Core.PropertyDictionary.Add(System.String,System.String)">
14827 <summary>
14828 Adds a property to the collection.
14829 </summary>
14830 <param name="name">The name of the property.</param>
14831 <param name="value">The value to assign to the property.</param>
14832 </member>
14833 <member name="M:NAnt.Core.PropertyDictionary.IsReadOnlyProperty(System.String)">
14834 <summary>
14835 Determines whether the specified property is listed as read-only.
14836 </summary>
14837 <param name="name">The name of the property to check.</param>
14838 <returns>
14839 <see langword="true" /> if the property is listed as read-only;
14840 otherwise, <see langword="false" />.
14841 </returns>
14842 </member>
14843 <member name="M:NAnt.Core.PropertyDictionary.IsDynamicProperty(System.String)">
14844 <summary>
14845 Determines whether the specified property is listed as dynamic.
14846 </summary>
14847 <param name="name">The name of the property to check.</param>
14848 <returns>
14849 <see langword="true" /> if the property is listed as dynamic;
14850 otherwise, <see langword="false" />.
14851 </returns>
14852 </member>
14853 <member name="M:NAnt.Core.PropertyDictionary.Inherit(NAnt.Core.PropertyDictionary,System.Collections.Specialized.StringCollection)">
14854 <summary>
14855 Inherits properties from an existing property dictionary Instance.
14856 </summary>
14857 <param name="source">Property list to inherit.</param>
14858 <param name="excludes">The list of properties to exclude during inheritance.</param>
14859 </member>
14860 <member name="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location)">
14861 <summary>
14862 Expands a <see cref="T:System.String"/> from known properties.
14863 </summary>
14864 <param name="input">The replacement tokens.</param>
14865 <param name="location">The <see cref="T:NAnt.Core.Location"/> to pass through for any exceptions.</param>
14866 <returns>The expanded and replaced string.</returns>
14867 </member>
14868 <member name="M:NAnt.Core.PropertyDictionary.Contains(System.String)">
14869 <summary>
14870 Determines whether a property already exists.
14871 </summary>
14872 <param name="name">The name of the property to check.</param>
14873 <returns>
14874 <see langword="true" /> if the specified property already exists;
14875 otherwise, <see langword="false" />.
14876 </returns>
14877 </member>
14878 <member name="M:NAnt.Core.PropertyDictionary.Remove(System.String)">
14879 <summary>
14880 Removes the property with the specified name.
14881 </summary>
14882 <param name="name">The name of the property to remove.</param>
14883 </member>
14884 <member name="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location,System.Collections.Hashtable,System.Collections.Stack)">
14885 <summary>
14886 Expands a <see cref="T:System.String"/> from known properties.
14887 </summary>
14888 <param name="input">The replacement tokens.</param>
14889 <param name="location">The <see cref="T:NAnt.Core.Location"/> to pass through for any exceptions.</param>
14890 <param name="state">A mapping from properties to states. The states in question are "VISITING" and "VISITED". Must not be <see langword="null"/>.</param>
14891 <param name="visiting">A stack of properties which are currently being visited. Must not be <see langword="null"/>.</param>
14892 <returns>The expanded and replaced string.</returns>
14893 </member>
14894 <member name="M:NAnt.Core.PropertyDictionary.EvaluateEmbeddedExpressions(System.String,NAnt.Core.Location,System.Collections.Hashtable,System.Collections.Stack)">
14895 <summary>
14896 Evaluates the given expression string and returns the result
14897 </summary>
14898 <param name="input"></param>
14899 <param name="location"></param>
14900 <param name="state"></param>
14901 <param name="visiting"></param>
14902 <returns></returns>
14903 </member>
14904 <member name="M:NAnt.Core.PropertyDictionary.CheckDeprecation(System.String)">
14905 <summary>
14906 Checks whether the specified property is deprecated.
14907 </summary>
14908 <param name="name">The property to check.</param>
14909 </member>
14910 <member name="M:NAnt.Core.PropertyDictionary.CreateCircularException(System.String,System.Collections.Stack)">
14911 <summary>
14912 Builds an appropriate exception detailing a specified circular
14913 reference.
14914 </summary>
14915 <param name="end">The property reference to stop at. Must not be <see langword="null"/>.</param>
14916 <param name="stack">A stack of property references. Must not be <see langword="null"/>.</param>
14917 <returns>
14918 A <see cref="T:NAnt.Core.BuildException"/> detailing the specified circular
14919 dependency.
14920 </returns>
14921 </member>
14922 <member name="F:NAnt.Core.PropertyDictionary._readOnlyProperties">
14923 <summary>
14924 Maintains a list of the property names that are readonly.
14925 </summary>
14926 </member>
14927 <member name="F:NAnt.Core.PropertyDictionary._dynamicProperties">
14928 <summary>
14929 Maintains a list of the property names of which the value is expanded
14930 on usage, not at initalization.
14931 </summary>
14932 </member>
14933 <member name="F:NAnt.Core.PropertyDictionary._project">
14934 <summary>
14935 The project for which the dictionary holds properties.
14936 </summary>
14937 </member>
14938 <member name="P:NAnt.Core.PropertyDictionary.Item(System.String)">
14939 <summary>
14940 Indexer property.
14941 </summary>
14942 </member>
14943 <member name="P:NAnt.Core.PropertyDictionary.Project">
14944 <summary>
14945 Gets the project for which the dictionary holds properties.
14946 </summary>
14947 <value>
14948 The project for which the dictionary holds properties.
14949 </value>
14950 </member>
14951 <member name="M:NAnt.Core.Target.#ctor">
14952 <summary>
14953 Initializes a new instance of the <see cref="T:NAnt.Core.Target"/> class.
14954 </summary>
14955 </member>
14956 <member name="M:NAnt.Core.Target.System#ICloneable#Clone">
14957 <summary>
14958 Creates a shallow copy of the <see cref="T:NAnt.Core.Target"/>.
14959 </summary>
14960 <returns>
14961 A shallow copy of the <see cref="T:NAnt.Core.Target"/>.
14962 </returns>
14963 </member>
14964 <member name="M:NAnt.Core.Target.Clone">
14965 <summary>
14966 Creates a shallow copy of the <see cref="T:NAnt.Core.Target"/>.
14967 </summary>
14968 <returns>
14969 A shallow copy of the <see cref="T:NAnt.Core.Target"/>.
14970 </returns>
14971 </member>
14972 <member name="M:NAnt.Core.Target.Execute">
14973 <summary>
14974 Executes dependent targets first, then the target.
14975 </summary>
14976 </member>
14977 <member name="P:NAnt.Core.Target.Executed">
14978 <summary>
14979 This indicates whether the target has already executed.
14980 </summary>
14981 </member>
14982 <member name="P:NAnt.Core.Target.Name">
14983 <summary>
14984 The name of the target.
14985 </summary>
14986 <remarks>
14987 <para>
14988 Hides <see cref="P:NAnt.Core.Element.Name"/> to have <see cref="T:NAnt.Core.Target"/>
14989 return the name of target, not the name of XML element - which
14990 would always be <c>target</c>.
14991 </para>
14992 <para>
14993 Note: Properties are not allowed in the name.
14994 </para>
14995 </remarks>
14996 </member>
14997 <member name="P:NAnt.Core.Target.IfCondition">
14998 <summary>
14999 If <see langword="true" /> then the target will be executed;
15000 otherwise, skipped. The default is <see langword="true" />.
15001 </summary>
15002 </member>
15003 <member name="P:NAnt.Core.Target.IfDefined">
15004 <summary>
15005 Gets a value indicating whether the target should be executed.
15006 </summary>
15007 <value>
15008 <see langword="true" /> if the target should be executed; otherwise,
15009 <see langword="false" />.
15010 </value>
15011 </member>
15012 <member name="P:NAnt.Core.Target.UnlessCondition">
15013 <summary>
15014 Opposite of <see cref="P:NAnt.Core.Target.IfDefined"/>. If <see langword="false"/>
15015 then the target will be executed; otherwise, skipped. The default
15016 is <see langword="false"/>.
15017 </summary>
15018 </member>
15019 <member name="P:NAnt.Core.Target.UnlessDefined">
15020 <summary>
15021 Gets a value indicating whether the target should NOT be executed.
15022 </summary>
15023 <value>
15024 <see langword="true" /> if the target should NOT be executed;
15025 otherwise, <see langword="false" />.
15026 </value>
15027 </member>
15028 <member name="P:NAnt.Core.Target.Description">
15029 <summary>
15030 The description of the target.
15031 </summary>
15032 </member>
15033 <member name="P:NAnt.Core.Target.DependsListString">
15034 <summary>
15035 Space separated list of targets that this target depends on.
15036 </summary>
15037 </member>
15038 <member name="P:NAnt.Core.Target.Dependencies">
15039 <summary>
15040 A collection of target names that must be executed before this
15041 target.
15042 </summary>
15043 </member>
15044 <member name="M:NAnt.Core.TargetCollection.Find(System.String)">
15045 <summary>
15046 Finds a target by name.
15047 </summary>
15048 <param name="targetName">The name of the target to find.</param>
15049 <returns>
15050 The <see cref="T:NAnt.Core.Target"/> with the specified name, or
15051 <see langword="null"/> if no <see cref="T:NAnt.Core.Target"/> exists with
15052 the given name.
15053 </returns>
15054 </member>
15055 <member name="M:NAnt.Core.TargetCollection.ToString(System.String)">
15056 <summary>
15057 Gets the names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>
15058 combined into one list separated by the given <see cref="T:System.String"/>.
15059 </summary>
15060 <returns>
15061 A <see cref="T:System.String"/> that contains a list of the names of the
15062 targets in the <see cref="T:NAnt.Core.TargetCollection"/>, separated by
15063 the specified <paramref name="separator"/>.
15064 </returns>
15065 </member>
15066 <member name="M:NAnt.Core.TargetCollection.ToString">
15067 <summary>
15068 Gets the names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>
15069 combined into one comma-separated list.
15070 </summary>
15071 <returns>
15072 A <see cref="T:System.String"/> that contains a comma-separated list of the
15073 names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>.
15074 </returns>
15075 </member>
15076 <member name="M:NAnt.Core.TaskBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
15077 <summary>
15078 Creates a new instance of the <see cref="T:NAnt.Core.TaskBuilder"/> class
15079 for the specified <see cref="T:NAnt.Core.Task"/> class in the specified
15080 <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.
15081 </summary>
15082 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.Task"/>.</param>
15083 <param name="className">The class representing the <see cref="T:NAnt.Core.Task"/>.</param>
15084 </member>
15085 <member name="P:NAnt.Core.TaskBuilder.ClassName">
15086 <summary>
15087 Gets the name of the <see cref="T:NAnt.Core.Task"/> class that can be created
15088 using this <see cref="T:NAnt.Core.TaskBuilder"/>.
15089 </summary>
15090 <value>
15091 The name of the <see cref="T:NAnt.Core.Task"/> class that can be created using
15092 this <see cref="T:NAnt.Core.TaskBuilder"/>.
15093 </value>
15094 </member>
15095 <member name="P:NAnt.Core.TaskBuilder.TaskName">
15096 <summary>
15097 Gets the name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/>
15098 can create.
15099 </summary>
15100 <value>
15101 The name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/> can
15102 create.
15103 </value>
15104 </member>
15105 <member name="T:NAnt.Core.TaskBuilderCollection">
15106 <summary>
15107 Contains a strongly typed collection of <see cref="T:NAnt.Core.TaskBuilder"/> objects.
15108 </summary>
15109 </member>
15110 <member name="M:NAnt.Core.TaskBuilderCollection.#ctor">
15111 <summary>
15112 Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class.
15113 </summary>
15114 </member>
15115 <member name="M:NAnt.Core.TaskBuilderCollection.#ctor(NAnt.Core.TaskBuilderCollection)">
15116 <summary>
15117 Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class
15118 with the specified <see cref="T:NAnt.Core.TaskBuilderCollection"/> instance.
15119 </summary>
15120 </member>
15121 <member name="M:NAnt.Core.TaskBuilderCollection.#ctor(NAnt.Core.TaskBuilder[])">
15122 <summary>
15123 Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class
15124 with the specified array of <see cref="T:NAnt.Core.TaskBuilder"/> instances.
15125 </summary>
15126 </member>
15127 <member name="M:NAnt.Core.TaskBuilderCollection.Add(NAnt.Core.TaskBuilder)">
15128 <summary>
15129 Adds a <see cref="T:NAnt.Core.TaskBuilder"/> to the end of the collection.
15130 </summary>
15131 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to be added to the end of the collection.</param>
15132 <returns>The position into which the new element was inserted.</returns>
15133 </member>
15134 <member name="M:NAnt.Core.TaskBuilderCollection.AddRange(NAnt.Core.TaskBuilder[])">
15135 <summary>
15136 Adds the elements of a <see cref="T:NAnt.Core.TaskBuilder"/> array to the end of the collection.
15137 </summary>
15138 <param name="items">The array of <see cref="T:NAnt.Core.TaskBuilder"/> elements to be added to the end of the collection.</param>
15139 </member>
15140 <member name="M:NAnt.Core.TaskBuilderCollection.AddRange(NAnt.Core.TaskBuilderCollection)">
15141 <summary>
15142 Adds the elements of a <see cref="T:NAnt.Core.TaskBuilderCollection"/> to the end of the collection.
15143 </summary>
15144 <param name="items">The <see cref="T:NAnt.Core.TaskBuilderCollection"/> to be added to the end of the collection.</param>
15145 </member>
15146 <member name="M:NAnt.Core.TaskBuilderCollection.Contains(NAnt.Core.TaskBuilder)">
15147 <summary>
15148 Determines whether a <see cref="T:NAnt.Core.TaskBuilder"/> is in the collection.
15149 </summary>
15150 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to locate in the collection.</param>
15151 <returns>
15152 <see langword="true"/> if <paramref name="item"/> is found in the
15153 collection; otherwise, <see langword="false"/>.
15154 </returns>
15155 </member>
15156 <member name="M:NAnt.Core.TaskBuilderCollection.Contains(System.String)">
15157 <summary>
15158 Determines whether a <see cref="T:NAnt.Core.TaskBuilder"/> for the specified
15159 task is in the collection.
15160 </summary>
15161 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.TaskBuilder"/> should be located in the collection.</param>
15162 <returns>
15163 <see langword="true"/> if a <see cref="T:NAnt.Core.TaskBuilder"/> for the
15164 specified task is found in the collection; otherwise, <see langword="false"/>.
15165 </returns>
15166 </member>
15167 <member name="M:NAnt.Core.TaskBuilderCollection.CopyTo(NAnt.Core.TaskBuilder[],System.Int32)">
15168 <summary>
15169 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
15170 </summary>
15171 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
15172 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
15173 </member>
15174 <member name="M:NAnt.Core.TaskBuilderCollection.IndexOf(NAnt.Core.TaskBuilder)">
15175 <summary>
15176 Retrieves the index of a specified <see cref="T:NAnt.Core.TaskBuilder"/> object in the collection.
15177 </summary>
15178 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> object for which the index is returned.</param>
15179 <returns>
15180 The index of the specified <see cref="T:NAnt.Core.TaskBuilder"/>. If the <see cref="T:NAnt.Core.TaskBuilder"/> is not currently a member of the collection, it returns -1.
15181 </returns>
15182 </member>
15183 <member name="M:NAnt.Core.TaskBuilderCollection.Insert(System.Int32,NAnt.Core.TaskBuilder)">
15184 <summary>
15185 Inserts a <see cref="T:NAnt.Core.TaskBuilder"/> into the collection at the specified index.
15186 </summary>
15187 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
15188 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to insert.</param>
15189 </member>
15190 <member name="M:NAnt.Core.TaskBuilderCollection.GetEnumerator">
15191 <summary>
15192 Returns an enumerator that can iterate through the collection.
15193 </summary>
15194 <returns>
15195 A <see cref="T:NAnt.Core.TaskBuilderEnumerator"/> for the entire collection.
15196 </returns>
15197 </member>
15198 <member name="M:NAnt.Core.TaskBuilderCollection.Remove(NAnt.Core.TaskBuilder)">
15199 <summary>
15200 Removes a member from the collection.
15201 </summary>
15202 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to remove from the collection.</param>
15203 </member>
15204 <member name="P:NAnt.Core.TaskBuilderCollection.Item(System.Int32)">
15205 <summary>
15206 Gets or sets the element at the specified index.
15207 </summary>
15208 <param name="index">The zero-based index of the element to get or set.</param>
15209 </member>
15210 <member name="P:NAnt.Core.TaskBuilderCollection.Item(System.String)">
15211 <summary>
15212 Gets the <see cref="T:NAnt.Core.TaskBuilder"/> for the specified task.
15213 </summary>
15214 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.TaskBuilder"/> should be located in the collection.</param>
15215 </member>
15216 <member name="T:NAnt.Core.TaskBuilderEnumerator">
15217 <summary>
15218 Enumerates the <see cref="T:NAnt.Core.TaskBuilder"/> elements of a <see cref="T:NAnt.Core.TaskBuilderCollection"/>.
15219 </summary>
15220 </member>
15221 <member name="M:NAnt.Core.TaskBuilderEnumerator.#ctor(NAnt.Core.TaskBuilderCollection)">
15222 <summary>
15223 Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderEnumerator"/> class
15224 with the specified <see cref="T:NAnt.Core.TaskBuilderCollection"/>.
15225 </summary>
15226 <param name="arguments">The collection that should be enumerated.</param>
15227 </member>
15228 <member name="M:NAnt.Core.TaskBuilderEnumerator.MoveNext">
15229 <summary>
15230 Advances the enumerator to the next element of the collection.
15231 </summary>
15232 <returns>
15233 <see langword="true" /> if the enumerator was successfully advanced
15234 to the next element; <see langword="false" /> if the enumerator has
15235 passed the end of the collection.
15236 </returns>
15237 </member>
15238 <member name="M:NAnt.Core.TaskBuilderEnumerator.Reset">
15239 <summary>
15240 Sets the enumerator to its initial position, which is before the
15241 first element in the collection.
15242 </summary>
15243 </member>
15244 <member name="P:NAnt.Core.TaskBuilderEnumerator.Current">
15245 <summary>
15246 Gets the current element in the collection.
15247 </summary>
15248 <returns>
15249 The current element in the collection.
15250 </returns>
15251 </member>
15252 <member name="T:NAnt.Core.TypeFactory">
15253 <summary>
15254 Comprises all of the loaded, and available, tasks.
15255 Use these static methods to register, initialize and create a task.
15256 </summary>
15257 </member>
15258 <member name="M:NAnt.Core.TypeFactory.ScanAssembly(System.String,NAnt.Core.Task)">
15259 <summary>
15260 Scans the given assembly for tasks, types, functions and filters.
15261 </summary>
15262 <param name="assemblyFile">The assembly to scan for tasks, types, functions and filters.</param>
15263 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15264 </member>
15265 <member name="M:NAnt.Core.TypeFactory.ScanAssembly(System.Reflection.Assembly,NAnt.Core.Task)">
15266 <summary>
15267 Scans the given assembly for tasks, types, functions and filters.
15268 </summary>
15269 <param name="assembly">The assembly to scan for tasks, types, functions and filters.</param>
15270 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15271 <returns>
15272 <see langword="true"/> if <paramref name="assembly"/> contains at
15273 least one "extension"; otherwise, <see langword="false"/>.
15274 </returns>
15275 </member>
15276 <member name="M:NAnt.Core.TypeFactory.ScanDir(System.String,NAnt.Core.Task,System.Boolean)">
15277 <summary>
15278 Scans the path for any task assemblies and adds them.
15279 </summary>
15280 <param name="path">The directory to scan in.</param>
15281 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15282 <param name="failOnError"><see cref="T:System.Boolean"/> indicating whether scanning of the directory should halt on first error.</param>
15283 </member>
15284 <member name="M:NAnt.Core.TypeFactory.AddProject(NAnt.Core.Project)">
15285 <summary>
15286 Adds any task assemblies in the project base directory
15287 and its <c>tasks</c> subdirectory.
15288 </summary>
15289 <param name="project">The project to work from.</param>
15290 </member>
15291 <member name="M:NAnt.Core.TypeFactory.AddProject(NAnt.Core.Project,System.Boolean)">
15292 <summary>
15293 Registers the project with <see cref="T:NAnt.Core.TypeFactory"/>, and optionally
15294 scan the <see cref="P:NAnt.Core.Project.BaseDirectory"/> for extension assemblies.
15295 </summary>
15296 <param name="project">The project to work from.</param>
15297 <param name="scan">Specified whether to scan the <see cref="P:NAnt.Core.Project.BaseDirectory"/> for extension assemblies.</param>
15298 </member>
15299 <member name="M:NAnt.Core.TypeFactory.LookupFunction(System.String,NAnt.Core.Project)">
15300 <summary>
15301 Looks up a function by name.
15302 </summary>
15303 <param name="methodName">The name of the function to lookup, including namespace prefix.</param>
15304 <param name="project">The <see cref="T:NAnt.Core.Project"/> in which the function is invoked.</param>
15305 <returns>
15306 A <see cref="T:System.Reflection.MethodInfo"/> representing the function, or
15307 <see langword="null"/> if a function with the given name does not
15308 exist.
15309 </returns>
15310 </member>
15311 <member name="M:NAnt.Core.TypeFactory.CreateTask(System.Xml.XmlNode,NAnt.Core.Project)">
15312 <summary>
15313 Creates a new <see cref="T:NAnt.Core.Task"/> instance for the given XML and
15314 <see cref="T:NAnt.Core.Project"/>.
15315 </summary>
15316 <param name="taskNode">The XML to initialize the task with.</param>
15317 <param name="proj">The <see cref="T:NAnt.Core.Project"/> that the <see cref="T:NAnt.Core.Task"/> belongs to.</param>
15318 <returns>
15319 The new <see cref="T:NAnt.Core.Task"/> instance.
15320 </returns>
15321 </member>
15322 <member name="M:NAnt.Core.TypeFactory.ScanTypeForTasks(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
15323 <summary>
15324 Scans a given <see cref="T:System.Type"/> for tasks.
15325 </summary>
15326 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
15327 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
15328 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15329 <returns>
15330 <see langword="true"/> if <paramref name="type"/> represents a
15331 <see cref="T:NAnt.Core.Task"/>; otherwise, <see langword="false"/>.
15332 </returns>
15333 </member>
15334 <member name="M:NAnt.Core.TypeFactory.ScanTypeForDataTypes(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
15335 <summary>
15336 Scans a given <see cref="T:System.Type"/> for data type.
15337 </summary>
15338 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
15339 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
15340 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15341 <returns>
15342 <see langword="true"/> if <paramref name="type"/> represents a
15343 data type; otherwise, <see langword="false"/>.
15344 </returns>
15345 </member>
15346 <member name="M:NAnt.Core.TypeFactory.ScanTypeForFunctions(System.Type,NAnt.Core.Task)">
15347 <summary>
15348 Scans a given <see cref="T:System.Type"/> for functions.
15349 </summary>
15350 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
15351 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15352 <returns>
15353 <see langword="true"/> if <paramref name="type"/> represents a
15354 valid set of funtions; otherwise, <see langword="false"/>.
15355 </returns>
15356 </member>
15357 <member name="M:NAnt.Core.TypeFactory.ScanTypeForFilters(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
15358 <summary>
15359 Scans a given <see cref="T:System.Type"/> for filters.
15360 </summary>
15361 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
15362 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
15363 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15364 <returns>
15365 <see langword="true"/> if <paramref name="type"/> represents a
15366 <see cref="T:NAnt.Core.Filters.Filter"/>; otherwise, <see langword="false"/>.
15367 </returns>
15368 </member>
15369 <member name="P:NAnt.Core.TypeFactory.TaskBuilders">
15370 <summary>
15371 Gets the list of loaded <see cref="T:NAnt.Core.TaskBuilder"/> instances.
15372 </summary>
15373 <value>
15374 List of loaded <see cref="T:NAnt.Core.TaskBuilder"/> instances.
15375 </value>
15376 </member>
15377 <member name="P:NAnt.Core.TypeFactory.DataTypeBuilders">
15378 <summary>
15379 Gets the list of loaded <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
15380 </summary>
15381 <value>
15382 List of loaded <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
15383 </value>
15384 </member>
15385 <member name="P:NAnt.Core.TypeFactory.FilterBuilders">
15386 <summary>
15387 Gets the list of loaded <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
15388 </summary>
15389 <value>
15390 List of loaded <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
15391 </value>
15392 </member>
15393 <member name="M:NAnt.Core.ValidationException.#ctor">
15394 <summary>
15395 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15396 class.
15397 </summary>
15398 </member>
15399 <member name="M:NAnt.Core.ValidationException.#ctor(System.String)">
15400 <summary>
15401 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15402 class with a descriptive message.
15403 </summary>
15404 <param name="message">A descriptive message to include with the exception.</param>
15405 </member>
15406 <member name="M:NAnt.Core.ValidationException.#ctor(System.String,System.Exception)">
15407 <summary>
15408 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15409 class with the specified descriptive message and inner exception.
15410 </summary>
15411 <param name="message">A descriptive message to include with the exception.</param>
15412 <param name="innerException">A nested exception that is the cause of the current exception.</param>
15413 </member>
15414 <member name="M:NAnt.Core.ValidationException.#ctor(System.String,NAnt.Core.Location)">
15415 <summary>
15416 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15417 class with a descriptive message and the location in the build file
15418 that caused the exception.
15419 </summary>
15420 <param name="message">A descriptive message to include with the exception.</param>
15421 <param name="location">The location in the build file where the exception occured.</param>
15422 </member>
15423 <member name="M:NAnt.Core.ValidationException.#ctor(System.String,NAnt.Core.Location,System.Exception)">
15424 <summary>
15425 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15426 class with a descriptive message, the location in the build file and
15427 an instance of the exception that is the cause of the current
15428 exception.
15429 </summary>
15430 <param name="message">A descriptive message to include with the exception.</param>
15431 <param name="location">The location in the build file where the exception occured.</param>
15432 <param name="innerException">A nested exception that is the cause of the current exception.</param>
15433 </member>
15434 <member name="M:NAnt.Core.ValidationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
15435 <summary>
15436 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15437 class with serialized data.
15438 </summary>
15439 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
15440 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
15441 </member>
15442 <member name="T:NAnt.Core.XmlLogger">
15443 <summary>
15444 Used to wrap log messages in xml <message/> elements.
15445 </summary>
15446 </member>
15447 <member name="F:NAnt.Core.XmlLogger._projectStack">
15448 <summary>
15449 Holds the stack of currently executing projects.
15450 </summary>
15451 </member>
15452 <member name="M:NAnt.Core.XmlLogger.#ctor">
15453 <summary>
15454 Initializes a new instance of the <see cref="T:NAnt.Core.XmlLogger"/> class.
15455 </summary>
15456 </member>
15457 <member name="M:NAnt.Core.XmlLogger.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
15458 <summary>
15459 Initializes a new instance of the <see cref="T:NAnt.Core.XmlLogger"/> class
15460 with serialized data.
15461 </summary>
15462 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
15463 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
15464 </member>
15465 <member name="M:NAnt.Core.XmlLogger.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
15466 <summary>
15467 Populates <paramref name="info"/> with the data needed to serialize
15468 the <see cref="T:NAnt.Core.XmlLogger"/> instance.
15469 </summary>
15470 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
15471 <param name="context">The destination for this serialization.</param>
15472 </member>
15473 <member name="M:NAnt.Core.XmlLogger.ToString">
15474 <summary>
15475 Returns the contents of log captured.
15476 </summary>
15477 </member>
15478 <member name="M:NAnt.Core.XmlLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
15479 <summary>
15480 Signals that a build has started.
15481 </summary>
15482 <param name="sender">The source of the event.</param>
15483 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15484 <remarks>
15485 This event is fired before any targets have started.
15486 </remarks>
15487 </member>
15488 <member name="M:NAnt.Core.XmlLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
15489 <summary>
15490 Signals that the last target has finished.
15491 </summary>
15492 <param name="sender">The source of the event.</param>
15493 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15494 <remarks>
15495 This event will still be fired if an error occurred during the build.
15496 </remarks>
15497 </member>
15498 <member name="M:NAnt.Core.XmlLogger.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
15499 <summary>
15500 Signals that a target has started.
15501 </summary>
15502 <param name="sender">The source of the event.</param>
15503 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15504 </member>
15505 <member name="M:NAnt.Core.XmlLogger.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
15506 <summary>
15507 Signals that a target has finished.
15508 </summary>
15509 <param name="sender">The source of the event.</param>
15510 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15511 <remarks>
15512 This event will still be fired if an error occurred during the build.
15513 </remarks>
15514 </member>
15515 <member name="M:NAnt.Core.XmlLogger.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
15516 <summary>
15517 Signals that a task has started.
15518 </summary>
15519 <param name="sender">The source of the event.</param>
15520 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15521 </member>
15522 <member name="M:NAnt.Core.XmlLogger.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
15523 <summary>
15524 Signals that a task has finished.
15525 </summary>
15526 <param name="sender">The source of the event.</param>
15527 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15528 <remarks>
15529 This event will still be fired if an error occurred during the build.
15530 </remarks>
15531 </member>
15532 <member name="M:NAnt.Core.XmlLogger.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
15533 <summary>
15534 Signals that a message has been logged.
15535 </summary>
15536 <param name="sender">The source of the event.</param>
15537 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15538 <remarks>
15539 Only messages with a priority higher or equal to the threshold of
15540 the logger will actually be output in the build log.
15541 </remarks>
15542 </member>
15543 <member name="M:NAnt.Core.XmlLogger.Flush">
15544 <summary>
15545 Flushes buffered build events or messages to the underlying storage.
15546 </summary>
15547 </member>
15548 <member name="P:NAnt.Core.XmlLogger.Threshold">
15549 <summary>
15550 Gets or sets the highest level of message this logger should respond
15551 to.
15552 </summary>
15553 <value>
15554 The highest level of message this logger should respond to.
15555 </value>
15556 <remarks>
15557 Only messages with a message level higher than or equal to the given
15558 level should be written to the log.
15559 </remarks>
15560 </member>
15561 <member name="P:NAnt.Core.XmlLogger.EmacsMode">
15562 <summary>
15563 Gets or sets a value indicating whether to produce emacs (and other
15564 editor) friendly output.
15565 </summary>
15566 <value>
15567 <see langword="false" /> as it has no meaning in XML format.
15568 </value>
15569 </member>
15570 <member name="P:NAnt.Core.XmlLogger.OutputWriter">
15571 <summary>
15572 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
15573 to send its output.
15574 </summary>
15575 </member>
15576 </members>
15577</doc>