main
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 [BuildAttribute("optimize")]
54 [BooleanValidator()]
55 public bool Optimize {
56 get { return _optimize; }
57 set { _optimize = value; }
58 }
59 [BuildAttribute("warnlevel")]
60 [Int32Validator(0,4)] // limit values to 0-4
61 public int WarnLevel {
62 get { return _warnLevel; }
63 set { _warnLevel = value; }
64 }
65 [BuildElement("sources")]
66 public FileSet Sources {
67 get { return _sources; }
68 set { _sources = value; }
69 }
70
71 #endregion Public Instance Properties
72
73 #region Private Instance Fields
74
75 private string _out = null;
76 private bool _optimize = false;
77 private int _warnLevel = 4;
78 private FileSet _sources = new FileSet();
79
80 #endregion Private Instance Fields
81 </code>
82 </example>
83 </member>
84 <member name="M:NAnt.Core.Attributes.BuildAttributeAttribute.#ctor(System.String)">
85 <summary>
86 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildAttributeAttribute"/> with the
87 specified name.
88 </summary>
89 <param name="name">The name of the attribute.</param>
90 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
91 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
92 </member>
93 <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Name">
94 <summary>
95 Gets or sets the name of the XML attribute.
96 </summary>
97 <value>
98 The name of the XML attribute.
99 </value>
100 </member>
101 <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Required">
102 <summary>
103 Gets or sets a value indicating whether the attribute is required.
104 </summary>
105 <value>
106 <see langword="true" /> if the attribute is required; otherwise,
107 <see langword="false" />. The default is <see langword="false" />.
108 </value>
109 </member>
110 <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ExpandProperties">
111 <summary>
112 Gets or sets a value indicating whether property references should
113 be expanded.
114 </summary>
115 <value>
116 <see langword="true" /> if properties should be expanded; otherwise
117 <see langword="false" />. The default is <see langword="true" />.
118 </value>
119 </member>
120 <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ProcessXml">
121 <summary>
122 Used to specify how this attribute will be handled as the XML is
123 parsed and given to the element.
124 </summary>
125 <value>
126 <see langword="true" /> if XML should be processed; otherwise
127 <see langword="false" />. The default is <see langword="true" />.
128 </value>
129 </member>
130 <member name="T:NAnt.Core.Attributes.BuildElementArrayAttribute">
131 <summary>
132 Indicates that property should be treated as a XML arrayList
133 </summary>
134 <remarks>
135 <para>
136 Should only be applied to properties exposing strongly typed arrays or
137 strongly typed collections.
138 </para>
139 <para>
140 The XML format is like this:
141 <code>
142 <![CDATA[
143 <task>
144 <elementName ... />
145 <elementName ... />
146 <elementName ... />
147 <elementName ... />
148 </task>
149 ]]>
150 </code>
151 </para>
152 </remarks>
153 </member>
154 <member name="T:NAnt.Core.Attributes.BuildElementAttribute">
155 <summary>
156 Indicates that the property should be treated as an XML element and
157 further processing should be done.
158 </summary>
159 <remarks>
160 <para>
161 The XML format is like this:
162 <code>
163 <![CDATA[
164 <task>
165 <elementName ...>
166 <morestuff />
167 </elementName>
168 </task>
169 ]]>
170 </code>
171 </para>
172 </remarks>
173 </member>
174 <member name="M:NAnt.Core.Attributes.BuildElementAttribute.#ctor(System.String)">
175 <summary>
176 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> with the
177 specified name.
178 </summary>
179 <param name="name">The name of the attribute.</param>
180 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
181 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
182 </member>
183 <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Name">
184 <summary>
185 Gets or sets the name of the attribute.
186 </summary>
187 <value>
188 The name of the attribute.
189 </value>
190 </member>
191 <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Required">
192 <summary>
193 Gets or sets a value indicating whether the attribute is required.
194 </summary>
195 <value>
196 <see langword="true" /> if the attribute is required; otherwise,
197 <see langword="false" />. The default is <see langword="false" />.
198 </value>
199 </member>
200 <member name="P:NAnt.Core.Attributes.BuildElementAttribute.ProcessXml">
201 <summary>
202 Used to specify how this element will be handled as the XML is parsed
203 and given to the element.
204 </summary>
205 <value>
206 <see langword="true" /> if XML should be processed; otherwise
207 <see langword="false" />. The default is <see langword="true" />.
208 </value>
209 </member>
210 <member name="M:NAnt.Core.Attributes.BuildElementArrayAttribute.#ctor(System.String)">
211 <summary>
212 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementArrayAttribute"/>
213 with the specified name.
214 </summary>
215 <param name="name">The name of the attribute.</param>
216 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
217 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
218 </member>
219 <member name="P:NAnt.Core.Attributes.BuildElementArrayAttribute.ElementType">
220 <summary>
221 Gets or sets the type of objects that this container holds.
222 </summary>
223 <value>
224 The type of the elements that this container holds.
225 </value>
226 <remarks>
227 <para>
228 This can be used for validation and schema generation.
229 </para>
230 <para>
231 If not specified, the type of the elements will be determined using
232 reflection.
233 </para>
234 </remarks>
235 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
236 </member>
237 <member name="T:NAnt.Core.Attributes.BuildElementCollectionAttribute">
238 <summary>
239 Indicates that the property should be treated as a container for a
240 collection of build elements.
241 </summary>
242 <remarks>
243 <para>
244 Should only be applied to properties exposing strongly typed arrays or
245 strongly typed collections.
246 </para>
247 <para>
248 The XML format is like this:
249 <code>
250 <![CDATA[
251 <task>
252 <collectionName>
253 <elementName ... />
254 <elementName ... />
255 <elementName ... />
256 <elementName ... />
257 </collectionName>
258 </task>
259 ]]>
260 </code>
261 </para>
262 </remarks>
263 </member>
264 <member name="M:NAnt.Core.Attributes.BuildElementCollectionAttribute.#ctor(System.String,System.String)">
265 <summary>
266 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementCollectionAttribute"/> with the
267 specified name and child element name.
268 </summary>
269 <param name="collectionName">The name of the collection.</param>
270 <param name="childName">The name of the child elements in the collection</param>
271 <exception cref="T:System.ArgumentNullException"><paramref name="childName"/> is <see langword="null"/>.</exception>
272 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="childName"/> is a zero-length <see cref="T:System.String"/>.</exception>
273 </member>
274 <member name="P:NAnt.Core.Attributes.BuildElementCollectionAttribute.ChildElementName">
275 <summary>
276 The name of the child element within the collection.
277 </summary>
278 <value>
279 The name to check for in the XML of the elements in the collection.
280 </value>
281 <remarks>
282 This can be used for validation and schema generation.
283 </remarks>
284 </member>
285 <member name="T:NAnt.Core.Attributes.DateTimeValidatorAttribute">
286 <summary>
287 Used to indicate that a property should be able to be converted into a
288 <see cref="T:System.DateTime"/>.
289 </summary>
290 </member>
291 <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.#ctor">
292 <summary>
293 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.DateTimeValidatorAttribute"/>
294 class.
295 </summary>
296 </member>
297 <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.Validate(System.Object)">
298 <summary>
299 Checks if the specified value can be converted to a <see cref="T:System.DateTime"/>.
300 </summary>
301 <param name="value">The value to be checked.</param>
302 <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> cannot be converted to a <see cref="T:System.DateTime"/>.</exception>
303 </member>
304 <member name="T:NAnt.Core.Attributes.ElementNameAttribute">
305 <summary>
306 Indicates that class should be treated as a NAnt element.
307 </summary>
308 <remarks>
309 Attach this attribute to a subclass of Element to have NAnt be able
310 to recognize it. The name should be short but must not confict
311 with any other element already in use.
312 </remarks>
313 </member>
314 <member name="M:NAnt.Core.Attributes.ElementNameAttribute.#ctor(System.String)">
315 <summary>
316 Initializes a new instance of the <see cre="ElementNameAttribute"/>
317 with the specified name.
318 </summary>
319 <param name="name">The name of the element.</param>
320 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
321 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
322 </member>
323 <member name="P:NAnt.Core.Attributes.ElementNameAttribute.Name">
324 <summary>
325 Gets or sets the name of the element.
326 </summary>
327 <value>
328 The name of the element.
329 </value>
330 </member>
331 <member name="T:NAnt.Core.Attributes.FileSetAttribute">
332 <summary>
333 Indicates that a property should be treated as a XML file set for the
334 task.
335 </summary>
336 </member>
337 <member name="M:NAnt.Core.Attributes.FileSetAttribute.#ctor(System.String)">
338 <summary>
339 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FileSetAttribute"/> with the
340 specified name.
341 </summary>
342 <param name="name">The name of the attribute.</param>
343 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
344 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
345 </member>
346 <member name="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute">
347 <summary>
348 Indicates that the value of the property to which the attribute is
349 assigned, can be configured on the framework-level in the NAnt application
350 configuration file.
351 </summary>
352 <example>
353 <para>
354 The following example shows a property of which the value can be
355 configured for a specific framework in the NAnt configuration file.
356 </para>
357 <code lang="C#">
358 [FrameworkConfigurable("exename", Required=true)]
359 public virtual string ExeName {
360 get { return _exeName; }
361 set { _exeName = value; }
362 }
363 </code>
364 </example>
365 </member>
366 <member name="M:NAnt.Core.Attributes.FrameworkConfigurableAttribute.#ctor(System.String)">
367 <summary>
368 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute"/>
369 with the specified attribute name.
370 </summary>
371 <param name="name">The name of the framework configuration attribute.</param>
372 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception>
373 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
374 </member>
375 <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Name">
376 <summary>
377 Gets or sets the name of the framework configuration attribute.
378 </summary>
379 <value>The name of the framework configuration attribute.</value>
380 </member>
381 <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Required">
382 <summary>
383 Gets or sets a value indicating whether the configuration attribute
384 is required.
385 </summary>
386 <value>
387 <see langword="true" /> if the configuration attribute is required;
388 otherwise, <see langword="true" />. The default is <see langword="false" />.
389 </value>
390 </member>
391 <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.ExpandProperties">
392 <summary>
393 Gets or sets a value indicating whether property references should
394 be expanded.
395 </summary>
396 <value>
397 <see langword="true" /> if properties should be expanded; otherwise
398 <see langword="false" />. The default is <see langword="true" />.
399 </value>
400 </member>
401 <member name="T:NAnt.Core.Attributes.FunctionAttribute">
402 <summary>
403 Indicates that the method should be exposed as a function in NAnt build
404 files.
405 </summary>
406 <remarks>
407 Attach this attribute to a method of a class that derives from
408 <see cref="T:NAnt.Core.FunctionSetBase"/> to have NAnt be able to recognize it.
409 </remarks>
410 </member>
411 <member name="M:NAnt.Core.Attributes.FunctionAttribute.#ctor(System.String)">
412 <summary>
413 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionAttribute"/>
414 class with the specified name.
415 </summary>
416 <param name="name">The name of the function.</param>
417 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
418 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
419 </member>
420 <member name="P:NAnt.Core.Attributes.FunctionAttribute.Name">
421 <summary>
422 Gets or sets the name of the function.
423 </summary>
424 <value>
425 The name of the function.
426 </value>
427 </member>
428 <member name="T:NAnt.Core.Attributes.FunctionSetAttribute">
429 <summary>
430 Indicates that class should be treated as a set of functions.
431 </summary>
432 <remarks>
433 Attach this attribute to a class that derives from <see cref="T:NAnt.Core.FunctionSetBase"/>
434 to have NAnt be able to recognize it as containing custom functions.
435 </remarks>
436 </member>
437 <member name="M:NAnt.Core.Attributes.FunctionSetAttribute.#ctor(System.String,System.String)">
438 <summary>
439 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionSetAttribute"/>
440 class with the specified name.
441 </summary>
442 <param name="prefix">The prefix used to distinguish the functions.</param>
443 <param name="category">The category of the functions.</param>
444 <exception cref="T:System.ArgumentNullException">
445 <para><paramref name="prefix"/> is <see langword="null"/>.</para>
446 <para>-or-</para>
447 <para><paramref name="category"/> is <see langword="null"/>.</para>
448 </exception>
449 <exception cref="T:System.ArgumentOutOfRangeException">
450 <para><paramref name="prefix"/> is a zero-length <see cref="T:System.String"/>.</para>
451 <para>-or-</para>
452 <para><paramref name="category"/> is a zero-length <see cref="T:System.String"/>.</para>
453 </exception>
454 </member>
455 <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Category">
456 <summary>
457 Gets or sets the category of the function set.
458 </summary>
459 <value>
460 The name of the category of the function set.
461 </value>
462 <remarks>
463 This will be displayed in the user docs.
464 </remarks>
465 </member>
466 <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Prefix">
467 <summary>
468 Gets or sets the prefix of all functions in this function set.
469 </summary>
470 <value>
471 The prefix of the functions in this function set.
472 </value>
473 </member>
474 <member name="T:NAnt.Core.Attributes.Int32ValidatorAttribute">
475 <summary>
476 Indicates that property should be able to be converted into a <see cref="T:System.Int32"/>
477 within the given range.
478 </summary>
479 </member>
480 <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor">
481 <summary>
482 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/>
483 class.
484 </summary>
485 </member>
486 <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor(System.Int32,System.Int32)">
487 <summary>
488 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/>
489 class with the specied minimum and maximum values.
490 </summary>
491 <param name="minValue">The minimum value.</param>
492 <param name="maxValue">The maximum value.</param>
493 </member>
494 <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.Validate(System.Object)">
495 <summary>
496 Checks whether the specified value can be converted to an <see cref="T:System.Int32"/>
497 and whether the value lies within the range defined by the <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/>
498 and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/> properties.
499 </summary>
500 <param name="value">The value to be checked.</param>
501 <exception cref="T:NAnt.Core.ValidationException">
502 <para>
503 <paramref name="value"/> cannot be converted to an <see cref="T:System.Int32"/>.
504 </para>
505 <para>-or-</para>
506 <para>
507 <paramref name="value"/> is not in the range defined by <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/>
508 and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/>.
509 </para>
510 </exception>
511 </member>
512 <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue">
513 <summary>
514 Gets or sets the minimum value.
515 </summary>
516 <value>
517 The minimum value. The default is <see cref="F:System.Int32.MinValue"/>.
518 </value>
519 </member>
520 <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue">
521 <summary>
522 Gets or sets the maximum value.
523 </summary>
524 <value>
525 The maximum value. The default is <see cref="F:System.Int32.MaxValue"/>.
526 </value>
527 </member>
528 <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.Base">
529 <summary>
530 The base of the number to validate, which must be 2, 8, 10, or 16.
531 </summary>
532 <value>
533 The base of the number to validate.
534 </value>
535 <remarks>
536 The default is 10.
537 </remarks>
538 </member>
539 <member name="T:NAnt.Core.Attributes.LocationType">
540 <summary>
541 Defines possible locations in which a task executable can be located.
542 </summary>
543 </member>
544 <member name="F:NAnt.Core.Attributes.LocationType.FrameworkDir">
545 <summary>
546 Locates the task executable in the current Framework directory.
547 </summary>
548 </member>
549 <member name="F:NAnt.Core.Attributes.LocationType.FrameworkSdkDir">
550 <summary>
551 Locates the task executable in the current Framework SDK directory.
552 </summary>
553 </member>
554 <member name="T:NAnt.Core.Attributes.ProgramLocationAttribute">
555 <summary>
556 Indicates the location that a task executable can be located in.
557 </summary>
558 <remarks>
559 <para>
560 When applied to a task deriving from <see cref="T:NAnt.Core.Tasks.ExternalProgramBase"/>,
561 the program to execute will first be searched for in the designated
562 location.
563 </para>
564 <para>
565 If the program does not exist in that location, and the file name is
566 not an absolute path then the list of tool paths of the current
567 target framework will be searched (in the order in which they are
568 defined in the NAnt configuration file).
569 </para>
570 </remarks>
571 </member>
572 <member name="M:NAnt.Core.Attributes.ProgramLocationAttribute.#ctor(NAnt.Core.Attributes.LocationType)">
573 <summary>
574 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/>
575 with the specified location.
576 </summary>
577 <param type="type">The <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the attribute.</param>
578 </member>
579 <member name="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType">
580 <summary>
581 Gets or sets the <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the task.
582 </summary>
583 <value>
584 The location type of the task to which the attribute is assigned.
585 </value>
586 </member>
587 <member name="T:NAnt.Core.Attributes.StringValidatorAttribute">
588 <summary>
589 Used to indicate whether a <see cref="T:System.String"/> property should allow
590 an empty string value or not.
591 </summary>
592 </member>
593 <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.#ctor">
594 <summary>
595 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>
596 class.
597 </summary>
598 </member>
599 <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.Validate(System.Object)">
600 <summary>
601 Checks if the specified value adheres to the rules defined by the
602 properties of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>.
603 </summary>
604 <param name="value">The value to be checked.</param>
605 <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>
606 </member>
607 <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.AllowEmpty">
608 <summary>
609 Gets or sets a value indicating whether an empty string or
610 <see langword="null" /> should be a considered a valid value.
611 </summary>
612 <value>
613 <see langword="true" /> if an empty string or <see langword="null" />
614 should be considered a valid value; otherwise, <see langword="false" />.
615 The default is <see langword="true" />.
616 </value>
617 </member>
618 <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.Expression">
619 <summary>
620 Gets or sets a regular expression. The string will be validated to
621 determine if it matches the expression.
622 </summary>
623 <value>
624 <see cref="N:System.Text.RegularExpressions"/>
625 </value>
626 </member>
627 <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.ExpressionErrorMessage">
628 <summary>
629 An optional error message that can be used to better describe the
630 regular expression error.
631 </summary>
632 </member>
633 <member name="T:NAnt.Core.Attributes.TaskAttributeAttribute">
634 <summary>
635 Indicates that property should be treated as a XML attribute for the
636 task.
637 </summary>
638 <example>
639 Examples of how to specify task attributes
640 <code>
641 // task XmlType default is string
642 [TaskAttribute("out", Required=true)]
643 string _out = null; // assign default value here
644 [TaskAttribute("optimize")]
645 [BooleanValidator()]
646 // during ExecuteTask you can safely use Convert.ToBoolean(_optimize)
647 string _optimize = Boolean.FalseString;
648 [TaskAttribute("warnlevel")]
649 [Int32Validator(0,4)] // limit values to 0-4
650 // during ExecuteTask you can safely use Convert.ToInt32(_optimize)
651 string _warnlevel = "0";
652 [BuildElement("sources")]
653 FileSet _sources = new FileSet();
654 </code>
655 NOTE: Attribute values must be of type of string if you want
656 to be able to have macros. The field stores the exact value during
657 Initialize. Just before ExecuteTask is called NAnt will expand
658 all the macros with the current values.
659 </example>
660 </member>
661 <member name="M:NAnt.Core.Attributes.TaskAttributeAttribute.#ctor(System.String)">
662 <summary>
663 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskAttributeAttribute"/>
664 with the specified attribute name.
665 </summary>
666 <param name="name">The name of the task attribute.</param>
667 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception>
668 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
669 </member>
670 <member name="T:NAnt.Core.Attributes.TaskNameAttribute">
671 <summary>
672 Indicates that class should be treated as a task.
673 </summary>
674 <remarks>
675 Attach this attribute to a subclass of Task to have NAnt be able
676 to recognize it. The name should be short but must not confict
677 with any other task already in use.
678 </remarks>
679 </member>
680 <member name="M:NAnt.Core.Attributes.TaskNameAttribute.#ctor(System.String)">
681 <summary>
682 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskNameAttribute"/>
683 with the specified name.
684 </summary>
685 <param name="name">The name of the task.</param>
686 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
687 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
688 </member>
689 <member name="T:NAnt.Core.Element">
690 <summary>
691 Models a NAnt XML element in the build file.
692 </summary>
693 <remarks>
694 <para>
695 Automatically validates attributes in the element based on attributes
696 applied to members in derived classes.
697 </para>
698 </remarks>
699 </member>
700 <member name="M:NAnt.Core.Element.#ctor">
701 <summary>
702 Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class.
703 </summary>
704 </member>
705 <member name="M:NAnt.Core.Element.#ctor(NAnt.Core.Element)">
706 <summary>
707 Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class
708 from the specified element.
709 </summary>
710 <param name="e">The element that should be used to create a new instance of the <see cref="T:NAnt.Core.Element"/> class.</param>
711 </member>
712 <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode)">
713 <summary>
714 Performs default initialization.
715 </summary>
716 <remarks>
717 Derived classes that wish to add custom initialization should override
718 the <see cref="M:NAnt.Core.Element.Initialize"/> method.
719 </remarks>
720 </member>
721 <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String)">
722 <summary>
723 Logs a message with the given priority.
724 </summary>
725 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
726 <param name="message">The message to be logged.</param>
727 <remarks>
728 The actual logging is delegated to the project.
729 </remarks>
730 </member>
731 <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String,System.Object[])">
732 <summary>
733 Logs a message with the given priority.
734 </summary>
735 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
736 <param name="message">The message to log, containing zero or more format items.</param>
737 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
738 <remarks>
739 The actual logging is delegated to the project.
740 </remarks>
741 </member>
742 <member name="M:NAnt.Core.Element.InitializeElement(System.Xml.XmlNode)">
743 <summary>
744 Derived classes should override to this method to provide extra
745 initialization and validation not covered by the base class.
746 </summary>
747 <param name="elementNode">The XML node of the element to use for initialization.</param>
748 </member>
749 <member name="M:NAnt.Core.Element.Initialize">
750 <summary>
751 Derived classes should override to this method to provide extra
752 initialization and validation not covered by the base class.
753 </summary>
754 <remarks>
755 Access to the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize
756 this <see cref="T:NAnt.Core.Element"/> is available through <see cref="P:NAnt.Core.Element.XmlNode"/>.
757 </remarks>
758 </member>
759 <member name="M:NAnt.Core.Element.CopyTo(NAnt.Core.Element)">
760 <summary>
761 Copies all instance data of the <see cref="T:NAnt.Core.Element"/> to a given
762 <see cref="T:NAnt.Core.Element"/>.
763 </summary>
764 </member>
765 <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
766 <summary>
767 Performs initialization using the given set of properties.
768 </summary>
769 </member>
770 <member name="M:NAnt.Core.Element.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
771 <summary>
772 Initializes all build attributes and child elements.
773 </summary>
774 </member>
775 <member name="M:NAnt.Core.Element.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)">
776 <summary>
777 Locates the XML node for the specified attribute in the project
778 configuration node.
779 </summary>
780 <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param>
781 <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>
782 <returns>
783 The XML configuration node for the specified attribute, or
784 <see langword="null" /> if no corresponding XML node could be
785 located.
786 </returns>
787 <remarks>
788 If there's a valid current framework, the configuration section for
789 that framework will first be searched. If no corresponding
790 configuration node can be located in that section, the framework-neutral
791 section of the project configuration node will be searched.
792 </remarks>
793 </member>
794 <member name="M:NAnt.Core.Element.GetElementNameFromType(System.Type)">
795 <summary>
796 Returns the <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> of the
797 <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned to the specified
798 <see cref="T:System.Type"/>.
799 </summary>
800 <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>
801 <returns>
802 The <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> assigned to the specified
803 <see cref="T:System.Type"/> or a null reference is no <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/>
804 is assigned to the <paramref name="type"/>.
805 </returns>
806 </member>
807 <member name="P:NAnt.Core.Element.Parent">
808 <summary>
809 Gets or sets the parent of the element.
810 </summary>
811 <value>
812 The parent of the element.
813 </value>
814 <remarks>
815 This will be the parent <see cref="T:NAnt.Core.Task"/>, <see cref="T:NAnt.Core.Target"/>, or
816 <see cref="P:NAnt.Core.Element.Project"/> depending on where the element is defined.
817 </remarks>
818 </member>
819 <member name="P:NAnt.Core.Element.Name">
820 <summary>
821 Gets the name of the XML element used to initialize this element.
822 </summary>
823 <value>
824 The name of the XML element used to initialize this element.
825 </value>
826 </member>
827 <member name="P:NAnt.Core.Element.Project">
828 <summary>
829 Gets or sets the <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs.
830 </summary>
831 <value>
832 The <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs.
833 </value>
834 </member>
835 <member name="P:NAnt.Core.Element.Properties">
836 <summary>
837 Gets the properties local to this <see cref="T:NAnt.Core.Element"/> and the
838 <see cref="P:NAnt.Core.Element.Project"/>.
839 </summary>
840 <value>
841 The properties local to this <see cref="T:NAnt.Core.Element"/> and the <see cref="P:NAnt.Core.Element.Project"/>.
842 </value>
843 </member>
844 <member name="P:NAnt.Core.Element.NamespaceManager">
845 <summary>
846 Gets or sets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
847 </summary>
848 <value>
849 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
850 </value>
851 <remarks>
852 The <see cref="P:NAnt.Core.Element.NamespaceManager"/> defines the current namespace
853 scope and provides methods for looking up namespace information.
854 </remarks>
855 </member>
856 <member name="P:NAnt.Core.Element.XmlNode">
857 <summary>
858 Gets or sets the XML node of the element.
859 </summary>
860 <value>
861 The XML node of the element.
862 </value>
863 </member>
864 <member name="P:NAnt.Core.Element.Location">
865 <summary>
866 Gets or sets the location in the build file where the element is
867 defined.
868 </summary>
869 <value>
870 The location in the build file where the element is defined.
871 </value>
872 </member>
873 <member name="P:NAnt.Core.Element.CustomXmlProcessing">
874 <summary>
875 Gets a value indicating whether the element is performing additional
876 processing using the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to
877 initialize the element.
878 </summary>
879 <value>
880 <see langword="false"/>.
881 </value>
882 <remarks>
883 <para>
884 Elements that need to perform additional processing of the
885 <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize the element, should
886 override this property and return <see langword="true"/>.
887 </para>
888 <para>
889 When <see langword="true"/>, no build errors will be reported for
890 unknown nested build elements.
891 </para>
892 </remarks>
893 </member>
894 <member name="T:NAnt.Core.Element.AttributeConfigurator">
895 <summary>
896 Configures an <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using meta-data provided by
897 assigned attributes.
898 </summary>
899 </member>
900 <member name="M:NAnt.Core.Element.AttributeConfigurator.#ctor(NAnt.Core.Element,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
901 <summary>
902 Initializes a new instance of the <see cref="T:NAnt.Core.Element.AttributeConfigurator"/>
903 class for the given <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>.
904 </summary>
905 <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>
906 <param name="elementNode">The <see cref="P:NAnt.Core.Element.XmlNode"/> to initialize the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> with.</param>
907 <param name="properties">The <see cref="T:NAnt.Core.PropertyDictionary"/> to use for property expansion.</param>
908 <param name="targetFramework">The framework that the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> should target.</param>
909 <exception cref="T:System.ArgumentNullException">
910 <para><paramref name="element"/> is <see langword="null"/>.</para>
911 <para>-or-</para>
912 <para><paramref name="elementNode"/> is <see langword="null"/>.</para>
913 <para>-or-</para>
914 <para><paramref name="properties"/> is <see langword="null"/>.</para>
915 </exception>
916 </member>
917 <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateChildBuildElement(System.Reflection.PropertyInfo,System.Reflection.MethodInfo,System.Reflection.MethodInfo,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
918 <summary>
919 Creates a child <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using property set/get methods.
920 </summary>
921 <param name="propInf">The <see cref="T:System.Reflection.PropertyInfo"/> instance that represents the property of the current class.</param>
922 <param name="getter">A <see cref="T:System.Reflection.MethodInfo"/> representing the get accessor for the property.</param>
923 <param name="setter">A <see cref="T:System.Reflection.MethodInfo"/> representing the set accessor for the property.</param>
924 <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>
925 <param name="properties">The collection of property values to use for macro expansion.</param>
926 <param name="framework">The <see cref="T:NAnt.Core.FrameworkInfo"/> from which to obtain framework-specific information.</param>
927 <returns>The <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> child.</returns>
928 </member>
929 <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateAttributeSetter(System.Type)">
930 <summary>
931 Creates an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given
932 <see cref="T:System.Type"/>.
933 </summary>
934 <param name="attributeType">The <see cref="T:System.Type"/> for which an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> should be created.</param>
935 <returns>
936 An <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given <see cref="T:System.Type"/>.
937 </returns>
938 </member>
939 <member name="F:NAnt.Core.Element.AttributeConfigurator._element">
940 <summary>
941 Holds the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that should be initialized.
942 </summary>
943 </member>
944 <member name="F:NAnt.Core.Element.AttributeConfigurator._elementXml">
945 <summary>
946 Holds the <see cref="P:NAnt.Core.Element.XmlNode"/> that should be used to initialize
947 the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>.
948 </summary>
949 </member>
950 <member name="F:NAnt.Core.Element.AttributeConfigurator._properties">
951 <summary>
952 Holds the dictionary that should be used for property
953 expansion.
954 </summary>
955 </member>
956 <member name="F:NAnt.Core.Element.AttributeConfigurator._targetFramework">
957 <summary>
958 Holds the framework that should be targeted by the
959 <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that we're configuring, or
960 <see langword="null"/> if there's no current target
961 framework.
962 </summary>
963 </member>
964 <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedAttributes">
965 <summary>
966 Holds the names of the attributes that still need to be
967 processed.
968 </summary>
969 </member>
970 <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedChildNodes">
971 <summary>
972 Holds the names of the child nodes that still need to be
973 processed.
974 </summary>
975 </member>
976 <member name="F:NAnt.Core.Element.AttributeConfigurator.logger">
977 <summary>
978 Holds the logger for the current class.
979 </summary>
980 </member>
981 <member name="F:NAnt.Core.Element.AttributeConfigurator.AttributeSetters">
982 <summary>
983 Holds the cache of <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> instances.
984 </summary>
985 </member>
986 <member name="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager">
987 <summary>
988 Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
989 </summary>
990 <value>
991 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
992 </value>
993 <remarks>
994 The <see cref="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager"/> defines the current namespace
995 scope and provides methods for looking up namespace information.
996 </remarks>
997 </member>
998 <member name="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter">
999 <summary>
1000 Internal interface used for setting element attributes.
1001 </summary>
1002 </member>
1003 <member name="T:NAnt.Core.Configuration.DirList">
1004 <summary>
1005 Represents an explicitly named list of directories.
1006 </summary>
1007 <remarks>
1008 A <see cref="T:NAnt.Core.Configuration.DirList"/> is useful when you want to capture a list of
1009 directories regardless whether they currently exist.
1010 </remarks>
1011 </member>
1012 <member name="P:NAnt.Core.Configuration.DirList.Directory">
1013 <summary>
1014 The base of the directory of this dirlist. The default is the project
1015 base directory.
1016 </summary>
1017 </member>
1018 <member name="P:NAnt.Core.Configuration.ManagedExecutionMode.Environment">
1019 <summary>
1020 Gets the collection of environment variables that should be passed
1021 to external programs that are launched.
1022 </summary>
1023 <value>
1024 <summary>
1025 The collection of environment variables that should be passed
1026 to external programs that are launched.
1027 </summary>
1028 </value>
1029 </member>
1030 <member name="P:NAnt.Core.Configuration.RuntimeEngine.Arguments">
1031 <summary>
1032 The command-line arguments for the runtime engine.
1033 </summary>
1034 </member>
1035 <member name="T:NAnt.Core.Extensibility.ExtensionAssembly">
1036 <summary>
1037 Represents an <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> in which one or more extensions
1038 are found.
1039 </summary>
1040 </member>
1041 <member name="M:NAnt.Core.Extensibility.ExtensionAssembly.#ctor(System.Reflection.Assembly)">
1042 <summary>
1043 Initializes a new instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>
1044 class for a given <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/>.
1045 </summary>
1046 <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>
1047 </member>
1048 <member name="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly">
1049 <summary>
1050 Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> containing extensions.
1051 </summary>
1052 </member>
1053 <member name="M:NAnt.Core.Extensibility.ExtensionBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly)">
1054 <summary>
1055 Initializes a instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionBuilder"/>
1056 class for an extension in a given <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/>.
1057 </summary>
1058 <param name="extensionAssembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/> in which the extension is found.</param>
1059 <exception cref="T:System.ArgumentNullException"><paramref name="extensionAssembly"/> is <see langword="null"/>.</exception>
1060 </member>
1061 <member name="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly">
1062 <summary>
1063 Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/> in which the extension
1064 was found.
1065 </summary>
1066 </member>
1067 <member name="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly">
1068 <summary>
1069 Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> from which the extension will
1070 be created.
1071 </summary>
1072 <value>
1073 The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> containing the extension.
1074 </value>
1075 </member>
1076 <member name="M:NAnt.Core.Extensibility.PluginConsumerAttribute.#ctor(System.Type)">
1077 <summary>
1078 Initializes a new instance of the <see cref="T:NAnt.Core.Extensibility.PluginConsumerAttribute"/>
1079 with the specified type.
1080 </summary>
1081 <param name="type">The type of the <see cref="T:NAnt.Core.Extensibility.IPlugin"/> to consume.</param>
1082 <exception cref="T:System.ArgumentNullException"><paramref name="type"/> is <see langword="null"/>.</exception>
1083 </member>
1084 <member name="T:NAnt.Core.Extensibility.PluginScanner">
1085 <summary>
1086 Responsible for scanning types for plugins, and maintaining a cache of
1087 <see cref="T:NAnt.Core.Extensibility.PluginBuilder"/> instances.
1088 </summary>
1089 </member>
1090 <member name="M:NAnt.Core.Extensibility.PluginScanner.ScanTypeForPlugins(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
1091 <summary>
1092 Scans a given <see cref="T:System.Type"/> for plugins.
1093 </summary>
1094 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
1095 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
1096 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
1097 <returns>
1098 <see langword="true"/> if <paramref name="type"/> represents a
1099 <see cref="T:NAnt.Core.Extensibility.IPlugin"/>; otherwise, <see langword="false"/>.
1100 </returns>
1101 </member>
1102 <member name="M:NAnt.Core.Extensibility.PluginScanner.RegisterPlugins(NAnt.Core.Extensibility.IPluginConsumer)">
1103 <summary>
1104 Registers matching plugins for the specified <see cref="T:NAnt.Core.Extensibility.IPluginConsumer"/>.
1105 </summary>
1106 <param name="consumer">The <see cref="T:NAnt.Core.Extensibility.IPluginConsumer"/> which plugins must be registered for.</param>
1107 <exception cref="T:System.ArgumentNullException"><paramref name="consumer"/> is <see langword="null"/>.</exception>
1108 </member>
1109 <member name="T:NAnt.Core.Filters.ChainableReader">
1110 <summary>
1111 Functions as a chainable TextReader
1112 </summary>
1113 <remarks>
1114 Implements a abstraction over a TextReader that allows the class to represent
1115 either a TextReader or another ChainableReader to which it is chained.
1116 By passing a ChainableReader as a constructor paramater it is possiable to
1117 chain many ChainableReaders together. The last ChainableReader in the chain must
1118 be based on a TextReader.
1119 </remarks>
1120 </member>
1121 <member name="M:NAnt.Core.Filters.ChainableReader.Chain(NAnt.Core.Filters.ChainableReader)">
1122 <summary>
1123 Makes it so all calls to Read and Peek are passed the ChainableReader
1124 passed as a parameter.
1125 </summary>
1126 <param name="parentChainedReader">ChainableReader to forward calls to</param>
1127 </member>
1128 <member name="M:NAnt.Core.Filters.ChainableReader.Chain(System.IO.TextReader)">
1129 <summary>
1130 Makes it so all calls to Read and Peek are passed the TextReader
1131 passed as a parameter.
1132 </summary>
1133 <param name="baseReader">TextReader to forward calls to</param>
1134 </member>
1135 <member name="M:NAnt.Core.Filters.ChainableReader.Peek">
1136 <summary>
1137 Forwards Peek calls to the TextReader or ChainableReader passed in the corresponding constructor.
1138 </summary>
1139 <returns>Character or -1 if end of stream</returns>
1140 </member>
1141 <member name="M:NAnt.Core.Filters.ChainableReader.Read">
1142 <summary>
1143 Forwards Read calls to the TextReader or ChainableReader passed in the corresponding constructor.
1144 </summary>
1145 <returns>
1146 Character or -1 if end of stream.
1147 </returns>
1148 </member>
1149 <member name="M:NAnt.Core.Filters.ChainableReader.Close">
1150 <summary>
1151 Closes the reader.
1152 </summary>
1153 </member>
1154 <member name="M:NAnt.Core.Filters.ChainableReader.Dispose">
1155 <summary>
1156 Calls close and supresses the finalizer for the object.
1157 </summary>
1158 </member>
1159 <member name="P:NAnt.Core.Filters.ChainableReader.Base">
1160 <summary>
1161 Gets a value indicating if the reader is backed by a stream in the
1162 chain.
1163 </summary>
1164 <value>
1165 <see langword="true" /> if the reader is backed by a stream;
1166 otherwise, <see langword="false" />.
1167 </value>
1168 </member>
1169 <member name="T:NAnt.Core.Filters.Filter">
1170 <summary>
1171 Allows a file's content to be modified while performing an operation.
1172 </summary>
1173 </member>
1174 <member name="M:NAnt.Core.Filters.Filter.InitializeFilter">
1175 <summary>
1176 Called after construction and after properties are set. Allows
1177 for filter initialization.
1178 </summary>
1179 </member>
1180 <member name="P:NAnt.Core.Filters.Filter.IfDefined">
1181 <summary>
1182 If <see langword="true" /> then the filter will be used; otherwise,
1183 skipped. The default is <see langword="true" />.
1184 </summary>
1185 </member>
1186 <member name="P:NAnt.Core.Filters.Filter.UnlessDefined">
1187 <summary>
1188 Opposite of <see cref="P:NAnt.Core.Filters.Filter.IfDefined"/>. If <see langword="false"/>
1189 then the filter will be executed; otherwise, skipped. The default
1190 is <see langword="false"/>.
1191 </summary>
1192 </member>
1193 <member name="M:NAnt.Core.Filters.FilterBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
1194 <summary>
1195 Creates a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> class
1196 for the specified <see cref="T:NAnt.Core.Filters.Filter"/> class in the specified
1197 <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.
1198 </summary>
1199 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
1200 <param name="className">The class representing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
1201 </member>
1202 <member name="P:NAnt.Core.Filters.FilterBuilder.ClassName">
1203 <summary>
1204 Gets the name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created
1205 using this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>.
1206 </summary>
1207 <value>
1208 The name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created using
1209 this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>.
1210 </value>
1211 </member>
1212 <member name="P:NAnt.Core.Filters.FilterBuilder.FilterName">
1213 <summary>
1214 Gets the name of the filter which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/>
1215 can create.
1216 </summary>
1217 <value>
1218 The name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/> can
1219 create.
1220 </value>
1221 </member>
1222 <member name="T:NAnt.Core.Filters.FilterBuilderCollection">
1223 <summary>
1224 Contains a strongly typed collection of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> objects.
1225 </summary>
1226 </member>
1227 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor">
1228 <summary>
1229 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class.
1230 </summary>
1231 </member>
1232 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilderCollection)">
1233 <summary>
1234 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class
1235 with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> instance.
1236 </summary>
1237 </member>
1238 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilder[])">
1239 <summary>
1240 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class
1241 with the specified array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
1242 </summary>
1243 </member>
1244 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Add(NAnt.Core.Filters.FilterBuilder)">
1245 <summary>
1246 Adds a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to the end of the collection.
1247 </summary>
1248 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to be added to the end of the collection.</param>
1249 <returns>The position into which the new element was inserted.</returns>
1250 </member>
1251 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilder[])">
1252 <summary>
1253 Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> array to the end of the collection.
1254 </summary>
1255 <param name="items">The array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements to be added to the end of the collection.</param>
1256 </member>
1257 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilderCollection)">
1258 <summary>
1259 Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to the end of the collection.
1260 </summary>
1261 <param name="items">The <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to be added to the end of the collection.</param>
1262 </member>
1263 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(NAnt.Core.Filters.FilterBuilder)">
1264 <summary>
1265 Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> is in the collection.
1266 </summary>
1267 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to locate in the collection.</param>
1268 <returns>
1269 <see langword="true"/> if <paramref name="item"/> is found in the
1270 collection; otherwise, <see langword="false"/>.
1271 </returns>
1272 </member>
1273 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(System.String)">
1274 <summary>
1275 Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified
1276 task is in the collection.
1277 </summary>
1278 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> should be located in the collection.</param>
1279 <returns>
1280 <see langword="true"/> if a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for
1281 the specified task is found in the collection; otherwise,
1282 <see langword="false"/>.
1283 </returns>
1284 </member>
1285 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.CopyTo(NAnt.Core.Filters.FilterBuilder[],System.Int32)">
1286 <summary>
1287 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
1288 </summary>
1289 <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>
1290 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
1291 </member>
1292 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.IndexOf(NAnt.Core.Filters.FilterBuilder)">
1293 <summary>
1294 Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object in the collection.
1295 </summary>
1296 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object for which the index is returned.</param>
1297 <returns>
1298 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.
1299 </returns>
1300 </member>
1301 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Insert(System.Int32,NAnt.Core.Filters.FilterBuilder)">
1302 <summary>
1303 Inserts a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> into the collection at the specified index.
1304 </summary>
1305 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
1306 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to insert.</param>
1307 </member>
1308 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.GetEnumerator">
1309 <summary>
1310 Returns an enumerator that can iterate through the collection.
1311 </summary>
1312 <returns>
1313 A <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> for the entire collection.
1314 </returns>
1315 </member>
1316 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Remove(NAnt.Core.Filters.FilterBuilder)">
1317 <summary>
1318 Removes a member from the collection.
1319 </summary>
1320 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to remove from the collection.</param>
1321 </member>
1322 <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.Int32)">
1323 <summary>
1324 Gets or sets the element at the specified index.
1325 </summary>
1326 <param name="index">The zero-based index of the element to get or set.</param>
1327 </member>
1328 <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.String)">
1329 <summary>
1330 Gets the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified task.
1331 </summary>
1332 <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>
1333 </member>
1334 <member name="T:NAnt.Core.Filters.FilterBuilderEnumerator">
1335 <summary>
1336 Enumerates the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>.
1337 </summary>
1338 </member>
1339 <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.#ctor(NAnt.Core.Filters.FilterBuilderCollection)">
1340 <summary>
1341 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> class
1342 with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>.
1343 </summary>
1344 <param name="arguments">The collection that should be enumerated.</param>
1345 </member>
1346 <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.MoveNext">
1347 <summary>
1348 Advances the enumerator to the next element of the collection.
1349 </summary>
1350 <returns>
1351 <see langword="true" /> if the enumerator was successfully advanced
1352 to the next element; <see langword="false" /> if the enumerator has
1353 passed the end of the collection.
1354 </returns>
1355 </member>
1356 <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.Reset">
1357 <summary>
1358 Sets the enumerator to its initial position, which is before the
1359 first element in the collection.
1360 </summary>
1361 </member>
1362 <member name="P:NAnt.Core.Filters.FilterBuilderEnumerator.Current">
1363 <summary>
1364 Gets the current element in the collection.
1365 </summary>
1366 <returns>
1367 The current element in the collection.
1368 </returns>
1369 </member>
1370 <member name="T:NAnt.Core.Filters.FilterChain">
1371 <summary>
1372 Represent a chain of NAnt filters that can be applied to a <see cref="T:NAnt.Core.Task"/>.
1373 </summary>
1374 <remarks>
1375 <para>
1376 A FilterChain represents a collection of one or more filters that can
1377 be appled to a <see cref="T:NAnt.Core.Task"/> such as the <see cref="T:NAnt.Core.Tasks.CopyTask"/>.
1378 In the case of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>, the contents of the copied
1379 files are filtered through each filter specified in the filter chain.
1380 Filtering occurs in the order the filters are specified with filtered
1381 output of one filter feeding into another.
1382 </para>
1383 <para>
1384 :--------:--->:----------:--->:----------: ... :----------:--->:--------:<br/>
1385 :.Source.:--->:.Filter 1.:--->:.Filter 2.: ... :.Filter n.:--->:.target.:<br/>
1386 :--------:--->:----------:--->:----------: ... :----------:--->:--------:<br/>
1387 </para>
1388 <para>
1389 A list of all filters that come with NAnt is available <see href="../filters/index.html">here</see>.
1390 </para>
1391 <para>
1392 The following tasks support filtering with a FilterChain:
1393 </para>
1394 <list type="bullet">
1395 <item>
1396 <description><see cref="T:NAnt.Core.Tasks.CopyTask"/></description>
1397 </item>
1398 <item>
1399 <description><see cref="T:NAnt.Core.Tasks.MoveTask"/></description>
1400 </item>
1401 </list>
1402 </remarks>
1403 <example>
1404 <para>
1405 Replace all occurrences of @NOW@ with the current date/time and
1406 replace tabs with spaces in all copied files.
1407 </para>
1408 <code>
1409 <![CDATA[
1410 <property name="NOW" value="${datetime::now()}" />
1411 <copy todir="out">
1412 <fileset basedir="in">
1413 <include name="**/*" />
1414 </fileset>
1415 <filterchain>
1416 <replacetokens>
1417 <token key="NOW" value="${TODAY}" />
1418 </replacetokens>
1419 <tabstospaces />
1420 </filterchain>
1421 </copy>
1422 ]]>
1423 </code>
1424 </example>
1425 </member>
1426 <member name="T:NAnt.Core.DataTypeBase">
1427 <summary>
1428 Provides the abstract base class for types.
1429 </summary>
1430 </member>
1431 <member name="M:NAnt.Core.DataTypeBase.Reset">
1432 <summary>
1433 Should be overridden by derived classes. clones the referenced types
1434 data into the current instance.
1435 </summary>
1436 </member>
1437 <member name="M:NAnt.Core.DataTypeBase.CopyTo(NAnt.Core.DataTypeBase)">
1438 <summary>
1439 Copies all instance data of the <see cref="T:NAnt.Core.DataTypeBase"/> to a given
1440 <see cref="T:NAnt.Core.DataTypeBase"/>.
1441 </summary>
1442 </member>
1443 <member name="P:NAnt.Core.DataTypeBase.ID">
1444 <summary>
1445 The ID used to be referenced later.
1446 </summary>
1447 </member>
1448 <member name="P:NAnt.Core.DataTypeBase.RefID">
1449 <summary>
1450 The ID to use as the reference.
1451 </summary>
1452 </member>
1453 <member name="P:NAnt.Core.DataTypeBase.CanBeReferenced">
1454 <summary>
1455 Gets a value indicating whether a reference to the type can be
1456 defined.
1457 </summary>
1458 <remarks>
1459 Only types with an <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned
1460 to it, can be referenced.
1461 </remarks>
1462 </member>
1463 <member name="P:NAnt.Core.DataTypeBase.Name">
1464 <summary>
1465 Gets the name of the datatype.
1466 </summary>
1467 <value>
1468 The name of the datatype.
1469 </value>
1470 </member>
1471 <member name="M:NAnt.Core.Filters.FilterChain.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
1472 <summary>
1473 Initializes all build attributes and child elements.
1474 </summary>
1475 <remarks>
1476 <see cref="T:NAnt.Core.Filters.FilterChain"/> needs to maintain the order in which the
1477 filters are specified in the build file.
1478 </remarks>
1479 </member>
1480 <member name="M:NAnt.Core.Filters.FilterChain.GetBaseFilter(NAnt.Core.Filters.PhysicalTextReader)">
1481 <summary>
1482 Used to to instantiate and return the chain of stream based filters.
1483 </summary>
1484 <param name="physicalTextReader">The <see cref="T:NAnt.Core.Filters.PhysicalTextReader"/> that is the source of input to the filter chain.</param>
1485 <remarks>
1486 The <paramref name="physicalTextReader"/> is the first <see cref="T:NAnt.Core.Filters.Filter"/>
1487 in the chain, which is based on a physical stream that feeds the chain.
1488 </remarks>
1489 <returns>
1490 The last <see cref="T:NAnt.Core.Filters.Filter"/> in the chain.
1491 </returns>
1492 </member>
1493 <member name="P:NAnt.Core.Filters.FilterChain.Filters">
1494 <summary>
1495 The filters to apply.
1496 </summary>
1497 </member>
1498 <member name="P:NAnt.Core.Filters.FilterChain.InputEncoding">
1499 <summary>
1500 The encoding to assume when filter-copying files. The default is
1501 system's current ANSI code page.
1502 </summary>
1503 </member>
1504 <member name="T:NAnt.Core.Filters.FilterChain.FilterChainConfigurator">
1505 <summary>
1506 Configurator that initializes filters in the order in which they've
1507 been specified in the build file.
1508 </summary>
1509 </member>
1510 <member name="T:NAnt.Core.Filters.FilterCollection">
1511 <summary>
1512 Contains a collection of <see cref="T:NAnt.Core.Filters.Filter"/> elements.
1513 </summary>
1514 </member>
1515 <member name="M:NAnt.Core.Filters.FilterCollection.#ctor">
1516 <summary>
1517 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class.
1518 </summary>
1519 </member>
1520 <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.FilterCollection)">
1521 <summary>
1522 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class
1523 with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/> instance.
1524 </summary>
1525 </member>
1526 <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.Filter[])">
1527 <summary>
1528 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class
1529 with the specified array of <see cref="T:NAnt.Core.Filters.Filter"/> instances.
1530 </summary>
1531 </member>
1532 <member name="M:NAnt.Core.Filters.FilterCollection.Add(NAnt.Core.Filters.Filter)">
1533 <summary>
1534 Adds a <see cref="T:NAnt.Core.Filters.Filter"/> to the end of the collection.
1535 </summary>
1536 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to be added to the end of the collection.</param>
1537 <returns>The position into which the new element was inserted.</returns>
1538 </member>
1539 <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.Filter[])">
1540 <summary>
1541 Adds the elements of a <see cref="T:NAnt.Core.Filters.Filter"/> array to the end of the collection.
1542 </summary>
1543 <param name="items">The array of <see cref="T:NAnt.Core.Filters.Filter"/> elements to be added to the end of the collection.</param>
1544 </member>
1545 <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.FilterCollection)">
1546 <summary>
1547 Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/> to the end of the collection.
1548 </summary>
1549 <param name="items">The <see cref="T:NAnt.Core.Filters.FilterCollection"/> to be added to the end of the collection.</param>
1550 </member>
1551 <member name="M:NAnt.Core.Filters.FilterCollection.Contains(NAnt.Core.Filters.Filter)">
1552 <summary>
1553 Determines whether a <see cref="T:NAnt.Core.Filters.Filter"/> is in the collection.
1554 </summary>
1555 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to locate in the collection.</param>
1556 <returns>
1557 <see langword="true"/> if <paramref name="item"/> is found in the
1558 collection; otherwise, <see langword="false"/>.
1559 </returns>
1560 </member>
1561 <member name="M:NAnt.Core.Filters.FilterCollection.CopyTo(NAnt.Core.Filters.Filter[],System.Int32)">
1562 <summary>
1563 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
1564 </summary>
1565 <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>
1566 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
1567 </member>
1568 <member name="M:NAnt.Core.Filters.FilterCollection.IndexOf(NAnt.Core.Filters.Filter)">
1569 <summary>
1570 Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.Filter"/> object in the collection.
1571 </summary>
1572 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> object for which the index is returned.</param>
1573 <returns>
1574 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.
1575 </returns>
1576 </member>
1577 <member name="M:NAnt.Core.Filters.FilterCollection.Insert(System.Int32,NAnt.Core.Filters.Filter)">
1578 <summary>
1579 Inserts a <see cref="T:NAnt.Core.Filters.Filter"/> into the collection at the specified index.
1580 </summary>
1581 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
1582 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to insert.</param>
1583 </member>
1584 <member name="M:NAnt.Core.Filters.FilterCollection.GetEnumerator">
1585 <summary>
1586 Returns an enumerator that can iterate through the collection.
1587 </summary>
1588 <returns>
1589 A <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> for the entire collection.
1590 </returns>
1591 </member>
1592 <member name="M:NAnt.Core.Filters.FilterCollection.Remove(NAnt.Core.Filters.Filter)">
1593 <summary>
1594 Removes a member from the collection.
1595 </summary>
1596 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to remove from the collection.</param>
1597 </member>
1598 <member name="P:NAnt.Core.Filters.FilterCollection.Item(System.Int32)">
1599 <summary>
1600 Gets or sets the element at the specified index.
1601 </summary>
1602 <param name="index">The zero-based index of the element to get or set.</param>
1603 </member>
1604 <member name="T:NAnt.Core.Filters.FilterEnumerator">
1605 <summary>
1606 Enumerates the <see cref="T:NAnt.Core.Filters.Filter"/> elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/>.
1607 </summary>
1608 </member>
1609 <member name="M:NAnt.Core.Filters.FilterEnumerator.#ctor(NAnt.Core.Filters.FilterCollection)">
1610 <summary>
1611 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> class
1612 with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/>.
1613 </summary>
1614 <param name="arguments">The collection that should be enumerated.</param>
1615 </member>
1616 <member name="M:NAnt.Core.Filters.FilterEnumerator.MoveNext">
1617 <summary>
1618 Advances the enumerator to the next element of the collection.
1619 </summary>
1620 <returns>
1621 <see langword="true" /> if the enumerator was successfully advanced
1622 to the next element; <see langword="false" /> if the enumerator has
1623 passed the end of the collection.
1624 </returns>
1625 </member>
1626 <member name="M:NAnt.Core.Filters.FilterEnumerator.Reset">
1627 <summary>
1628 Sets the enumerator to its initial position, which is before the
1629 first element in the collection.
1630 </summary>
1631 </member>
1632 <member name="P:NAnt.Core.Filters.FilterEnumerator.Current">
1633 <summary>
1634 Gets the current element in the collection.
1635 </summary>
1636 <returns>
1637 The current element in the collection.
1638 </returns>
1639 </member>
1640 <member name="T:NAnt.Core.Filters.PhysicalTextReader">
1641 <summary>
1642 Represents a physical <see cref="T:System.IO.TextReader"/>. That is a reader based
1643 on a stream.
1644 </summary>
1645 <remarks>
1646 Used by <see cref="T:NAnt.Core.Filters.ChainableReader"/> to represent a <see cref="T:NAnt.Core.Filters.Filter"/>
1647 based on a <see cref="T:System.IO.TextReader"/> in the chain.
1648 </remarks>
1649 </member>
1650 <member name="T:NAnt.Core.Filters.ExpandProperties">
1651 <summary>
1652 Parses NAnt properties and expressions
1653 </summary>
1654 <remarks>
1655 <para>
1656 This filter parses any NAnt properties or expressions found in its input,
1657 inlining their values in its output.
1658 </para>
1659 <para>
1660 Note: Due to limitations on buffering, expressions longer than 2048
1661 characters are not guaranteed to be expanded.
1662 </para>
1663 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
1664 </remarks>
1665 <example>
1666 <para>Replace all properties with their corresponding values.</para>
1667 <code>
1668 <![CDATA[
1669 <expandproperties />
1670 ]]>
1671 </code>
1672 </example>
1673 </member>
1674 <member name="F:NAnt.Core.Filters.ExpandProperties._buffer">
1675 <summary>
1676 Holds data for expression expansion between input and output.
1677 </summary>
1678 </member>
1679 <member name="M:NAnt.Core.Filters.ExpandProperties.InitializeFilter">
1680 <summary>
1681 Called after construction and after properties are set. Allows
1682 for filter initialization.
1683 </summary>
1684 </member>
1685 <member name="M:NAnt.Core.Filters.ExpandProperties.Read">
1686 <summary>
1687 Reads the next character applying the filter logic.
1688 </summary>
1689 <returns>Char as an int or -1 if at the end of the stream</returns>
1690 </member>
1691 <member name="M:NAnt.Core.Filters.ExpandProperties.Peek">
1692 <summary>
1693 Reads the next character applying the filter logic without advancing the current position in the stream.
1694 </summary>
1695 <returns>Char as an int or -1 if at the end of the stream</returns>
1696 </member>
1697 <member name="M:NAnt.Core.Filters.ExpandProperties.Advance">
1698 <summary>
1699 Moves to the next character.
1700 </summary>
1701 </member>
1702 <member name="M:NAnt.Core.Filters.ExpandProperties.ReplenishBuffer">
1703 <summary>
1704 Refills the buffer, running our input through
1705 <see cref="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location)"/>.)
1706 </summary>
1707 </member>
1708 <member name="P:NAnt.Core.Filters.ExpandProperties.AtEnd">
1709 <summary>
1710 Determines whether we've passed the end of our data.
1711 </summary>
1712 </member>
1713 <member name="T:NAnt.Core.Filters.ReplaceString">
1714 <summary>
1715 Replaces all occurrences of a given string in the original input with
1716 user-supplied replacement string.
1717 </summary>
1718 <remarks>
1719 <para>
1720 This filter replaces all occurrences of a given string in the original
1721 input stream with a user-supplied replacement string. By default string
1722 comparisons are case sensitive but this can be changed by setting the
1723 optional <see cref="P:NAnt.Core.Filters.ReplaceString.IgnoreCase"/> attribute to <see langword="true"/>.
1724 </para>
1725 <para>
1726 To use this filter specify the string to be replaced with the
1727 <see cref="P:NAnt.Core.Filters.ReplaceString.From"/> attribute and the string to replace it with using the
1728 <see cref="P:NAnt.Core.Filters.ReplaceString.To"/> attribute.
1729 </para>
1730 <para>
1731 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
1732 </para>
1733 </remarks>
1734 <example>
1735 <para>
1736 Replace all occurrences of "3.14" with "PI".
1737 </para>
1738 <code>
1739 <![CDATA[
1740 <replacestring from="3.14" to="PI" />
1741 ]]>
1742 </code>
1743 </example>
1744 <example>
1745 <para>
1746 Replace all occurrences of "string", "String", etc. with "System.String".
1747 </para>
1748 <code>
1749 <![CDATA[
1750 <replacestring from="String" to="System.String" ignorecase="true" />
1751 ]]>
1752 </code>
1753 </example>
1754 </member>
1755 <member name="M:NAnt.Core.Filters.ReplaceString.Chain(NAnt.Core.Filters.ChainableReader)">
1756 <summary>
1757 Construct that allows this filter to be chained to the one
1758 in the parameter chainedReader.
1759 </summary>
1760 <param name="chainedReader">Filter that the filter will be chained to</param>
1761 </member>
1762 <member name="M:NAnt.Core.Filters.ReplaceString.Read">
1763 <summary>
1764 Reads the next character applying the filter logic.
1765 </summary>
1766 <returns>Char as an int or -1 if at the end of the stream</returns>
1767 </member>
1768 <member name="M:NAnt.Core.Filters.ReplaceString.Peek">
1769 <summary>
1770 Reads the next character applying the filter logic without
1771 advancing the current position in the stream.
1772 Peek currently is not supported.
1773 </summary>
1774 <returns>
1775 Char as an int or -1 if at the end of the stream.
1776 </returns>
1777 </member>
1778 <member name="M:NAnt.Core.Filters.ReplaceString.FindString(System.Int32,System.Boolean@,System.String@)">
1779 <summary>
1780 <para>
1781 Helper function used to search for the filter's traget string. If the string
1782 is found the result is true. If the string was not found false is returned and
1783 nonMatchingChars contains the characters that were read to determine if the
1784 string is present.
1785 </para>
1786
1787 <para>
1788 It is assumed the stream is positioned at the character after the first character
1789 in the target string.
1790 </para>
1791 </summary>
1792 <param name="startChar">First character in target string</param>
1793 <param name="streamEnded">Ture if the stream ended while search for the string.</param>
1794 <param name="nonMatchingChars">Characters that were read while searching for the string.</param>
1795 <returns></returns>
1796 </member>
1797 <member name="M:NAnt.Core.Filters.ReplaceString.GetNextCharacter(NAnt.Core.Filters.ReplaceString.AcquireCharDelegate)">
1798 <summary>
1799 Returns the next character in the stream replacing the specified character. Using the
1800 <see cref="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
1801 </summary>
1802 <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
1803 <returns>Char as an int or -1 if at the end of the stream</returns>
1804 </member>
1805 <member name="M:NAnt.Core.Filters.ReplaceString.CompareCharacters(System.Int32,System.Int32)">
1806 <summary>
1807 Compares to characters taking into account the _ignoreCase flag.
1808 </summary>
1809 <param name="char1"></param>
1810 <param name="char2"></param>
1811 <returns></returns>
1812 </member>
1813 <member name="P:NAnt.Core.Filters.ReplaceString.From">
1814 <summary>
1815 The string to be replaced.
1816 </summary>
1817 </member>
1818 <member name="P:NAnt.Core.Filters.ReplaceString.To">
1819 <summary>
1820 The new value for the replaced string.
1821 Am empty string is permissible.
1822 </summary>
1823 </member>
1824 <member name="P:NAnt.Core.Filters.ReplaceString.IgnoreCase">
1825 <summary>
1826 Determines if case will be ignored.
1827 The default is <see langword="false" />.
1828 </summary>
1829 </member>
1830 <member name="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate">
1831 <summary>
1832 Delegate for Read and Peek. Allows the same implementation
1833 to be used for both methods.
1834 </summary>
1835 </member>
1836 <member name="T:NAnt.Core.Filters.ReplaceTokens">
1837 <summary>
1838 Replaces tokens in the original input with user-supplied values.
1839 </summary>
1840 <remarks>
1841 <para>
1842 This filter replaces all token surrounded by a beginning and ending
1843 token. The default beginning and ending tokens both default to '@'. The
1844 optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.BeginToken"/> and <see cref="P:NAnt.Core.Filters.ReplaceTokens.EndToken"/> attributes
1845 can be specified to change either token. By default string
1846 comparisons are case sensitive but this can be changed by setting the
1847 optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> attribute to <see langword="true"/>.
1848 </para>
1849 <para>
1850 Tokens are specified by using the <see cref="T:NAnt.Core.Types.Token"/> element. It is
1851 possible to specify from 1 to n tokens and replacement values. Values can
1852 be any valid NAnt expression.
1853 </para>
1854 <para>
1855 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
1856 </para>
1857 </remarks>
1858 <example>
1859 <para>
1860 Replace all occurrences of the string @DATE@ with the value of property
1861 "TODAY".
1862 </para>
1863 <code>
1864 <![CDATA[
1865 <replacetokens>
1866 <token key="DATE" value="${TODAY}" />
1867 </replacetokens>
1868 ]]>
1869 </code>
1870 </example>
1871 <example>
1872 <para>
1873 Replace all occurrences of the string <DATE> with the value of
1874 property "TODAY".
1875 </para>
1876 <code>
1877 <![CDATA[
1878 <replacetokens begintoken="<" endtoken=">">
1879 <token key="DATE" value="${TODAY}" />
1880 </replacetokens>
1881 ]]>
1882 </code>
1883 </example>
1884 </member>
1885 <member name="M:NAnt.Core.Filters.ReplaceTokens.Chain(NAnt.Core.Filters.ChainableReader)">
1886 <summary>
1887 Construct that allows this filter to be chained to the one
1888 in the parameter chainedReader.
1889 </summary>
1890 <param name="chainedReader">Filter that the filter will be chained to</param>
1891 </member>
1892 <member name="M:NAnt.Core.Filters.ReplaceTokens.Read">
1893 <summary>
1894 Reads the next character applying the filter logic.
1895 </summary>
1896 <returns>Char as an int or -1 if at the end of the stream</returns>
1897 </member>
1898 <member name="M:NAnt.Core.Filters.ReplaceTokens.Peek">
1899 <summary>
1900 Reads the next character applying the filter logic without
1901 advancing the current position in the stream.
1902 Peek currently is not supported.
1903 </summary>
1904 <returns>
1905 Char as an int or -1 if at the end of the stream.
1906 </returns>
1907 </member>
1908 <member name="M:NAnt.Core.Filters.ReplaceTokens.Initialize">
1909 <summary>
1910 Initialize the filter by setting its parameters.
1911 </summary>
1912 </member>
1913 <member name="M:NAnt.Core.Filters.ReplaceTokens.FindTokenContents(System.Boolean@,System.Boolean@,System.Boolean@)">
1914 <summary>
1915 Finds a token give that we are positioned at a beginning token character. Either a
1916 token replacement is returned or the characters that were read looking for the token.
1917 </summary>
1918 <param name="tokenNotFound">A token was not found</param>
1919 <param name="unknownToken">A token was found by there is no replacement</param>
1920 <param name="streamEnded">The stream ended while looking for the token</param>
1921 <returns>Either the replacement token or the characters that were read looking for the token</returns>
1922 </member>
1923 <member name="M:NAnt.Core.Filters.ReplaceTokens.GetNextCharacter(NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate)">
1924 <summary>
1925 Returns the next character in the stream replacing the specified character. Using the
1926 <see cref="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
1927 </summary>
1928 <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
1929 <returns>Char as an int or -1 if at the end of the stream</returns>
1930 </member>
1931 <member name="M:NAnt.Core.Filters.ReplaceTokens.CompareCharacters(System.Int32,System.Int32)">
1932 <summary>
1933 Compares to characters taking <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> into account.
1934 </summary>
1935 <param name="char1"></param>
1936 <param name="char2"></param>
1937 <returns>
1938 </returns>
1939 </member>
1940 <member name="P:NAnt.Core.Filters.ReplaceTokens.BeginToken">
1941 <summary>
1942 Marks the beginning of a token. The default is "@".
1943 </summary>
1944 </member>
1945 <member name="P:NAnt.Core.Filters.ReplaceTokens.EndToken">
1946 <summary>
1947 Marks the end of a token. The default is "@".
1948 </summary>
1949 </member>
1950 <member name="P:NAnt.Core.Filters.ReplaceTokens.Tokens">
1951 <summary>
1952 Tokens and replacement values.
1953 </summary>
1954 </member>
1955 <member name="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase">
1956 <summary>
1957 Determines if case will be ignored.
1958 The default is <see langword="false" />.
1959 </summary>
1960 </member>
1961 <member name="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate">
1962 <summary>
1963 Delegate for Read and Peek. Allows the same implementation
1964 to be used for both methods.
1965 </summary>
1966 </member>
1967 <member name="T:NAnt.Core.Filters.TabsToSpaces">
1968 <summary>
1969 Converts tabs to spaces.
1970 </summary>
1971 <remarks>
1972 <para>
1973 The <see cref="T:NAnt.Core.Filters.TabsToSpaces"/> filter replaces tabs in a text file
1974 with spaces.
1975 </para>
1976 <para>
1977 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
1978 </para>
1979 </remarks>
1980 <example>
1981 <para>Replace all tabs with four spaces.</para>
1982 <code>
1983 <![CDATA[
1984 <tabtospaces tablength="4" />
1985 ]]>
1986 </code>
1987 </example>
1988 </member>
1989 <member name="M:NAnt.Core.Filters.TabsToSpaces.Chain(NAnt.Core.Filters.ChainableReader)">
1990 <summary>
1991 Construct that allows this filter to be chained to the one
1992 in the parameter chainedReader.
1993 </summary>
1994 <param name="chainedReader">Filter that the filter will be chained to</param>
1995 </member>
1996 <member name="M:NAnt.Core.Filters.TabsToSpaces.Peek">
1997 <summary>
1998 <para>Retrieves the next character with moving the position in the stream.</para>
1999 <note>This method is not implemented</note>
2000 </summary>
2001 <returns>-1 if end of stream otherwise a character</returns>
2002 </member>
2003 <member name="M:NAnt.Core.Filters.TabsToSpaces.Read">
2004 <summary>
2005 <para>Retrieves the next character in the stream.</para>
2006 </summary>
2007 <returns>-1 if end of stream otherwise a character</returns>
2008 </member>
2009 <member name="M:NAnt.Core.Filters.TabsToSpaces.GetNextCharacter(NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate)">
2010 <summary>
2011 Returns the next character in the stream replacing the specified character. Using the
2012 <see cref="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
2013 </summary>
2014 <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
2015 <returns>Char as an int or -1 if at the end of the stream</returns>
2016 </member>
2017 <member name="P:NAnt.Core.Filters.TabsToSpaces.TabLength">
2018 <summary>
2019 The number of spaces used when converting a tab. The default is
2020 "8".
2021 </summary>
2022 </member>
2023 <member name="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate">
2024 <summary>
2025 Delegate for Read and Peek. Allows the same implementation
2026 to be used for both methods.
2027 </summary>
2028 </member>
2029 <member name="T:NAnt.Core.Functions.AssemblyFunctions">
2030 <summary>
2031 Functions to return information for a given assembly.
2032 </summary>
2033 </member>
2034 <member name="P:NAnt.Core.FunctionSetBase.Project">
2035 <summary>
2036 Gets or sets the <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will
2037 reference.
2038 </summary>
2039 <value>
2040 The <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will reference.
2041 </value>
2042 </member>
2043 <member name="M:NAnt.Core.Functions.AssemblyFunctions.LoadFromFile(System.String)">
2044 <summary>
2045 Loads an assembly given its file name or path.
2046 </summary>
2047 <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
2048 <returns>
2049 The loaded assembly.
2050 </returns>
2051 <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
2052 <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>
2053 <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception>
2054 <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>
2055 </member>
2056 <member name="M:NAnt.Core.Functions.AssemblyFunctions.Load(System.String)">
2057 <summary>
2058 Loads an assembly given the long form of its name.
2059 </summary>
2060 <param name="assemblyString">The long form of the assembly name.</param>
2061 <returns>
2062 The loaded assembly.
2063 </returns>
2064 <exception cref="T:System.ArgumentNullException"><paramref name="assemblyString"/> is a <see langword="null"/>.</exception>
2065 <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyString"/> is not found.</exception>
2066 <example>
2067 <para>
2068 Determine the location of the Microsoft Access 11 Primary Interop
2069 Assembly by loading it using its fully qualified name, and copy it
2070 to the build directory.
2071 </para>
2072 <code>
2073 <![CDATA[
2074 <property name="access.pia.path" value="${assembly::get-location(assembly::load('Microsoft.Office.Interop.Access, Version=11.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c'))}" />
2075 <copy file="${access.pia.path}" todir="${build.dir}" />
2076 ]]>
2077 </code>
2078 </example>
2079 </member>
2080 <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetFullName(System.Reflection.Assembly)">
2081 <summary>
2082 Gets the full name of the assembly, also known as the display name.
2083 </summary>
2084 <param name="assembly">The assembly to get the full name for.</param>
2085 <returns>
2086 The full name of the assembly, also known as the display name.
2087 </returns>
2088 </member>
2089 <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)">
2090 <summary>
2091 Gets an <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly.
2092 </summary>
2093 <param name="assembly">The assembly to get an <see cref="T:System.Reflection.AssemblyName"/> for.</param>
2094 <returns>
2095 An <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly.
2096 </returns>
2097 <seealso cref="T:NAnt.Core.Functions.AssemblyNameFunctions"/>
2098 </member>
2099 <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetLocation(System.Reflection.Assembly)">
2100 <summary>
2101 Gets the physical location, in codebase format, of the loaded file
2102 that contains the manifest.
2103 </summary>
2104 <param name="assembly">The assembly to get the location for.</param>
2105 <returns>
2106 The location of the specified assembly.
2107 </returns>
2108 </member>
2109 <member name="T:NAnt.Core.Functions.AssemblyNameFunctions">
2110 <summary>
2111 Functions that return information about an assembly's identity.
2112 </summary>
2113 </member>
2114 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetCodeBase(System.Reflection.AssemblyName)">
2115 <summary>
2116 Gets the location of the assembly as a URL.
2117 </summary>
2118 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2119 <returns>
2120 The location of the assembly as a URL.
2121 </returns>
2122 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2123 </member>
2124 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetEscapedCodeBase(System.Reflection.AssemblyName)">
2125 <summary>
2126 Gets the URI, including escape characters, that represents the codebase.
2127 </summary>
2128 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2129 <returns>
2130 The URI, including escape characters, that represents the codebase.
2131 </returns>
2132 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2133 </member>
2134 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetFullName(System.Reflection.AssemblyName)">
2135 <summary>
2136 Gets the full name of the assembly, also known as the display name.
2137 </summary>
2138 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2139 <returns>
2140 The full name of the assembly, also known as the display name.
2141 </returns>
2142 <example>
2143 <para>
2144 Output the full name of the <c>nunit.framework</c> assembly to the
2145 build log.
2146 </para>
2147 <code>
2148 <![CDATA[
2149 <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
2150 ]]>
2151 </code>
2152 </example>
2153 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2154 </member>
2155 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetName(System.Reflection.AssemblyName)">
2156 <summary>
2157 Gets the simple, unencrypted name of the assembly.
2158 </summary>
2159 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2160 <returns>
2161 The simple, unencrypted name of the assembly.
2162 </returns>
2163 <example>
2164 <para>
2165 Output the simple name of the <c>nunit.framework</c> assembly to
2166 the build log.
2167 </para>
2168 <code>
2169 <![CDATA[
2170 <echo message="${assemblyname::get-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
2171 ]]>
2172 </code>
2173 </example>
2174 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2175 </member>
2176 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)">
2177 <summary>
2178 Gets the version of the assembly.
2179 </summary>
2180 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2181 <returns>
2182 The version of the assembly.
2183 </returns>
2184 <example>
2185 <para>
2186 Output the major version of the <c>nunit.framework</c> assembly
2187 to the build log.
2188 </para>
2189 <code>
2190 <![CDATA[
2191 <echo message="${version::get-major-version(assemblyname::get-version(assemblyname::get-assembly-name('nunit.framework.dll')))}" />
2192 ]]>
2193 </code>
2194 </example>
2195 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2196 <seealso cref="T:NAnt.Core.Functions.VersionFunctions"/>
2197 </member>
2198 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetAssemblyName(System.String)">
2199 <summary>
2200 Gets the <see cref="T:System.Reflection.AssemblyName"/> for a given file.
2201 </summary>
2202 <param name="assemblyFile">The assembly file for which to get the <see cref="T:System.Reflection.AssemblyName"/>.</param>
2203 <returns>
2204 An <see cref="T:System.Reflection.AssemblyName"/> object representing the given file.
2205 </returns>
2206 <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
2207 <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> does not exist.</exception>
2208 <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception>
2209 <remarks>
2210 The assembly is not added to this domain.
2211 </remarks>
2212 <example>
2213 <para>
2214 Output the full name of the <c>nunit.framework</c> assembly to the
2215 build log.
2216 </para>
2217 <code>
2218 <![CDATA[
2219 <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
2220 ]]>
2221 </code>
2222 </example>
2223 </member>
2224 <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.Parse(System.String)">
2225 <summary>
2226 Converts the specified string representation of a logical value to
2227 its <see cref="T:System.Boolean"/> equivalent.
2228 </summary>
2229 <param name="s">A string containing the value to convert.</param>
2230 <returns>
2231 <see langword="true"/> if <paramref name="value"/> is equivalent to
2232 "True"; otherwise, <see langword="false"/>.
2233 </returns>
2234 <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>
2235 </member>
2236 <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.ToString(System.Boolean)">
2237 <summary>
2238 Converts the specified <see cref="T:System.Boolean"/> to its equivalent string
2239 representation.
2240 </summary>
2241 <param name="value">A <see cref="T:System.Boolean"/> to convert.</param>
2242 <returns>
2243 "True" if <paramref name="value"/> is <see langword="true"/>, or
2244 "False" if <paramref name="value"/> is <see langword="false"/>.
2245 </returns>
2246 </member>
2247 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToInt(System.Int32)">
2248 <summary>
2249 Converts the argument to an integer.
2250 </summary>
2251 <param name="value">value to be converted</param>
2252 <returns><paramref name="value" /> converted to integer. The function fails with an exception when the conversion is not possible.</returns>
2253 </member>
2254 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDouble(System.Double)">
2255 <summary>
2256 Converts the argument to double
2257 </summary>
2258 <param name="value">The value to be converted.</param>
2259 <returns><paramref name="value" /> converted to double. The function fails with an exception when the conversion is not possible.</returns>
2260 </member>
2261 <member name="M:NAnt.Core.Functions.ConversionFunctions.ConvertToString(System.String)">
2262 <summary>
2263 Converts the argument to a string.
2264 </summary>
2265 <param name="value">The value to be converted.</param>
2266 <returns>
2267 <paramref name="value" /> converted to string. The function fails
2268 with an exception when the conversion is not possible.
2269 </returns>
2270 <remarks>
2271 Named method ConvertToString as a static ToString method would break
2272 CLS compliance.
2273 </remarks>
2274 </member>
2275 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDateTime(System.DateTime)">
2276 <summary>
2277 Converts the argument to a datetime.
2278 </summary>
2279 <param name="value">value to be converted</param>
2280 <returns><paramref name="value" /> converted to datetime. The function fails with an exception when the conversion is not possible.</returns>
2281 </member>
2282 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToBoolean(System.Boolean)">
2283 <summary>
2284 Converts the argument to a boolean
2285 </summary>
2286 <param name="value">The string value to be converted to boolean. Must be 'true' or 'false'.</param>
2287 <returns>
2288 <paramref name="value" /> converted to boolean. The function fails
2289 with an exception when the conversion is not possible.
2290 </returns>
2291 </member>
2292 <member name="M:NAnt.Core.Functions.DateTimeFunctions.Now">
2293 <summary>
2294 Gets a <see cref="T:System.DateTime"/> that is the current local date and
2295 time on this computer.
2296 </summary>
2297 <returns>
2298 A <see cref="T:System.DateTime"/> whose value is the current date and time.
2299 </returns>
2300 </member>
2301 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetYear(System.DateTime)">
2302 <summary>
2303 Gets the year component of the specified date.
2304 </summary>
2305 <param name="date">The date of which to get the year component.</param>
2306 <returns>
2307 The year, between 1 and 9999.
2308 </returns>
2309 </member>
2310 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMonth(System.DateTime)">
2311 <summary>
2312 Gets the month component of the specified date.
2313 </summary>
2314 <param name="date">The date of which to get the month component.</param>
2315 <returns>
2316 The month, between 1 and 12.
2317 </returns>
2318 </member>
2319 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDay(System.DateTime)">
2320 <summary>
2321 Gets the day of the month represented by the specified date.
2322 </summary>
2323 <param name="date">The date of which to get the day of the month.</param>
2324 <returns>
2325 The day value, between 1 and 31.
2326 </returns>
2327 </member>
2328 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetHour(System.DateTime)">
2329 <summary>
2330 Gets the hour component of the specified date.
2331 </summary>
2332 <param name="date">The date of which to get the hour component.</param>
2333 <returns>
2334 The hour, between 0 and 23.
2335 </returns>
2336 </member>
2337 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMinute(System.DateTime)">
2338 <summary>
2339 Gets the minute component of the specified date.
2340 </summary>
2341 <param name="date">The date of which to get the minute component.</param>
2342 <returns>
2343 The minute, between 0 and 59.
2344 </returns>
2345 </member>
2346 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetSecond(System.DateTime)">
2347 <summary>
2348 Gets the seconds component of the specified date.
2349 </summary>
2350 <param name="date">The date of which to get the seconds component.</param>
2351 <returns>
2352 The seconds, between 0 and 59.
2353 </returns>
2354 </member>
2355 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMillisecond(System.DateTime)">
2356 <summary>
2357 Gets the milliseconds component of the specified date.
2358 </summary>
2359 <param name="date">The date of which to get the milliseconds component.</param>
2360 <returns>
2361 The millisecond, between 0 and 999.
2362 </returns>
2363 </member>
2364 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetTicks(System.DateTime)">
2365 <summary>
2366 Gets the number of ticks that represent the specified date.
2367 </summary>
2368 <param name="date">The date of which to get the number of ticks.</param>
2369 <returns>
2370 The number of ticks that represent the date and time of the
2371 specified date.
2372 </returns>
2373 </member>
2374 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfWeek(System.DateTime)">
2375 <summary>
2376 Gets the day of the week represented by the specified date.
2377 </summary>
2378 <param name="date">The date of which to get the day of the week.</param>
2379 <returns>
2380 The day of the week, ranging from zero, indicating Sunday, to six,
2381 indicating Saturday.
2382 </returns>
2383 </member>
2384 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfYear(System.DateTime)">
2385 <summary>
2386 Gets the day of the year represented by the specified date.
2387 </summary>
2388 <param name="date">The date of which to get the day of the year.</param>
2389 <returns>
2390 The day of the year, between 1 and 366.
2391 </returns>
2392 </member>
2393 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDaysInMonth(System.Int32,System.Int32)">
2394 <summary>
2395 Returns the number of days in the specified month of the specified
2396 year.
2397 </summary>
2398 <param name="year">The year.</param>
2399 <param name="month">The month (a number ranging from 1 to 12).</param>
2400 <returns>
2401 The number of days in <paramref name="month"/> for the specified
2402 <paramref name="year"/>.
2403 </returns>
2404 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="month"/> is less than 1 or greater than 12.</exception>
2405 </member>
2406 <member name="M:NAnt.Core.Functions.DateTimeFunctions.IsLeapYear(System.Int32)">
2407 <summary>
2408 Returns an indication whether the specified year is a leap year.
2409 </summary>
2410 <param name="year">A 4-digit year.</param>
2411 <returns>
2412 <see langword="true" /> if <paramref name="year" /> is a leap year;
2413 otherwise, <see langword="false" />.
2414 </returns>
2415 </member>
2416 <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.Parse(System.String)">
2417 <summary>
2418 Converts the specified string representation of a date and time to
2419 its <see cref="T:System.DateTime"/> equivalent.
2420 </summary>
2421 <param name="s">A string containing a date and time to convert.</param>
2422 <returns>
2423 A <see cref="T:System.DateTime"/> equivalent to the date and time contained
2424 in <paramref name="s"/>.
2425 </returns>
2426 <exception cref="T:System.FormatException"><paramref name="s"/> does not contain a valid string representation of a date and time.</exception>
2427 <remarks>
2428 The <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture is
2429 used to supply formatting information about <paramref name="s"/>.
2430 </remarks>
2431 </member>
2432 <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.ToString(System.DateTime)">
2433 <summary>
2434 Converts the specified <see cref="T:System.DateTime"/> to its equivalent
2435 string representation.
2436 </summary>
2437 <param name="value">A <see cref="T:System.DateTime"/> to convert.</param>
2438 <returns>
2439 A string representation of <paramref name="value"/> formatted using
2440 the general format specifier ("G").
2441 </returns>
2442 <remarks>
2443 <paramref name="value"/> is formatted with the
2444 <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture.
2445 </remarks>
2446 </member>
2447 <member name="T:NAnt.Core.Functions.DirectoryFunctions">
2448 <summary>
2449 Groups a set of functions for dealing with directories.
2450 </summary>
2451 </member>
2452 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCreationTime(System.String)">
2453 <summary>
2454 Returns the creation date and time of the specified directory.
2455 </summary>
2456 <param name="path">The directory for which to obtain creation date and time information.</param>
2457 <returns>
2458 The creation date and time of the specified directory.
2459 </returns>
2460 <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
2461 <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>
2462 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2463 </member>
2464 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastWriteTime(System.String)">
2465 <summary>
2466 Returns the date and time the specified directory was last written to.
2467 </summary>
2468 <param name="path">The directory for which to obtain write date and time information.</param>
2469 <returns>
2470 The date and time the specified directory was last written to.
2471 </returns>
2472 <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
2473 <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>
2474 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2475 </member>
2476 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastAccessTime(System.String)">
2477 <summary>
2478 Returns the date and time the specified directory was last accessed.
2479 </summary>
2480 <param name="path">The directory for which to obtain access date and time information.</param>
2481 <returns>
2482 The date and time the specified directory was last accessed.
2483 </returns>
2484 <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
2485 <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>
2486 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2487 <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
2488 </member>
2489 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCurrentDirectory">
2490 <summary>
2491 Gets the current working directory.
2492 </summary>
2493 <returns>
2494 A <see cref="T:System.String"/> containing the path of the current working
2495 directory.
2496 </returns>
2497 </member>
2498 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetParentDirectory(System.String)">
2499 <summary>
2500 Retrieves the parent directory of the specified path.
2501 </summary>
2502 <param name="path">The path for which to retrieve the parent directory.</param>
2503 <returns>
2504 The parent directory, or an empty <see cref="T:System.String"/> if
2505 <paramref name="path"/> is the root directory, including the root
2506 of a UNC server or share name.
2507 </returns>
2508 <exception cref="T:System.IO.IOException">The directory specified by <paramref name="path"/> is read-only.</exception>
2509 <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>
2510 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2511 <exception cref="T:System.IO.DirectoryNotFoundException">The specified path was not found.</exception>
2512 <example>
2513 <para>
2514 Copy "readme.txt" from the current working directory to
2515 its parent directory.
2516 </para>
2517 <code>
2518 <![CDATA[
2519 <property name="current.dir" value="${directory::get-current-directory()}" />
2520 <property name="current.dir.parent" value="${directory::get-parent-directory(current.dir)}" />
2521 <copy file="${path::combine(current.dir, 'readme.txt')} todir="${current.dir.parent}" />
2522 ]]>
2523 </code>
2524 </example>
2525 </member>
2526 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetDirectoryRoot(System.String)">
2527 <summary>
2528 Returns the volume information, root information, or both for the
2529 specified path.
2530 </summary>
2531 <param name="path">The path for which to retrieve the parent directory.</param>
2532 <returns>
2533 A string containing the volume information, root information, or
2534 both for the specified path.
2535 </returns>
2536 <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>
2537 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2538 </member>
2539 <member name="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)">
2540 <summary>
2541 Determines whether the given path refers to an existing directory
2542 on disk.
2543 </summary>
2544 <param name="path">The path to test.</param>
2545 <returns>
2546 <see langword="true" /> if <paramref name="path" /> refers to an
2547 existing directory; otherwise, <see langword="false" />.
2548 </returns>
2549 <example>
2550 <para>Remove directory "test", if it exists.</para>
2551 <code>
2552 <![CDATA[
2553 <delete dir="test" if="${directory::exists('test')}" />
2554 ]]>
2555 </code>
2556 </example>
2557 </member>
2558 <member name="T:NAnt.Core.Functions.DnsFunctions">
2559 <summary>
2560 Functions for requesting information from DNS.
2561 </summary>
2562 </member>
2563 <member name="M:NAnt.Core.Functions.DnsFunctions.GetHostName">
2564 <summary>
2565 Gets the host name of the local computer.
2566 </summary>
2567 <returns>
2568 A string that contains the DNS host name of the local computer.
2569 </returns>
2570 <exception cref="T:System.Net.Sockets.SocketException">An error is encountered when resolving the local host name.</exception>
2571 </member>
2572 <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.Parse(System.String)">
2573 <summary>
2574 Converts the specified string representation of a number to its
2575 double-precision floating point number equivalent.
2576 </summary>
2577 <param name="s">A string containing a number to convert.</param>
2578 <returns>
2579 A double-precision floating point number equivalent to the numeric
2580 value or symbol specified in <paramref name="s"/>.
2581 </returns>
2582 <exception cref="T:System.FormatException"><paramref name="s"/> is not a number in a valid format.</exception>
2583 <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>
2584 <remarks>
2585 The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
2586 used to supply formatting information about <paramref name="s"/>.
2587 </remarks>
2588 </member>
2589 <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.ToString(System.Double)">
2590 <summary>
2591 Converts the specified <see cref="T:System.Double"/> to its equivalent
2592 string representation.
2593 </summary>
2594 <param name="value">A <see cref="T:System.Double"/> to convert.</param>
2595 <returns>
2596 The string representation of <paramref name="value"/> formatted
2597 using the general format specifier ("G").
2598 </returns>
2599 <remarks>
2600 <paramref name="value"/> is formatted with the
2601 <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
2602 </remarks>
2603 </member>
2604 <member name="T:NAnt.Core.Functions.EnvironmentFunctions">
2605 <summary>
2606 Provide information about the current environment and platform.
2607 </summary>
2608 </member>
2609 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)">
2610 <summary>
2611 Gets the path to the system special folder identified by the
2612 specified enumeration.
2613 </summary>
2614 <param name="folder">An enumerated constant that identifies a system special folder.</param>
2615 <returns>
2616 The path to the specified system special folder, if that folder
2617 physically exists on your computer; otherwise, the empty string ("").
2618 </returns>
2619 <exception cref="T:System.ArgumentException"><paramref name="folder"/> is not a member of <see cref="T:System.Environment.SpecialFolder"/>.</exception>
2620 <example>
2621 <para>
2622 Copy "out.log" from the project base directory to the
2623 program files directory.
2624 </para>
2625 <code>
2626 <![CDATA[
2627 <copy file="out.log" todir="${environment::get-folder-path('ProgramFiles')}" />
2628 ]]>
2629 </code>
2630 </example>
2631 </member>
2632 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetMachineName">
2633 <summary>
2634 Gets the NetBIOS name of this local computer.
2635 </summary>
2636 <returns>
2637 The NetBIOS name of this local computer.
2638 </returns>
2639 <exception cref="T:System.InvalidOperationException">The name of this computer cannot be obtained.</exception>
2640 </member>
2641 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem">
2642 <summary>
2643 Gets an <see cref="T:System.OperatingSystem"/> object that represents the
2644 current operating system.
2645 </summary>
2646 <returns>
2647 An <see cref="T:System.OperatingSystem"/> object that contains the current
2648 platform identifier and version number.
2649 </returns>
2650 <example>
2651 <para>
2652 Output string representation of the current operating system.
2653 </para>
2654 <code>
2655 <![CDATA[
2656 <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" />
2657 ]]>
2658 </code>
2659 <para>If the operating system is Windows 2000, the output is:</para>
2660 <code>
2661 Microsoft Windows NT 5.0.2195.0
2662 </code>
2663 </example>
2664 <seealso cref="T:NAnt.Core.Functions.OperatingSystemFunctions"/>
2665 </member>
2666 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetUserName">
2667 <summary>
2668 Gets the user name of the person who started the current thread.
2669 </summary>
2670 <returns>
2671 The name of the person logged on to the system who started the
2672 current thread.
2673 </returns>
2674 <example>
2675 <para>
2676 Modify the home directory of the current user on unix-based systems.
2677 </para>
2678 <code>
2679 <![CDATA[
2680 <exec program="usermod">
2681 <arg value="-d" />
2682 <arg value="/home/temp" />
2683 <arg value="${environment::get-user-name()}" />
2684 </exec>
2685 ]]>
2686 </code>
2687 </example>
2688 </member>
2689 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)">
2690 <summary>
2691 Returns the value of the specified environment variable.
2692 </summary>
2693 <param name="name">The environment variable of which the value should be returned.</param>
2694 <returns>
2695 The value of the specified environment variable.
2696 </returns>
2697 <exception cref="T:System.ArgumentException">Environment variable <paramref name="name"/> does not exist.</exception>
2698 </member>
2699 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.VariableExists(System.String)">
2700 <summary>
2701 Gets a value indicating whether the specified environment variable
2702 exists.
2703 </summary>
2704 <param name="name">The environment variable that should be checked.</param>
2705 <returns>
2706 <see langword="true" /> if the environment variable exists; otherwise,
2707 <see langword="false" />.
2708 </returns>
2709 <example>
2710 <para>
2711 Execute a set of tasks only if the "BUILD_DEBUG" environment
2712 variable is set.
2713 </para>
2714 <code>
2715 <![CDATA[
2716 <if test="${environment::variable-exists('BUILD_DEBUG')}">
2717 ...
2718 </if>
2719 ]]>
2720 </code>
2721 </example>
2722 </member>
2723 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion">
2724 <summary>
2725 Gets a <see cref="T:System.Version"/> object that describes the major,
2726 minor, build, and revision numbers of the Common Language Runtime.
2727 </summary>
2728 <returns>
2729 A Version object.
2730 </returns>
2731 <example>
2732 <para>Output the major version of the CLR.</para>
2733 <code>
2734 <![CDATA[
2735 <echo message="Major version=${version::get-major(environment::get-version())}" />
2736 ]]>
2737 </code>
2738 </example>
2739 </member>
2740 <member name="T:NAnt.Core.Functions.FileFunctions">
2741 <summary>
2742 Groups a set of functions for dealing with files.
2743 </summary>
2744 </member>
2745 <member name="M:NAnt.Core.Functions.FileFunctions.GetCreationTime(System.String)">
2746 <summary>
2747 Returns the creation date and time of the specified file.
2748 </summary>
2749 <param name="path">The file for which to obtain creation date and time information.</param>
2750 <returns>
2751 The creation date and time of the specified file.
2752 </returns>
2753 <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
2754 <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>
2755 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2756 <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
2757 </member>
2758 <member name="M:NAnt.Core.Functions.FileFunctions.GetLastWriteTime(System.String)">
2759 <summary>
2760 Returns the date and time the specified file was last written to.
2761 </summary>
2762 <param name="path">The file for which to obtain write date and time information.</param>
2763 <returns>
2764 The date and time the specified file was last written to.
2765 </returns>
2766 <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
2767 <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>
2768 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2769 </member>
2770 <member name="M:NAnt.Core.Functions.FileFunctions.GetLastAccessTime(System.String)">
2771 <summary>
2772 Returns the date and time the specified file was last accessed.
2773 </summary>
2774 <param name="path">The file for which to obtain access date and time information.</param>
2775 <returns>
2776 The date and time the specified file was last accessed.
2777 </returns>
2778 <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
2779 <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>
2780 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2781 <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
2782 </member>
2783 <member name="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)">
2784 <summary>
2785 Determines whether the specified file exists.
2786 </summary>
2787 <param name="file">The file to check.</param>
2788 <returns>
2789 <see langword="true" /> if <paramref name="file" /> refers to an
2790 existing file; otherwise, <see langword="false" />.
2791 </returns>
2792 <example>
2793 <para>Execute a set of tasks, if file "output.xml" does not exist.</para>
2794 <code>
2795 <![CDATA[
2796 <if test="${not file::exists('output.xml')}">
2797 ...
2798 </if>
2799 ]]>
2800 </code>
2801 </example>
2802 </member>
2803 <member name="M:NAnt.Core.Functions.FileFunctions.UpToDate(System.String,System.String)">
2804 <summary>
2805 Determines whether <paramref name="targetFile"/> is more or equal
2806 up-to-date than <paramref name="srcFile"/>.
2807 </summary>
2808 <param name="srcFile">The file to check against the target file.</param>
2809 <param name="targetFile">The file for which we want to determine the status.</param>
2810 <returns>
2811 <see langword="true"/> if <paramref name="targetFile"/> is more
2812 or equal up-to-date than <paramref name="srcFile"/>; otherwise,
2813 <see langword="false"/>.
2814 </returns>
2815 <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>
2816 <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>
2817 </member>
2818 <member name="M:NAnt.Core.Functions.FileFunctions.GetLength(System.String)">
2819 <summary>
2820 Gets the length of the file.
2821 </summary>
2822 <param name="file">filename</param>
2823 <returns>
2824 Length in bytes, of the file named <paramref name="file"/>.
2825 </returns>
2826 <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception>
2827 </member>
2828 <member name="M:NAnt.Core.Functions.FileFunctions.IsAssembly(System.String)">
2829 <summary>
2830 Checks if a given file is an assembly.
2831 </summary>
2832 <param name="assemblyFile">The name or path of the file to be checked.</param>
2833 <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>
2834 <exception cref="T:System.ArgumentNullException"><paramref name="assemblyFile"/> is a null <see cref="T:System.String"/>.</exception>
2835 <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
2836 <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>
2837 <exception cref="T:System.Security.SecurityException">The caller does not have path discovery permission.</exception>
2838 </member>
2839 <member name="T:NAnt.Core.Functions.FileVersionInfoFunctions">
2840 <summary>
2841 Functions that provide version information for a physical file on disk.
2842 </summary>
2843 </member>
2844 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetVersionInfo(System.String)">
2845 <summary>
2846 Returns a <see cref="T:System.Diagnostics.FileVersionInfo"/> representing the version
2847 information associated with the specified file.
2848 </summary>
2849 <param name="fileName">The file to retrieve the version information for.</param>
2850 <returns>
2851 A <see cref="T:System.Diagnostics.FileVersionInfo"/> containing information about the file.
2852 </returns>
2853 <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception>
2854 </member>
2855 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetCompanyName(System.Diagnostics.FileVersionInfo)">
2856 <summary>
2857 Gets the name of the company that produced the file.
2858 </summary>
2859 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
2860 <returns>
2861 The name of the company that produced the file.
2862 </returns>
2863 </member>
2864 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetFileVersion(System.Diagnostics.FileVersionInfo)">
2865 <summary>
2866 Gets the file version of a file.
2867 </summary>
2868 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
2869 <returns>
2870 The file version of a file.
2871 </returns>
2872 <see cref="T:NAnt.Core.Functions.VersionFunctions"/>
2873 </member>
2874 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductName(System.Diagnostics.FileVersionInfo)">
2875 <summary>
2876 Gets the name of the product the file is distributed with.
2877 </summary>
2878 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
2879 <returns>
2880 The name of the product the file is distributed with.
2881 </returns>
2882 </member>
2883 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductVersion(System.Diagnostics.FileVersionInfo)">
2884 <summary>
2885 Gets the product version of a file.
2886 </summary>
2887 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
2888 <returns>
2889 The product version of a file.
2890 </returns>
2891 <see cref="T:NAnt.Core.Functions.VersionFunctions"/>
2892 </member>
2893 <member name="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)">
2894 <summary>
2895 Checks whether the specified framework exists, and is valid.
2896 </summary>
2897 <param name="framework">The framework to test.</param>
2898 <returns>
2899 <see langword="true" /> if the specified framework exists ; otherwise,
2900 <see langword="false" />.
2901 </returns>
2902 </member>
2903 <member name="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)">
2904 <summary>
2905 Checks whether the SDK for the specified framework is installed.
2906 </summary>
2907 <param name="framework">The framework to test.</param>
2908 <returns>
2909 <see langword="true"/> if the SDK for specified framework is installed;
2910 otherwise, <see langword="false"/>.
2911 </returns>
2912 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
2913 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
2914 </member>
2915 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework">
2916 <summary>
2917 Gets the identifier of the current target framework.
2918 </summary>
2919 <returns>
2920 The identifier of the current target framework.
2921 </returns>
2922 </member>
2923 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework">
2924 <summary>
2925 Gets the identifier of the runtime framework.
2926 </summary>
2927 <returns>
2928 The identifier of the runtime framework.
2929 </returns>
2930 </member>
2931 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFamily(System.String)">
2932 <summary>
2933 Gets the family of the specified framework.
2934 </summary>
2935 <param name="framework">The framework of which the family should be returned.</param>
2936 <returns>
2937 The family of the specified framework.
2938 </returns>
2939 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
2940 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
2941 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
2942 </member>
2943 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetVersion(System.String)">
2944 <summary>
2945 Gets the version of the specified framework.
2946 </summary>
2947 <param name="framework">The framework of which the version should be returned.</param>
2948 <returns>
2949 The version of the specified framework.
2950 </returns>
2951 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
2952 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
2953 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
2954 </member>
2955 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetDescription(System.String)">
2956 <summary>
2957 Gets the description of the specified framework.
2958 </summary>
2959 <param name="framework">The framework of which the description should be returned.</param>
2960 <returns>
2961 The description of the specified framework.
2962 </returns>
2963 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
2964 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
2965 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
2966 </member>
2967 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetClrVersion(System.String)">
2968 <summary>
2969 Gets the Common Language Runtime version of the specified framework.
2970 </summary>
2971 <param name="framework">The framework of which the Common Language Runtime version should be returned.</param>
2972 <returns>
2973 The Common Language Runtime version of the specified framework.
2974 </returns>
2975 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
2976 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
2977 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
2978 </member>
2979 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFrameworkDirectory(System.String)">
2980 <summary>
2981 Gets the framework directory of the specified framework.
2982 </summary>
2983 <param name="framework">The framework of which the framework directory should be returned.</param>
2984 <returns>
2985 The framework directory of the specified framework.
2986 </returns>
2987 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
2988 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
2989 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
2990 </member>
2991 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetAssemblyDirectory(System.String)">
2992 <summary>
2993 Gets the assembly directory of the specified framework.
2994 </summary>
2995 <param name="framework">The framework of which the assembly directory should be returned.</param>
2996 <returns>
2997 The assembly directory of the specified framework.
2998 </returns>
2999 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3000 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3001 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3002 </member>
3003 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetSdkDirectory(System.String)">
3004 <summary>
3005 Gets the SDK directory of the specified framework.
3006 </summary>
3007 <param name="framework">The framework of which the SDK directory should be returned.</param>
3008 <returns>
3009 The SDK directory of the specified framework, or an empty
3010 <see cref="T:System.String"/> if the SDK of the specified framework is not
3011 installed.
3012 </returns>
3013 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3014 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3015 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3016 </member>
3017 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetToolPath(System.String)">
3018 <summary>
3019 Gets the absolute path of the specified tool for the current
3020 target framework.
3021 </summary>
3022 <param name="tool">The file name of the tool to search for.</param>
3023 <returns>
3024 The absolute path to <paramref name="tool"/> if found in one of the
3025 configured tool paths; otherwise, an error is reported.
3026 </returns>
3027 <exception cref="T:System.IO.FileNotFoundException"><paramref name="tool"/> could not be found in the configured tool paths.</exception>
3028 <remarks>
3029 <para>
3030 The configured tool paths are scanned in the order in which they
3031 are defined in the framework configuration.
3032 </para>
3033 <para>
3034 The file name of the tool to search should include the extension.
3035 </para>
3036 </remarks>
3037 <example>
3038 <para>Use <b>gacutil</b> to install an assembly in the GAC.</para>
3039 <code>
3040 <![CDATA[
3041 <exec program="${framework::get-tool-path('gacutil.exe')}" managed="strict">
3042 <arg value="/i" />
3043 <arg file="Cegeka.HealthFramework.dll" />
3044 </exec>
3045 ]]>
3046 </code>
3047 </example>
3048 </member>
3049 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeEngine(System.String)">
3050 <summary>
3051 Gets the runtime engine of the specified framework.
3052 </summary>
3053 <param name="framework">The framework of which the runtime engine should be returned.</param>
3054 <returns>
3055 The full path to the runtime engine of the specified framework, or
3056 an empty <see cref="T:System.String"/> if no runtime engine is defined
3057 for the specified framework.
3058 </returns>
3059 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3060 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3061 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3062 </member>
3063 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFrameworks(NAnt.Core.FrameworkTypes)">
3064 <summary>
3065 Gets a comma-separated list of frameworks filtered by the specified
3066 <see cref="T:NAnt.Core.FrameworkTypes"/>.
3067 </summary>
3068 <param name="types">A bitwise combination of <see cref="T:NAnt.Core.FrameworkTypes"/> values that filter the frameworks to retrieve.</param>
3069 <returns>
3070 A comma-separated list of frameworks filtered by the specified
3071 <see cref="T:NAnt.Core.FrameworkTypes"/>, sorted on name.
3072 </returns>
3073 <example>
3074 <para>
3075 Define a <b>build-all</b> target that executes the <b>build</b>
3076 target once for each installed framework targeting compact
3077 devices.
3078 </para>
3079 <code>
3080 <![CDATA[
3081 <target name="build-all">
3082 <foreach item="String" in="${framework::get-frameworks('installed compact')}" delim="," property="framework">
3083 <property name="nant.settings.currentframework" value="${framework}" />
3084 <call target="build" />
3085 </foreach>
3086 </target>
3087
3088 <target name="build">
3089 ...
3090 </target>
3091 ]]>
3092 </code>
3093 </example>
3094 </member>
3095 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFramework(System.String)">
3096 <summary>
3097 Checks whether the specified framework is valid.
3098 </summary>
3099 <param name="framework">The framework to check.</param>
3100 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3101 </member>
3102 <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.Parse(System.String)">
3103 <summary>
3104 Converts the specified string representation of a number to its
3105 32-bit signed integer equivalent.
3106 </summary>
3107 <param name="s">A string containing a number to convert.</param>
3108 <returns>
3109 A 32-bit signed integer equivalent to the number contained in
3110 <paramref name="s"/>.
3111 </returns>
3112 <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception>
3113 <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>
3114 <remarks>
3115 The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
3116 used to supply formatting information about <paramref name="s"/>.
3117 </remarks>
3118 </member>
3119 <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.ToString(System.Int32)">
3120 <summary>
3121 Converts the specified <see cref="T:System.Int32"/> to its equivalent string
3122 representation.
3123 </summary>
3124 <param name="value">A <see cref="T:System.Int32"/> to convert.</param>
3125 <returns>
3126 The string representation of <paramref name="value"/>, consisting
3127 of a negative sign if the value is negative, and a sequence of
3128 digits ranging from 0 to 9 with no leading zeroes.
3129 </returns>
3130 <remarks>
3131 <paramref name="value"/> is formatted with the
3132 <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
3133 </remarks>
3134 </member>
3135 <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.Parse(System.String)">
3136 <summary>
3137 Converts the specified string representation of a number to its
3138 64-bit signed integer equivalent.
3139 </summary>
3140 <param name="s">A string containing a number to convert.</param>
3141 <returns>
3142 A 64-bit signed integer equivalent to the number contained in
3143 <paramref name="s"/>.
3144 </returns>
3145 <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception>
3146 <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>
3147 <remarks>
3148 The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
3149 used to supply formatting information about <paramref name="s"/>.
3150 </remarks>
3151 </member>
3152 <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.ToString(System.Int64)">
3153 <summary>
3154 Converts the specified <see cref="T:System.Int64"/> to its equivalent string
3155 representation.
3156 </summary>
3157 <param name="value">A <see cref="T:System.Int64"/> to convert.</param>
3158 <returns>
3159 The string representation of <paramref name="value"/>, consisting
3160 of a negative sign if the value is negative, and a sequence of
3161 digits ranging from 0 to 9 with no leading zeroes.
3162 </returns>
3163 <remarks>
3164 <paramref name="value"/> is formatted with the
3165 <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
3166 </remarks>
3167 </member>
3168 <member name="M:NAnt.Core.Functions.MathFunctions.Round(System.Double)">
3169 <summary>
3170 Rounds the value to the nearest whole number
3171 </summary>
3172 <param name="value">Number to be rounded, can be anything convertible to a double.</param>
3173 <returns>
3174 Rounded value.
3175 </returns>
3176 </member>
3177 <member name="M:NAnt.Core.Functions.MathFunctions.Floor(System.Double)">
3178 <summary>
3179 Returns the largest whole number less than or equal to the specified
3180 number.
3181 </summary>
3182 <param name="value">value to be , can be anything convertible to a double</param>
3183 <returns>
3184 The largest whole number less than or equal to the specified number.
3185 </returns>
3186 </member>
3187 <member name="M:NAnt.Core.Functions.MathFunctions.Ceiling(System.Double)">
3188 <summary>
3189 Returns the smallest whole number greater than or equal to the specified number
3190 </summary>
3191 <param name="value">value</param>
3192 <returns>
3193 The smallest whole number greater than or equal to the specified number.
3194 </returns>
3195 </member>
3196 <member name="M:NAnt.Core.Functions.MathFunctions.Abs(System.Double)">
3197 <summary>
3198 Returns the absolute value of the specified number
3199 </summary>
3200 <param name="value">value to take the absolute value from</param>
3201 <returns>
3202 <paramref name="value" /> when <paramref name="value" /> is greater
3203 than or equal to zero; otherwise, -<paramref name="value" />.
3204 </returns>
3205 </member>
3206 <member name="M:NAnt.Core.Functions.NAntFunctions.GetBaseDirectory">
3207 <summary>
3208 Gets the base directory of the appdomain in which NAnt is running.
3209 </summary>
3210 <returns>
3211 The base directory of the appdomain in which NAnt is running.
3212 </returns>
3213 </member>
3214 <member name="M:NAnt.Core.Functions.NAntFunctions.GetAssembly">
3215 <summary>
3216 Gets the NAnt assembly.
3217 </summary>
3218 <returns>
3219 The NAnt assembly.
3220 </returns>
3221 </member>
3222 <member name="M:NAnt.Core.Functions.NAntFunctions.ScanProbingPaths(System.String)">
3223 <summary>
3224 Searches the probing paths of the current target framework for the
3225 specified file.
3226 </summary>
3227 <param name="fileName">The name of the file to search for.</param>
3228 <returns>
3229 The absolute path to <paramref name="fileName"/> if found in one of the
3230 configured probing; otherwise, an error is reported.
3231 </returns>
3232 <exception cref="T:System.IO.FileNotFoundException"><paramref name="fileName"/> could not be found in the configured probing paths.</exception>
3233 <remarks>
3234 <para>
3235 The configured probing paths are scanned recursively in the order
3236 in which they are defined in the framework configuration.
3237 </para>
3238 <para>
3239 The file name to search should include the extension.
3240 </para>
3241 </remarks>
3242 <example>
3243 <para>
3244 Compile an assembly referencing the <c>nunit.framework</c> assembly
3245 for the current target framework that is shipped as part of the
3246 NAnt distribution.
3247 </para>
3248 <code>
3249 <![CDATA[
3250 <csc target="library" output="NAnt.Core.Tests.dll">
3251 <sources basedir="NAnt.Core">
3252 <include name="**/*.cs" />
3253 </sources>
3254 <references>
3255 <include name="NAnt.Core.dll" />
3256 <include name="${framework::get-lib-path('nunit.framework.dll')}" />
3257 </references>
3258 </csc>
3259 ]]>
3260 </code>
3261 </example>
3262 </member>
3263 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetName">
3264 <summary>
3265 Gets the name of the current project.
3266 </summary>
3267 <returns>
3268 The name of the current project, or an empty <see cref="T:System.String"/>
3269 if no name is specified in the build file.
3270 </returns>
3271 </member>
3272 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFileUri">
3273 <summary>
3274 Gets the <see cref="T:System.Uri"/> form of the build file.
3275 </summary>
3276 <returns>
3277 The <see cref="T:System.Uri"/> form of the build file, or
3278 an empty <see cref="T:System.String"/> if the project is not file backed.
3279 </returns>
3280 </member>
3281 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFilePath">
3282 <summary>
3283 Gets the local path to the build file.
3284 </summary>
3285 <returns>
3286 The local path of the build file, or an empty <see cref="T:System.String"/>
3287 if the project is not file backed.
3288 </returns>
3289 </member>
3290 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetDefaultTarget">
3291 <summary>
3292 Gets the name of the target that will be executed when no other
3293 build targets are specified.
3294 </summary>
3295 <returns>
3296 The name of the target that will be executed when no other build
3297 targets are specified, or an empty <see cref="T:System.String"/> if no
3298 default target is defined for the project.
3299 </returns>
3300 </member>
3301 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBaseDirectory">
3302 <summary>
3303 Gets the base directory of the current project.
3304 </summary>
3305 <returns>
3306 The base directory of the current project.
3307 </returns>
3308 </member>
3309 <member name="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)">
3310 <summary>
3311 Checks whether the specified target exists.
3312 </summary>
3313 <param name="name">The target to test.</param>
3314 <returns>
3315 <see langword="true" /> if the specified target exists; otherwise,
3316 <see langword="false" />.
3317 </returns>
3318 <example>
3319 <para>
3320 Execute target "clean", if it exists.
3321 </para>
3322 <code>
3323 <![CDATA[
3324 <if test="${target::exists('clean')}">
3325 <call target="clean" />
3326 </if>
3327 ]]>
3328 </code>
3329 </example>
3330 </member>
3331 <member name="M:NAnt.Core.Functions.TargetFunctions.GetCurrentTarget">
3332 <summary>
3333 Gets the name of the target being executed.
3334 </summary>
3335 <returns>
3336 A <see cref="T:System.String"/> that contains the name of the target
3337 being executed.
3338 </returns>
3339 <exception cref="T:System.InvalidOperationException">No target is being executed.</exception>
3340 </member>
3341 <member name="M:NAnt.Core.Functions.TargetFunctions.HasExecuted(System.String)">
3342 <summary>
3343 Checks whether the specified target has already been executed.
3344 </summary>
3345 <param name="name">The target to test.</param>
3346 <returns>
3347 <see langword="true"/> if the specified target has already been
3348 executed; otherwise, <see langword="false"/>.
3349 </returns>
3350 <exception cref="T:System.ArgumentException">Target <paramref name="name"/> does not exist.</exception>
3351 </member>
3352 <member name="M:NAnt.Core.Functions.TaskFunctions.Exists(System.String)">
3353 <summary>
3354 Checks whether the specified task exists.
3355 </summary>
3356 <param name="name">The task to test.</param>
3357 <returns>
3358 <see langword="true" /> if the specified task exists; otherwise,
3359 <see langword="false" />.
3360 </returns>
3361 </member>
3362 <member name="M:NAnt.Core.Functions.TaskFunctions.GetAssembly(System.String)">
3363 <summary>
3364 Returns the <see cref="T:System.Reflection.Assembly"/> from which the specified task
3365 was loaded.
3366 </summary>
3367 <param name="name">The name of the task to get the <see cref="T:System.Reflection.Assembly"/> of.</param>
3368 <returns>
3369 The <see cref="T:System.Reflection.Assembly"/> from which the specified task was loaded.
3370 </returns>
3371 <exception cref="T:System.ArgumentException">Task <paramref name="name"/> is not available.</exception>
3372 </member>
3373 <member name="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)">
3374 <summary>
3375 Checks whether the specified property exists.
3376 </summary>
3377 <param name="name">The property to test.</param>
3378 <returns>
3379 <see langword="true" /> if the specified property exists; otherwise,
3380 <see langword="false" />.
3381 </returns>
3382 <example>
3383 <para>
3384 Execute a set of tasks if the "build.debug" property
3385 exists.
3386 </para>
3387 <code>
3388 <![CDATA[
3389 <if test="${property::exists('build.debug')}">
3390 <echo message="Starting debug build" />
3391 <call target="init-debug" />
3392 <call target="build" />
3393 </if>
3394 ]]>
3395 </code>
3396 </example>
3397 </member>
3398 <member name="M:NAnt.Core.Functions.PropertyFunctions.IsReadOnly(System.String)">
3399 <summary>
3400 Checks whether the specified property is read-only.
3401 </summary>
3402 <param name="name">The property to test.</param>
3403 <returns>
3404 <see langword="true"/> if the specified property is read-only;
3405 otherwise, <see langword="false"/>.
3406 </returns>
3407 <example>
3408 <para>Check whether the "debug" property is read-only.</para>
3409 <code>property::is-readonly('debug')</code>
3410 </example>
3411 <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception>
3412 </member>
3413 <member name="M:NAnt.Core.Functions.PropertyFunctions.IsDynamic(System.String)">
3414 <summary>
3415 Checks whether the specified property is a dynamic property.
3416 </summary>
3417 <param name="name">The property to test.</param>
3418 <returns>
3419 <see langword="true"/> if the specified property is a dynamic
3420 property; otherwise, <see langword="false"/>.
3421 </returns>
3422 <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception>
3423 <example>
3424 <para>
3425 Check whether the "debug" property is a dynamic property.
3426 </para>
3427 <code>property::is-dynamic('debug')</code>
3428 </example>
3429 </member>
3430 <member name="M:NAnt.Core.Functions.PlatformFunctions.GetName">
3431 <summary>
3432 Gets the name of the platform on which NAnt is running.
3433 </summary>
3434 <returns>
3435 The name of the platform on which NAnt is running.
3436 </returns>
3437 </member>
3438 <member name="M:NAnt.Core.Functions.PlatformFunctions.IsWin32">
3439 <summary>
3440 Checks whether NAnt is running on the win32 platform.
3441 </summary>
3442 <returns>
3443 <see langword="true" /> if NAnt is running on the win32 platform;
3444 otherwise, <see langword="false" />.
3445 </returns>
3446 </member>
3447 <member name="M:NAnt.Core.Functions.PlatformFunctions.IsUnix">
3448 <summary>
3449 Checks whether NAnt is running on unix.
3450 </summary>
3451 <returns>
3452 <see langword="true" /> if NAnt is running on unix;
3453 otherwise, <see langword="false" />.
3454 </returns>
3455 </member>
3456 <member name="T:NAnt.Core.Functions.OperatingSystemFunctions">
3457 <summary>
3458 Functions that return information about an operating system.
3459 </summary>
3460 </member>
3461 <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetPlatform(System.OperatingSystem)">
3462 <summary>
3463 Gets a <see cref="T:System.PlatformID"/> value that identifies the operating
3464 system platform.
3465 </summary>
3466 <param name="operatingSystem">The operating system.</param>
3467 <returns>
3468 <see cref="T:System.PlatformID"/> value that identifies the operating system
3469 platform.
3470 </returns>
3471 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
3472 </member>
3473 <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)">
3474 <summary>
3475 Gets a <see cref="T:System.Version"/> object that identifies this operating
3476 system.
3477 </summary>
3478 <param name="operatingSystem">The operating system.</param>
3479 <returns>
3480 A <see cref="T:System.Version"/> object that describes the major version,
3481 minor version, build, and revision of the operating system.
3482 </returns>
3483 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
3484 </member>
3485 <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.ToString(System.OperatingSystem)">
3486 <summary>
3487 Converts the value of the specified operating system to its equivalent
3488 <see cref="T:System.String"/> representation.
3489 </summary>
3490 <param name="operatingSystem">The operating system.</param>
3491 <returns>
3492 The <see cref="T:System.String"/> representation of
3493 <paramref name="operatingSystem"/>.
3494 </returns>
3495 <example>
3496 <para>
3497 Output string representation of the current operating system.
3498 </para>
3499 <code>
3500 <![CDATA[
3501 <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" />
3502 ]]>
3503 </code>
3504 <para>If the operating system is Windows 2000, the output is:</para>
3505 <code>
3506 Microsoft Windows NT 5.0.2195.0
3507 </code>
3508 </example>
3509 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
3510 </member>
3511 <member name="M:NAnt.Core.Functions.PathFunctions.GetFullPath(System.String)">
3512 <summary>
3513 Returns the fully qualified path.
3514 </summary>
3515 <param name="path">The file or directory for which to obtain absolute path information.</param>
3516 <returns>
3517 A string containing the fully qualified location of <paramref name="path"/>,
3518 such as "C:\MyFile.txt".
3519 </returns>
3520 <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>
3521 <exception cref="T:System.NotSupportedException"><paramref name="path"/> contains a colon (":").</exception>
3522 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
3523 </member>
3524 <member name="M:NAnt.Core.Functions.PathFunctions.Combine(System.String,System.String)">
3525 <summary>
3526 Combines two paths.
3527 </summary>
3528 <param name="path1">first path</param>
3529 <param name="path2">second path</param>
3530 <returns>
3531 A string containing the combined paths. If one of the specified paths
3532 is a zero-length string, this method returns the other path. If
3533 <paramref name="path2"/> contains an absolute path, this method
3534 returns <paramref name="path2"/>.
3535 </returns>
3536 <exception cref="T:System.ArgumentException"><paramref name="path1"/> or <paramref name="path2"/> contain one or more invalid characters.</exception>
3537 </member>
3538 <member name="M:NAnt.Core.Functions.PathFunctions.ChangeExtension(System.String,System.String)">
3539 <summary>
3540 Changes the extension of the path string.
3541 </summary>
3542 <param name="path">The path information to modify. The path cannot contain any of the characters
3543 defined in <see cref="F:System.IO.Path.InvalidPathChars"/>InvalidPathChars.</param>
3544 <param name="extension">The new extension (with a leading period). Specify a null reference
3545 to remove an existing extension from <paramref name="path"/>.</param>
3546 <returns>
3547 <para>
3548 A string containing the modified path information.
3549 </para>
3550 <para>
3551 On Windows-based desktop platforms, if <paramref name="path"/> is
3552 an empty <see cref="T:System.String"/>, the path information is returned
3553 unmodified. If <paramref name="path"/> has no extension, the returned
3554 path <see cref="T:System.String"/> contains <paramref name="extension"/>
3555 appended to the end of <paramref name="path"/>.
3556 </para>
3557 </returns>
3558 <remarks>
3559 For more information see the <see cref="T:System.IO.Path"/> documentation.
3560 </remarks>
3561 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3562 </member>
3563 <member name="M:NAnt.Core.Functions.PathFunctions.GetDirectoryName(System.String)">
3564 <summary>
3565 Returns the directory information for the specified path string.
3566 </summary>
3567 <param name="path">The path of a file or directory.</param>
3568 <returns>
3569 A <see cref="T:System.String"/> containing directory information for
3570 <paramref name="path"/>, or an empty <see cref="T:System.String"/> if
3571 <paramref name="path"/> denotes a root directory, or does not
3572 contain directory information.
3573 </returns>
3574 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, is empty, or contains only white spaces.</exception>
3575 </member>
3576 <member name="M:NAnt.Core.Functions.PathFunctions.GetExtension(System.String)">
3577 <summary>
3578 Returns the extension for the specified path string.
3579 </summary>
3580 <param name="path">The path string from which to get the extension.</param>
3581 <returns>
3582 A <see cref="T:System.String"/> containing the extension of the specified
3583 <paramref name="path"/> (including the "."), or an empty
3584 <see cref="T:System.String"/> if <paramref name="path"/> does not have
3585 extension information.
3586 </returns>
3587 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3588 </member>
3589 <member name="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)">
3590 <summary>
3591 Returns the filename for the specified path string.
3592 </summary>
3593 <param name="path">The path string from which to obtain the file name and extension.</param>
3594 <returns>
3595 <para>
3596 A <see cref="T:System.String"/> consisting of the characters after the last
3597 directory character in path.
3598 </para>
3599 <para>
3600 If the last character of <paramref name="path"/> is a directory or
3601 volume separator character, an empty <see cref="T:System.String"/> is returned.
3602 </para>
3603 </returns>
3604 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3605 </member>
3606 <member name="M:NAnt.Core.Functions.PathFunctions.GetFileNameWithoutExtension(System.String)">
3607 <summary>
3608 Returns the filename without extension for the specified path string.
3609 </summary>
3610 <param name="path">The path of the file.</param>
3611 <returns>
3612 A <see cref="T:System.String"/> containing the <see cref="T:System.String"/> returned
3613 by <see cref="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)"/>, minus the last period (.) and all
3614 characters following it.
3615 </returns>
3616 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3617 </member>
3618 <member name="M:NAnt.Core.Functions.PathFunctions.GetPathRoot(System.String)">
3619 <summary>
3620 Gets the root directory of the specified path.
3621 </summary>
3622 <param name="path">The path from which to obtain root directory information.</param>
3623 <returns>
3624 A <see cref="T:System.String"/> containing the root directory of
3625 <paramref name="path"/>, such as "C:\", or an empty <see cref="T:System.String"/>
3626 if <paramref name="path"/> does not contain root directory information.
3627 </returns>
3628 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, or is empty.</exception>
3629 </member>
3630 <member name="M:NAnt.Core.Functions.PathFunctions.GetTempFileName">
3631 <summary>
3632 Returns a uniquely named zero-byte temporary file on disk and returns the full path to that file.
3633 </summary>
3634 <returns>
3635 A <see cref="T:System.String"/> containing the name of the temporary file.
3636 </returns>
3637 </member>
3638 <member name="M:NAnt.Core.Functions.PathFunctions.GetTempPath">
3639 <summary>
3640 Gets the path to the temporary directory.
3641 </summary>
3642 <returns>
3643 A <see cref="T:System.String"/> containing the path information of a
3644 temporary directory.
3645 </returns>
3646 </member>
3647 <member name="M:NAnt.Core.Functions.PathFunctions.HasExtension(System.String)">
3648 <summary>
3649 Determines whether a path string includes an extension.
3650 </summary>
3651 <param name="path">The path to search for an extension.</param>
3652 <returns>
3653 <see langword="true"/>. if the characters that follow the last
3654 directory separator or volume separator in the <paramref name="path"/>
3655 include a period (.) followed by one or more characters;
3656 otherwise, <see langword="false"/>.
3657 </returns>
3658 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3659 </member>
3660 <member name="M:NAnt.Core.Functions.PathFunctions.IsPathRooted(System.String)">
3661 <summary>
3662 Determines whether a path string is absolute.
3663 </summary>
3664 <param name="path">The path to test.</param>
3665 <returns>
3666 <see langword="true"/> if path contains an absolute <paramref name="path"/>;
3667 otherwise, <see langword="false"/>.
3668 </returns>
3669 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3670 </member>
3671 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetVariable(System.String,System.String)">
3672 <summary>
3673 Gets the value of a variable for the specified package.
3674 </summary>
3675 <param name="package">The package for which the variable should be retrieved.</param>
3676 <param name="name">The name of the variable.</param>
3677 <returns>
3678 The value of variable <paramref name="name"/> for the specified
3679 package.
3680 </returns>
3681 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3682 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
3683 </member>
3684 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetLinkFlags(System.String)">
3685 <summary>
3686 Gets the link flags required to compile the package, including all
3687 its dependencies.
3688 </summary>
3689 <param name="package">The package for which the link flags should be retrieved.</param>
3690 <returns>
3691 The link flags required to compile the package.
3692 </returns>
3693 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3694 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
3695 </member>
3696 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetCompileFlags(System.String)">
3697 <summary>
3698 Gets the compile flags required to compile the package, including all
3699 its dependencies.
3700 </summary>
3701 <param name="package">The package for which the compile flags should be retrieved.</param>
3702 <returns>
3703 The pre-processor and compile flags required to compile the package.
3704 </returns>
3705 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3706 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
3707 </member>
3708 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetModVersion(System.String)">
3709 <summary>
3710 Determines the version of the given package.
3711 </summary>
3712 <param name="package">The package to get the version of.</param>
3713 <returns>
3714 The version of the given package.
3715 </returns>
3716 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3717 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
3718 </member>
3719 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsAtLeastVersion(System.String,System.String)">
3720 <summary>
3721 Determines whether the given package is at least version
3722 <paramref name="version"/>.
3723 </summary>
3724 <param name="package">The package to check.</param>
3725 <param name="version">The version the package should at least have.</param>
3726 <returns>
3727 <see langword="true"/> if the given package is at least version
3728 <paramref name="version"/>; otherwise, <see langword="false"/>.
3729 </returns>
3730 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3731 </member>
3732 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsExactVersion(System.String,System.String)">
3733 <summary>
3734 Determines whether the given package is exactly version
3735 <paramref name="version"/>.
3736 </summary>
3737 <param name="package">The package to check.</param>
3738 <param name="version">The version the package should have.</param>
3739 <returns>
3740 <see langword="true"/> if the given package is exactly version
3741 <paramref name="version"/>; otherwise, <see langword="false"/>.
3742 </returns>
3743 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3744 </member>
3745 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsMaxVersion(System.String,System.String)">
3746 <summary>
3747 Determines whether the given package is at no newer than version
3748 <paramref name="version"/>.
3749 </summary>
3750 <param name="package">The package to check.</param>
3751 <param name="version">The version the package should maximum have.</param>
3752 <returns>
3753 <see langword="true"/> if the given package is at no newer than
3754 version <paramref name="version"/>; otherwise, <see langword="false"/>.
3755 </returns>
3756 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3757 </member>
3758 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsBetweenVersion(System.String,System.String,System.String)">
3759 <summary>
3760 Determines whether the given package is between two versions.
3761 </summary>
3762 <param name="package">The package to check.</param>
3763 <param name="minVersion">The version the package should at least have.</param>
3764 <param name="maxVersion">The version the package should maximum have.</param>
3765 <returns>
3766 <see langword="true"/> if the given package is between <paramref name="minVersion"/>
3767 and <paramref name="maxVersion"/>; otherwise, <see langword="false"/>.
3768 </returns>
3769 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3770 </member>
3771 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.Exists(System.String)">
3772 <summary>
3773 Determines whether the given package exists.
3774 </summary>
3775 <param name="package">The package to check.</param>
3776 <returns>
3777 <see langword="true"/> if the package exists; otherwise,
3778 <see langword="false"/>.
3779 </returns>
3780 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3781 </member>
3782 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigBool(NAnt.Core.Types.Argument[])">
3783 <summary>
3784 Runs pkg-config with the specified arguments and returns a
3785 <see cref="T:System.Boolean"/> based on the exit code.
3786 </summary>
3787 <param name="args">The arguments to pass to pkg-config.</param>
3788 <returns>
3789 <see langword="true"/> if pkg-config exited with exit code 0;
3790 otherwise, <see langword="false"/>
3791 </returns>
3792 </member>
3793 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigString(NAnt.Core.Types.Argument[])">
3794 <summary>
3795 Runs pkg-config with the specified arguments and returns the result
3796 as a <see cref="T:System.String"/>.
3797 </summary>
3798 <param name="args">The arguments to pass to pkg-config.</param>
3799 <returns>
3800 The result of running pkg-config with the specified arguments.
3801 </returns>
3802 </member>
3803 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetTask(System.IO.Stream)">
3804 <summary>
3805 Factory method to return a new instance of ExecTask
3806 </summary>
3807 <param name="stream"></param>
3808 <returns></returns>
3809 </member>
3810 <member name="M:NAnt.Core.Functions.StringFunctions.GetLength(System.String)">
3811 <summary>
3812 Returns the length of the specified string.
3813 </summary>
3814 <param name="s">input string</param>
3815 <returns>
3816 The string's length.
3817 </returns>
3818 <example>
3819 <code>string::get-length('foo') ==> 3</code>
3820 </example>
3821 <example>
3822 <code>string::get-length('') ==> 0</code>
3823 </example>
3824 </member>
3825 <member name="M:NAnt.Core.Functions.StringFunctions.Substring(System.String,System.Int32,System.Int32)">
3826 <summary>
3827 Returns a substring of the specified string.
3828 </summary>
3829 <param name="str">input string</param>
3830 <param name="startIndex">position of the start of the substring</param>
3831 <param name="length">the length of the substring</param>
3832 <returns>
3833 <para>
3834 If the <paramref name="length"/> is greater than zero, the
3835 function returns a substring starting at character position
3836 <paramref name="startIndex"/> with a length of <paramref name="length"/>
3837 characters.
3838 </para>
3839 <para>
3840 If the <paramref name="length"/> is equal to zero, the function
3841 returns an empty string.
3842 </para>
3843 </returns>
3844 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> or <paramref name="length"/> is less than zero.</exception>
3845 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> is greater than the length of <paramref name="str"/>.</exception>
3846 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> plus <paramref name="length"/> indicates a position not within <paramref name="str"/>.</exception>
3847 <example>
3848 <code>string::substring('testing string', 0, 4) ==> 'test'</code>
3849 </example>
3850 <example>
3851 <code>string::substring('testing string', 8, 3) ==> 'str'</code>
3852 </example>
3853 <example>
3854 <code>string::substring('testing string', 8, 0) ==> ''</code>
3855 </example>
3856 <example>
3857 <code>string::substring('testing string', -1, 5) ==> ERROR</code>
3858 </example>
3859 <example>
3860 <code>string::substring('testing string', 8, -1) ==> ERROR</code>
3861 </example>
3862 <example>
3863 <code>string::substring('testing string', 5, 17) ==> ERROR</code>
3864 </example>
3865 </member>
3866 <member name="M:NAnt.Core.Functions.StringFunctions.StartsWith(System.String,System.String)">
3867 <summary>
3868 Tests whether the specified string starts with the specified prefix
3869 string.
3870 </summary>
3871 <param name="s1">test string</param>
3872 <param name="s2">prefix string</param>
3873 <returns>
3874 <see langword="true" /> when <paramref name="s2" /> is a prefix for
3875 the string <paramref name="s1" />. Meaning, the characters at the
3876 beginning of <paramref name="s1" /> are identical to
3877 <paramref name="s2" />; otherwise, <see langword="false" />.
3878 </returns>
3879 <remarks>
3880 This function performs a case-sensitive word search using the
3881 invariant culture.
3882 </remarks>
3883 <example>
3884 <code>string::starts-with('testing string', 'test') ==> true</code>
3885 </example>
3886 <example>
3887 <code>string::starts-with('testing string', 'testing') ==> true</code>
3888 </example>
3889 <example>
3890 <code>string::starts-with('testing string', 'string') ==> false</code>
3891 </example>
3892 <example>
3893 <code>string::starts-with('test', 'testing string') ==> false</code>
3894 </example>
3895 </member>
3896 <member name="M:NAnt.Core.Functions.StringFunctions.EndsWith(System.String,System.String)">
3897 <summary>
3898 Tests whether the specified string ends with the specified suffix
3899 string.
3900 </summary>
3901 <param name="s1">test string</param>
3902 <param name="s2">suffix string</param>
3903 <returns>
3904 <see langword="true" /> when <paramref name="s2" /> is a suffix for
3905 the string <paramref name="s1" />. Meaning, the characters at the
3906 end of <paramref name="s1" /> are identical to
3907 <paramref name="s2" />; otherwise, <see langword="false" />.
3908 </returns>
3909 <remarks>
3910 This function performs a case-sensitive word search using the
3911 invariant culture.
3912 </remarks>
3913 <example>
3914 <code>string::ends-with('testing string', 'string') ==> true</code>
3915 </example>
3916 <example>
3917 <code>string::ends-with('testing string', '') ==> true</code>
3918 </example>
3919 <example>
3920 <code>string::ends-with('testing string', 'bring') ==> false</code>
3921 </example>
3922 <example>
3923 <code>string::ends-with('string', 'testing string') ==> false</code>
3924 </example>
3925 </member>
3926 <member name="M:NAnt.Core.Functions.StringFunctions.ToLower(System.String)">
3927 <summary>
3928 Returns the specified string converted to lowercase.
3929 </summary>
3930 <param name="s">input string</param>
3931 <returns>
3932 The string <paramref name="s" /> in lowercase.
3933 </returns>
3934 <remarks>
3935 The casing rules of the invariant culture are used to convert the
3936 <paramref name="s" /> to lowercase.
3937 </remarks>
3938 <example>
3939 <code>string::to-lower('testing string') ==> 'testing string'</code>
3940 </example>
3941 <example>
3942 <code>string::to-lower('Testing String') ==> 'testing string'</code>
3943 </example>
3944 <example>
3945 <code>string::to-lower('Test 123') ==> 'test 123'</code>
3946 </example>
3947 </member>
3948 <member name="M:NAnt.Core.Functions.StringFunctions.ToUpper(System.String)">
3949 <summary>
3950 Returns the specified string converted to uppercase.
3951 </summary>
3952 <param name="s">input string</param>
3953 <returns>
3954 The string <paramref name="s" /> in uppercase.
3955 </returns>
3956 <remarks>
3957 The casing rules of the invariant culture are used to convert the
3958 <paramref name="s" /> to uppercase.
3959 </remarks>
3960 <example>
3961 <code>string::to-upper('testing string') ==> 'TESTING STRING'</code>
3962 </example>
3963 <example>
3964 <code>string::to-upper('Testing String') ==> 'TESTING STRING'</code>
3965 </example>
3966 <example>
3967 <code>string::to-upper('Test 123') ==> 'TEST 123'</code>
3968 </example>
3969 </member>
3970 <member name="M:NAnt.Core.Functions.StringFunctions.Replace(System.String,System.String,System.String)">
3971 <summary>
3972 Returns a string corresponding to the replacement of a given string
3973 with another in the specified string.
3974 </summary>
3975 <param name="str">input string</param>
3976 <param name="oldValue">A <see cref="T:System.String"/> to be replaced.</param>
3977 <param name="newValue">A <see cref="T:System.String"/> to replace all occurrences of <paramref name="oldValue"/>.</param>
3978 <returns>
3979 A <see cref="T:System.String"/> equivalent to <paramref name="str"/> but
3980 with all instances of <paramref name="oldValue"/> replaced with
3981 <paramref name="newValue"/>.
3982 </returns>
3983 <exception cref="T:System.ArgumentException"><paramref name="oldValue"/> is an empty string.</exception>
3984 <remarks>
3985 This function performs a word (case-sensitive and culture-sensitive)
3986 search to find <paramref name="oldValue"/>.
3987 </remarks>
3988 <example>
3989 <code>string::replace('testing string', 'test', 'winn') ==> 'winning string'</code>
3990 </example>
3991 <example>
3992 <code>string::replace('testing string', 'foo', 'winn') ==> 'testing string'</code>
3993 </example>
3994 <example>
3995 <code>string::replace('testing string', 'ing', '') ==> 'test str'</code>
3996 </example>
3997 <example>
3998 <code>string::replace('banana', 'ana', 'ana') ==> 'banana'</code>
3999 </example>
4000 </member>
4001 <member name="M:NAnt.Core.Functions.StringFunctions.Contains(System.String,System.String)">
4002 <summary>
4003 Tests whether the specified string contains the given search string.
4004 </summary>
4005 <param name="source">The string to search.</param>
4006 <param name="value">The string to locate within <paramref name="source" />.</param>
4007 <returns>
4008 <see langword="true" /> if <paramref name="value" /> is found in
4009 <paramref name="source" />; otherwise, <see langword="false" />.
4010 </returns>
4011 <remarks>
4012 This function performs a case-sensitive word search using the
4013 invariant culture.
4014 </remarks>
4015 <example>
4016 <code>string::contains('testing string', 'test') ==> true</code>
4017 </example>
4018 <example>
4019 <code>string::contains('testing string', '') ==> true</code>
4020 </example>
4021 <example>
4022 <code>string::contains('testing string', 'Test') ==> false</code>
4023 </example>
4024 <example>
4025 <code>string::contains('testing string', 'foo') ==> false</code>
4026 </example>
4027 </member>
4028 <member name="M:NAnt.Core.Functions.StringFunctions.IndexOf(System.String,System.String)">
4029 <summary>
4030 Returns the position of the first occurrence in the specified string
4031 of the given search string.
4032 </summary>
4033 <param name="source">The string to search.</param>
4034 <param name="value">The string to locate within <paramref name="source" />.</param>
4035 <returns>
4036 <para>
4037 The lowest-index position of <paramref name="value" /> in
4038 <paramref name="source" /> if it is found, or -1 if <paramref name="source" />
4039 does not contain <paramref name="value" />.
4040 </para>
4041 <para>
4042 If <paramref name="value" /> is an empty string, the return value
4043 will always be <c>0</c>.
4044 </para>
4045 </returns>
4046 <remarks>
4047 This function performs a case-sensitive word search using the
4048 invariant culture.
4049 </remarks>
4050 <example>
4051 <code>string::index-of('testing string', 'test') ==> 0</code>
4052 </example>
4053 <example>
4054 <code>string::index-of('testing string', '') ==> 0</code>
4055 </example>
4056 <example>
4057 <code>string::index-of('testing string', 'Test') ==> -1</code>
4058 </example>
4059 <example>
4060 <code>string::index-of('testing string', 'ing') ==> 4</code>
4061 </example>
4062 </member>
4063 <member name="M:NAnt.Core.Functions.StringFunctions.LastIndexOf(System.String,System.String)">
4064 <summary>
4065 Returns the position of the last occurrence in the specified string
4066 of the given search string.
4067 </summary>
4068 <param name="source">The string to search.</param>
4069 <param name="value">The string to locate within <paramref name="source" />.</param>
4070 <returns>
4071 <para>
4072 The highest-index position of <paramref name="value" /> in
4073 <paramref name="source" /> if it is found, or -1 if <paramref name="source" />
4074 does not contain <paramref name="value" />.
4075 </para>
4076 <para>
4077 If <paramref name="value" /> is an empty string, the return value
4078 is the last index position in <paramref name="source" />.
4079 </para>
4080 </returns>
4081 <remarks>
4082 This function performs a case-sensitive word search using the
4083 invariant culture.
4084 </remarks>
4085 <example>
4086 <code>string::last-index-of('testing string', 'test') ==> 0</code>
4087 </example>
4088 <example>
4089 <code>string::last-index-of('testing string', '') ==> 13</code>
4090 </example>
4091 <example>
4092 <code>string::last-index-of('testing string', 'Test') ==> -1</code>
4093 </example>
4094 <example>
4095 <code>string::last-index-of('testing string', 'ing') ==> 11</code>
4096 </example>
4097 </member>
4098 <member name="M:NAnt.Core.Functions.StringFunctions.PadLeft(System.String,System.Int32,System.String)">
4099 <summary>
4100 Returns the given string left-padded to the given length.
4101 </summary>
4102 <param name="s">The <see cref="T:System.String"/> that needs to be left-padded.</param>
4103 <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param>
4104 <param name="paddingChar">A Unicode padding character.</param>
4105 <returns>
4106 If the length of <paramref name="s"/> is at least
4107 <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical
4108 to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/>
4109 will be padded on the left with as many <paramref name="paddingChar"/>
4110 characters as needed to create a length of <paramref name="totalWidth"/>.
4111 </returns>
4112 <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception>
4113 <remarks>
4114 Note that only the first character of <paramref name="paddingChar"/>
4115 will be used when padding the result.
4116 </remarks>
4117 <example>
4118 <code>string::pad-left('test', 10, ' ') ==> ' test'</code>
4119 </example>
4120 <example>
4121 <code>string::pad-left('test', 10, 'test') ==> 'tttttttest'</code>
4122 </example>
4123 <example>
4124 <code>string::pad-left('test', 3, ' ') ==> 'test'</code>
4125 </example>
4126 <example>
4127 <code>string::pad-left('test', -4, ' ') ==> ERROR</code>
4128 </example>
4129 </member>
4130 <member name="M:NAnt.Core.Functions.StringFunctions.PadRight(System.String,System.Int32,System.String)">
4131 <summary>
4132 Returns the given string right-padded to the given length.
4133 </summary>
4134 <param name="s">The <see cref="T:System.String"/> that needs to be right-padded.</param>
4135 <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param>
4136 <param name="paddingChar">A Unicode padding character.</param>
4137 <returns>
4138 If the length of <paramref name="s"/> is at least
4139 <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical
4140 to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/>
4141 will be padded on the right with as many <paramref name="paddingChar"/>
4142 characters as needed to create a length of <paramref name="totalWidth"/>.
4143 </returns>
4144 <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception>
4145 <remarks>
4146 Note that only the first character of <paramref name="paddingChar"/>
4147 will be used when padding the result.
4148 </remarks>
4149 <example>
4150 <code>string::pad-right('test', 10, ' ') ==> 'test '</code>
4151 </example>
4152 <example>
4153 <code>string::pad-right('test', 10, 'abcd') ==> 'testaaaaaa'</code>
4154 </example>
4155 <example>
4156 <code>string::pad-right('test', 3, ' ') ==> 'test'</code>
4157 </example>
4158 <example>
4159 <code>string::pad-right('test', -3, ' ') ==> ERROR</code>
4160 </example>
4161 </member>
4162 <member name="M:NAnt.Core.Functions.StringFunctions.Trim(System.String)">
4163 <summary>
4164 Returns the given string trimmed of whitespace.
4165 </summary>
4166 <param name="s">input string</param>
4167 <returns>
4168 The string <paramref name="s" /> with any leading or trailing
4169 white space characters removed.
4170 </returns>
4171 <example>
4172 <code>string::trim(' test ') ==> 'test'</code>
4173 </example>
4174 <example>
4175 <code>string::trim('\t\tfoo \r\n') ==> 'foo'</code>
4176 </example>
4177 </member>
4178 <member name="M:NAnt.Core.Functions.StringFunctions.TrimStart(System.String)">
4179 <summary>
4180 Returns the given string trimmed of leading whitespace.
4181 </summary>
4182 <param name="s">input string</param>
4183 <returns>
4184 The string <paramref name="s" /> with any leading
4185 whites pace characters removed.
4186 </returns>
4187 <example>
4188 <code>string::trim-start(' test ') ==> 'test '</code>
4189 </example>
4190 <example>
4191 <code>string::trim-start('\t\tfoo \r\n') ==> 'foo \r\n'</code>
4192 </example>
4193 </member>
4194 <member name="M:NAnt.Core.Functions.StringFunctions.TrimEnd(System.String)">
4195 <summary>
4196 Returns the given string trimmed of trailing whitespace.
4197 </summary>
4198 <param name="s">input string</param>
4199 <returns>
4200 The string <paramref name="s" /> with any trailing
4201 white space characters removed.
4202 </returns>
4203 <example>
4204 <code>string::trim-end(' test ') ==> ' test'</code>
4205 </example>
4206 <example>
4207 <code>string::trim-end('\t\tfoo \r\n') ==> '\t\tfoo'</code>
4208 </example>
4209 </member>
4210 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalDays(System.TimeSpan)">
4211 <summary>
4212 Returns the total number of days represented by the specified
4213 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional days.
4214 </summary>
4215 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4216 <returns>
4217 The total number of days represented by the given <see cref="T:System.TimeSpan"/>.
4218 </returns>
4219 </member>
4220 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalHours(System.TimeSpan)">
4221 <summary>
4222 Returns the total number of hours represented by the specified
4223 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional hours.
4224 </summary>
4225 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4226 <returns>
4227 The total number of hours represented by the given <see cref="T:System.TimeSpan"/>.
4228 </returns>
4229 </member>
4230 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMinutes(System.TimeSpan)">
4231 <summary>
4232 Returns the total number of minutes represented by the specified
4233 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional minutes.
4234 </summary>
4235 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4236 <returns>
4237 The total number of minutes represented by the given <see cref="T:System.TimeSpan"/>.
4238 </returns>
4239 </member>
4240 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalSeconds(System.TimeSpan)">
4241 <summary>
4242 Returns the total number of seconds represented by the specified
4243 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional seconds.
4244 </summary>
4245 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4246 <returns>
4247 The total number of seconds represented by the given <see cref="T:System.TimeSpan"/>.
4248 </returns>
4249 </member>
4250 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMilliseconds(System.TimeSpan)">
4251 <summary>
4252 Returns the total number of milliseconds represented by the specified
4253 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional milliseconds.
4254 </summary>
4255 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4256 <returns>
4257 The total number of milliseconds represented by the given
4258 <see cref="T:System.TimeSpan"/>.
4259 </returns>
4260 </member>
4261 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetDays(System.TimeSpan)">
4262 <summary>
4263 Returns the number of whole days represented by the specified
4264 <see cref="T:System.TimeSpan"/>.
4265 </summary>
4266 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4267 <returns>
4268 The number of whole days represented by the given
4269 <see cref="T:System.TimeSpan"/>.
4270 </returns>
4271 <example>
4272 <para>
4273 Remove all files that have not been modified in the last 7 days from directory "binaries".</para>
4274 <code>
4275 <![CDATA[
4276 <foreach item="File" in="binaries" property="filename">
4277 <if test="${timespan::get-days(datetime::now() - file::get-last-write-time(filename)) >= 7}">
4278 <delete file="${filename}" />
4279 </if>
4280 </foreach>
4281 ]]>
4282 </code>
4283 </example>
4284 </member>
4285 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetHours(System.TimeSpan)">
4286 <summary>
4287 Returns the number of whole hours represented by the specified
4288 <see cref="T:System.TimeSpan"/>.
4289 </summary>
4290 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4291 <returns>
4292 The number of whole hours represented by the given
4293 <see cref="T:System.TimeSpan"/>.
4294 </returns>
4295 </member>
4296 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMinutes(System.TimeSpan)">
4297 <summary>
4298 Returns the number of whole minutes represented by the specified
4299 <see cref="T:System.TimeSpan"/>.
4300 </summary>
4301 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4302 <returns>
4303 The number of whole minutes represented by the given
4304 <see cref="T:System.TimeSpan"/>.
4305 </returns>
4306 </member>
4307 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetSeconds(System.TimeSpan)">
4308 <summary>
4309 Returns the number of whole seconds represented by the specified
4310 <see cref="T:System.TimeSpan"/>.
4311 </summary>
4312 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4313 <returns>
4314 The number of whole seconds represented by the given
4315 <see cref="T:System.TimeSpan"/>.
4316 </returns>
4317 </member>
4318 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMilliseconds(System.TimeSpan)">
4319 <summary>
4320 Returns the number of whole milliseconds represented by the specified
4321 <see cref="T:System.TimeSpan"/>.
4322 </summary>
4323 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4324 <returns>
4325 The number of whole milliseconds represented by the given
4326 <see cref="T:System.TimeSpan"/>.
4327 </returns>
4328 </member>
4329 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTicks(System.TimeSpan)">
4330 <summary>
4331 Returns the number of ticks contained in the specified
4332 <see cref="T:System.TimeSpan"/>.
4333 </summary>
4334 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4335 <returns>
4336 The number of ticks contained in the given <see cref="T:System.TimeSpan"/>.
4337 </returns>
4338 </member>
4339 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromDays(System.Double)">
4340 <summary>
4341 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4342 of days, where the specification is accurate to the nearest millisecond.
4343 </summary>
4344 <param name="value">A number of days, accurate to the nearest millisecond.</param>
4345 <returns>
4346 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4347 </returns>
4348 </member>
4349 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromHours(System.Double)">
4350 <summary>
4351 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4352 of hours, where the specification is accurate to the nearest
4353 millisecond.
4354 </summary>
4355 <param name="value">A number of hours, accurate to the nearest millisecond.</param>
4356 <returns>
4357 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4358 </returns>
4359 </member>
4360 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMinutes(System.Double)">
4361 <summary>
4362 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4363 of minutes, where the specification is accurate to the nearest
4364 millisecond.
4365 </summary>
4366 <param name="value">A number of minutes, accurate to the nearest millisecond.</param>
4367 <returns>
4368 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4369 </returns>
4370 </member>
4371 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromSeconds(System.Double)">
4372 <summary>
4373 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4374 of seconds, where the specification is accurate to the nearest
4375 millisecond.
4376 </summary>
4377 <param name="value">A number of seconds, accurate to the nearest millisecond.</param>
4378 <returns>
4379 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4380 </returns>
4381 </member>
4382 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMilliseconds(System.Double)">
4383 <summary>
4384 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4385 of milliseconds.
4386 </summary>
4387 <param name="value">A number of milliseconds.</param>
4388 <returns>
4389 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4390 </returns>
4391 </member>
4392 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromTicks(System.Int64)">
4393 <summary>
4394 Returns a <see cref="T:System.TimeSpan"/> that represents a specified time,
4395 where the specification is in units of ticks.
4396 </summary>
4397 <param name="value">A number of ticks that represent a time.</param>
4398 <returns>
4399 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4400 </returns>
4401 </member>
4402 <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.Parse(System.String)">
4403 <summary>
4404 Constructs a <see cref="T:System.TimeSpan"/> from a time indicated by a
4405 specified string.
4406 </summary>
4407 <param name="s">A string.</param>
4408 <returns>
4409 A <see cref="T:System.TimeSpan"/> that corresponds to <paramref name="s"/>.
4410 </returns>
4411 <exception cref="T:System.FormatException"><paramref name="s"/> has an invalid format.</exception>
4412 <exception cref="T:System.OverflowException">At least one of the hours, minutes, or seconds components is outside its valid range.</exception>
4413 </member>
4414 <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.ToString(System.TimeSpan)">
4415 <summary>
4416 Converts the specified <see cref="T:System.TimeSpan"/> to its equivalent
4417 string representation.
4418 </summary>
4419 <param name="value">A <see cref="T:System.TimeSpan"/> to convert.</param>
4420 <returns>
4421 The string representation of <paramref name="value"/>. The format
4422 of the return value is of the form: [-][d.]hh:mm:ss[.ff].
4423 </returns>
4424 </member>
4425 <member name="M:NAnt.Core.Functions.VersionFunctions.GetMajor(System.Version)">
4426 <summary>
4427 Gets the value of the major component of a given version.
4428 </summary>
4429 <param name="version">A version.</param>
4430 <returns>
4431 The major version number.
4432 </returns>
4433 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4434 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4435 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4436 </member>
4437 <member name="M:NAnt.Core.Functions.VersionFunctions.GetMinor(System.Version)">
4438 <summary>
4439 Gets the value of the minor component of a given version.
4440 </summary>
4441 <param name="version">A version.</param>
4442 <returns>
4443 The minor version number.
4444 </returns>
4445 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4446 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4447 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4448 </member>
4449 <member name="M:NAnt.Core.Functions.VersionFunctions.GetBuild(System.Version)">
4450 <summary>
4451 Gets the value of the build component of a given version.
4452 </summary>
4453 <param name="version">A version.</param>
4454 <returns>
4455 The build number, or -1 if the build number is undefined.
4456 </returns>
4457 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4458 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4459 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4460 </member>
4461 <member name="M:NAnt.Core.Functions.VersionFunctions.GetRevision(System.Version)">
4462 <summary>
4463 Gets the value of the revision component of a given version.
4464 </summary>
4465 <param name="version">A version.</param>
4466 <returns>
4467 The revision number, or -1 if the revision number is undefined.
4468 </returns>
4469 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4470 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4471 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4472 </member>
4473 <member name="M:NAnt.Core.Functions.VersionConversionFunctions.Parse(System.String)">
4474 <summary>
4475 Converts the specified string representation of a version to
4476 its <see cref="T:System.Version"/> equivalent.
4477 </summary>
4478 <param name="version">A string containing the major, minor, build, and revision numbers, where each number is delimited with a period character ('.').</param>
4479 <returns>
4480 A <see cref="T:System.Version"/> instance representing the specified
4481 <see cref="T:System.String"/>.
4482 </returns>
4483 <exception cref="T:System.ArgumentException"><paramref name="version"/> has fewer than two components or more than four components.</exception>
4484 <exception cref="T:System.ArgumentOutOfRangeException">A major, minor, build, or revision component is less than zero.</exception>
4485 <exception cref="T:System.FormatException">At least one component of <paramref name="version"/> does not parse to a decimal integer.</exception>
4486 </member>
4487 <member name="M:NAnt.Core.Functions.VersionConversionFunctions.ToString(System.Version)">
4488 <summary>
4489 Converts the specified <see cref="T:System.Version"/> to its equivalent
4490 string representation.
4491 </summary>
4492 <param name="value">A <see cref="T:System.Version"/> to convert.</param>
4493 <returns>
4494 The string representation of the values of the major, minor, build,
4495 and revision components of the specified <see cref="T:System.Version"/>.
4496 </returns>
4497 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4498 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4499 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4500 </member>
4501 <member name="T:NAnt.Core.Tasks.AttribTask">
4502 <summary>
4503 Changes the file attributes of a file or set of files and directories.
4504 </summary>
4505 <remarks>
4506 <para>
4507 <see cref="T:NAnt.Core.Tasks.AttribTask"/> does not have the concept of turning
4508 attributes off. Instead you specify all the attributes that you want
4509 turned on and the rest are turned off by default.
4510 </para>
4511 <para>
4512 Refer to the <see cref="T:System.IO.FileAttributes"/> enumeration in the .NET SDK
4513 for more information about file attributes.
4514 </para>
4515 </remarks>
4516 <example>
4517 <para>
4518 Set the <c>read-only</c> file attribute for the specified file in
4519 the project directory.
4520 </para>
4521 <code>
4522 <![CDATA[
4523 <attrib file="myfile.txt" readonly="true" />
4524 ]]>
4525 </code>
4526 </example>
4527 <example>
4528 <para>
4529 Set the <c>normal</c> file attribute for the specified file.
4530 </para>
4531 <code>
4532 <![CDATA[
4533 <attrib file="myfile.txt" normal="true" />
4534 ]]>
4535 </code>
4536 </example>
4537 <example>
4538 <para>
4539 Set the <c>normal</c> file attribute for all executable files in
4540 the current project directory and sub-directories.
4541 </para>
4542 <code>
4543 <![CDATA[
4544 <attrib normal="true">
4545 <fileset>
4546 <include name="**/*.exe" />
4547 <include name="bin" />
4548 </fileset>
4549 </attrib>
4550 ]]>
4551 </code>
4552 </example>
4553 </member>
4554 <member name="T:NAnt.Core.Task">
4555 <summary>
4556 Provides the abstract base class for tasks.
4557 </summary>
4558 <remarks>
4559 A task is a piece of code that can be executed.
4560 </remarks>
4561 </member>
4562 <member name="M:NAnt.Core.Task.Execute">
4563 <summary>
4564 Executes the task unless it is skipped.
4565 </summary>
4566 </member>
4567 <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String)">
4568 <summary>
4569 Logs a message with the given priority.
4570 </summary>
4571 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
4572 <param name="message">The message to be logged.</param>
4573 <remarks>
4574 <para>
4575 The actual logging is delegated to the project.
4576 </para>
4577 <para>
4578 If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a
4579 message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the
4580 priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>
4581 when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>.
4582 </para>
4583 <para>
4584 This will allow individual tasks to run in verbose mode while
4585 the build log itself is still configured with threshold
4586 <see cref="F:NAnt.Core.Level.Info"/>.
4587 </para>
4588 <para>
4589 The threshold of the project is not taken into account to determine
4590 whether a message should be passed to the logging infrastructure,
4591 as build listeners might be interested in receiving all messages.
4592 </para>
4593 </remarks>
4594 </member>
4595 <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String,System.Object[])">
4596 <summary>
4597 Logs a formatted message with the given priority.
4598 </summary>
4599 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
4600 <param name="message">The message to log, containing zero or more format items.</param>
4601 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
4602 <remarks>
4603 <para>
4604 The actual logging is delegated to the project.
4605 </para>
4606 <para>
4607 If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a
4608 message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the
4609 priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>.
4610 when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>.
4611 </para>
4612 <para>
4613 This will allow individual tasks to run in verbose mode while
4614 the build log itself is still configured with threshold
4615 <see cref="F:NAnt.Core.Level.Info"/>.
4616 </para>
4617 </remarks>
4618 </member>
4619 <member name="M:NAnt.Core.Task.IsLogEnabledFor(NAnt.Core.Level)">
4620 <summary>
4621 Determines whether build output is enabled for the given
4622 <see cref="T:NAnt.Core.Level"/>.
4623 </summary>
4624 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to check.</param>
4625 <returns>
4626 <see langword="true"/> if messages with the given <see cref="T:NAnt.Core.Level"/>
4627 should be passed on to the logging infrastructure; otherwise,
4628 <see langword="false"/>.
4629 </returns>
4630 <remarks>
4631 The threshold of the project is not taken into account to determine
4632 whether a message should be passed to the logging infrastructure,
4633 as build listeners might be interested in receiving all messages.
4634 </remarks>
4635 </member>
4636 <member name="M:NAnt.Core.Task.InitializeTaskConfiguration">
4637 <summary>
4638 Initializes the configuration of the task using configuration
4639 settings retrieved from the NAnt configuration file.
4640 </summary>
4641 <remarks>
4642 TO-DO : Remove this temporary hack when a permanent solution is
4643 available for loading the default values from the configuration
4644 file if a build element is constructed from code.
4645 </remarks>
4646 </member>
4647 <member name="M:NAnt.Core.Task.Initialize">
4648 <summary>Initializes the task.</summary>
4649 </member>
4650 <member name="M:NAnt.Core.Task.InitializeTask(System.Xml.XmlNode)">
4651 <summary>Initializes the task.</summary>
4652 </member>
4653 <member name="M:NAnt.Core.Task.ExecuteTask">
4654 <summary>Executes the task.</summary>
4655 </member>
4656 <member name="M:NAnt.Core.Task.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)">
4657 <summary>
4658 Locates the XML node for the specified attribute in either the
4659 configuration section of the extension assembly or the.project.
4660 </summary>
4661 <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param>
4662 <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>
4663 <returns>
4664 The XML configuration node for the specified attribute, or
4665 <see langword="null" /> if no corresponding XML node could be
4666 located.
4667 </returns>
4668 <remarks>
4669 If there's a valid current framework, the configuration section for
4670 that framework will first be searched. If no corresponding
4671 configuration node can be located in that section, the framework-neutral
4672 section of the project configuration node will be searched.
4673 </remarks>
4674 </member>
4675 <member name="P:NAnt.Core.Task.FailOnError">
4676 <summary>
4677 Determines if task failure stops the build, or is just reported.
4678 The default is <see langword="true" />.
4679 </summary>
4680 </member>
4681 <member name="P:NAnt.Core.Task.Verbose">
4682 <summary>
4683 Determines whether the task should report detailed build log messages.
4684 The default is <see langword="false" />.
4685 </summary>
4686 </member>
4687 <member name="P:NAnt.Core.Task.IfDefined">
4688 <summary>
4689 If <see langword="true" /> then the task will be executed; otherwise,
4690 skipped. The default is <see langword="true" />.
4691 </summary>
4692 </member>
4693 <member name="P:NAnt.Core.Task.UnlessDefined">
4694 <summary>
4695 Opposite of <see cref="P:NAnt.Core.Task.IfDefined"/>. If <see langword="false"/>
4696 then the task will be executed; otherwise, skipped. The default is
4697 <see langword="false"/>.
4698 </summary>
4699 </member>
4700 <member name="P:NAnt.Core.Task.Name">
4701 <summary>
4702 The name of the task.
4703 </summary>
4704 </member>
4705 <member name="P:NAnt.Core.Task.LogPrefix">
4706 <summary>
4707 The prefix used when sending messages to the log.
4708 </summary>
4709 </member>
4710 <member name="P:NAnt.Core.Task.Threshold">
4711 <summary>
4712 Gets or sets the log threshold for this <see cref="T:NAnt.Core.Task"/>. By
4713 default the threshold of a task is <see cref="F:NAnt.Core.Level.Debug"/>,
4714 causing no messages to be filtered in the task itself.
4715 </summary>
4716 <value>
4717 The log threshold level for this <see cref="T:NAnt.Core.Task"/>.
4718 </value>
4719 <remarks>
4720 When the threshold of a <see cref="T:NAnt.Core.Task"/> is higher than the
4721 threshold of the <see cref="T:NAnt.Core.Project"/>, then all messages will
4722 still be delivered to the build listeners.
4723 </remarks>
4724 </member>
4725 <member name="P:NAnt.Core.Task.TaskBuilder">
4726 <summary>
4727 Returns the TaskBuilder used to construct an instance of this
4728 <see cref="T:NAnt.Core.Task"/>.
4729 </summary>
4730 </member>
4731 <member name="P:NAnt.Core.Tasks.AttribTask.File">
4732 <summary>
4733 The name of the file which will have its attributes set. This is
4734 provided as an alternate to using the task's fileset.
4735 </summary>
4736 </member>
4737 <member name="P:NAnt.Core.Tasks.AttribTask.AttribFileSet">
4738 <summary>
4739 All the matching files and directories in this fileset will have
4740 their attributes set.
4741 </summary>
4742 </member>
4743 <member name="P:NAnt.Core.Tasks.AttribTask.ArchiveAttrib">
4744 <summary>
4745 Set the archive attribute. The default is <see langword="false" />.
4746 </summary>
4747 </member>
4748 <member name="P:NAnt.Core.Tasks.AttribTask.HiddenAttrib">
4749 <summary>
4750 Set the hidden attribute. The default is <see langword="false" />.
4751 </summary>
4752 </member>
4753 <member name="P:NAnt.Core.Tasks.AttribTask.NormalAttrib">
4754 <summary>
4755 Set the normal file attributes. This attribute is only valid if used
4756 alone. The default is <see langword="false" />.
4757 </summary>
4758 </member>
4759 <member name="P:NAnt.Core.Tasks.AttribTask.ReadOnlyAttrib">
4760 <summary>
4761 Set the read-only attribute. The default is <see langword="false" />.
4762 </summary>
4763 </member>
4764 <member name="P:NAnt.Core.Tasks.AttribTask.SystemAttrib">
4765 <summary>
4766 Set the system attribute. The default is <see langword="false" />.
4767 </summary>
4768 </member>
4769 <member name="T:NAnt.Core.Tasks.AvailableTask">
4770 <summary>
4771 Checks if a resource is available at runtime.
4772 </summary>
4773 <remarks>
4774 <para>
4775 The specified property is set to <see langword="true"/> if the
4776 requested resource is available at runtime, and <see langword="false"/>
4777 if the resource is not available.
4778 </para>
4779 <note>
4780 we advise you to use the following functions instead:
4781 </note>
4782 <list type="table">
4783 <listheader>
4784 <term>Function</term>
4785 <description>Description</description>
4786 </listheader>
4787 <item>
4788 <term><see cref="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)"/></term>
4789 <description>Determines whether the specified file exists.</description>
4790 </item>
4791 <item>
4792 <term><see cref="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)"/></term>
4793 <description>Determines whether the given path refers to an existing directory on disk.</description>
4794 </item>
4795 <item>
4796 <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)"/></term>
4797 <description>Checks whether the specified framework exists..</description>
4798 </item>
4799 <item>
4800 <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)"/></term>
4801 <description>Checks whether the SDK for the specified framework is installed.</description>
4802 </item>
4803 </list>
4804 </remarks>
4805 <example>
4806 <para>
4807 Sets the <c>myfile.present</c> property to <see langword="true"/> if the
4808 file is available on the filesystem and <see langword="false"/> if the
4809 file is not available.
4810 </para>
4811 <code>
4812 <![CDATA[
4813 <available type="File" resource="myfile.txt" property="myfile.present" />
4814 ]]>
4815 </code>
4816 </example>
4817 <example>
4818 <para>
4819 Sets the <c>build.dir.present</c> property to <see langword="true"/>
4820 if the directory is available on the filesystem and <see langword="false"/>
4821 if the directory is not available.
4822 </para>
4823 <code>
4824 <![CDATA[
4825 <available type="Directory" resource="build" property="build.dir.present" />
4826 ]]>
4827 </code>
4828 </example>
4829 <example>
4830 <para>
4831 Sets the <c>mono-0.21.framework.present</c> property to <see langword="true"/>
4832 if the Mono 0.21 framework is available on the current system and
4833 <see langword="false"/> if the framework is not available.
4834 </para>
4835 <code>
4836 <![CDATA[
4837 <available type="Framework" resource="mono-0.21" property="mono-0.21.framework.present" />
4838 ]]>
4839 </code>
4840 </example>
4841 <example>
4842 <para>
4843 Sets the <c>net-1.1.frameworksdk.present</c> property to <see langword="true"/>
4844 if the .NET 1.1 Framework SDK is available on the current system and
4845 <see langword="false"/> if the SDK is not available.
4846 </para>
4847 <code>
4848 <![CDATA[
4849 <available type="FrameworkSDK" resource="net-1.1" property="net-1.1.frameworksdk.present" />
4850 ]]>
4851 </code>
4852 </example>
4853 </member>
4854 <member name="M:NAnt.Core.Tasks.AvailableTask.ExecuteTask">
4855 <summary>
4856 Executes the task.
4857 </summary>
4858 <remarks>
4859 <para>
4860 Sets the property identified by <see cref="P:NAnt.Core.Tasks.AvailableTask.PropertyName"/> to
4861 <see langword="true"/> when the resource exists and to <see langword="false"/>
4862 when the resource doesn't exist.
4863 </para>
4864 </remarks>
4865 <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception>
4866 </member>
4867 <member name="M:NAnt.Core.Tasks.AvailableTask.Evaluate">
4868 <summary>
4869 Evaluates the availability of a resource.
4870 </summary>
4871 <returns>
4872 <see langword="true"/> if the resource is available; otherwise,
4873 <see langword="false"/>.
4874 </returns>
4875 <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception>
4876 </member>
4877 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFile">
4878 <summary>
4879 Checks if the file specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/> property is
4880 available on the filesystem.
4881 </summary>
4882 <returns>
4883 <see langword="true"/> when the file exists; otherwise, <see langword="false"/>.
4884 </returns>
4885 </member>
4886 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckDirectory">
4887 <summary>
4888 Checks if the directory specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
4889 property is available on the filesystem.
4890 </summary>
4891 <returns>
4892 <see langword="true"/> when the directory exists; otherwise, <see langword="false"/>.
4893 </returns>
4894 </member>
4895 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFramework">
4896 <summary>
4897 Checks if the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
4898 property is available on the current system.
4899 </summary>
4900 <returns>
4901 <see langword="true"/> when the framework is available; otherwise,
4902 <see langword="false"/>.
4903 </returns>
4904 </member>
4905 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFrameworkSDK">
4906 <summary>
4907 Checks if the SDK for the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
4908 property is available on the current system.
4909 </summary>
4910 <returns>
4911 <see langword="true"/> when the SDK for the specified framework is
4912 available; otherwise, <see langword="false"/>.
4913 </returns>
4914 </member>
4915 <member name="P:NAnt.Core.Tasks.AvailableTask.Resource">
4916 <summary>
4917 The resource which must be available.
4918 </summary>
4919 </member>
4920 <member name="P:NAnt.Core.Tasks.AvailableTask.Type">
4921 <summary>
4922 The type of resource which must be present.
4923 </summary>
4924 </member>
4925 <member name="P:NAnt.Core.Tasks.AvailableTask.PropertyName">
4926 <summary>
4927 The property that must be set if the resource is available.
4928 </summary>
4929 </member>
4930 <member name="T:NAnt.Core.Tasks.AvailableTask.ResourceType">
4931 <summary>
4932 Defines the possible resource checks.
4933 </summary>
4934 </member>
4935 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.File">
4936 <summary>
4937 Determines whether a given file exists.
4938 </summary>
4939 </member>
4940 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Directory">
4941 <summary>
4942 Determines whether a given directory exists.
4943 </summary>
4944 </member>
4945 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Framework">
4946 <summary>
4947 Determines whether a given framework is available.
4948 </summary>
4949 </member>
4950 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.FrameworkSDK">
4951 <summary>
4952 Determines whether a given SDK is available.
4953 </summary>
4954 </member>
4955 <member name="T:NAnt.Core.Tasks.CallTask">
4956 <summary>
4957 Calls a NAnt target in the current project.
4958 </summary>
4959 <remarks>
4960 <para>
4961 When the <see cref="T:NAnt.Core.Tasks.CallTask"/> is used to execute a target, both that
4962 target and all its dependent targets will be re-executed.
4963 </para>
4964 <para>
4965 To avoid dependent targets from being executed more than once, two
4966 options are available:
4967 </para>
4968 <list type="bullet">
4969 <item>
4970 <description>
4971 Add an "unless" attribute with value "${<see href="../functions/target.has-executed.html">target::has-executed</see>('<c><target name></c>')}"
4972 to the dependent targets.
4973 </description>
4974 </item>
4975 <item>
4976 <description>
4977 Set the <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute on the
4978 <see cref="T:NAnt.Core.Tasks.CallTask"/> to <see langword="false "/> (<c>recommended</c>).
4979 </description>
4980 </item>
4981 </list>
4982 </remarks>
4983 <example>
4984 <para>
4985 Call the target "build".
4986 </para>
4987 <code>
4988 <![CDATA[
4989 <call target="build" />
4990 ]]>
4991 </code>
4992 </example>
4993 <example>
4994 <para>
4995 This shows how a project could 'compile' a debug and release build
4996 using a common compile target.
4997 </para>
4998 <code>
4999 <![CDATA[
5000 <project default="build">
5001 <property name="debug" value="false" />
5002 <target name="init">
5003 <echo message="initializing" />
5004 </target>
5005 <target name="compile" depends="init">
5006 <echo message="compiling with debug = ${debug}" />
5007 </target>
5008 <target name="build">
5009 <property name="debug" value="false" />
5010 <call target="compile" />
5011 <property name="debug" value="true" />
5012 <call target="compile" />
5013 </target>
5014 </project>
5015 ]]>
5016 </code>
5017 <para>
5018 The <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> parameter of the
5019 <see cref="T:NAnt.Core.Tasks.CallTask"/> defaults to <see langword="true"/>,
5020 causing the "init" target to be executed for both
5021 the "debug" and "release" build.
5022 </para>
5023 <para>
5024 This results in the following build log:
5025 </para>
5026 <code>
5027 build:
5028
5029 init:
5030 [echo] initializing
5031
5032 compile:
5033
5034 [echo] compiling with debug = false
5035
5036 init:
5037
5038 [echo] initializing
5039
5040 compile:
5041
5042 [echo] compiling with debug = true
5043
5044 BUILD SUCCEEDED
5045 </code>
5046 <para>
5047 If the "init" should only be executed once, set the
5048 <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute of the <see cref="T:NAnt.Core.Tasks.CallTask"/>
5049 to <see langword="false"/>.
5050 </para>
5051 <para>
5052 The build log would then look like this:
5053 </para>
5054 <code>
5055 build:
5056
5057 init:
5058 [echo] initializing
5059
5060 compile:
5061
5062 [echo] compiling with debug = false
5063
5064 compile:
5065
5066 [echo] compiling with debug = true
5067
5068 BUILD SUCCEEDED
5069 </code>
5070 </example>
5071 </member>
5072 <member name="M:NAnt.Core.Tasks.CallTask.ExecuteTask">
5073 <summary>
5074 Executes the specified target.
5075 </summary>
5076 </member>
5077 <member name="M:NAnt.Core.Tasks.CallTask.Initialize">
5078 <summary>
5079 Makes sure the <see cref="T:NAnt.Core.Tasks.CallTask"/> is not calling its own
5080 parent.
5081 </summary>
5082 </member>
5083 <member name="P:NAnt.Core.Tasks.CallTask.TargetName">
5084 <summary>
5085 NAnt target to call.
5086 </summary>
5087 </member>
5088 <member name="P:NAnt.Core.Tasks.CallTask.ForceExecute">
5089 <summary>
5090 Force an execute even if the target has already been executed. The
5091 default is <see langword="false" />.
5092 </summary>
5093 </member>
5094 <member name="P:NAnt.Core.Tasks.CallTask.CascadeDependencies">
5095 <summary>
5096 Execute the specified targets dependencies -- even if they have been
5097 previously executed. The default is <see langword="true" />.
5098 </summary>
5099 </member>
5100 <member name="T:NAnt.Core.Tasks.CopyTask">
5101 <summary>
5102 Copies a file or set of files to a new file or directory.
5103 </summary>
5104 <remarks>
5105 <para>
5106 Files are only copied if the source file is newer than the destination
5107 file, or if the destination file does not exist. However, you can
5108 explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/> attribute.
5109 </para>
5110 <para>
5111 When a <see cref="T:NAnt.Core.Types.FileSet"/> is used to select files to copy, the
5112 <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set. Files that are
5113 located under the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/> will
5114 be copied to a directory under the destination directory matching the
5115 path relative to the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/>,
5116 unless the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/> attribute is set to
5117 <see langword="true"/>.
5118 </para>
5119 <para>
5120 Files that are not located under the the base directory of the
5121 <see cref="T:NAnt.Core.Types.FileSet"/> will be copied directly under to the destination
5122 directory, regardless of the value of the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/>
5123 attribute.
5124 </para>
5125 <h4>Encoding</h4>
5126 <para>
5127 Unless an encoding is specified, the encoding associated with the
5128 system's current ANSI code page is used.
5129 </para>
5130 <para>
5131 An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
5132 file is automatically recognized, if the file starts with the
5133 appropriate byte order marks.
5134 </para>
5135 <note>
5136 If you employ filters in your copy operation, you should limit the copy
5137 to text files. Binary files will be corrupted by the copy operation.
5138 </note>
5139 </remarks>
5140 <example>
5141 <para>
5142 Copy a single file while changing its encoding from "latin1" to
5143 "utf-8".
5144 </para>
5145 <code>
5146 <![CDATA[
5147 <copy
5148 file="myfile.txt"
5149 tofile="mycopy.txt"
5150 inputencoding="latin1"
5151 outputencoding="utf-8" />
5152 ]]>
5153 </code>
5154 </example>
5155 <example>
5156 <para>Copy a set of files to a new directory.</para>
5157 <code>
5158 <![CDATA[
5159 <copy todir="${build.dir}">
5160 <fileset basedir="bin">
5161 <include name="*.dll" />
5162 </fileset>
5163 </copy>
5164 ]]>
5165 </code>
5166 </example>
5167 <example>
5168 <para>
5169 Copy a set of files to a directory, replacing <c>@TITLE@</c> with
5170 "Foo Bar" in all files.
5171 </para>
5172 <code>
5173 <![CDATA[
5174 <copy todir="../backup/dir">
5175 <fileset basedir="src_dir">
5176 <include name="**/*" />
5177 </fileset>
5178 <filterchain>
5179 <replacetokens>
5180 <token key="TITLE" value="Foo Bar" />
5181 </replacetokens>
5182 </filterchain>
5183 </copy>
5184 ]]>
5185 </code>
5186 </example>
5187 </member>
5188 <member name="M:NAnt.Core.Tasks.CopyTask.#ctor">
5189 <summary>
5190 Initialize new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>.
5191 </summary>
5192 </member>
5193 <member name="M:NAnt.Core.Tasks.CopyTask.Initialize">
5194 <summary>
5195 Checks whether the task is initialized with valid attributes.
5196 </summary>
5197 </member>
5198 <member name="M:NAnt.Core.Tasks.CopyTask.ExecuteTask">
5199 <summary>
5200 Executes the Copy task.
5201 </summary>
5202 <exception cref="T:NAnt.Core.BuildException">A file that has to be copied does not exist or could not be copied.</exception>
5203 </member>
5204 <member name="M:NAnt.Core.Tasks.CopyTask.DoFileOperations">
5205 <summary>
5206 Actually does the file copies.
5207 </summary>
5208 </member>
5209 <member name="P:NAnt.Core.Tasks.CopyTask.SourceFile">
5210 <summary>
5211 The file to copy.
5212 </summary>
5213 </member>
5214 <member name="P:NAnt.Core.Tasks.CopyTask.ToFile">
5215 <summary>
5216 The file to copy to.
5217 </summary>
5218 </member>
5219 <member name="P:NAnt.Core.Tasks.CopyTask.ToDirectory">
5220 <summary>
5221 The directory to copy to.
5222 </summary>
5223 </member>
5224 <member name="P:NAnt.Core.Tasks.CopyTask.Overwrite">
5225 <summary>
5226 Overwrite existing files even if the destination files are newer.
5227 The default is <see langword="false" />.
5228 </summary>
5229 </member>
5230 <member name="P:NAnt.Core.Tasks.CopyTask.Flatten">
5231 <summary>
5232 Ignore directory structure of source directory, copy all files into
5233 a single directory, specified by the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/>
5234 attribute. The default is <see langword="false"/>.
5235 </summary>
5236 </member>
5237 <member name="P:NAnt.Core.Tasks.CopyTask.IncludeEmptyDirs">
5238 <summary>
5239 Copy any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>.
5240 The default is <see langword="true"/>.
5241 </summary>
5242 </member>
5243 <member name="P:NAnt.Core.Tasks.CopyTask.CopyFileSet">
5244 <summary>
5245 Used to select the files to copy. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
5246 the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set.
5247 </summary>
5248 </member>
5249 <member name="P:NAnt.Core.Tasks.CopyTask.Filters">
5250 <summary>
5251 Chain of filters used to alter the file's content as it is copied.
5252 </summary>
5253 </member>
5254 <member name="P:NAnt.Core.Tasks.CopyTask.InputEncoding">
5255 <summary>
5256 The encoding to use when reading files. The default is the system's
5257 current ANSI code page.
5258 </summary>
5259 </member>
5260 <member name="P:NAnt.Core.Tasks.CopyTask.OutputEncoding">
5261 <summary>
5262 The encoding to use when writing the files. The default is
5263 the encoding of the input file.
5264 </summary>
5265 </member>
5266 <member name="P:NAnt.Core.Tasks.CopyTask.FileCopyMap">
5267 <summary>
5268 The set of files to perform a file operation on.
5269 </summary>
5270 <remarks>
5271 <para>
5272 The key of the <see cref="T:System.Collections.Hashtable"/> is the absolute path of
5273 the destination file and the value is a <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/>
5274 holding the path and last write time of the most recently updated
5275 source file that is selected to be copied or moved to the
5276 destination file.
5277 </para>
5278 <para>
5279 On Windows, the <see cref="T:System.Collections.Hashtable"/> is case-insensitive.
5280 </para>
5281 </remarks>
5282 </member>
5283 <member name="T:NAnt.Core.Tasks.CopyTask.FileDateInfo">
5284 <summary>
5285 Holds the absolute paths and last write time of a given file.
5286 </summary>
5287 </member>
5288 <member name="M:NAnt.Core.Tasks.CopyTask.FileDateInfo.#ctor(System.String,System.DateTime)">
5289 <summary>
5290 Initializes a new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/>
5291 class for the specified file and last write time.
5292 </summary>
5293 <param name="path">The absolute path of the file.</param>
5294 <param name="lastWriteTime">The last write time of the file.</param>
5295 </member>
5296 <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.Path">
5297 <summary>
5298 Gets the absolute path of the current file.
5299 </summary>
5300 <value>
5301 The absolute path of the current file.
5302 </value>
5303 </member>
5304 <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.LastWriteTime">
5305 <summary>
5306 Gets the time when the current file was last written to.
5307 </summary>
5308 <value>
5309 The time when the current file was last written to.
5310 </value>
5311 </member>
5312 <member name="T:NAnt.Core.Tasks.DeleteTask">
5313 <summary>
5314 Deletes a file, fileset or directory.
5315 </summary>
5316 <remarks>
5317 <para>
5318 Deletes either a single file, all files in a specified directory and
5319 its sub-directories, or a set of files specified by one or more filesets.
5320 </para>
5321 <para>
5322 If the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> or <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/> attribute is
5323 set then the fileset contents will be ignored. To delete the files
5324 in the fileset ommit the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> and <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/>
5325 attributes in the <c><delete></c> element.
5326 </para>
5327 <para>
5328 If the specified file or directory does not exist, no error is
5329 reported.
5330 </para>
5331 <note>
5332 Read-only files cannot be deleted. Use the <see cref="T:NAnt.Core.Tasks.AttribTask"/>
5333 first to remove the read-only attribute.
5334 </note>
5335 </remarks>
5336 <example>
5337 <para>Delete a single file.</para>
5338 <code>
5339 <![CDATA[
5340 <delete file="myfile.txt" />
5341 ]]>
5342 </code>
5343 </example>
5344 <example>
5345 <para>
5346 Delete a directory and the contents within. If the directory does not
5347 exist, no error is reported.
5348 </para>
5349 <code>
5350 <![CDATA[
5351 <delete dir="${build.dir}" />
5352 ]]>
5353 </code>
5354 </example>
5355 <example>
5356 <para>
5357 Delete a set of files.
5358 </para>
5359 <code>
5360 <![CDATA[
5361 <delete>
5362 <fileset>
5363 <include name="${basename}-??.exe" />
5364 <include name="${basename}-??.pdb" />
5365 </fileset>
5366 </delete>
5367 ]]>
5368 </code>
5369 </example>
5370 </member>
5371 <member name="M:NAnt.Core.Tasks.DeleteTask.Initialize">
5372 <summary>
5373 Ensures the supplied attributes are valid.
5374 </summary>
5375 </member>
5376 <member name="P:NAnt.Core.Tasks.DeleteTask.File">
5377 <summary>
5378 The file to delete.
5379 </summary>
5380 </member>
5381 <member name="P:NAnt.Core.Tasks.DeleteTask.Directory">
5382 <summary>
5383 The directory to delete.
5384 </summary>
5385 </member>
5386 <member name="P:NAnt.Core.Tasks.DeleteTask.IncludeEmptyDirs">
5387 <summary>
5388 Remove any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>.
5389 The default is <see langword="true"/>.
5390 </summary>
5391 </member>
5392 <member name="P:NAnt.Core.Tasks.DeleteTask.DeleteFileSet">
5393 <summary>
5394 All the files in the file set will be deleted.
5395 </summary>
5396 </member>
5397 <member name="P:NAnt.Core.Tasks.DeleteTask.Verbose">
5398 <summary>
5399 Controls whether to show the name of each deleted file or directory.
5400 The default is <see langword="false" />.
5401 </summary>
5402 </member>
5403 <member name="T:NAnt.Core.Tasks.DescriptionTask">
5404 <summary>
5405 An empty task that allows a build file to contain a description.
5406 </summary>
5407 <example>
5408 <para>Set a description.</para>
5409 <code>
5410 <![CDATA[
5411 <description>This is a description.</description>
5412 ]]>
5413 </code>
5414 </example>
5415 </member>
5416 <member name="T:NAnt.Core.Tasks.EchoTask">
5417 <summary>
5418 Writes a message to the build log or a specified file.
5419 </summary>
5420 <remarks>
5421 <para>
5422 The message can be specified using the <see cref="P:NAnt.Core.Tasks.EchoTask.Message"/> attribute
5423 or as inline content.
5424 </para>
5425 <para>
5426 Macros in the message will be expanded.
5427 </para>
5428 <para>
5429 When writing to a file, the <see cref="P:NAnt.Core.Tasks.EchoTask.MessageLevel"/> attribute is
5430 ignored.
5431 </para>
5432 </remarks>
5433 <example>
5434 <para>
5435 Writes a message with level <see cref="F:NAnt.Core.Level.Debug"/> to the build log.
5436 </para>
5437 <code>
5438 <![CDATA[
5439 <echo message="Hello, World!" level="Debug" />
5440 ]]>
5441 </code>
5442 </example>
5443 <example>
5444 <para>
5445 Writes a message with expanded macro to the build log.
5446 </para>
5447 <code>
5448 <![CDATA[
5449 <echo message="Base build directory = ${nant.project.basedir}" />
5450 ]]>
5451 </code>
5452 </example>
5453 <example>
5454 <para>
5455 Functionally equivalent to the previous example.
5456 </para>
5457 <code>
5458 <![CDATA[
5459 <echo>Base build directory = ${nant.project.basedir}</echo>
5460 ]]>
5461 </code>
5462 </example>
5463 <example>
5464 <para>
5465 Writes the previous message to a file in the project directory,
5466 overwriting the file if it exists.
5467 </para>
5468 <code>
5469 <![CDATA[
5470 <echo file="buildmessage.txt">Base build directory = ${nant.project.basedir}</echo>
5471 ]]>
5472 </code>
5473 </example>
5474 </member>
5475 <member name="M:NAnt.Core.Tasks.EchoTask.ExecuteTask">
5476 <summary>
5477 Outputs the message to the build log or the specified file.
5478 </summary>
5479 </member>
5480 <member name="P:NAnt.Core.Tasks.EchoTask.Message">
5481 <summary>
5482 The message to output.
5483 </summary>
5484 </member>
5485 <member name="P:NAnt.Core.Tasks.EchoTask.Contents">
5486 <summary>
5487 Gets or sets the inline content that should be output.
5488 </summary>
5489 <value>
5490 The inline content that should be output.
5491 </value>
5492 </member>
5493 <member name="P:NAnt.Core.Tasks.EchoTask.File">
5494 <summary>
5495 The file to write the message to.
5496 </summary>
5497 </member>
5498 <member name="P:NAnt.Core.Tasks.EchoTask.Append">
5499 <summary>
5500 Determines whether the <see cref="T:NAnt.Core.Tasks.EchoTask"/> should append to the
5501 file, or overwrite it. By default, the file will be overwritten.
5502 </summary>
5503 <value>
5504 <see langword="true"/> if output should be appended to the file;
5505 otherwise, <see langword="false"/>. The default is
5506 <see langword="false"/>.
5507 </value>
5508 </member>
5509 <member name="P:NAnt.Core.Tasks.EchoTask.MessageLevel">
5510 <summary>
5511 The logging level with which the message should be output. The default
5512 is <see cref="F:NAnt.Core.Level.Info"/>.
5513 </summary>
5514 </member>
5515 <member name="T:NAnt.Core.Tasks.ExecTask">
5516 <summary>
5517 Executes a system command.
5518 </summary>
5519 <remarks>
5520 <para>
5521 Use of nested <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"/> element(s)
5522 is advised over the <see cref="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments"/> parameter, as
5523 it supports automatic quoting and can resolve relative to absolute
5524 paths.
5525 </para>
5526 </remarks>
5527 <example>
5528 <para>Ping "nant.sourceforge.net".</para>
5529 <code>
5530 <![CDATA[
5531 <exec program="ping">
5532 <arg value="nant.sourceforge.net" />
5533 </exec>
5534 ]]>
5535 </code>
5536 </example>
5537 <example>
5538 <para>
5539 Execute a java application using <c>IKVM.NET</c> that requires the
5540 Apache FOP jars, and a set of custom jars.
5541 </para>
5542 <code>
5543 <![CDATA[
5544 <path id="fop-classpath">
5545 <pathelement file="${fop.dist.dir}/build/fop.jar" />
5546 <pathelement file="${fop.dist.dir}/lib/xercesImpl-2.2.1.jar" />
5547 <pathelement file="${fop.dist.dir}/lib/avalon-framework-cvs-20020806.jar" />
5548 <pathelement file="${fop.dist.dir}/lib/batik.jar" />
5549 </path>
5550 <exec program="ikvm.exe" useruntimeengine="true">
5551 <arg value="-cp" />
5552 <arg>
5553 <path>
5554 <pathelement dir="conf" />
5555 <path refid="fop-classpath" />
5556 <pathelement file="lib/mylib.jar" />
5557 <pathelement file="lib/otherlib.zip" />
5558 </path>
5559 </arg>
5560 <arg value="org.me.MyProg" />
5561 </exec>
5562 ]]>
5563 </code>
5564 <para>
5565 Assuming the base directory of the build file is "c:\ikvm-test" and
5566 the value of the "fop.dist.dir" property is "c:\fop", then the value
5567 of the <c>-cp</c> argument that is passed to<c>ikvm.exe</c> is
5568 "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"
5569 on a DOS-based system.
5570 </para>
5571 </example>
5572 </member>
5573 <member name="T:NAnt.Core.Tasks.ExternalProgramBase">
5574 <summary>
5575 Provides the abstract base class for tasks that execute external applications.
5576 </summary>
5577 <remarks>
5578 <para>
5579 When a <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/> is applied to the
5580 deriving class and <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName"/> does not return an
5581 absolute path, then the program to execute will first be searched for
5582 in the location specified by <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/>.
5583 </para>
5584 <para>
5585 If the program does not exist in that location, then the list of tool
5586 paths of the current target framework will be scanned in the order in
5587 which they are defined in the NAnt configuration file.
5588 </para>
5589 </remarks>
5590 </member>
5591 <member name="F:NAnt.Core.Tasks.ExternalProgramBase.UnknownExitCode">
5592 <summary>
5593 Defines the exit code that will be returned by <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode"/>
5594 if the process could not be started, or did not exit (in time).
5595 </summary>
5596 </member>
5597 <member name="F:NAnt.Core.Tasks.ExternalProgramBase._lockObject">
5598 <summary>
5599 Will be used to ensure thread-safe operations.
5600 </summary>
5601 </member>
5602 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.ExecuteTask">
5603 <summary>
5604 Starts the external process and captures its output.
5605 </summary>
5606 <exception cref="T:NAnt.Core.BuildException">
5607 <para>The external process did not finish within the configured timeout.</para>
5608 <para>-or-</para>
5609 <para>The exit code of the external process indicates a failure.</para>
5610 </exception>
5611 </member>
5612 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.PrepareProcess(System.Diagnostics.Process)">
5613 <summary>
5614 Updates the <see cref="T:System.Diagnostics.ProcessStartInfo"/> of the specified
5615 <see cref="T:System.Diagnostics.Process"/>.
5616 </summary>
5617 <param name="process">The <see cref="T:System.Diagnostics.Process"/> of which the <see cref="T:System.Diagnostics.ProcessStartInfo"/> should be updated.</param>
5618 </member>
5619 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StartProcess">
5620 <summary>
5621 Starts the process and handles errors.
5622 </summary>
5623 <returns>The <see cref="T:System.Diagnostics.Process"/> that was started.</returns>
5624 </member>
5625 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Output">
5626 <summary>
5627 Reads from the stream until the external program is ended.
5628 </summary>
5629 </member>
5630 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Error">
5631 <summary>
5632 Reads from the stream until the external program is ended.
5633 </summary>
5634 </member>
5635 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.DetermineFilePath">
5636 <summary>
5637 Determines the path of the external program that should be executed.
5638 </summary>
5639 <returns>
5640 A fully qualifies pathname including the program name.
5641 </returns>
5642 <exception cref="T:NAnt.Core.BuildException">The task is not available or not configured for the current framework.</exception>
5643 </member>
5644 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName">
5645 <summary>
5646 The name of the executable that should be used to launch the
5647 external program.
5648 </summary>
5649 <value>
5650 The name of the executable that should be used to launch the external
5651 program, or <see langword="null" /> if no name is specified.
5652 </value>
5653 <remarks>
5654 If available, the configured value in the NAnt configuration
5655 file will be used if no name is specified.
5656 </remarks>
5657 </member>
5658 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramFileName">
5659 <summary>
5660 Gets the filename of the external program to start.
5661 </summary>
5662 <value>
5663 The filename of the external program.
5664 </value>
5665 <remarks>
5666 Override in derived classes to explicitly set the location of the
5667 external tool.
5668 </remarks>
5669 </member>
5670 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramArguments">
5671 <summary>
5672 Gets the command-line arguments for the external program.
5673 </summary>
5674 <value>
5675 The command-line arguments for the external program.
5676 </value>
5677 </member>
5678 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Output">
5679 <summary>
5680 Gets the file to which the standard output should be redirected.
5681 </summary>
5682 <value>
5683 The file to which the standard output should be redirected, or
5684 <see langword="null" /> if the standard output should not be
5685 redirected.
5686 </value>
5687 <remarks>
5688 The default implementation will never allow the standard output
5689 to be redirected to a file. Deriving classes should override this
5690 property to change this behaviour.
5691 </remarks>
5692 </member>
5693 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputAppend">
5694 <summary>
5695 Gets a value indicating whether output will be appended to the
5696 <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>.
5697 </summary>
5698 <value>
5699 <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>;
5700 otherwise, <see langword="false"/>.
5701 </value>
5702 </member>
5703 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.BaseDirectory">
5704 <summary>
5705 Gets the working directory for the application.
5706 </summary>
5707 <value>
5708 The working directory for the application.
5709 </value>
5710 </member>
5711 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.TimeOut">
5712 <summary>
5713 The maximum amount of time the application is allowed to execute,
5714 expressed in milliseconds. Defaults to no time-out.
5715 </summary>
5716 </member>
5717 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments">
5718 <summary>
5719 The command-line arguments for the external program.
5720 </summary>
5721 </member>
5722 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine">
5723 <summary>
5724 Specifies whether the external program is a managed application
5725 which should be executed using a runtime engine, if configured.
5726 The default is <see langword="false"/>.
5727 </summary>
5728 <value>
5729 <see langword="true"/> if the external program should be executed
5730 using a runtime engine; otherwise, <see langword="false"/>.
5731 </value>
5732 <remarks>
5733 <para>
5734 The value of <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is only used from
5735 <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/>, and then only if its value is set to
5736 <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>. In which case
5737 <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/> returns <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/>
5738 if <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is <see langword="true"/>.
5739 </para>
5740 <para>
5741 In all other cases, the value of <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/>
5742 is ignored.
5743 </para>
5744 </remarks>
5745 </member>
5746 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Managed">
5747 <summary>
5748 Specifies whether the external program should be treated as a managed
5749 application, possibly forcing it to be executed under the currently
5750 targeted version of the CLR.
5751 </summary>
5752 <value>
5753 A <see cref="T:NAnt.Core.Types.ManagedExecution"/> indicating how the program should
5754 be treated.
5755 </value>
5756 <remarks>
5757 <para>
5758 If <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/> is set to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>,
5759 which is the default value, and <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is
5760 <see langword="true"/> then <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/>
5761 is returned.
5762 </para>
5763 <para>
5764 When the changing <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/> to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>,
5765 then <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is set to <see langword="false"/>;
5766 otherwise, it is changed to <see langword="true"/>.
5767 </para>
5768 </remarks>
5769 </member>
5770 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputWriter">
5771 <summary>
5772 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which standard output
5773 messages of the external program will be written.
5774 </summary>
5775 <value>
5776 The <see cref="T:System.IO.TextWriter"/> to which standard output messages of
5777 the external program will be written.
5778 </value>
5779 <remarks>
5780 By default, standard output messages wil be written to the build log
5781 with level <see cref="F:NAnt.Core.Level.Info"/>.
5782 </remarks>
5783 </member>
5784 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ErrorWriter">
5785 <summary>
5786 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which error output
5787 of the external program will be written.
5788 </summary>
5789 <value>
5790 The <see cref="T:System.IO.TextWriter"/> to which error output of the external
5791 program will be written.
5792 </value>
5793 <remarks>
5794 By default, error output wil be written to the build log with level
5795 <see cref="F:NAnt.Core.Level.Warning"/>.
5796 </remarks>
5797 </member>
5798 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode">
5799 <summary>
5800 Gets the value that the process specified when it terminated.
5801 </summary>
5802 <value>
5803 The code that the associated process specified when it terminated,
5804 or <c>-1000</c> if the process could not be started or did not
5805 exit (in time).
5806 </value>
5807 </member>
5808 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProcessId">
5809 <summary>
5810 Gets the unique identifier for the spawned application.
5811 </summary>
5812 </member>
5813 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Spawn">
5814 <summary>
5815 Gets or sets a value indicating whether the application should be
5816 spawned. If you spawn an application, its output will not be logged
5817 by NAnt. The default is <see langword="false" />.
5818 </summary>
5819 </member>
5820 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.CommandLine">
5821 <summary>
5822 Gets the command-line arguments, separated by spaces.
5823 </summary>
5824 </member>
5825 <member name="M:NAnt.Core.Tasks.ExecTask.Initialize">
5826 <summary>
5827 Performs additional checks after the task has been initialized.
5828 </summary>
5829 <exception cref="T:NAnt.Core.BuildException"><see cref="P:NAnt.Core.Tasks.ExecTask.FileName"/> does not hold a valid file name.</exception>
5830 </member>
5831 <member name="M:NAnt.Core.Tasks.ExecTask.ExecuteTask">
5832 <summary>
5833 Executes the external program.
5834 </summary>
5835 </member>
5836 <member name="P:NAnt.Core.Tasks.ExecTask.FileName">
5837 <summary>
5838 The program to execute without command arguments.
5839 </summary>
5840 <remarks>
5841 The path will not be evaluated to a full path using the project
5842 base directory.
5843 </remarks>
5844 </member>
5845 <member name="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments">
5846 <summary>
5847 The command-line arguments for the program. These will be
5848 passed as is to the external program. When quoting is necessary,
5849 these must be explictly set as part of the value. Consider using
5850 nested <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"/> elements instead.
5851 </summary>
5852 </member>
5853 <member name="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet">
5854 <summary>
5855 Environment variables to pass to the program.
5856 </summary>
5857 </member>
5858 <member name="P:NAnt.Core.Tasks.ExecTask.WorkingDirectory">
5859 <summary>
5860 The directory in which the command will be executed.
5861 </summary>
5862 <value>
5863 The directory in which the command will be executed. The default
5864 is the project's base directory.
5865 </value>
5866 <remarks>
5867 <para>
5868 The working directory will be evaluated relative to the project's
5869 base directory if it is relative.
5870 </para>
5871 </remarks>
5872 </member>
5873 <member name="P:NAnt.Core.Tasks.ExecTask.ResultProperty">
5874 <summary>
5875 <para>
5876 The name of a property in which the exit code of the program should
5877 be stored. Only of interest if <see cref="P:NAnt.Core.Task.FailOnError"/> is
5878 <see langword="false"/>.
5879 </para>
5880 <para>
5881 If the exit code of the program is "-1000" then the program could
5882 not be started, or did not exit (in time).
5883 </para>
5884 </summary>
5885 </member>
5886 <member name="P:NAnt.Core.Tasks.ExecTask.UseRuntimeEngine">
5887 <summary>
5888 Specifies whether the external program should be executed using a
5889 runtime engine, if configured. The default is <see langword="false" />.
5890 </summary>
5891 <value>
5892 <see langword="true" /> if the external program should be executed
5893 using a runtime engine; otherwise, <see langword="false" />.
5894 </value>
5895 </member>
5896 <member name="P:NAnt.Core.Tasks.ExecTask.Managed">
5897 <summary>
5898 Specifies whether the external program is a managed application
5899 which should be executed using a runtime engine, if configured.
5900 The default is <see langword="false" />.
5901 </summary>
5902 <value>
5903 <see langword="true" /> if the external program should be executed
5904 using a runtime engine; otherwise, <see langword="false" />.
5905 </value>
5906 </member>
5907 <member name="P:NAnt.Core.Tasks.ExecTask.ProgramFileName">
5908 <summary>
5909 Gets the filename of the external program to start.
5910 </summary>
5911 <value>
5912 The filename of the external program.
5913 </value>
5914 </member>
5915 <member name="P:NAnt.Core.Tasks.ExecTask.ProgramArguments">
5916 <summary>
5917 Gets the command-line arguments for the external program.
5918 </summary>
5919 <value>
5920 The command-line arguments for the external program.
5921 </value>
5922 </member>
5923 <member name="P:NAnt.Core.Tasks.ExecTask.BaseDirectory">
5924 <summary>
5925 The directory the program is in.
5926 </summary>
5927 <remarks>
5928 <value>
5929 The directory the program is in. The default is the project's base
5930 directory.
5931 </value>
5932 <para>
5933 The basedir will be evaluated relative to the project's base
5934 directory if it is relative.
5935 </para>
5936 </remarks>
5937 </member>
5938 <member name="P:NAnt.Core.Tasks.ExecTask.Output">
5939 <summary>
5940 The file to which the standard output will be redirected.
5941 </summary>
5942 <remarks>
5943 By default, the standard output is redirected to the console.
5944 </remarks>
5945 </member>
5946 <member name="P:NAnt.Core.Tasks.ExecTask.OutputAppend">
5947 <summary>
5948 Gets or sets a value indicating whether output should be appended
5949 to the output file. The default is <see langword="false"/>.
5950 </summary>
5951 <value>
5952 <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExecTask.Output"/>;
5953 otherwise, <see langword="false"/>.
5954 </value>
5955 </member>
5956 <member name="P:NAnt.Core.Tasks.ExecTask.Spawn">
5957 <summary>
5958 Gets or sets a value indicating whether the application should be
5959 spawned. If you spawn an application, its output will not be logged
5960 by NAnt. The default is <see langword="false" />.
5961 </summary>
5962 </member>
5963 <member name="P:NAnt.Core.Tasks.ExecTask.ProcessIdProperty">
5964 <summary>
5965 The name of a property in which the unique identifier of the spawned
5966 application should be stored. Only of interest if <see cref="P:NAnt.Core.Tasks.ExecTask.Spawn"/>
5967 is <see langword="true"/>.
5968 </summary>
5969 </member>
5970 <member name="T:NAnt.Core.Tasks.FailTask">
5971 <summary>
5972 Exits the current build by throwing a <see cref="T:NAnt.Core.BuildException"/>,
5973 optionally printing additional information.
5974 </summary>
5975 <remarks>
5976 <para>
5977 The cause of the build failure can be specified using the <see cref="P:NAnt.Core.Tasks.FailTask.Message"/>
5978 attribute or as inline content.
5979 </para>
5980 <para>
5981 Macros in the message will be expanded.
5982 </para>
5983 </remarks>
5984 <example>
5985 <para>Exits the current build without giving further information.</para>
5986 <code>
5987 <![CDATA[
5988 <fail />
5989 ]]>
5990 </code>
5991 </example>
5992 <example>
5993 <para>Exits the current build and writes a message to the build log.</para>
5994 <code>
5995 <![CDATA[
5996 <fail message="Something wrong here." />
5997 ]]>
5998 </code>
5999 </example>
6000 <example>
6001 <para>Functionally equivalent to the previous example.</para>
6002 <code>
6003 <![CDATA[
6004 <fail>Something wrong here.</fail>
6005 ]]>
6006 </code>
6007 </example>
6008 </member>
6009 <member name="P:NAnt.Core.Tasks.FailTask.Message">
6010 <summary>
6011 A message giving further information on why the build exited.
6012 </summary>
6013 <remarks>
6014 Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive.
6015 </remarks>
6016 </member>
6017 <member name="P:NAnt.Core.Tasks.FailTask.Contents">
6018 <summary>
6019 Gets or sets the inline content that should be output in the build
6020 log, giving further information on why the build exited.
6021 </summary>
6022 <value>
6023 The inline content that should be output in the build log.
6024 </value>
6025 <remarks>
6026 Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive.
6027 </remarks>
6028 </member>
6029 <member name="T:NAnt.Core.Tasks.GetTask">
6030 <summary>
6031 Gets a particular file from a URL source.
6032 </summary>
6033 <remarks>
6034 <para>
6035 Options include verbose reporting and timestamp based fetches.
6036 </para>
6037 <para>
6038 Currently, only HTTP and UNC protocols are supported. FTP support may
6039 be added when more pluggable protocols are added to the System.Net
6040 assembly.
6041 </para>
6042 <para>
6043 The <see cref="P:NAnt.Core.Tasks.GetTask.UseTimeStamp"/> option enables you to control downloads
6044 so that the remote file is only fetched if newer than the local copy.
6045 If there is no local copy, the download always takes place. When a file
6046 is downloaded, the timestamp of the downloaded file is set to the remote
6047 timestamp.
6048 </para>
6049 <note>
6050 This timestamp facility only works on downloads using the HTTP protocol.
6051 </note>
6052 </remarks>
6053 <example>
6054 <para>
6055 Gets the index page of the NAnt home page, and stores it in the file
6056 <c>help/index.html</c> relative to the project base directory.
6057 </para>
6058 <code>
6059 <![CDATA[
6060 <get src="http://nant.sourceforge.org/" dest="help/index.html" />
6061 ]]>
6062 </code>
6063 </example>
6064 <example>
6065 <para>
6066 Gets the index page of a secured web site using the given credentials,
6067 while connecting using the specified password-protected proxy server.
6068 </para>
6069 <code>
6070 <![CDATA[
6071 <get src="http://password.protected.site/index.html" dest="secure/index.html">
6072 <credentials username="user" password="guess" domain="mydomain" />
6073 <proxy host="proxy.company.com" port="8080">
6074 <credentials username="proxyuser" password="dunno" />
6075 </proxy>
6076 </get>
6077 ]]>
6078 </code>
6079 </example>
6080 </member>
6081 <member name="M:NAnt.Core.Tasks.GetTask.Initialize">
6082 <summary>
6083 Initializes task and ensures the supplied attributes are valid.
6084 </summary>
6085 </member>
6086 <member name="M:NAnt.Core.Tasks.GetTask.ExecuteTask">
6087 <summary>
6088 This is where the work is done
6089 </summary>
6090 </member>
6091 <member name="M:NAnt.Core.Tasks.GetTask.TouchFile(System.IO.FileInfo,System.DateTime)">
6092 <summary>
6093 Sets the timestamp of a given file to a specified time.
6094 </summary>
6095 </member>
6096 <member name="P:NAnt.Core.Tasks.GetTask.Source">
6097 <summary>
6098 The URL from which to retrieve a file.
6099 </summary>
6100 </member>
6101 <member name="P:NAnt.Core.Tasks.GetTask.DestinationFile">
6102 <summary>
6103 The file where to store the retrieved file.
6104 </summary>
6105 </member>
6106 <member name="P:NAnt.Core.Tasks.GetTask.HttpProxy">
6107 <summary>
6108 If inside a firewall, proxy server/port information
6109 Format: {proxy server name}:{port number}
6110 Example: proxy.mycompany.com:8080
6111 </summary>
6112 </member>
6113 <member name="P:NAnt.Core.Tasks.GetTask.Proxy">
6114 <summary>
6115 The network proxy to use to access the Internet resource.
6116 </summary>
6117 </member>
6118 <member name="P:NAnt.Core.Tasks.GetTask.Credentials">
6119 <summary>
6120 The network credentials used for authenticating the request with
6121 the Internet resource.
6122 </summary>
6123 </member>
6124 <member name="P:NAnt.Core.Tasks.GetTask.IgnoreErrors">
6125 <summary>
6126 Log errors but don't treat as fatal. The default is <see langword="false" />.
6127 </summary>
6128 </member>
6129 <member name="P:NAnt.Core.Tasks.GetTask.UseTimeStamp">
6130 <summary>
6131 Conditionally download a file based on the timestamp of the local
6132 copy. HTTP only. The default is <see langword="false" />.
6133 </summary>
6134 </member>
6135 <member name="P:NAnt.Core.Tasks.GetTask.Timeout">
6136 <summary>
6137 The length of time, in milliseconds, until the request times out.
6138 The default is <c>100000</c> milliseconds.
6139 </summary>
6140 </member>
6141 <member name="P:NAnt.Core.Tasks.GetTask.Certificates">
6142 <summary>
6143 The security certificates to associate with the request.
6144 </summary>
6145 </member>
6146 <member name="T:NAnt.Core.Tasks.IfTask">
6147 <summary>
6148 Checks the conditional attributes and executes the children if
6149 <see langword="true"/>.
6150 </summary>
6151 <remarks>
6152 <para>
6153 If no conditions are checked, all child tasks are executed.
6154 </para>
6155 <para>
6156 If more than one attribute is used, they are &&'d. The first
6157 to fail stops the check.
6158 </para>
6159 <para>
6160 The order of condition evaluation is, <see cref="P:NAnt.Core.Tasks.IfTask.TargetNameExists"/>,
6161 <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameExists"/>, <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue"/>,
6162 <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>.
6163 </para>
6164 <note>
6165 instead of using the deprecated attributes, we advise you to use the
6166 following functions in combination with the <see cref="P:NAnt.Core.Tasks.IfTask.Test"/>
6167 attribute:
6168 </note>
6169 <list type="table">
6170 <listheader>
6171 <term>Function</term>
6172 <description>Description</description>
6173 </listheader>
6174 <item>
6175 <term><see cref="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)"/></term>
6176 <description>Checks whether the specified property exists.</description>
6177 </item>
6178 <item>
6179 <term><see cref="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)"/></term>
6180 <description>Checks whether the specified target exists.</description>
6181 </item>
6182 </list>
6183 </remarks>
6184 <example>
6185 <para>Tests the value of a property using expressions.</para>
6186 <code>
6187 <![CDATA[
6188 <if test="${build.configuration=='release'}">
6189 <echo>Build release configuration</echo>
6190 </if>
6191 ]]>
6192 </code>
6193 </example>
6194 <example>
6195 <para>Tests the the output of a function.</para>
6196 <code>
6197 <![CDATA[
6198 <if test="${not file::exists(filename) or file::get-length(filename) = 0}">
6199 <echo message="The version file ${filename} doesn't exist or is empty!" />
6200 </if>
6201 ]]>
6202 </code>
6203 </example>
6204 <example>
6205 <para><c>(Deprecated)</c> Check that a target exists.</para>
6206 <code>
6207 <![CDATA[
6208 <target name="myTarget" />
6209 <if targetexists="myTarget">
6210 <echo message="myTarget exists" />
6211 </if>
6212 ]]>
6213 </code>
6214 </example>
6215 <example>
6216 <para><c>(Deprecated)</c> Check existence of a property.</para>
6217 <code>
6218 <![CDATA[
6219 <if propertyexists="myProp">
6220 <echo message="myProp Exists. Value='${myProp}'" />
6221 </if>
6222 ]]>
6223 </code>
6224 </example>
6225 <example>
6226 <para><c>(Deprecated)</c> Check that a property value is true.</para>
6227 <code>
6228 <![CDATA[
6229 <if propertytrue="myProp">
6230 <echo message="myProp is true. Value='${myProp}'" />
6231 </if>
6232 ]]>
6233 </code>
6234 </example>
6235 <example>
6236 <para>
6237 <c>(Deprecated)</c> Check that a property exists and is <see langword="true"/>
6238 (uses multiple conditions).
6239 </para>
6240 <code>
6241 <![CDATA[
6242 <if propertyexists="myProp" propertytrue="myProp">
6243 <echo message="myProp is '${myProp}'" />
6244 </if>
6245 ]]>
6246 </code>
6247 <para>which is the same as</para>
6248 <code>
6249 <![CDATA[
6250 <if propertyexists="myProp">
6251 <if propertytrue="myProp">
6252 <echo message="myProp is '${myProp}'" />
6253 </if>
6254 </if>
6255 ]]>
6256 </code>
6257 </example>
6258 <example>
6259 <para>
6260 <c>(Deprecated)</c> Check file dates. If <c>myfile.dll</c> is uptodate,
6261 then do stuff.
6262 </para>
6263 <code>
6264 <![CDATA[
6265 <if uptodatefile="myfile.dll" comparefile="myfile.cs">
6266 <echo message="myfile.dll is newer/same-date as myfile.cs" />
6267 </if>
6268 ]]>
6269 </code>
6270 <para>or</para>
6271 <code>
6272 <![CDATA[
6273 <if uptodatefile="myfile.dll">
6274 <comparefiles>
6275 <include name="*.cs" />
6276 </comparefiles>
6277 <echo message="myfile.dll is newer/same-date as myfile.cs" />
6278 </if>
6279 ]]>
6280 </code>
6281 <para>or</para>
6282 <code>
6283 <![CDATA[
6284 <if>
6285 <uptodatefiles>
6286 <include name="myfile.dll" />
6287 </uptodatefiles>
6288 <comparefiles>
6289 <include name="*.cs" />
6290 </comparefiles>
6291 <echo message="myfile.dll is newer/same-date as myfile.cs" />
6292 </if>
6293 ]]>
6294 </code>
6295 </example>
6296 </member>
6297 <member name="T:NAnt.Core.TaskContainer">
6298 <summary>
6299 Executes embedded tasks in the order in which they are defined.
6300 </summary>
6301 </member>
6302 <member name="M:NAnt.Core.TaskContainer.Initialize">
6303 <summary>
6304 Automatically exclude build elements that are defined on the task
6305 from things that get executed, as they are evaluated normally during
6306 XML task initialization.
6307 </summary>
6308 </member>
6309 <member name="M:NAnt.Core.TaskContainer.ExecuteChildTasks">
6310 <summary>
6311 Creates and executes the embedded (child XML nodes) elements.
6312 </summary>
6313 <remarks>
6314 Skips any element defined by the host <see cref="T:NAnt.Core.Task"/> that has
6315 a <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> defined.
6316 </remarks>
6317 </member>
6318 <member name="P:NAnt.Core.TaskContainer.CustomXmlProcessing">
6319 <summary>
6320 Gets a value indicating whether the element is performing additional
6321 processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
6322 initialize the element.
6323 </summary>
6324 <value>
6325 <see langword="true"/>, as a <see cref="T:NAnt.Core.TaskContainer"/> is
6326 responsable for creating tasks from the nested build elements.
6327 </value>
6328 </member>
6329 <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFile">
6330 <summary>
6331 The file to compare if uptodate.
6332 </summary>
6333 </member>
6334 <member name="P:NAnt.Core.Tasks.IfTask.CompareFile">
6335 <summary>
6336 The file to check against for the uptodate file.
6337 </summary>
6338 </member>
6339 <member name="P:NAnt.Core.Tasks.IfTask.CompareFiles">
6340 <summary>
6341 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the comparison files for
6342 the <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>(s) check.
6343 </summary>
6344 </member>
6345 <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFiles">
6346 <summary>
6347 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the uptodate files for
6348 the <see cref="P:NAnt.Core.Tasks.IfTask.CompareFile"/>(s) check.
6349 </summary>
6350 </member>
6351 <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue">
6352 <summary>
6353 Used to test whether a property is true.
6354 </summary>
6355 </member>
6356 <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameExists">
6357 <summary>
6358 Used to test whether a property exists.
6359 </summary>
6360 </member>
6361 <member name="P:NAnt.Core.Tasks.IfTask.TargetNameExists">
6362 <summary>
6363 Used to test whether a target exists.
6364 </summary>
6365 </member>
6366 <member name="P:NAnt.Core.Tasks.IfTask.Test">
6367 <summary>
6368 Used to test arbitrary boolean expression.
6369 </summary>
6370 </member>
6371 <member name="T:NAnt.Core.Tasks.IfNotTask">
6372 <summary>
6373 The opposite of the <c>if</c> task.
6374 </summary>
6375 <example>
6376 <para>Check that a property does not exist.</para>
6377 <code>
6378 <![CDATA[
6379 <ifnot propertyexists="myProp">
6380 <echo message="myProp does not exist."/>
6381 </if>
6382 ]]>
6383 </code>
6384 <para>Check that a property value is not true.</para>
6385 <code>
6386 <![CDATA[
6387 <ifnot propertytrue="myProp">
6388 <echo message="myProp is not true."/>
6389 </if>
6390 ]]>
6391 </code>
6392 </example>
6393 <example>
6394 <para>Check that a target does not exist.</para>
6395 <code>
6396 <![CDATA[
6397 <ifnot targetexists="myTarget">
6398 <echo message="myTarget does not exist."/>
6399 </if>
6400 ]]>
6401 </code>
6402 </example>
6403 </member>
6404 <member name="T:NAnt.Core.Tasks.IncludeTask">
6405 <summary>
6406 Includes an external build file.
6407 </summary>
6408 <remarks>
6409 <para>
6410 This task is used to break your build file into smaller chunks. You
6411 can load a partial build file and have it included into the build file.
6412 </para>
6413 <note>
6414 Any global (project level) tasks in the included build file are executed
6415 when this task is executed. Tasks in target elements are only executed
6416 if that target is executed.
6417 </note>
6418 <note>
6419 The project element attributes are ignored.
6420 </note>
6421 <note>
6422 This task can only be in the global (project level) section of the
6423 build file.
6424 </note>
6425 <note>
6426 This task can only include files from the file system.
6427 </note>
6428 </remarks>
6429 <example>
6430 <para>
6431 Include a task that fetches the project version from the
6432 <c>GetProjectVersion.include</c> build file.
6433 </para>
6434 <code>
6435 <![CDATA[
6436 <include buildfile="GetProjectVersion.include" />
6437 ]]>
6438 </code>
6439 </example>
6440 </member>
6441 <member name="F:NAnt.Core.Tasks.IncludeTask._includedFileNames">
6442 <summary>
6443 Used to check for recursived includes.
6444 </summary>
6445 </member>
6446 <member name="M:NAnt.Core.Tasks.IncludeTask.Initialize">
6447 <summary>
6448 Verifies parameters.
6449 </summary>
6450 </member>
6451 <member name="P:NAnt.Core.Tasks.IncludeTask.BuildFileName">
6452 <summary>
6453 Build file to include.
6454 </summary>
6455 </member>
6456 <member name="T:NAnt.Core.Tasks.LoadFileTask">
6457 <summary>
6458 Load a text file into a single property.
6459 </summary>
6460 <remarks>
6461 <para>
6462 Unless an encoding is specified, the encoding associated with the
6463 system's current ANSI code page is used.
6464 </para>
6465 <para>
6466 An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
6467 file is automatically recognized, if the file starts with the appropriate
6468 byte order marks.
6469 </para>
6470 </remarks>
6471 <example>
6472 <para>
6473 Load file <c>message.txt</c> into property "message".
6474 </para>
6475 <code>
6476 <![CDATA[
6477 <loadfile
6478 file="message.txt"
6479 property="message" />
6480 ]]>
6481 </code>
6482 </example>
6483 <example>
6484 <para>
6485 Load a file using the "latin-1" encoding.
6486 </para>
6487 <code>
6488 <![CDATA[
6489 <loadfile
6490 file="loadfile.xml"
6491 property="encoded-file"
6492 encoding="iso-8859-1" />
6493 ]]>
6494 </code>
6495 </example>
6496 <example>
6497 <para>
6498 Load a file, replacing all <c>@NOW@</c> tokens with the current
6499 date/time.
6500 </para>
6501 <code>
6502 <![CDATA[
6503 <loadfile file="token.txt" property="token-file">
6504 <filterchain>
6505 <replacetokens>
6506 <token key="NOW" value="${datetime::now()}" />
6507 </replacetokens>
6508 </filterchain>
6509 </loadfile>
6510 ]]>
6511 </code>
6512 </example>
6513 </member>
6514 <member name="P:NAnt.Core.Tasks.LoadFileTask.File">
6515 <summary>
6516 The file to load.
6517 </summary>
6518 </member>
6519 <member name="P:NAnt.Core.Tasks.LoadFileTask.Property">
6520 <summary>
6521 The name of the property to save the content to.
6522 </summary>
6523 </member>
6524 <member name="P:NAnt.Core.Tasks.LoadFileTask.Encoding">
6525 <summary>
6526 The encoding to use when loading the file. The default is the encoding
6527 associated with the system's current ANSI code page.
6528 </summary>
6529 </member>
6530 <member name="P:NAnt.Core.Tasks.LoadFileTask.FilterChain">
6531 <summary>
6532 The filterchain definition to use.
6533 </summary>
6534 </member>
6535 <member name="T:NAnt.Core.Tasks.LoadTasksTask">
6536 <summary>
6537 Loads tasks form a given assembly or all assemblies in a given directory
6538 or <see cref="T:NAnt.Core.Types.FileSet"/>.
6539 </summary>
6540 <example>
6541 <para>
6542 Load tasks from a single assembly.
6543 </para>
6544 <code>
6545 <![CDATA[
6546 <loadtasks assembly="c:foo\NAnt.Contrib.Tasks.dll" />
6547 ]]>
6548 </code>
6549 </example>
6550 <example>
6551 <para>
6552 Scan a single directory for task assemblies.
6553 </para>
6554 <code>
6555 <![CDATA[
6556 <loadtasks path="c:\foo" />
6557 ]]>
6558 </code>
6559 </example>
6560 <example>
6561 <para>
6562 Use a <see cref="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet"/> containing both a directory and an
6563 assembly.
6564 </para>
6565 <code>
6566 <![CDATA[
6567 <loadtasks>
6568 <fileset>
6569 <include name="C:\cvs\NAntContrib\build" />
6570 <include name="C:\cvs\NAntContrib\build\NAnt.Contrib.Tasks.dll" />
6571 </fileset>
6572 </loadtasks>
6573 ]]>
6574 </code>
6575 </example>
6576 </member>
6577 <member name="M:NAnt.Core.Tasks.LoadTasksTask.ExecuteTask">
6578 <summary>
6579 Executes the Load Tasks task.
6580 </summary>
6581 <exception cref="T:NAnt.Core.BuildException">Specified assembly or path does not exist.</exception>
6582 </member>
6583 <member name="M:NAnt.Core.Tasks.LoadTasksTask.Initialize">
6584 <summary>
6585 Validates the attributes.
6586 </summary>
6587 <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>
6588 </member>
6589 <member name="P:NAnt.Core.Tasks.LoadTasksTask.AssemblyPath">
6590 <summary>
6591 An assembly to load tasks from.
6592 </summary>
6593 </member>
6594 <member name="P:NAnt.Core.Tasks.LoadTasksTask.Path">
6595 <summary>
6596 A directory to scan for task assemblies.
6597 </summary>
6598 </member>
6599 <member name="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet">
6600 <summary>
6601 Used to select which directories or individual assemblies to scan.
6602 </summary>
6603 </member>
6604 <member name="T:NAnt.Core.Tasks.LoopTask">
6605 <summary>
6606 Loops over a set of items.
6607 </summary>
6608 <remarks>
6609 <para>
6610 Can loop over files in directory, lines in a file, etc.
6611 </para>
6612 <para>
6613 The property value is stored before the loop is done, and restored
6614 when the loop is finished.
6615 </para>
6616 <para>
6617 The property is returned to its normal value once it is used. Read-only
6618 parameters cannot be overridden in this loop.
6619 </para>
6620 </remarks>
6621 <example>
6622 <para>Loops over the files in <c>c:\</c>.</para>
6623 <code>
6624 <![CDATA[
6625 <foreach item="File" in="c:\" property="filename">
6626 <echo message="${filename}" />
6627 </foreach>
6628 ]]>
6629 </code>
6630 </example>
6631 <example>
6632 <para>Loops over all files in the project directory.</para>
6633 <code>
6634 <![CDATA[
6635 <foreach item="File" property="filename">
6636 <in>
6637 <items>
6638 <include name="**" />
6639 </items>
6640 </in>
6641 <do>
6642 <echo message="${filename}" />
6643 </do>
6644 </foreach>
6645 ]]>
6646 </code>
6647 </example>
6648 <example>
6649 <para>Loops over the folders in <c>c:\</c>.</para>
6650 <code>
6651 <![CDATA[
6652 <foreach item="Folder" in="c:\" property="foldername">
6653 <echo message="${foldername}" />
6654 </foreach>
6655 ]]>
6656 </code>
6657 </example>
6658 <example>
6659 <para>Loops over all folders in the project directory.</para>
6660 <code>
6661 <![CDATA[
6662 <foreach item="Folder" property="foldername">
6663 <in>
6664 <items>
6665 <include name="**" />
6666 </items>
6667 </in>
6668 <do>
6669 <echo message="${foldername}" />
6670 </do>
6671 </foreach>
6672 ]]>
6673 </code>
6674 </example>
6675 <example>
6676 <para>Loops over a list.</para>
6677 <code>
6678 <![CDATA[
6679 <foreach item="String" in="1 2,3" delim=" ," property="count">
6680 <echo message="${count}" />
6681 </foreach>
6682 ]]>
6683 </code>
6684 </example>
6685 <example>
6686 <para>
6687 Loops over lines in the file <c>properties.csv</c>, where each line
6688 is of the format name,value.
6689 </para>
6690 <code>
6691 <![CDATA[
6692 <foreach item="Line" in="properties.csv" delim="," property="x,y">
6693 <echo message="Read pair ${x}=${y}" />
6694 </foreach>
6695 ]]>
6696 </code>
6697 </example>
6698 </member>
6699 <member name="P:NAnt.Core.Tasks.LoopTask.Property">
6700 <summary>
6701 The NAnt property name(s) that should be used for the current
6702 iterated item.
6703 </summary>
6704 <remarks>
6705 If specifying multiple properties, separate them with a comma.
6706 </remarks>
6707 </member>
6708 <member name="P:NAnt.Core.Tasks.LoopTask.ItemType">
6709 <summary>
6710 The type of iteration that should be done.
6711 </summary>
6712 </member>
6713 <member name="P:NAnt.Core.Tasks.LoopTask.TrimType">
6714 <summary>
6715 The type of whitespace trimming that should be done. The default
6716 is <see cref="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None"/>.
6717 </summary>
6718 </member>
6719 <member name="P:NAnt.Core.Tasks.LoopTask.Source">
6720 <summary>
6721 The source of the iteration.
6722 </summary>
6723 </member>
6724 <member name="P:NAnt.Core.Tasks.LoopTask.Delimiter">
6725 <summary>
6726 The deliminator char.
6727 </summary>
6728 </member>
6729 <member name="P:NAnt.Core.Tasks.LoopTask.InElement">
6730 <summary>
6731 Stuff to operate in. Just like the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/>
6732 attribute, but supports more complicated things like a <see cref="T:NAnt.Core.Types.FileSet"/>
6733 and such.
6734 <note>
6735 Please remove the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/> attribute if you
6736 are using this element.
6737 </note>
6738 </summary>
6739 </member>
6740 <member name="P:NAnt.Core.Tasks.LoopTask.StuffToDo">
6741 <summary>
6742 Tasks to execute for each matching item.
6743 </summary>
6744 </member>
6745 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None">
6746 <summary>
6747 Do not remove any white space characters.
6748 </summary>
6749 </member>
6750 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.End">
6751 <summary>
6752 Remove all white space characters from the end of the current
6753 item.
6754 </summary>
6755 </member>
6756 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Start">
6757 <summary>
6758 Remove all white space characters from the beginning of the
6759 current item.
6760 </summary>
6761 </member>
6762 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Both">
6763 <summary>
6764 Remove all white space characters from the beginning and end of
6765 the current item.
6766 </summary>
6767 </member>
6768 <member name="T:NAnt.Core.Tasks.MailTask">
6769 <summary>
6770 Sends an SMTP message.
6771 </summary>
6772 <remarks>
6773 <para>
6774 Text and text files to include in the message body may be specified as
6775 well as binary attachments.
6776 </para>
6777 </remarks>
6778 <example>
6779 <para>
6780 Sends an email from <c>nant@sourceforge.net</c> to three recipients
6781 with a subject about the attachments. The body of the message will be
6782 the combined contents of all <c>.txt</c> files in the base directory.
6783 All zip files in the base directory will be included as attachments.
6784 The message will be sent using the <c>smtpserver.anywhere.com</c> SMTP
6785 server.
6786 </para>
6787 <code>
6788 <![CDATA[
6789 <mail
6790 from="nant@sourceforge.net"
6791 tolist="recipient1@sourceforge.net"
6792 cclist="recipient2@sourceforge.net"
6793 bcclist="recipient3@sourceforge.net"
6794 subject="Msg 7: With attachments"
6795 mailhost="smtpserver.anywhere.com">
6796 <files>
6797 <include name="*.txt" />
6798 </files>
6799 <attachments>
6800 <include name="*.zip" />
6801 </attachments>
6802 </mail>
6803 ]]>
6804 </code>
6805 </example>
6806 </member>
6807 <member name="M:NAnt.Core.Tasks.MailTask.Initialize">
6808 <summary>
6809 Initializes task and ensures the supplied attributes are valid.
6810 </summary>
6811 </member>
6812 <member name="M:NAnt.Core.Tasks.MailTask.ExecuteTask">
6813 <summary>
6814 This is where the work is done.
6815 </summary>
6816 </member>
6817 <member name="M:NAnt.Core.Tasks.MailTask.ReadFile(System.String)">
6818 <summary>
6819 Reads a text file and returns the content
6820 in a string.
6821 </summary>
6822 <param name="filename">The file to read content of.</param>
6823 <returns>
6824 The content of the specified file.
6825 </returns>
6826 </member>
6827 <member name="P:NAnt.Core.Tasks.MailTask.From">
6828 <summary>
6829 Email address of sender.
6830 </summary>
6831 </member>
6832 <member name="P:NAnt.Core.Tasks.MailTask.ToList">
6833 <summary>
6834 Semicolon-separated list of recipient email addresses.
6835 </summary>
6836 </member>
6837 <member name="P:NAnt.Core.Tasks.MailTask.CcList">
6838 <summary>
6839 Semicolon-separated list of CC: recipient email addresses.
6840 </summary>
6841 </member>
6842 <member name="P:NAnt.Core.Tasks.MailTask.BccList">
6843 <summary>
6844 Semicolon-separated list of BCC: recipient email addresses.
6845 </summary>
6846 </member>
6847 <member name="P:NAnt.Core.Tasks.MailTask.Mailhost">
6848 <summary>
6849 Host name of mail server. The default is <c>localhost</c>.
6850 </summary>
6851 </member>
6852 <member name="P:NAnt.Core.Tasks.MailTask.Message">
6853 <summary>
6854 Text to send in body of email message.
6855 </summary>
6856 </member>
6857 <member name="P:NAnt.Core.Tasks.MailTask.Subject">
6858 <summary>
6859 Text to send in subject line of email message.
6860 </summary>
6861 </member>
6862 <member name="P:NAnt.Core.Tasks.MailTask.Format">
6863 <summary>
6864 Format of the message. The default is <see cref="F:System.Web.Mail.MailFormat.Text"/>.
6865 </summary>
6866 </member>
6867 <member name="P:NAnt.Core.Tasks.MailTask.Files">
6868 <summary>
6869 Files that are transmitted as part of the body of the email message.
6870 </summary>
6871 </member>
6872 <member name="P:NAnt.Core.Tasks.MailTask.Attachments">
6873 <summary>
6874 Attachments that are transmitted with the message.
6875 </summary>
6876 </member>
6877 <member name="T:NAnt.Core.Tasks.MkDirTask">
6878 <summary>
6879 Creates a directory and any non-existent parent directory if necessary.
6880 </summary>
6881 <example>
6882 <para>Create the directory <c>build</c>.</para>
6883 <code>
6884 <![CDATA[
6885 <mkdir dir="build" />
6886 ]]>
6887 </code>
6888 </example>
6889 <example>
6890 <para>Create the directory tree <c>one/two/three</c>.</para>
6891 <code>
6892 <![CDATA[
6893 <mkdir dir="one/two/three" />
6894 ]]>
6895 </code>
6896 </example>
6897 </member>
6898 <member name="M:NAnt.Core.Tasks.MkDirTask.ExecuteTask">
6899 <summary>
6900 Creates the directory specified by the <see cref="P:NAnt.Core.Tasks.MkDirTask.Dir"/> property.
6901 </summary>
6902 <exception cref="T:NAnt.Core.BuildException">The directory could not be created.</exception>
6903 </member>
6904 <member name="P:NAnt.Core.Tasks.MkDirTask.Dir">
6905 <summary>
6906 The directory to create.
6907 </summary>
6908 </member>
6909 <member name="T:NAnt.Core.Tasks.MoveTask">
6910 <summary>
6911 Moves a file or set of files to a new file or directory.
6912 </summary>
6913 <remarks>
6914 <para>
6915 Files are only moved if the source file is newer than the destination
6916 file, or if the destination file does not exist. However, you can
6917 explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/>
6918 attribute.
6919 </para>
6920 <para>
6921 A <see cref="T:NAnt.Core.Types.FileSet"/> can be used to select files to move. To use
6922 a <see cref="T:NAnt.Core.Types.FileSet"/>, the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/>
6923 attribute must be set.
6924 </para>
6925 <h3>Encoding</h3>
6926 <para>
6927 Unless an encoding is specified, the encoding associated with the
6928 system's current ANSI code page is used.
6929 </para>
6930 <para>
6931 An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
6932 file is automatically recognized, if the file starts with the
6933 appropriate byte order marks.
6934 </para>
6935 <note>
6936 If you employ filters in your move operation, you should limit the
6937 move to text files. Binary files will be corrupted by the move
6938 operation.
6939 </note>
6940 </remarks>
6941 <example>
6942 <para>
6943 Move a single file while changing its encoding from "latin1" to
6944 "utf-8".
6945 </para>
6946 <code>
6947 <![CDATA[
6948 <move
6949 file="myfile.txt"
6950 tofile="mycopy.txt"
6951 inputencoding="latin1"
6952 outputencoding="utf-8" />
6953 ]]>
6954 </code>
6955 </example>
6956 <example>
6957 <para>Move a set of files.</para>
6958 <code>
6959 <![CDATA[
6960 <move todir="${build.dir}">
6961 <fileset basedir="bin">
6962 <include name="*.dll" />
6963 </fileset>
6964 </move>
6965 ]]>
6966 </code>
6967 </example>
6968 <example>
6969 <para>
6970 Move a set of files to a directory, replacing <c>@TITLE@</c> with
6971 "Foo Bar" in all files.
6972 </para>
6973 <code>
6974 <![CDATA[
6975 <move todir="../backup/dir">
6976 <fileset basedir="src_dir">
6977 <include name="**/*" />
6978 </fileset>
6979 <filterchain>
6980 <replacetokens>
6981 <token key="TITLE" value="Foo Bar" />
6982 </replacetokens>
6983 </filterchain>
6984 </move>
6985 ]]>
6986 </code>
6987 </example>
6988 </member>
6989 <member name="M:NAnt.Core.Tasks.MoveTask.DoFileOperations">
6990 <summary>
6991 Actually does the file moves.
6992 </summary>
6993 </member>
6994 <member name="P:NAnt.Core.Tasks.MoveTask.SourceFile">
6995 <summary>
6996 The file to move.
6997 </summary>
6998 </member>
6999 <member name="P:NAnt.Core.Tasks.MoveTask.ToFile">
7000 <summary>
7001 The file to move to.
7002 </summary>
7003 </member>
7004 <member name="P:NAnt.Core.Tasks.MoveTask.ToDirectory">
7005 <summary>
7006 The directory to move to.
7007 </summary>
7008 </member>
7009 <member name="P:NAnt.Core.Tasks.MoveTask.CopyFileSet">
7010 <summary>
7011 Used to select the files to move. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
7012 the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/> attribute must be set.
7013 </summary>
7014 </member>
7015 <member name="P:NAnt.Core.Tasks.MoveTask.Flatten">
7016 <summary>
7017 Ignore directory structure of source directory, move all files into
7018 a single directory, specified by the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/>
7019 attribute. The default is <see langword="false"/>.
7020 </summary>
7021 </member>
7022 <member name="P:NAnt.Core.Tasks.MoveTask.Filters">
7023 <summary>
7024 Chain of filters used to alter the file's content as it is moved.
7025 </summary>
7026 </member>
7027 <member name="T:NAnt.Core.Tasks.NAntSchemaTask">
7028 <summary>
7029 Creates an XSD File for all available tasks.
7030 </summary>
7031 <remarks>
7032 <para>
7033 This can be used in conjuntion with the command-line option to do XSD
7034 Schema validation on the build file.
7035 </para>
7036 </remarks>
7037 <example>
7038 <para>Creates a <c>NAnt.xsd</c> file in the current project directory.</para>
7039 <code>
7040 <![CDATA[
7041 <nantschema output="NAnt.xsd" />
7042 ]]>
7043 </code>
7044 </example>
7045 </member>
7046 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.WriteSchema(System.IO.Stream,System.Type[],System.Type[],System.String)">
7047 <summary>
7048 Creates a NAnt Schema for given types
7049 </summary>
7050 <param name="stream">The output stream to save the schema to. If <see langword="null" />, writing is ignored, no exception generated.</param>
7051 <param name="tasks">The list of tasks to generate XML Schema for.</param>
7052 <param name="dataTypes">The list of datatypes to generate XML Schema for.</param>
7053 <param name="targetNS">The target namespace to output.</param>
7054 <returns>The new NAnt Schema.</returns>
7055 </member>
7056 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdAttribute(System.String,System.Boolean)">
7057 <summary>
7058 Creates a new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.
7059 </summary>
7060 <param name="name">The name of the attribute.</param>
7061 <param name="required">Value indicating whether the attribute should be required.</param>
7062 <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.</returns>
7063 </member>
7064 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdSequence(System.Decimal,System.Decimal)">
7065 <summary>
7066 Creates a new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.
7067 </summary>
7068 <param name="min">The minimum value to allow for this choice</param>
7069 <param name="max">The maximum value to allow, Decimal.MaxValue sets it to 'unbound'</param>
7070 <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.</returns>
7071 </member>
7072 <member name="P:NAnt.Core.Tasks.NAntSchemaTask.OutputFile">
7073 <summary>
7074 The name of the output file to which the XSD should be written.
7075 </summary>
7076 </member>
7077 <member name="P:NAnt.Core.Tasks.NAntSchemaTask.TargetNamespace">
7078 <summary>
7079 The target namespace for the output. Defaults to "http://tempuri.org/nant-donotuse.xsd"
7080 </summary>
7081 </member>
7082 <member name="P:NAnt.Core.Tasks.NAntSchemaTask.ForType">
7083 <summary>
7084 The <see cref="T:System.Type"/> for which an XSD should be created. If not
7085 specified, an XSD will be created for all available tasks.
7086 </summary>
7087 </member>
7088 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator.#ctor(System.Type[],System.Type[],System.String)">
7089 <summary>
7090 Creates a new instance of the <see cref="T:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator"/>
7091 class.
7092 </summary>
7093 <param name="tasks">Tasks for which a schema should be generated.</param>
7094 <param name="dataTypes">Data Types for which a schema should be generated.</param>
7095 <param name="targetNS">The namespace to use.
7096 <example> http://tempuri.org/nant.xsd </example>
7097 </param>
7098 </member>
7099 <member name="T:NAnt.Core.Tasks.NAntTask">
7100 <summary>
7101 Runs NAnt on a supplied build file, or a set of build files.
7102 </summary>
7103 <remarks>
7104 <para>
7105 By default, all the properties of the current project will be available
7106 in the new project. Alternatively, you can set <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>
7107 to <see langword="false"/> to not copy any properties to the new
7108 project.
7109 </para>
7110 <para>
7111 You can also set properties in the new project from the old project by
7112 using nested property tags. These properties are always passed to the
7113 new project regardless of the setting of <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>.
7114 This allows you to parameterize your subprojects.
7115 </para>
7116 <para>
7117 References to data types can also be passed to the new project, but by
7118 default they are not. If you set the <see cref="P:NAnt.Core.Tasks.NAntTask.InheritRefs"/> to
7119 <see langword="true"/>, all references will be copied.
7120 </para>
7121 </remarks>
7122 <example>
7123 <para>
7124 Build a project located in a different directory if the <c>debug</c>
7125 property is not <see langword="true"/>.
7126 </para>
7127 <code>
7128 <![CDATA[
7129 <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build" unless="${debug}" />
7130 ]]>
7131 </code>
7132 </example>
7133 <example>
7134 <para>
7135 Build a project while adding a set of properties to that project.
7136 </para>
7137 <code>
7138 <![CDATA[
7139 <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build">
7140 <properties>
7141 <property name="build.dir" value="c:/buildserver" />
7142 <property name="build.debug" value="false" />
7143 <property name="lib.dir" value="c:/shared/lib" readonly="true" />
7144 </properties>
7145 </nant>
7146 ]]>
7147 </code>
7148 </example>
7149 <example>
7150 <para>
7151 Build all projects named <c>default.build</c> located anywhere under
7152 the project base directory.
7153 </para>
7154 <code>
7155 <![CDATA[
7156 <nant>
7157 <buildfiles>
7158 <include name="**/default.build" />
7159 <!-- avoid recursive execution of current build file -->
7160 <exclude name="${project::get-buildfile-path()}" />
7161 </buildfiles>
7162 </nant>
7163 ]]>
7164 </code>
7165 </example>
7166 </member>
7167 <member name="M:NAnt.Core.Tasks.NAntTask.Initialize">
7168 <summary>
7169 Validates the <see cref="T:NAnt.Core.Tasks.NAntTask"/> element.
7170 </summary>
7171 </member>
7172 <member name="P:NAnt.Core.Tasks.NAntTask.BuildFile">
7173 <summary>
7174 The build file to build.
7175 </summary>
7176 </member>
7177 <member name="P:NAnt.Core.Tasks.NAntTask.DefaultTarget">
7178 <summary>
7179 The target to execute. To specify more than one target seperate
7180 targets with a space. Targets are executed in order if possible.
7181 The default is to use target specified in the project's default
7182 attribute.
7183 </summary>
7184 </member>
7185 <member name="P:NAnt.Core.Tasks.NAntTask.BuildFiles">
7186 <summary>
7187 Used to specify a set of build files to process.
7188 </summary>
7189 </member>
7190 <member name="P:NAnt.Core.Tasks.NAntTask.InheritAll">
7191 <summary>
7192 Specifies whether current property values should be inherited by
7193 the executed project. The default is <see langword="true" />.
7194 </summary>
7195 </member>
7196 <member name="P:NAnt.Core.Tasks.NAntTask.InheritRefs">
7197 <summary>
7198 Specifies whether all references will be copied to the new project.
7199 The default is <see langword="false" />.
7200 </summary>
7201 </member>
7202 <member name="P:NAnt.Core.Tasks.NAntTask.OverrideProperties">
7203 <summary>
7204 Specifies a collection of properties that should be created in the
7205 executed project. Note, existing properties with identical names
7206 that are not read-only will be overwritten.
7207 </summary>
7208 </member>
7209 <member name="T:NAnt.Core.Tasks.PropertyTask">
7210 <summary>
7211 Sets a property in the current project.
7212 </summary>
7213 <remarks>
7214 <note>NAnt uses a number of predefined properties.</note>
7215 </remarks>
7216 <example>
7217 <para>
7218 Define a <c>debug</c> property with value <see langword="true" />.
7219 </para>
7220 <code>
7221 <![CDATA[
7222 <property name="debug" value="true" />
7223 ]]>
7224 </code>
7225 </example>
7226 <example>
7227 <para>
7228 Use the user-defined <c>debug</c> property.
7229 </para>
7230 <code>
7231 <![CDATA[
7232 <property name="trace" value="${debug}" />
7233 ]]>
7234 </code>
7235 </example>
7236 <example>
7237 <para>
7238 Define a read-only property. This is just like passing in the param
7239 on the command line.
7240 </para>
7241 <code>
7242 <![CDATA[
7243 <property name="do_not_touch_ME" value="hammer" readonly="true" />
7244 ]]>
7245 </code>
7246 </example>
7247 <example>
7248 <para>
7249 Define a property, but do not overwrite the value if the property already exists (eg. it was specified on the command line).
7250 </para>
7251 <code>
7252 <![CDATA[
7253 <project name="property-example">
7254 <property name="debug" value="true" overwrite="false" />
7255 <echo message="debug: ${debug}" />
7256 </project>
7257 ]]>
7258 </code>
7259 <para>
7260 Executing this build file with the command line option <c>-D:debug=false</c>,
7261 would cause the value specified on the command line to remain unaltered.
7262 </para>
7263 <code>
7264 <![CDATA[
7265 [echo] debug: false
7266 ]]>
7267 </code>
7268 </example>
7269 </member>
7270 <member name="P:NAnt.Core.Tasks.PropertyTask.PropertyName">
7271 <summary>
7272 The name of the NAnt property to set.
7273 </summary>
7274 </member>
7275 <member name="P:NAnt.Core.Tasks.PropertyTask.Value">
7276 <summary>
7277 The value to assign to the NAnt property.
7278 </summary>
7279 </member>
7280 <member name="P:NAnt.Core.Tasks.PropertyTask.ReadOnly">
7281 <summary>
7282 Specifies whether the property is read-only or not.
7283 The default is <see langword="false" />.
7284 </summary>
7285 </member>
7286 <member name="P:NAnt.Core.Tasks.PropertyTask.Dynamic">
7287 <summary>
7288 Specifies whether references to other properties should not be
7289 expanded when the value of the property is set, but expanded when
7290 the property is actually used. By default, properties will be
7291 expanded when set.
7292 </summary>
7293 </member>
7294 <member name="P:NAnt.Core.Tasks.PropertyTask.Overwrite">
7295 <summary>
7296 Specifies whether the value of a property should be overwritten if
7297 the property already exists (unless the property is read-only).
7298 The default is <see langword="true" />.
7299 </summary>
7300 </member>
7301 <member name="T:NAnt.Core.Tasks.RegexTask">
7302 <summary>
7303 Sets project properties based on the evaluatuion of a regular expression.
7304 </summary>
7305 <remarks>
7306 <para>
7307 The <see cref="P:NAnt.Core.Tasks.RegexTask.Pattern"/> attribute must contain one or more
7308 <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpcongroupingconstructs.asp">
7309 named grouping constructs</see>, which represents the names of the
7310 properties to be set. These named grouping constructs can be enclosed
7311 by angle brackets (?<name>) or single quotes (?'name').
7312 </para>
7313 <note>
7314 In the build file, use the XML element <![CDATA[<]]> to specify <,
7315 and <![CDATA[>]]> to specify >.
7316 </note>
7317 <note>
7318 The named grouping construct must not contain any punctuation and it
7319 cannot begin with a number.
7320 </note>
7321 </remarks>
7322 <example>
7323 <para>
7324 Find the last word in the given string and stores it in the property
7325 <c>lastword</c>.
7326 </para>
7327 <code>
7328 <![CDATA[
7329 <regex pattern="(?'lastword'\w+)$" input="This is a test sentence" />
7330 <echo message="${lastword}" />
7331 ]]>
7332 </code>
7333 </example>
7334 <example>
7335 <para>
7336 Split the full filename and extension of a filename.
7337 </para>
7338 <code>
7339 <![CDATA[
7340 <regex pattern="^(?'filename'.*)\.(?'extension'\w+)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" />
7341 ]]>
7342 </code>
7343 </example>
7344 <example>
7345 <para>
7346 Split the path and the filename. (This checks for <c>/</c> or <c>\</c>
7347 as the path separator).
7348 </para>
7349 <code>
7350 <![CDATA[
7351 <regex pattern="^(?'path'.*(\\|/)|(/|\\))(?'file'.*)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" />
7352 ]]>
7353 </code>
7354 <para>
7355 Results in path=<c>d:\Temp\SomeDir\SomeDir\</c> and file=<c>bla.xml</c>.
7356 </para>
7357 </example>
7358 </member>
7359 <member name="M:NAnt.Core.Tasks.RegexTask.ExecuteTask">
7360 <summary>
7361 Executes the task.
7362 </summary>
7363 </member>
7364 <member name="P:NAnt.Core.Tasks.RegexTask.Pattern">
7365 <summary>
7366 Represents the regular expression to be evalued.
7367 </summary>
7368 <value>
7369 The regular expression to be evalued.
7370 </value>
7371 <remarks>
7372 The pattern must contain one or more named constructs, which may
7373 not contain any punctuation and cannot begin with a number.
7374 </remarks>
7375 </member>
7376 <member name="P:NAnt.Core.Tasks.RegexTask.Options">
7377 <summary>
7378 A comma separated list of options to pass to the regex engine. The
7379 default is <see cref="F:System.Text.RegularExpressions.RegexOptions.None"/>.
7380 </summary>
7381 </member>
7382 <member name="P:NAnt.Core.Tasks.RegexTask.Input">
7383 <summary>
7384 Represents the input for the regular expression.
7385 </summary>
7386 <value>
7387 The input for the regular expression.
7388 </value>
7389 </member>
7390 <member name="T:NAnt.Core.Tasks.SetEnvTask">
7391 <summary>
7392 Sets an environment variable or a whole collection of them. Use an empty
7393 <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute to clear a variable.
7394 </summary>
7395 <remarks>
7396 <note>
7397 Variables will be set for the current NAnt process and all child
7398 processes that NAnt spawns (compilers, shell tools, etc). If the
7399 intention is to only set a variable for a single child process, then
7400 using the <see cref="T:NAnt.Core.Tasks.ExecTask"/> and its nested <see cref="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet"/>
7401 element might be a better option.
7402 </note>
7403 <note>
7404 Expansion of inline environment variables is performed using the syntax
7405 of the current platform. So on Windows platforms using the string %PATH%
7406 in the <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute will result in the value of
7407 the PATH variable being expanded in place before the variable is set.
7408 </note>
7409 </remarks>
7410 <example>
7411 <para>Set the MONO_PATH environment variable on a *nix platform.</para>
7412 <code>
7413 <![CDATA[
7414 <setenv name=="MONO_PATH" value="/home/jimbob/dev/foo:%MONO_PATH%"/>
7415 ]]>
7416 </code>
7417 </example>
7418 <example>
7419 <para>Set a collection of environment variables. Note the nested variable used to set var3.</para>
7420 <code>
7421 <![CDATA[
7422 <setenv>
7423 <variable name="var1" value="value2" />
7424 <variable name="var2" value="value2" />
7425 <variable name="var3" value="value3:%var2%" />
7426 </setenv>
7427 ]]>
7428 </code>
7429 </example>
7430 <example>
7431 <para>Set environment variables using nested path elements.</para>
7432 <code>
7433 <![CDATA[
7434 <path id="build.path">
7435 <pathelement dir="c:/windows" />
7436 <pathelement dir="c:/cygwin/usr/local/bin" />
7437 </path>
7438 <setenv>
7439 <variable name="build_path" >
7440 <path refid="build.path" />
7441 </variable>
7442 <variable name="path2">
7443 <path>
7444 <pathelement dir="c:/windows" />
7445 <pathelement dir="c:/cygwin/usr/local/bin" />
7446 </path>
7447 </variable>
7448 </setenv>
7449 ]]>
7450 </code>
7451 </example>
7452 </member>
7453 <member name="M:NAnt.Core.Tasks.SetEnvTask.SetEnvironmentVariable(System.String,System.String)">
7454 <summary>
7455 Win32 DllImport for the SetEnvironmentVariable function.
7456 </summary>
7457 <param name="lpName"></param>
7458 <param name="lpValue"></param>
7459 <returns></returns>
7460 </member>
7461 <member name="M:NAnt.Core.Tasks.SetEnvTask.setenv(System.String,System.String,System.Int32)">
7462 <summary>
7463 *nix dllimport for the setenv function.
7464 </summary>
7465 <param name="name"></param>
7466 <param name="value"></param>
7467 <param name="overwrite"></param>
7468 <returns>
7469 <c>0</c> if the execution is successful; otherwise, <c>-1</c>.
7470 </returns>
7471 </member>
7472 <member name="M:NAnt.Core.Tasks.SetEnvTask.unsetenv(System.String)">
7473 <summary>
7474 Deletes all instances of the variable name.
7475 </summary>
7476 <param name="name">The variable to unset.</param>
7477 <returns>
7478 <c>0</c> if the execution is successful; otherwise, <c>-1</c>.
7479 </returns>
7480 </member>
7481 <member name="M:NAnt.Core.Tasks.SetEnvTask.Initialize">
7482 <summary>
7483 Checks whether the task is initialized with valid attributes.
7484 </summary>
7485 </member>
7486 <member name="M:NAnt.Core.Tasks.SetEnvTask.ExecuteTask">
7487 <summary>
7488 Set the environment variables
7489 </summary>
7490 </member>
7491 <member name="M:NAnt.Core.Tasks.SetEnvTask.SetSingleEnvironmentVariable(System.String,System.String)">
7492 <summary>
7493 Do the actual work here.
7494 </summary>
7495 <param name="name">The name of the environment variable.</param>
7496 <param name="value">The value of the environment variable.</param>
7497 </member>
7498 <member name="P:NAnt.Core.Tasks.SetEnvTask.EnvName">
7499 <summary>
7500 The name of a single Environment variable to set
7501 </summary>
7502 </member>
7503 <member name="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue">
7504 <summary>
7505 The literal value for the environment variable.
7506 </summary>
7507 </member>
7508 <member name="P:NAnt.Core.Tasks.SetEnvTask.File">
7509 <summary>
7510 The value for a file-based environment variable. NAnt will convert
7511 it to an absolute filename.
7512 </summary>
7513 </member>
7514 <member name="P:NAnt.Core.Tasks.SetEnvTask.Directory">
7515 <summary>
7516 The value for a directory-based environment variable. NAnt will
7517 convert it to an absolute path.
7518 </summary>
7519 </member>
7520 <member name="P:NAnt.Core.Tasks.SetEnvTask.Path">
7521 <summary>
7522 The value for a PATH like environment variable. You can use
7523 <c>:</c> or <c>;</c> as path separators and NAnt will convert it to
7524 the platform's local conventions.
7525 </summary>
7526 </member>
7527 <member name="T:NAnt.Core.Tasks.SleepTask">
7528 <summary>
7529 A task for sleeping a specified period of time, useful when a build or deployment process
7530 requires an interval between tasks.
7531 </summary>
7532 <example>
7533 <para>Sleep 1 hour, 2 minutes, 3 seconds and 4 milliseconds.</para>
7534 <code>
7535 <![CDATA[
7536 <sleep hours="1" minutes="2" seconds="3" milliseconds="4" />
7537 ]]>
7538 </code>
7539 </example>
7540 <example>
7541 <para>Sleep 123 milliseconds.</para>
7542 <code>
7543 <![CDATA[
7544 <sleep milliseconds="123" />
7545 ]]>
7546 </code>
7547 </example>
7548 </member>
7549 <member name="M:NAnt.Core.Tasks.SleepTask.Initialize">
7550 <summary>
7551 Verify parameters.
7552 </summary>
7553 </member>
7554 <member name="M:NAnt.Core.Tasks.SleepTask.GetSleepTime">
7555 <summary>
7556 Return time to sleep.
7557 </summary>
7558 </member>
7559 <member name="M:NAnt.Core.Tasks.SleepTask.DoSleep(System.Int32)">
7560 <summary>
7561 Sleeps for the specified number of milliseconds.
7562 </summary>
7563 <param name="millis">Number of milliseconds to sleep.</param>
7564 </member>
7565 <member name="P:NAnt.Core.Tasks.SleepTask.Hours">
7566 <summary>
7567 Hours to add to the sleep time.
7568 </summary>
7569 </member>
7570 <member name="P:NAnt.Core.Tasks.SleepTask.Minutes">
7571 <summary>
7572 Minutes to add to the sleep time.
7573 </summary>
7574 </member>
7575 <member name="P:NAnt.Core.Tasks.SleepTask.Seconds">
7576 <summary>
7577 Seconds to add to the sleep time.
7578 </summary>
7579 </member>
7580 <member name="P:NAnt.Core.Tasks.SleepTask.Milliseconds">
7581 <summary>
7582 Milliseconds to add to the sleep time.
7583 </summary>
7584 </member>
7585 <member name="T:NAnt.Core.Tasks.StyleTask">
7586 <summary>
7587 Processes a document via XSLT.
7588 </summary>
7589 <example>
7590 <para>Create a report in HTML.</para>
7591 <code>
7592 <![CDATA[
7593 <style style="report.xsl" in="data.xml" out="report.html" />
7594 ]]>
7595 </code>
7596 </example>
7597 <example>
7598 <para>Create a report in HTML, with a param.</para>
7599 <code>
7600 <![CDATA[
7601 <style style="report.xsl" in="data.xml" out="report.html">
7602 <parameters>
7603 <parameter name="reportType" namespaceuri="" value="Plain" />
7604 </parameters>
7605 </style>
7606 ]]>
7607 </code>
7608 </example>
7609 <example>
7610 <para>Create a report in HTML, with a expanded param.</para>
7611 <code>
7612 <![CDATA[
7613 <style style="report.xsl" in="data.xml" out="report.html">
7614 <parameters>
7615 <parameter name="reportType" namespaceuri="" value="${report.type}" />
7616 </parameters>
7617 </style>
7618 ]]>
7619 </code>
7620 </example>
7621 <example>
7622 <para>Create some code based on a directory of templates.</para>
7623 <code>
7624 <![CDATA[
7625 <style style="CodeGenerator.xsl" extension="java">
7626 <infiles>
7627 <include name="*.xml" />
7628 </infiles>
7629 <parameters>
7630 <parameter name="reportType" namespaceuri="" value="Plain" if="${report.plain}" />
7631 </parameters>
7632 <style>
7633 ]]>
7634 </code>
7635 </example>
7636 <example>
7637 <para>Create a report in HTML, with an extension object.</para>
7638 <code>
7639 <![CDATA[
7640 <style style="report.xsl" in="data.xml" out="report.html">
7641 <extensionobjects>
7642 <extensionobject namespaceuri="urn:Formatter" typename="XsltExtensionObjects.Formatter" assembly="XsltExtensionObjects.dll" />
7643 </extensionobjects>
7644 </style>
7645 ]]>
7646 </code>
7647 </example>
7648 </member>
7649 <member name="P:NAnt.Core.Tasks.StyleTask.DestDir">
7650 <summary>
7651 Directory in which to store the results. The default is the project
7652 base directory.
7653 </summary>
7654 </member>
7655 <member name="P:NAnt.Core.Tasks.StyleTask.Extension">
7656 <summary>
7657 Desired file extension to be used for the targets. The default is
7658 <c>html</c>.
7659 </summary>
7660 </member>
7661 <member name="P:NAnt.Core.Tasks.StyleTask.XsltFile">
7662 <summary>
7663 URI or path that points to the stylesheet to use. If given as path, it can
7664 be relative to the project's basedir or absolute.
7665 </summary>
7666 </member>
7667 <member name="P:NAnt.Core.Tasks.StyleTask.SrcFile">
7668 <summary>
7669 Specifies a single XML document to be styled. Should be used with
7670 the <see cref="P:NAnt.Core.Tasks.StyleTask.OutputFile"/> attribute.
7671 </summary>
7672 </member>
7673 <member name="P:NAnt.Core.Tasks.StyleTask.OutputFile">
7674 <summary>
7675 Specifies the output name for the styled result from the <see cref="P:NAnt.Core.Tasks.StyleTask.SrcFile"/>
7676 attribute.
7677 </summary>
7678 </member>
7679 <member name="P:NAnt.Core.Tasks.StyleTask.InFiles">
7680 <summary>
7681 Specifies a group of input files to which to apply the stylesheet.
7682 </summary>
7683 </member>
7684 <member name="P:NAnt.Core.Tasks.StyleTask.Parameters">
7685 <summary>
7686 XSLT parameters to be passed to the XSLT transformation.
7687 </summary>
7688 </member>
7689 <member name="P:NAnt.Core.Tasks.StyleTask.ExtensionObjects">
7690 <summary>
7691 XSLT extension objects to be passed to the XSLT transformation.
7692 </summary>
7693 </member>
7694 <member name="P:NAnt.Core.Tasks.StyleTask.Proxy">
7695 <summary>
7696 The network proxy to use to access the Internet resource.
7697 </summary>
7698 </member>
7699 <member name="T:NAnt.Core.Tasks.SysInfoTask">
7700 <summary>
7701 Sets properties with system information.
7702 </summary>
7703 <remarks>
7704 <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>
7705 <list type="table">
7706 <listheader>
7707 <term>Property</term>
7708 <description>Value</description>
7709 </listheader>
7710 <item>
7711 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.clr.version</term>
7712 <description>Common Language Runtime version number.</description>
7713 </item>
7714 <item>
7715 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.env.*</term>
7716 <description>Environment variables (e.g., <<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.env.PATH).</description>
7717 </item>
7718 <item>
7719 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.platform</term>
7720 <description>Operating system platform ID.</description>
7721 </item>
7722 <item>
7723 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.version</term>
7724 <description>Operating system version.</description>
7725 </item>
7726 <item>
7727 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os</term>
7728 <description>Operating system version string.</description>
7729 </item>
7730 <item>
7731 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.applicationdata</term>
7732 <description>The directory that serves as a common repository for application-specific data for the current roaming user.</description>
7733 </item>
7734 <item>
7735 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.commonapplicationdata</term>
7736 <description>The directory that serves as a common repository for application-specific data that is used by all users.</description>
7737 </item>
7738 <item>
7739 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.commonprogramfiles</term>
7740 <description>The directory for components that are shared across applications.</description>
7741 </item>
7742 <item>
7743 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.desktopdirectory</term>
7744 <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>
7745 </item>
7746 <item>
7747 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.programfiles</term>
7748 <description>The Program Files directory.</description>
7749 </item>
7750 <item>
7751 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.system</term>
7752 <description>The System directory.</description>
7753 </item>
7754 <item>
7755 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.temp</term>
7756 <description>The temporary directory.</description>
7757 </item>
7758 </list>
7759 <para>
7760 When the name of an environment variable is not a valid property name,
7761 the task will fail. In that case, set <see cref="P:NAnt.Core.Task.FailOnError"/> to
7762 <see langword="true"/> to allow that environment variable to be
7763 skipped.
7764 </para>
7765 <note>
7766 we advise you to use the following functions instead:
7767 </note>
7768 <list type="table">
7769 <listheader>
7770 <term>Function</term>
7771 <description>Description</description>
7772 </listheader>
7773 <item>
7774 <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/></term>
7775 <description>Gets a <see cref="T:System.OperatingSystem"/> object that identifies this operating system.</description>
7776 </item>
7777 <item>
7778 <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)"/></term>
7779 <description>Gets the path to a system special folder.</description>
7780 </item>
7781 <item>
7782 <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)"/></term>
7783 <description>Returns the value of a environment variable.</description>
7784 </item>
7785 <item>
7786 <term><see cref="M:NAnt.Core.Functions.PathFunctions.GetTempPath"/></term>
7787 <description>Gets the path to the temporary directory.</description>
7788 </item>
7789 <item>
7790 <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/></term>
7791 <description>Gets the Common Language Runtime version.</description>
7792 </item>
7793 </list>
7794 </remarks>
7795 <example>
7796 <para>Register the properties with the default property prefix.</para>
7797 <code>
7798 <![CDATA[
7799 <sysinfo />
7800 ]]>
7801 </code>
7802 </example>
7803 <example>
7804 <para>Register the properties without a prefix.</para>
7805 <code>
7806 <![CDATA[
7807 <sysinfo prefix="" />
7808 ]]>
7809 </code>
7810 </example>
7811 <example>
7812 <para>Register properties and display a summary.</para>
7813 <code>
7814 <![CDATA[
7815 <sysinfo verbose="true" />
7816 ]]>
7817 </code>
7818 </example>
7819 </member>
7820 <member name="P:NAnt.Core.Tasks.SysInfoTask.Prefix">
7821 <summary>
7822 The string to prefix the property names with. The default is "sys.".
7823 </summary>
7824 </member>
7825 <member name="T:NAnt.Core.Tasks.TStampTask">
7826 <summary>
7827 Sets properties with the current date and time.
7828 </summary>
7829 <remarks>
7830 <para>
7831 By default the <see cref="T:NAnt.Core.Tasks.TStampTask"/> displays the current date
7832 and time and sets the following properties:
7833 </para>
7834 <list type="bullet">
7835 <item><description>tstamp.date to yyyyMMdd</description></item>
7836 <item><description>tstamp.time to HHmm</description></item>
7837 <item><description>tstamp.now using the default DateTime.ToString() method</description></item>
7838 </list>
7839 <para>
7840 To set an additional property with a custom date/time use the
7841 <see cref="P:NAnt.Core.Tasks.TStampTask.Property"/> and <see cref="P:NAnt.Core.Tasks.TStampTask.Pattern"/> attributes.
7842 To set a number of additional properties with the exact same date and
7843 time use the <see cref="P:NAnt.Core.Tasks.TStampTask.Formatters"/> nested element (see example).
7844 </para>
7845 <para>
7846 The date and time string displayed by the <see cref="T:NAnt.Core.Tasks.TStampTask"/>
7847 uses the computer's default long date and time string format. You
7848 might consider setting these to the
7849 <see href="http://www.cl.cam.ac.uk/~mgk25/iso-time.html">ISO 8601 standard
7850 for date and time notation</see>.
7851 </para>
7852 </remarks>
7853 <example>
7854 <para>Set the <c>build.date</c> property.</para>
7855 <code>
7856 <![CDATA[
7857 <tstamp property="build.date" pattern="yyyyMMdd" verbose="true" />
7858 ]]>
7859 </code>
7860 </example>
7861 <example>
7862 <para>Set a number of properties for Ant like compatibility.</para>
7863 <code>
7864 <![CDATA[
7865 <tstamp verbose="true">
7866 <formatter property="TODAY" pattern="dd MMM yyyy"/>
7867 <formatter property="DSTAMP" pattern="yyyyMMdd" unless="${date.not.needed}" />
7868 <formatter property="TSTAMP" pattern="HHmm" if="${need.hours}" />
7869 </tstamp>
7870 ]]>
7871 </code>
7872 </example>
7873 </member>
7874 <member name="P:NAnt.Core.Tasks.TStampTask.Property">
7875 <summary>
7876 The property to receive the date/time string in the given pattern.
7877 </summary>
7878 </member>
7879 <member name="P:NAnt.Core.Tasks.TStampTask.Pattern">
7880 <summary>The date/time pattern to be used.</summary>
7881 <remarks>
7882 <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>
7883 <list type="table">
7884 <listheader>
7885 <description>Format Character</description>
7886 <description>Description Example Format Pattern (en-US)</description>
7887 </listheader>
7888 <item><description>d</description><description>MM/dd/yyyy</description></item>
7889 <item><description>D</description><description>dddd, dd MMMM yyyy</description></item>
7890 <item><description>f</description><description>dddd, dd MMMM yyyy HH:mm</description></item>
7891 <item><description>F</description><description>dddd, dd MMMM yyyy HH:mm:ss</description></item>
7892 <item><description>g</description><description>MM/dd/yyyy HH:mm</description></item>
7893 <item><description>G</description><description>MM/dd/yyyy HH:mm:ss</description></item>
7894 <item><description>m, M</description><description>MMMM dd</description></item>
7895 <item><description>r, R</description><description>ddd, dd MMM yyyy HH':'mm':'ss 'GMT'</description></item>
7896 <item><description>s</description><description>yyyy'-'MM'-'dd'T'HH':'mm':'ss</description></item>
7897 <item><description>t</description><description>HH:mm</description></item>
7898 <item><description>T</description><description>HH:mm:ss</description></item>
7899 <item><description>u</description><description>yyyy'-'MM'-'dd HH':'mm':'ss'Z'</description></item>
7900 <item><description>U</description><description>dddd, dd MMMM yyyy HH:mm:ss</description></item>
7901 <item><description>y, Y</description><description>yyyy MMMM</description></item>
7902 </list>
7903 <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>
7904 <list type="table">
7905 <listheader>
7906 <description>Format</description>
7907 <description>Pattern Description</description>
7908 </listheader>
7909 <item><description>d</description><description>The day of the month. Single-digit days will not have a leading zero.</description></item>
7910 <item><description>dd</description><description>The day of the month. Single-digit days will have a leading zero.</description></item>
7911 <item><description>ddd</description><description>The abbreviated name of the day of the week.</description></item>
7912 <item><description>dddd</description><description>The full name of the day of the week.</description></item>
7913 <item><description>M</description><description>The numeric month. Single-digit months will not have a leading zero.</description></item>
7914 <item><description>MM</description><description>The numeric month. Single-digit months will have a leading zero.</description></item>
7915 <item><description>MMM</description><description>The abbreviated name of the month.</description></item>
7916 <item><description>MMMM</description><description>The full name of the month.</description></item>
7917 <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>
7918 <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>
7919 <item><description>yyyy</description><description>The year in four digits, including the century.</description></item>
7920 <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>
7921 <item><description>h</description><description>The hour in a 12-hour clock. Single-digit hours will not have a leading zero.</description></item>
7922 <item><description>hh</description><description>The hour in a 12-hour clock. Single-digit hours will have a leading zero.</description></item>
7923 <item><description>H</description><description>The hour in a 24-hour clock. Single-digit hours will not have a leading zero.</description></item>
7924 <item><description>HH</description><description>The hour in a 24-hour clock. Single-digit hours will have a leading zero.</description></item>
7925 <item><description>m</description><description>The minute. Single-digit minutes will not have a leading zero.</description></item>
7926 <item><description>mm</description><description>The minute. Single-digit minutes will have a leading zero.</description></item>
7927 <item><description>s</description><description>The second. Single-digit seconds will not have a leading zero.</description></item>
7928 <item><description>ss</description><description>The second. Single-digit seconds will have a leading zero.</description></item>
7929 <item><description>f</description><description>The fraction of a second in single-digit precision. The remaining digits are truncated.</description></item>
7930 <item><description>ff</description><description>The fraction of a second in double-digit precision. The remaining digits are truncated.</description></item>
7931 <item><description>fff</description><description>The fraction of a second in three-digit precision. The remaining digits are truncated.</description></item>
7932 <item><description>ffff</description><description>The fraction of a second in four-digit precision. The remaining digits are truncated.</description></item>
7933 <item><description>fffff</description><description>The fraction of a second in five-digit precision. The remaining digits are truncated. </description></item>
7934 <item><description>ffffff</description><description>The fraction of a second in six-digit precision. The remaining digits are truncated. </description></item>
7935 <item><description>fffffff</description><description>The fraction of a second in seven-digit precision. The remaining digits are truncated. </description></item>
7936 <item><description>t</description><description>The first character in the AM/PM designator.</description></item>
7937 <item><description>tt</description><description>The AM/PM designator. </description></item>
7938 <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>
7939 <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>
7940 <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>
7941 <item><description>:</description><description>The default time separator.</description></item>
7942 <item><description>/</description><description>The default date separator.</description></item>
7943 <item><description>\ c</description><description>Pattern Where c is any character. Displays the character literally. To display the backslash character, use "\\". </description></item>
7944 </list>
7945 </remarks>
7946 </member>
7947 <member name="T:NAnt.Core.Tasks.TouchTask">
7948 <summary>
7949 Touches a file or set of files -- corresponds to the Unix touch command.
7950 </summary>
7951 <remarks>
7952 <para>
7953 If the file specified does not exist, the task will create it.
7954 </para>
7955 </remarks>
7956 <example>
7957 <para>Touch the <c>Main.cs</c> file. The current time is used.</para>
7958 <code>
7959 <![CDATA[
7960 <touch file="Main.cs" />
7961 ]]>
7962 </code>
7963 </example>
7964 <example>
7965 <para>
7966 Touch all executable files in the project base directory and its
7967 subdirectories.
7968 </para>
7969 <code>
7970 <![CDATA[
7971 <touch>
7972 <fileset>
7973 <include name="**/*.exe" />
7974 <include name="**/*.dll" />
7975 </fileset>
7976 </touch>
7977 ]]>
7978 </code>
7979 </example>
7980 </member>
7981 <member name="M:NAnt.Core.Tasks.TouchTask.Initialize">
7982 <summary>
7983 Ensures the supplied attributes are valid.
7984 </summary>
7985 </member>
7986 <member name="P:NAnt.Core.Tasks.TouchTask.File">
7987 <summary>
7988 The file to touch.
7989 </summary>
7990 </member>
7991 <member name="P:NAnt.Core.Tasks.TouchTask.Millis">
7992 <summary>
7993 Specifies the new modification time of the file(s) in milliseconds
7994 since midnight Jan 1 1970.
7995 </summary>
7996 </member>
7997 <member name="P:NAnt.Core.Tasks.TouchTask.Datetime">
7998 <summary>
7999 Specifies the new modification time of the file in the format
8000 MM/DD/YYYY HH:MM:SS.
8001 </summary>
8002 </member>
8003 <member name="P:NAnt.Core.Tasks.TouchTask.TouchFileSet">
8004 <summary>
8005 Used to select files that should be touched.
8006 </summary>
8007 </member>
8008 <member name="T:NAnt.Core.Tasks.UpToDateTask">
8009 <summary>
8010 Check modification dates on groups of files.
8011 </summary>
8012 <remarks>
8013 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
8014 is set to <see langword="false"/>.
8015 </remarks>
8016 <example>
8017 <para>
8018 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
8019 to either <see langword="true"/> or <see langword="false"/>.
8020 </para>
8021 <code>
8022 <![CDATA[
8023 <uptodate property="myfile.dll.uptodate">
8024 <sourcefiles>
8025 <include name="myfile.cs" />
8026 </sourcefiles>
8027 <targetfiles>
8028 <include name="myfile.dll" />
8029 </targetfiles>
8030 </uptodate>
8031 ]]>
8032 </code>
8033 </example>
8034 </member>
8035 <member name="P:NAnt.Core.Tasks.UpToDateTask.PropertyName">
8036 <summary>
8037 Property that will be set to <see langword="true" /> or <see langword="false" /> depending on the
8038 result of the date check.
8039 </summary>
8040 </member>
8041 <member name="P:NAnt.Core.Tasks.UpToDateTask.SourceFiles">
8042 <summary>
8043 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains list of source files.
8044 </summary>
8045 </member>
8046 <member name="P:NAnt.Core.Tasks.UpToDateTask.TargetFiles">
8047 <summary>
8048 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains list of target files.
8049 </summary>
8050 </member>
8051 <member name="T:NAnt.Core.Tasks.XmlPeekTask">
8052 <summary>
8053 Extracts text from an XML file at the location specified by an XPath
8054 expression.
8055 </summary>
8056 <remarks>
8057 <para>
8058 If the XPath expression specifies multiple nodes the node index is used
8059 to determine which of the nodes' text is returned.
8060 </para>
8061 </remarks>
8062 <example>
8063 <para>
8064 The example provided assumes that the following XML file (App.config)
8065 exists in the current build directory.
8066 </para>
8067 <code>
8068 <![CDATA[
8069 <?xml version="1.0" encoding="utf-8" ?>
8070 <configuration xmlns="http://www.gordic.cz/shared/project-config/v_1.0.0.0">
8071 <appSettings>
8072 <add key="server" value="testhost.somecompany.com" />
8073 </appSettings>
8074 </configuration>
8075 ]]>
8076 </code>
8077 </example>
8078 <example>
8079 <para>
8080 The example will read the server value from the above
8081 configuration file.
8082 </para>
8083 <code>
8084 <![CDATA[
8085 <xmlpeek
8086 file="App.config"
8087 xpath="/x:configuration/x:appSettings/x:add[@key = 'server']/@value"
8088 property="configuration.server">
8089 <namespaces>
8090 <namespace prefix="x" uri="http://www.gordic.cz/shared/project-config/v_1.0.0.0" />
8091 </namespaces>
8092 </xmlpeek>
8093 ]]>
8094 </code>
8095 </example>
8096 </member>
8097 <member name="M:NAnt.Core.Tasks.XmlPeekTask.ExecuteTask">
8098 <summary>
8099 Executes the XML peek task.
8100 </summary>
8101 </member>
8102 <member name="M:NAnt.Core.Tasks.XmlPeekTask.LoadDocument(System.String)">
8103 <summary>
8104 Loads an XML document from a file on disk.
8105 </summary>
8106 <param name="fileName">The file name of the file to load the XML document from.</param>
8107 <returns>
8108 A <see cref="T:System.Xml.XmlDocument">document</see> containing
8109 the document object representing the file.
8110 </returns>
8111 </member>
8112 <member name="M:NAnt.Core.Tasks.XmlPeekTask.GetNodeContents(System.String,System.Xml.XmlDocument,System.Int32)">
8113 <summary>
8114 Gets the contents of the node specified by the XPath expression.
8115 </summary>
8116 <param name="xpath">The XPath expression used to determine which nodes to choose from.</param>
8117 <param name="document">The XML document to select the nodes from.</param>
8118 <param name="nodeIndex">The node index in the case where multiple nodes satisfy the expression.</param>
8119 <returns>
8120 The contents of the node specified by the XPath expression.
8121 </returns>
8122 </member>
8123 <member name="P:NAnt.Core.Tasks.XmlPeekTask.XmlFile">
8124 <summary>
8125 The name of the file that contains the XML document
8126 that is going to be peeked at.
8127 </summary>
8128 </member>
8129 <member name="P:NAnt.Core.Tasks.XmlPeekTask.NodeIndex">
8130 <summary>
8131 The index of the node that gets its text returned when the query
8132 returns multiple nodes.
8133 </summary>
8134 </member>
8135 <member name="P:NAnt.Core.Tasks.XmlPeekTask.Property">
8136 <summary>
8137 The property that receives the text representation of the XML inside
8138 the node returned from the XPath expression.
8139 </summary>
8140 </member>
8141 <member name="P:NAnt.Core.Tasks.XmlPeekTask.XPath">
8142 <summary>
8143 The XPath expression used to select which node to read.
8144 </summary>
8145 </member>
8146 <member name="P:NAnt.Core.Tasks.XmlPeekTask.Namespaces">
8147 <summary>
8148 Namespace definitions to resolve prefixes in the XPath expression.
8149 </summary>
8150 </member>
8151 <member name="T:NAnt.Core.Tasks.XmlPokeTask">
8152 <summary>
8153 Replaces text in an XML file at the location specified by an XPath
8154 expression.
8155 </summary>
8156 <remarks>
8157 <para>
8158 The location specified by the XPath expression must exist, it will
8159 not create the parent elements for you. However, provided you have
8160 a root element you could use a series of the tasks to build the
8161 XML file up if necessary.
8162 </para>
8163 </remarks>
8164 <example>
8165 <para>
8166 Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
8167 to <c>productionhost.somecompany.com</c>.
8168 </para>
8169 <para>XML file:</para>
8170 <code>
8171 <![CDATA[
8172 <?xml version="1.0" encoding="utf-8" ?>
8173 <configuration>
8174 <appSettings>
8175 <add key="server" value="testhost.somecompany.com" />
8176 </appSettings>
8177 </configuration>
8178 ]]>
8179 </code>
8180 <para>Build fragment:</para>
8181 <code>
8182 <![CDATA[
8183 <xmlpoke
8184 file="App.config"
8185 xpath="/configuration/appSettings/add[@key = 'server']/@value"
8186 value="productionhost.somecompany.com" />
8187 ]]>
8188 </code>
8189 </example>
8190 <example>
8191 <para>
8192 Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
8193 </para>
8194 <para>XML file:</para>
8195 <code>
8196 <![CDATA[
8197 <?xml version="1.0" encoding="utf-8" ?>
8198 <Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
8199 </Commands>
8200 ]]>
8201 </code>
8202 <para>Build fragment:</para>
8203 <code>
8204 <![CDATA[
8205 <xmlpoke file="test.xml" xpath="/Commands/@xsi:noNamespaceSchemaLocation" value="d:\Commands.xsd">
8206 <namespaces>
8207 <namespace prefix="xsi" uri="http://www.w3.org/2001/XMLSchema-instance" />
8208 </namespaces>
8209 </xmlpoke>
8210 ]]>
8211 </code>
8212 </example>
8213 </member>
8214 <member name="M:NAnt.Core.Tasks.XmlPokeTask.ExecuteTask">
8215 <summary>
8216 Executes the XML poke task.
8217 </summary>
8218 </member>
8219 <member name="M:NAnt.Core.Tasks.XmlPokeTask.LoadDocument(System.String)">
8220 <summary>
8221 Loads an XML document from a file on disk.
8222 </summary>
8223 <param name="fileName">
8224 The file name of the file to load the XML document from.
8225 </param>
8226 <returns>
8227 An <see cref="T:System.Xml.XmlDocument"/> containing
8228 the document object model representing the file.
8229 </returns>
8230 </member>
8231 <member name="M:NAnt.Core.Tasks.XmlPokeTask.SelectNodes(System.String,System.Xml.XmlDocument,System.Xml.XmlNamespaceManager)">
8232 <summary>
8233 Given an XML document and an expression, returns a list of nodes
8234 which match the expression criteria.
8235 </summary>
8236 <param name="xpath">
8237 The XPath expression used to select the nodes.
8238 </param>
8239 <param name="document">
8240 The XML document that is searched.
8241 </param>
8242 <param name="nsMgr">
8243 An <see cref="T:System.Xml.XmlNamespaceManager"/> to use for resolving namespaces
8244 for prefixes in the XPath expression.
8245 </param>
8246 <returns>
8247 An <see cref="T:System.Xml.XmlNodeList"/> containing references to the nodes
8248 that matched the XPath expression.
8249 </returns>
8250 </member>
8251 <member name="M:NAnt.Core.Tasks.XmlPokeTask.UpdateNodes(System.Xml.XmlNodeList,System.String)">
8252 <summary>
8253 Given a node list, replaces the XML within those nodes.
8254 </summary>
8255 <param name="nodes">
8256 The list of nodes to replace the contents of.
8257 </param>
8258 <param name="value">
8259 The text to replace the contents with.
8260 </param>
8261 </member>
8262 <member name="M:NAnt.Core.Tasks.XmlPokeTask.SaveDocument(System.Xml.XmlDocument,System.String)">
8263 <summary>
8264 Saves the XML document to a file.
8265 </summary>
8266 <param name="document">The XML document to be saved.</param>
8267 <param name="fileName">The file name to save the XML document under.</param>
8268 </member>
8269 <member name="P:NAnt.Core.Tasks.XmlPokeTask.XmlFile">
8270 <summary>
8271 The name of the file that contains the XML document that is going
8272 to be poked.
8273 </summary>
8274 </member>
8275 <member name="P:NAnt.Core.Tasks.XmlPokeTask.XPath">
8276 <summary>
8277 The XPath expression used to select which nodes are to be modified.
8278 </summary>
8279 </member>
8280 <member name="P:NAnt.Core.Tasks.XmlPokeTask.Value">
8281 <summary>
8282 The value that replaces the contents of the selected nodes.
8283 </summary>
8284 </member>
8285 <member name="P:NAnt.Core.Tasks.XmlPokeTask.Namespaces">
8286 <summary>
8287 Namespace definitions to resolve prefixes in the XPath expression.
8288 </summary>
8289 </member>
8290 <member name="T:NAnt.Core.Types.Argument">
8291 <summary>
8292 Represents a command-line argument.
8293 </summary>
8294 <remarks>
8295 <para>
8296 When passed to an external application, the argument will be quoted
8297 when appropriate. This does not apply to the <see cref="P:NAnt.Core.Types.Argument.Line"/>
8298 parameter, which is always passed as is.
8299 </para>
8300 </remarks>
8301 <example>
8302 <para>
8303 A single command-line argument containing a space character.
8304 </para>
8305 <code>
8306 <![CDATA[
8307 <arg value="-l -a" />
8308 ]]>
8309 </code>
8310 </example>
8311 <example>
8312 <para>
8313 Two separate command-line arguments.
8314 </para>
8315 <code>
8316 <![CDATA[
8317 <arg line="-l -a" />
8318 ]]>
8319 </code>
8320 </example>
8321 <example>
8322 <para>
8323 A single command-line argument with the value <c>\dir;\dir2;\dir3</c>
8324 on DOS-based systems and <c>/dir:/dir2:/dir3</c> on Unix-like systems.
8325 </para>
8326 <code>
8327 <![CDATA[
8328 <arg path="/dir;/dir2:\dir3" />
8329 ]]>
8330 </code>
8331 </example>
8332 </member>
8333 <member name="M:NAnt.Core.Types.Argument.#ctor">
8334 <summary>
8335 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class.
8336 </summary>
8337 </member>
8338 <member name="M:NAnt.Core.Types.Argument.#ctor(System.String)">
8339 <summary>
8340 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
8341 with the specified command-line argument.
8342 </summary>
8343 </member>
8344 <member name="M:NAnt.Core.Types.Argument.#ctor(System.IO.FileInfo)">
8345 <summary>
8346 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
8347 with the given file.
8348 </summary>
8349 </member>
8350 <member name="M:NAnt.Core.Types.Argument.#ctor(NAnt.Core.Types.PathSet)">
8351 <summary>
8352 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
8353 with the given path.
8354 </summary>
8355 </member>
8356 <member name="M:NAnt.Core.Types.Argument.ToString">
8357 <summary>
8358 Returns the argument as a <see cref="T:System.String"/>.
8359 </summary>
8360 <returns>
8361 The argument as a <see cref="T:System.String"/>.
8362 </returns>
8363 <remarks>
8364 File and individual path elements will be quoted if necessary.
8365 </remarks>
8366 </member>
8367 <member name="M:NAnt.Core.Types.Argument.QuoteArgument(System.String)">
8368 <summary>
8369 Quotes a command line argument if it contains a single quote or a
8370 space.
8371 </summary>
8372 <param name="argument">The command line argument.</param>
8373 <returns>
8374 A quoted command line argument if <paramref name="argument" />
8375 contains a single quote or a space; otherwise,
8376 <paramref name="argument" />.
8377 </returns>
8378 </member>
8379 <member name="P:NAnt.Core.Types.Argument.Value">
8380 <summary>
8381 A single command-line argument; can contain space characters.
8382 </summary>
8383 </member>
8384 <member name="P:NAnt.Core.Types.Argument.File">
8385 <summary>
8386 The name of a file as a single command-line argument; will be
8387 replaced with the absolute filename of the file.
8388 </summary>
8389 </member>
8390 <member name="P:NAnt.Core.Types.Argument.Directory">
8391 <summary>
8392 The value for a directory-based command-line argument; will be
8393 replaced with the absolute path of the directory.
8394 </summary>
8395 </member>
8396 <member name="P:NAnt.Core.Types.Argument.Path">
8397 <summary>
8398 The value for a PATH-like command-line argument; you can use
8399 <c>:</c> or <c>;</c> as path separators and NAnt will convert it
8400 to the platform's local conventions, while resolving references to
8401 environment variables.
8402 </summary>
8403 <remarks>
8404 Individual parts will be replaced with the absolute path, resolved
8405 relative to the project base directory.
8406 </remarks>
8407 </member>
8408 <member name="P:NAnt.Core.Types.Argument.PathSet">
8409 <summary>
8410 Sets a single command-line argument and treats it like a PATH - ensures
8411 the right separator for the local platform is used.
8412 </summary>
8413 </member>
8414 <member name="P:NAnt.Core.Types.Argument.Line">
8415 <summary>
8416 List of command-line arguments; will be passed to the executable
8417 as is.
8418 </summary>
8419 </member>
8420 <member name="P:NAnt.Core.Types.Argument.IfDefined">
8421 <summary>
8422 Indicates if the argument should be passed to the external program.
8423 If <see langword="true" /> then the argument will be passed;
8424 otherwise, skipped. The default is <see langword="true" />.
8425 </summary>
8426 </member>
8427 <member name="P:NAnt.Core.Types.Argument.UnlessDefined">
8428 <summary>
8429 Indicates if the argument should not be passed to the external
8430 program. If <see langword="false" /> then the argument will be
8431 passed; otherwise, skipped. The default is <see langword="false" />.
8432 </summary>
8433 </member>
8434 <member name="P:NAnt.Core.Types.Argument.StringValue">
8435 <summary>
8436 Gets string value corresponding with the argument.
8437 </summary>
8438 </member>
8439 <member name="T:NAnt.Core.Types.ArgumentCollection">
8440 <summary>
8441 Contains a collection of <see cref="T:NAnt.Core.Types.Argument"/> elements.
8442 </summary>
8443 </member>
8444 <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor">
8445 <summary>
8446 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class.
8447 </summary>
8448 </member>
8449 <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor(NAnt.Core.Types.ArgumentCollection)">
8450 <summary>
8451 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class
8452 with the specified <see cref="T:NAnt.Core.Types.ArgumentCollection"/> instance.
8453 </summary>
8454 </member>
8455 <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor(NAnt.Core.Types.Argument[])">
8456 <summary>
8457 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class
8458 with the specified array of <see cref="T:NAnt.Core.Types.Argument"/> instances.
8459 </summary>
8460 </member>
8461 <member name="M:NAnt.Core.Types.ArgumentCollection.Add(NAnt.Core.Types.Argument)">
8462 <summary>
8463 Adds a <see cref="T:NAnt.Core.Types.Argument"/> to the end of the collection.
8464 </summary>
8465 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to be added to the end of the collection.</param>
8466 <returns>The position into which the new element was inserted.</returns>
8467 </member>
8468 <member name="M:NAnt.Core.Types.ArgumentCollection.AddRange(NAnt.Core.Types.Argument[])">
8469 <summary>
8470 Adds the elements of a <see cref="T:NAnt.Core.Types.Argument"/> array to the end of the collection.
8471 </summary>
8472 <param name="items">The array of <see cref="T:NAnt.Core.Types.Argument"/> elements to be added to the end of the collection.</param>
8473 </member>
8474 <member name="M:NAnt.Core.Types.ArgumentCollection.AddRange(NAnt.Core.Types.ArgumentCollection)">
8475 <summary>
8476 Adds the elements of a <see cref="T:NAnt.Core.Types.ArgumentCollection"/> to the end of the collection.
8477 </summary>
8478 <param name="items">The <see cref="T:NAnt.Core.Types.ArgumentCollection"/> to be added to the end of the collection.</param>
8479 </member>
8480 <member name="M:NAnt.Core.Types.ArgumentCollection.Contains(NAnt.Core.Types.Argument)">
8481 <summary>
8482 Determines whether a <see cref="T:NAnt.Core.Types.Argument"/> is in the collection.
8483 </summary>
8484 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to locate in the collection.</param>
8485 <returns>
8486 <see langword="true"/> if <paramref name="item"/> is found in the
8487 collection; otherwise, <see langword="false"/>.
8488 </returns>
8489 </member>
8490 <member name="M:NAnt.Core.Types.ArgumentCollection.Contains(System.String)">
8491 <summary>
8492 Determines whether a <see cref="T:NAnt.Core.Types.Argument"/> with the specified
8493 value is in the collection.
8494 </summary>
8495 <param name="value">The argument value to locate in the collection.</param>
8496 <returns>
8497 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.Argument"/> with value
8498 <paramref name="value"/> is found in the collection; otherwise,
8499 <see langword="false"/>.
8500 </returns>
8501 </member>
8502 <member name="M:NAnt.Core.Types.ArgumentCollection.CopyTo(NAnt.Core.Types.Argument[],System.Int32)">
8503 <summary>
8504 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
8505 </summary>
8506 <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>
8507 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
8508 </member>
8509 <member name="M:NAnt.Core.Types.ArgumentCollection.IndexOf(NAnt.Core.Types.Argument)">
8510 <summary>
8511 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Argument"/> object in the collection.
8512 </summary>
8513 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> object for which the index is returned.</param>
8514 <returns>
8515 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.
8516 </returns>
8517 </member>
8518 <member name="M:NAnt.Core.Types.ArgumentCollection.Insert(System.Int32,NAnt.Core.Types.Argument)">
8519 <summary>
8520 Inserts a <see cref="T:NAnt.Core.Types.Argument"/> into the collection at the specified index.
8521 </summary>
8522 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
8523 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to insert.</param>
8524 </member>
8525 <member name="M:NAnt.Core.Types.ArgumentCollection.GetEnumerator">
8526 <summary>
8527 Returns an enumerator that can iterate through the collection.
8528 </summary>
8529 <returns>
8530 A <see cref="T:NAnt.Core.Types.ArgumentEnumerator"/> for the entire collection.
8531 </returns>
8532 </member>
8533 <member name="M:NAnt.Core.Types.ArgumentCollection.Remove(NAnt.Core.Types.Argument)">
8534 <summary>
8535 Removes a member from the collection.
8536 </summary>
8537 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to remove from the collection.</param>
8538 </member>
8539 <member name="P:NAnt.Core.Types.ArgumentCollection.Item(System.Int32)">
8540 <summary>
8541 Gets or sets the element at the specified index.
8542 </summary>
8543 <param name="index">The zero-based index of the element to get or set.</param>
8544 </member>
8545 <member name="P:NAnt.Core.Types.ArgumentCollection.Item(System.String)">
8546 <summary>
8547 Gets the <see cref="T:NAnt.Core.Types.Argument"/> with the specified value.
8548 </summary>
8549 <param name="value">The value of the <see cref="T:NAnt.Core.Types.Argument"/> to get.</param>
8550 </member>
8551 <member name="T:NAnt.Core.Types.ArgumentEnumerator">
8552 <summary>
8553 Enumerates the <see cref="T:NAnt.Core.Types.Argument"/> elements of a <see cref="T:NAnt.Core.Types.ArgumentCollection"/>.
8554 </summary>
8555 </member>
8556 <member name="M:NAnt.Core.Types.ArgumentEnumerator.#ctor(NAnt.Core.Types.ArgumentCollection)">
8557 <summary>
8558 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentEnumerator"/> class
8559 with the specified <see cref="T:NAnt.Core.Types.ArgumentCollection"/>.
8560 </summary>
8561 <param name="arguments">The collection that should be enumerated.</param>
8562 </member>
8563 <member name="M:NAnt.Core.Types.ArgumentEnumerator.MoveNext">
8564 <summary>
8565 Advances the enumerator to the next element of the collection.
8566 </summary>
8567 <returns>
8568 <see langword="true" /> if the enumerator was successfully advanced
8569 to the next element; <see langword="false" /> if the enumerator has
8570 passed the end of the collection.
8571 </returns>
8572 </member>
8573 <member name="M:NAnt.Core.Types.ArgumentEnumerator.Reset">
8574 <summary>
8575 Sets the enumerator to its initial position, which is before the
8576 first element in the collection.
8577 </summary>
8578 </member>
8579 <member name="P:NAnt.Core.Types.ArgumentEnumerator.Current">
8580 <summary>
8581 Gets the current element in the collection.
8582 </summary>
8583 <returns>
8584 The current element in the collection.
8585 </returns>
8586 </member>
8587 <member name="T:NAnt.Core.Types.Credential">
8588 <summary>
8589 Provides credentials for password-based authentication schemes.
8590 </summary>
8591 </member>
8592 <member name="M:NAnt.Core.Types.Credential.#ctor">
8593 <summary>
8594 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Credential"/> class.
8595 </summary>
8596 </member>
8597 <member name="M:NAnt.Core.Types.Credential.GetCredential">
8598 <summary>
8599 Returns a <see cref="T:System.Net.NetworkCredential"/> instance representing
8600 the current <see cref="T:NAnt.Core.Types.Credential"/>.
8601 </summary>
8602 <returns>
8603 A <see cref="T:System.Net.NetworkCredential"/> instance representing the current
8604 <see cref="T:NAnt.Core.Types.Credential"/>, or <see langword="null"/> if the
8605 credentials should not be used to provide authentication information
8606 to the external resource.
8607 </returns>
8608 </member>
8609 <member name="P:NAnt.Core.Types.Credential.Domain">
8610 <summary>
8611 The domain or computer name that verifies the credentials.
8612 </summary>
8613 </member>
8614 <member name="P:NAnt.Core.Types.Credential.Password">
8615 <summary>
8616 The password for the user name associated with the credentials.
8617 </summary>
8618 </member>
8619 <member name="P:NAnt.Core.Types.Credential.UserName">
8620 <summary>
8621 The user name associated with the credentials.
8622 </summary>
8623 </member>
8624 <member name="P:NAnt.Core.Types.Credential.IfDefined">
8625 <summary>
8626 Indicates if the credentials should be used to provide authentication
8627 information to the external resource. If <see langword="true" /> then
8628 the credentials will be passed; otherwise, not. The default is
8629 <see langword="true" />.
8630 </summary>
8631 </member>
8632 <member name="P:NAnt.Core.Types.Credential.UnlessDefined">
8633 <summary>
8634 Indicates if the credentials should not be used to provide authentication
8635 information to the external resource. If <see langword="false" /> then the
8636 credentials will be passed; otherwise, not. The default is
8637 <see langword="false" />.
8638 </summary>
8639 </member>
8640 <member name="T:NAnt.Core.Types.DirSet">
8641 <summary>
8642 A specialized <see cref="T:NAnt.Core.Types.FileSet"/> used for specifying a set of
8643 directories.
8644 </summary>
8645 <remarks>
8646 Hint for supporting tasks that the included directories instead of
8647 files should be used.
8648 </remarks>
8649 </member>
8650 <member name="T:NAnt.Core.Types.FileSet">
8651 <summary>
8652 Filesets are groups of files. These files can be found in a directory
8653 tree starting in a base directory and are matched by patterns taken
8654 from a number of patterns. Filesets can appear inside tasks that support
8655 this feature or at the project level, i.e., as children of <c><project></c>.
8656 </summary>
8657 <remarks>
8658 <h3>Patterns</h3>
8659 <para>
8660 As described earlier, patterns are used for the inclusion and exclusion.
8661 These patterns look very much like the patterns used in DOS and UNIX:
8662 </para>
8663 <list type="bullet">
8664 <item>
8665 <description>
8666 <para>'<c>*</c>' matches zero or more characters</para>
8667 <para>For example:</para>
8668 <para>
8669 <c>*.cs</c> matches <c>.cs</c>, <c>x.cs</c> and <c>FooBar.cs</c>,
8670 but not <c>FooBar.xml</c> (does not end with <c>.cs</c>).
8671 </para>
8672 </description>
8673 </item>
8674 <item>
8675 <description>
8676 <para>'<c>?</c>' matches one character</para>
8677 <para>For example:</para>
8678 <para>
8679 <c>?.cs</c> matches <c>x.cs</c>, <c>A.cs</c>, but not
8680 <c>.cs</c> or <c>xyz.cs</c> (both don't have one character
8681 before <c>.cs</c>).
8682 </para>
8683 </description>
8684 </item>
8685 </list>
8686 <para>
8687 Combinations of <c>*</c>'s and <c>?</c>'s are allowed.
8688 </para>
8689 <para>
8690 Matching is done per-directory. This means that first the first directory
8691 in the pattern is matched against the first directory in the path to match.
8692 Then the second directory is matched, and so on. For example, when we have
8693 the pattern <c>/?abc/*/*.cs</c> and the path <c>/xabc/foobar/test.cs</c>,
8694 the first <c>?abc</c> is matched with <c>xabc</c>, then <c>*</c> is matched
8695 with <c>foobar</c>, and finally <c>*.cs</c> is matched with <c>test.cs</c>.
8696 They all match, so the path matches the pattern.
8697 </para>
8698 <para>
8699 To make things a bit more flexible, we added one extra feature, which makes
8700 it possible to match multiple directory levels. This can be used to match a
8701 complete directory tree, or a file anywhere in the directory tree. To do this,
8702 <c>**</c> must be used as the name of a directory. When <c>**</c> is used as
8703 the name of a directory in the pattern, it matches zero or more directories.
8704 For example: <c>/test/**</c> matches all files/directories under <c>/test/</c>,
8705 such as <c>/test/x.cs</c>, or <c>/test/foo/bar/xyz.html</c>, but not <c>/xyz.xml</c>.
8706 </para>
8707 <para>
8708 There is one "shorthand" - if a pattern ends with <c>/</c> or <c>\</c>, then
8709 <c>**</c> is appended. For example, <c>mypackage/test/</c> is interpreted as
8710 if it were <c>mypackage/test/**</c>.
8711 </para>
8712 <h3>Case-Sensitivity</h3>
8713 <para>
8714 By default, pattern matching is case-sensitive on Unix and case-insensitive
8715 on other platforms. The <see cref="P:NAnt.Core.Types.FileSet.CaseSensitive"/> parameter can be used
8716 to override this.
8717 </para>
8718 <h3>Default Excludes</h3>
8719 <para>
8720 There are a set of definitions that are excluded by default from all
8721 tasks that use filesets. They are:
8722 </para>
8723 <list type="bullet">
8724 <item>
8725 <description>
8726 **/*~
8727 </description>
8728 </item>
8729 <item>
8730 <description>
8731 **/#*#
8732 </description>
8733 </item>
8734 <item>
8735 <description>
8736 **/.#*
8737 </description>
8738 </item>
8739 <item>
8740 <description>
8741 **/%*%
8742 </description>
8743 </item>
8744 <item>
8745 <description>
8746 **/CVS
8747 </description>
8748 </item>
8749 <item>
8750 <description>
8751 **/CVS/**
8752 </description>
8753 </item>
8754 <item>
8755 <description>
8756 **/.cvsignore
8757 </description>
8758 </item>
8759 <item>
8760 <description>
8761 **/.svn
8762 </description>
8763 </item>
8764 <item>
8765 <description>
8766 **/.svn/**
8767 </description>
8768 </item>
8769 <item>
8770 <description>
8771 **/_svn
8772 </description>
8773 </item>
8774 <item>
8775 <description>
8776 **/_svn/**
8777 </description>
8778 </item>
8779 <item>
8780 <description>
8781 **/SCCS
8782 </description>
8783 </item>
8784 <item>
8785 <description>
8786 **/SCCS/**
8787 </description>
8788 </item>
8789 <item>
8790 <description>
8791 **/vssver.scc
8792 </description>
8793 </item>
8794 <item>
8795 <description>
8796 **/_vti_cnf/**
8797 </description>
8798 </item>
8799 </list>
8800 <para>
8801 If you do not want these default excludes applied, you may disable them
8802 by setting <see cref="P:NAnt.Core.Types.FileSet.DefaultExcludes"/> to <see langword="false"/>.
8803 </para>
8804 </remarks>
8805 <example>
8806 <list type="table">
8807 <listheader>
8808 <term>Pattern</term>
8809 <description>Match</description>
8810 </listheader>
8811 <item>
8812 <term><c>**/CVS/*</c></term>
8813 <description>
8814 <para>
8815 Matches all files in <c>CVS</c> directories that can be
8816 located anywhere in the directory tree.
8817 </para>
8818 <para>Matches:</para>
8819 <list type="bullet">
8820 <item>
8821 <description>CVS/Repository</description>
8822 </item>
8823 <item>
8824 <description>org/apache/CVS/Entries</description>
8825 </item>
8826 <item>
8827 <description>org/apache/jakarta/tools/ant/CVS/Entries</description>
8828 </item>
8829 </list>
8830 <para>But not:</para>
8831 <list type="bullet">
8832 <item>
8833 <description>org/apache/CVS/foo/bar/Entries (<c>foo/bar/</c> part does not match)</description>
8834 </item>
8835 </list>
8836 </description>
8837 </item>
8838 <item>
8839 <term><c>org/apache/jakarta/**</c></term>
8840 <description>
8841 <para>
8842 Matches all files in the <c>org/apache/jakarta</c> directory
8843 tree.
8844 </para>
8845 <para>Matches:</para>
8846 <list type="bullet">
8847 <item>
8848 <description>org/apache/jakarta/tools/ant/docs/index.html</description>
8849 </item>
8850 <item>
8851 <description>org/apache/jakarta/test.xml</description>
8852 </item>
8853 </list>
8854 <para>But not:</para>
8855 <list type="bullet">
8856 <item>
8857 <description>org/apache/xyz.java (<c>jakarta/</c> part is missing)</description>
8858 </item>
8859 </list>
8860 </description>
8861 </item>
8862 <item>
8863 <term><c>org/apache/**/CVS/*</c></term>
8864 <description>
8865 <para>
8866 Matches all files in <c>CVS</c> directories that are located
8867 anywhere in the directory tree under <c>org/apache</c>.
8868 </para>
8869 <para>Matches:</para>
8870 <list type="bullet">
8871 <item>
8872 <description>org/apache/CVS/Entries</description>
8873 </item>
8874 <item>
8875 <description>org/apache/jakarta/tools/ant/CVS/Entries</description>
8876 </item>
8877 </list>
8878 <para>But not:</para>
8879 <list type="bullet">
8880 <item>
8881 <description>org/apache/CVS/foo/bar/Entries (<c>foo/bar/</c> part does not match)</description>
8882 </item>
8883 </list>
8884 </description>
8885 </item>
8886 <item>
8887 <term><c>**/test/**</c></term>
8888 <description>
8889 <para>
8890 Matches all files that have a <c>test</c> element in their
8891 path, including <c>test</c> as a filename.
8892 </para>
8893 </description>
8894 </item>
8895 </list>
8896 </example>
8897 <seealso cref="T:NAnt.Core.Types.PatternSet"/>
8898 </member>
8899 <member name="M:NAnt.Core.Types.FileSet.#ctor">
8900 <summary>
8901 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FileSet"/> class.
8902 </summary>
8903 </member>
8904 <member name="M:NAnt.Core.Types.FileSet.#ctor(NAnt.Core.Types.FileSet)">
8905 <summary>
8906 copy constructor
8907 </summary>
8908 <param name="fs"></param>
8909 </member>
8910 <member name="M:NAnt.Core.Types.FileSet.Clone">
8911 <summary>
8912 Creates a shallow copy of the <see cref="T:NAnt.Core.Types.FileSet"/>.
8913 </summary>
8914 <returns>
8915 A shallow copy of the <see cref="T:NAnt.Core.Types.FileSet"/>.
8916 </returns>
8917 </member>
8918 <member name="M:NAnt.Core.Types.FileSet.AddPatternSet(NAnt.Core.Types.PatternSet)">
8919 <summary>
8920 Adds a nested set of patterns, or references a standalone patternset.
8921 </summary>
8922 </member>
8923 <member name="M:NAnt.Core.Types.FileSet.CopyTo(NAnt.Core.Types.FileSet)">
8924 <summary>
8925 Copies all instance data of the <see cref="T:NAnt.Core.Types.FileSet"/> to a given
8926 <see cref="T:NAnt.Core.Types.FileSet"/>.
8927 </summary>
8928 </member>
8929 <member name="M:NAnt.Core.Types.FileSet.FindMoreRecentLastWriteTime(System.String,System.DateTime)">
8930 <summary>
8931 Determines if a file has a more recent last write time than the
8932 given time, or no longer exists.
8933 </summary>
8934 <param name="fileName">A file to check the last write time against.</param>
8935 <param name="targetLastWriteTime">The datetime to compare against.</param>
8936 <returns>
8937 The name of the file that has a last write time greater than
8938 <paramref name="targetLastWriteTime" /> or that no longer exists;
8939 otherwise, <see langword="null" />.
8940 </returns>
8941 </member>
8942 <member name="M:NAnt.Core.Types.FileSet.FindMoreRecentLastWriteTime(System.Collections.Specialized.StringCollection,System.DateTime)">
8943 <summary>
8944 Determines if one of the given files has a more recent last write
8945 time than the given time. If one of the given files no longer exists,
8946 the target will be considered out-of-date.
8947 </summary>
8948 <param name="fileNames">A collection of filenames to check the last write time against.</param>
8949 <param name="targetLastWriteTime">The datetime to compare against.</param>
8950 <returns>
8951 The name of the first file that has a last write time greater than
8952 <paramref name="targetLastWriteTime" />; otherwise, null.
8953 </returns>
8954 </member>
8955 <member name="P:NAnt.Core.Types.FileSet.CaseSensitive">
8956 <summary>
8957 Indicates whether include and exclude patterns must be treated in a
8958 case-sensitive way. The default is <see langword="true" /> on Unix;
8959 otherwise, <see langword="false" />.
8960 </summary>
8961 </member>
8962 <member name="P:NAnt.Core.Types.FileSet.FailOnEmpty">
8963 <summary>
8964 When set to <see langword="true"/>, causes the fileset element to
8965 throw a <see cref="T:NAnt.Core.ValidationException"/> when no files match the
8966 includes and excludes criteria. The default is <see langword="false"/>.
8967 </summary>
8968 </member>
8969 <member name="P:NAnt.Core.Types.FileSet.DefaultExcludes">
8970 <summary>
8971 Indicates whether default excludes should be used or not.
8972 The default is <see langword="true" />.
8973 </summary>
8974 </member>
8975 <member name="P:NAnt.Core.Types.FileSet.BaseDirectory">
8976 <summary>
8977 The base of the directory of this fileset. The default is the project
8978 base directory.
8979 </summary>
8980 </member>
8981 <member name="P:NAnt.Core.Types.FileSet.Includes">
8982 <summary>
8983 Gets the collection of include patterns.
8984 </summary>
8985 </member>
8986 <member name="P:NAnt.Core.Types.FileSet.Excludes">
8987 <summary>
8988 Gets the collection of exclude patterns.
8989 </summary>
8990 </member>
8991 <member name="P:NAnt.Core.Types.FileSet.AsIs">
8992 <summary>
8993 Gets the collection of files that will be added to the
8994 <see cref="T:NAnt.Core.Types.FileSet"/> without pattern matching or checking if the
8995 file exists.
8996 </summary>
8997 </member>
8998 <member name="P:NAnt.Core.Types.FileSet.FileNames">
8999 <summary>
9000 Gets the collection of file names that match the fileset.
9001 </summary>
9002 <value>
9003 A collection that contains the file names that match the
9004 <see cref="T:NAnt.Core.Types.FileSet"/>.
9005 </value>
9006 </member>
9007 <member name="P:NAnt.Core.Types.FileSet.DirectoryNames">
9008 <summary>
9009 Gets the collection of directory names that match the fileset.
9010 </summary>
9011 <value>
9012 A collection that contains the directory names that match the
9013 <see cref="T:NAnt.Core.Types.FileSet"/>.
9014 </value>
9015 </member>
9016 <member name="P:NAnt.Core.Types.FileSet.ScannedDirectories">
9017 <summary>
9018 Gets the collection of directory names that were scanned for files.
9019 </summary>
9020 <value>
9021 A collection that contains the directory names that were scanned for
9022 files.
9023 </value>
9024 </member>
9025 <member name="P:NAnt.Core.Types.FileSet.SetIncludes">
9026 <summary>
9027 The items to include in the fileset.
9028 </summary>
9029 </member>
9030 <member name="P:NAnt.Core.Types.FileSet.IncludeElements">
9031 <summary>
9032 The items to include in the fileset.
9033 </summary>
9034 </member>
9035 <member name="P:NAnt.Core.Types.FileSet.SetExcludes">
9036 <summary>
9037 The items to exclude from the fileset.
9038 </summary>
9039 </member>
9040 <member name="P:NAnt.Core.Types.FileSet.ExcludeElements">
9041 <summary>
9042 The items to exclude from the fileset.
9043 </summary>
9044 </member>
9045 <member name="P:NAnt.Core.Types.FileSet.SetIncludesList">
9046 <summary>
9047 The files from which a list of patterns or files to include should
9048 be obtained.
9049 </summary>
9050 </member>
9051 <member name="P:NAnt.Core.Types.FileSet.IncludesFiles">
9052 <summary>
9053 The files from which a list of patterns or files to include should
9054 be obtained.
9055 </summary>
9056 </member>
9057 <member name="P:NAnt.Core.Types.FileSet.ExcludesFiles">
9058 <summary>
9059 The files from which a list of patterns or files to exclude should
9060 be obtained.
9061 </summary>
9062 </member>
9063 <member name="P:NAnt.Core.Types.FileSet.MostRecentLastWriteTimeFile">
9064 <summary>
9065 Determines the most recently modified file in the fileset (by LastWriteTime of the <see cref="T:System.IO.FileInfo"/>).
9066 </summary>
9067 <returns>
9068 The <see cref="T:System.IO.FileInfo"/> of the file that has the newest (closest to present) last write time.
9069 </returns>
9070 </member>
9071 <member name="P:NAnt.Core.Types.FileSet.Exclude.Pattern">
9072 <summary>
9073 The pattern or file name to exclude.
9074 </summary>
9075 </member>
9076 <member name="P:NAnt.Core.Types.FileSet.Exclude.IfDefined">
9077 <summary>
9078 If <see langword="true" /> then the pattern will be excluded;
9079 otherwise, skipped. The default is <see langword="true" />.
9080 </summary>
9081 </member>
9082 <member name="P:NAnt.Core.Types.FileSet.Exclude.UnlessDefined">
9083 <summary>
9084 Opposite of <see cref="P:NAnt.Core.Types.FileSet.Exclude.IfDefined"/>. If <see langword="false"/>
9085 then the pattern will be excluded; otherwise, skipped. The default
9086 is <see langword="false"/>.
9087 </summary>
9088 </member>
9089 <member name="P:NAnt.Core.Types.FileSet.Include.AsIs">
9090 <summary>
9091 If <see langword="true"/> then the file name will be added to
9092 the <see cref="T:NAnt.Core.Types.FileSet"/> without pattern matching or checking
9093 if the file exists. The default is <see langword="false"/>.
9094 </summary>
9095 </member>
9096 <member name="P:NAnt.Core.Types.FileSet.Include.FromPath">
9097 <summary>
9098 If <see langword="true" /> then the file will be searched for
9099 on the path. The default is <see langword="false" />.
9100 </summary>
9101 </member>
9102 <member name="P:NAnt.Core.Types.FileSet.Include.Pattern">
9103 <summary>
9104 The pattern or file name to include.
9105 </summary>
9106 </member>
9107 <member name="P:NAnt.Core.Types.FileSet.Include.IfDefined">
9108 <summary>
9109 If <see langword="true" /> then the pattern will be included;
9110 otherwise, skipped. The default is <see langword="true" />.
9111 </summary>
9112 </member>
9113 <member name="P:NAnt.Core.Types.FileSet.Include.UnlessDefined">
9114 <summary>
9115 Opposite of <see cref="P:NAnt.Core.Types.FileSet.Include.IfDefined"/>. If <see langword="false"/>
9116 then the pattern will be included; otherwise, skipped. The default
9117 is <see langword="false"/>.
9118 </summary>
9119 </member>
9120 <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.Patterns">
9121 <summary>
9122 Gets the list of patterns in <see cref="P:NAnt.Core.Types.FileSet.ExcludesFile.PatternFile"/>.
9123 </summary>
9124 </member>
9125 <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.IfDefined">
9126 <summary>
9127 If <see langword="true" /> then the patterns will be excluded;
9128 otherwise, skipped. The default is <see langword="true" />.
9129 </summary>
9130 </member>
9131 <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.UnlessDefined">
9132 <summary>
9133 Opposite of <see cref="P:NAnt.Core.Types.FileSet.ExcludesFile.IfDefined"/>. If <see langword="false"/>
9134 then the patterns will be excluded; otherwise, skipped. The default
9135 is <see langword="false"/>.
9136 </summary>
9137 </member>
9138 <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.PatternFile">
9139 <summary>
9140 The name of a file; each line of this file is taken to be a
9141 pattern.
9142 </summary>
9143 </member>
9144 <member name="P:NAnt.Core.Types.FileSet.IncludesFile.AsIs">
9145 <summary>
9146 If <see langword="true"/> then the patterns in the include file
9147 will be added to the <see cref="T:NAnt.Core.Types.FileSet"/> without pattern
9148 matching or checking if the file exists. The default is
9149 <see langword="false"/>.
9150 </summary>
9151 </member>
9152 <member name="P:NAnt.Core.Types.FileSet.IncludesFile.FromPath">
9153 <summary>
9154 If <see langword="true" /> then the patterns in the include file
9155 will be searched for on the path. The default is <see langword="false" />.
9156 </summary>
9157 </member>
9158 <member name="P:NAnt.Core.Types.FileSet.IncludesFile.IfDefined">
9159 <summary>
9160 If <see langword="true" /> then the patterns will be included;
9161 otherwise, skipped. The default is <see langword="true" />.
9162 </summary>
9163 </member>
9164 <member name="P:NAnt.Core.Types.FileSet.IncludesFile.UnlessDefined">
9165 <summary>
9166 Opposite of <see cref="P:NAnt.Core.Types.FileSet.IncludesFile.IfDefined"/>. If <see langword="false"/>
9167 then the patterns will be included; otherwise, skipped. The default
9168 is <see langword="false"/>.
9169 </summary>
9170 </member>
9171 <member name="M:NAnt.Core.Types.DirSet.#ctor">
9172 <summary>
9173 Initializes a new instance of the <see cref="T:NAnt.Core.Types.DirSet"/> class.
9174 </summary>
9175 </member>
9176 <member name="M:NAnt.Core.Types.DirSet.#ctor(NAnt.Core.Types.FileSet)">
9177 <summary>
9178 Copy constructor for <see cref="T:NAnt.Core.Types.FileSet"/>. Required in order to
9179 assign references of <see cref="T:NAnt.Core.Types.FileSet"/> type where
9180 <see cref="T:NAnt.Core.Types.DirSet"/> is used.
9181 </summary>
9182 <param name="fs">A <see cref="T:NAnt.Core.Types.FileSet"/> instance to create a <see cref="T:NAnt.Core.Types.DirSet"/> from.</param>
9183 </member>
9184 <member name="T:NAnt.Core.Types.EnvironmentVariable">
9185 <summary>
9186 Represents an environment variable.
9187 </summary>
9188 </member>
9189 <member name="M:NAnt.Core.Types.EnvironmentVariable.#ctor(System.String,System.String)">
9190 <summary>
9191 Initializes a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instance with the
9192 specified name and value.
9193 </summary>
9194 <param name="name">The name of the environment variable.</param>
9195 <param name="value">The value of the environment variable.</param>
9196 </member>
9197 <member name="M:NAnt.Core.Types.EnvironmentVariable.#ctor">
9198 <summary>
9199 Initializes a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instance.
9200 </summary>
9201 </member>
9202 <member name="P:NAnt.Core.Types.EnvironmentVariable.VariableName">
9203 <summary>
9204 The name of the environment variable.
9205 </summary>
9206 </member>
9207 <member name="P:NAnt.Core.Types.EnvironmentVariable.LiteralValue">
9208 <summary>
9209 The literal value for the environment variable.
9210 </summary>
9211 </member>
9212 <member name="P:NAnt.Core.Types.EnvironmentVariable.File">
9213 <summary>
9214 The value for a file-based environment variable. NAnt will convert
9215 it to an absolute filename.
9216 </summary>
9217 </member>
9218 <member name="P:NAnt.Core.Types.EnvironmentVariable.Directory">
9219 <summary>
9220 The value for a directory-based environment variable. NAnt will
9221 convert it to an absolute path.
9222 </summary>
9223 </member>
9224 <member name="P:NAnt.Core.Types.EnvironmentVariable.Path">
9225 <summary>
9226 The value for a PATH like environment variable. You can use
9227 <c>:</c> or <c>;</c> as path separators and NAnt will convert it to
9228 the platform's local conventions.
9229 </summary>
9230 </member>
9231 <member name="P:NAnt.Core.Types.EnvironmentVariable.PathSet">
9232 <summary>
9233 Sets a single environment variable and treats it like a PATH -
9234 ensures the right separator for the local platform is used.
9235 </summary>
9236 </member>
9237 <member name="P:NAnt.Core.Types.EnvironmentVariable.Value">
9238 <summary>
9239 Gets the value of the environment variable.
9240 </summary>
9241 </member>
9242 <member name="P:NAnt.Core.Types.EnvironmentVariable.IfDefined">
9243 <summary>
9244 Indicates if the environment variable should be passed to the
9245 external program. If <see langword="true" /> then the environment
9246 variable will be passed; otherwise, skipped. The default is
9247 <see langword="true" />.
9248 </summary>
9249 </member>
9250 <member name="P:NAnt.Core.Types.EnvironmentVariable.UnlessDefined">
9251 <summary>
9252 Indicates if the environment variable should not be passed to the
9253 external program. If <see langword="false" /> then the environment
9254 variable will be passed; otherwise, skipped. The default is
9255 <see langword="false" />.
9256 </summary>
9257 </member>
9258 <member name="T:NAnt.Core.Types.EnvironmentSet">
9259 <summary>
9260 A set of environment variables.
9261 </summary>
9262 </member>
9263 <member name="P:NAnt.Core.Types.EnvironmentSet.Options">
9264 <summary>
9265 Environment variable to pass to a program.
9266 </summary>
9267 </member>
9268 <member name="P:NAnt.Core.Types.EnvironmentSet.EnvironmentVariables">
9269 <summary>
9270 Environment variable to pass to a program.
9271 </summary>
9272 </member>
9273 <member name="T:NAnt.Core.Types.EnvironmentVariableCollection">
9274 <summary>
9275 Contains a collection of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements.
9276 </summary>
9277 </member>
9278 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor">
9279 <summary>
9280 Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class.
9281 </summary>
9282 </member>
9283 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor(NAnt.Core.Types.EnvironmentVariableCollection)">
9284 <summary>
9285 Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class
9286 with the specified <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> instance.
9287 </summary>
9288 </member>
9289 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor(NAnt.Core.Types.EnvironmentVariable[])">
9290 <summary>
9291 Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class
9292 with the specified array of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instances.
9293 </summary>
9294 </member>
9295 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Add(NAnt.Core.Types.EnvironmentVariable)">
9296 <summary>
9297 Adds a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to the end of the collection.
9298 </summary>
9299 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to be added to the end of the collection.</param>
9300 <returns>The position into which the new element was inserted.</returns>
9301 </member>
9302 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.AddRange(NAnt.Core.Types.EnvironmentVariable[])">
9303 <summary>
9304 Adds the elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> array to the end of the collection.
9305 </summary>
9306 <param name="items">The array of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements to be added to the end of the collection.</param>
9307 </member>
9308 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.AddRange(NAnt.Core.Types.EnvironmentVariableCollection)">
9309 <summary>
9310 Adds the elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> to the end of the collection.
9311 </summary>
9312 <param name="items">The <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> to be added to the end of the collection.</param>
9313 </member>
9314 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Contains(NAnt.Core.Types.EnvironmentVariable)">
9315 <summary>
9316 Determines whether a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> is in the collection.
9317 </summary>
9318 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to locate in the collection.</param>
9319 <returns>
9320 <see langword="true"/> if <paramref name="item"/> is found in the
9321 collection; otherwise, <see langword="false"/>.
9322 </returns>
9323 </member>
9324 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Contains(System.String)">
9325 <summary>
9326 Determines whether a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with the specified
9327 value is in the collection.
9328 </summary>
9329 <param name="value">The argument value to locate in the collection.</param>
9330 <returns>
9331 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with value
9332 <paramref name="value"/> is found in the collection; otherwise,
9333 <see langword="false"/>.
9334 </returns>
9335 </member>
9336 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.CopyTo(NAnt.Core.Types.EnvironmentVariable[],System.Int32)">
9337 <summary>
9338 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
9339 </summary>
9340 <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>
9341 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
9342 </member>
9343 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.IndexOf(NAnt.Core.Types.EnvironmentVariable)">
9344 <summary>
9345 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> object in the collection.
9346 </summary>
9347 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> object for which the index is returned.</param>
9348 <returns>
9349 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.
9350 </returns>
9351 </member>
9352 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Insert(System.Int32,NAnt.Core.Types.EnvironmentVariable)">
9353 <summary>
9354 Inserts a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> into the collection at the specified index.
9355 </summary>
9356 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
9357 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to insert.</param>
9358 </member>
9359 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.GetEnumerator">
9360 <summary>
9361 Returns an enumerator that can iterate through the collection.
9362 </summary>
9363 <returns>
9364 A <see cref="T:NAnt.Core.Types.EnvironmentVariableEnumerator"/> for the entire collection.
9365 </returns>
9366 </member>
9367 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Remove(NAnt.Core.Types.EnvironmentVariable)">
9368 <summary>
9369 Removes a member from the collection.
9370 </summary>
9371 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to remove from the collection.</param>
9372 </member>
9373 <member name="P:NAnt.Core.Types.EnvironmentVariableCollection.Item(System.Int32)">
9374 <summary>
9375 Gets or sets the element at the specified index.
9376 </summary>
9377 <param name="index">The zero-based index of the element to get or set.</param>
9378 </member>
9379 <member name="P:NAnt.Core.Types.EnvironmentVariableCollection.Item(System.String)">
9380 <summary>
9381 Gets the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with the specified name.
9382 </summary>
9383 <param name="name">The name of the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to get.</param>
9384 </member>
9385 <member name="T:NAnt.Core.Types.EnvironmentVariableEnumerator">
9386 <summary>
9387 Enumerates the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/>.
9388 </summary>
9389 </member>
9390 <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.#ctor(NAnt.Core.Types.EnvironmentVariableCollection)">
9391 <summary>
9392 Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableEnumerator"/> class
9393 with the specified <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/>.
9394 </summary>
9395 <param name="arguments">The collection that should be enumerated.</param>
9396 </member>
9397 <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.MoveNext">
9398 <summary>
9399 Advances the enumerator to the next element of the collection.
9400 </summary>
9401 <returns>
9402 <see langword="true" /> if the enumerator was successfully advanced
9403 to the next element; <see langword="false" /> if the enumerator has
9404 passed the end of the collection.
9405 </returns>
9406 </member>
9407 <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.Reset">
9408 <summary>
9409 Sets the enumerator to its initial position, which is before the
9410 first element in the collection.
9411 </summary>
9412 </member>
9413 <member name="P:NAnt.Core.Types.EnvironmentVariableEnumerator.Current">
9414 <summary>
9415 Gets the current element in the collection.
9416 </summary>
9417 <returns>
9418 The current element in the collection.
9419 </returns>
9420 </member>
9421 <member name="P:NAnt.Core.Types.Formatter.Property">
9422 <summary>
9423 The name of the NAnt property to set.
9424 </summary>
9425 </member>
9426 <member name="P:NAnt.Core.Types.Formatter.Pattern">
9427 <summary>
9428 The string pattern to use to format the property.
9429 </summary>
9430 </member>
9431 <member name="P:NAnt.Core.Types.Formatter.IfDefined">
9432 <summary>
9433 Indicates if the formatter should be used to format the timestamp.
9434 If <see langword="true" /> then the formatter will be used;
9435 otherwise, skipped. The default is <see langword="true" />.
9436 </summary>
9437 </member>
9438 <member name="P:NAnt.Core.Types.Formatter.UnlessDefined">
9439 <summary>
9440 Indicates if the formatter should be not used to format the
9441 timestamp. If <see langword="false" /> then the formatter will be
9442 used; otherwise, skipped. The default is <see langword="false" />.
9443 </summary>
9444 </member>
9445 <member name="T:NAnt.Core.Types.FormatterCollection">
9446 <summary>
9447 Contains a collection of <see cref="T:NAnt.Core.Types.Formatter"/> elements.
9448 </summary>
9449 </member>
9450 <member name="M:NAnt.Core.Types.FormatterCollection.#ctor">
9451 <summary>
9452 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class.
9453 </summary>
9454 </member>
9455 <member name="M:NAnt.Core.Types.FormatterCollection.#ctor(NAnt.Core.Types.FormatterCollection)">
9456 <summary>
9457 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class
9458 with the specified <see cref="T:NAnt.Core.Types.FormatterCollection"/> instance.
9459 </summary>
9460 </member>
9461 <member name="M:NAnt.Core.Types.FormatterCollection.#ctor(NAnt.Core.Types.Formatter[])">
9462 <summary>
9463 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class
9464 with the specified array of <see cref="T:NAnt.Core.Types.Formatter"/> instances.
9465 </summary>
9466 </member>
9467 <member name="M:NAnt.Core.Types.FormatterCollection.Add(NAnt.Core.Types.Formatter)">
9468 <summary>
9469 Adds a <see cref="T:NAnt.Core.Types.Formatter"/> to the end of the collection.
9470 </summary>
9471 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to be added to the end of the collection.</param>
9472 <returns>The position into which the new element was inserted.</returns>
9473 </member>
9474 <member name="M:NAnt.Core.Types.FormatterCollection.AddRange(NAnt.Core.Types.Formatter[])">
9475 <summary>
9476 Adds the elements of a <see cref="T:NAnt.Core.Types.Formatter"/> array to the end of the collection.
9477 </summary>
9478 <param name="items">The array of <see cref="T:NAnt.Core.Types.Formatter"/> elements to be added to the end of the collection.</param>
9479 </member>
9480 <member name="M:NAnt.Core.Types.FormatterCollection.AddRange(NAnt.Core.Types.FormatterCollection)">
9481 <summary>
9482 Adds the elements of a <see cref="T:NAnt.Core.Types.FormatterCollection"/> to the end of the collection.
9483 </summary>
9484 <param name="items">The <see cref="T:NAnt.Core.Types.FormatterCollection"/> to be added to the end of the collection.</param>
9485 </member>
9486 <member name="M:NAnt.Core.Types.FormatterCollection.Contains(NAnt.Core.Types.Formatter)">
9487 <summary>
9488 Determines whether a <see cref="T:NAnt.Core.Types.Formatter"/> is in the collection.
9489 </summary>
9490 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to locate in the collection.</param>
9491 <returns>
9492 <see langword="true"/> if <paramref name="item"/> is found in the
9493 collection; otherwise, <see langword="false"/>.
9494 </returns>
9495 </member>
9496 <member name="M:NAnt.Core.Types.FormatterCollection.CopyTo(NAnt.Core.Types.Formatter[],System.Int32)">
9497 <summary>
9498 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
9499 </summary>
9500 <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>
9501 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
9502 </member>
9503 <member name="M:NAnt.Core.Types.FormatterCollection.IndexOf(NAnt.Core.Types.Formatter)">
9504 <summary>
9505 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Formatter"/> object in the collection.
9506 </summary>
9507 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> object for which the index is returned.</param>
9508 <returns>
9509 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.
9510 </returns>
9511 </member>
9512 <member name="M:NAnt.Core.Types.FormatterCollection.Insert(System.Int32,NAnt.Core.Types.Formatter)">
9513 <summary>
9514 Inserts a <see cref="T:NAnt.Core.Types.Formatter"/> into the collection at the specified index.
9515 </summary>
9516 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
9517 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to insert.</param>
9518 </member>
9519 <member name="M:NAnt.Core.Types.FormatterCollection.GetEnumerator">
9520 <summary>
9521 Returns an enumerator that can iterate through the collection.
9522 </summary>
9523 <returns>
9524 A <see cref="T:NAnt.Core.Types.FormatterEnumerator"/> for the entire collection.
9525 </returns>
9526 </member>
9527 <member name="M:NAnt.Core.Types.FormatterCollection.Remove(NAnt.Core.Types.Formatter)">
9528 <summary>
9529 Removes a member from the collection.
9530 </summary>
9531 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to remove from the collection.</param>
9532 </member>
9533 <member name="P:NAnt.Core.Types.FormatterCollection.Item(System.Int32)">
9534 <summary>
9535 Gets or sets the element at the specified index.
9536 </summary>
9537 <param name="index">The zero-based index of the element to get or set.</param>
9538 </member>
9539 <member name="T:NAnt.Core.Types.FormatterEnumerator">
9540 <summary>
9541 Enumerates the <see cref="T:NAnt.Core.Types.Formatter"/> elements of a <see cref="T:NAnt.Core.Types.FormatterCollection"/>.
9542 </summary>
9543 </member>
9544 <member name="M:NAnt.Core.Types.FormatterEnumerator.#ctor(NAnt.Core.Types.FormatterCollection)">
9545 <summary>
9546 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterEnumerator"/> class
9547 with the specified <see cref="T:NAnt.Core.Types.FormatterCollection"/>.
9548 </summary>
9549 <param name="arguments">The collection that should be enumerated.</param>
9550 </member>
9551 <member name="M:NAnt.Core.Types.FormatterEnumerator.MoveNext">
9552 <summary>
9553 Advances the enumerator to the next element of the collection.
9554 </summary>
9555 <returns>
9556 <see langword="true" /> if the enumerator was successfully advanced
9557 to the next element; <see langword="false" /> if the enumerator has
9558 passed the end of the collection.
9559 </returns>
9560 </member>
9561 <member name="M:NAnt.Core.Types.FormatterEnumerator.Reset">
9562 <summary>
9563 Sets the enumerator to its initial position, which is before the
9564 first element in the collection.
9565 </summary>
9566 </member>
9567 <member name="P:NAnt.Core.Types.FormatterEnumerator.Current">
9568 <summary>
9569 Gets the current element in the collection.
9570 </summary>
9571 <returns>
9572 The current element in the collection.
9573 </returns>
9574 </member>
9575 <member name="T:NAnt.Core.Types.ManagedExecution">
9576 <summary>
9577 Specifies the execution mode for managed applications.
9578 </summary>
9579 <remarks>
9580 <para>
9581 For backward compatibility, the following string values can also be
9582 used in build files:
9583 </para>
9584 <list type="table">
9585 <listheader>
9586 <term>Value</term>
9587 <description>Corresponding field</description>
9588 </listheader>
9589 <item>
9590 <term>"true"</term>
9591 <description><see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/></description>
9592 </item>
9593 <item>
9594 <term>"false"</term>
9595 <description><see cref="F:NAnt.Core.Types.ManagedExecution.Default"/></description>
9596 </item>
9597 </list>
9598 <para>
9599 Even if set to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>, the operating system can still
9600 run the program as a managed application.
9601 </para>
9602 <para>On Linux this can be done through <b>binfmt_misc</b>, while on
9603 Windows installing the .NET Framework redistributable caused managed
9604 applications to run on the MS CLR by default.
9605 </para>
9606 </remarks>
9607 </member>
9608 <member name="F:NAnt.Core.Types.ManagedExecution.Default">
9609 <summary>
9610 Do not threat the program as a managed application.
9611 </summary>
9612 </member>
9613 <member name="F:NAnt.Core.Types.ManagedExecution.Auto">
9614 <summary>
9615 Leave it up to the CLR to determine which specific version of
9616 the CLR will be used to run the application.
9617 </summary>
9618 </member>
9619 <member name="F:NAnt.Core.Types.ManagedExecution.Strict">
9620 <summary>
9621 Forces an application to run against the currently targeted
9622 version of a given CLR.
9623 </summary>
9624 </member>
9625 <member name="T:NAnt.Core.Types.ManagedExecutionConverter">
9626 <summary>
9627 Specialized <see cref="T:System.ComponentModel.EnumConverter"/> that also supports
9628 case-insensitive conversion of "true" to
9629 <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/> and "false" to
9630 <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>.
9631 </summary>
9632 </member>
9633 <member name="M:NAnt.Core.Types.ManagedExecutionConverter.#ctor">
9634 <summary>
9635 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ManagedExecutionConverter"/>
9636 class.
9637 </summary>
9638 </member>
9639 <member name="M:NAnt.Core.Types.ManagedExecutionConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
9640 <summary>
9641 Converts the given object to the type of this converter, using the
9642 specified context and culture information.
9643 </summary>
9644 <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
9645 <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
9646 <param name="value">The <see cref="T:System.Object"/> to convert.</param>
9647 <returns>
9648 An <see cref="T:System.Object"/> that represents the converted value.
9649 </returns>
9650 </member>
9651 <member name="T:NAnt.Core.Types.Option">
9652 <summary>
9653 Represents an option.
9654 </summary>
9655 </member>
9656 <member name="M:NAnt.Core.Types.Option.#ctor(System.String,System.String)">
9657 <summary>
9658 name, value constructor
9659 </summary>
9660 <param name="name"></param>
9661 <param name="value"></param>
9662 </member>
9663 <member name="M:NAnt.Core.Types.Option.#ctor">
9664 <summary>
9665 Default constructor
9666 </summary>
9667 </member>
9668 <member name="P:NAnt.Core.Types.Option.OptionName">
9669 <summary>
9670 Name of the option.
9671 </summary>
9672 </member>
9673 <member name="P:NAnt.Core.Types.Option.Value">
9674 <summary>
9675 Value of the option. The default is <see langword="null" />.
9676 </summary>
9677 </member>
9678 <member name="P:NAnt.Core.Types.Option.IfDefined">
9679 <summary>
9680 Indicates if the option should be passed to the task.
9681 If <see langword="true" /> then the option will be passed;
9682 otherwise, skipped. The default is <see langword="true" />.
9683 </summary>
9684 </member>
9685 <member name="P:NAnt.Core.Types.Option.UnlessDefined">
9686 <summary>
9687 Indicates if the option should not be passed to the task.
9688 If <see langword="false" /> then the option will be passed;
9689 otherwise, skipped. The default is <see langword="false" />.
9690 </summary>
9691 </member>
9692 <member name="T:NAnt.Core.Types.OptionCollection">
9693 <summary>
9694 Contains a collection of <see cref="T:NAnt.Core.Types.Option"/> elements.
9695 </summary>
9696 </member>
9697 <member name="M:NAnt.Core.Types.OptionCollection.#ctor">
9698 <summary>
9699 Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class.
9700 </summary>
9701 </member>
9702 <member name="M:NAnt.Core.Types.OptionCollection.#ctor(NAnt.Core.Types.OptionCollection)">
9703 <summary>
9704 Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class
9705 with the specified <see cref="T:NAnt.Core.Types.OptionCollection"/> instance.
9706 </summary>
9707 </member>
9708 <member name="M:NAnt.Core.Types.OptionCollection.#ctor(NAnt.Core.Types.Option[])">
9709 <summary>
9710 Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class
9711 with the specified array of <see cref="T:NAnt.Core.Types.Option"/> instances.
9712 </summary>
9713 </member>
9714 <member name="M:NAnt.Core.Types.OptionCollection.Add(NAnt.Core.Types.Option)">
9715 <summary>
9716 Adds a <see cref="T:NAnt.Core.Types.Option"/> to the end of the collection.
9717 </summary>
9718 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to be added to the end of the collection.</param>
9719 <returns>The position into which the new element was inserted.</returns>
9720 </member>
9721 <member name="M:NAnt.Core.Types.OptionCollection.AddRange(NAnt.Core.Types.Option[])">
9722 <summary>
9723 Adds the elements of a <see cref="T:NAnt.Core.Types.Option"/> array to the end of the collection.
9724 </summary>
9725 <param name="items">The array of <see cref="T:NAnt.Core.Types.Option"/> elements to be added to the end of the collection.</param>
9726 </member>
9727 <member name="M:NAnt.Core.Types.OptionCollection.AddRange(NAnt.Core.Types.OptionCollection)">
9728 <summary>
9729 Adds the elements of a <see cref="T:NAnt.Core.Types.OptionCollection"/> to the end of the collection.
9730 </summary>
9731 <param name="items">The <see cref="T:NAnt.Core.Types.OptionCollection"/> to be added to the end of the collection.</param>
9732 </member>
9733 <member name="M:NAnt.Core.Types.OptionCollection.Contains(NAnt.Core.Types.Option)">
9734 <summary>
9735 Determines whether a <see cref="T:NAnt.Core.Types.Option"/> is in the collection.
9736 </summary>
9737 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to locate in the collection.</param>
9738 <returns>
9739 <see langword="true"/> if <paramref name="item"/> is found in the
9740 collection; otherwise, <see langword="false"/>.
9741 </returns>
9742 </member>
9743 <member name="M:NAnt.Core.Types.OptionCollection.Contains(System.String)">
9744 <summary>
9745 Determines whether a <see cref="T:NAnt.Core.Types.Option"/> for the specified
9746 task is in the collection.
9747 </summary>
9748 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Types.Option"/> should be located in the collection.</param>
9749 <returns>
9750 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.Option"/> for the specified
9751 task is found in the collection; otherwise, <see langword="false"/>.
9752 </returns>
9753 </member>
9754 <member name="M:NAnt.Core.Types.OptionCollection.CopyTo(NAnt.Core.Types.Option[],System.Int32)">
9755 <summary>
9756 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
9757 </summary>
9758 <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>
9759 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
9760 </member>
9761 <member name="M:NAnt.Core.Types.OptionCollection.IndexOf(NAnt.Core.Types.Option)">
9762 <summary>
9763 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Option"/> object in the collection.
9764 </summary>
9765 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> object for which the index is returned.</param>
9766 <returns>
9767 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.
9768 </returns>
9769 </member>
9770 <member name="M:NAnt.Core.Types.OptionCollection.Insert(System.Int32,NAnt.Core.Types.Option)">
9771 <summary>
9772 Inserts a <see cref="T:NAnt.Core.Types.Option"/> into the collection at the specified index.
9773 </summary>
9774 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
9775 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to insert.</param>
9776 </member>
9777 <member name="M:NAnt.Core.Types.OptionCollection.GetEnumerator">
9778 <summary>
9779 Returns an enumerator that can iterate through the collection.
9780 </summary>
9781 <returns>
9782 A <see cref="T:NAnt.Core.Types.OptionEnumerator"/> for the entire collection.
9783 </returns>
9784 </member>
9785 <member name="M:NAnt.Core.Types.OptionCollection.Remove(NAnt.Core.Types.Option)">
9786 <summary>
9787 Removes a member from the collection.
9788 </summary>
9789 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to remove from the collection.</param>
9790 </member>
9791 <member name="P:NAnt.Core.Types.OptionCollection.Item(System.Int32)">
9792 <summary>
9793 Gets or sets the element at the specified index.
9794 </summary>
9795 <param name="index">The zero-based index of the element to get or set.</param>
9796 </member>
9797 <member name="P:NAnt.Core.Types.OptionCollection.Item(System.String)">
9798 <summary>
9799 Gets the <see cref="T:NAnt.Core.Types.Option"/> with the specified name.
9800 </summary>
9801 <param name="name">The name of the option that should be located in the collection.</param>
9802 </member>
9803 <member name="T:NAnt.Core.Types.OptionEnumerator">
9804 <summary>
9805 Enumerates the <see cref="T:NAnt.Core.Types.Option"/> elements of a <see cref="T:NAnt.Core.Types.OptionCollection"/>.
9806 </summary>
9807 </member>
9808 <member name="M:NAnt.Core.Types.OptionEnumerator.#ctor(NAnt.Core.Types.OptionCollection)">
9809 <summary>
9810 Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionEnumerator"/> class
9811 with the specified <see cref="T:NAnt.Core.Types.OptionCollection"/>.
9812 </summary>
9813 <param name="arguments">The collection that should be enumerated.</param>
9814 </member>
9815 <member name="M:NAnt.Core.Types.OptionEnumerator.MoveNext">
9816 <summary>
9817 Advances the enumerator to the next element of the collection.
9818 </summary>
9819 <returns>
9820 <see langword="true" /> if the enumerator was successfully advanced
9821 to the next element; <see langword="false" /> if the enumerator has
9822 passed the end of the collection.
9823 </returns>
9824 </member>
9825 <member name="M:NAnt.Core.Types.OptionEnumerator.Reset">
9826 <summary>
9827 Sets the enumerator to its initial position, which is before the
9828 first element in the collection.
9829 </summary>
9830 </member>
9831 <member name="P:NAnt.Core.Types.OptionEnumerator.Current">
9832 <summary>
9833 Gets the current element in the collection.
9834 </summary>
9835 <returns>
9836 The current element in the collection.
9837 </returns>
9838 </member>
9839 <member name="T:NAnt.Core.Types.PathElement">
9840 <summary>
9841 Represents a nested path element.
9842 </summary>
9843 </member>
9844 <member name="P:NAnt.Core.Types.PathElement.File">
9845 <summary>
9846 The name of a file to add to the path. Will be replaced with
9847 the absolute path of the file.
9848 </summary>
9849 </member>
9850 <member name="P:NAnt.Core.Types.PathElement.Directory">
9851 <summary>
9852 The name of a directory to add to the path. Will be replaced with
9853 the absolute path of the directory.
9854 </summary>
9855 </member>
9856 <member name="P:NAnt.Core.Types.PathElement.Path">
9857 <summary>
9858 A string that will be treated as a path-like string. You can use
9859 <c>:</c> or <c>;</c> as path separators and NAnt will convert it
9860 to the platform's local conventions, while resolving references
9861 to environment variables.
9862 </summary>
9863 </member>
9864 <member name="P:NAnt.Core.Types.PathElement.IfDefined">
9865 <summary>
9866 If <see langword="true" /> then the entry will be added to the
9867 path; otherwise, skipped. The default is <see langword="true" />.
9868 </summary>
9869 </member>
9870 <member name="P:NAnt.Core.Types.PathElement.UnlessDefined">
9871 <summary>
9872 Opposite of <see cref="P:NAnt.Core.Types.PathElement.IfDefined"/>. If <see langword="false"/>
9873 then the entry will be added to the path; otherwise, skipped.
9874 The default is <see langword="false"/>.
9875 </summary>
9876 </member>
9877 <member name="P:NAnt.Core.Types.PathElement.Parts">
9878 <summary>
9879 Gets the parts of a path represented by this element.
9880 </summary>
9881 <value>
9882 A <see cref="T:System.Collections.Specialized.StringCollection"/> containing the parts of a path
9883 represented by this element.
9884 </value>
9885 </member>
9886 <member name="T:NAnt.Core.Types.PathSet">
9887 <summary>
9888 <para>
9889 Paths are groups of files and/or directories that need to be passed as a single
9890 unit. The order in which parts of the path are specified in the build file is
9891 retained, and duplicate parts are automatically suppressed.
9892 </para>
9893 </summary>
9894 <example>
9895 <para>
9896 Define a global <c><path></c> that can be referenced by other
9897 tasks or types.
9898 </para>
9899 <code>
9900 <![CDATA[
9901 <path id="includes-path">
9902 <pathelement path="%INCLUDE%" />
9903 <pathelement dir="${build.dir}/include" />
9904 </path>
9905 ]]>
9906 </code>
9907 </example>
9908 </member>
9909 <member name="M:NAnt.Core.Types.PathSet.#ctor">
9910 <summary>
9911 Initializes a new instance of the <see cref="T:NAnt.Core.Types.PathSet"/> class.
9912 </summary>
9913 </member>
9914 <member name="M:NAnt.Core.Types.PathSet.#ctor(NAnt.Core.Project,System.String)">
9915 <summary>
9916 Invoked by <see cref="T:NAnt.Core.Element.AttributeConfigurator"/> for build
9917 attributes with an underlying <see cref="T:NAnt.Core.Types.PathSet"/> type.
9918 </summary>
9919 <param name="project">The <see cref="T:NAnt.Core.Project"/> to be used to resolve relative paths.</param>
9920 <param name="path">The string representing a path.</param>
9921 </member>
9922 <member name="M:NAnt.Core.Types.PathSet.ToString">
9923 <summary>
9924 Returns a textual representation of the path, which can be used as
9925 PATH environment variable definition.
9926 </summary>
9927 <returns>
9928 A textual representation of the path.
9929 </returns>
9930 </member>
9931 <member name="M:NAnt.Core.Types.PathSet.AddPath(NAnt.Core.Types.PathSet)">
9932 <summary>
9933 Defines a set of path elements to add to the current path.
9934 </summary>
9935 <param name="path">The <see cref="T:NAnt.Core.Types.PathSet"/> to add.</param>
9936 </member>
9937 <member name="M:NAnt.Core.Types.PathSet.AddPathElement(NAnt.Core.Types.PathElement)">
9938 <summary>
9939 Defines a path element to add to the current path.
9940 </summary>
9941 <param name="pathElement">The <see cref="T:NAnt.Core.Types.PathElement"/> to add.</param>
9942 </member>
9943 <member name="M:NAnt.Core.Types.PathSet.GetElements">
9944 <summary>
9945 Returns all path elements defined by this path object.
9946 </summary>
9947 <returns>
9948 A list of path elements.
9949 </returns>
9950 </member>
9951 <member name="M:NAnt.Core.Types.PathSet.TranslatePath(NAnt.Core.Project,System.String)">
9952 <summary>
9953 Splits a PATH (with ; or : as separators) into its parts, while
9954 resolving references to environment variables.
9955 </summary>
9956 <param name="project">The <see cref="T:NAnt.Core.Project"/> to be used to resolve relative paths.</param>
9957 <param name="source">The path to translate.</param>
9958 <returns>
9959 A PATH split up its parts, with references to environment variables
9960 resolved and duplicate entries removed.
9961 </returns>
9962 </member>
9963 <member name="M:NAnt.Core.Types.Pattern.#ctor">
9964 <summary>
9965 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Pattern"/> class.
9966 </summary>
9967 </member>
9968 <member name="P:NAnt.Core.Types.Pattern.PatternName">
9969 <summary>
9970 The name pattern to include/exclude.
9971 </summary>
9972 </member>
9973 <member name="P:NAnt.Core.Types.Pattern.IfDefined">
9974 <summary>
9975 If <see langword="true" /> then the pattern will be used;
9976 otherwise, skipped. The default is <see langword="true" />.
9977 </summary>
9978 </member>
9979 <member name="P:NAnt.Core.Types.Pattern.UnlessDefined">
9980 <summary>
9981 If <see langword="false" /> then the pattern will be used;
9982 otherwise, skipped. The default is <see langword="false" />.
9983 </summary>
9984 </member>
9985 <member name="T:NAnt.Core.Types.PatternCollection">
9986 <summary>
9987 Contains a collection of <see cref="T:NAnt.Core.Types.Pattern"/> elements.
9988 </summary>
9989 </member>
9990 <member name="M:NAnt.Core.Types.PatternCollection.#ctor">
9991 <summary>
9992 Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternCollection"/> class.
9993 </summary>
9994 </member>
9995 <member name="M:NAnt.Core.Types.PatternCollection.Clear">
9996 <summary>
9997 Removes all items from the <see cref="T:NAnt.Core.Types.PatternCollection"/>.
9998 </summary>
9999 </member>
10000 <member name="M:NAnt.Core.Types.PatternCollection.Add(NAnt.Core.Types.Pattern)">
10001 <summary>
10002 Adds a <see cref="T:NAnt.Core.Types.Pattern"/> to the end of the collection.
10003 </summary>
10004 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to be added to the end of the collection.</param>
10005 <returns>The position into which the new element was inserted.</returns>
10006 </member>
10007 <member name="M:NAnt.Core.Types.PatternCollection.AddRange(NAnt.Core.Types.Pattern[])">
10008 <summary>
10009 Adds the elements of a <see cref="T:NAnt.Core.Types.Pattern"/> array to the end of the collection.
10010 </summary>
10011 <param name="items">The array of <see cref="T:NAnt.Core.Types.Pattern"/> elements to be added to the end of the collection.</param>
10012 </member>
10013 <member name="M:NAnt.Core.Types.PatternCollection.AddRange(NAnt.Core.Types.PatternCollection)">
10014 <summary>
10015 Adds the elements of a <see cref="T:NAnt.Core.Types.PatternCollection"/> to the end of the collection.
10016 </summary>
10017 <param name="items">The <see cref="T:NAnt.Core.Types.PatternCollection"/> to be added to the end of the collection.</param>
10018 </member>
10019 <member name="M:NAnt.Core.Types.PatternCollection.Contains(NAnt.Core.Types.Pattern)">
10020 <summary>
10021 Determines whether a <see cref="T:NAnt.Core.Types.Pattern"/> is in the collection.
10022 </summary>
10023 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to locate in the collection.</param>
10024 <returns>
10025 <see langword="true"/> if <paramref name="item"/> is found in the
10026 collection; otherwise, <see langword="false"/>.
10027 </returns>
10028 </member>
10029 <member name="M:NAnt.Core.Types.PatternCollection.CopyTo(NAnt.Core.Types.Pattern[],System.Int32)">
10030 <summary>
10031 Copies the entire collection to a compatible one-dimensional array,
10032 starting at the specified index of the target array.
10033 </summary>
10034 <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>
10035 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
10036 </member>
10037 <member name="M:NAnt.Core.Types.PatternCollection.IndexOf(NAnt.Core.Types.Pattern)">
10038 <summary>
10039 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Pattern"/> object in the collection.
10040 </summary>
10041 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> object for which the index is returned.</param>
10042 <returns>
10043 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.
10044 </returns>
10045 </member>
10046 <member name="M:NAnt.Core.Types.PatternCollection.Insert(System.Int32,NAnt.Core.Types.Pattern)">
10047 <summary>
10048 Inserts a <see cref="T:NAnt.Core.Types.Pattern"/> into the collection at the specified index.
10049 </summary>
10050 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
10051 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to insert.</param>
10052 </member>
10053 <member name="M:NAnt.Core.Types.PatternCollection.GetEnumerator">
10054 <summary>
10055 Returns an enumerator that can iterate through the collection.
10056 </summary>
10057 <returns>
10058 A <see cref="T:NAnt.Core.Types.PatternEnumerator"/> for the entire collection.
10059 </returns>
10060 </member>
10061 <member name="M:NAnt.Core.Types.PatternCollection.Remove(NAnt.Core.Types.Pattern)">
10062 <summary>
10063 Removes a member from the collection.
10064 </summary>
10065 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to remove from the collection.</param>
10066 </member>
10067 <member name="P:NAnt.Core.Types.PatternCollection.Item(System.Int32)">
10068 <summary>
10069 Gets or sets the element at the specified index.
10070 </summary>
10071 <param name="index">The zero-based index of the element to get or set.</param>
10072 </member>
10073 <member name="T:NAnt.Core.Types.PatternEnumerator">
10074 <summary>
10075 Enumerates the <see cref="T:NAnt.Core.Types.Pattern"/> elements of a <see cref="T:NAnt.Core.Types.PatternCollection"/>.
10076 </summary>
10077 </member>
10078 <member name="M:NAnt.Core.Types.PatternEnumerator.#ctor(NAnt.Core.Types.PatternCollection)">
10079 <summary>
10080 Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternEnumerator"/> class
10081 with the specified <see cref="T:NAnt.Core.Types.PatternCollection"/>.
10082 </summary>
10083 <param name="arguments">The collection that should be enumerated.</param>
10084 </member>
10085 <member name="M:NAnt.Core.Types.PatternEnumerator.MoveNext">
10086 <summary>
10087 Advances the enumerator to the next element of the collection.
10088 </summary>
10089 <returns>
10090 <see langword="true" /> if the enumerator was successfully advanced
10091 to the next element; <see langword="false" /> if the enumerator has
10092 passed the end of the collection.
10093 </returns>
10094 </member>
10095 <member name="M:NAnt.Core.Types.PatternEnumerator.Reset">
10096 <summary>
10097 Sets the enumerator to its initial position, which is before the
10098 first element in the collection.
10099 </summary>
10100 </member>
10101 <member name="P:NAnt.Core.Types.PatternEnumerator.Current">
10102 <summary>
10103 Gets the current element in the collection.
10104 </summary>
10105 <returns>
10106 The current element in the collection.
10107 </returns>
10108 </member>
10109 <member name="P:NAnt.Core.Types.PatternEnumerator.System#Collections#IEnumerator#Current">
10110 <summary>
10111 Gets the current element in the collection.
10112 </summary>
10113 <returns>
10114 The current element in the collection.
10115 </returns>
10116 </member>
10117 <member name="T:NAnt.Core.Types.PatternSet">
10118 <summary>
10119 A set of patterns, mostly used to include or exclude certain files.
10120 </summary>
10121 <remarks>
10122 <para>
10123 The individual patterns support <c>if</c> and <c>unless</c> attributes
10124 to specify that the element should only be used if or unless a given
10125 condition is met.
10126 </para>
10127 <para>
10128 The <see cref="P:NAnt.Core.Types.PatternSet.IncludesFile"/> and <see cref="P:NAnt.Core.Types.PatternSet.ExcludesFile"/>
10129 elements load patterns from a file. When the file is a relative path,
10130 it will be resolved relative to the project base directory in which
10131 the patternset is defined. Each line of this file is taken to be a
10132 pattern.
10133 </para>
10134 <para>
10135 The number sign (#) as the first non-blank character in a line denotes
10136 that all text following it is a comment:
10137 </para>
10138 <code>
10139 <![CDATA[
10140 EventLog.cs
10141 # requires Mono.Posix
10142 SysLogEventLogImpl.cs
10143 # uses the win32 eventlog API
10144 Win32EventLogImpl.cs
10145 ]]>
10146 </code>
10147 <para>
10148 Patterns can be grouped to sets, and later be referenced by their
10149 <see cref="P:NAnt.Core.DataTypeBase.ID"/>.
10150 </para>
10151 <para>
10152 When used as a standalone element (global type), any properties that
10153 are referenced will be resolved when the definition is processed, not
10154 when it actually used. Passing a reference to a nested build file
10155 will not cause the properties to be re-evaluated.
10156 </para>
10157 <para>
10158 To improve reuse of globally defined patternsets, avoid referencing
10159 any properties altogether.
10160 </para>
10161 </remarks>
10162 <example>
10163 <para>
10164 Define a set of patterns that matches all .cs files that do not contain
10165 the text <c>Test</c> in their name.
10166 </para>
10167 <code>
10168 <![CDATA[
10169 <patternset id="non.test.sources">
10170 <include name="**/*.cs" />
10171 <exclude name="**/*Test*" />
10172 </patternset>
10173 ]]>
10174 </code>
10175 </example>
10176 <example>
10177 <para>
10178 Define two sets. One holding C# sources, and one holding VB sources.
10179 Both sets only include test sources when the <c>test</c> property is
10180 set. A third set combines both C# and VB sources.
10181 </para>
10182 <code>
10183 <![CDATA[
10184 <patternset id="cs.sources">
10185 <include name="src/**/*.cs" />
10186 <include name="test/**/*.cs" if=${property::exist('test')}" />
10187 </patternset>
10188
10189 <patternset id="vb.sources">
10190 <include name="src/**/*.vb" />
10191 <include name="test/**/*.vb" if=${property::exist('test')}" />
10192 </patternset>
10193
10194 <patternset id="all.sources">
10195 <patternset refid="cs.sources" />
10196 <patternset refid="vb.sources" />
10197 </patternset>
10198 ]]>
10199 </code>
10200 </example>
10201 <example>
10202 <para>
10203 Define a set from patterns in a file.
10204 </para>
10205 <code>
10206 <![CDATA[
10207 <patternset id="sources">
10208 <includesfile name="test.sources" />
10209 <includesfile name="non.test.sources" />
10210 </patternset>
10211 ]]>
10212 </code>
10213 </example>
10214 <example>
10215 <para>
10216 Defines a patternset with patterns that are loaded from an external
10217 file, and shows the behavior when that patternset is passed as a
10218 reference to a nested build script.
10219 </para>
10220 <para>
10221 External file "c:\foo\build\service.lst" holding patterns
10222 of source files to include for the Foo.Service assembly:
10223 </para>
10224 <code>
10225 <![CDATA[
10226 AssemblyInfo.cs
10227 *Channel.cs
10228 ServiceFactory.cs]]></code>
10229 <para>
10230 Main build script located in "c:\foo\default.build":
10231 </para>
10232 <code>
10233 <![CDATA[
10234 <project name="main" default="build">
10235 <property name="build.debug" value="true" />
10236
10237 <patternset id="service.sources">
10238 <include name="TraceListener.cs" if="${build.debug}" />
10239 <includesfile name="build/service.lst" />
10240 </patternset>
10241
10242 <property name="build.debug" value="false" />
10243
10244 <target name="build">
10245 <nant buildfile="service/default.build" inheritrefs="true" />
10246 </target>
10247 </project>]]></code>
10248 <para>
10249 Nested build script located in "c:\foo\services\default.build"
10250 which uses the patternset to feed sources files to the C# compiler:
10251 </para>
10252 <code>
10253 <![CDATA[
10254 <project name="service" default="build">
10255 <target name="build">
10256 <csc output="../bin/Foo.Service.dll" target="library">
10257 <fileset basedir="src">
10258 <patternset refid="service.sources" />
10259 </fileset>
10260 </csc>
10261 </target>
10262 </project>]]></code>
10263 <para>
10264 At the time when the patternset is used in the "service"
10265 build script, the following source files in "c:\foo\services\src"
10266 match the defined patterns:
10267 </para>
10268 <code>
10269 <![CDATA[
10270 AssemblyInfo.cs
10271 MsmqChannel.cs
10272 SmtpChannel.cs
10273 ServiceFactory.cs
10274 TraceListener.cs]]></code>
10275 <para>
10276 You should have observed that:
10277 </para>
10278 <list type="bullet">
10279 <item>
10280 <description>
10281 although the patternset is used from the "service"
10282 build script, the path to the external file is resolved relative
10283 to the base directory of the "main" build script in
10284 which the patternset is defined.
10285 </description>
10286 </item>
10287 <item>
10288 <description>
10289 the "TraceListener.cs" file is included, even though
10290 the "build.debug" property was changed to <b>false</b>
10291 after the patternset was defined (but before it was passed to
10292 the nested build, and used).
10293 </description>
10294 </item>
10295 </list>
10296 </example>
10297 <seealso cref="T:NAnt.Core.Types.FileSet"/>
10298 </member>
10299 <member name="M:NAnt.Core.Types.PatternSet.#ctor">
10300 <summary>
10301 Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternSet"/> class.
10302 </summary>
10303 </member>
10304 <member name="M:NAnt.Core.Types.PatternSet.Append(NAnt.Core.Types.PatternSet)">
10305 <summary>
10306 Adds a nested set of patterns, or references other standalone
10307 patternset.
10308 </summary>
10309 <param name="patternSet">The <see cref="T:NAnt.Core.Types.PatternSet"/> to add.</param>
10310 </member>
10311 <member name="P:NAnt.Core.Types.PatternSet.Include">
10312 <summary>
10313 Defines a single pattern for files to include.
10314 </summary>
10315 </member>
10316 <member name="P:NAnt.Core.Types.PatternSet.IncludesFile">
10317 <summary>
10318 Loads multiple patterns of files to include from a given file, set
10319 using the <see cref="P:NAnt.Core.Types.Pattern.PatternName"/> parameter.
10320 </summary>
10321 </member>
10322 <member name="P:NAnt.Core.Types.PatternSet.Exclude">
10323 <summary>
10324 Defines a single pattern for files to exclude.
10325 </summary>
10326 </member>
10327 <member name="P:NAnt.Core.Types.PatternSet.ExcludesFile">
10328 <summary>
10329 Loads multiple patterns of files to exclude from a given file, set
10330 using the <see cref="P:NAnt.Core.Types.Pattern.PatternName"/> parameter.
10331 </summary>
10332 </member>
10333 <member name="T:NAnt.Core.Types.Proxy">
10334 <summary>
10335 Contains HTTP proxy settings used to process requests to Internet
10336 resources.
10337 </summary>
10338 </member>
10339 <member name="M:NAnt.Core.Types.Proxy.#ctor">
10340 <summary>
10341 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Proxy"/> class.
10342 </summary>
10343 </member>
10344 <member name="M:NAnt.Core.Types.Proxy.GetWebProxy">
10345 <summary>
10346 Gets a <see cref="T:System.Net.WebProxy"/> instance representing the current
10347 <see cref="T:NAnt.Core.Types.Proxy"/>.
10348 </summary>
10349 <returns>
10350 A <see cref="T:System.Net.WebProxy"/> instance representing the current
10351 <see cref="T:NAnt.Core.Types.Proxy"/>, or <see langword="GlobalProxySelection.Select"/>
10352 if this proxy should not be used to connect to the external resource.
10353 </returns>
10354 </member>
10355 <member name="P:NAnt.Core.Types.Proxy.Host">
10356 <summary>
10357 The name of the proxy host.
10358 </summary>
10359 </member>
10360 <member name="P:NAnt.Core.Types.Proxy.Port">
10361 <summary>
10362 The port number on <see cref="P:NAnt.Core.Types.Proxy.Host"/> to use.
10363 </summary>
10364 </member>
10365 <member name="P:NAnt.Core.Types.Proxy.BypassOnLocal">
10366 <summary>
10367 Specifies whether to bypass the proxy server for local addresses.
10368 The default is <see langword="false" />.
10369 </summary>
10370 </member>
10371 <member name="P:NAnt.Core.Types.Proxy.Credentials">
10372 <summary>
10373 The credentials to submit to the proxy server for authentication.
10374 </summary>
10375 </member>
10376 <member name="P:NAnt.Core.Types.Proxy.IfDefined">
10377 <summary>
10378 Indicates if the proxy should be used to connect to the external
10379 resource. If <see langword="true" /> then the proxy will be used;
10380 otherwise, not. The default is <see langword="true" />.
10381 </summary>
10382 </member>
10383 <member name="P:NAnt.Core.Types.Proxy.UnlessDefined">
10384 <summary>
10385 Indicates if the proxy should not be used to connect to the external
10386 resource. If <see langword="false" /> then the proxy will be used;
10387 otherwise, not. The default is <see langword="false" />.
10388 </summary>
10389 </member>
10390 <member name="T:NAnt.Core.Types.RawXml">
10391 <summary>
10392 Represents an element of which the XML is processed by its parent task
10393 or type.
10394 </summary>
10395 </member>
10396 <member name="P:NAnt.Core.Types.RawXml.Xml">
10397 <summary>
10398 Gets the XML that this element represents.
10399 </summary>
10400 </member>
10401 <member name="P:NAnt.Core.Types.RawXml.CustomXmlProcessing">
10402 <summary>
10403 Gets a value indicating whether the element is performing additional
10404 processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
10405 initialize the element.
10406 </summary>
10407 <value>
10408 <see langword="true"/>, as the XML that represents this build
10409 element is processed by the containing task or type.
10410 </value>
10411 </member>
10412 <member name="T:NAnt.Core.Types.Token">
10413 <summary>
10414 ReplaceTokens filter token.
10415 </summary>
10416 </member>
10417 <member name="P:NAnt.Core.Types.Token.Key">
10418 <summary>
10419 Token to be replaced.
10420 </summary>
10421 </member>
10422 <member name="P:NAnt.Core.Types.Token.Value">
10423 <summary>
10424 New value of token.
10425 </summary>
10426 </member>
10427 <member name="P:NAnt.Core.Types.Token.IfDefined">
10428 <summary>
10429 Indicates if the token should be used to replace values.
10430 If <see langword="true" /> then the token will be used;
10431 otherwise, not. The default is <see langword="true" />.
10432 </summary>
10433 </member>
10434 <member name="P:NAnt.Core.Types.Token.UnlessDefined">
10435 <summary>
10436 Indicates if the token should not be used to replace values.
10437 If <see langword="false" /> then the token will be used;
10438 otherwise, not. The default is <see langword="false" />.
10439 </summary>
10440 </member>
10441 <member name="T:NAnt.Core.Types.XmlNamespace">
10442 <summary>
10443 Represents an XML namespace.
10444 </summary>
10445 </member>
10446 <member name="P:NAnt.Core.Types.XmlNamespace.Prefix">
10447 <summary>
10448 The prefix to associate with the namespace.
10449 </summary>
10450 </member>
10451 <member name="P:NAnt.Core.Types.XmlNamespace.Uri">
10452 <summary>
10453 The associated XML namespace URI.
10454 </summary>
10455 </member>
10456 <member name="P:NAnt.Core.Types.XmlNamespace.IfDefined">
10457 <summary>
10458 Indicates if the namespace should be added to the <see cref="T:System.Xml.XmlNamespaceManager"/>.
10459 If <see langword="true"/> then the namespace will be added;
10460 otherwise, skipped. The default is <see langword="true"/>.
10461 </summary>
10462 </member>
10463 <member name="P:NAnt.Core.Types.XmlNamespace.UnlessDefined">
10464 <summary>
10465 Indicates if the namespace should not be added to the <see cref="T:System.Xml.XmlNamespaceManager"/>.
10466 list. If <see langword="false"/> then the parameter will be
10467 added; otherwise, skipped. The default is <see langword="false"/>.
10468 </summary>
10469 </member>
10470 <member name="T:NAnt.Core.Types.XmlNamespaceCollection">
10471 <summary>
10472 Contains a collection of <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements.
10473 </summary>
10474 </member>
10475 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor">
10476 <summary>
10477 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class.
10478 </summary>
10479 </member>
10480 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor(NAnt.Core.Types.XmlNamespaceCollection)">
10481 <summary>
10482 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class
10483 with the specified <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> instance.
10484 </summary>
10485 </member>
10486 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor(NAnt.Core.Types.XmlNamespace[])">
10487 <summary>
10488 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class
10489 with the specified array of <see cref="T:NAnt.Core.Types.XmlNamespace"/> instances.
10490 </summary>
10491 </member>
10492 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Add(NAnt.Core.Types.XmlNamespace)">
10493 <summary>
10494 Adds a <see cref="T:NAnt.Core.Types.XmlNamespace"/> to the end of the collection.
10495 </summary>
10496 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to be added to the end of the collection.</param>
10497 <returns>The position into which the new element was inserted.</returns>
10498 </member>
10499 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.AddRange(NAnt.Core.Types.XmlNamespace[])">
10500 <summary>
10501 Adds the elements of a <see cref="T:NAnt.Core.Types.XmlNamespace"/> array to the end of the collection.
10502 </summary>
10503 <param name="items">The array of <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements to be added to the end of the collection.</param>
10504 </member>
10505 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.AddRange(NAnt.Core.Types.XmlNamespaceCollection)">
10506 <summary>
10507 Adds the elements of a <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> to the end of the collection.
10508 </summary>
10509 <param name="items">The <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> to be added to the end of the collection.</param>
10510 </member>
10511 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Contains(NAnt.Core.Types.XmlNamespace)">
10512 <summary>
10513 Determines whether a <see cref="T:NAnt.Core.Types.XmlNamespace"/> is in the collection.
10514 </summary>
10515 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to locate in the collection.</param>
10516 <returns>
10517 <see langword="true"/> if <paramref name="item"/> is found in the
10518 collection; otherwise, <see langword="false"/>.
10519 </returns>
10520 </member>
10521 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Contains(System.String)">
10522 <summary>
10523 Determines whether a <see cref="T:NAnt.Core.Types.XmlNamespace"/> with the specified
10524 value is in the collection.
10525 </summary>
10526 <param name="value">The argument value to locate in the collection.</param>
10527 <returns>
10528 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XmlNamespace"/> with
10529 value <paramref name="value"/> is found in the collection; otherwise,
10530 <see langword="false"/>.
10531 </returns>
10532 </member>
10533 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.CopyTo(NAnt.Core.Types.XmlNamespace[],System.Int32)">
10534 <summary>
10535 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
10536 </summary>
10537 <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>
10538 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
10539 </member>
10540 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.IndexOf(NAnt.Core.Types.XmlNamespace)">
10541 <summary>
10542 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XmlNamespace"/> object in the collection.
10543 </summary>
10544 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> object for which the index is returned.</param>
10545 <returns>
10546 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.
10547 </returns>
10548 </member>
10549 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Insert(System.Int32,NAnt.Core.Types.XmlNamespace)">
10550 <summary>
10551 Inserts a <see cref="T:NAnt.Core.Types.XmlNamespace"/> into the collection at the specified index.
10552 </summary>
10553 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
10554 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to insert.</param>
10555 </member>
10556 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.GetEnumerator">
10557 <summary>
10558 Returns an enumerator that can iterate through the collection.
10559 </summary>
10560 <returns>
10561 A <see cref="T:NAnt.Core.Types.XmlNamespaceEnumerator"/> for the entire collection.
10562 </returns>
10563 </member>
10564 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Remove(NAnt.Core.Types.XmlNamespace)">
10565 <summary>
10566 Removes a member from the collection.
10567 </summary>
10568 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to remove from the collection.</param>
10569 </member>
10570 <member name="P:NAnt.Core.Types.XmlNamespaceCollection.Item(System.Int32)">
10571 <summary>
10572 Gets or sets the element at the specified index.
10573 </summary>
10574 <param name="index">The zero-based index of the element to get or set.</param>
10575 </member>
10576 <member name="P:NAnt.Core.Types.XmlNamespaceCollection.Item(System.String)">
10577 <summary>
10578 Gets the <see cref="T:NAnt.Core.Types.XmlNamespace"/> with the specified prefix.
10579 </summary>
10580 <param name="value">The prefix of the <see cref="T:NAnt.Core.Types.XmlNamespace"/> to get.</param>
10581 </member>
10582 <member name="T:NAnt.Core.Types.XmlNamespaceEnumerator">
10583 <summary>
10584 Enumerates the <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements of a <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/>.
10585 </summary>
10586 </member>
10587 <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.#ctor(NAnt.Core.Types.XmlNamespaceCollection)">
10588 <summary>
10589 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceEnumerator"/> class
10590 with the specified <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/>.
10591 </summary>
10592 <param name="arguments">The collection that should be enumerated.</param>
10593 </member>
10594 <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.MoveNext">
10595 <summary>
10596 Advances the enumerator to the next element of the collection.
10597 </summary>
10598 <returns>
10599 <see langword="true" /> if the enumerator was successfully advanced
10600 to the next element; <see langword="false" /> if the enumerator has
10601 passed the end of the collection.
10602 </returns>
10603 </member>
10604 <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.Reset">
10605 <summary>
10606 Sets the enumerator to its initial position, which is before the
10607 first element in the collection.
10608 </summary>
10609 </member>
10610 <member name="P:NAnt.Core.Types.XmlNamespaceEnumerator.Current">
10611 <summary>
10612 Gets the current element in the collection.
10613 </summary>
10614 <returns>
10615 The current element in the collection.
10616 </returns>
10617 </member>
10618 <member name="T:NAnt.Core.Types.XsltExtensionObject">
10619 <summary>
10620 Represents an XSLT extension object. The object should have a default
10621 parameterless constructor and the return value should be one of the
10622 four basic XPath data types of number, string, Boolean or node set.
10623 </summary>
10624 </member>
10625 <member name="M:NAnt.Core.Types.XsltExtensionObject.#ctor">
10626 <summary>
10627 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10628 class.
10629 </summary>
10630 </member>
10631 <member name="P:NAnt.Core.Types.XsltExtensionObject.NamespaceUri">
10632 <summary>
10633 The namespace URI to associate with the extension object.
10634 </summary>
10635 <value>
10636 The namespace URI to associate with the extension object, or
10637 <see cref="F:System.String.Empty"/> if not set.
10638 </value>
10639 </member>
10640 <member name="P:NAnt.Core.Types.XsltExtensionObject.TypeName">
10641 <summary>
10642 The full type name of the XSLT extension object.
10643 </summary>
10644 </member>
10645 <member name="P:NAnt.Core.Types.XsltExtensionObject.AssemblyPath">
10646 <summary>
10647 The assembly which contains the XSLT extension object.
10648 </summary>
10649 </member>
10650 <member name="P:NAnt.Core.Types.XsltExtensionObject.IfDefined">
10651 <summary>
10652 Indicates if the extension object should be added to the XSLT argument
10653 list. If <see langword="true" /> then the extension object will be
10654 added; otherwise, skipped. The default is <see langword="true" />.
10655 </summary>
10656 </member>
10657 <member name="P:NAnt.Core.Types.XsltExtensionObject.UnlessDefined">
10658 <summary>
10659 Indicates if the extension object should not be added to the XSLT argument
10660 list. If <see langword="false" /> then the extension object will be
10661 added; otherwise, skipped. The default is <see langword="false" />.
10662 </summary>
10663 </member>
10664 <member name="T:NAnt.Core.Types.XsltExtensionObjectCollection">
10665 <summary>
10666 Contains a collection of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> elements.
10667 </summary>
10668 </member>
10669 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor">
10670 <summary>
10671 Initializes a new instance of the
10672 <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class.
10673 </summary>
10674 </member>
10675 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor(NAnt.Core.Types.XsltExtensionObjectCollection)">
10676 <summary>
10677 Initializes a new instance of the
10678 <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class with the
10679 specified <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> instance.
10680 </summary>
10681 </member>
10682 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor(NAnt.Core.Types.XsltExtensionObject[])">
10683 <summary>
10684 Initializes a new instance of the
10685 <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class with the
10686 specified array of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> instances.
10687 </summary>
10688 </member>
10689 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Add(NAnt.Core.Types.XsltExtensionObject)">
10690 <summary>
10691 Adds a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to the end of the collection.
10692 </summary>
10693 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to be added
10694 to the end of the collection.</param>
10695 <returns>The position into which the new element was inserted.</returns>
10696 </member>
10697 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.AddRange(NAnt.Core.Types.XsltExtensionObject[])">
10698 <summary>
10699 Adds the elements of a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> array to the
10700 end of the collection.
10701 </summary>
10702 <param name="items">The array of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10703 elements to be added to the end of the collection.</param>
10704 </member>
10705 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.AddRange(NAnt.Core.Types.XsltExtensionObjectCollection)">
10706 <summary>
10707 Adds the elements of a <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>
10708 to the end of the collection.
10709 </summary>
10710 <param name="items">The <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>
10711 to be added to the end of the collection.</param>
10712 </member>
10713 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Contains(NAnt.Core.Types.XsltExtensionObject)">
10714 <summary>
10715 Determines whether a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> is in the
10716 collection.
10717 </summary>
10718 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to locate
10719 in the collection.</param>
10720 <returns>
10721 <see langword="true"/> if <paramref name="item"/> is found in the
10722 collection; otherwise, <see langword="false"/>.
10723 </returns>
10724 </member>
10725 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Contains(System.String)">
10726 <summary>
10727 Determines whether a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> with the
10728 specified value is in the collection.
10729 </summary>
10730 <param name="value">The argument value to locate in the
10731 collection.</param>
10732 <returns>
10733 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10734 with value <paramref name="value"/> is found in the collection;
10735 otherwise, <see langword="false"/>.
10736 </returns>
10737 </member>
10738 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.CopyTo(NAnt.Core.Types.XsltExtensionObject[],System.Int32)">
10739 <summary>
10740 Copies the entire collection to a compatible one-dimensional array,
10741 starting at the specified index of the target array.
10742 </summary>
10743 <param name="array">The one-dimensional array that is the
10744 destination of the elements copied from the collection. The array
10745 must have zero-based indexing.</param>
10746 <param name="index">The zero-based index in <paramref name="array"/>
10747 at which copying begins.</param>
10748 </member>
10749 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.IndexOf(NAnt.Core.Types.XsltExtensionObject)">
10750 <summary>
10751 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10752 object in the collection.
10753 </summary>
10754 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> object for
10755 which the index is returned.</param>
10756 <returns>
10757 The index of the specified <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>. If the
10758 <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> is not currently a member of the
10759 collection, it returns -1.
10760 </returns>
10761 </member>
10762 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Insert(System.Int32,NAnt.Core.Types.XsltExtensionObject)">
10763 <summary>
10764 Inserts a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> into the collection at
10765 the specified index.
10766 </summary>
10767 <param name="index">The zero-based index at which
10768 <paramref name="item"/> should be inserted.</param>
10769 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to
10770 insert.</param>
10771 </member>
10772 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.GetEnumerator">
10773 <summary>
10774 Returns an enumerator that can iterate through the collection.
10775 </summary>
10776 <returns>
10777 A <see cref="T:NAnt.Core.Types.XsltExtensionObjectEnumerator"/> for the entire
10778 collection.
10779 </returns>
10780 </member>
10781 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Remove(NAnt.Core.Types.XsltExtensionObject)">
10782 <summary>
10783 Removes a member from the collection.
10784 </summary>
10785 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to remove
10786 from the collection.</param>
10787 </member>
10788 <member name="P:NAnt.Core.Types.XsltExtensionObjectCollection.Item(System.Int32)">
10789 <summary>
10790 Gets or sets the element at the specified index.
10791 </summary>
10792 <param name="index">The zero-based index of the element to get
10793 or set.</param>
10794 </member>
10795 <member name="P:NAnt.Core.Types.XsltExtensionObjectCollection.Item(System.String)">
10796 <summary>
10797 Gets the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> with the specified name.
10798 </summary>
10799 <param name="value">The name of the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10800 to get.</param>
10801 </member>
10802 <member name="T:NAnt.Core.Types.XsltExtensionObjectEnumerator">
10803 <summary>
10804 Enumerates the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> elements of a
10805 <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>.
10806 </summary>
10807 </member>
10808 <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.#ctor(NAnt.Core.Types.XsltExtensionObjectCollection)">
10809 <summary>
10810 Initializes a new instance of the
10811 <see cref="T:NAnt.Core.Types.XsltExtensionObjectEnumerator"/> class
10812 with the specified <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>.
10813 </summary>
10814 <param name="arguments">The collection that should be
10815 enumerated.</param>
10816 </member>
10817 <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.MoveNext">
10818 <summary>
10819 Advances the enumerator to the next element of the collection.
10820 </summary>
10821 <returns>
10822 <see langword="true" /> if the enumerator was successfully advanced
10823 to the next element; <see langword="false" /> if the enumerator has
10824 passed the end of the collection.
10825 </returns>
10826 </member>
10827 <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.Reset">
10828 <summary>
10829 Sets the enumerator to its initial position, which is before the
10830 first element in the collection.
10831 </summary>
10832 </member>
10833 <member name="P:NAnt.Core.Types.XsltExtensionObjectEnumerator.Current">
10834 <summary>
10835 Gets the current element in the collection.
10836 </summary>
10837 <returns>
10838 The current element in the collection.
10839 </returns>
10840 </member>
10841 <member name="T:NAnt.Core.Types.XsltParameter">
10842 <summary>
10843 Represents an XSLT parameter.
10844 </summary>
10845 </member>
10846 <member name="M:NAnt.Core.Types.XsltParameter.#ctor">
10847 <summary>
10848 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameter"/>
10849 class.
10850 </summary>
10851 </member>
10852 <member name="P:NAnt.Core.Types.XsltParameter.ParameterName">
10853 <summary>
10854 The name of the XSLT parameter.
10855 </summary>
10856 <value>
10857 The name of the XSLT parameter, or <see cref="F:System.String.Empty"/> if
10858 not set.
10859 </value>
10860 </member>
10861 <member name="P:NAnt.Core.Types.XsltParameter.NamespaceUri">
10862 <summary>
10863 The namespace URI to associate with the parameter.
10864 </summary>
10865 <value>
10866 The namespace URI to associate with the parameter, or
10867 <see cref="F:System.String.Empty"/> if not set.
10868 </value>
10869 </member>
10870 <member name="P:NAnt.Core.Types.XsltParameter.Value">
10871 <summary>
10872 The value of the XSLT parameter.
10873 </summary>
10874 <value>
10875 The value of the XSLT parameter, or <see cref="F:System.String.Empty"/> if
10876 not set.
10877 </value>
10878 </member>
10879 <member name="P:NAnt.Core.Types.XsltParameter.IfDefined">
10880 <summary>
10881 Indicates if the parameter should be added to the XSLT argument list.
10882 If <see langword="true" /> then the parameter will be added;
10883 otherwise, skipped. The default is <see langword="true" />.
10884 </summary>
10885 </member>
10886 <member name="P:NAnt.Core.Types.XsltParameter.UnlessDefined">
10887 <summary>
10888 Indicates if the parameter should not be added to the XSLT argument
10889 list. If <see langword="false" /> then the parameter will be
10890 added; otherwise, skipped. The default is <see langword="false" />.
10891 </summary>
10892 </member>
10893 <member name="T:NAnt.Core.Types.XsltParameterCollection">
10894 <summary>
10895 Contains a collection of <see cref="T:NAnt.Core.Types.XsltParameter"/> elements.
10896 </summary>
10897 </member>
10898 <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor">
10899 <summary>
10900 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class.
10901 </summary>
10902 </member>
10903 <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor(NAnt.Core.Types.XsltParameterCollection)">
10904 <summary>
10905 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class
10906 with the specified <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> instance.
10907 </summary>
10908 </member>
10909 <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor(NAnt.Core.Types.XsltParameter[])">
10910 <summary>
10911 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class
10912 with the specified array of <see cref="T:NAnt.Core.Types.XsltParameter"/> instances.
10913 </summary>
10914 </member>
10915 <member name="M:NAnt.Core.Types.XsltParameterCollection.Add(NAnt.Core.Types.XsltParameter)">
10916 <summary>
10917 Adds a <see cref="T:NAnt.Core.Types.XsltParameter"/> to the end of the collection.
10918 </summary>
10919 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to be added to the end of the collection.</param>
10920 <returns>The position into which the new element was inserted.</returns>
10921 </member>
10922 <member name="M:NAnt.Core.Types.XsltParameterCollection.AddRange(NAnt.Core.Types.XsltParameter[])">
10923 <summary>
10924 Adds the elements of a <see cref="T:NAnt.Core.Types.XsltParameter"/> array to the end of the collection.
10925 </summary>
10926 <param name="items">The array of <see cref="T:NAnt.Core.Types.XsltParameter"/> elements to be added to the end of the collection.</param>
10927 </member>
10928 <member name="M:NAnt.Core.Types.XsltParameterCollection.AddRange(NAnt.Core.Types.XsltParameterCollection)">
10929 <summary>
10930 Adds the elements of a <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> to the end of the collection.
10931 </summary>
10932 <param name="items">The <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> to be added to the end of the collection.</param>
10933 </member>
10934 <member name="M:NAnt.Core.Types.XsltParameterCollection.Contains(NAnt.Core.Types.XsltParameter)">
10935 <summary>
10936 Determines whether a <see cref="T:NAnt.Core.Types.XsltParameter"/> is in the collection.
10937 </summary>
10938 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to locate in the collection.</param>
10939 <returns>
10940 <see langword="true"/> if <paramref name="item"/> is found in the
10941 collection; otherwise, <see langword="false"/>.
10942 </returns>
10943 </member>
10944 <member name="M:NAnt.Core.Types.XsltParameterCollection.Contains(System.String)">
10945 <summary>
10946 Determines whether a <see cref="T:NAnt.Core.Types.XsltParameter"/> with the specified
10947 value is in the collection.
10948 </summary>
10949 <param name="value">The argument value to locate in the collection.</param>
10950 <returns>
10951 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XsltParameter"/> with
10952 value <paramref name="value"/> is found in the collection; otherwise,
10953 <see langword="false"/>.
10954 </returns>
10955 </member>
10956 <member name="M:NAnt.Core.Types.XsltParameterCollection.CopyTo(NAnt.Core.Types.XsltParameter[],System.Int32)">
10957 <summary>
10958 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
10959 </summary>
10960 <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>
10961 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
10962 </member>
10963 <member name="M:NAnt.Core.Types.XsltParameterCollection.IndexOf(NAnt.Core.Types.XsltParameter)">
10964 <summary>
10965 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XsltParameter"/> object in the collection.
10966 </summary>
10967 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> object for which the index is returned.</param>
10968 <returns>
10969 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.
10970 </returns>
10971 </member>
10972 <member name="M:NAnt.Core.Types.XsltParameterCollection.Insert(System.Int32,NAnt.Core.Types.XsltParameter)">
10973 <summary>
10974 Inserts a <see cref="T:NAnt.Core.Types.XsltParameter"/> into the collection at the specified index.
10975 </summary>
10976 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
10977 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to insert.</param>
10978 </member>
10979 <member name="M:NAnt.Core.Types.XsltParameterCollection.GetEnumerator">
10980 <summary>
10981 Returns an enumerator that can iterate through the collection.
10982 </summary>
10983 <returns>
10984 A <see cref="T:NAnt.Core.Types.XsltParameterEnumerator"/> for the entire collection.
10985 </returns>
10986 </member>
10987 <member name="M:NAnt.Core.Types.XsltParameterCollection.Remove(NAnt.Core.Types.XsltParameter)">
10988 <summary>
10989 Removes a member from the collection.
10990 </summary>
10991 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to remove from the collection.</param>
10992 </member>
10993 <member name="P:NAnt.Core.Types.XsltParameterCollection.Item(System.Int32)">
10994 <summary>
10995 Gets or sets the element at the specified index.
10996 </summary>
10997 <param name="index">The zero-based index of the element to get or set.</param>
10998 </member>
10999 <member name="P:NAnt.Core.Types.XsltParameterCollection.Item(System.String)">
11000 <summary>
11001 Gets the <see cref="T:NAnt.Core.Types.XsltParameter"/> with the specified name.
11002 </summary>
11003 <param name="value">The name of the <see cref="T:NAnt.Core.Types.XsltParameter"/> to get.</param>
11004 </member>
11005 <member name="T:NAnt.Core.Types.XsltParameterEnumerator">
11006 <summary>
11007 Enumerates the <see cref="T:NAnt.Core.Types.XsltParameter"/> elements of a <see cref="T:NAnt.Core.Types.XsltParameterCollection"/>.
11008 </summary>
11009 </member>
11010 <member name="M:NAnt.Core.Types.XsltParameterEnumerator.#ctor(NAnt.Core.Types.XsltParameterCollection)">
11011 <summary>
11012 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterEnumerator"/> class
11013 with the specified <see cref="T:NAnt.Core.Types.XsltParameterCollection"/>.
11014 </summary>
11015 <param name="arguments">The collection that should be enumerated.</param>
11016 </member>
11017 <member name="M:NAnt.Core.Types.XsltParameterEnumerator.MoveNext">
11018 <summary>
11019 Advances the enumerator to the next element of the collection.
11020 </summary>
11021 <returns>
11022 <see langword="true" /> if the enumerator was successfully advanced
11023 to the next element; <see langword="false" /> if the enumerator has
11024 passed the end of the collection.
11025 </returns>
11026 </member>
11027 <member name="M:NAnt.Core.Types.XsltParameterEnumerator.Reset">
11028 <summary>
11029 Sets the enumerator to its initial position, which is before the
11030 first element in the collection.
11031 </summary>
11032 </member>
11033 <member name="P:NAnt.Core.Types.XsltParameterEnumerator.Current">
11034 <summary>
11035 Gets the current element in the collection.
11036 </summary>
11037 <returns>
11038 The current element in the collection.
11039 </returns>
11040 </member>
11041 <member name="T:NAnt.Core.Util.AssemblyResolver">
11042 <summary>
11043 Resolves assemblies by caching assemblies that were loaded.
11044 </summary>
11045 </member>
11046 <member name="M:NAnt.Core.Util.AssemblyResolver.#ctor">
11047 <summary>
11048 Initializes an instanse of the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
11049 class.
11050 </summary>
11051 </member>
11052 <member name="M:NAnt.Core.Util.AssemblyResolver.#ctor(NAnt.Core.Task)">
11053 <summary>
11054 Initializes an instanse of the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
11055 class in the context of the given <see cref="T:NAnt.Core.Task"/>.
11056 </summary>
11057 </member>
11058 <member name="M:NAnt.Core.Util.AssemblyResolver.Attach">
11059 <summary>
11060 Installs the assembly resolver by hooking up to the
11061 <see cref="F:System.AppDomain.AssemblyResolve"/> event.
11062 </summary>
11063 </member>
11064 <member name="M:NAnt.Core.Util.AssemblyResolver.Detach">
11065 <summary>
11066 Uninstalls the assembly resolver.
11067 </summary>
11068 </member>
11069 <member name="M:NAnt.Core.Util.AssemblyResolver.AssemblyResolve(System.Object,System.ResolveEventArgs)">
11070 <summary>
11071 Resolves an assembly not found by the system using the assembly
11072 cache.
11073 </summary>
11074 <param name="sender">The source of the event.</param>
11075 <param name="args">A <see cref="T:System.ResolveEventArgs"/> that contains the event data.</param>
11076 <returns>
11077 The loaded assembly, or <see langword="null"/> if not found.
11078 </returns>
11079 </member>
11080 <member name="M:NAnt.Core.Util.AssemblyResolver.AssemblyLoad(System.Object,System.AssemblyLoadEventArgs)">
11081 <summary>
11082 Occurs when an assembly is loaded. The loaded assembly is added
11083 to the assembly cache.
11084 </summary>
11085 <param name="sender">The source of the event.</param>
11086 <param name="args">An <see cref="T:System.AssemblyLoadEventArgs"/> that contains the event data.</param>
11087 </member>
11088 <member name="M:NAnt.Core.Util.AssemblyResolver.Log(NAnt.Core.Level,System.String,System.Object[])">
11089 <summary>
11090 Logs a message with the given priority.
11091 </summary>
11092 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
11093 <param name="message">The message to log, containing zero or more format items.</param>
11094 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
11095 <remarks>
11096 The actual logging is delegated to the <see cref="T:NAnt.Core.Task"/> in which
11097 the <see cref="T:NAnt.Core.Util.AssemblyResolver"/> is executing
11098 </remarks>
11099 </member>
11100 <member name="F:NAnt.Core.Util.AssemblyResolver._assemblyCache">
11101 <summary>
11102 Holds the loaded assemblies.
11103 </summary>
11104 </member>
11105 <member name="F:NAnt.Core.Util.AssemblyResolver._task">
11106 <summary>
11107 Holds the <see cref="T:NAnt.Core.Task"/> in which the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
11108 is executing.
11109 </summary>
11110 <value>
11111 The <see cref="T:NAnt.Core.Task"/> in which the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
11112 is executing or <see langword="null"/> if the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
11113 is not executing in the context of a <see cref="T:NAnt.Core.Task"/>.
11114 </value>
11115 </member>
11116 <member name="T:NAnt.Core.Util.CommandLineArgument">
11117 <summary>
11118 Represents a valid command-line argument.
11119 </summary>
11120 </member>
11121 <member name="M:NAnt.Core.Util.CommandLineArgument.Finish(System.Object)">
11122 <summary>
11123 Sets the value of the argument on the specified object.
11124 </summary>
11125 <param name="destination">The object on which the value of the argument should be set.</param>
11126 <exception cref="T:NAnt.Core.Util.CommandLineArgumentException">The argument is required and no value was specified.</exception>
11127 <exception cref="T:System.NotSupportedException">
11128 <para>
11129 The matching property is collection-based, but is not initialized
11130 and cannot be written to.
11131 </para>
11132 <para>-or-</para>
11133 <para>
11134 The matching property is collection-based, but has no strongly-typed
11135 Add method.
11136 </para>
11137 <para>-or-</para>
11138 <para>
11139 The matching property is collection-based, but the signature of the
11140 Add method is not supported.
11141 </para>
11142 </exception>
11143 </member>
11144 <member name="M:NAnt.Core.Util.CommandLineArgument.SetValue(System.String)">
11145 <summary>
11146 Assigns the specified value to the argument.
11147 </summary>
11148 <param name="value">The value that should be assigned to the argument.</param>
11149 <exception cref="T:NAnt.Core.Util.CommandLineArgumentException">
11150 <para>Duplicate argument.</para>
11151 <para>-or-</para>
11152 <para>Invalid value.</para>
11153 </exception>
11154 </member>
11155 <member name="M:NAnt.Core.Util.CommandLineArgument.IsNameValueCollectionType(System.Type)">
11156 <summary>
11157 Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is a
11158 <see cref="T:System.Collections.Specialized.NameValueCollection"/>.
11159 </summary>
11160 <value>
11161 <see langword="true"/> if <paramref name="type"/> can be assigned
11162 to <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise, <see langword="false"/>.
11163 </value>
11164 </member>
11165 <member name="M:NAnt.Core.Util.CommandLineArgument.IsCollectionType(System.Type)">
11166 <summary>
11167 Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is collection-based.
11168 </summary>
11169 <value>
11170 <see langword="true"/> if <paramref name="type"/> can be assigned
11171 to <see cref="T:System.Collections.ICollection"/> and is not backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
11172 that can be assigned to <see cref="T:System.Collections.Specialized.NameValueCollection"/>;
11173 otherwise, <see langword="false"/>.
11174 </value>
11175 </member>
11176 <member name="M:NAnt.Core.Util.CommandLineArgument.IsArrayType(System.Type)">
11177 <summary>
11178 Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is an array.
11179 </summary>
11180 <value>
11181 <see langword="true"/> if <paramref name="type"/> is an array;
11182 otherwise, <see langword="false"/>.
11183 </value>
11184 </member>
11185 <member name="P:NAnt.Core.Util.CommandLineArgument.Property">
11186 <summary>
11187 Gets the property that backs the argument.
11188 </summary>
11189 <value>
11190 The property that backs the arguments.
11191 </value>
11192 </member>
11193 <member name="P:NAnt.Core.Util.CommandLineArgument.ValueType">
11194 <summary>
11195 Gets the underlying <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument.
11196 </summary>
11197 <value>
11198 The underlying <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument.
11199 </value>
11200 <remarks>
11201 If the <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument is a collection type,
11202 this property will returns the underlying type of that collection.
11203 </remarks>
11204 </member>
11205 <member name="P:NAnt.Core.Util.CommandLineArgument.LongName">
11206 <summary>
11207 Gets the long name of the argument.
11208 </summary>
11209 <value>The long name of the argument.</value>
11210 </member>
11211 <member name="P:NAnt.Core.Util.CommandLineArgument.ShortName">
11212 <summary>
11213 Gets the short name of the argument.
11214 </summary>
11215 <value>The short name of the argument.</value>
11216 </member>
11217 <member name="P:NAnt.Core.Util.CommandLineArgument.Description">
11218 <summary>
11219 Gets the description of the argument.
11220 </summary>
11221 <value>The description of the argument.</value>
11222 </member>
11223 <member name="P:NAnt.Core.Util.CommandLineArgument.IsRequired">
11224 <summary>
11225 Gets a value indicating whether the argument is required.
11226 </summary>
11227 <value>
11228 <see langword="true" /> if the argument is required; otherwise,
11229 <see langword="false" />.
11230 </value>
11231 </member>
11232 <member name="P:NAnt.Core.Util.CommandLineArgument.SeenValue">
11233 <summary>
11234 Gets a value indicating whether a mathing command-line argument
11235 was already found.
11236 </summary>
11237 <value>
11238 <see langword="true" /> if a matching command-line argument was
11239 already found; otherwise, <see langword="false" />.
11240 </value>
11241 </member>
11242 <member name="P:NAnt.Core.Util.CommandLineArgument.AllowMultiple">
11243 <summary>
11244 Gets a value indicating whether the argument can be specified multiple
11245 times.
11246 </summary>
11247 <value>
11248 <see langword="true" /> if the argument may be specified multiple
11249 times; otherwise, <see langword="false" />.
11250 </value>
11251 </member>
11252 <member name="P:NAnt.Core.Util.CommandLineArgument.Unique">
11253 <summary>
11254 Gets a value indicating whether the argument can only be specified once
11255 with a certain value.
11256 </summary>
11257 <value>
11258 <see langword="true" /> if the argument should always have a unique
11259 value; otherwise, <see langword="false" />.
11260 </value>
11261 </member>
11262 <member name="P:NAnt.Core.Util.CommandLineArgument.Type">
11263 <summary>
11264 Gets the <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the property to which the argument
11265 is applied.
11266 </summary>
11267 <value>
11268 The <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the property to which the argument is
11269 applied.
11270 </value>
11271 </member>
11272 <member name="P:NAnt.Core.Util.CommandLineArgument.IsCollection">
11273 <summary>
11274 Gets a value indicating whether the argument is collection-based.
11275 </summary>
11276 <value>
11277 <see langword="true"/> if the argument is backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
11278 that can be assigned to <see cref="T:System.Collections.ICollection"/> and is not backed
11279 by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> that can be assigned to
11280 <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise, <see langword="false"/>.
11281 </value>
11282 </member>
11283 <member name="P:NAnt.Core.Util.CommandLineArgument.IsNameValueCollection">
11284 <summary>
11285 Gets a value indicating whether the argument is a set of name/value
11286 pairs.
11287 </summary>
11288 <value>
11289 <see langword="true"/> if the argument is backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
11290 that can be assigned to <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise,
11291 <see langword="false"/>.
11292 </value>
11293 </member>
11294 <member name="P:NAnt.Core.Util.CommandLineArgument.IsArray">
11295 <summary>
11296 Gets a value indicating whether the argument is array-based.
11297 </summary>
11298 <value>
11299 <see langword="true" /> if the argument is backed by an array;
11300 otherwise, <see langword="false" />.
11301 </value>
11302 </member>
11303 <member name="P:NAnt.Core.Util.CommandLineArgument.IsDefault">
11304 <summary>
11305 Gets a value indicating whether the argument is the default argument.
11306 </summary>
11307 <value>
11308 <see langword="true" /> if the argument is the default argument;
11309 otherwise, <see langword="false" />.
11310 </value>
11311 </member>
11312 <member name="P:NAnt.Core.Util.CommandLineArgument.IsExclusive">
11313 <summary>
11314 Gets a value indicating whether the argument cannot be combined with
11315 other arguments.
11316 </summary>
11317 <value>
11318 <see langword="true" /> if the argument cannot be combined with other
11319 arguments; otherwise, <see langword="false" />.
11320 </value>
11321 </member>
11322 <member name="T:NAnt.Core.Util.CommandLineArgumentAttribute">
11323 <summary>
11324 Allows control of command line parsing.
11325 </summary>
11326 </member>
11327 <member name="M:NAnt.Core.Util.CommandLineArgumentAttribute.#ctor(NAnt.Core.Util.CommandLineArgumentTypes)">
11328 <summary>
11329 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> class
11330 with the specified argument type.
11331 </summary>
11332 <param name="argumentType">Specifies the checking to be done on the argument.</param>
11333 </member>
11334 <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Type">
11335 <summary>
11336 Gets or sets the checking to be done on the argument.
11337 </summary>
11338 <value>The checking that should be done on the argument.</value>
11339 </member>
11340 <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Name">
11341 <summary>
11342 Gets or sets the long name of the argument.
11343 </summary>
11344 <value>The long name of the argument.</value>
11345 </member>
11346 <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.ShortName">
11347 <summary>
11348 Gets or sets the short name of the argument.
11349 </summary>
11350 <value>The short name of the argument.</value>
11351 </member>
11352 <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Description">
11353 <summary>
11354 Gets or sets the description of the argument.
11355 </summary>
11356 <value>The description of the argument.</value>
11357 </member>
11358 <member name="T:NAnt.Core.Util.CommandLineArgumentCollection">
11359 <summary>
11360 Contains a strongly typed collection of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> objects.
11361 </summary>
11362 </member>
11363 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor">
11364 <summary>
11365 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class.
11366 </summary>
11367 </member>
11368 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor(NAnt.Core.Util.CommandLineArgumentCollection)">
11369 <summary>
11370 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class
11371 with the specified <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> instance.
11372 </summary>
11373 </member>
11374 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor(NAnt.Core.Util.CommandLineArgument[])">
11375 <summary>
11376 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class
11377 with the specified array of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> instances.
11378 </summary>
11379 </member>
11380 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Add(NAnt.Core.Util.CommandLineArgument)">
11381 <summary>
11382 Adds a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to the end of the collection.
11383 </summary>
11384 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to be added to the end of the collection.</param>
11385 <returns>The position into which the new element was inserted.</returns>
11386 </member>
11387 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.AddRange(NAnt.Core.Util.CommandLineArgument[])">
11388 <summary>
11389 Adds the elements of a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> array to the end of the collection.
11390 </summary>
11391 <param name="items">The array of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> elements to be added to the end of the collection.</param>
11392 </member>
11393 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.AddRange(NAnt.Core.Util.CommandLineArgumentCollection)">
11394 <summary>
11395 Adds the elements of a <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> to the end of the collection.
11396 </summary>
11397 <param name="items">The <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> to be added to the end of the collection.</param>
11398 </member>
11399 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Contains(NAnt.Core.Util.CommandLineArgument)">
11400 <summary>
11401 Determines whether a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> is in the collection.
11402 </summary>
11403 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to locate in the collection.</param>
11404 <returns>
11405 <see langword="true"/> if <paramref name="item"/> is found in the
11406 collection; otherwise, <see langword="false"/>.
11407 </returns>
11408 </member>
11409 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.CopyTo(NAnt.Core.Util.CommandLineArgument[],System.Int32)">
11410 <summary>
11411 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
11412 </summary>
11413 <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>
11414 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
11415 </member>
11416 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.IndexOf(NAnt.Core.Util.CommandLineArgument)">
11417 <summary>
11418 Retrieves the index of a specified <see cref="T:NAnt.Core.Util.CommandLineArgument"/> object in the collection.
11419 </summary>
11420 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> object for which the index is returned.</param>
11421 <returns>
11422 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.
11423 </returns>
11424 </member>
11425 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Insert(System.Int32,NAnt.Core.Util.CommandLineArgument)">
11426 <summary>
11427 Inserts a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> into the collection at the specified index.
11428 </summary>
11429 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
11430 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to insert.</param>
11431 </member>
11432 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.GetEnumerator">
11433 <summary>
11434 Returns an enumerator that can iterate through the collection.
11435 </summary>
11436 <returns>
11437 A <see cref="T:NAnt.Core.Util.CommandLineArgumentEnumerator"/> for the entire collection.
11438 </returns>
11439 </member>
11440 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Remove(NAnt.Core.Util.CommandLineArgument)">
11441 <summary>
11442 Removes a member from the collection.
11443 </summary>
11444 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to remove from the collection.</param>
11445 </member>
11446 <member name="P:NAnt.Core.Util.CommandLineArgumentCollection.Item(System.Int32)">
11447 <summary>
11448 Gets or sets the element at the specified index.
11449 </summary>
11450 <param name="index">The zero-based index of the element to get or set.</param>
11451 </member>
11452 <member name="P:NAnt.Core.Util.CommandLineArgumentCollection.Item(System.String)">
11453 <summary>
11454 Gets the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> with the specified name.
11455 </summary>
11456 <param name="name">The name of the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to get.</param>
11457 </member>
11458 <member name="T:NAnt.Core.Util.CommandLineArgumentEnumerator">
11459 <summary>
11460 Enumerates the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> elements of a <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/>.
11461 </summary>
11462 </member>
11463 <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.#ctor(NAnt.Core.Util.CommandLineArgumentCollection)">
11464 <summary>
11465 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentEnumerator"/> class
11466 with the specified <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/>.
11467 </summary>
11468 <param name="arguments">The collection that should be enumerated.</param>
11469 </member>
11470 <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.MoveNext">
11471 <summary>
11472 Advances the enumerator to the next element of the collection.
11473 </summary>
11474 <returns>
11475 <see langword="true" /> if the enumerator was successfully advanced
11476 to the next element; <see langword="false" /> if the enumerator has
11477 passed the end of the collection.
11478 </returns>
11479 </member>
11480 <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.Reset">
11481 <summary>
11482 Sets the enumerator to its initial position, which is before the
11483 first element in the collection.
11484 </summary>
11485 </member>
11486 <member name="P:NAnt.Core.Util.CommandLineArgumentEnumerator.Current">
11487 <summary>
11488 Gets the current element in the collection.
11489 </summary>
11490 <returns>
11491 The current element in the collection.
11492 </returns>
11493 </member>
11494 <member name="T:NAnt.Core.Util.CommandLineArgumentException">
11495 <summary>
11496 The exception that is thrown when one of the command-line arguments provided
11497 is not valid.
11498 </summary>
11499 </member>
11500 <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor">
11501 <summary>
11502 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class.
11503 </summary>
11504 </member>
11505 <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.String)">
11506 <summary>
11507 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
11508 with a descriptive message.
11509 </summary>
11510 <param name="message">A descriptive message to include with the exception.</param>
11511 </member>
11512 <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.String,System.Exception)">
11513 <summary>
11514 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
11515 with a descriptive message and an inner exception.
11516 </summary>
11517 <param name="message">A descriptive message to include with the exception.</param>
11518 <param name="innerException">A nested exception that is the cause of the current exception.</param>
11519 </member>
11520 <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
11521 <summary>
11522 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
11523 with serialized data.
11524 </summary>
11525 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
11526 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
11527 </member>
11528 <member name="T:NAnt.Core.Util.CommandLineArgumentTypes">
11529 <summary>
11530 Used to control parsing of command-line arguments.
11531 </summary>
11532 </member>
11533 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Required">
11534 <summary>
11535 Indicates that this field is required. An error will be displayed
11536 if it is not present when parsing arguments.
11537 </summary>
11538 </member>
11539 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Unique">
11540 <summary>
11541 Only valid in conjunction with Multiple.
11542 Duplicate values will result in an error.
11543 </summary>
11544 </member>
11545 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Multiple">
11546 <summary>
11547 Inidicates that the argument may be specified more than once.
11548 Only valid if the argument is a collection
11549 </summary>
11550 </member>
11551 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Exclusive">
11552 <summary>
11553 Inidicates that if this argument is specified, no other arguments may be specified.
11554 </summary>
11555 </member>
11556 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.AtMostOnce">
11557 <summary>
11558 The default type for non-collection arguments.
11559 The argument is not required, but an error will be reported if it is specified more than once.
11560 </summary>
11561 </member>
11562 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.MultipleUnique">
11563 <summary>
11564 The default type for collection arguments.
11565 The argument is permitted to occur multiple times, but duplicate
11566 values will cause an error to be reported.
11567 </summary>
11568 </member>
11569 <member name="T:NAnt.Core.Util.CommandLineParser">
11570 <summary>
11571 Commandline parser.
11572 </summary>
11573 </member>
11574 <member name="M:NAnt.Core.Util.CommandLineParser.#ctor(System.Type,System.Boolean)">
11575 <summary>
11576 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineParser"/> class
11577 using possible arguments deducted from the specific <see cref="T:System.Type"/>.
11578 </summary>
11579 <param name="argumentSpecification">The <see cref="T:System.Type"/> from which the possible command-line arguments should be retrieved.</param>
11580 <param name="supportsResponseFile">A <see cref="T:System.Boolean"/> value indicating whether or not a response file is able to be used. </param>
11581 <exception cref="T:System.ArgumentNullException"><paramref name="argumentSpecification"/> is a null reference.</exception>
11582 </member>
11583 <member name="M:NAnt.Core.Util.CommandLineParser.Parse(System.String[],System.Object)">
11584 <summary>
11585 Parses an argument list.
11586 </summary>
11587 <param name="args">The arguments to parse.</param>
11588 <param name="destination">The destination object on which properties will be set corresponding to the specified arguments.</param>
11589 <exception cref="T:System.ArgumentNullException"><paramref name="destination"/> is a null reference.</exception>
11590 <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>
11591 </member>
11592 <member name="M:NAnt.Core.Util.CommandLineParser.ParseArguments(System.String,System.Char[])">
11593 <summary>
11594 Splits a string and removes any empty strings from the
11595 result. Same functionality as the
11596 public string[] Split(char[] separator, StringSplitOptions options)
11597 method in .Net 2.0. Replace with that call when 2.0 is standard.
11598 </summary>
11599 <param name="sourceString"></param>
11600 <param name="delimiters"></param>
11601 <returns>the array of strings</returns>
11602 </member>
11603 <member name="M:NAnt.Core.Util.CommandLineParser.ProcessResponseFile(System.String)">
11604 <summary>
11605 Read a response file and parse the arguments as usual.
11606 </summary>
11607 <param name="file">The response file to load arguments</param>
11608 </member>
11609 <member name="M:NAnt.Core.Util.CommandLineParser.ParseArgumentList(System.String[])">
11610 <summary>
11611 Parse the argument list using the
11612 </summary>
11613 <param name="args"></param>
11614 </member>
11615 <member name="M:NAnt.Core.Util.CommandLineParser.GetCommandLineAttribute(System.Reflection.PropertyInfo)">
11616 <summary>
11617 Returns the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> that's applied
11618 on the specified property.
11619 </summary>
11620 <param name="propertyInfo">The property of which applied <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> should be returned.</param>
11621 <returns>
11622 The <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> that's applied to the
11623 <paramref name="propertyInfo"/>, or a null reference if none was applied.
11624 </returns>
11625 </member>
11626 <member name="P:NAnt.Core.Util.CommandLineParser.LogoBanner">
11627 <summary>
11628 Gets a logo banner using version and copyright attributes defined on the
11629 <see cref="M:System.Reflection.Assembly.GetEntryAssembly"/> or the
11630 <see cref="M:System.Reflection.Assembly.GetCallingAssembly"/>.
11631 </summary>
11632 <value>
11633 A logo banner.
11634 </value>
11635 </member>
11636 <member name="P:NAnt.Core.Util.CommandLineParser.Usage">
11637 <summary>
11638 Gets the usage instructions.
11639 </summary>
11640 <value>The usage instructions.</value>
11641 </member>
11642 <member name="P:NAnt.Core.Util.CommandLineParser.NoArgs">
11643 <summary>
11644 Gets a value indicating whether no arguments were specified on the
11645 command line.
11646 </summary>
11647 </member>
11648 <member name="T:NAnt.Core.Util.DefaultCommandLineArgumentAttribute">
11649 <summary>
11650 Marks a command-line option as being the default option. When the name of
11651 a command-line argument is not specified, this option will be assumed.
11652 </summary>
11653 </member>
11654 <member name="M:NAnt.Core.Util.DefaultCommandLineArgumentAttribute.#ctor(NAnt.Core.Util.CommandLineArgumentTypes)">
11655 <summary>
11656 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> class
11657 with the specified argument type.
11658 </summary>
11659 <param name="argumentType">Specifies the checking to be done on the argument.</param>
11660 </member>
11661 <member name="T:NAnt.Core.Util.FileUtils">
11662 <summary>
11663 Provides modified version for Copy and Move from the File class that
11664 allow for filter chain processing.
11665 </summary>
11666 </member>
11667 <member name="M:NAnt.Core.Util.FileUtils.CopyFile(System.String,System.String,NAnt.Core.Filters.FilterChain,System.Text.Encoding,System.Text.Encoding)">
11668 <summary>
11669 Copies a file filtering its content through the filter chain.
11670 </summary>
11671 <param name="sourceFileName">The file to copy</param>
11672 <param name="destFileName">The file to copy to</param>
11673 <param name="filterChain">Chain of filters to apply when copying, or <see langword="null" /> is no filters should be applied.</param>
11674 <param name="inputEncoding">The encoding used to read the soure file.</param>
11675 <param name="outputEncoding">The encoding used to write the destination file.</param>
11676 </member>
11677 <member name="M:NAnt.Core.Util.FileUtils.MoveFile(System.String,System.String,NAnt.Core.Filters.FilterChain,System.Text.Encoding,System.Text.Encoding)">
11678 <summary>
11679 Moves a file filtering its content through the filter chain.
11680 </summary>
11681 <param name="sourceFileName">The file to move.</param>
11682 <param name="destFileName">The file to move move to.</param>
11683 <param name="filterChain">Chain of filters to apply when moving, or <see langword="null" /> is no filters should be applied.</param>
11684 <param name="inputEncoding">The encoding used to read the soure file.</param>
11685 <param name="outputEncoding">The encoding used to write the destination file.</param>
11686 </member>
11687 <member name="M:NAnt.Core.Util.FileUtils.ReadFile(System.String,NAnt.Core.Filters.FilterChain,System.Text.Encoding)">
11688 <summary>
11689 Reads a file filtering its content through the filter chain.
11690 </summary>
11691 <param name="fileName">The file to read.</param>
11692 <param name="filterChain">Chain of filters to apply when reading, or <see langword="null" /> is no filters should be applied.</param>
11693 <param name="inputEncoding">The encoding used to read the file.</param>
11694 <remarks>
11695 If <paramref name="inputEncoding" /> is <see langword="null" />,
11696 then the system's ANSI code page will be used to read the file.
11697 </remarks>
11698 </member>
11699 <member name="M:NAnt.Core.Util.FileUtils.GetTempDirectory">
11700 <summary>
11701 Returns a uniquely named empty temporary directory on disk.
11702 </summary>
11703 <value>
11704 A <see cref="T:System.IO.DirectoryInfo"/> representing the temporary directory.
11705 </value>
11706 </member>
11707 <member name="M:NAnt.Core.Util.FileUtils.CombinePaths(System.String,System.String)">
11708 <summary>
11709 Combines two path strings.
11710 </summary>
11711 <param name="path1">The first path.</param>
11712 <param name="path2">The second path.</param>
11713 <returns>
11714 A string containing the combined paths. If one of the specified
11715 paths is a zero-length string, this method returns the other path.
11716 If <paramref name="path2"/> contains an absolute path, this method
11717 returns <paramref name="path2"/>.
11718 </returns>
11719 <remarks>
11720 <para>
11721 On *nix, processing is delegated to <see cref="M:System.IO.Path.Combine(System.String,System.String)"/>.
11722 </para>
11723 <para>
11724 On Windows, this method normalized the paths to avoid running into
11725 the 260 character limit of a path and converts forward slashes in
11726 both <paramref name="path1"/> and <paramref name="path2"/> to
11727 the platform's directory separator character.
11728 </para>
11729 </remarks>
11730 </member>
11731 <member name="M:NAnt.Core.Util.FileUtils.GetFullPath(System.String)">
11732 <summary>
11733 Returns Absolute Path (Fix for 260 Char Limit of Path.GetFullPath(...))
11734 </summary>
11735 <param name="path">The file or directory for which to obtain absolute path information.</param>
11736 <returns>Path Resolved</returns>
11737 <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>
11738 <exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
11739 </member>
11740 <member name="M:NAnt.Core.Util.FileUtils.GetHomeDirectory">
11741 <summary>
11742 Returns the home directory of the current user.
11743 </summary>
11744 <returns>
11745 The home directory of the current user.
11746 </returns>
11747 </member>
11748 <member name="M:NAnt.Core.Util.FileUtils.ResolveFile(System.String[],System.String,System.Boolean)">
11749 <summary>
11750 Scans a list of directories for the specified filename.
11751 </summary>
11752 <param name="directories">The list of directories to search.</param>
11753 <param name="fileName">The name of the file to look for.</param>
11754 <param name="recursive">Specifies whether the directory should be searched recursively.</param>
11755 <remarks>
11756 The directories are scanned in the order in which they are defined.
11757 </remarks>
11758 <returns>
11759 The absolute path to the specified file, or null if the file was
11760 not found.
11761 </returns>
11762 </member>
11763 <member name="T:NAnt.Core.Util.GacCache">
11764 <summary>
11765 Helper class for determining whether assemblies are located in the
11766 Global Assembly Cache.
11767 </summary>
11768 </member>
11769 <member name="M:NAnt.Core.Util.GacCache.#ctor(NAnt.Core.Project)">
11770 <summary>
11771 Initializes a new instance of the <see cref="T:NAnt.Core.Util.GacCache"/> class in
11772 the context of the given <see cref="P:NAnt.Core.Util.GacCache.Project"/>.
11773 </summary>
11774 </member>
11775 <member name="M:NAnt.Core.Util.GacCache.IsAssemblyInGac(System.String)">
11776 <summary>
11777 Determines whether an assembly is installed in the Global
11778 Assembly Cache given its file name or path.
11779 </summary>
11780 <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
11781 <returns>
11782 <see langword="true"/> if <paramref name="assemblyFile"/> is
11783 installed in the Global Assembly Cache; otherwise,
11784 <see langword="false"/>.
11785 </returns>
11786 <remarks>
11787 <para>
11788 To determine whether the specified assembly is installed in the
11789 Global Assembly Cache, the assembly is loaded into a separate
11790 <see cref="T:System.AppDomain"/>.
11791 </para>
11792 <para>
11793 If the family of the current runtime framework does not match the
11794 family of the current target framework, this method will return
11795 <see langword="false"/> for all assemblies as there's no way to
11796 determine whether a given assembly is in the Global Assembly Cache
11797 for another framework family than the family of the current runtime
11798 framework.
11799 </para>
11800 </remarks>
11801 </member>
11802 <member name="F:NAnt.Core.Util.GacCache._domain">
11803 <summary>
11804 Holds the <see cref="T:System.AppDomain"/> in which assemblies will be loaded
11805 to determine whether they are in the Global Assembly Cache.
11806 </summary>
11807 </member>
11808 <member name="F:NAnt.Core.Util.GacCache._project">
11809 <summary>
11810 Holds the <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
11811 </summary>
11812 </member>
11813 <member name="F:NAnt.Core.Util.GacCache._gacQueryCache">
11814 <summary>
11815 Holds a list of assembly files for which already has been determined
11816 whether they are located in the Global Assembly Cache.
11817 </summary>
11818 <remarks>
11819 <para>
11820 The key of the <see cref="T:System.Collections.Hashtable"/> is the full path to the
11821 assembly file and the value is a <see cref="T:System.Boolean"/> indicating
11822 whether the assembly is located in the Global Assembly Cache.
11823 </para>
11824 </remarks>
11825 </member>
11826 <member name="F:NAnt.Core.Util.GacCache._disposed">
11827 <summary>
11828 Holds a value indicating whether the object has been disposed.
11829 </summary>
11830 </member>
11831 <member name="P:NAnt.Core.Util.GacCache.Project">
11832 <summary>
11833 Gets the <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
11834 </summary>
11835 <value>
11836 The <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
11837 </value>
11838 </member>
11839 <member name="M:NAnt.Core.Util.GacCache.GacResolver.InitializeLifetimeService">
11840 <summary>
11841 Obtains a lifetime service object to control the lifetime policy for
11842 this instance.
11843 </summary>
11844 <returns>
11845 An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
11846 policy for this instance. This is the current lifetime service object
11847 for this instance if one exists; otherwise, a new lifetime service
11848 object initialized with a lease that will never time out.
11849 </returns>
11850 </member>
11851 <member name="M:NAnt.Core.Util.GacCache.GacResolver.IsAssemblyInGac(System.String)">
11852 <summary>
11853 Determines whether an assembly is installed in the Global
11854 Assembly Cache given its file name or path.
11855 </summary>
11856 <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
11857 <returns>
11858 <see langword="true" /> if <paramref name="assemblyFile" /> is
11859 installed in the Global Assembly Cache; otherwise,
11860 <see langword="false" />.
11861 </returns>
11862 </member>
11863 <member name="T:NAnt.Core.Util.ReflectionUtils">
11864 <summary>
11865 Provides a set of helper methods related to reflection.
11866 </summary>
11867 </member>
11868 <member name="M:NAnt.Core.Util.ReflectionUtils.#ctor">
11869 <summary>
11870 Initializes a new instance of the <see cref="T:NAnt.Core.Util.ReflectionUtils"/> class.
11871 </summary>
11872 <remarks>
11873 Uses a private access modifier to prevent instantiation of this class.
11874 </remarks>
11875 </member>
11876 <member name="M:NAnt.Core.Util.ReflectionUtils.GetTypeFromString(System.String,System.Boolean)">
11877 <summary>
11878 Loads the type specified in the type string with assembly qualified name.
11879 </summary>
11880 <param name="typeName">The assembly qualified name of the type to load.</param>
11881 <param name="throwOnError">Flag set to <see langword="true"/> to throw an exception if the type cannot be loaded.</param>
11882 <exception cref="T:System.TypeLoadException">
11883 <paramref name="throwOnError"/> is <see langword="true"/> and
11884 an error is encountered while loading the <see cref="T:System.Type"/>, or
11885 <paramref name="typeName"/> is not an assembly qualified name.
11886 </exception>
11887 <remarks>
11888 If the <see cref="T:System.Type"/> cannot be instantiated from the assembly
11889 qualified type name, then we'll try to instantiate the type using its
11890 simple type name from an already loaded assembly with an assembly
11891 name mathing the assembly in the assembly qualified type name.
11892 </remarks>
11893 <returns>
11894 The type loaded or <see langword="null"/> if it could not be loaded.
11895 </returns>
11896 </member>
11897 <member name="T:NAnt.Core.Util.ResourceUtils">
11898 <summary>
11899 Provides resource support to NAnt assemblies. This class cannot
11900 be inherited from.
11901 </summary>
11902 </member>
11903 <member name="M:NAnt.Core.Util.ResourceUtils.#ctor">
11904 <summary>
11905 Prevents the <see cref="T:NAnt.Core.Util.ResourceUtils"/> class from being
11906 instantiated explicitly.
11907 </summary>
11908 </member>
11909 <member name="M:NAnt.Core.Util.ResourceUtils.RegisterSharedAssembly(System.Reflection.Assembly)">
11910 <summary>
11911 Registers the assembly to be used as the fallback if resources
11912 aren't found in the local satellite assembly.
11913 </summary>
11914 <param name="assembly">
11915 A <see cref="T:System.Reflection.Assembly"/> that represents the
11916 assembly to register.
11917 </param>
11918 <example>
11919 The following example shows how to register a shared satellite
11920 assembly.
11921 <code>
11922 <![CDATA[
11923 Assembly sharedAssembly = Assembly.Load("MyResources.dll");
11924 ResourceUtils.RegisterSharedAssembly(sharedAssembly);
11925 ]]>
11926 </code>
11927 </example>
11928 </member>
11929 <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String)">
11930 <summary>
11931 Returns the value of the specified string resource.
11932 </summary>
11933 <param name="name">
11934 A <see cref="T:System.String"/> that contains the name of the
11935 resource to get.
11936 </param>
11937 <returns>
11938 A <see cref="T:System.String"/> that contains the value of the
11939 resource localized for the current culture.
11940 </returns>
11941 <remarks>
11942 The returned resource is localized for the cultural settings of the
11943 current <see cref="T:System.Threading.Thread"/>.
11944 <note>
11945 The <c>GetString</c> method is thread-safe.
11946 </note>
11947 </remarks>
11948 <example>
11949 The following example demonstrates the <c>GetString</c> method using
11950 the cultural settings of the current <see cref="T:System.Threading.Thread"/>.
11951 <code>
11952 <![CDATA[
11953 string localizedString = ResourceUtils.GetString("String_HelloWorld");
11954 ]]>
11955 </code>
11956 </example>
11957 </member>
11958 <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String,System.Globalization.CultureInfo)">
11959 <summary>
11960 Returns the value of the specified string resource localized for
11961 the specified culture.
11962 </summary>
11963 <param name="name"></param>
11964 <param name="culture"></param>
11965 <returns>
11966 A <see cref="T:System.String"/> that contains the value of the
11967 resource localized for the specified culture.
11968 </returns>
11969 <remarks>
11970 <note>
11971 The <c>GetString</c> method is thread-safe.
11972 </note>
11973 </remarks>
11974 <example>
11975 The following example demonstrates the <c>GetString</c> method using
11976 a specific culture.
11977 <code>
11978 <![CDATA[
11979 CultureInfo culture = CultureInfo.CreateSpecificCulture("en-US");
11980 string localizedString = ResourceUtils.GetString("String_HelloWorld", culture);
11981 ]]>
11982 </code>
11983 </example>
11984 </member>
11985 <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String,System.Globalization.CultureInfo,System.Reflection.Assembly)">
11986 <summary>
11987 Returns the value of the specified string resource localized for
11988 the specified culture for the specified assembly.
11989 </summary>
11990 <param name="name">
11991 A <see cref="T:System.String"/> that contains the name of the
11992 resource to get.
11993 </param>
11994 <param name="culture">
11995 A <see cref="T:System.Globalization.CultureInfo"/> that represents
11996 the culture for which the resource is localized.
11997 </param>
11998 <param name="assembly">
11999 A <see cref="T:System.Reflection.Assembly"/>
12000 </param>
12001 <returns>
12002 A <see cref="T:System.String"/> that contains the value of the
12003 resource localized for the specified culture.
12004 </returns>
12005 <remarks>
12006 <note>
12007 The <c>GetString</c> method is thread-safe.
12008 </note>
12009 </remarks>
12010 <example>
12011 The following example demonstrates the <c>GetString</c> method using
12012 specific culture and assembly.
12013 <code>
12014 <![CDATA[
12015 CultureInfo culture = CultureInfo.CreateSpecificCulture("en-US");
12016 Assembly assembly = Assembly.GetCallingAssembly();
12017 string localizedString = ResourceUtils.GetString("String_HelloWorld", culture, assembly);
12018 ]]>
12019 </code>
12020 </example>
12021 </member>
12022 <member name="M:NAnt.Core.Util.ResourceUtils.RegisterAssembly(System.Reflection.Assembly)">
12023 <summary>
12024 Registers the specified assembly.
12025 </summary>
12026 <param name="assembly">
12027 A <see cref="T:System.Reflection.Assembly"/> that represents the
12028 assembly to register.
12029 </param>
12030 </member>
12031 <member name="M:NAnt.Core.Util.ResourceUtils.GetResourceName(System.String)">
12032 <summary>
12033 Determines the manifest resource name of the resource holding the
12034 localized strings.
12035 </summary>
12036 <param name="assemblyName">The name of the assembly.</param>
12037 <returns>
12038 The manifest resource name of the resource holding the localized
12039 strings for the specified assembly.
12040 </returns>
12041 <remarks>
12042 The manifest resource name of the resource holding the localized
12043 strings should match the name of the assembly, minus <c>Tasks</c>
12044 suffix.
12045 </remarks>
12046 </member>
12047 <member name="T:NAnt.Core.Util.StringUtils">
12048 <summary>
12049 Groups a set of useful <see cref="T:System.String"/> manipulation and validation
12050 methods.
12051 </summary>
12052 </member>
12053 <member name="M:NAnt.Core.Util.StringUtils.#ctor">
12054 <summary>
12055 Initializes a new instance of the <see cref="T:NAnt.Core.Util.StringUtils"/> class.
12056 </summary>
12057 <remarks>
12058 Prevents instantiation of the <see cref="T:NAnt.Core.Util.StringUtils"/> class.
12059 </remarks>
12060 </member>
12061 <member name="M:NAnt.Core.Util.StringUtils.EndsWith(System.String,System.Char)">
12062 <summary>
12063 Determines whether the last character of the given <see cref="T:System.String"/>
12064 matches the specified character.
12065 </summary>
12066 <param name="value">The string.</param>
12067 <param name="c">The character.</param>
12068 <returns>
12069 <see langword="true"/> if the last character of <paramref name="value"/>
12070 matches <paramref name="c"/>; otherwise, <see langword="false"/>.
12071 </returns>
12072 <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null"/>.</exception>
12073 </member>
12074 <member name="M:NAnt.Core.Util.StringUtils.IsNullOrEmpty(System.String)">
12075 <summary>
12076 Indicates whether or not the specified <see cref="T:System.String"/> is
12077 <see langword="null"/> or an <see cref="F:System.String.Empty"/> string.
12078 </summary>
12079 <param name="value">The value to check.</param>
12080 <returns>
12081 <see langword="true"/> if <paramref name="value"/> is <see langword="null"/>
12082 or an empty string (""); otherwise, <see langword="false"/>.
12083 </returns>
12084 </member>
12085 <member name="M:NAnt.Core.Util.StringUtils.ConvertEmptyToNull(System.String)">
12086 <summary>
12087 Converts an empty string ("") to <see langword="null" />.
12088 </summary>
12089 <param name="value">The value to convert.</param>
12090 <returns>
12091 <see langword="null" /> if <paramref name="value" /> is an empty
12092 string ("") or <see langword="null" />; otherwise, <paramref name="value" />.
12093 </returns>
12094 </member>
12095 <member name="M:NAnt.Core.Util.StringUtils.ConvertNullToEmpty(System.String)">
12096 <summary>
12097 Converts <see langword="null" /> to an empty string.
12098 </summary>
12099 <param name="value">The value to convert.</param>
12100 <returns>
12101 An empty string if <paramref name="value" /> is <see langword="null" />;
12102 otherwise, <paramref name="value" />.
12103 </returns>
12104 </member>
12105 <member name="M:NAnt.Core.Util.StringUtils.Join(System.String,System.Collections.Specialized.StringCollection)">
12106 <summary>
12107 Concatenates a specified separator <see cref="T:System.String"/> between each
12108 element of a specified <see cref="T:System.Collections.Specialized.StringCollection"/>, yielding a
12109 single concatenated string.
12110 </summary>
12111 <param name="separator">A <see cref="T:System.String"/>.</param>
12112 <param name="value">A <see cref="T:System.Collections.Specialized.StringCollection"/>.</param>
12113 <returns>
12114 A <see cref="T:System.String"/> consisting of the elements of <paramref name="value"/>
12115 interspersed with the separator string.
12116 </returns>
12117 <remarks>
12118 <para>
12119 For example if <paramref name="separator"/> is ", " and the elements
12120 of <paramref name="value"/> are "apple", "orange", "grape", and "pear",
12121 <see cref="M:NAnt.Core.Util.StringUtils.Join(System.String,System.Collections.Specialized.StringCollection)"/> returns "apple, orange,
12122 grape, pear".
12123 </para>
12124 <para>
12125 If <paramref name="separator"/> is <see langword="null"/>, an empty
12126 string (<see cref="F:System.String.Empty"/>) is used instead.
12127 </para>
12128 </remarks>
12129 </member>
12130 <member name="M:NAnt.Core.Util.StringUtils.Clone(System.Collections.Specialized.StringCollection)">
12131 <summary>
12132 Creates a shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
12133 </summary>
12134 <param name="stringCollection">The <see cref="T:System.Collections.Specialized.StringCollection"/> that should be copied.</param>
12135 <returns>
12136 A shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
12137 </returns>
12138 </member>
12139 <member name="T:NAnt.Core.BuildException">
12140 <summary>
12141 Thrown whenever an error occurs during the build.
12142 </summary>
12143 </member>
12144 <member name="F:NAnt.Core.BuildException._location">
12145 <summary>
12146 The location of the exception in the build document (xml file).
12147 </summary>
12148 </member>
12149 <member name="M:NAnt.Core.BuildException.#ctor">
12150 <summary>
12151 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class.
12152 </summary>
12153 </member>
12154 <member name="M:NAnt.Core.BuildException.#ctor(System.String)">
12155 <summary>
12156 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12157 with a descriptive message.
12158 </summary>
12159 <param name="message">A descriptive message to include with the exception.</param>
12160 </member>
12161 <member name="M:NAnt.Core.BuildException.#ctor(System.String,System.Exception)">
12162 <summary>
12163 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12164 with the specified descriptive message and inner exception.
12165 </summary>
12166 <param name="message">A descriptive message to include with the exception.</param>
12167 <param name="innerException">A nested exception that is the cause of the current exception.</param>
12168 </member>
12169 <member name="M:NAnt.Core.BuildException.#ctor(System.String,NAnt.Core.Location)">
12170 <summary>
12171 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12172 with a descriptive message and the location in the build file that
12173 caused the exception.
12174 </summary>
12175 <param name="message">A descriptive message to include with the exception.</param>
12176 <param name="location">The location in the build file where the exception occured.</param>
12177 </member>
12178 <member name="M:NAnt.Core.BuildException.#ctor(System.String,NAnt.Core.Location,System.Exception)">
12179 <summary>
12180 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12181 with a descriptive message, the location in the build file and an
12182 instance of the exception that is the cause of the current exception.
12183 </summary>
12184 <param name="message">A descriptive message to include with the exception.</param>
12185 <param name="location">The location in the build file where the exception occured.</param>
12186 <param name="innerException">A nested exception that is the cause of the current exception.</param>
12187 </member>
12188 <member name="M:NAnt.Core.BuildException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
12189 <summary>
12190 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12191 with serialized data.
12192 </summary>
12193 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
12194 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
12195 </member>
12196 <member name="M:NAnt.Core.BuildException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
12197 <summary>
12198 Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
12199 </summary>
12200 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
12201 <param name="context">The destination for this serialization.</param>
12202 </member>
12203 <member name="M:NAnt.Core.BuildException.ToString">
12204 <summary>
12205 Creates and returns a string representation of the current
12206 exception.
12207 </summary>
12208 <returns>
12209 A string representation of the current exception.
12210 </returns>
12211 </member>
12212 <member name="P:NAnt.Core.BuildException.RawMessage">
12213 <summary>
12214 Gets the raw message as specified when the exception was
12215 constructed.
12216 </summary>
12217 <value>
12218 The raw message as specified when the exception was
12219 constructed.
12220 </value>
12221 </member>
12222 <member name="P:NAnt.Core.BuildException.Location">
12223 <summary>
12224 Gets the location in the build file of the element from which the
12225 exception originated.
12226 </summary>
12227 <value>
12228 The location in the build file of the element from which the
12229 exception originated.
12230 </value>
12231 </member>
12232 <member name="P:NAnt.Core.BuildException.Message">
12233 <summary>
12234 Gets a message that describes the current exception.
12235 </summary>
12236 <value>
12237 The error message that explains the reason for the exception.
12238 </value>
12239 <remarks>
12240 Adds location information to the message, if available.
12241 </remarks>
12242 </member>
12243 <member name="T:NAnt.Core.CommandLineOptions">
12244 <summary>
12245 Represents the set of command-line options supported by NAnt.
12246 </summary>
12247 </member>
12248 <member name="P:NAnt.Core.CommandLineOptions.TargetFramework">
12249 <summary>
12250 Gets or sets the target framework to use (overrides
12251 NAnt.exe.config settings)
12252 </summary>
12253 <value>
12254 The framework that should be used.
12255 </value>
12256 <remarks>
12257 For a list of possible frameworks, see NAnt.exe.config, possible
12258 values include "net-1.0", "net-1.1", etc.
12259 </remarks>
12260 </member>
12261 <member name="P:NAnt.Core.CommandLineOptions.DefaultFramework">
12262 <summary>
12263 Gets or sets the target framework to use (overrides
12264 NAnt.exe.config settings)
12265 </summary>
12266 <value>
12267 The framework that should be used.
12268 </value>
12269 <remarks>
12270 For a list of possible frameworks, see NAnt.exe.config, possible
12271 values include "net-1.0", "net-1.1", etc.
12272 </remarks>
12273 </member>
12274 <member name="P:NAnt.Core.CommandLineOptions.BuildFile">
12275 <summary>
12276 Gets or sets the buildfile that should be executed.
12277 </summary>
12278 <value>
12279 The buildfile that should be executed.
12280 </value>
12281 <remarks>
12282 Can be both a file or an URI.
12283 </remarks>
12284 </member>
12285 <member name="P:NAnt.Core.CommandLineOptions.Verbose">
12286 <summary>
12287 Gets or sets a value indicating whether more information should be
12288 displayed during the build process.
12289 </summary>
12290 <value>
12291 <see langword="true" /> if more information should be displayed;
12292 otherwise, <see langword="false" />. The default is <see langword="false" />.
12293 </value>
12294 </member>
12295 <member name="P:NAnt.Core.CommandLineOptions.Debug">
12296 <summary>
12297 Gets or sets a value indicating whether debug information should be
12298 displayed during the build process.
12299 </summary>
12300 <value>
12301 <see langword="true" /> if debug information should be displayed;
12302 otherwise, <see langword="false" />. The default is <see langword="false" />.
12303 </value>
12304 </member>
12305 <member name="P:NAnt.Core.CommandLineOptions.Quiet">
12306 <summary>
12307 Gets or sets a value indicating whether only error and debug debug messages should be
12308 displayed during the build process.
12309 </summary>
12310 <value>
12311 <see langword="true" /> if only error or warning messages should be
12312 displayed; otherwise, <see langword="false" />. The default is
12313 <see langword="false" />.
12314 </value>
12315 </member>
12316 <member name="P:NAnt.Core.CommandLineOptions.EmacsMode">
12317 <summary>
12318 Gets or sets a value indicating whether to produce emacs (and other
12319 editor) friendly output.
12320 </summary>
12321 <value>
12322 <see langword="true" /> if output is to be unadorned so that emacs
12323 and other editors can parse files names, etc. The default is
12324 <see langword="false" />.
12325 </value>
12326 </member>
12327 <member name="P:NAnt.Core.CommandLineOptions.FindInParent">
12328 <summary>
12329 Gets a value indicating whether parent directories should be searched
12330 for a buildfile.
12331 </summary>
12332 <value>
12333 <see langword="true" /> if parent directories should be searched for
12334 a build file; otherwise, <see langword="false" />. The default is
12335 <see langword="false" />.
12336 </value>
12337 </member>
12338 <member name="P:NAnt.Core.CommandLineOptions.IndentationLevel">
12339 <summary>
12340 Gets or sets the indentation level of the build output.
12341 </summary>
12342 <value>
12343 The indentation level of the build output. The default is <c>0</c>.
12344 </value>
12345 </member>
12346 <member name="P:NAnt.Core.CommandLineOptions.Properties">
12347 <summary>
12348 Gets or sets the list of properties that should be set.
12349 </summary>
12350 <value>
12351 The list of properties that should be set.
12352 </value>
12353 </member>
12354 <member name="P:NAnt.Core.CommandLineOptions.LoggerType">
12355 <summary>
12356 Gets or sets the <see cref="T:System.Type"/> of logger to add to the list
12357 of listeners.
12358 </summary>
12359 <value>
12360 The <see cref="T:System.Type"/> of logger to add to the list of
12361 listeners.
12362 </value>
12363 <remarks>
12364 The <see cref="P:NAnt.Core.CommandLineOptions.LoggerType"/> should derive from <see cref="T:NAnt.Core.IBuildLogger"/>.
12365 </remarks>
12366 </member>
12367 <member name="P:NAnt.Core.CommandLineOptions.LogFile">
12368 <summary>
12369 Gets or sets the name of the file to log output to.
12370 </summary>
12371 <value>
12372 The name of the file to log output to.
12373 </value>
12374 </member>
12375 <member name="P:NAnt.Core.CommandLineOptions.Listeners">
12376 <summary>
12377 Gets a collection containing fully qualified type names of classes
12378 implementating <see cref="T:NAnt.Core.IBuildListener"/> that should be added
12379 to the project as listeners.
12380 </summary>
12381 <value>
12382 A collection of fully qualified type names that should be added as
12383 listeners to the <see cref="T:NAnt.Core.Project"/>.
12384 </value>
12385 </member>
12386 <member name="P:NAnt.Core.CommandLineOptions.ExtensionAssemblies">
12387 <summary>
12388 Gets a collection of assemblies to load extensions from.
12389 </summary>
12390 <value>
12391 A collection of assemblies to load extensions from.
12392 </value>
12393 </member>
12394 <member name="P:NAnt.Core.CommandLineOptions.ShowProjectHelp">
12395 <summary>
12396 Gets or sets a value indicating whether <see cref="T:NAnt.Core.Project"/> help
12397 should be printed.
12398 </summary>
12399 <value>
12400 <see langword="true"/> if <see cref="T:NAnt.Core.Project"/> help should be
12401 printed; otherwise, <see langword="false"/>. The default is
12402 <see langword="false"/>.
12403 </value>
12404 </member>
12405 <member name="P:NAnt.Core.CommandLineOptions.NoLogo">
12406 <summary>
12407 Gets or sets a value indicating whether the logo banner should be
12408 printed.
12409 </summary>
12410 <value>
12411 <see langword="true" /> if the logo banner should be printed; otherwise,
12412 <see langword="false" />. The default is <see langword="false" />.
12413 </value>
12414 </member>
12415 <member name="P:NAnt.Core.CommandLineOptions.ShowHelp">
12416 <summary>
12417 Gets or sets a value indicating whether the NAnt help should be
12418 printed.
12419 </summary>
12420 <value>
12421 <see langword="true" /> if NAnt help should be printed; otherwise,
12422 <see langword="false" />. The default is <see langword="false" />.
12423 </value>
12424 </member>
12425 <member name="P:NAnt.Core.CommandLineOptions.Targets">
12426 <summary>
12427 Gets a collection containing the targets that should be executed.
12428 </summary>
12429 <value>
12430 A collection that contains the targets that should be executed.
12431 </value>
12432 </member>
12433 <member name="T:NAnt.Core.ConfigurationSection">
12434 <summary>
12435 Custom configuration section handler for the <nantsettings/> element.
12436 </summary>
12437 </member>
12438 <member name="M:NAnt.Core.ConfigurationSection.Create(System.Object,System.Object,System.Xml.XmlNode)">
12439 <summary>
12440 This just passed things through. Return the node read from the config file.
12441 </summary>
12442 </member>
12443 <member name="T:NAnt.Core.ConsoleDriver">
12444 <summary>
12445 Main entry point to NAnt that is called by the ConsoleStub.
12446 </summary>
12447 </member>
12448 <member name="M:NAnt.Core.ConsoleDriver.Main(System.String[])">
12449 <summary>
12450 Starts NAnt. This is the Main entry point.
12451 </summary>
12452 <param name="args">Command Line args, or whatever you want to pass it. They will treated as Command Line args.</param>
12453 <returns>
12454 The exit code.
12455 </returns>
12456 </member>
12457 <member name="M:NAnt.Core.ConsoleDriver.ShowProjectHelp(System.Xml.XmlDocument)">
12458 <summary>
12459 Prints the projecthelp to the console.
12460 </summary>
12461 <param name="buildDoc">The build file to show help for.</param>
12462 <remarks>
12463 <paramref name="buildDoc" /> is loaded and transformed with
12464 <c>ProjectHelp.xslt</c>, which is an embedded resource.
12465 </remarks>
12466 </member>
12467 <member name="M:NAnt.Core.ConsoleDriver.GetBuildFileName(System.String,System.String,System.Boolean)">
12468 <summary>
12469 Gets the file name for the build file in the specified directory.
12470 </summary>
12471 <param name="directory">The directory to look for a build file. When in doubt use Environment.CurrentDirectory for directory.</param>
12472 <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>
12473 <param name="findInParent">Whether or not to search the parent directories for a build file.</param>
12474 <returns>The path to the build file or <c>null</c> if no build file could be found.</returns>
12475 </member>
12476 <member name="M:NAnt.Core.ConsoleDriver.LoadExtensionAssemblies(System.Collections.Specialized.StringCollection,NAnt.Core.Project)">
12477 <summary>
12478 Loads the extension assemblies in the current <see cref="T:System.AppDomain"/>
12479 and scans them for extensions.
12480 </summary>
12481 <param name="extensionAssemblies">The extension assemblies to load.</param>
12482 <param name="project">The <see cref="T:NAnt.Core.Project"/> which will be used to output messages to the build log.</param>
12483 </member>
12484 <member name="M:NAnt.Core.ConsoleDriver.CreateLogger(System.String)">
12485 <summary>
12486 Dynamically constructs an <see cref="T:NAnt.Core.IBuildLogger"/> instance of
12487 the class specified.
12488 </summary>
12489 <remarks>
12490 <para>
12491 At this point, only looks in the assembly where <see cref="T:NAnt.Core.IBuildLogger"/>
12492 is defined.
12493 </para>
12494 </remarks>
12495 <param name="typeName">The fully qualified name of the logger that should be instantiated.</param>
12496 <exception cref="T:System.TypeLoadException">Type <paramref name="typeName"/> could not be loaded.</exception>
12497 <exception cref="T:System.ArgumentException"><paramref name="typeName"/> does not implement <see cref="T:NAnt.Core.IBuildLogger"/>.</exception>
12498 </member>
12499 <member name="M:NAnt.Core.ConsoleDriver.CreateListener(System.String)">
12500 <summary>
12501 Dynamically constructs an <see cref="T:NAnt.Core.IBuildListener"/> instance of
12502 the class specified.
12503 </summary>
12504 <remarks>
12505 <para>
12506 At this point, only looks in the assembly where <see cref="T:NAnt.Core.IBuildListener"/>
12507 is defined.
12508 </para>
12509 </remarks>
12510 <param name="typeName">The fully qualified name of the listener that should be instantiated.</param>
12511 <exception cref="T:System.TypeLoadException">Type <paramref name="typeName"/> could not be loaded.</exception>
12512 <exception cref="T:System.ArgumentException"><paramref name="typeName"/> does not implement <see cref="T:NAnt.Core.IBuildListener"/>.</exception>
12513 </member>
12514 <member name="M:NAnt.Core.ConsoleDriver.AddBuildListeners(NAnt.Core.CommandLineOptions,NAnt.Core.Project)">
12515 <summary>
12516 Add the listeners specified in the command line arguments,
12517 along with the default listener, to the specified project.
12518 </summary>
12519 <param name="cmdlineOptions">The command-line options.</param>
12520 <param name="project">The <see cref="T:NAnt.Core.Project"/> to add listeners to.</param>
12521 </member>
12522 <member name="M:NAnt.Core.ConsoleDriver.ShowHelp(NAnt.Core.Util.CommandLineParser)">
12523 <summary>
12524 Spits out generic help info to the console.
12525 </summary>
12526 </member>
12527 <member name="M:NAnt.Core.ConsoleDriver.WriteException(System.Exception)">
12528 <summary>
12529 Write the message of the specified <see cref="T:System.Exception"/> and
12530 the inner exceptions to <see cref="P:System.Console.Error"/>.
12531 </summary>
12532 <param name="cause">The <see cref="T:System.Exception"/> to write to <see cref="P:System.Console.Error"/>.</param>
12533 </member>
12534 <member name="M:NAnt.Core.DataTypeBaseBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
12535 <summary>
12536 Creates a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
12537 class for the specified <see cref="T:NAnt.Core.DataTypeBase"/> class in the
12538 <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> specified.
12539 </summary>
12540 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.DataTypeBase"/>.</param>
12541 <param name="className">The class representing the <see cref="T:NAnt.Core.DataTypeBase"/>.</param>
12542 </member>
12543 <member name="P:NAnt.Core.DataTypeBaseBuilder.ClassName">
12544 <summary>
12545 Gets the name of the <see cref="T:NAnt.Core.DataTypeBase"/> class that can be
12546 created using this <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>.
12547 </summary>
12548 <value>
12549 The name of the <see cref="T:NAnt.Core.DataTypeBase"/> class that can be created
12550 using this <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>.
12551 </value>
12552 </member>
12553 <member name="P:NAnt.Core.DataTypeBaseBuilder.DataTypeName">
12554 <summary>
12555 Gets the name of the data type which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
12556 can create.
12557 </summary>
12558 <value>
12559 The name of the data type which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
12560 can create.
12561 </value>
12562 </member>
12563 <member name="T:NAnt.Core.DataTypeBaseBuilderCollection">
12564 <summary>
12565 Contains a strongly typed collection of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> objects.
12566 </summary>
12567 </member>
12568 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor">
12569 <summary>
12570 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class.
12571 </summary>
12572 </member>
12573 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor(NAnt.Core.DataTypeBaseBuilderCollection)">
12574 <summary>
12575 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class
12576 with the specified <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> instance.
12577 </summary>
12578 </member>
12579 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor(NAnt.Core.DataTypeBaseBuilder[])">
12580 <summary>
12581 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class
12582 with the specified array of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
12583 </summary>
12584 </member>
12585 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Add(NAnt.Core.DataTypeBaseBuilder)">
12586 <summary>
12587 Adds a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to the end of the collection.
12588 </summary>
12589 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to be added to the end of the collection.</param>
12590 <returns>The position into which the new element was inserted.</returns>
12591 </member>
12592 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.AddRange(NAnt.Core.DataTypeBaseBuilder[])">
12593 <summary>
12594 Adds the elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> array to the end of the collection.
12595 </summary>
12596 <param name="items">The array of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> elements to be added to the end of the collection.</param>
12597 </member>
12598 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.AddRange(NAnt.Core.DataTypeBaseBuilderCollection)">
12599 <summary>
12600 Adds the elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> to the end of the collection.
12601 </summary>
12602 <param name="items">The <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> to be added to the end of the collection.</param>
12603 </member>
12604 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Contains(NAnt.Core.DataTypeBaseBuilder)">
12605 <summary>
12606 Determines whether a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> is in the collection.
12607 </summary>
12608 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to locate in the collection.</param>
12609 <returns>
12610 <see langword="true"/> if <paramref name="item"/> is found in the
12611 collection; otherwise, <see langword="false"/>.
12612 </returns>
12613 </member>
12614 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Contains(System.String)">
12615 <summary>
12616 Determines whether a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for the specified
12617 task is in the collection.
12618 </summary>
12619 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> should be located in the collection.</param>
12620 <returns>
12621 <see langword="true"/> if a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for
12622 the specified task is found in the collection; otherwise,
12623 <see langword="false"/>.
12624 </returns>
12625 </member>
12626 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.CopyTo(NAnt.Core.DataTypeBaseBuilder[],System.Int32)">
12627 <summary>
12628 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
12629 </summary>
12630 <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>
12631 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
12632 </member>
12633 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.IndexOf(NAnt.Core.DataTypeBaseBuilder)">
12634 <summary>
12635 Retrieves the index of a specified <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> object in the collection.
12636 </summary>
12637 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> object for which the index is returned.</param>
12638 <returns>
12639 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.
12640 </returns>
12641 </member>
12642 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Insert(System.Int32,NAnt.Core.DataTypeBaseBuilder)">
12643 <summary>
12644 Inserts a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> into the collection at the specified index.
12645 </summary>
12646 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
12647 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to insert.</param>
12648 </member>
12649 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.GetEnumerator">
12650 <summary>
12651 Returns an enumerator that can iterate through the collection.
12652 </summary>
12653 <returns>
12654 A <see cref="T:NAnt.Core.DataTypeBaseBuilderEnumerator"/> for the entire collection.
12655 </returns>
12656 </member>
12657 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Remove(NAnt.Core.DataTypeBaseBuilder)">
12658 <summary>
12659 Removes a member from the collection.
12660 </summary>
12661 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to remove from the collection.</param>
12662 </member>
12663 <member name="P:NAnt.Core.DataTypeBaseBuilderCollection.Item(System.Int32)">
12664 <summary>
12665 Gets or sets the element at the specified index.
12666 </summary>
12667 <param name="index">The zero-based index of the element to get or set.</param>
12668 </member>
12669 <member name="P:NAnt.Core.DataTypeBaseBuilderCollection.Item(System.String)">
12670 <summary>
12671 Gets the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for the specified task.
12672 </summary>
12673 <param name="dataTypeName">The name of task for which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> should be located in the collection.</param>
12674 </member>
12675 <member name="T:NAnt.Core.DataTypeBaseBuilderEnumerator">
12676 <summary>
12677 Enumerates the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/>.
12678 </summary>
12679 </member>
12680 <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.#ctor(NAnt.Core.DataTypeBaseBuilderCollection)">
12681 <summary>
12682 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderEnumerator"/> class
12683 with the specified <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/>.
12684 </summary>
12685 <param name="arguments">The collection that should be enumerated.</param>
12686 </member>
12687 <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.MoveNext">
12688 <summary>
12689 Advances the enumerator to the next element of the collection.
12690 </summary>
12691 <returns>
12692 <see langword="true" /> if the enumerator was successfully advanced
12693 to the next element; <see langword="false" /> if the enumerator has
12694 passed the end of the collection.
12695 </returns>
12696 </member>
12697 <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.Reset">
12698 <summary>
12699 Sets the enumerator to its initial position, which is before the
12700 first element in the collection.
12701 </summary>
12702 </member>
12703 <member name="P:NAnt.Core.DataTypeBaseBuilderEnumerator.Current">
12704 <summary>
12705 Gets the current element in the collection.
12706 </summary>
12707 <returns>
12708 The current element in the collection.
12709 </returns>
12710 </member>
12711 <member name="M:NAnt.Core.DataTypeBaseDictionary.#ctor">
12712 <summary>
12713 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseDictionary"/> class.
12714 </summary>
12715 </member>
12716 <member name="M:NAnt.Core.DataTypeBaseDictionary.#ctor(System.Int32)">
12717 <summary>
12718 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseDictionary"/> class
12719 with the specified capacity.
12720 </summary>
12721 </member>
12722 <member name="M:NAnt.Core.DataTypeBaseDictionary.Inherit(NAnt.Core.DataTypeBaseDictionary)">
12723 <summary>
12724 Inherits Properties from an existing property
12725 dictionary Instance
12726 </summary>
12727 <param name="source">DataType list to inherit</param>
12728 </member>
12729 <member name="T:NAnt.Core.DirectoryScanner">
12730 <summary>
12731 Used for searching filesystem based on given include/exclude rules.
12732 </summary>
12733 <example>
12734 <para>Simple client code for testing the class.</para>
12735 <code>
12736 while (true) {
12737 DirectoryScanner scanner = new DirectoryScanner();
12738 Console.Write("Scan Basedirectory : ");
12739 string s = Console.ReadLine();
12740 if (s.Length == 0) break;
12741 scanner.BaseDirectory = s;
12742 while(true) {
12743 Console.Write("Include pattern : ");
12744 s = Console.ReadLine();
12745 if (s.Length == 0) break;
12746 scanner.Includes.Add(s);
12747 }
12748 while(true) {
12749 Console.Write("Exclude pattern : ");
12750 s = Console.ReadLine();
12751 if (s.Length == 0) break;
12752 scanner.Excludes.Add(s);
12753 }
12754 foreach (string name in scanner.FileNames)
12755 Console.WriteLine("file:" + name);
12756 foreach (string name in scanner.DirectoryNames)
12757 Console.WriteLine("dir :" + name);
12758 Console.WriteLine("");
12759 }
12760 </code>
12761 </example>
12762 </member>
12763 <member name="M:NAnt.Core.DirectoryScanner.#ctor">
12764 <summary>
12765 Initializes a new instance of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
12766 </summary>
12767 <remarks>
12768 On unix, patterns are matching case-sensitively; otherwise, they
12769 are matched case-insensitively.
12770 </remarks>
12771 </member>
12772 <member name="M:NAnt.Core.DirectoryScanner.#ctor(System.Boolean)">
12773 <summary>
12774 Initializes a new instance of the <see cref="T:NAnt.Core.DirectoryScanner"/>
12775 specifying whether patterns are to be match case-sensitively.
12776 </summary>
12777 <param name="caseSensitive">Specifies whether patterns are to be matched case-sensititely.</param>
12778 </member>
12779 <member name="M:NAnt.Core.DirectoryScanner.Clone">
12780 <summary>
12781 Creates a shallow copy of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
12782 </summary>
12783 <returns>
12784 A shallow copy of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
12785 </returns>
12786 </member>
12787 <member name="M:NAnt.Core.DirectoryScanner.Scan">
12788 <summary>
12789 Uses <see cref="P:NAnt.Core.DirectoryScanner.Includes"/> and <see cref="P:NAnt.Core.DirectoryScanner.Excludes"/> search criteria (relative to
12790 <see cref="P:NAnt.Core.DirectoryScanner.BaseDirectory"/> or absolute), to search for filesystem objects.
12791 </summary>
12792 </member>
12793 <member name="M:NAnt.Core.DirectoryScanner.ConvertPatterns(System.Collections.Specialized.StringCollection,System.Collections.ArrayList,System.Collections.Specialized.StringCollection,System.Boolean)">
12794 <summary>
12795 Parses specified NAnt search patterns for search directories and
12796 corresponding regex patterns.
12797 </summary>
12798 <param name="nantPatterns">In. NAnt patterns. Absolute or relative paths.</param>
12799 <param name="regexPatterns">Out. Regex patterns. Absolute canonical paths.</param>
12800 <param name="nonRegexFiles">Out. Non-regex files. Absolute canonical paths.</param>
12801 <param name="addSearchDirectories">In. Whether to allow a pattern to add search directories.</param>
12802 </member>
12803 <member name="M:NAnt.Core.DirectoryScanner.ParseSearchDirectoryAndPattern(System.Boolean,System.String,System.String@,System.Boolean@,System.Boolean@,System.String@)">
12804 <summary>
12805 Given a NAnt search pattern returns a search directory and an regex
12806 search pattern.
12807 </summary>
12808 <param name="isInclude">Whether this pattern is an include or exclude pattern</param>
12809 <param name="originalNAntPattern">NAnt searh pattern (relative to the Basedirectory OR absolute, relative paths refering to parent directories ( ../ ) also supported)</param>
12810 <param name="searchDirectory">Out. Absolute canonical path to the directory to be searched</param>
12811 <param name="recursive">Out. Whether the pattern is potentially recursive or not</param>
12812 <param name="isRegex">Out. Whether this is a regex pattern or not</param>
12813 <param name="regexPattern">Out. Regex search pattern (absolute canonical path)</param>
12814 </member>
12815 <member name="M:NAnt.Core.DirectoryScanner.ScanDirectory(System.String,System.Boolean)">
12816 <summary>
12817 Searches a directory recursively for files and directories matching
12818 the search criteria.
12819 </summary>
12820 <param name="path">Directory in which to search (absolute canonical path)</param>
12821 <param name="recursive">Whether to scan recursively or not</param>
12822 </member>
12823 <member name="M:NAnt.Core.DirectoryScanner.ToRegexPattern(System.String)">
12824 <summary>
12825 Converts search pattern to a regular expression pattern.
12826 </summary>
12827 <param name="nantPattern">Search pattern relative to the search directory.</param>
12828 <returns>Regular expresssion</returns>
12829 </member>
12830 <member name="P:NAnt.Core.DirectoryScanner.CaseSensitive">
12831 <summary>
12832 Gets or set a value indicating whether or not to use case-sensitive
12833 pattern matching.
12834 </summary>
12835 </member>
12836 <member name="P:NAnt.Core.DirectoryScanner.Includes">
12837 <summary>
12838 Gets the collection of include patterns.
12839 </summary>
12840 </member>
12841 <member name="P:NAnt.Core.DirectoryScanner.Excludes">
12842 <summary>
12843 Gets the collection of exclude patterns.
12844 </summary>
12845 </member>
12846 <member name="P:NAnt.Core.DirectoryScanner.BaseDirectory">
12847 <summary>
12848 The base directory to scan. The default is the
12849 <see cref="P:System.Environment.CurrentDirectory">current directory</see>.
12850 </summary>
12851 </member>
12852 <member name="P:NAnt.Core.DirectoryScanner.FileNames">
12853 <summary>
12854 Gets the list of files that match the given patterns.
12855 </summary>
12856 </member>
12857 <member name="P:NAnt.Core.DirectoryScanner.DirectoryNames">
12858 <summary>
12859 Gets the list of directories that match the given patterns.
12860 </summary>
12861 </member>
12862 <member name="P:NAnt.Core.DirectoryScanner.ScannedDirectories">
12863 <summary>
12864 Gets the list of directories that were scanned for files.
12865 </summary>
12866 </member>
12867 <member name="M:NAnt.Core.StringCollectionWithGoodToString.Clone">
12868 <summary>
12869 Creates a shallow copy of the <see cref="T:NAnt.Core.StringCollectionWithGoodToString"/>.
12870 </summary>
12871 <returns>
12872 A shallow copy of the <see cref="T:NAnt.Core.StringCollectionWithGoodToString"/>.
12873 </returns>
12874 </member>
12875 <member name="M:NAnt.Core.StringCollectionWithGoodToString.ToString">
12876 <summary>
12877 Creates a string representing a list of the strings in the collection.
12878 </summary>
12879 <returns>
12880 A string that represents the contents.
12881 </returns>
12882 </member>
12883 <member name="M:NAnt.Core.DirScannerStringCollection.#ctor(System.Boolean)">
12884 <summary>
12885 Initialize a new instance of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
12886 class specifying whether or not string comparison should be
12887 case-sensitive.
12888 </summary>
12889 <param name="caseSensitive">Specifies whether or not string comparison should be case-sensitive.</param>
12890 </member>
12891 <member name="M:NAnt.Core.DirScannerStringCollection.Clone">
12892 <summary>
12893 Creates a shallow copy of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
12894 </summary>
12895 <returns>
12896 A shallow copy of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
12897 </returns>
12898 </member>
12899 <member name="M:NAnt.Core.DirScannerStringCollection.Contains(System.String)">
12900 <summary>
12901 Determines whether the specified string is in the
12902 <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
12903 </summary>
12904 <param name="value">The string to locate in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>. The value can be <see langword="null"/>.</param>
12905 <returns>
12906 <seee langword="true"/> if value is found in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>; otherwise, <see langword="false"/>.
12907 </returns>
12908 <remarks>
12909 String comparisons within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
12910 are only case-sensitive if <see cref="P:NAnt.Core.DirScannerStringCollection.CaseSensitive"/> is
12911 <see langword="true"/>
12912 </remarks>
12913 </member>
12914 <member name="M:NAnt.Core.DirScannerStringCollection.IndexOf(System.String)">
12915 <summary>
12916 Searches for the specified string and returns the zero-based index
12917 of the first occurrence within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
12918 </summary>
12919 <param name="value">The string to locate. The value can be <see langword="null"/>.</param>
12920 <returns>
12921 The zero-based index of the first occurrence of <paramref name="value"/>
12922 in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>, if found; otherwise, -1.
12923 </returns>
12924 <remarks>
12925 String comparisons within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
12926 are only case-sensitive if <see cref="P:NAnt.Core.DirScannerStringCollection.CaseSensitive"/> is
12927 <see langword="true"/>.
12928 </remarks>
12929 </member>
12930 <member name="P:NAnt.Core.DirScannerStringCollection.CaseSensitive">
12931 <summary>
12932 Gets a value indicating whether string comparison is case-sensitive.
12933 </summary>
12934 <value>
12935 A value indicating whether string comparison is case-sensitive.
12936 </value>
12937 </member>
12938 <member name="M:NAnt.Core.ExpressionEvaluator.GetPropertyValue(System.String)">
12939 <summary>
12940 Gets the value of the specified property.
12941 </summary>
12942 <param name="propertyName">The name of the property to get the value of.</param>
12943 <returns>
12944 The value of the specified property.
12945 </returns>
12946 </member>
12947 <member name="T:NAnt.Core.ExpressionTokenizer">
12948 <summary>
12949 Splits an input string into a sequence of tokens used during parsing.
12950 </summary>
12951 </member>
12952 <member name="T:NAnt.Core.ExpressionTokenizer.TokenType">
12953 <summary>
12954 Available tokens
12955 </summary>
12956 </member>
12957 <member name="T:NAnt.Core.FrameworkInfo">
12958 <summary>
12959 Encalsulates information about installed frameworks incuding version
12960 information and directory locations for finding tools.
12961 </summary>
12962 </member>
12963 <member name="M:NAnt.Core.FrameworkInfo.ResolveAssembly(System.String)">
12964 <summary>
12965 Resolves the specified assembly to a full path by matching it
12966 against the reference assemblies.
12967 </summary>
12968 <param name="fileName">The file name of the assembly to resolve (without path information).</param>
12969 <returns>
12970 An absolute path to the assembly, or <see langword="null" /> if the
12971 assembly could not be found or no reference assemblies are configured
12972 for the current framework.
12973 </returns>
12974 <remarks>
12975 Whether the file name is matched case-sensitively depends on the
12976 operating system.
12977 </remarks>
12978 </member>
12979 <member name="M:NAnt.Core.FrameworkInfo.GetToolPath(System.String)">
12980 <summary>
12981 Searches the list of tool paths of the current framework for the
12982 given file, and returns the absolute path if found.
12983 </summary>
12984 <param name="tool">The file name of the tool to search for.</param>
12985 <returns>
12986 The absolute path to <paramref name="tool"/> if found in one of the
12987 configured tool paths; otherwise, <see langword="null"/>.
12988 </returns>
12989 <exception cref="T:System.ArgumentNullException"><paramref name="tool"/> is <see langword="null"/>.</exception>
12990 <remarks>
12991 <para>
12992 The configured tool paths are scanned in the order in which they
12993 are defined in the framework configuration.
12994 </para>
12995 <para>
12996 The file name of the tool to search should include the extension.
12997 </para>
12998 </remarks>
12999 </member>
13000 <member name="M:NAnt.Core.FrameworkInfo.GetXmlAttributeValue(System.Xml.XmlNode,System.String)">
13001 <summary>
13002 Gets the value of the specified attribute from the specified node.
13003 </summary>
13004 <param name="xmlNode">The node of which the attribute value should be retrieved.</param>
13005 <param name="attributeName">The attribute of which the value should be returned.</param>
13006 <returns>
13007 The value of the attribute with the specified name or <see langword="null" />
13008 if the attribute does not exist or has no value.
13009 </returns>
13010 </member>
13011 <member name="P:NAnt.Core.FrameworkInfo.Name">
13012 <summary>
13013 Gets the name of the framework.
13014 </summary>
13015 <value>
13016 The name of the framework.
13017 </value>
13018 </member>
13019 <member name="P:NAnt.Core.FrameworkInfo.Family">
13020 <summary>
13021 Gets the family of the framework.
13022 </summary>
13023 <value>
13024 The family of the framework.
13025 </value>
13026 </member>
13027 <member name="P:NAnt.Core.FrameworkInfo.Description">
13028 <summary>
13029 Gets the description of the framework.
13030 </summary>
13031 <value>
13032 The description of the framework.
13033 </value>
13034 </member>
13035 <member name="P:NAnt.Core.FrameworkInfo.Version">
13036 <summary>
13037 Gets the version of the framework.
13038 </summary>
13039 <value>
13040 The version of the framework.
13041 </value>
13042 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13043 <remarks>
13044 When <see cref="P:NAnt.Core.FrameworkInfo.Version"/> is not configured, the framework is not
13045 considered valid.
13046 </remarks>
13047 </member>
13048 <member name="P:NAnt.Core.FrameworkInfo.ClrVersion">
13049 <summary>
13050 Gets the Common Language Runtime version of the framework.
13051 </summary>
13052 <value>
13053 The Common Language Runtime version of the framework.
13054 </value>
13055 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13056 <remarks>
13057 When <see cref="P:NAnt.Core.FrameworkInfo.ClrVersion"/> is <see langword="null"/>, the
13058 framework is not considered valid.
13059 </remarks>
13060 </member>
13061 <member name="P:NAnt.Core.FrameworkInfo.ClrType">
13062 <summary>
13063 Gets the CLR type of the framework.
13064 </summary>
13065 <value>
13066 The CLR type of the framework.
13067 </value>
13068 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13069 </member>
13070 <member name="P:NAnt.Core.FrameworkInfo.VisualStudioVersion">
13071 <summary>
13072 Gets the Visual Studio version that corresponds with this
13073 framework.
13074 </summary>
13075 <value>
13076 The Visual Studio version that corresponds with this framework.
13077 </value>
13078 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13079 <exception cref="T:NAnt.Core.BuildException">There is no version of Visual Studio that corresponds with this framework.</exception>
13080 </member>
13081 <member name="P:NAnt.Core.FrameworkInfo.FrameworkDirectory">
13082 <summary>
13083 Gets the base directory of the framework tools for the framework.
13084 </summary>
13085 <value>
13086 The base directory of the framework tools for the framework.
13087 </value>
13088 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13089 </member>
13090 <member name="P:NAnt.Core.FrameworkInfo.Runtime">
13091 <summary>
13092 Gets the runtime information for this framework.
13093 </summary>
13094 <value>
13095 The runtime information for the framework or <see langword="null"/>
13096 if no runtime information is configured for the framework.
13097 </value>
13098 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13099 </member>
13100 <member name="P:NAnt.Core.FrameworkInfo.FrameworkAssemblyDirectory">
13101 <summary>
13102 Gets the directory where the system assemblies for the framework
13103 are located.
13104 </summary>
13105 <value>
13106 The directory where the system assemblies for the framework are
13107 located.
13108 </value>
13109 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13110 </member>
13111 <member name="P:NAnt.Core.FrameworkInfo.SdkDirectory">
13112 <summary>
13113 Gets the directory containing the SDK tools for the framework.
13114 </summary>
13115 <value>
13116 The directory containing the SDK tools for the framework or a null
13117 reference if the configured sdk directory does not exist, or is not
13118 valid.
13119 </value>
13120 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13121 </member>
13122 <member name="P:NAnt.Core.FrameworkInfo.Project">
13123 <summary>
13124 Gets the <see cref="P:NAnt.Core.FrameworkInfo.Project"/> used to initialize this framework.
13125 </summary>
13126 <value>
13127 The <see cref="P:NAnt.Core.FrameworkInfo.Project"/> used to initialize this framework.
13128 </value>
13129 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13130 </member>
13131 <member name="P:NAnt.Core.FrameworkInfo.TaskAssemblies">
13132 <summary>
13133 Gets the set of assemblies and directories that should scanned for
13134 NAnt tasks, types or functions.
13135 </summary>
13136 <value>
13137 The set of assemblies and directories that should be scanned for
13138 NAnt tasks, types or functions.
13139 </value>
13140 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13141 </member>
13142 <member name="P:NAnt.Core.FrameworkInfo.IsValid">
13143 <summary>
13144 Returns a value indicating whether the current framework is valid.
13145 </summary>
13146 <value>
13147 <see langword="true" /> if the framework is installed and correctly
13148 configured; otherwise, <see langword="false" />.
13149 </value>
13150 </member>
13151 <member name="P:NAnt.Core.FrameworkInfo.ReferenceAssemblies">
13152 <summary>
13153 Gets the reference assemblies for the current framework.
13154 </summary>
13155 <value>
13156 The reference assemblies for the current framework.
13157 </value>
13158 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13159 </member>
13160 <member name="P:NAnt.Core.FrameworkInfo.ToolPaths">
13161 <summary>
13162 Gets the tool paths for the current framework.
13163 </summary>
13164 <value>
13165 The tool paths for the current framework.
13166 </value>
13167 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13168 </member>
13169 <member name="P:NAnt.Core.FrameworkInfo.NamespaceManager">
13170 <summary>
13171 Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
13172 </summary>
13173 <value>
13174 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
13175 </value>
13176 <remarks>
13177 The <see cref="P:NAnt.Core.FrameworkInfo.NamespaceManager"/> defines the current namespace
13178 scope and provides methods for looking up namespace information.
13179 </remarks>
13180 </member>
13181 <member name="M:NAnt.Core.FrameworkInfoDictionary.#ctor">
13182 <summary>
13183 Initializes a new instance of the <see cref="T:NAnt.Core.FrameworkInfoDictionary"/> class.
13184 </summary>
13185 </member>
13186 <member name="M:NAnt.Core.FrameworkInfoDictionary.#ctor(System.Int32)">
13187 <summary>
13188 Initializes a new instance of the <see cref="T:NAnt.Core.FrameworkInfoDictionary"/> class
13189 with the specified capacity.
13190 </summary>
13191 </member>
13192 <member name="T:NAnt.Core.FrameworkTypes">
13193 <summary>
13194 Defines the types of frameworks.
13195 </summary>
13196 </member>
13197 <member name="F:NAnt.Core.FrameworkTypes.NotInstalled">
13198 <summary>
13199 Frameworks that are supported on the current platform, but are not
13200 installed.
13201 </summary>
13202 </member>
13203 <member name="F:NAnt.Core.FrameworkTypes.Installed">
13204 <summary>
13205 Frameworks that are installed on the current system.
13206 </summary>
13207 </member>
13208 <member name="F:NAnt.Core.FrameworkTypes.InstallStateMask">
13209 <summary>
13210 Retrieves installation state attributes.
13211 </summary>
13212 </member>
13213 <member name="F:NAnt.Core.FrameworkTypes.Desktop">
13214 <summary>
13215 Frameworks that typically target full desktop devices.
13216 </summary>
13217 </member>
13218 <member name="F:NAnt.Core.FrameworkTypes.Compact">
13219 <summary>
13220 Frameworks that target compact devices.
13221 </summary>
13222 </member>
13223 <member name="F:NAnt.Core.FrameworkTypes.Browser">
13224 <summary>
13225 Frameworks that run in a browser.
13226 </summary>
13227 </member>
13228 <member name="F:NAnt.Core.FrameworkTypes.DeviceMask">
13229 <summary>
13230 Retrieves device attributes.
13231 </summary>
13232 </member>
13233 <member name="F:NAnt.Core.FrameworkTypes.Mono">
13234 <summary>
13235 Frameworks released as part of the open-source <see href="http://www.mono-project.com">Mono</see>
13236 project.
13237 </summary>
13238 </member>
13239 <member name="F:NAnt.Core.FrameworkTypes.MS">
13240 <summary>
13241 Frameworks released by Microsoft.
13242 </summary>
13243 </member>
13244 <member name="F:NAnt.Core.FrameworkTypes.VendorMask">
13245 <summary>
13246 Retrieves vendor attributes.
13247 </summary>
13248 </member>
13249 <member name="F:NAnt.Core.FrameworkTypes.All">
13250 <summary>
13251 All frameworks supported on the current platform, regarless of their
13252 installation state, target device or vendor.
13253 </summary>
13254 </member>
13255 <member name="T:NAnt.Core.Location">
13256 <summary>
13257 Stores the file name, line number and column number to record a position
13258 in a text file.
13259 </summary>
13260 </member>
13261 <member name="M:NAnt.Core.Location.#ctor(System.String,System.Int32,System.Int32)">
13262 <summary>
13263 Creates a location consisting of a file name, line number and
13264 column number.
13265 </summary>
13266 <remarks>
13267 <paramref name="fileName" /> can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt.
13268 </remarks>
13269 </member>
13270 <member name="M:NAnt.Core.Location.#ctor(System.String)">
13271 <summary>
13272 Creates a location consisting of a file name.
13273 </summary>
13274 <remarks>
13275 <paramref name="fileName" /> can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt.
13276 </remarks>
13277 </member>
13278 <member name="M:NAnt.Core.Location.#ctor">
13279 <summary>
13280 Creates an "unknown" location.
13281 </summary>
13282 </member>
13283 <member name="M:NAnt.Core.Location.Init(System.String,System.Int32,System.Int32)">
13284 <summary>Private Init function.</summary>
13285 </member>
13286 <member name="M:NAnt.Core.Location.ToString">
13287 <summary>
13288 Returns the file name, line number and a trailing space. An error
13289 message can be appended easily. For unknown locations, returns
13290 an empty string.
13291 </summary>
13292 </member>
13293 <member name="P:NAnt.Core.Location.FileName">
13294 <summary>
13295 Gets a string containing the file name for the location.
13296 </summary>
13297 <remarks>
13298 The file name includes both the file path and the extension.
13299 </remarks>
13300 </member>
13301 <member name="P:NAnt.Core.Location.LineNumber">
13302 <summary>
13303 Gets the line number for the location.
13304 </summary>
13305 <remarks>
13306 Lines start at 1. Will be zero if not specified.
13307 </remarks>
13308 </member>
13309 <member name="P:NAnt.Core.Location.ColumnNumber">
13310 <summary>
13311 Gets the column number for the location.
13312 </summary>
13313 <remarks>
13314 Columns start a 1. Will be zero if not specified.
13315 </remarks>
13316 </member>
13317 <member name="T:NAnt.Core.LocationMap">
13318 <summary>
13319 Maps XML nodes to the text positions from their original source.
13320 </summary>
13321 </member>
13322 <member name="M:NAnt.Core.LocationMap.#ctor">
13323 <summary>
13324 Initializes a new instance of the <see cref="T:NAnt.Core.LocationMap"/> class.
13325 </summary>
13326 </member>
13327 <member name="M:NAnt.Core.LocationMap.FileIsMapped(System.String)">
13328 <summary>
13329 Determines if a file has been loaded by the current project.
13330 </summary>
13331 <param name="fileOrUri">The file to check.</param>
13332 <returns>
13333 <see langword="true" /> if the specified file has already been loaded
13334 by the current project; otherwise, <see langword="false" />.
13335 </returns>
13336 </member>
13337 <member name="M:NAnt.Core.LocationMap.Add(System.Xml.XmlDocument)">
13338 <summary>
13339 Adds an <see cref="T:System.Xml.XmlDocument"/> to the map.
13340 </summary>
13341 <remarks>
13342 An <see cref="T:System.Xml.XmlDocument"/> can only be added to the map once.
13343 </remarks>
13344 </member>
13345 <member name="M:NAnt.Core.LocationMap.GetLocation(System.Xml.XmlNode)">
13346 <summary>
13347 Returns the <see cref="T:NAnt.Core.Location"/> in the XML file for the given node.
13348 </summary>
13349 <remarks>
13350 The <paramref name="node"/> must be from an <see cref="T:System.Xml.XmlDocument"/>
13351 that has been added to the map.
13352 </remarks>
13353 </member>
13354 <member name="T:NAnt.Core.LocationMap.TextPosition">
13355 <summary>
13356 Represents a position in the build file.
13357 </summary>
13358 </member>
13359 <member name="M:NAnt.Core.LocationMap.TextPosition.#ctor(System.Int32,System.Int32)">
13360 <summary>
13361 Initializes a new instance of the <see cref="T:NAnt.Core.LocationMap.TextPosition"/>
13362 with the speified line and column.
13363 </summary>
13364 <param name="line">The line coordinate of the position.</param>
13365 <param name="column">The column coordinate of the position.</param>
13366 </member>
13367 <member name="F:NAnt.Core.LocationMap.TextPosition.Line">
13368 <summary>
13369 The line coordinate of the position.
13370 </summary>
13371 </member>
13372 <member name="F:NAnt.Core.LocationMap.TextPosition.Column">
13373 <summary>
13374 The column coordinate of the position.
13375 </summary>
13376 </member>
13377 <member name="T:NAnt.Core.Level">
13378 <summary>
13379 Defines the set of levels recognised by the NAnt logging system.
13380 </summary>
13381 </member>
13382 <member name="F:NAnt.Core.Level.Debug">
13383 <summary>
13384 Designates fine-grained informational events that are most useful
13385 to debug a build process.
13386 </summary>
13387 </member>
13388 <member name="F:NAnt.Core.Level.Verbose">
13389 <summary>
13390 Designates events that offer a more detailed view of the build
13391 process.
13392 </summary>
13393 </member>
13394 <member name="F:NAnt.Core.Level.Info">
13395 <summary>
13396 Designates informational events that are useful for getting a
13397 high-level view of the build process.
13398 </summary>
13399 </member>
13400 <member name="F:NAnt.Core.Level.Warning">
13401 <summary>
13402 Designates potentionally harmful events.
13403 </summary>
13404 </member>
13405 <member name="F:NAnt.Core.Level.Error">
13406 <summary>
13407 Designates error events.
13408 </summary>
13409 </member>
13410 <member name="F:NAnt.Core.Level.None">
13411 <summary>
13412 Can be used to suppress all messages.
13413 </summary>
13414 <remarks>
13415 No events should be logged with this <see cref="T:NAnt.Core.Level"/>.
13416 </remarks>
13417 </member>
13418 <member name="T:NAnt.Core.BuildEventArgs">
13419 <summary>
13420 Class representing an event occurring during a build.
13421 </summary>
13422 <remarks>
13423 <para>
13424 An event is built by specifying either a project, a task or a target.
13425 </para>
13426 <para>
13427 A <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event will only have a <see cref="P:NAnt.Core.BuildEventArgs.Project"/>
13428 reference.
13429 </para>
13430 <para>
13431 A <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level event will have <see cref="P:NAnt.Core.BuildEventArgs.Project"/> and
13432 <see cref="P:NAnt.Core.BuildEventArgs.Target"/> references.
13433 </para>
13434 <para>
13435 A <see cref="P:NAnt.Core.BuildEventArgs.Task"/> level event will have <see cref="P:NAnt.Core.BuildEventArgs.Project"/>,
13436 <see cref="P:NAnt.Core.BuildEventArgs.Target"/> and <see cref="P:NAnt.Core.BuildEventArgs.Task"/> references.
13437 </para>
13438 </remarks>
13439 </member>
13440 <member name="M:NAnt.Core.BuildEventArgs.#ctor">
13441 <summary>
13442 Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
13443 class.
13444 </summary>
13445 </member>
13446 <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Project)">
13447 <summary>
13448 Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
13449 class for a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event.
13450 </summary>
13451 <param name="project">The <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that emitted the event.</param>
13452 </member>
13453 <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Target)">
13454 <summary>
13455 Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
13456 class for a <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level event.
13457 </summary>
13458 <param name="target">The <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that emitted the event.</param>
13459 </member>
13460 <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Task)">
13461 <summary>
13462 Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
13463 class for a <see cref="P:NAnt.Core.BuildEventArgs.Task"/> level event.
13464 </summary>
13465 <param name="task">The <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that emitted the event.</param>
13466 </member>
13467 <member name="P:NAnt.Core.BuildEventArgs.Message">
13468 <summary>
13469 Gets or sets the message associated with this event.
13470 </summary>
13471 <value>
13472 The message associated with this event.
13473 </value>
13474 </member>
13475 <member name="P:NAnt.Core.BuildEventArgs.MessageLevel">
13476 <summary>
13477 Gets or sets the priority level associated with this event.
13478 </summary>
13479 <value>
13480 The priority level associated with this event.
13481 </value>
13482 </member>
13483 <member name="P:NAnt.Core.BuildEventArgs.Exception">
13484 <summary>
13485 Gets or sets the <see cref="P:NAnt.Core.BuildEventArgs.Exception"/> associated with this event.
13486 </summary>
13487 <value>
13488 The <see cref="P:NAnt.Core.BuildEventArgs.Exception"/> associated with this event.
13489 </value>
13490 </member>
13491 <member name="P:NAnt.Core.BuildEventArgs.Project">
13492 <summary>
13493 Gets the <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that fired this event.
13494 </summary>
13495 <value>
13496 The <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that fired this event.
13497 </value>
13498 </member>
13499 <member name="P:NAnt.Core.BuildEventArgs.Target">
13500 <summary>
13501 Gets the <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that fired this event.
13502 </summary>
13503 <value>
13504 The <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that fired this event, or a null reference
13505 if this is a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event.
13506 </value>
13507 </member>
13508 <member name="P:NAnt.Core.BuildEventArgs.Task">
13509 <summary>
13510 Gets the <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that fired this event.
13511 </summary>
13512 <value>
13513 The <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that fired this event, or <see langword="null"/>
13514 if this is a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> or <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level
13515 event.
13516 </value>
13517 </member>
13518 <member name="T:NAnt.Core.BuildEventHandler">
13519 <summary>
13520 Represents the method that handles the build events.
13521 </summary>
13522 <param name="sender">The source of the event.</param>
13523 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
13524 </member>
13525 <member name="T:NAnt.Core.IBuildListener">
13526 <summary>
13527 Instances of classes that implement this interface can register to be
13528 notified when things happen during a build.
13529 </summary>
13530 </member>
13531 <member name="M:NAnt.Core.IBuildListener.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
13532 <summary>
13533 Signals that a build has started.
13534 </summary>
13535 <param name="sender">The source of the event.</param>
13536 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13537 <remarks>
13538 This event is fired before any targets have started.
13539 </remarks>
13540 </member>
13541 <member name="M:NAnt.Core.IBuildListener.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
13542 <summary>
13543 Signals that the last target has finished.
13544 </summary>
13545 <param name="sender">The source of the event.</param>
13546 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13547 <remarks>
13548 This event will still be fired if an error occurred during the build.
13549 </remarks>
13550 </member>
13551 <member name="M:NAnt.Core.IBuildListener.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
13552 <summary>
13553 Signals that a target has started.
13554 </summary>
13555 <param name="sender">The source of the event.</param>
13556 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13557 </member>
13558 <member name="M:NAnt.Core.IBuildListener.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
13559 <summary>
13560 Signals that a target has finished.
13561 </summary>
13562 <param name="sender">The source of the event.</param>
13563 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13564 <remarks>
13565 This event will still be fired if an error occurred during the build.
13566 </remarks>
13567 </member>
13568 <member name="M:NAnt.Core.IBuildListener.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
13569 <summary>
13570 Signals that a task has started.
13571 </summary>
13572 <param name="sender">The source of the event.</param>
13573 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13574 </member>
13575 <member name="M:NAnt.Core.IBuildListener.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
13576 <summary>
13577 Signals that a task has finished.
13578 </summary>
13579 <param name="sender">The source of the event.</param>
13580 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13581 <remarks>
13582 This event will still be fired if an error occurred during the build.
13583 </remarks>
13584 </member>
13585 <member name="M:NAnt.Core.IBuildListener.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
13586 <summary>
13587 Signals that a message has been logged.
13588 </summary>
13589 <param name="sender">The source of the event.</param>
13590 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13591 </member>
13592 <member name="T:NAnt.Core.IBuildLogger">
13593 <summary>
13594 Interface used by NAnt to log the build output.
13595 </summary>
13596 <remarks>
13597 Depending on the supplied command-line arguments, NAnt will set the
13598 <see cref="P:NAnt.Core.IBuildLogger.OutputWriter"/> to <see cref="P:System.Console.Out"/> or a
13599 <see cref="T:System.IO.StreamWriter"/> with a file as backend store.
13600 </remarks>
13601 </member>
13602 <member name="M:NAnt.Core.IBuildLogger.Flush">
13603 <summary>
13604 Flushes buffered build events or messages to the underlying storage.
13605 </summary>
13606 </member>
13607 <member name="P:NAnt.Core.IBuildLogger.Threshold">
13608 <summary>
13609 Gets or sets the highest level of message this logger should respond
13610 to.
13611 </summary>
13612 <value>The highest level of message this logger should respond to.</value>
13613 <remarks>
13614 Only messages with a message level higher than or equal to the given
13615 level should actually be written to the log.
13616 </remarks>
13617 </member>
13618 <member name="P:NAnt.Core.IBuildLogger.EmacsMode">
13619 <summary>
13620 Gets or sets a value indicating whether to produce emacs (and other
13621 editor) friendly output.
13622 </summary>
13623 <value>
13624 <see langword="true" /> if output is to be unadorned so that emacs
13625 and other editors can parse files names, etc.
13626 </value>
13627 </member>
13628 <member name="P:NAnt.Core.IBuildLogger.OutputWriter">
13629 <summary>
13630 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
13631 to send its output.
13632 </summary>
13633 </member>
13634 <member name="M:NAnt.Core.DefaultLogger.#ctor">
13635 <summary>
13636 Initializes a new instance of the <see cref="T:NAnt.Core.DefaultLogger"/>
13637 class.
13638 </summary>
13639 </member>
13640 <member name="M:NAnt.Core.DefaultLogger.Flush">
13641 <summary>
13642 Flushes buffered build events or messages to the underlying storage.
13643 </summary>
13644 </member>
13645 <member name="M:NAnt.Core.DefaultLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
13646 <summary>
13647 Signals that a build has started.
13648 </summary>
13649 <param name="sender">The source of the event.</param>
13650 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13651 <remarks>
13652 This event is fired before any targets have started.
13653 </remarks>
13654 </member>
13655 <member name="M:NAnt.Core.DefaultLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
13656 <summary>
13657 Signals that the last target has finished.
13658 </summary>
13659 <param name="sender">The source of the event.</param>
13660 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13661 <remarks>
13662 This event will still be fired if an error occurred during the build.
13663 </remarks>
13664 </member>
13665 <member name="M:NAnt.Core.DefaultLogger.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
13666 <summary>
13667 Signals that a target has started.
13668 </summary>
13669 <param name="sender">The source of the event.</param>
13670 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13671 </member>
13672 <member name="M:NAnt.Core.DefaultLogger.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
13673 <summary>
13674 Signals that a task has finished.
13675 </summary>
13676 <param name="sender">The source of the event.</param>
13677 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13678 <remarks>
13679 This event will still be fired if an error occurred during the build.
13680 </remarks>
13681 </member>
13682 <member name="M:NAnt.Core.DefaultLogger.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
13683 <summary>
13684 Signals that a task has started.
13685 </summary>
13686 <param name="sender">The source of the event.</param>
13687 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13688 </member>
13689 <member name="M:NAnt.Core.DefaultLogger.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
13690 <summary>
13691 Signals that a task has finished.
13692 </summary>
13693 <param name="sender">The source of the event.</param>
13694 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13695 <remarks>
13696 This event will still be fired if an error occurred during the build.
13697 </remarks>
13698 </member>
13699 <member name="M:NAnt.Core.DefaultLogger.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
13700 <summary>
13701 Signals that a message has been logged.
13702 </summary>
13703 <param name="sender">The source of the event.</param>
13704 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13705 <remarks>
13706 Only messages with a priority higher or equal to the threshold of
13707 the logger will actually be output in the build log.
13708 </remarks>
13709 </member>
13710 <member name="M:NAnt.Core.DefaultLogger.Log(System.String)">
13711 <summary>
13712 Empty implementation which allows derived classes to receive the
13713 output that is generated in this logger.
13714 </summary>
13715 <param name="message">The message being logged.</param>
13716 </member>
13717 <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.Level,System.String,System.Int32)">
13718 <summary>
13719 Outputs an indented message to the build log if its priority is
13720 greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
13721 logger.
13722 </summary>
13723 <param name="messageLevel">The priority of the message to output.</param>
13724 <param name="message">The message to output.</param>
13725 <param name="indentationLength">The number of characters that the message should be indented.</param>
13726 </member>
13727 <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.BuildEventArgs)">
13728 <summary>
13729 Outputs an indented message to the build log if its priority is
13730 greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
13731 logger.
13732 </summary>
13733 <param name="e">The event to output.</param>
13734 </member>
13735 <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.BuildEventArgs,System.Int32)">
13736 <summary>
13737 Outputs an indented message to the build log if its priority is
13738 greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
13739 logger.
13740 </summary>
13741 <param name="e">The event to output.</param>
13742 <param name="indentationLength">The number of characters that the message should be indented.</param>
13743 </member>
13744 <member name="F:NAnt.Core.DefaultLogger._buildReports">
13745 <summary>
13746 Holds a stack of reports for all running builds.
13747 </summary>
13748 </member>
13749 <member name="P:NAnt.Core.DefaultLogger.Threshold">
13750 <summary>
13751 Gets or sets the highest level of message this logger should respond
13752 to.
13753 </summary>
13754 <value>
13755 The highest level of message this logger should respond to.
13756 </value>
13757 <remarks>
13758 Only messages with a message level higher than or equal to the given
13759 level should be written to the log.
13760 </remarks>
13761 </member>
13762 <member name="P:NAnt.Core.DefaultLogger.EmacsMode">
13763 <summary>
13764 Gets or sets a value indicating whether to produce emacs (and other
13765 editor) friendly output.
13766 </summary>
13767 <value>
13768 <see langword="true" /> if output is to be unadorned so that emacs
13769 and other editors can parse files names, etc. The default is
13770 <see langword="false" />.
13771 </value>
13772 </member>
13773 <member name="P:NAnt.Core.DefaultLogger.OutputWriter">
13774 <summary>
13775 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
13776 to send its output.
13777 </summary>
13778 <value>
13779 The <see cref="T:System.IO.TextWriter"/> to which the logger sends its output.
13780 </value>
13781 </member>
13782 <member name="T:NAnt.Core.BuildReport">
13783 <summary>
13784 Used to store information about a build, to allow better reporting to
13785 the user.
13786 </summary>
13787 </member>
13788 <member name="F:NAnt.Core.BuildReport.Errors">
13789 <summary>
13790 Errors encountered so far.
13791 </summary>
13792 </member>
13793 <member name="F:NAnt.Core.BuildReport.Warnings">
13794 <summary>
13795 Warnings encountered so far.
13796 </summary>
13797 </member>
13798 <member name="F:NAnt.Core.BuildReport.StartTime">
13799 <summary>
13800 The start time of the build process.
13801 </summary>
13802 </member>
13803 <member name="T:NAnt.Core.MailLogger">
13804 <summary>
13805 Buffers log messages from DefaultLogger, and sends an e-mail with the
13806 results.
13807 </summary>
13808 <remarks>
13809 The following properties are used to send the mail :
13810 <list type="table">
13811 <listheader>
13812 <term>Property</term>
13813 <description>Description</description>
13814 </listheader>
13815 <item>
13816 <term>MailLogger.mailhost</term>
13817 <description>Mail server to use. [default: localhost]</description>
13818 </item>
13819 <item>
13820 <term>MailLogger.from</term>
13821 <description>The address of the e-mail sender.</description>
13822 </item>
13823 <item>
13824 <term>MailLogger.failure.notify</term>
13825 <description>Send build failure e-mails ? [default: true]</description>
13826 </item>
13827 <item>
13828 <term>MailLogger.success.notify</term>
13829 <description>Send build success e-mails ? [default: true]</description>
13830 </item>
13831 <item>
13832 <term>MailLogger.failure.to</term>
13833 <description>The address to send build failure messages to.</description>
13834 </item>
13835 <item>
13836 <term>MailLogger.success.to</term>
13837 <description>The address to send build success messages to.</description>
13838 </item>
13839 <item>
13840 <term>MailLogger.failure.subject</term>
13841 <description>The subject of build failure messages. [default: "Build Failure"]</description>
13842 </item>
13843 <item>
13844 <term>MailLogger.success.subject</term>
13845 <description>The subject of build success messages. [default: "Build Success"]</description>
13846 </item>
13847 <item>
13848 <term>MailLogger.success.attachments</term>
13849 <description>The ID of a fileset holdng set of files to attach when the build is successful.</description>
13850 </item>
13851 <item>
13852 <term>MailLogger.failure.attachments</term>
13853 <description>The ID of a fileset holdng set of files to attach when the build fails.</description>
13854 </item>
13855 <item>
13856 <term>MailLogger.body.encoding</term>
13857 <description>The encoding type of the body of the e-mail message. [default: system's ANSI code page]</description>
13858 </item>
13859 <item>
13860 <term>MailLogger.smtp.username</term>
13861 <description>The name of the user to login to the SMTP server.</description>
13862 </item>
13863 <item>
13864 <term>MailLogger.smtp.password</term>
13865 <description>The password of the specified user.</description>
13866 </item>
13867 <item>
13868 <term>MailLogger.smtp.enablessl</term>
13869 <description>Specifies whether to use SSL to encrypt the connection. [default: false]</description>
13870 </item>
13871 <item>
13872 <term>MailLogger.smtp.port</term>
13873 <description>The SMTP server port to connect to. [default: 25]</description>
13874 </item>
13875 </list>
13876 </remarks>
13877 </member>
13878 <member name="M:NAnt.Core.MailLogger.#ctor">
13879 <summary>
13880 Initializes a new instance of the <see cref="T:NAnt.Core.MailLogger"/>
13881 class.
13882 </summary>
13883 </member>
13884 <member name="M:NAnt.Core.MailLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
13885 <summary>
13886 Signals that a build has started.
13887 </summary>
13888 <param name="sender">The source of the event.</param>
13889 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13890 <remarks>
13891 This event is fired before any targets have started.
13892 </remarks>
13893 </member>
13894 <member name="M:NAnt.Core.MailLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
13895 <summary>
13896 Signals that the last target has finished, and send an e-mail with
13897 the build results.
13898 </summary>
13899 <param name="sender">The source of the event.</param>
13900 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13901 </member>
13902 <member name="M:NAnt.Core.MailLogger.Log(System.String)">
13903 <summary>
13904 Receives and buffers log messages.
13905 </summary>
13906 <param name="message">The message being logged.</param>
13907 </member>
13908 <member name="M:NAnt.Core.MailLogger.GetPropertyValue(NAnt.Core.PropertyDictionary,System.String,System.String,System.Boolean)">
13909 <summary>
13910 Gets the value of the specified property.
13911 </summary>
13912 <param name="properties">Properties to obtain value from.</param>
13913 <param name="name">Suffix of property name. "MailLogger" will be prepended internally.</param>
13914 <param name="defaultValue">Value returned if property is not present in <paramref name="properties"/>.</param>
13915 <param name="required">Value indicating whether the property should exist, or have a default value set.</param>
13916 <returns>
13917 The value of the specified property; or the default value if the
13918 property is not present in <paramref name="properties"/>.
13919 </returns>
13920 <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>
13921 </member>
13922 <member name="F:NAnt.Core.MailLogger._buffer">
13923 <summary>
13924 Buffer in which the message is constructed prior to sending.
13925 </summary>
13926 </member>
13927 <member name="F:NAnt.Core.MailLogger._projectStack">
13928 <summary>
13929 Holds the stack of currently executing projects.
13930 </summary>
13931 </member>
13932 <member name="T:NAnt.Core.BuildListenerCollection">
13933 <summary>
13934 Contains a strongly typed collection of <see cref="T:NAnt.Core.IBuildListener"/>
13935 objects.
13936 </summary>
13937 </member>
13938 <member name="M:NAnt.Core.BuildListenerCollection.#ctor">
13939 <summary>
13940 Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
13941 class.
13942 </summary>
13943 </member>
13944 <member name="M:NAnt.Core.BuildListenerCollection.#ctor(NAnt.Core.BuildListenerCollection)">
13945 <summary>
13946 Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
13947 class with the specified <see cref="T:NAnt.Core.BuildListenerCollection"/> instance.
13948 </summary>
13949 </member>
13950 <member name="M:NAnt.Core.BuildListenerCollection.#ctor(NAnt.Core.IBuildListener[])">
13951 <summary>
13952 Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
13953 class with the specified array of <see cref="T:NAnt.Core.IBuildListener"/> instances.
13954 </summary>
13955 </member>
13956 <member name="M:NAnt.Core.BuildListenerCollection.Add(NAnt.Core.IBuildListener)">
13957 <summary>
13958 Adds a <see cref="T:NAnt.Core.IBuildListener"/> to the end of the collection.
13959 </summary>
13960 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to be added to the end of the collection.</param>
13961 <returns>The position into which the new element was inserted.</returns>
13962 </member>
13963 <member name="M:NAnt.Core.BuildListenerCollection.AddRange(NAnt.Core.IBuildListener[])">
13964 <summary>
13965 Adds the elements of a <see cref="T:NAnt.Core.IBuildListener"/> array to the end of the collection.
13966 </summary>
13967 <param name="items">The array of <see cref="T:NAnt.Core.IBuildListener"/> elements to be added to the end of the collection.</param>
13968 </member>
13969 <member name="M:NAnt.Core.BuildListenerCollection.AddRange(NAnt.Core.BuildListenerCollection)">
13970 <summary>
13971 Adds the elements of a <see cref="T:NAnt.Core.BuildListenerCollection"/> to the end of the collection.
13972 </summary>
13973 <param name="items">The <see cref="T:NAnt.Core.BuildListenerCollection"/> to be added to the end of the collection.</param>
13974 </member>
13975 <member name="M:NAnt.Core.BuildListenerCollection.Contains(NAnt.Core.IBuildListener)">
13976 <summary>
13977 Determines whether a <see cref="T:NAnt.Core.IBuildListener"/> is in the collection.
13978 </summary>
13979 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to locate in the collection.</param>
13980 <returns>
13981 <see langword="true"/> if <paramref name="item"/> is found in the
13982 collection; otherwise, <see langword="false"/>.
13983 </returns>
13984 </member>
13985 <member name="M:NAnt.Core.BuildListenerCollection.CopyTo(NAnt.Core.IBuildListener[],System.Int32)">
13986 <summary>
13987 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
13988 </summary>
13989 <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>
13990 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
13991 </member>
13992 <member name="M:NAnt.Core.BuildListenerCollection.IndexOf(NAnt.Core.IBuildListener)">
13993 <summary>
13994 Retrieves the index of a specified <see cref="T:NAnt.Core.IBuildListener"/> object in the collection.
13995 </summary>
13996 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> object for which the index is returned.</param>
13997 <returns>
13998 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.
13999 </returns>
14000 </member>
14001 <member name="M:NAnt.Core.BuildListenerCollection.Insert(System.Int32,NAnt.Core.IBuildListener)">
14002 <summary>
14003 Inserts a <see cref="T:NAnt.Core.IBuildListener"/> into the collection at the specified index.
14004 </summary>
14005 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
14006 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to insert.</param>
14007 </member>
14008 <member name="M:NAnt.Core.BuildListenerCollection.GetEnumerator">
14009 <summary>
14010 Returns an enumerator that can iterate through the collection.
14011 </summary>
14012 <returns>
14013 A <see cref="T:NAnt.Core.BuildListenerEnumerator"/> for the entire collection.
14014 </returns>
14015 </member>
14016 <member name="M:NAnt.Core.BuildListenerCollection.Remove(NAnt.Core.IBuildListener)">
14017 <summary>
14018 Removes a member from the collection.
14019 </summary>
14020 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to remove from the collection.</param>
14021 </member>
14022 <member name="P:NAnt.Core.BuildListenerCollection.Item(System.Int32)">
14023 <summary>
14024 Gets or sets the element at the specified index.
14025 </summary>
14026 <param name="index">The zero-based index of the element to get or set.</param>
14027 </member>
14028 <member name="T:NAnt.Core.BuildListenerEnumerator">
14029 <summary>
14030 Enumerates the <see cref="T:NAnt.Core.IBuildListener"/> elements of a <see cref="T:NAnt.Core.BuildListenerCollection"/>.
14031 </summary>
14032 </member>
14033 <member name="M:NAnt.Core.BuildListenerEnumerator.#ctor(NAnt.Core.BuildListenerCollection)">
14034 <summary>
14035 Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerEnumerator"/> class
14036 with the specified <see cref="T:NAnt.Core.BuildListenerCollection"/>.
14037 </summary>
14038 <param name="arguments">The collection that should be enumerated.</param>
14039 </member>
14040 <member name="M:NAnt.Core.BuildListenerEnumerator.MoveNext">
14041 <summary>
14042 Advances the enumerator to the next element of the collection.
14043 </summary>
14044 <returns>
14045 <see langword="true" /> if the enumerator was successfully advanced
14046 to the next element; <see langword="false" /> if the enumerator has
14047 passed the end of the collection.
14048 </returns>
14049 </member>
14050 <member name="M:NAnt.Core.BuildListenerEnumerator.Reset">
14051 <summary>
14052 Sets the enumerator to its initial position, which is before the
14053 first element in the collection.
14054 </summary>
14055 </member>
14056 <member name="P:NAnt.Core.BuildListenerEnumerator.Current">
14057 <summary>
14058 Gets the current element in the collection.
14059 </summary>
14060 <returns>
14061 The current element in the collection.
14062 </returns>
14063 </member>
14064 <member name="T:NAnt.Core.LogWriter">
14065 <summary>
14066 Implements a <see cref="T:System.IO.TextWriter"/> for writing information to
14067 the NAnt logging infrastructure.
14068 </summary>
14069 </member>
14070 <member name="M:NAnt.Core.LogWriter.#ctor(NAnt.Core.Task,NAnt.Core.Level,System.IFormatProvider)">
14071 <summary>
14072 Initializes a new instance of the <see cref="T:NAnt.Core.LogWriter"/> class
14073 for the specified <see cref="T:NAnt.Core.Task"/> with the specified output
14074 level and format provider.
14075 </summary>
14076 <param name="task">Determines the indentation level.</param>
14077 <param name="outputLevel">The <see cref="T:NAnt.Core.Level"/> with which messages will be output to the build log.</param>
14078 <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> object that controls formatting.</param>
14079 </member>
14080 <member name="M:NAnt.Core.LogWriter.Write(System.Char[])">
14081 <summary>
14082 Writes a character array to the buffer.
14083 </summary>
14084 <param name="chars">The character array to write to the text stream.</param>
14085 </member>
14086 <member name="M:NAnt.Core.LogWriter.Write(System.String)">
14087 <summary>
14088 Writes a string to the buffer.
14089 </summary>
14090 <param name="value"></param>
14091 </member>
14092 <member name="M:NAnt.Core.LogWriter.WriteLine">
14093 <summary>
14094 Writes an empty string to the logging infrastructure.
14095 </summary>
14096 </member>
14097 <member name="M:NAnt.Core.LogWriter.WriteLine(System.String)">
14098 <summary>
14099 Writes a string to the logging infrastructure.
14100 </summary>
14101 <param name="value">The string to write. If <paramref name="value" /> is a null reference, only the line termination characters are written.</param>
14102 </member>
14103 <member name="M:NAnt.Core.LogWriter.WriteLine(System.String,System.Object[])">
14104 <summary>
14105 Writes out a formatted string using the same semantics as
14106 <see cref="M:System.String.Format(System.String,System.Object[])"/>.
14107 </summary>
14108 <param name="line">The formatting string.</param>
14109 <param name="args">The object array to write into format string.</param>
14110 </member>
14111 <member name="M:NAnt.Core.LogWriter.Flush">
14112 <summary>
14113 Causes any buffered data to be written to the logging infrastructure.
14114 </summary>
14115 </member>
14116 <member name="M:NAnt.Core.LogWriter.Close">
14117 <summary>
14118 Closes the current writer and releases any system resources
14119 associated with the writer.
14120 </summary>
14121 </member>
14122 <member name="M:NAnt.Core.LogWriter.InitializeLifetimeService">
14123 <summary>
14124 Obtains a lifetime service object to control the lifetime policy for
14125 this instance.
14126 </summary>
14127 <returns>
14128 An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
14129 policy for this instance. This is the current lifetime service object
14130 for this instance if one exists; otherwise, a new lifetime service
14131 object initialized with a lease that will never time out.
14132 </returns>
14133 </member>
14134 <member name="P:NAnt.Core.LogWriter.Encoding">
14135 <summary>
14136 Gets the <see cref="P:NAnt.Core.LogWriter.Encoding"/> in which the output is written.
14137 </summary>
14138 <value>
14139 The <see cref="T:NAnt.Core.LogWriter"/> always writes output in UTF8
14140 encoding.
14141 </value>
14142 </member>
14143 <member name="P:NAnt.Core.LogWriter.OutputLevel">
14144 <summary>
14145 Gets the <see cref="T:NAnt.Core.Level"/> with which messages will be output to
14146 the build log.
14147 </summary>
14148 </member>
14149 <member name="T:NAnt.Core.PathScanner">
14150 <summary>
14151 Used to search for files on the PATH.
14152 </summary>
14153 <remarks>
14154 <para>
14155 The local directory is not searched (since this would already be covered
14156 by normal use of the includes element).
14157 </para>
14158 <para>
14159 Also, advanced pattern matching isn't supported: you need to know the
14160 exact name of the file.
14161 </para>
14162 </remarks>
14163 </member>
14164 <member name="M:NAnt.Core.PathScanner.System#ICloneable#Clone">
14165 <summary>
14166 Creates a shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
14167 </summary>
14168 <returns>
14169 A shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
14170 </returns>
14171 </member>
14172 <member name="M:NAnt.Core.PathScanner.Clone">
14173 <summary>
14174 Creates a shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
14175 </summary>
14176 <returns>
14177 A shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
14178 </returns>
14179 </member>
14180 <member name="M:NAnt.Core.PathScanner.Add(System.String)">
14181 <summary>
14182 Adds a file to the list of files to be scanned for.
14183 </summary>
14184 <param name="fileName">The filename or search pattern to add to the list.</param>
14185 </member>
14186 <member name="M:NAnt.Core.PathScanner.Scan">
14187 <summary>
14188 Scans all direcetories in the PATH environment variable for files.
14189 </summary>
14190 <returns>
14191 List of matching files found in the PATH.
14192 </returns>
14193 </member>
14194 <member name="M:NAnt.Core.PathScanner.Scan(System.String)">
14195 <summary>
14196 Scans all directories in the given environment variable for files.
14197 </summary>
14198 <param name="name">The environment variable of which the directories should be scanned.</param>
14199 <returns>
14200 List of matching files found in the directory of the given
14201 environment variable.
14202 </returns>
14203 </member>
14204 <member name="M:NAnt.Core.PathScanner.Clone(System.Collections.Specialized.StringCollection)">
14205 <summary>
14206 Creates a shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
14207 </summary>
14208 <param name="stringCollection">The <see cref="T:System.Collections.Specialized.StringCollection"/> that should be copied.</param>
14209 <returns>
14210 A shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
14211 </returns>
14212 </member>
14213 <member name="T:NAnt.Core.Project">
14214 <summary>
14215 Central representation of a NAnt project.
14216 </summary>
14217 <example>
14218 <para>
14219 The <see cref="M:NAnt.Core.Project.Run"/> method will initialize the project with the build
14220 file specified in the constructor and execute the default target.
14221 </para>
14222 <code>
14223 <![CDATA[
14224 Project p = new Project("foo.build", Level.Info);
14225 p.Run();
14226 ]]>
14227 </code>
14228 </example>
14229 <example>
14230 <para>
14231 If no target is given, the default target will be executed if specified
14232 in the project.
14233 </para>
14234 <code>
14235 <![CDATA[
14236 Project p = new Project("foo.build", Level.Info);
14237 p.Execute("build");
14238 ]]>
14239 </code>
14240 </example>
14241 </member>
14242 <member name="F:NAnt.Core.Project.Visiting">
14243 <summary>
14244 Constant for the "visiting" state, used when traversing a DFS of
14245 target dependencies.
14246 </summary>
14247 </member>
14248 <member name="F:NAnt.Core.Project.Visited">
14249 <summary>
14250 Constant for the "visited" state, used when traversing a DFS of
14251 target dependencies.
14252 </summary>
14253 </member>
14254 <member name="F:NAnt.Core.Project.logger">
14255 <summary>
14256 Holds the logger for this class.
14257 </summary>
14258 </member>
14259 <member name="F:NAnt.Core.Project._threshold">
14260 <summary>
14261 Holds the default threshold for build loggers.
14262 </summary>
14263 </member>
14264 <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32)">
14265 <summary>
14266 Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
14267 document, message threshold and indentation level.
14268 </summary>
14269 <param name="doc">Any valid build format will do.</param>
14270 <param name="threshold">The message threshold.</param>
14271 <param name="indentLevel">The project indentation level.</param>
14272 </member>
14273 <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32,System.Xml.XmlNode)">
14274 <summary>
14275 Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
14276 document, message threshold and indentation level, and using
14277 the specified <see cref="T:System.Xml.XmlNode"/> to load internal configuration
14278 settings.
14279 </summary>
14280 <param name="doc">Any valid build format will do.</param>
14281 <param name="threshold">The message threshold.</param>
14282 <param name="indentLevel">The project indentation level.</param>
14283 <param name="configurationNode">The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize configuration settings.</param>
14284 <remarks>
14285 This constructor is useful for developers using NAnt as a class
14286 library.
14287 </remarks>
14288 </member>
14289 <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Level,System.Int32)">
14290 <summary>
14291 Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
14292 source, message threshold and indentation level.
14293 </summary>
14294 <param name="uriOrFilePath">
14295 <para>The full path to the build file.</para>
14296 <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
14297 </param>
14298 <param name="threshold">The message threshold.</param>
14299 <param name="indentLevel">The project indentation level.</param>
14300 <remarks>
14301 If the source is a uri of form 'file:///path' then use the path part.
14302 </remarks>
14303 </member>
14304 <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Level,System.Int32,System.Xml.XmlNode)">
14305 <summary>
14306 Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
14307 source, message threshold and indentation level, and using
14308 the specified <see cref="T:System.Xml.XmlNode"/> to load internal configuration
14309 settings.
14310 </summary>
14311 <param name="uriOrFilePath">
14312 <para>The full path to the build file.</para>
14313 <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
14314 </param>
14315 <param name="threshold">The message threshold.</param>
14316 <param name="indentLevel">The project indentation level.</param>
14317 <param name="configurationNode">The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize configuration settings.</param>
14318 <exception cref="T:System.ArgumentNullException"><paramref name="configurationNode"/> is <see langword="null"/>.</exception>
14319 <remarks>
14320 If the source is a uri of form 'file:///path' then use the path part.
14321 </remarks>
14322 </member>
14323 <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Project)">
14324 <summary>
14325 Initializes a <see cref="T:NAnt.Core.Project"/> as subproject of the specified
14326 <see cref="T:NAnt.Core.Project"/>.
14327 </summary>
14328 <param name="uriOrFilePath">
14329 <para>The full path to the build file.</para>
14330 <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
14331 </param>
14332 <param name="parent">The parent <see cref="T:NAnt.Core.Project"/>.</param>
14333 <remarks>
14334 Optimized for framework initialization projects, by skipping automatic
14335 discovery of extension assemblies and framework configuration.
14336 </remarks>
14337 </member>
14338 <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument)">
14339 <summary>
14340 Initializes a <see cref="T:NAnt.Core.Project"/> with <see cref="P:NAnt.Core.Project.Threshold"/>
14341 set to <see cref="F:NAnt.Core.Level.None"/>, and <see cref="P:NAnt.Core.Project.IndentationLevel"/>
14342 set to 0.
14343 </summary>
14344 <param name="doc">An <see cref="T:System.Xml.XmlDocument"/> containing the build script.</param>
14345 <remarks>
14346 Optimized for framework initialization projects, by skipping automatic
14347 discovery of extension assemblies and framework configuration.
14348 </remarks>
14349 </member>
14350 <member name="M:NAnt.Core.Project.GetFrameworks(NAnt.Core.FrameworkTypes)">
14351 <summary>
14352 Gets the list of supported frameworks filtered by the specified
14353 <see cref="T:NAnt.Core.FrameworkTypes"/> parameter.
14354 </summary>
14355 <param name="types">A bitwise combination of <see cref="T:NAnt.Core.FrameworkTypes"/> values that filter the frameworks to retrieve.</param>
14356 <returns>
14357 An array of type <see cref="T:NAnt.Core.FrameworkInfo"/> that contains the
14358 frameworks specified by the <paramref name="types"/> parameter,
14359 sorted on name.
14360 </returns>
14361 </member>
14362 <member name="M:NAnt.Core.Project.OnBuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
14363 <summary>
14364 Dispatches a <see cref="F:NAnt.Core.Project.BuildStarted"/> event to the build listeners
14365 for this <see cref="T:NAnt.Core.Project"/>.
14366 </summary>
14367 <param name="sender">The source of the event.</param>
14368 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14369 </member>
14370 <member name="M:NAnt.Core.Project.OnBuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
14371 <summary>
14372 Dispatches a <see cref="F:NAnt.Core.Project.BuildFinished"/> event to the build listeners
14373 for this <see cref="T:NAnt.Core.Project"/>.
14374 </summary>
14375 <param name="sender">The source of the event.</param>
14376 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14377 </member>
14378 <member name="M:NAnt.Core.Project.OnTargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
14379 <summary>
14380 Dispatches a <see cref="F:NAnt.Core.Project.TargetStarted"/> event to the build listeners
14381 for this <see cref="T:NAnt.Core.Project"/>.
14382 </summary>
14383 <param name="sender">The source of the event.</param>
14384 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14385 </member>
14386 <member name="M:NAnt.Core.Project.OnTargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
14387 <summary>
14388 Dispatches a <see cref="F:NAnt.Core.Project.TargetFinished"/> event to the build listeners
14389 for this <see cref="T:NAnt.Core.Project"/>.
14390 </summary>
14391 <param name="sender">The source of the event.</param>
14392 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14393 </member>
14394 <member name="M:NAnt.Core.Project.OnTaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
14395 <summary>
14396 Dispatches a <see cref="F:NAnt.Core.Project.TaskStarted"/> event to the build listeners
14397 for this <see cref="T:NAnt.Core.Project"/>.
14398 </summary>
14399 <param name="sender">The source of the event.</param>
14400 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14401 </member>
14402 <member name="M:NAnt.Core.Project.OnTaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
14403 <summary>
14404 Dispatches the <see cref="F:NAnt.Core.Project.TaskFinished"/> event to the build listeners
14405 for this <see cref="T:NAnt.Core.Project"/>.
14406 </summary>
14407 <param name="sender">The source of the event.</param>
14408 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14409 </member>
14410 <member name="M:NAnt.Core.Project.OnMessageLogged(NAnt.Core.BuildEventArgs)">
14411 <summary>
14412 Dispatches a <see cref="F:NAnt.Core.Project.MessageLogged"/> event to the build listeners
14413 for this <see cref="T:NAnt.Core.Project"/>.
14414 </summary>
14415 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14416 </member>
14417 <member name="M:NAnt.Core.Project.Log(NAnt.Core.Level,System.String)">
14418 <summary>
14419 Writes a <see cref="T:NAnt.Core.Project"/> level message to the build log with
14420 the given <see cref="T:NAnt.Core.Level"/>.
14421 </summary>
14422 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
14423 <param name="message">The message to log.</param>
14424 </member>
14425 <member name="M:NAnt.Core.Project.Log(NAnt.Core.Level,System.String,System.Object[])">
14426 <summary>
14427 Writes a <see cref="T:NAnt.Core.Project"/> level formatted message to the build
14428 log with the given <see cref="T:NAnt.Core.Level"/>.
14429 </summary>
14430 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
14431 <param name="message">The message to log, containing zero or more format items.</param>
14432 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
14433 </member>
14434 <member name="M:NAnt.Core.Project.Log(NAnt.Core.Task,NAnt.Core.Level,System.String)">
14435 <summary>
14436 Writes a <see cref="T:NAnt.Core.Task"/> task level message to the build log
14437 with the given <see cref="T:NAnt.Core.Level"/>.
14438 </summary>
14439 <param name="task">The <see cref="T:NAnt.Core.Task"/> from which the message originated.</param>
14440 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
14441 <param name="message">The message to log.</param>
14442 </member>
14443 <member name="M:NAnt.Core.Project.Log(NAnt.Core.Target,NAnt.Core.Level,System.String)">
14444 <summary>
14445 Writes a <see cref="T:NAnt.Core.Target"/> level message to the build log with
14446 the given <see cref="T:NAnt.Core.Level"/>.
14447 </summary>
14448 <param name="target">The <see cref="T:NAnt.Core.Target"/> from which the message orignated.</param>
14449 <param name="messageLevel">The level to log at.</param>
14450 <param name="message">The message to log.</param>
14451 </member>
14452 <member name="M:NAnt.Core.Project.Execute">
14453 <summary>
14454 Executes the default target.
14455 </summary>
14456 <remarks>
14457 No top level error handling is done. Any <see cref="T:NAnt.Core.BuildException"/>
14458 will be passed onto the caller.
14459 </remarks>
14460 </member>
14461 <member name="M:NAnt.Core.Project.Execute(System.String)">
14462 <summary>
14463 Executes a specific target, and its dependencies.
14464 </summary>
14465 <param name="targetName">The name of the target to execute.</param>
14466 <remarks>
14467 Global tasks are not executed.
14468 </remarks>
14469 </member>
14470 <member name="M:NAnt.Core.Project.Execute(System.String,System.Boolean)">
14471 <summary>
14472 Executes a specific target.
14473 </summary>
14474 <param name="targetName">The name of the target to execute.</param>
14475 <param name="forceDependencies">Whether dependencies should be forced to execute</param>
14476 <remarks>
14477 Global tasks are not executed.
14478 </remarks>
14479 </member>
14480 <member name="M:NAnt.Core.Project.Run">
14481 <summary>
14482 Executes the default target and wraps in error handling and time
14483 stamping.
14484 </summary>
14485 <returns>
14486 <see langword="true" /> if the build was successful; otherwise,
14487 <see langword="false" />.
14488 </returns>
14489 </member>
14490 <member name="M:NAnt.Core.Project.CreateTask(System.Xml.XmlNode)">
14491 <summary>
14492 Creates a new <see ref="Task"/> from the given <see cref="T:System.Xml.XmlNode"/>.
14493 </summary>
14494 <param name="taskNode">The <see cref="T:NAnt.Core.Task"/> definition.</param>
14495 <returns>The new <see cref="T:NAnt.Core.Task"/> instance.</returns>
14496 </member>
14497 <member name="M:NAnt.Core.Project.CreateTask(System.Xml.XmlNode,NAnt.Core.Target)">
14498 <summary>
14499 Creates a new <see cref="T:NAnt.Core.Task"/> from the given <see cref="T:System.Xml.XmlNode"/>
14500 within a <see cref="T:NAnt.Core.Target"/>.
14501 </summary>
14502 <param name="taskNode">The <see cref="T:NAnt.Core.Task"/> definition.</param>
14503 <param name="target">The owner <see cref="T:NAnt.Core.Target"/>.</param>
14504 <returns>The new <see cref="T:NAnt.Core.Task"/> instance.</returns>
14505 </member>
14506 <member name="M:NAnt.Core.Project.ExpandProperties(System.String,NAnt.Core.Location)">
14507 <summary>
14508 Expands a <see cref="T:System.String"/> from known properties.
14509 </summary>
14510 <param name="input">The <see cref="T:System.String"/> with replacement tokens.</param>
14511 <param name="location">The location in the build file. Used to throw more accurate exceptions.</param>
14512 <returns>The expanded and replaced <see cref="T:System.String"/>.</returns>
14513 </member>
14514 <member name="M:NAnt.Core.Project.GetFullPath(System.String)">
14515 <summary>
14516 Combines the specified path with the <see cref="P:NAnt.Core.Project.BaseDirectory"/> of
14517 the <see cref="T:NAnt.Core.Project"/> to form a full path to file or directory.
14518 </summary>
14519 <param name="path">The relative or absolute path.</param>
14520 <returns>
14521 A rooted path, or the <see cref="P:NAnt.Core.Project.BaseDirectory"/> of the <see cref="T:NAnt.Core.Project"/>
14522 if the <paramref name="path"/> parameter is a null reference.
14523 </returns>
14524 </member>
14525 <member name="M:NAnt.Core.Project.CreateDefaultLogger">
14526 <summary>
14527 Creates the default <see cref="T:NAnt.Core.IBuildLogger"/> and attaches it to
14528 the <see cref="T:NAnt.Core.Project"/>.
14529 </summary>
14530 </member>
14531 <member name="M:NAnt.Core.Project.Indent">
14532 <summary>
14533 Increases the <see cref="P:NAnt.Core.Project.IndentationLevel"/> of the <see cref="T:NAnt.Core.Project"/>.
14534 </summary>
14535 </member>
14536 <member name="M:NAnt.Core.Project.Unindent">
14537 <summary>
14538 Decreases the <see cref="P:NAnt.Core.Project.IndentationLevel"/> of the <see cref="T:NAnt.Core.Project"/>.
14539 </summary>
14540 </member>
14541 <member name="M:NAnt.Core.Project.DetachBuildListeners">
14542 <summary>
14543 Detaches the currently attached <see cref="T:NAnt.Core.IBuildListener"/> instances
14544 from the <see cref="T:NAnt.Core.Project"/>.
14545 </summary>
14546 </member>
14547 <member name="M:NAnt.Core.Project.AttachBuildListeners(NAnt.Core.BuildListenerCollection)">
14548 <summary>
14549 Attaches the specified build listeners to the <see cref="T:NAnt.Core.Project"/>.
14550 </summary>
14551 <param name="listeners">The <see cref="T:NAnt.Core.IBuildListener"/> instances to attach to the <see cref="T:NAnt.Core.Project"/>.</param>
14552 <remarks>
14553 The currently attached <see cref="T:NAnt.Core.IBuildListener"/> instances will
14554 be detached before the new <see cref="T:NAnt.Core.IBuildListener"/> instances
14555 are attached.
14556 </remarks>
14557 </member>
14558 <member name="M:NAnt.Core.Project.CtorHelper(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32,NAnt.Core.Optimizations)">
14559 <summary>
14560 Inits stuff:
14561 <para>TypeFactory: Calls Initialize and AddProject </para>
14562 <para>Log.IndentSize set to 12</para>
14563 <para>Project properties are initialized ("nant.* stuff set")</para>
14564 <list type="nant.items">
14565 <listheader>NAnt Props:</listheader>
14566 <item>nant.filename</item>
14567 <item>nant.version</item>
14568 <item>nant.location</item>
14569 <item>nant.project.name</item>
14570 <item>nant.project.buildfile (if doc has baseuri)</item>
14571 <item>nant.project.basedir</item>
14572 <item>nant.project.default = defaultTarget</item>
14573 </list>
14574 </summary>
14575 <param name="doc">An <see cref="T:System.Xml.XmlDocument"/> representing the project definition.</param>
14576 <param name="threshold">The project message threshold.</param>
14577 <param name="indentLevel">The project indentation level.</param>
14578 <param name="optimization">Optimization flags.</param>
14579 <exception cref="T:System.ArgumentNullException"><paramref name="doc"/> is <see langword="null"/>.</exception>
14580 </member>
14581 <member name="M:NAnt.Core.Project.InitializeProjectDocument(System.Xml.XmlDocument)">
14582 <summary>
14583 This method is only meant to be used by the <see cref="T:NAnt.Core.Project"/>
14584 class and <see cref="T:NAnt.Core.Tasks.IncludeTask"/>.
14585 </summary>
14586 </member>
14587 <member name="M:NAnt.Core.Project.LoadBuildFile(System.String)">
14588 <summary>
14589 Creates a new <see cref="T:System.Xml.XmlDocument"/> based on the project
14590 definition.
14591 </summary>
14592 <param name="uriOrFilePath">
14593 <para>The full path to the build file.</para>
14594 <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
14595 </param>
14596 <returns>
14597 An <see cref="T:System.Xml.XmlDocument"/> based on the specified project
14598 definition.
14599 </returns>
14600 </member>
14601 <member name="M:NAnt.Core.Project.ConfigurePlatformProperties">
14602 <summary>
14603 Configures the platform properties for the current platform.
14604 </summary>
14605 <exception cref="T:NAnt.Core.BuildException">NAnt does not support the current platform.</exception>
14606 </member>
14607 <member name="M:NAnt.Core.Project.UpdateTargetFrameworkProperties">
14608 <summary>
14609 Updates dependent properties when the <see cref="P:NAnt.Core.Project.TargetFramework"/>
14610 is set.
14611 </summary>
14612 </member>
14613 <member name="M:NAnt.Core.Project.TopologicalTargetSort(System.String,NAnt.Core.TargetCollection)">
14614 <summary>
14615 Topologically sorts a set of targets.
14616 </summary>
14617 <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>
14618 <param name="targets">A collection of <see cref="T:NAnt.Core.Target"/> instances.</param>
14619 <returns>
14620 A collection of <see cref="T:NAnt.Core.Target"/> instances in sorted order.
14621 </returns>
14622 <exception cref="T:NAnt.Core.BuildException">There is a cyclic dependecy among the targets, or a named target does not exist.</exception>
14623 </member>
14624 <member name="M:NAnt.Core.Project.TopologicalTargetSort(System.String,NAnt.Core.TargetCollection,System.Collections.Hashtable,System.Collections.Stack,NAnt.Core.TargetCollection)">
14625 <summary>
14626 <para>
14627 Performs a single step in a recursive depth-first-search traversal
14628 of the target dependency tree.
14629 </para>
14630 <para>
14631 The current target is first set to the "visiting" state, and pushed
14632 onto the "visiting" stack.
14633 </para>
14634 <para>
14635 An exception is then thrown if any child of the current node is in
14636 the visiting state, as that implies a circular dependency. The
14637 exception contains details of the cycle, using elements of the
14638 "visiting" stack.
14639 </para>
14640 <para>
14641 If any child has not already been "visited", this method is called
14642 recursively on it.
14643 </para>
14644 <para>
14645 The current target is then added to the ordered list of targets.
14646 Note that this is performed after the children have been visited in
14647 order to get the correct order. The current target is set to the
14648 "visited" state.
14649 </para>
14650 <para>
14651 By the time this method returns, the ordered list contains the
14652 sequence of targets up to and including the current target.
14653 </para>
14654 </summary>
14655 <param name="root">The current target to inspect. Must not be <see langword="null"/>.</param>
14656 <param name="targets">A collection of <see cref="T:NAnt.Core.Target"/> instances.</param>
14657 <param name="state">A mapping from targets to states The states in question are "VISITING" and "VISITED". Must not be <see langword="null"/>.</param>
14658 <param name="visiting">A stack of targets which are currently being visited. Must not be <see langword="null"/>.</param>
14659 <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>
14660 <exception cref="T:NAnt.Core.BuildException">
14661 <para>A non-existent target is specified</para>
14662 <para>-or-</para>
14663 <para>A circular dependency is detected.</para>
14664 </exception>
14665 </member>
14666 <member name="M:NAnt.Core.Project.CreateCircularException(System.String,System.Collections.Stack)">
14667 <summary>
14668 Builds an appropriate exception detailing a specified circular
14669 dependency.
14670 </summary>
14671 <param name="end">The dependency to stop at. Must not be <see langword="null"/>.</param>
14672 <param name="stack">A stack of dependencies. Must not be <see langword="null"/>.</param>
14673 <returns>
14674 A <see cref="T:NAnt.Core.BuildException"/> detailing the specified circular
14675 dependency.
14676 </returns>
14677 </member>
14678 <member name="P:NAnt.Core.Project.IndentationLevel">
14679 <summary>
14680 Gets or sets the indendation level of the build output.
14681 </summary>
14682 <value>
14683 The indentation level of the build output.
14684 </value>
14685 <remarks>
14686 To change the <see cref="P:NAnt.Core.Project.IndentationLevel"/>, the <see cref="M:NAnt.Core.Project.Indent"/>
14687 and <see cref="M:NAnt.Core.Project.Unindent"/> methods should be used.
14688 </remarks>
14689 </member>
14690 <member name="P:NAnt.Core.Project.IndentationSize">
14691 <summary>
14692 Gets or sets the indentation size of the build output.
14693 </summary>
14694 <value>
14695 The indendation size of the build output.
14696 </value>
14697 </member>
14698 <member name="P:NAnt.Core.Project.Threshold">
14699 <summary>
14700 Gets or sets the default threshold level for build loggers.
14701 </summary>
14702 <value>
14703 The default threshold level for build loggers.
14704 </value>
14705 </member>
14706 <member name="P:NAnt.Core.Project.ProjectName">
14707 <summary>
14708 Gets the name of the <see cref="T:NAnt.Core.Project"/>.
14709 </summary>
14710 <value>
14711 The name of the <see cref="T:NAnt.Core.Project"/> or an empty <see cref="T:System.String"/>
14712 if no name is specified.
14713 </value>
14714 </member>
14715 <member name="P:NAnt.Core.Project.BaseDirectory">
14716 <summary>
14717 Gets or sets the base directory used for relative references.
14718 </summary>
14719 <value>
14720 The base directory used for relative references.
14721 </value>
14722 <exception cref="T:NAnt.Core.BuildException">The directory is not rooted.</exception>
14723 <remarks>
14724 <para>
14725 The <see cref="P:NAnt.Core.Project.BaseDirectory"/> gets and sets the built-in property
14726 named "nant.project.basedir".
14727 </para>
14728 </remarks>
14729 </member>
14730 <member name="P:NAnt.Core.Project.NamespaceManager">
14731 <summary>
14732 Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
14733 </summary>
14734 <value>
14735 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
14736 </value>
14737 <remarks>
14738 The <see cref="P:NAnt.Core.Project.NamespaceManager"/> defines the current namespace
14739 scope and provides methods for looking up namespace information.
14740 </remarks>
14741 </member>
14742 <member name="P:NAnt.Core.Project.BuildFileUri">
14743 <summary>
14744 Gets the <see cref="T:System.Uri"/> form of the current project definition.
14745 </summary>
14746 <value>
14747 The <see cref="T:System.Uri"/> form of the current project definition.
14748 </value>
14749 </member>
14750 <member name="P:NAnt.Core.Project.Frameworks">
14751 <summary>
14752 Gets a collection of available .NET frameworks.
14753 </summary>
14754 <value>
14755 A collection of available .NET frameworks.
14756 </value>
14757 </member>
14758 <member name="P:NAnt.Core.Project.RuntimeFramework">
14759 <summary>
14760 Gets the framework in which NAnt is currently running.
14761 </summary>
14762 <value>
14763 The framework in which NAnt is currently running.
14764 </value>
14765 </member>
14766 <member name="P:NAnt.Core.Project.TargetFramework">
14767 <summary>
14768 Gets or sets the framework to use for compilation.
14769 </summary>
14770 <value>
14771 The framework to use for compilation.
14772 </value>
14773 <exception cref="T:System.ArgumentNullException">The value specified is <see langword="null"/>.</exception>
14774 <exception cref="T:NAnt.Core.BuildException">The specified framework is not installed, or not configured correctly.</exception>
14775 <remarks>
14776 We will use compiler tools and system assemblies for this framework
14777 in framework-related tasks.
14778 </remarks>
14779 </member>
14780 <member name="P:NAnt.Core.Project.PlatformName">
14781 <summary>
14782 Gets the name of the platform on which NAnt is currently running.
14783 </summary>
14784 <value>
14785 The name of the platform on which NAnt is currently running.
14786 </value>
14787 <remarks>
14788 <para>
14789 Possible values are:
14790 </para>
14791 <list type="bullet">
14792 <item>
14793 <description>win32</description>
14794 </item>
14795 <item>
14796 <description>unix</description>
14797 </item>
14798 </list>
14799 </remarks>
14800 <exception cref="T:NAnt.Core.BuildException">NAnt does not support the current platform.</exception>
14801 </member>
14802 <member name="P:NAnt.Core.Project.CurrentTarget">
14803 <summary>
14804 Gets the current target.
14805 </summary>
14806 <value>
14807 The current target, or <see langword="null" /> if no target is
14808 executing.
14809 </value>
14810 </member>
14811 <member name="P:NAnt.Core.Project.BuildFileLocalName">
14812 <summary>
14813 Gets the path to the build file.
14814 </summary>
14815 <value>
14816 The path to the build file, or <see langword="null" /> if the build
14817 document is not file backed.
14818 </value>
14819 </member>
14820 <member name="P:NAnt.Core.Project.Document">
14821 <summary>
14822 Gets the active <see cref="T:NAnt.Core.Project"/> definition.
14823 </summary>
14824 <value>
14825 The active <see cref="T:NAnt.Core.Project"/> definition.
14826 </value>
14827 </member>
14828 <member name="P:NAnt.Core.Project.ConfigurationNode">
14829 <summary>
14830 Gets the <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize
14831 configuration settings.
14832 </summary>
14833 <value>
14834 The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize
14835 configuration settings.
14836 </value>
14837 </member>
14838 <member name="P:NAnt.Core.Project.DefaultTargetName">
14839 <remarks>
14840 Gets the name of the target that will be executed when no other
14841 build targets are specified.
14842 </remarks>
14843 <value>
14844 The name of the target that will be executed when no other
14845 build targets are specified, or <see langword="null" /> if no
14846 default target is specified in the build file.
14847 </value>
14848 </member>
14849 <member name="P:NAnt.Core.Project.Verbose">
14850 <summary>
14851 Gets a value indicating whether tasks should output more build log
14852 messages.
14853 </summary>
14854 <value>
14855 <see langword="true" /> if tasks should output more build log message;
14856 otherwise, <see langword="false" />.
14857 </value>
14858 </member>
14859 <member name="P:NAnt.Core.Project.BuildTargets">
14860 <summary>
14861 The list of targets to build.
14862 </summary>
14863 <remarks>
14864 Targets are built in the order they appear in the collection. If
14865 the collection is empty the default target will be built.
14866 </remarks>
14867 </member>
14868 <member name="P:NAnt.Core.Project.Properties">
14869 <summary>
14870 Gets the properties defined in this project.
14871 </summary>
14872 <value>The properties defined in this project.</value>
14873 <remarks>
14874 <para>
14875 This is the collection of properties that are defined by the system
14876 and property task statements.
14877 </para>
14878 <para>
14879 These properties can be used in expansion.
14880 </para>
14881 </remarks>
14882 </member>
14883 <member name="P:NAnt.Core.Project.FrameworkNeutralProperties">
14884 <summary>
14885 Gets the framework-neutral properties defined in the NAnt
14886 configuration file.
14887 </summary>
14888 <value>
14889 The framework-neutral properties defined in the NAnt configuration
14890 file.
14891 </value>
14892 <remarks>
14893 <para>
14894 This is the collection of read-only properties that are defined in
14895 the NAnt configuration file.
14896 </para>
14897 <para>
14898 These properties can only be used for expansion in framework-specific
14899 and framework-neutral configuration settings. These properties are
14900 not available for expansion in the build file.
14901 </para>
14902 </remarks>
14903 </member>
14904 <member name="P:NAnt.Core.Project.DataTypeReferences">
14905 <summary>
14906 Gets the <see cref="T:NAnt.Core.DataTypeBase"/> instances defined in this project.
14907 </summary>
14908 <value>
14909 The <see cref="T:NAnt.Core.DataTypeBase"/> instances defined in this project.
14910 </value>
14911 <remarks>
14912 <para>
14913 This is the collection of <see cref="T:NAnt.Core.DataTypeBase"/> instances that
14914 are defined by <see cref="T:NAnt.Core.DataTypeBase"/> (eg fileset) declarations.
14915 </para>
14916 </remarks>
14917 </member>
14918 <member name="P:NAnt.Core.Project.Targets">
14919 <summary>
14920 Gets the targets defined in this project.
14921 </summary>
14922 <value>
14923 The targets defined in this project.
14924 </value>
14925 </member>
14926 <member name="P:NAnt.Core.Project.BuildListeners">
14927 <summary>
14928 Gets the build listeners for this project.
14929 </summary>
14930 <value>
14931 The build listeners for this project.
14932 </value>
14933 </member>
14934 <member name="T:NAnt.Core.Optimizations">
14935 <summary>
14936 Allow the project construction to be optimized.
14937 </summary>
14938 <remarks>
14939 Use this with care!
14940 </remarks>
14941 </member>
14942 <member name="F:NAnt.Core.Optimizations.None">
14943 <summary>
14944 Do not perform any optimizations.
14945 </summary>
14946 </member>
14947 <member name="F:NAnt.Core.Optimizations.SkipAutomaticDiscovery">
14948 <summary>
14949 The project base directory must not be automatically scanned
14950 for extension assemblies.
14951 </summary>
14952 </member>
14953 <member name="F:NAnt.Core.Optimizations.SkipFrameworkConfiguration">
14954 <summary>
14955 Do not scan the project configuration for frameworks, and
14956 do not configure the runtime and target framework.
14957 </summary>
14958 </member>
14959 <member name="F:NAnt.Core.ProjectSettingsLoader.ScannedTasks">
14960 <summary>
14961 Holds a value indicating whether a scan for tasks, types and functions
14962 has already been performed for the current runtime framework.
14963 </summary>
14964 </member>
14965 <member name="M:NAnt.Core.ProjectSettingsLoader.#ctor(NAnt.Core.Project)">
14966 <summary>
14967 Initializes a new instance of the <see cref="T:NAnt.Core.ProjectSettingsLoader"/>
14968 class for the given <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/>.
14969 </summary>
14970 <param name="project">The <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> that should be configured.</param>
14971 </member>
14972 <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessSettings">
14973 <summary>
14974 Loads and processes settings from the specified <see cref="T:System.Xml.XmlNode"/>
14975 of the configuration file.
14976 </summary>
14977 </member>
14978 <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessFrameworks(System.Xml.XmlNode)">
14979 <summary>
14980 Processes the framework nodes of the given platform node.
14981 </summary>
14982 <param name="platformNode">An <see cref="T:System.Xml.XmlNode"/> representing the platform on which NAnt is running.</param>
14983 </member>
14984 <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessGlobalProperties(System.Xml.XmlNodeList)">
14985 <summary>
14986 Reads the list of global properties specified in the NAnt configuration
14987 file.
14988 </summary>
14989 <param name="propertyNodes">An <see cref="T:System.Xml.XmlNodeList"/> representing global properties.</param>
14990 </member>
14991 <member name="M:NAnt.Core.ProjectSettingsLoader.GetXmlAttributeValue(System.Xml.XmlNode,System.String)">
14992 <summary>
14993 Gets the value of the specified attribute from the specified node.
14994 </summary>
14995 <param name="xmlNode">The node of which the attribute value should be retrieved.</param>
14996 <param name="attributeName">The attribute of which the value should be returned.</param>
14997 <returns>
14998 The value of the attribute with the specified name or <see langword="null" />
14999 if the attribute does not exist or has no value.
15000 </returns>
15001 </member>
15002 <member name="P:NAnt.Core.ProjectSettingsLoader.Project">
15003 <summary>
15004 Gets the underlying <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> instance.
15005 </summary>
15006 <value>
15007 The underlying <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> instance.
15008 </value>
15009 </member>
15010 <member name="P:NAnt.Core.ProjectSettingsLoader.NamespaceManager">
15011 <summary>
15012 Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
15013 </summary>
15014 <value>
15015 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
15016 </value>
15017 <remarks>
15018 The <see cref="P:NAnt.Core.ProjectSettingsLoader.NamespaceManager"/> defines the current namespace
15019 scope and provides methods for looking up namespace information.
15020 </remarks>
15021 </member>
15022 <member name="F:NAnt.Core.PropertyDictionary.Visiting">
15023 <summary>
15024 Constant for the "visiting" state, used when traversing a DFS of
15025 property references.
15026 </summary>
15027 </member>
15028 <member name="F:NAnt.Core.PropertyDictionary.Visited">
15029 <summary>
15030 Constant for the "visited" state, used when travesing a DFS of
15031 property references.
15032 </summary>
15033 </member>
15034 <member name="M:NAnt.Core.PropertyDictionary.#ctor(NAnt.Core.Project)">
15035 <summary>
15036 Initializes a new instance of the <see cref="T:NAnt.Core.PropertyDictionary"/>
15037 class holding properties for the given <see cref="P:NAnt.Core.PropertyDictionary.Project"/>
15038 instance.
15039 </summary>
15040 <param name="project">The project for which the dictionary will hold properties.</param>
15041 </member>
15042 <member name="M:NAnt.Core.PropertyDictionary.OnInsert(System.Object,System.Object)">
15043 <summary>
15044 Performs additional custom processes before inserting a new element
15045 into the <see cref="T:System.Collections.DictionaryBase"/> instance.
15046 </summary>
15047 <param name="key">The key of the element to insert.</param>
15048 <param name="value">The value of the element to insert.</param>
15049 </member>
15050 <member name="M:NAnt.Core.PropertyDictionary.OnRemove(System.Object,System.Object)">
15051 <summary>
15052 Performs additional custom processes before removing an element
15053 from the <see cref="T:System.Collections.DictionaryBase"/> instance.
15054 </summary>
15055 <param name="key">The key of the element to remove.</param>
15056 <param name="value">The value of the element to remove.</param>
15057 </member>
15058 <member name="M:NAnt.Core.PropertyDictionary.OnValidate(System.Object,System.Object)">
15059 <summary>
15060 Performs additional custom processes when validating the element
15061 with the specified key and value.
15062 </summary>
15063 <param name="key">The key of the element to validate.</param>
15064 <param name="value">The value of the element to validate.</param>
15065 </member>
15066 <member name="M:NAnt.Core.PropertyDictionary.AddReadOnly(System.String,System.String)">
15067 <summary>
15068 Adds a property that cannot be changed.
15069 </summary>
15070 <param name="name">The name of the property.</param>
15071 <param name="value">The value to assign to the property.</param>
15072 <remarks>
15073 Properties added with this method can never be changed. Note that
15074 they are removed if the <see cref="M:System.Collections.DictionaryBase.Clear"/> method is called.
15075 </remarks>
15076 </member>
15077 <member name="M:NAnt.Core.PropertyDictionary.MarkDynamic(System.String)">
15078 <summary>
15079 Marks a property as a property of which the value is expanded at
15080 execution time.
15081 </summary>
15082 <param name="name">The name of the property to mark as dynamic.</param>
15083 </member>
15084 <member name="M:NAnt.Core.PropertyDictionary.Add(System.String,System.String)">
15085 <summary>
15086 Adds a property to the collection.
15087 </summary>
15088 <param name="name">The name of the property.</param>
15089 <param name="value">The value to assign to the property.</param>
15090 </member>
15091 <member name="M:NAnt.Core.PropertyDictionary.IsReadOnlyProperty(System.String)">
15092 <summary>
15093 Determines whether the specified property is listed as read-only.
15094 </summary>
15095 <param name="name">The name of the property to check.</param>
15096 <returns>
15097 <see langword="true" /> if the property is listed as read-only;
15098 otherwise, <see langword="false" />.
15099 </returns>
15100 </member>
15101 <member name="M:NAnt.Core.PropertyDictionary.IsDynamicProperty(System.String)">
15102 <summary>
15103 Determines whether the specified property is listed as dynamic.
15104 </summary>
15105 <param name="name">The name of the property to check.</param>
15106 <returns>
15107 <see langword="true" /> if the property is listed as dynamic;
15108 otherwise, <see langword="false" />.
15109 </returns>
15110 </member>
15111 <member name="M:NAnt.Core.PropertyDictionary.Inherit(NAnt.Core.PropertyDictionary,System.Collections.Specialized.StringCollection)">
15112 <summary>
15113 Inherits properties from an existing property dictionary Instance.
15114 </summary>
15115 <param name="source">Property list to inherit.</param>
15116 <param name="excludes">The list of properties to exclude during inheritance.</param>
15117 </member>
15118 <member name="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location)">
15119 <summary>
15120 Expands a <see cref="T:System.String"/> from known properties.
15121 </summary>
15122 <param name="input">The replacement tokens.</param>
15123 <param name="location">The <see cref="T:NAnt.Core.Location"/> to pass through for any exceptions.</param>
15124 <returns>The expanded and replaced string.</returns>
15125 </member>
15126 <member name="M:NAnt.Core.PropertyDictionary.Contains(System.String)">
15127 <summary>
15128 Determines whether a property already exists.
15129 </summary>
15130 <param name="name">The name of the property to check.</param>
15131 <returns>
15132 <see langword="true" /> if the specified property already exists;
15133 otherwise, <see langword="false" />.
15134 </returns>
15135 </member>
15136 <member name="M:NAnt.Core.PropertyDictionary.Remove(System.String)">
15137 <summary>
15138 Removes the property with the specified name.
15139 </summary>
15140 <param name="name">The name of the property to remove.</param>
15141 </member>
15142 <member name="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location,System.Collections.Hashtable,System.Collections.Stack)">
15143 <summary>
15144 Expands a <see cref="T:System.String"/> from known properties.
15145 </summary>
15146 <param name="input">The replacement tokens.</param>
15147 <param name="location">The <see cref="T:NAnt.Core.Location"/> to pass through for any exceptions.</param>
15148 <param name="state">A mapping from properties to states. The states in question are "VISITING" and "VISITED". Must not be <see langword="null"/>.</param>
15149 <param name="visiting">A stack of properties which are currently being visited. Must not be <see langword="null"/>.</param>
15150 <returns>The expanded and replaced string.</returns>
15151 </member>
15152 <member name="M:NAnt.Core.PropertyDictionary.EvaluateEmbeddedExpressions(System.String,NAnt.Core.Location,System.Collections.Hashtable,System.Collections.Stack)">
15153 <summary>
15154 Evaluates the given expression string and returns the result
15155 </summary>
15156 <param name="input"></param>
15157 <param name="location"></param>
15158 <param name="state"></param>
15159 <param name="visiting"></param>
15160 <returns></returns>
15161 </member>
15162 <member name="M:NAnt.Core.PropertyDictionary.CheckDeprecation(System.String)">
15163 <summary>
15164 Checks whether the specified property is deprecated.
15165 </summary>
15166 <param name="name">The property to check.</param>
15167 </member>
15168 <member name="M:NAnt.Core.PropertyDictionary.CreateCircularException(System.String,System.Collections.Stack)">
15169 <summary>
15170 Builds an appropriate exception detailing a specified circular
15171 reference.
15172 </summary>
15173 <param name="end">The property reference to stop at. Must not be <see langword="null"/>.</param>
15174 <param name="stack">A stack of property references. Must not be <see langword="null"/>.</param>
15175 <returns>
15176 A <see cref="T:NAnt.Core.BuildException"/> detailing the specified circular
15177 dependency.
15178 </returns>
15179 </member>
15180 <member name="F:NAnt.Core.PropertyDictionary._readOnlyProperties">
15181 <summary>
15182 Maintains a list of the property names that are readonly.
15183 </summary>
15184 </member>
15185 <member name="F:NAnt.Core.PropertyDictionary._dynamicProperties">
15186 <summary>
15187 Maintains a list of the property names of which the value is expanded
15188 on usage, not at initalization.
15189 </summary>
15190 </member>
15191 <member name="F:NAnt.Core.PropertyDictionary._project">
15192 <summary>
15193 The project for which the dictionary holds properties.
15194 </summary>
15195 </member>
15196 <member name="P:NAnt.Core.PropertyDictionary.Item(System.String)">
15197 <summary>
15198 Indexer property.
15199 </summary>
15200 </member>
15201 <member name="P:NAnt.Core.PropertyDictionary.Project">
15202 <summary>
15203 Gets the project for which the dictionary holds properties.
15204 </summary>
15205 <value>
15206 The project for which the dictionary holds properties.
15207 </value>
15208 </member>
15209 <member name="M:NAnt.Core.Target.#ctor">
15210 <summary>
15211 Initializes a new instance of the <see cref="T:NAnt.Core.Target"/> class.
15212 </summary>
15213 </member>
15214 <member name="M:NAnt.Core.Target.System#ICloneable#Clone">
15215 <summary>
15216 Creates a shallow copy of the <see cref="T:NAnt.Core.Target"/>.
15217 </summary>
15218 <returns>
15219 A shallow copy of the <see cref="T:NAnt.Core.Target"/>.
15220 </returns>
15221 </member>
15222 <member name="M:NAnt.Core.Target.Clone">
15223 <summary>
15224 Creates a shallow copy of the <see cref="T:NAnt.Core.Target"/>.
15225 </summary>
15226 <returns>
15227 A shallow copy of the <see cref="T:NAnt.Core.Target"/>.
15228 </returns>
15229 </member>
15230 <member name="M:NAnt.Core.Target.Execute">
15231 <summary>
15232 Executes dependent targets first, then the target.
15233 </summary>
15234 </member>
15235 <member name="P:NAnt.Core.Target.Executed">
15236 <summary>
15237 This indicates whether the target has already executed.
15238 </summary>
15239 </member>
15240 <member name="P:NAnt.Core.Target.Name">
15241 <summary>
15242 The name of the target.
15243 </summary>
15244 <remarks>
15245 <para>
15246 Hides <see cref="P:NAnt.Core.Element.Name"/> to have <see cref="T:NAnt.Core.Target"/>
15247 return the name of target, not the name of XML element - which
15248 would always be <c>target</c>.
15249 </para>
15250 <para>
15251 Note: Properties are not allowed in the name.
15252 </para>
15253 </remarks>
15254 </member>
15255 <member name="P:NAnt.Core.Target.IfCondition">
15256 <summary>
15257 If <see langword="true" /> then the target will be executed;
15258 otherwise, skipped. The default is <see langword="true" />.
15259 </summary>
15260 </member>
15261 <member name="P:NAnt.Core.Target.IfDefined">
15262 <summary>
15263 Gets a value indicating whether the target should be executed.
15264 </summary>
15265 <value>
15266 <see langword="true" /> if the target should be executed; otherwise,
15267 <see langword="false" />.
15268 </value>
15269 </member>
15270 <member name="P:NAnt.Core.Target.UnlessCondition">
15271 <summary>
15272 Opposite of <see cref="P:NAnt.Core.Target.IfDefined"/>. If <see langword="false"/>
15273 then the target will be executed; otherwise, skipped. The default
15274 is <see langword="false"/>.
15275 </summary>
15276 </member>
15277 <member name="P:NAnt.Core.Target.UnlessDefined">
15278 <summary>
15279 Gets a value indicating whether the target should NOT be executed.
15280 </summary>
15281 <value>
15282 <see langword="true" /> if the target should NOT be executed;
15283 otherwise, <see langword="false" />.
15284 </value>
15285 </member>
15286 <member name="P:NAnt.Core.Target.Description">
15287 <summary>
15288 The description of the target.
15289 </summary>
15290 </member>
15291 <member name="P:NAnt.Core.Target.DependsListString">
15292 <summary>
15293 Space separated list of targets that this target depends on.
15294 </summary>
15295 </member>
15296 <member name="P:NAnt.Core.Target.Dependencies">
15297 <summary>
15298 A collection of target names that must be executed before this
15299 target.
15300 </summary>
15301 </member>
15302 <member name="M:NAnt.Core.TargetCollection.Find(System.String)">
15303 <summary>
15304 Finds a target by name.
15305 </summary>
15306 <param name="targetName">The name of the target to find.</param>
15307 <returns>
15308 The <see cref="T:NAnt.Core.Target"/> with the specified name, or
15309 <see langword="null"/> if no <see cref="T:NAnt.Core.Target"/> exists with
15310 the given name.
15311 </returns>
15312 </member>
15313 <member name="M:NAnt.Core.TargetCollection.ToString(System.String)">
15314 <summary>
15315 Gets the names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>
15316 combined into one list separated by the given <see cref="T:System.String"/>.
15317 </summary>
15318 <returns>
15319 A <see cref="T:System.String"/> that contains a list of the names of the
15320 targets in the <see cref="T:NAnt.Core.TargetCollection"/>, separated by
15321 the specified <paramref name="separator"/>.
15322 </returns>
15323 </member>
15324 <member name="M:NAnt.Core.TargetCollection.ToString">
15325 <summary>
15326 Gets the names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>
15327 combined into one comma-separated list.
15328 </summary>
15329 <returns>
15330 A <see cref="T:System.String"/> that contains a comma-separated list of the
15331 names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>.
15332 </returns>
15333 </member>
15334 <member name="M:NAnt.Core.TaskBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
15335 <summary>
15336 Creates a new instance of the <see cref="T:NAnt.Core.TaskBuilder"/> class
15337 for the specified <see cref="T:NAnt.Core.Task"/> class in the specified
15338 <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.
15339 </summary>
15340 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.Task"/>.</param>
15341 <param name="className">The class representing the <see cref="T:NAnt.Core.Task"/>.</param>
15342 </member>
15343 <member name="P:NAnt.Core.TaskBuilder.ClassName">
15344 <summary>
15345 Gets the name of the <see cref="T:NAnt.Core.Task"/> class that can be created
15346 using this <see cref="T:NAnt.Core.TaskBuilder"/>.
15347 </summary>
15348 <value>
15349 The name of the <see cref="T:NAnt.Core.Task"/> class that can be created using
15350 this <see cref="T:NAnt.Core.TaskBuilder"/>.
15351 </value>
15352 </member>
15353 <member name="P:NAnt.Core.TaskBuilder.TaskName">
15354 <summary>
15355 Gets the name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/>
15356 can create.
15357 </summary>
15358 <value>
15359 The name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/> can
15360 create.
15361 </value>
15362 </member>
15363 <member name="T:NAnt.Core.TaskBuilderCollection">
15364 <summary>
15365 Contains a strongly typed collection of <see cref="T:NAnt.Core.TaskBuilder"/> objects.
15366 </summary>
15367 </member>
15368 <member name="M:NAnt.Core.TaskBuilderCollection.#ctor">
15369 <summary>
15370 Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class.
15371 </summary>
15372 </member>
15373 <member name="M:NAnt.Core.TaskBuilderCollection.#ctor(NAnt.Core.TaskBuilderCollection)">
15374 <summary>
15375 Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class
15376 with the specified <see cref="T:NAnt.Core.TaskBuilderCollection"/> instance.
15377 </summary>
15378 </member>
15379 <member name="M:NAnt.Core.TaskBuilderCollection.#ctor(NAnt.Core.TaskBuilder[])">
15380 <summary>
15381 Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class
15382 with the specified array of <see cref="T:NAnt.Core.TaskBuilder"/> instances.
15383 </summary>
15384 </member>
15385 <member name="M:NAnt.Core.TaskBuilderCollection.Add(NAnt.Core.TaskBuilder)">
15386 <summary>
15387 Adds a <see cref="T:NAnt.Core.TaskBuilder"/> to the end of the collection.
15388 </summary>
15389 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to be added to the end of the collection.</param>
15390 <returns>The position into which the new element was inserted.</returns>
15391 </member>
15392 <member name="M:NAnt.Core.TaskBuilderCollection.AddRange(NAnt.Core.TaskBuilder[])">
15393 <summary>
15394 Adds the elements of a <see cref="T:NAnt.Core.TaskBuilder"/> array to the end of the collection.
15395 </summary>
15396 <param name="items">The array of <see cref="T:NAnt.Core.TaskBuilder"/> elements to be added to the end of the collection.</param>
15397 </member>
15398 <member name="M:NAnt.Core.TaskBuilderCollection.AddRange(NAnt.Core.TaskBuilderCollection)">
15399 <summary>
15400 Adds the elements of a <see cref="T:NAnt.Core.TaskBuilderCollection"/> to the end of the collection.
15401 </summary>
15402 <param name="items">The <see cref="T:NAnt.Core.TaskBuilderCollection"/> to be added to the end of the collection.</param>
15403 </member>
15404 <member name="M:NAnt.Core.TaskBuilderCollection.Contains(NAnt.Core.TaskBuilder)">
15405 <summary>
15406 Determines whether a <see cref="T:NAnt.Core.TaskBuilder"/> is in the collection.
15407 </summary>
15408 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to locate in the collection.</param>
15409 <returns>
15410 <see langword="true"/> if <paramref name="item"/> is found in the
15411 collection; otherwise, <see langword="false"/>.
15412 </returns>
15413 </member>
15414 <member name="M:NAnt.Core.TaskBuilderCollection.Contains(System.String)">
15415 <summary>
15416 Determines whether a <see cref="T:NAnt.Core.TaskBuilder"/> for the specified
15417 task is in the collection.
15418 </summary>
15419 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.TaskBuilder"/> should be located in the collection.</param>
15420 <returns>
15421 <see langword="true"/> if a <see cref="T:NAnt.Core.TaskBuilder"/> for the
15422 specified task is found in the collection; otherwise, <see langword="false"/>.
15423 </returns>
15424 </member>
15425 <member name="M:NAnt.Core.TaskBuilderCollection.CopyTo(NAnt.Core.TaskBuilder[],System.Int32)">
15426 <summary>
15427 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
15428 </summary>
15429 <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>
15430 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
15431 </member>
15432 <member name="M:NAnt.Core.TaskBuilderCollection.IndexOf(NAnt.Core.TaskBuilder)">
15433 <summary>
15434 Retrieves the index of a specified <see cref="T:NAnt.Core.TaskBuilder"/> object in the collection.
15435 </summary>
15436 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> object for which the index is returned.</param>
15437 <returns>
15438 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.
15439 </returns>
15440 </member>
15441 <member name="M:NAnt.Core.TaskBuilderCollection.Insert(System.Int32,NAnt.Core.TaskBuilder)">
15442 <summary>
15443 Inserts a <see cref="T:NAnt.Core.TaskBuilder"/> into the collection at the specified index.
15444 </summary>
15445 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
15446 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to insert.</param>
15447 </member>
15448 <member name="M:NAnt.Core.TaskBuilderCollection.GetEnumerator">
15449 <summary>
15450 Returns an enumerator that can iterate through the collection.
15451 </summary>
15452 <returns>
15453 A <see cref="T:NAnt.Core.TaskBuilderEnumerator"/> for the entire collection.
15454 </returns>
15455 </member>
15456 <member name="M:NAnt.Core.TaskBuilderCollection.Remove(NAnt.Core.TaskBuilder)">
15457 <summary>
15458 Removes a member from the collection.
15459 </summary>
15460 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to remove from the collection.</param>
15461 </member>
15462 <member name="P:NAnt.Core.TaskBuilderCollection.Item(System.Int32)">
15463 <summary>
15464 Gets or sets the element at the specified index.
15465 </summary>
15466 <param name="index">The zero-based index of the element to get or set.</param>
15467 </member>
15468 <member name="P:NAnt.Core.TaskBuilderCollection.Item(System.String)">
15469 <summary>
15470 Gets the <see cref="T:NAnt.Core.TaskBuilder"/> for the specified task.
15471 </summary>
15472 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.TaskBuilder"/> should be located in the collection.</param>
15473 </member>
15474 <member name="T:NAnt.Core.TaskBuilderEnumerator">
15475 <summary>
15476 Enumerates the <see cref="T:NAnt.Core.TaskBuilder"/> elements of a <see cref="T:NAnt.Core.TaskBuilderCollection"/>.
15477 </summary>
15478 </member>
15479 <member name="M:NAnt.Core.TaskBuilderEnumerator.#ctor(NAnt.Core.TaskBuilderCollection)">
15480 <summary>
15481 Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderEnumerator"/> class
15482 with the specified <see cref="T:NAnt.Core.TaskBuilderCollection"/>.
15483 </summary>
15484 <param name="arguments">The collection that should be enumerated.</param>
15485 </member>
15486 <member name="M:NAnt.Core.TaskBuilderEnumerator.MoveNext">
15487 <summary>
15488 Advances the enumerator to the next element of the collection.
15489 </summary>
15490 <returns>
15491 <see langword="true" /> if the enumerator was successfully advanced
15492 to the next element; <see langword="false" /> if the enumerator has
15493 passed the end of the collection.
15494 </returns>
15495 </member>
15496 <member name="M:NAnt.Core.TaskBuilderEnumerator.Reset">
15497 <summary>
15498 Sets the enumerator to its initial position, which is before the
15499 first element in the collection.
15500 </summary>
15501 </member>
15502 <member name="P:NAnt.Core.TaskBuilderEnumerator.Current">
15503 <summary>
15504 Gets the current element in the collection.
15505 </summary>
15506 <returns>
15507 The current element in the collection.
15508 </returns>
15509 </member>
15510 <member name="T:NAnt.Core.TypeFactory">
15511 <summary>
15512 Comprises all of the loaded, and available, tasks.
15513 Use these static methods to register, initialize and create a task.
15514 </summary>
15515 </member>
15516 <member name="M:NAnt.Core.TypeFactory.ScanAssembly(System.String,NAnt.Core.Task)">
15517 <summary>
15518 Scans the given assembly for tasks, types, functions and filters.
15519 </summary>
15520 <param name="assemblyFile">The assembly to scan for tasks, types, functions and filters.</param>
15521 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15522 </member>
15523 <member name="M:NAnt.Core.TypeFactory.ScanAssembly(System.Reflection.Assembly,NAnt.Core.Task)">
15524 <summary>
15525 Scans the given assembly for tasks, types, functions and filters.
15526 </summary>
15527 <param name="assembly">The assembly to scan for tasks, types, functions and filters.</param>
15528 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15529 <returns>
15530 <see langword="true"/> if <paramref name="assembly"/> contains at
15531 least one "extension"; otherwise, <see langword="false"/>.
15532 </returns>
15533 </member>
15534 <member name="M:NAnt.Core.TypeFactory.ScanDir(System.String,NAnt.Core.Task,System.Boolean)">
15535 <summary>
15536 Scans the path for any task assemblies and adds them.
15537 </summary>
15538 <param name="path">The directory to scan in.</param>
15539 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15540 <param name="failOnError"><see cref="T:System.Boolean"/> indicating whether scanning of the directory should halt on first error.</param>
15541 </member>
15542 <member name="M:NAnt.Core.TypeFactory.AddProject(NAnt.Core.Project)">
15543 <summary>
15544 Adds any task assemblies in the project base directory
15545 and its <c>tasks</c> subdirectory.
15546 </summary>
15547 <param name="project">The project to work from.</param>
15548 </member>
15549 <member name="M:NAnt.Core.TypeFactory.AddProject(NAnt.Core.Project,System.Boolean)">
15550 <summary>
15551 Registers the project with <see cref="T:NAnt.Core.TypeFactory"/>, and optionally
15552 scan the <see cref="P:NAnt.Core.Project.BaseDirectory"/> for extension assemblies.
15553 </summary>
15554 <param name="project">The project to work from.</param>
15555 <param name="scan">Specified whether to scan the <see cref="P:NAnt.Core.Project.BaseDirectory"/> for extension assemblies.</param>
15556 </member>
15557 <member name="M:NAnt.Core.TypeFactory.LookupFunction(System.String,NAnt.Core.Project)">
15558 <summary>
15559 Looks up a function by name.
15560 </summary>
15561 <param name="methodName">The name of the function to lookup, including namespace prefix.</param>
15562 <param name="project">The <see cref="T:NAnt.Core.Project"/> in which the function is invoked.</param>
15563 <returns>
15564 A <see cref="T:System.Reflection.MethodInfo"/> representing the function, or
15565 <see langword="null"/> if a function with the given name does not
15566 exist.
15567 </returns>
15568 </member>
15569 <member name="M:NAnt.Core.TypeFactory.CreateTask(System.Xml.XmlNode,NAnt.Core.Project)">
15570 <summary>
15571 Creates a new <see cref="T:NAnt.Core.Task"/> instance for the given XML and
15572 <see cref="T:NAnt.Core.Project"/>.
15573 </summary>
15574 <param name="taskNode">The XML to initialize the task with.</param>
15575 <param name="proj">The <see cref="T:NAnt.Core.Project"/> that the <see cref="T:NAnt.Core.Task"/> belongs to.</param>
15576 <returns>
15577 The new <see cref="T:NAnt.Core.Task"/> instance.
15578 </returns>
15579 </member>
15580 <member name="M:NAnt.Core.TypeFactory.ScanTypeForTasks(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
15581 <summary>
15582 Scans a given <see cref="T:System.Type"/> for tasks.
15583 </summary>
15584 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
15585 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
15586 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15587 <returns>
15588 <see langword="true"/> if <paramref name="type"/> represents a
15589 <see cref="T:NAnt.Core.Task"/>; otherwise, <see langword="false"/>.
15590 </returns>
15591 </member>
15592 <member name="M:NAnt.Core.TypeFactory.ScanTypeForDataTypes(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
15593 <summary>
15594 Scans a given <see cref="T:System.Type"/> for data type.
15595 </summary>
15596 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
15597 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
15598 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15599 <returns>
15600 <see langword="true"/> if <paramref name="type"/> represents a
15601 data type; otherwise, <see langword="false"/>.
15602 </returns>
15603 </member>
15604 <member name="M:NAnt.Core.TypeFactory.ScanTypeForFunctions(System.Type,NAnt.Core.Task)">
15605 <summary>
15606 Scans a given <see cref="T:System.Type"/> for functions.
15607 </summary>
15608 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
15609 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15610 <returns>
15611 <see langword="true"/> if <paramref name="type"/> represents a
15612 valid set of funtions; otherwise, <see langword="false"/>.
15613 </returns>
15614 </member>
15615 <member name="M:NAnt.Core.TypeFactory.ScanTypeForFilters(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
15616 <summary>
15617 Scans a given <see cref="T:System.Type"/> for filters.
15618 </summary>
15619 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
15620 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
15621 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15622 <returns>
15623 <see langword="true"/> if <paramref name="type"/> represents a
15624 <see cref="T:NAnt.Core.Filters.Filter"/>; otherwise, <see langword="false"/>.
15625 </returns>
15626 </member>
15627 <member name="P:NAnt.Core.TypeFactory.TaskBuilders">
15628 <summary>
15629 Gets the list of loaded <see cref="T:NAnt.Core.TaskBuilder"/> instances.
15630 </summary>
15631 <value>
15632 List of loaded <see cref="T:NAnt.Core.TaskBuilder"/> instances.
15633 </value>
15634 </member>
15635 <member name="P:NAnt.Core.TypeFactory.DataTypeBuilders">
15636 <summary>
15637 Gets the list of loaded <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
15638 </summary>
15639 <value>
15640 List of loaded <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
15641 </value>
15642 </member>
15643 <member name="P:NAnt.Core.TypeFactory.FilterBuilders">
15644 <summary>
15645 Gets the list of loaded <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
15646 </summary>
15647 <value>
15648 List of loaded <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
15649 </value>
15650 </member>
15651 <member name="M:NAnt.Core.ValidationException.#ctor">
15652 <summary>
15653 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15654 class.
15655 </summary>
15656 </member>
15657 <member name="M:NAnt.Core.ValidationException.#ctor(System.String)">
15658 <summary>
15659 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15660 class with a descriptive message.
15661 </summary>
15662 <param name="message">A descriptive message to include with the exception.</param>
15663 </member>
15664 <member name="M:NAnt.Core.ValidationException.#ctor(System.String,System.Exception)">
15665 <summary>
15666 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15667 class with the specified descriptive message and inner exception.
15668 </summary>
15669 <param name="message">A descriptive message to include with the exception.</param>
15670 <param name="innerException">A nested exception that is the cause of the current exception.</param>
15671 </member>
15672 <member name="M:NAnt.Core.ValidationException.#ctor(System.String,NAnt.Core.Location)">
15673 <summary>
15674 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15675 class with a descriptive message and the location in the build file
15676 that caused the exception.
15677 </summary>
15678 <param name="message">A descriptive message to include with the exception.</param>
15679 <param name="location">The location in the build file where the exception occured.</param>
15680 </member>
15681 <member name="M:NAnt.Core.ValidationException.#ctor(System.String,NAnt.Core.Location,System.Exception)">
15682 <summary>
15683 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15684 class with a descriptive message, the location in the build file and
15685 an instance of the exception that is the cause of the current
15686 exception.
15687 </summary>
15688 <param name="message">A descriptive message to include with the exception.</param>
15689 <param name="location">The location in the build file where the exception occured.</param>
15690 <param name="innerException">A nested exception that is the cause of the current exception.</param>
15691 </member>
15692 <member name="M:NAnt.Core.ValidationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
15693 <summary>
15694 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15695 class with serialized data.
15696 </summary>
15697 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
15698 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
15699 </member>
15700 <member name="T:NAnt.Core.XmlLogger">
15701 <summary>
15702 Used to wrap log messages in xml <message/> elements.
15703 </summary>
15704 </member>
15705 <member name="F:NAnt.Core.XmlLogger._projectStack">
15706 <summary>
15707 Holds the stack of currently executing projects.
15708 </summary>
15709 </member>
15710 <member name="M:NAnt.Core.XmlLogger.#ctor">
15711 <summary>
15712 Initializes a new instance of the <see cref="T:NAnt.Core.XmlLogger"/> class.
15713 </summary>
15714 </member>
15715 <member name="M:NAnt.Core.XmlLogger.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
15716 <summary>
15717 Initializes a new instance of the <see cref="T:NAnt.Core.XmlLogger"/> class
15718 with serialized data.
15719 </summary>
15720 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
15721 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
15722 </member>
15723 <member name="M:NAnt.Core.XmlLogger.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
15724 <summary>
15725 Populates <paramref name="info"/> with the data needed to serialize
15726 the <see cref="T:NAnt.Core.XmlLogger"/> instance.
15727 </summary>
15728 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
15729 <param name="context">The destination for this serialization.</param>
15730 </member>
15731 <member name="M:NAnt.Core.XmlLogger.ToString">
15732 <summary>
15733 Returns the contents of log captured.
15734 </summary>
15735 </member>
15736 <member name="M:NAnt.Core.XmlLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
15737 <summary>
15738 Signals that a build has started.
15739 </summary>
15740 <param name="sender">The source of the event.</param>
15741 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15742 <remarks>
15743 This event is fired before any targets have started.
15744 </remarks>
15745 </member>
15746 <member name="M:NAnt.Core.XmlLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
15747 <summary>
15748 Signals that the last target has finished.
15749 </summary>
15750 <param name="sender">The source of the event.</param>
15751 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15752 <remarks>
15753 This event will still be fired if an error occurred during the build.
15754 </remarks>
15755 </member>
15756 <member name="M:NAnt.Core.XmlLogger.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
15757 <summary>
15758 Signals that a target has started.
15759 </summary>
15760 <param name="sender">The source of the event.</param>
15761 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15762 </member>
15763 <member name="M:NAnt.Core.XmlLogger.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
15764 <summary>
15765 Signals that a target has finished.
15766 </summary>
15767 <param name="sender">The source of the event.</param>
15768 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15769 <remarks>
15770 This event will still be fired if an error occurred during the build.
15771 </remarks>
15772 </member>
15773 <member name="M:NAnt.Core.XmlLogger.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
15774 <summary>
15775 Signals that a task has started.
15776 </summary>
15777 <param name="sender">The source of the event.</param>
15778 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15779 </member>
15780 <member name="M:NAnt.Core.XmlLogger.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
15781 <summary>
15782 Signals that a task has finished.
15783 </summary>
15784 <param name="sender">The source of the event.</param>
15785 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15786 <remarks>
15787 This event will still be fired if an error occurred during the build.
15788 </remarks>
15789 </member>
15790 <member name="M:NAnt.Core.XmlLogger.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
15791 <summary>
15792 Signals that a message has been logged.
15793 </summary>
15794 <param name="sender">The source of the event.</param>
15795 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
15796 <remarks>
15797 Only messages with a priority higher or equal to the threshold of
15798 the logger will actually be output in the build log.
15799 </remarks>
15800 </member>
15801 <member name="M:NAnt.Core.XmlLogger.Flush">
15802 <summary>
15803 Flushes buffered build events or messages to the underlying storage.
15804 </summary>
15805 </member>
15806 <member name="P:NAnt.Core.XmlLogger.Threshold">
15807 <summary>
15808 Gets or sets the highest level of message this logger should respond
15809 to.
15810 </summary>
15811 <value>
15812 The highest level of message this logger should respond to.
15813 </value>
15814 <remarks>
15815 Only messages with a message level higher than or equal to the given
15816 level should be written to the log.
15817 </remarks>
15818 </member>
15819 <member name="P:NAnt.Core.XmlLogger.EmacsMode">
15820 <summary>
15821 Gets or sets a value indicating whether to produce emacs (and other
15822 editor) friendly output.
15823 </summary>
15824 <value>
15825 <see langword="false" /> as it has no meaning in XML format.
15826 </value>
15827 </member>
15828 <member name="P:NAnt.Core.XmlLogger.OutputWriter">
15829 <summary>
15830 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
15831 to send its output.
15832 </summary>
15833 </member>
15834 </members>
15835</doc>