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="value"/> 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 <remarks>
1047 The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> instance is not cached for
1048 future use. If this is required, use <see cref="M:NAnt.Core.Extensibility.ExtensionAssembly.Create(System.Reflection.Assembly)"/>.
1049 </remarks>
1050 <param name="assembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> for which to construct an <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.</param>
1051 </member>
1052 <member name="M:NAnt.Core.Extensibility.ExtensionAssembly.Create(System.Reflection.Assembly)">
1053 <summary>
1054 Creates an <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the specified
1055 <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> and caches it for future use.
1056 </summary>
1057 <remarks>
1058 If an <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the same assembly is
1059 available in the cache, then this cached instance is returned.
1060 </remarks>
1061 <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>
1062 <returns>
1063 The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the specified <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/>.
1064 </returns>
1065 </member>
1066 <member name="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly">
1067 <summary>
1068 Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> containing extensions.
1069 </summary>
1070 </member>
1071 <member name="M:NAnt.Core.Extensibility.ExtensionBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly)">
1072 <summary>
1073 Initializes a instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionBuilder"/>
1074 class for an extension in a given <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/>.
1075 </summary>
1076 <param name="extensionAssembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/> in which the extension is found.</param>
1077 <exception cref="T:System.ArgumentNullException"><paramref name="extensionAssembly"/> is <see langword="null"/>.</exception>
1078 </member>
1079 <member name="M:NAnt.Core.Extensibility.ExtensionBuilder.#ctor(System.Reflection.Assembly)">
1080 <summary>
1081 Initializes a instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionBuilder"/>
1082 class for an extension in a given <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/>.
1083 </summary>
1084 <param name="assembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> in which the extension is found.</param>
1085 <exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is <see langword="null"/>.</exception>
1086 </member>
1087 <member name="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly">
1088 <summary>
1089 Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/> in which the extension
1090 was found.
1091 </summary>
1092 </member>
1093 <member name="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly">
1094 <summary>
1095 Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> from which the extension will
1096 be created.
1097 </summary>
1098 <value>
1099 The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> containing the extension.
1100 </value>
1101 </member>
1102 <member name="M:NAnt.Core.Extensibility.PluginConsumerAttribute.#ctor(System.Type)">
1103 <summary>
1104 Initializes a new instance of the <see cref="T:NAnt.Core.Extensibility.PluginConsumerAttribute"/>
1105 with the specified type.
1106 </summary>
1107 <param name="type">The type of the <see cref="T:NAnt.Core.Extensibility.IPlugin"/> to consume.</param>
1108 <exception cref="T:System.ArgumentNullException"><paramref name="type"/> is <see langword="null"/>.</exception>
1109 </member>
1110 <member name="T:NAnt.Core.Extensibility.PluginScanner">
1111 <summary>
1112 Responsible for scanning types for plugins, and maintaining a cache of
1113 <see cref="T:NAnt.Core.Extensibility.PluginBuilder"/> instances.
1114 </summary>
1115 </member>
1116 <member name="M:NAnt.Core.Extensibility.PluginScanner.ScanTypeForPlugins(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
1117 <summary>
1118 Scans a given <see cref="T:System.Type"/> for plugins.
1119 </summary>
1120 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
1121 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
1122 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
1123 <returns>
1124 <see langword="true"/> if <paramref name="type"/> represents a
1125 <see cref="T:NAnt.Core.Extensibility.IPlugin"/>; otherwise, <see langword="false"/>.
1126 </returns>
1127 </member>
1128 <member name="M:NAnt.Core.Extensibility.PluginScanner.RegisterPlugins(NAnt.Core.Extensibility.IPluginConsumer)">
1129 <summary>
1130 Registers matching plugins for the specified <see cref="T:NAnt.Core.Extensibility.IPluginConsumer"/>.
1131 </summary>
1132 <param name="consumer">The <see cref="T:NAnt.Core.Extensibility.IPluginConsumer"/> which plugins must be registered for.</param>
1133 <exception cref="T:System.ArgumentNullException"><paramref name="consumer"/> is <see langword="null"/>.</exception>
1134 </member>
1135 <member name="T:NAnt.Core.Filters.ChainableReader">
1136 <summary>
1137 Functions as a chainable TextReader
1138 </summary>
1139 <remarks>
1140 Implements a abstraction over a TextReader that allows the class to represent
1141 either a TextReader or another ChainableReader to which it is chained.
1142 By passing a ChainableReader as a constructor paramater it is possiable to
1143 chain many ChainableReaders together. The last ChainableReader in the chain must
1144 be based on a TextReader.
1145 </remarks>
1146 </member>
1147 <member name="M:NAnt.Core.Filters.ChainableReader.Chain(NAnt.Core.Filters.ChainableReader)">
1148 <summary>
1149 Makes it so all calls to Read and Peek are passed the ChainableReader
1150 passed as a parameter.
1151 </summary>
1152 <param name="parentChainedReader">ChainableReader to forward calls to</param>
1153 </member>
1154 <member name="M:NAnt.Core.Filters.ChainableReader.Chain(System.IO.TextReader)">
1155 <summary>
1156 Makes it so all calls to Read and Peek are passed the TextReader
1157 passed as a parameter.
1158 </summary>
1159 <param name="baseReader">TextReader to forward calls to</param>
1160 </member>
1161 <member name="M:NAnt.Core.Filters.ChainableReader.Peek">
1162 <summary>
1163 Forwards Peek calls to the TextReader or ChainableReader passed in the corresponding constructor.
1164 </summary>
1165 <returns>Character or -1 if end of stream</returns>
1166 </member>
1167 <member name="M:NAnt.Core.Filters.ChainableReader.Read">
1168 <summary>
1169 Forwards Read calls to the TextReader or ChainableReader passed in the corresponding constructor.
1170 </summary>
1171 <returns>
1172 Character or -1 if end of stream.
1173 </returns>
1174 </member>
1175 <member name="M:NAnt.Core.Filters.ChainableReader.Close">
1176 <summary>
1177 Closes the reader.
1178 </summary>
1179 </member>
1180 <member name="M:NAnt.Core.Filters.ChainableReader.Dispose">
1181 <summary>
1182 Calls close and supresses the finalizer for the object.
1183 </summary>
1184 </member>
1185 <member name="P:NAnt.Core.Filters.ChainableReader.Base">
1186 <summary>
1187 Gets a value indicating if the reader is backed by a stream in the
1188 chain.
1189 </summary>
1190 <value>
1191 <see langword="true" /> if the reader is backed by a stream;
1192 otherwise, <see langword="false" />.
1193 </value>
1194 </member>
1195 <member name="T:NAnt.Core.Filters.Filter">
1196 <summary>
1197 Allows a file's content to be modified while performing an operation.
1198 </summary>
1199 </member>
1200 <member name="M:NAnt.Core.Filters.Filter.InitializeFilter">
1201 <summary>
1202 Called after construction and after properties are set. Allows
1203 for filter initialization.
1204 </summary>
1205 </member>
1206 <member name="P:NAnt.Core.Filters.Filter.IfDefined">
1207 <summary>
1208 If <see langword="true" /> then the filter will be used; otherwise,
1209 skipped. The default is <see langword="true" />.
1210 </summary>
1211 </member>
1212 <member name="P:NAnt.Core.Filters.Filter.UnlessDefined">
1213 <summary>
1214 Opposite of <see cref="P:NAnt.Core.Filters.Filter.IfDefined"/>. If <see langword="false"/>
1215 then the filter will be executed; otherwise, skipped. The default
1216 is <see langword="false"/>.
1217 </summary>
1218 </member>
1219 <member name="M:NAnt.Core.Filters.FilterBuilder.#ctor(System.Reflection.Assembly,System.String)">
1220 <summary>
1221 Creates a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> class
1222 for the specified <see cref="T:NAnt.Core.Filters.Filter"/> class in the specified
1223 <see cref="T:System.Reflection.Assembly"/>.
1224 </summary>
1225 <remarks>
1226 An <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the specified <see cref="T:System.Reflection.Assembly"/>
1227 is cached for future use.
1228 </remarks>
1229 <param name="assembly">The <see cref="T:System.Reflection.Assembly"/> containing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
1230 <param name="className">The class representing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
1231 </member>
1232 <member name="M:NAnt.Core.Filters.FilterBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
1233 <summary>
1234 Creates a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> class
1235 for the specified <see cref="T:NAnt.Core.Filters.Filter"/> class in the specified
1236 <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.
1237 </summary>
1238 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
1239 <param name="className">The class representing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
1240 </member>
1241 <member name="P:NAnt.Core.Filters.FilterBuilder.ClassName">
1242 <summary>
1243 Gets the name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created
1244 using this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>.
1245 </summary>
1246 <value>
1247 The name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created using
1248 this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>.
1249 </value>
1250 </member>
1251 <member name="P:NAnt.Core.Filters.FilterBuilder.FilterName">
1252 <summary>
1253 Gets the name of the filter which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/>
1254 can create.
1255 </summary>
1256 <value>
1257 The name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/> can
1258 create.
1259 </value>
1260 </member>
1261 <member name="T:NAnt.Core.Filters.FilterBuilderCollection">
1262 <summary>
1263 Contains a strongly typed collection of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> objects.
1264 </summary>
1265 </member>
1266 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor">
1267 <summary>
1268 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class.
1269 </summary>
1270 </member>
1271 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilderCollection)">
1272 <summary>
1273 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class
1274 with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> instance.
1275 </summary>
1276 </member>
1277 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilder[])">
1278 <summary>
1279 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class
1280 with the specified array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
1281 </summary>
1282 </member>
1283 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Add(NAnt.Core.Filters.FilterBuilder)">
1284 <summary>
1285 Adds a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to the end of the collection.
1286 </summary>
1287 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to be added to the end of the collection.</param>
1288 <returns>The position into which the new element was inserted.</returns>
1289 </member>
1290 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilder[])">
1291 <summary>
1292 Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> array to the end of the collection.
1293 </summary>
1294 <param name="items">The array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements to be added to the end of the collection.</param>
1295 </member>
1296 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilderCollection)">
1297 <summary>
1298 Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to the end of the collection.
1299 </summary>
1300 <param name="items">The <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to be added to the end of the collection.</param>
1301 </member>
1302 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(NAnt.Core.Filters.FilterBuilder)">
1303 <summary>
1304 Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> is in the collection.
1305 </summary>
1306 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to locate in the collection.</param>
1307 <returns>
1308 <see langword="true"/> if <paramref name="item"/> is found in the
1309 collection; otherwise, <see langword="false"/>.
1310 </returns>
1311 </member>
1312 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(System.String)">
1313 <summary>
1314 Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified
1315 task is in the collection.
1316 </summary>
1317 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> should be located in the collection.</param>
1318 <returns>
1319 <see langword="true"/> if a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for
1320 the specified task is found in the collection; otherwise,
1321 <see langword="false"/>.
1322 </returns>
1323 </member>
1324 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.CopyTo(NAnt.Core.Filters.FilterBuilder[],System.Int32)">
1325 <summary>
1326 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
1327 </summary>
1328 <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>
1329 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
1330 </member>
1331 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.IndexOf(NAnt.Core.Filters.FilterBuilder)">
1332 <summary>
1333 Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object in the collection.
1334 </summary>
1335 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object for which the index is returned.</param>
1336 <returns>
1337 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.
1338 </returns>
1339 </member>
1340 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Insert(System.Int32,NAnt.Core.Filters.FilterBuilder)">
1341 <summary>
1342 Inserts a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> into the collection at the specified index.
1343 </summary>
1344 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
1345 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to insert.</param>
1346 </member>
1347 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.GetEnumerator">
1348 <summary>
1349 Returns an enumerator that can iterate through the collection.
1350 </summary>
1351 <returns>
1352 A <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> for the entire collection.
1353 </returns>
1354 </member>
1355 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Remove(NAnt.Core.Filters.FilterBuilder)">
1356 <summary>
1357 Removes a member from the collection.
1358 </summary>
1359 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to remove from the collection.</param>
1360 </member>
1361 <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.Int32)">
1362 <summary>
1363 Gets or sets the element at the specified index.
1364 </summary>
1365 <param name="index">The zero-based index of the element to get or set.</param>
1366 </member>
1367 <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.String)">
1368 <summary>
1369 Gets the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified task.
1370 </summary>
1371 <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>
1372 </member>
1373 <member name="T:NAnt.Core.Filters.FilterBuilderEnumerator">
1374 <summary>
1375 Enumerates the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>.
1376 </summary>
1377 </member>
1378 <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.#ctor(NAnt.Core.Filters.FilterBuilderCollection)">
1379 <summary>
1380 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> class
1381 with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>.
1382 </summary>
1383 <param name="arguments">The collection that should be enumerated.</param>
1384 </member>
1385 <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.MoveNext">
1386 <summary>
1387 Advances the enumerator to the next element of the collection.
1388 </summary>
1389 <returns>
1390 <see langword="true" /> if the enumerator was successfully advanced
1391 to the next element; <see langword="false" /> if the enumerator has
1392 passed the end of the collection.
1393 </returns>
1394 </member>
1395 <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.Reset">
1396 <summary>
1397 Sets the enumerator to its initial position, which is before the
1398 first element in the collection.
1399 </summary>
1400 </member>
1401 <member name="P:NAnt.Core.Filters.FilterBuilderEnumerator.Current">
1402 <summary>
1403 Gets the current element in the collection.
1404 </summary>
1405 <returns>
1406 The current element in the collection.
1407 </returns>
1408 </member>
1409 <member name="T:NAnt.Core.Filters.FilterChain">
1410 <summary>
1411 Represent a chain of NAnt filters that can be applied to a <see cref="T:NAnt.Core.Task"/>.
1412 </summary>
1413 <remarks>
1414 <para>
1415 A FilterChain represents a collection of one or more filters that can
1416 be appled to a <see cref="T:NAnt.Core.Task"/> such as the <see cref="T:NAnt.Core.Tasks.CopyTask"/>.
1417 In the case of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>, the contents of the copied
1418 files are filtered through each filter specified in the filter chain.
1419 Filtering occurs in the order the filters are specified with filtered
1420 output of one filter feeding into another.
1421 </para>
1422 <para>
1423 :--------:--->:----------:--->:----------: ... :----------:--->:--------:<br/>
1424 :.Source.:--->:.Filter 1.:--->:.Filter 2.: ... :.Filter n.:--->:.target.:<br/>
1425 :--------:--->:----------:--->:----------: ... :----------:--->:--------:<br/>
1426 </para>
1427 <para>
1428 A list of all filters that come with NAnt is available <see href="../filters/index.html">here</see>.
1429 </para>
1430 <para>
1431 The following tasks support filtering with a FilterChain:
1432 </para>
1433 <list type="bullet">
1434 <item>
1435 <description><see cref="T:NAnt.Core.Tasks.CopyTask"/></description>
1436 </item>
1437 <item>
1438 <description><see cref="T:NAnt.Core.Tasks.MoveTask"/></description>
1439 </item>
1440 </list>
1441 </remarks>
1442 <example>
1443 <para>
1444 Replace all occurrences of @NOW@ with the current date/time and
1445 replace tabs with spaces in all copied files.
1446 </para>
1447 <code>
1448 <![CDATA[
1449 <property name="NOW" value="${datetime::now()}" />
1450 <copy todir="out">
1451 <fileset basedir="in">
1452 <include name="**/*" />
1453 </fileset>
1454 <filterchain>
1455 <replacetokens>
1456 <token key="NOW" value="${TODAY}" />
1457 </replacetokens>
1458 <tabstospaces />
1459 </filterchain>
1460 </copy>
1461 ]]>
1462 </code>
1463 </example>
1464 </member>
1465 <member name="T:NAnt.Core.DataTypeBase">
1466 <summary>
1467 Provides the abstract base class for types.
1468 </summary>
1469 </member>
1470 <member name="M:NAnt.Core.DataTypeBase.Reset">
1471 <summary>
1472 Should be overridden by derived classes. clones the referenced types
1473 data into the current instance.
1474 </summary>
1475 </member>
1476 <member name="M:NAnt.Core.DataTypeBase.CopyTo(NAnt.Core.DataTypeBase)">
1477 <summary>
1478 Copies all instance data of the <see cref="T:NAnt.Core.DataTypeBase"/> to a given
1479 <see cref="T:NAnt.Core.DataTypeBase"/>.
1480 </summary>
1481 </member>
1482 <member name="P:NAnt.Core.DataTypeBase.ID">
1483 <summary>
1484 The ID used to be referenced later.
1485 </summary>
1486 </member>
1487 <member name="P:NAnt.Core.DataTypeBase.RefID">
1488 <summary>
1489 The ID to use as the reference.
1490 </summary>
1491 </member>
1492 <member name="P:NAnt.Core.DataTypeBase.CanBeReferenced">
1493 <summary>
1494 Gets a value indicating whether a reference to the type can be
1495 defined.
1496 </summary>
1497 <remarks>
1498 Only types with an <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned
1499 to it, can be referenced.
1500 </remarks>
1501 </member>
1502 <member name="P:NAnt.Core.DataTypeBase.Name">
1503 <summary>
1504 Gets the name of the datatype.
1505 </summary>
1506 <value>
1507 The name of the datatype.
1508 </value>
1509 </member>
1510 <member name="M:NAnt.Core.Filters.FilterChain.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
1511 <summary>
1512 Initializes all build attributes and child elements.
1513 </summary>
1514 <remarks>
1515 <see cref="T:NAnt.Core.Filters.FilterChain"/> needs to maintain the order in which the
1516 filters are specified in the build file.
1517 </remarks>
1518 </member>
1519 <member name="M:NAnt.Core.Filters.FilterChain.GetBaseFilter(NAnt.Core.Filters.PhysicalTextReader)">
1520 <summary>
1521 Used to to instantiate and return the chain of stream based filters.
1522 </summary>
1523 <param name="physicalTextReader">The <see cref="T:NAnt.Core.Filters.PhysicalTextReader"/> that is the source of input to the filter chain.</param>
1524 <remarks>
1525 The <paramref name="physicalTextReader"/> is the first <see cref="T:NAnt.Core.Filters.Filter"/>
1526 in the chain, which is based on a physical stream that feeds the chain.
1527 </remarks>
1528 <returns>
1529 The last <see cref="T:NAnt.Core.Filters.Filter"/> in the chain.
1530 </returns>
1531 </member>
1532 <member name="P:NAnt.Core.Filters.FilterChain.Filters">
1533 <summary>
1534 The filters to apply.
1535 </summary>
1536 </member>
1537 <member name="P:NAnt.Core.Filters.FilterChain.InputEncoding">
1538 <summary>
1539 The encoding to assume when filter-copying files. The default is
1540 system's current ANSI code page.
1541 </summary>
1542 </member>
1543 <member name="T:NAnt.Core.Filters.FilterChain.FilterChainConfigurator">
1544 <summary>
1545 Configurator that initializes filters in the order in which they've
1546 been specified in the build file.
1547 </summary>
1548 </member>
1549 <member name="T:NAnt.Core.Filters.FilterCollection">
1550 <summary>
1551 Contains a collection of <see cref="T:NAnt.Core.Filters.Filter"/> elements.
1552 </summary>
1553 </member>
1554 <member name="M:NAnt.Core.Filters.FilterCollection.#ctor">
1555 <summary>
1556 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class.
1557 </summary>
1558 </member>
1559 <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.FilterCollection)">
1560 <summary>
1561 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class
1562 with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/> instance.
1563 </summary>
1564 </member>
1565 <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.Filter[])">
1566 <summary>
1567 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class
1568 with the specified array of <see cref="T:NAnt.Core.Filters.Filter"/> instances.
1569 </summary>
1570 </member>
1571 <member name="M:NAnt.Core.Filters.FilterCollection.Add(NAnt.Core.Filters.Filter)">
1572 <summary>
1573 Adds a <see cref="T:NAnt.Core.Filters.Filter"/> to the end of the collection.
1574 </summary>
1575 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to be added to the end of the collection.</param>
1576 <returns>The position into which the new element was inserted.</returns>
1577 </member>
1578 <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.Filter[])">
1579 <summary>
1580 Adds the elements of a <see cref="T:NAnt.Core.Filters.Filter"/> array to the end of the collection.
1581 </summary>
1582 <param name="items">The array of <see cref="T:NAnt.Core.Filters.Filter"/> elements to be added to the end of the collection.</param>
1583 </member>
1584 <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.FilterCollection)">
1585 <summary>
1586 Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/> to the end of the collection.
1587 </summary>
1588 <param name="items">The <see cref="T:NAnt.Core.Filters.FilterCollection"/> to be added to the end of the collection.</param>
1589 </member>
1590 <member name="M:NAnt.Core.Filters.FilterCollection.Contains(NAnt.Core.Filters.Filter)">
1591 <summary>
1592 Determines whether a <see cref="T:NAnt.Core.Filters.Filter"/> is in the collection.
1593 </summary>
1594 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to locate in the collection.</param>
1595 <returns>
1596 <see langword="true"/> if <paramref name="item"/> is found in the
1597 collection; otherwise, <see langword="false"/>.
1598 </returns>
1599 </member>
1600 <member name="M:NAnt.Core.Filters.FilterCollection.CopyTo(NAnt.Core.Filters.Filter[],System.Int32)">
1601 <summary>
1602 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
1603 </summary>
1604 <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>
1605 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
1606 </member>
1607 <member name="M:NAnt.Core.Filters.FilterCollection.IndexOf(NAnt.Core.Filters.Filter)">
1608 <summary>
1609 Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.Filter"/> object in the collection.
1610 </summary>
1611 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> object for which the index is returned.</param>
1612 <returns>
1613 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.
1614 </returns>
1615 </member>
1616 <member name="M:NAnt.Core.Filters.FilterCollection.Insert(System.Int32,NAnt.Core.Filters.Filter)">
1617 <summary>
1618 Inserts a <see cref="T:NAnt.Core.Filters.Filter"/> into the collection at the specified index.
1619 </summary>
1620 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
1621 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to insert.</param>
1622 </member>
1623 <member name="M:NAnt.Core.Filters.FilterCollection.GetEnumerator">
1624 <summary>
1625 Returns an enumerator that can iterate through the collection.
1626 </summary>
1627 <returns>
1628 A <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> for the entire collection.
1629 </returns>
1630 </member>
1631 <member name="M:NAnt.Core.Filters.FilterCollection.Remove(NAnt.Core.Filters.Filter)">
1632 <summary>
1633 Removes a member from the collection.
1634 </summary>
1635 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to remove from the collection.</param>
1636 </member>
1637 <member name="P:NAnt.Core.Filters.FilterCollection.Item(System.Int32)">
1638 <summary>
1639 Gets or sets the element at the specified index.
1640 </summary>
1641 <param name="index">The zero-based index of the element to get or set.</param>
1642 </member>
1643 <member name="T:NAnt.Core.Filters.FilterEnumerator">
1644 <summary>
1645 Enumerates the <see cref="T:NAnt.Core.Filters.Filter"/> elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/>.
1646 </summary>
1647 </member>
1648 <member name="M:NAnt.Core.Filters.FilterEnumerator.#ctor(NAnt.Core.Filters.FilterCollection)">
1649 <summary>
1650 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> class
1651 with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/>.
1652 </summary>
1653 <param name="arguments">The collection that should be enumerated.</param>
1654 </member>
1655 <member name="M:NAnt.Core.Filters.FilterEnumerator.MoveNext">
1656 <summary>
1657 Advances the enumerator to the next element of the collection.
1658 </summary>
1659 <returns>
1660 <see langword="true" /> if the enumerator was successfully advanced
1661 to the next element; <see langword="false" /> if the enumerator has
1662 passed the end of the collection.
1663 </returns>
1664 </member>
1665 <member name="M:NAnt.Core.Filters.FilterEnumerator.Reset">
1666 <summary>
1667 Sets the enumerator to its initial position, which is before the
1668 first element in the collection.
1669 </summary>
1670 </member>
1671 <member name="P:NAnt.Core.Filters.FilterEnumerator.Current">
1672 <summary>
1673 Gets the current element in the collection.
1674 </summary>
1675 <returns>
1676 The current element in the collection.
1677 </returns>
1678 </member>
1679 <member name="T:NAnt.Core.Filters.PhysicalTextReader">
1680 <summary>
1681 Represents a physical <see cref="T:System.IO.TextReader"/>. That is a reader based
1682 on a stream.
1683 </summary>
1684 <remarks>
1685 Used by <see cref="T:NAnt.Core.Filters.ChainableReader"/> to represent a <see cref="T:NAnt.Core.Filters.Filter"/>
1686 based on a <see cref="T:System.IO.TextReader"/> in the chain.
1687 </remarks>
1688 </member>
1689 <member name="T:NAnt.Core.Filters.ExpandProperties">
1690 <summary>
1691 Parses NAnt properties and expressions
1692 </summary>
1693 <remarks>
1694 <para>
1695 This filter parses any NAnt properties or expressions found in its input,
1696 inlining their values in its output.
1697 </para>
1698 <para>
1699 Note: Due to limitations on buffering, expressions longer than 2048
1700 characters are not guaranteed to be expanded.
1701 </para>
1702 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
1703 </remarks>
1704 <example>
1705 <para>Replace all properties with their corresponding values.</para>
1706 <code>
1707 <![CDATA[
1708 <expandproperties />
1709 ]]>
1710 </code>
1711 </example>
1712 </member>
1713 <member name="F:NAnt.Core.Filters.ExpandProperties._buffer">
1714 <summary>
1715 Holds data for expression expansion between input and output.
1716 </summary>
1717 </member>
1718 <member name="M:NAnt.Core.Filters.ExpandProperties.InitializeFilter">
1719 <summary>
1720 Called after construction and after properties are set. Allows
1721 for filter initialization.
1722 </summary>
1723 </member>
1724 <member name="M:NAnt.Core.Filters.ExpandProperties.Read">
1725 <summary>
1726 Reads the next character applying the filter logic.
1727 </summary>
1728 <returns>Char as an int or -1 if at the end of the stream</returns>
1729 </member>
1730 <member name="M:NAnt.Core.Filters.ExpandProperties.Peek">
1731 <summary>
1732 Reads the next character applying the filter logic without advancing the current position in the stream.
1733 </summary>
1734 <returns>Char as an int or -1 if at the end of the stream</returns>
1735 </member>
1736 <member name="M:NAnt.Core.Filters.ExpandProperties.Advance">
1737 <summary>
1738 Moves to the next character.
1739 </summary>
1740 </member>
1741 <member name="M:NAnt.Core.Filters.ExpandProperties.ReplenishBuffer">
1742 <summary>
1743 Refills the buffer, running our input through
1744 <see cref="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location)"/>.)
1745 </summary>
1746 </member>
1747 <member name="P:NAnt.Core.Filters.ExpandProperties.AtEnd">
1748 <summary>
1749 Determines whether we've passed the end of our data.
1750 </summary>
1751 </member>
1752 <member name="T:NAnt.Core.Filters.ReplaceString">
1753 <summary>
1754 Replaces all occurrences of a given string in the original input with
1755 user-supplied replacement string.
1756 </summary>
1757 <remarks>
1758 <para>
1759 This filter replaces all occurrences of a given string in the original
1760 input stream with a user-supplied replacement string. By default string
1761 comparisons are case sensitive but this can be changed by setting the
1762 optional <see cref="P:NAnt.Core.Filters.ReplaceString.IgnoreCase"/> attribute to <see langword="true"/>.
1763 </para>
1764 <para>
1765 To use this filter specify the string to be replaced with the
1766 <see cref="P:NAnt.Core.Filters.ReplaceString.From"/> attribute and the string to replace it with using the
1767 <see cref="P:NAnt.Core.Filters.ReplaceString.To"/> attribute.
1768 </para>
1769 <para>
1770 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
1771 </para>
1772 </remarks>
1773 <example>
1774 <para>
1775 Replace all occurrences of "3.14" with "PI".
1776 </para>
1777 <code>
1778 <![CDATA[
1779 <replacestring from="3.14" to="PI" />
1780 ]]>
1781 </code>
1782 </example>
1783 <example>
1784 <para>
1785 Replace all occurrences of "string", "String", etc. with "System.String".
1786 </para>
1787 <code>
1788 <![CDATA[
1789 <replacestring from="String" to="System.String" ignorecase="true" />
1790 ]]>
1791 </code>
1792 </example>
1793 </member>
1794 <member name="M:NAnt.Core.Filters.ReplaceString.Chain(NAnt.Core.Filters.ChainableReader)">
1795 <summary>
1796 Construct that allows this filter to be chained to the one
1797 in the parameter chainedReader.
1798 </summary>
1799 <param name="chainedReader">Filter that the filter will be chained to</param>
1800 </member>
1801 <member name="M:NAnt.Core.Filters.ReplaceString.Read">
1802 <summary>
1803 Reads the next character applying the filter logic.
1804 </summary>
1805 <returns>Char as an int or -1 if at the end of the stream</returns>
1806 </member>
1807 <member name="M:NAnt.Core.Filters.ReplaceString.Peek">
1808 <summary>
1809 Reads the next character applying the filter logic without
1810 advancing the current position in the stream.
1811 Peek currently is not supported.
1812 </summary>
1813 <returns>
1814 Char as an int or -1 if at the end of the stream.
1815 </returns>
1816 </member>
1817 <member name="M:NAnt.Core.Filters.ReplaceString.FindString(System.Int32,System.Boolean@,System.String@)">
1818 <summary>
1819 <para>
1820 Helper function used to search for the filter's traget string. If the string
1821 is found the result is true. If the string was not found false is returned and
1822 nonMatchingChars contains the characters that were read to determine if the
1823 string is present.
1824 </para>
1825
1826 <para>
1827 It is assumed the stream is positioned at the character after the first character
1828 in the target string.
1829 </para>
1830 </summary>
1831 <param name="startChar">First character in target string</param>
1832 <param name="streamEnded">Ture if the stream ended while search for the string.</param>
1833 <param name="nonMatchingChars">Characters that were read while searching for the string.</param>
1834 <returns></returns>
1835 </member>
1836 <member name="M:NAnt.Core.Filters.ReplaceString.GetNextCharacter(NAnt.Core.Filters.ReplaceString.AcquireCharDelegate)">
1837 <summary>
1838 Returns the next character in the stream replacing the specified character. Using the
1839 <see cref="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
1840 </summary>
1841 <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
1842 <returns>Char as an int or -1 if at the end of the stream</returns>
1843 </member>
1844 <member name="M:NAnt.Core.Filters.ReplaceString.CompareCharacters(System.Int32,System.Int32)">
1845 <summary>
1846 Compares to characters taking into account the _ignoreCase flag.
1847 </summary>
1848 <param name="char1"></param>
1849 <param name="char2"></param>
1850 <returns></returns>
1851 </member>
1852 <member name="P:NAnt.Core.Filters.ReplaceString.From">
1853 <summary>
1854 The string to be replaced.
1855 </summary>
1856 </member>
1857 <member name="P:NAnt.Core.Filters.ReplaceString.To">
1858 <summary>
1859 The new value for the replaced string.
1860 Am empty string is permissible.
1861 </summary>
1862 </member>
1863 <member name="P:NAnt.Core.Filters.ReplaceString.IgnoreCase">
1864 <summary>
1865 Determines if case will be ignored.
1866 The default is <see langword="false" />.
1867 </summary>
1868 </member>
1869 <member name="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate">
1870 <summary>
1871 Delegate for Read and Peek. Allows the same implementation
1872 to be used for both methods.
1873 </summary>
1874 </member>
1875 <member name="T:NAnt.Core.Filters.ReplaceTokens">
1876 <summary>
1877 Replaces tokens in the original input with user-supplied values.
1878 </summary>
1879 <remarks>
1880 <para>
1881 This filter replaces all token surrounded by a beginning and ending
1882 token. The default beginning and ending tokens both default to '@'. The
1883 optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.BeginToken"/> and <see cref="P:NAnt.Core.Filters.ReplaceTokens.EndToken"/> attributes
1884 can be specified to change either token. By default string
1885 comparisons are case sensitive but this can be changed by setting the
1886 optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> attribute to <see langword="true"/>.
1887 </para>
1888 <para>
1889 Tokens are specified by using the <see cref="T:NAnt.Core.Types.Token"/> element. It is
1890 possible to specify from 1 to n tokens and replacement values. Values can
1891 be any valid NAnt expression.
1892 </para>
1893 <para>
1894 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
1895 </para>
1896 </remarks>
1897 <example>
1898 <para>
1899 Replace all occurrences of the string @DATE@ with the value of property
1900 "TODAY".
1901 </para>
1902 <code>
1903 <![CDATA[
1904 <replacetokens>
1905 <token key="DATE" value="${TODAY}" />
1906 </replacetokens>
1907 ]]>
1908 </code>
1909 </example>
1910 <example>
1911 <para>
1912 Replace all occurrences of the string <DATE> with the value of
1913 property "TODAY".
1914 </para>
1915 <code>
1916 <![CDATA[
1917 <replacetokens begintoken="<" endtoken=">">
1918 <token key="DATE" value="${TODAY}" />
1919 </replacetokens>
1920 ]]>
1921 </code>
1922 </example>
1923 </member>
1924 <member name="M:NAnt.Core.Filters.ReplaceTokens.Chain(NAnt.Core.Filters.ChainableReader)">
1925 <summary>
1926 Construct that allows this filter to be chained to the one
1927 in the parameter chainedReader.
1928 </summary>
1929 <param name="chainedReader">Filter that the filter will be chained to</param>
1930 </member>
1931 <member name="M:NAnt.Core.Filters.ReplaceTokens.Read">
1932 <summary>
1933 Reads the next character applying the filter logic.
1934 </summary>
1935 <returns>Char as an int or -1 if at the end of the stream</returns>
1936 </member>
1937 <member name="M:NAnt.Core.Filters.ReplaceTokens.Peek">
1938 <summary>
1939 Reads the next character applying the filter logic without
1940 advancing the current position in the stream.
1941 Peek currently is not supported.
1942 </summary>
1943 <returns>
1944 Char as an int or -1 if at the end of the stream.
1945 </returns>
1946 </member>
1947 <member name="M:NAnt.Core.Filters.ReplaceTokens.Initialize">
1948 <summary>
1949 Initialize the filter by setting its parameters.
1950 </summary>
1951 </member>
1952 <member name="M:NAnt.Core.Filters.ReplaceTokens.FindTokenContents(System.Boolean@,System.Boolean@,System.Boolean@)">
1953 <summary>
1954 Finds a token give that we are positioned at a beginning token character. Either a
1955 token replacement is returned or the characters that were read looking for the token.
1956 </summary>
1957 <param name="tokenNotFound">A token was not found</param>
1958 <param name="unknownToken">A token was found by there is no replacement</param>
1959 <param name="streamEnded">The stream ended while looking for the token</param>
1960 <returns>Either the replacement token or the characters that were read looking for the token</returns>
1961 </member>
1962 <member name="M:NAnt.Core.Filters.ReplaceTokens.GetNextCharacter(NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate)">
1963 <summary>
1964 Returns the next character in the stream replacing the specified character. Using the
1965 <see cref="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
1966 </summary>
1967 <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
1968 <returns>Char as an int or -1 if at the end of the stream</returns>
1969 </member>
1970 <member name="M:NAnt.Core.Filters.ReplaceTokens.CompareCharacters(System.Int32,System.Int32)">
1971 <summary>
1972 Compares to characters taking <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> into account.
1973 </summary>
1974 <param name="char1"></param>
1975 <param name="char2"></param>
1976 <returns>
1977 </returns>
1978 </member>
1979 <member name="P:NAnt.Core.Filters.ReplaceTokens.BeginToken">
1980 <summary>
1981 Marks the beginning of a token. The default is "@".
1982 </summary>
1983 </member>
1984 <member name="P:NAnt.Core.Filters.ReplaceTokens.EndToken">
1985 <summary>
1986 Marks the end of a token. The default is "@".
1987 </summary>
1988 </member>
1989 <member name="P:NAnt.Core.Filters.ReplaceTokens.Tokens">
1990 <summary>
1991 Tokens and replacement values.
1992 </summary>
1993 </member>
1994 <member name="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase">
1995 <summary>
1996 Determines if case will be ignored.
1997 The default is <see langword="false" />.
1998 </summary>
1999 </member>
2000 <member name="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate">
2001 <summary>
2002 Delegate for Read and Peek. Allows the same implementation
2003 to be used for both methods.
2004 </summary>
2005 </member>
2006 <member name="T:NAnt.Core.Filters.TabsToSpaces">
2007 <summary>
2008 Converts tabs to spaces.
2009 </summary>
2010 <remarks>
2011 <para>
2012 The <see cref="T:NAnt.Core.Filters.TabsToSpaces"/> filter replaces tabs in a text file
2013 with spaces.
2014 </para>
2015 <para>
2016 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
2017 </para>
2018 </remarks>
2019 <example>
2020 <para>Replace all tabs with four spaces.</para>
2021 <code>
2022 <![CDATA[
2023 <tabtospaces tablength="4" />
2024 ]]>
2025 </code>
2026 </example>
2027 </member>
2028 <member name="M:NAnt.Core.Filters.TabsToSpaces.Chain(NAnt.Core.Filters.ChainableReader)">
2029 <summary>
2030 Construct that allows this filter to be chained to the one
2031 in the parameter chainedReader.
2032 </summary>
2033 <param name="chainedReader">Filter that the filter will be chained to</param>
2034 </member>
2035 <member name="M:NAnt.Core.Filters.TabsToSpaces.Peek">
2036 <summary>
2037 <para>Retrieves the next character with moving the position in the stream.</para>
2038 <note>This method is not implemented</note>
2039 </summary>
2040 <returns>-1 if end of stream otherwise a character</returns>
2041 </member>
2042 <member name="M:NAnt.Core.Filters.TabsToSpaces.Read">
2043 <summary>
2044 <para>Retrieves the next character in the stream.</para>
2045 </summary>
2046 <returns>-1 if end of stream otherwise a character</returns>
2047 </member>
2048 <member name="M:NAnt.Core.Filters.TabsToSpaces.GetNextCharacter(NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate)">
2049 <summary>
2050 Returns the next character in the stream replacing the specified character. Using the
2051 <see cref="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
2052 </summary>
2053 <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
2054 <returns>Char as an int or -1 if at the end of the stream</returns>
2055 </member>
2056 <member name="P:NAnt.Core.Filters.TabsToSpaces.TabLength">
2057 <summary>
2058 The number of spaces used when converting a tab. The default is
2059 "8".
2060 </summary>
2061 </member>
2062 <member name="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate">
2063 <summary>
2064 Delegate for Read and Peek. Allows the same implementation
2065 to be used for both methods.
2066 </summary>
2067 </member>
2068 <member name="T:NAnt.Core.Functions.AssemblyFunctions">
2069 <summary>
2070 Functions to return information for a given assembly.
2071 </summary>
2072 </member>
2073 <member name="P:NAnt.Core.FunctionSetBase.Project">
2074 <summary>
2075 Gets or sets the <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will
2076 reference.
2077 </summary>
2078 <value>
2079 The <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will reference.
2080 </value>
2081 </member>
2082 <member name="M:NAnt.Core.Functions.AssemblyFunctions.LoadFromFile(System.String)">
2083 <summary>
2084 Loads an assembly given its file name or path.
2085 </summary>
2086 <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
2087 <returns>
2088 The loaded assembly.
2089 </returns>
2090 <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
2091 <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>
2092 <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception>
2093 <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>
2094 </member>
2095 <member name="M:NAnt.Core.Functions.AssemblyFunctions.Load(System.String)">
2096 <summary>
2097 Loads an assembly given the long form of its name.
2098 </summary>
2099 <param name="assemblyString">The long form of the assembly name.</param>
2100 <returns>
2101 The loaded assembly.
2102 </returns>
2103 <exception cref="T:System.ArgumentNullException"><paramref name="assemblyString"/> is a <see langword="null"/>.</exception>
2104 <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyString"/> is not found.</exception>
2105 <example>
2106 <para>
2107 Determine the location of the Microsoft Access 11 Primary Interop
2108 Assembly by loading it using its fully qualified name, and copy it
2109 to the build directory.
2110 </para>
2111 <code>
2112 <![CDATA[
2113 <property name="access.pia.path" value="${assembly::get-location(assembly::load('Microsoft.Office.Interop.Access, Version=11.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c'))}" />
2114 <copy file="${access.pia.path}" todir="${build.dir}" />
2115 ]]>
2116 </code>
2117 </example>
2118 </member>
2119 <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetFullName(System.Reflection.Assembly)">
2120 <summary>
2121 Gets the full name of the assembly, also known as the display name.
2122 </summary>
2123 <param name="assembly">The assembly to get the full name for.</param>
2124 <returns>
2125 The full name of the assembly, also known as the display name.
2126 </returns>
2127 </member>
2128 <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)">
2129 <summary>
2130 Gets an <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly.
2131 </summary>
2132 <param name="assembly">The assembly to get an <see cref="T:System.Reflection.AssemblyName"/> for.</param>
2133 <returns>
2134 An <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly.
2135 </returns>
2136 <seealso cref="T:NAnt.Core.Functions.AssemblyNameFunctions"/>
2137 </member>
2138 <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetLocation(System.Reflection.Assembly)">
2139 <summary>
2140 Gets the physical location, in codebase format, of the loaded file
2141 that contains the manifest.
2142 </summary>
2143 <param name="assembly">The assembly to get the location for.</param>
2144 <returns>
2145 The location of the specified assembly.
2146 </returns>
2147 </member>
2148 <member name="T:NAnt.Core.Functions.AssemblyNameFunctions">
2149 <summary>
2150 Functions that return information about an assembly's identity.
2151 </summary>
2152 </member>
2153 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetCodeBase(System.Reflection.AssemblyName)">
2154 <summary>
2155 Gets the location of the assembly as a URL.
2156 </summary>
2157 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2158 <returns>
2159 The location of the assembly as a URL.
2160 </returns>
2161 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2162 </member>
2163 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetEscapedCodeBase(System.Reflection.AssemblyName)">
2164 <summary>
2165 Gets the URI, including escape characters, that represents the codebase.
2166 </summary>
2167 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2168 <returns>
2169 The URI, including escape characters, that represents the codebase.
2170 </returns>
2171 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2172 </member>
2173 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetFullName(System.Reflection.AssemblyName)">
2174 <summary>
2175 Gets the full name of the assembly, also known as the display name.
2176 </summary>
2177 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2178 <returns>
2179 The full name of the assembly, also known as the display name.
2180 </returns>
2181 <example>
2182 <para>
2183 Output the full name of the <c>nunit.framework</c> assembly to the
2184 build log.
2185 </para>
2186 <code>
2187 <![CDATA[
2188 <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
2189 ]]>
2190 </code>
2191 </example>
2192 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2193 </member>
2194 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetName(System.Reflection.AssemblyName)">
2195 <summary>
2196 Gets the simple, unencrypted name of the assembly.
2197 </summary>
2198 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2199 <returns>
2200 The simple, unencrypted name of the assembly.
2201 </returns>
2202 <example>
2203 <para>
2204 Output the simple name of the <c>nunit.framework</c> assembly to
2205 the build log.
2206 </para>
2207 <code>
2208 <![CDATA[
2209 <echo message="${assemblyname::get-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
2210 ]]>
2211 </code>
2212 </example>
2213 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2214 </member>
2215 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)">
2216 <summary>
2217 Gets the version of the assembly.
2218 </summary>
2219 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
2220 <returns>
2221 The version of the assembly.
2222 </returns>
2223 <example>
2224 <para>
2225 Output the major version of the <c>nunit.framework</c> assembly
2226 to the build log.
2227 </para>
2228 <code>
2229 <![CDATA[
2230 <echo message="${version::get-major-version(assemblyname::get-version(assemblyname::get-assembly-name('nunit.framework.dll')))}" />
2231 ]]>
2232 </code>
2233 </example>
2234 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
2235 <seealso cref="T:NAnt.Core.Functions.VersionFunctions"/>
2236 </member>
2237 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetAssemblyName(System.String)">
2238 <summary>
2239 Gets the <see cref="T:System.Reflection.AssemblyName"/> for a given file.
2240 </summary>
2241 <param name="assemblyFile">The assembly file for which to get the <see cref="T:System.Reflection.AssemblyName"/>.</param>
2242 <returns>
2243 An <see cref="T:System.Reflection.AssemblyName"/> object representing the given file.
2244 </returns>
2245 <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
2246 <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> does not exist.</exception>
2247 <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception>
2248 <remarks>
2249 The assembly is not added to this domain.
2250 </remarks>
2251 <example>
2252 <para>
2253 Output the full name of the <c>nunit.framework</c> assembly to the
2254 build log.
2255 </para>
2256 <code>
2257 <![CDATA[
2258 <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
2259 ]]>
2260 </code>
2261 </example>
2262 </member>
2263 <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.Parse(System.String)">
2264 <summary>
2265 Converts the specified string representation of a logical value to
2266 its <see cref="T:System.Boolean"/> equivalent.
2267 </summary>
2268 <param name="s">A string containing the value to convert.</param>
2269 <returns>
2270 <see langword="true"/> if <paramref name="s"/> is equivalent to
2271 "True"; otherwise, <see langword="false"/>.
2272 </returns>
2273 <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>
2274 </member>
2275 <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.ToString(System.Boolean)">
2276 <summary>
2277 Converts the specified <see cref="T:System.Boolean"/> to its equivalent string
2278 representation.
2279 </summary>
2280 <param name="value">A <see cref="T:System.Boolean"/> to convert.</param>
2281 <returns>
2282 "True" if <paramref name="value"/> is <see langword="true"/>, or
2283 "False" if <paramref name="value"/> is <see langword="false"/>.
2284 </returns>
2285 </member>
2286 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToInt(System.Int32)">
2287 <summary>
2288 Converts the argument to an integer.
2289 </summary>
2290 <param name="value">value to be converted</param>
2291 <returns><paramref name="value" /> converted to integer. The function fails with an exception when the conversion is not possible.</returns>
2292 </member>
2293 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDouble(System.Double)">
2294 <summary>
2295 Converts the argument to double
2296 </summary>
2297 <param name="value">The value to be converted.</param>
2298 <returns><paramref name="value" /> converted to double. The function fails with an exception when the conversion is not possible.</returns>
2299 </member>
2300 <member name="M:NAnt.Core.Functions.ConversionFunctions.ConvertToString(System.String)">
2301 <summary>
2302 Converts the argument to a string.
2303 </summary>
2304 <param name="value">The value to be converted.</param>
2305 <returns>
2306 <paramref name="value" /> converted to string. The function fails
2307 with an exception when the conversion is not possible.
2308 </returns>
2309 <remarks>
2310 Named method ConvertToString as a static ToString method would break
2311 CLS compliance.
2312 </remarks>
2313 </member>
2314 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDateTime(System.DateTime)">
2315 <summary>
2316 Converts the argument to a datetime.
2317 </summary>
2318 <param name="value">value to be converted</param>
2319 <returns><paramref name="value" /> converted to datetime. The function fails with an exception when the conversion is not possible.</returns>
2320 </member>
2321 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToBoolean(System.Boolean)">
2322 <summary>
2323 Converts the argument to a boolean
2324 </summary>
2325 <param name="value">The string value to be converted to boolean. Must be 'true' or 'false'.</param>
2326 <returns>
2327 <paramref name="value" /> converted to boolean. The function fails
2328 with an exception when the conversion is not possible.
2329 </returns>
2330 </member>
2331 <member name="M:NAnt.Core.Functions.DateTimeFunctions.Now">
2332 <summary>
2333 Gets a <see cref="T:System.DateTime"/> that is the current local date and
2334 time on this computer.
2335 </summary>
2336 <returns>
2337 A <see cref="T:System.DateTime"/> whose value is the current date and time.
2338 </returns>
2339 </member>
2340 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetYear(System.DateTime)">
2341 <summary>
2342 Gets the year component of the specified date.
2343 </summary>
2344 <param name="date">The date of which to get the year component.</param>
2345 <returns>
2346 The year, between 1 and 9999.
2347 </returns>
2348 </member>
2349 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMonth(System.DateTime)">
2350 <summary>
2351 Gets the month component of the specified date.
2352 </summary>
2353 <param name="date">The date of which to get the month component.</param>
2354 <returns>
2355 The month, between 1 and 12.
2356 </returns>
2357 </member>
2358 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDay(System.DateTime)">
2359 <summary>
2360 Gets the day of the month represented by the specified date.
2361 </summary>
2362 <param name="date">The date of which to get the day of the month.</param>
2363 <returns>
2364 The day value, between 1 and 31.
2365 </returns>
2366 </member>
2367 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetHour(System.DateTime)">
2368 <summary>
2369 Gets the hour component of the specified date.
2370 </summary>
2371 <param name="date">The date of which to get the hour component.</param>
2372 <returns>
2373 The hour, between 0 and 23.
2374 </returns>
2375 </member>
2376 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMinute(System.DateTime)">
2377 <summary>
2378 Gets the minute component of the specified date.
2379 </summary>
2380 <param name="date">The date of which to get the minute component.</param>
2381 <returns>
2382 The minute, between 0 and 59.
2383 </returns>
2384 </member>
2385 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetSecond(System.DateTime)">
2386 <summary>
2387 Gets the seconds component of the specified date.
2388 </summary>
2389 <param name="date">The date of which to get the seconds component.</param>
2390 <returns>
2391 The seconds, between 0 and 59.
2392 </returns>
2393 </member>
2394 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMillisecond(System.DateTime)">
2395 <summary>
2396 Gets the milliseconds component of the specified date.
2397 </summary>
2398 <param name="date">The date of which to get the milliseconds component.</param>
2399 <returns>
2400 The millisecond, between 0 and 999.
2401 </returns>
2402 </member>
2403 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetTicks(System.DateTime)">
2404 <summary>
2405 Gets the number of ticks that represent the specified date.
2406 </summary>
2407 <param name="date">The date of which to get the number of ticks.</param>
2408 <returns>
2409 The number of ticks that represent the date and time of the
2410 specified date.
2411 </returns>
2412 </member>
2413 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfWeek(System.DateTime)">
2414 <summary>
2415 Gets the day of the week represented by the specified date.
2416 </summary>
2417 <param name="date">The date of which to get the day of the week.</param>
2418 <returns>
2419 The day of the week, ranging from zero, indicating Sunday, to six,
2420 indicating Saturday.
2421 </returns>
2422 </member>
2423 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfYear(System.DateTime)">
2424 <summary>
2425 Gets the day of the year represented by the specified date.
2426 </summary>
2427 <param name="date">The date of which to get the day of the year.</param>
2428 <returns>
2429 The day of the year, between 1 and 366.
2430 </returns>
2431 </member>
2432 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDaysInMonth(System.Int32,System.Int32)">
2433 <summary>
2434 Returns the number of days in the specified month of the specified
2435 year.
2436 </summary>
2437 <param name="year">The year.</param>
2438 <param name="month">The month (a number ranging from 1 to 12).</param>
2439 <returns>
2440 The number of days in <paramref name="month"/> for the specified
2441 <paramref name="year"/>.
2442 </returns>
2443 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="month"/> is less than 1 or greater than 12.</exception>
2444 </member>
2445 <member name="M:NAnt.Core.Functions.DateTimeFunctions.IsLeapYear(System.Int32)">
2446 <summary>
2447 Returns an indication whether the specified year is a leap year.
2448 </summary>
2449 <param name="year">A 4-digit year.</param>
2450 <returns>
2451 <see langword="true" /> if <paramref name="year" /> is a leap year;
2452 otherwise, <see langword="false" />.
2453 </returns>
2454 </member>
2455 <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.Parse(System.String)">
2456 <summary>
2457 Converts the specified string representation of a date and time to
2458 its <see cref="T:System.DateTime"/> equivalent.
2459 </summary>
2460 <param name="s">A string containing a date and time to convert.</param>
2461 <returns>
2462 A <see cref="T:System.DateTime"/> equivalent to the date and time contained
2463 in <paramref name="s"/>.
2464 </returns>
2465 <exception cref="T:System.FormatException"><paramref name="s"/> does not contain a valid string representation of a date and time.</exception>
2466 <remarks>
2467 The <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture is
2468 used to supply formatting information about <paramref name="s"/>.
2469 </remarks>
2470 </member>
2471 <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.ToString(System.DateTime)">
2472 <summary>
2473 Converts the specified <see cref="T:System.DateTime"/> to its equivalent
2474 string representation.
2475 </summary>
2476 <param name="value">A <see cref="T:System.DateTime"/> to convert.</param>
2477 <returns>
2478 A string representation of <paramref name="value"/> formatted using
2479 the general format specifier ("G").
2480 </returns>
2481 <remarks>
2482 <paramref name="value"/> is formatted with the
2483 <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture.
2484 </remarks>
2485 </member>
2486 <member name="T:NAnt.Core.Functions.DirectoryFunctions">
2487 <summary>
2488 Groups a set of functions for dealing with directories.
2489 </summary>
2490 </member>
2491 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCreationTime(System.String)">
2492 <summary>
2493 Returns the creation date and time of the specified directory.
2494 </summary>
2495 <param name="path">The directory for which to obtain creation date and time information.</param>
2496 <returns>
2497 The creation date and time of the specified directory.
2498 </returns>
2499 <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
2500 <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>
2501 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2502 </member>
2503 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastWriteTime(System.String)">
2504 <summary>
2505 Returns the date and time the specified directory was last written to.
2506 </summary>
2507 <param name="path">The directory for which to obtain write date and time information.</param>
2508 <returns>
2509 The date and time the specified directory was last written to.
2510 </returns>
2511 <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
2512 <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>
2513 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2514 </member>
2515 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastAccessTime(System.String)">
2516 <summary>
2517 Returns the date and time the specified directory was last accessed.
2518 </summary>
2519 <param name="path">The directory for which to obtain access date and time information.</param>
2520 <returns>
2521 The date and time the specified directory was last accessed.
2522 </returns>
2523 <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
2524 <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>
2525 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2526 <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
2527 </member>
2528 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCurrentDirectory">
2529 <summary>
2530 Gets the current working directory.
2531 </summary>
2532 <returns>
2533 A <see cref="T:System.String"/> containing the path of the current working
2534 directory.
2535 </returns>
2536 </member>
2537 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetParentDirectory(System.String)">
2538 <summary>
2539 Retrieves the parent directory of the specified path.
2540 </summary>
2541 <param name="path">The path for which to retrieve the parent directory.</param>
2542 <returns>
2543 The parent directory, or an empty <see cref="T:System.String"/> if
2544 <paramref name="path"/> is the root directory, including the root
2545 of a UNC server or share name.
2546 </returns>
2547 <exception cref="T:System.IO.IOException">The directory specified by <paramref name="path"/> is read-only.</exception>
2548 <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>
2549 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2550 <exception cref="T:System.IO.DirectoryNotFoundException">The specified path was not found.</exception>
2551 <example>
2552 <para>
2553 Copy "readme.txt" from the current working directory to
2554 its parent directory.
2555 </para>
2556 <code>
2557 <![CDATA[
2558 <property name="current.dir" value="${directory::get-current-directory()}" />
2559 <property name="current.dir.parent" value="${directory::get-parent-directory(current.dir)}" />
2560 <copy file="${path::combine(current.dir, 'readme.txt')} todir="${current.dir.parent}" />
2561 ]]>
2562 </code>
2563 </example>
2564 </member>
2565 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetDirectoryRoot(System.String)">
2566 <summary>
2567 Returns the volume information, root information, or both for the
2568 specified path.
2569 </summary>
2570 <param name="path">The path for which to retrieve the parent directory.</param>
2571 <returns>
2572 A string containing the volume information, root information, or
2573 both for the specified path.
2574 </returns>
2575 <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>
2576 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2577 </member>
2578 <member name="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)">
2579 <summary>
2580 Determines whether the given path refers to an existing directory
2581 on disk.
2582 </summary>
2583 <param name="path">The path to test.</param>
2584 <returns>
2585 <see langword="true" /> if <paramref name="path" /> refers to an
2586 existing directory; otherwise, <see langword="false" />.
2587 </returns>
2588 <example>
2589 <para>Remove directory "test", if it exists.</para>
2590 <code>
2591 <![CDATA[
2592 <delete dir="test" if="${directory::exists('test')}" />
2593 ]]>
2594 </code>
2595 </example>
2596 </member>
2597 <member name="T:NAnt.Core.Functions.DnsFunctions">
2598 <summary>
2599 Functions for requesting information from DNS.
2600 </summary>
2601 </member>
2602 <member name="M:NAnt.Core.Functions.DnsFunctions.GetHostName">
2603 <summary>
2604 Gets the host name of the local computer.
2605 </summary>
2606 <returns>
2607 A string that contains the DNS host name of the local computer.
2608 </returns>
2609 <exception cref="T:System.Net.Sockets.SocketException">An error is encountered when resolving the local host name.</exception>
2610 </member>
2611 <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.Parse(System.String)">
2612 <summary>
2613 Converts the specified string representation of a number to its
2614 double-precision floating point number equivalent.
2615 </summary>
2616 <param name="s">A string containing a number to convert.</param>
2617 <returns>
2618 A double-precision floating point number equivalent to the numeric
2619 value or symbol specified in <paramref name="s"/>.
2620 </returns>
2621 <exception cref="T:System.FormatException"><paramref name="s"/> is not a number in a valid format.</exception>
2622 <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>
2623 <remarks>
2624 The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
2625 used to supply formatting information about <paramref name="s"/>.
2626 </remarks>
2627 </member>
2628 <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.ToString(System.Double)">
2629 <summary>
2630 Converts the specified <see cref="T:System.Double"/> to its equivalent
2631 string representation.
2632 </summary>
2633 <param name="value">A <see cref="T:System.Double"/> to convert.</param>
2634 <returns>
2635 The string representation of <paramref name="value"/> formatted
2636 using the general format specifier ("G").
2637 </returns>
2638 <remarks>
2639 <paramref name="value"/> is formatted with the
2640 <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
2641 </remarks>
2642 </member>
2643 <member name="T:NAnt.Core.Functions.EnvironmentFunctions">
2644 <summary>
2645 Provide information about the current environment and platform.
2646 </summary>
2647 </member>
2648 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)">
2649 <summary>
2650 Gets the path to the system special folder identified by the
2651 specified enumeration.
2652 </summary>
2653 <param name="folder">An enumerated constant that identifies a system special folder.</param>
2654 <returns>
2655 The path to the specified system special folder, if that folder
2656 physically exists on your computer; otherwise, the empty string ("").
2657 </returns>
2658 <exception cref="T:System.ArgumentException"><paramref name="folder"/> is not a member of <see cref="T:System.Environment.SpecialFolder"/>.</exception>
2659 <example>
2660 <para>
2661 Copy "out.log" from the project base directory to the
2662 program files directory.
2663 </para>
2664 <code>
2665 <![CDATA[
2666 <copy file="out.log" todir="${environment::get-folder-path('ProgramFiles')}" />
2667 ]]>
2668 </code>
2669 </example>
2670 </member>
2671 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetMachineName">
2672 <summary>
2673 Gets the NetBIOS name of this local computer.
2674 </summary>
2675 <returns>
2676 The NetBIOS name of this local computer.
2677 </returns>
2678 <exception cref="T:System.InvalidOperationException">The name of this computer cannot be obtained.</exception>
2679 </member>
2680 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem">
2681 <summary>
2682 Gets an <see cref="T:System.OperatingSystem"/> object that represents the
2683 current operating system.
2684 </summary>
2685 <returns>
2686 An <see cref="T:System.OperatingSystem"/> object that contains the current
2687 platform identifier and version number.
2688 </returns>
2689 <example>
2690 <para>
2691 Output string representation of the current operating system.
2692 </para>
2693 <code>
2694 <![CDATA[
2695 <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" />
2696 ]]>
2697 </code>
2698 <para>If the operating system is Windows 2000, the output is:</para>
2699 <code>
2700 Microsoft Windows NT 5.0.2195.0
2701 </code>
2702 </example>
2703 <seealso cref="T:NAnt.Core.Functions.OperatingSystemFunctions"/>
2704 </member>
2705 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetUserName">
2706 <summary>
2707 Gets the user name of the person who started the current thread.
2708 </summary>
2709 <returns>
2710 The name of the person logged on to the system who started the
2711 current thread.
2712 </returns>
2713 <example>
2714 <para>
2715 Modify the home directory of the current user on unix-based systems.
2716 </para>
2717 <code>
2718 <![CDATA[
2719 <exec program="usermod">
2720 <arg value="-d" />
2721 <arg value="/home/temp" />
2722 <arg value="${environment::get-user-name()}" />
2723 </exec>
2724 ]]>
2725 </code>
2726 </example>
2727 </member>
2728 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)">
2729 <summary>
2730 Returns the value of the specified environment variable.
2731 </summary>
2732 <param name="name">The environment variable of which the value should be returned.</param>
2733 <returns>
2734 The value of the specified environment variable.
2735 </returns>
2736 <exception cref="T:System.ArgumentException">Environment variable <paramref name="name"/> does not exist.</exception>
2737 </member>
2738 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.VariableExists(System.String)">
2739 <summary>
2740 Gets a value indicating whether the specified environment variable
2741 exists.
2742 </summary>
2743 <param name="name">The environment variable that should be checked.</param>
2744 <returns>
2745 <see langword="true" /> if the environment variable exists; otherwise,
2746 <see langword="false" />.
2747 </returns>
2748 <example>
2749 <para>
2750 Execute a set of tasks only if the "BUILD_DEBUG" environment
2751 variable is set.
2752 </para>
2753 <code>
2754 <![CDATA[
2755 <if test="${environment::variable-exists('BUILD_DEBUG')}">
2756 ...
2757 </if>
2758 ]]>
2759 </code>
2760 </example>
2761 </member>
2762 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion">
2763 <summary>
2764 Gets a <see cref="T:System.Version"/> object that describes the major,
2765 minor, build, and revision numbers of the Common Language Runtime.
2766 </summary>
2767 <returns>
2768 A Version object.
2769 </returns>
2770 <example>
2771 <para>Output the major version of the CLR.</para>
2772 <code>
2773 <![CDATA[
2774 <echo message="Major version=${version::get-major(environment::get-version())}" />
2775 ]]>
2776 </code>
2777 </example>
2778 </member>
2779 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.NewLine">
2780 <summary>
2781 Gets the newline string defined for this environment.
2782 </summary>
2783 <returns>
2784 A string containing CRLF for non-Unix platforms, or LF for Unix
2785 platforms.
2786 </returns>
2787 <example>
2788 <para>Output two lines in a log file.</para>
2789 <code>
2790 <![CDATA[
2791 <echo file="build.log" message="First line${environment::newline()}Second line" />
2792 ]]>
2793 </code>
2794 </example>
2795 </member>
2796 <member name="T:NAnt.Core.Functions.FileFunctions">
2797 <summary>
2798 Groups a set of functions for dealing with files.
2799 </summary>
2800 </member>
2801 <member name="M:NAnt.Core.Functions.FileFunctions.GetCreationTime(System.String)">
2802 <summary>
2803 Returns the creation date and time of the specified file.
2804 </summary>
2805 <param name="path">The file for which to obtain creation date and time information.</param>
2806 <returns>
2807 The creation date and time of the specified file.
2808 </returns>
2809 <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
2810 <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>
2811 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2812 <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
2813 </member>
2814 <member name="M:NAnt.Core.Functions.FileFunctions.GetLastWriteTime(System.String)">
2815 <summary>
2816 Returns the date and time the specified file was last written to.
2817 </summary>
2818 <param name="path">The file for which to obtain write date and time information.</param>
2819 <returns>
2820 The date and time the specified file was last written to.
2821 </returns>
2822 <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
2823 <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>
2824 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2825 </member>
2826 <member name="M:NAnt.Core.Functions.FileFunctions.GetLastAccessTime(System.String)">
2827 <summary>
2828 Returns the date and time the specified file was last accessed.
2829 </summary>
2830 <param name="path">The file for which to obtain access date and time information.</param>
2831 <returns>
2832 The date and time the specified file was last accessed.
2833 </returns>
2834 <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
2835 <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>
2836 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
2837 <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
2838 </member>
2839 <member name="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)">
2840 <summary>
2841 Determines whether the specified file exists.
2842 </summary>
2843 <param name="file">The file to check.</param>
2844 <returns>
2845 <see langword="true" /> if <paramref name="file" /> refers to an
2846 existing file; otherwise, <see langword="false" />.
2847 </returns>
2848 <example>
2849 <para>Execute a set of tasks, if file "output.xml" does not exist.</para>
2850 <code>
2851 <![CDATA[
2852 <if test="${not file::exists('output.xml')}">
2853 ...
2854 </if>
2855 ]]>
2856 </code>
2857 </example>
2858 </member>
2859 <member name="M:NAnt.Core.Functions.FileFunctions.UpToDate(System.String,System.String)">
2860 <summary>
2861 Determines whether <paramref name="targetFile"/> is more or equal
2862 up-to-date than <paramref name="srcFile"/>.
2863 </summary>
2864 <param name="srcFile">The file to check against the target file.</param>
2865 <param name="targetFile">The file for which we want to determine the status.</param>
2866 <returns>
2867 <see langword="true"/> if <paramref name="targetFile"/> is more
2868 or equal up-to-date than <paramref name="srcFile"/>; otherwise,
2869 <see langword="false"/>.
2870 </returns>
2871 <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>
2872 <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>
2873 </member>
2874 <member name="M:NAnt.Core.Functions.FileFunctions.GetLength(System.String)">
2875 <summary>
2876 Gets the length of the file.
2877 </summary>
2878 <param name="file">filename</param>
2879 <returns>
2880 Length in bytes, of the file named <paramref name="file"/>.
2881 </returns>
2882 <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception>
2883 </member>
2884 <member name="M:NAnt.Core.Functions.FileFunctions.IsAssembly(System.String)">
2885 <summary>
2886 Checks if a given file is an assembly.
2887 </summary>
2888 <param name="assemblyFile">The name or path of the file to be checked.</param>
2889 <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>
2890 <exception cref="T:System.ArgumentNullException"><paramref name="assemblyFile"/> is a null <see cref="T:System.String"/>.</exception>
2891 <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
2892 <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>
2893 <exception cref="T:System.Security.SecurityException">The caller does not have path discovery permission.</exception>
2894 </member>
2895 <member name="T:NAnt.Core.Functions.FileVersionInfoFunctions">
2896 <summary>
2897 Functions that provide version information for a physical file on disk.
2898 </summary>
2899 </member>
2900 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetVersionInfo(System.String)">
2901 <summary>
2902 Returns a <see cref="T:System.Diagnostics.FileVersionInfo"/> representing the version
2903 information associated with the specified file.
2904 </summary>
2905 <param name="fileName">The file to retrieve the version information for.</param>
2906 <returns>
2907 A <see cref="T:System.Diagnostics.FileVersionInfo"/> containing information about the file.
2908 </returns>
2909 <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception>
2910 </member>
2911 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetCompanyName(System.Diagnostics.FileVersionInfo)">
2912 <summary>
2913 Gets the name of the company that produced the file.
2914 </summary>
2915 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
2916 <returns>
2917 The name of the company that produced the file.
2918 </returns>
2919 </member>
2920 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetFileVersion(System.Diagnostics.FileVersionInfo)">
2921 <summary>
2922 Gets the file version of a file.
2923 </summary>
2924 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
2925 <returns>
2926 The file version of a file.
2927 </returns>
2928 <see cref="T:NAnt.Core.Functions.VersionFunctions"/>
2929 </member>
2930 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductName(System.Diagnostics.FileVersionInfo)">
2931 <summary>
2932 Gets the name of the product the file is distributed with.
2933 </summary>
2934 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
2935 <returns>
2936 The name of the product the file is distributed with.
2937 </returns>
2938 </member>
2939 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductVersion(System.Diagnostics.FileVersionInfo)">
2940 <summary>
2941 Gets the product version of a file.
2942 </summary>
2943 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
2944 <returns>
2945 The product version of a file.
2946 </returns>
2947 <see cref="T:NAnt.Core.Functions.VersionFunctions"/>
2948 </member>
2949 <member name="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)">
2950 <summary>
2951 Checks whether the specified framework exists, and is valid.
2952 </summary>
2953 <param name="framework">The framework to test.</param>
2954 <returns>
2955 <see langword="true" /> if the specified framework exists ; otherwise,
2956 <see langword="false" />.
2957 </returns>
2958 </member>
2959 <member name="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)">
2960 <summary>
2961 Checks whether the SDK for the specified framework is installed.
2962 </summary>
2963 <param name="framework">The framework to test.</param>
2964 <returns>
2965 <see langword="true"/> if the SDK for specified framework is installed;
2966 otherwise, <see langword="false"/>.
2967 </returns>
2968 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
2969 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
2970 </member>
2971 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework">
2972 <summary>
2973 Gets the identifier of the current target framework.
2974 </summary>
2975 <returns>
2976 The identifier of the current target framework.
2977 </returns>
2978 </member>
2979 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework">
2980 <summary>
2981 Gets the identifier of the runtime framework.
2982 </summary>
2983 <returns>
2984 The identifier of the runtime framework.
2985 </returns>
2986 </member>
2987 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFamily(System.String)">
2988 <summary>
2989 Gets the family of the specified framework.
2990 </summary>
2991 <param name="framework">The framework of which the family should be returned.</param>
2992 <returns>
2993 The family of the specified framework.
2994 </returns>
2995 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
2996 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
2997 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
2998 </member>
2999 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetVersion">
3000 <summary>
3001 Gets the version of the current target framework.
3002 </summary>
3003 <returns>
3004 The version of the current target framework.
3005 </returns>
3006 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3007 </member>
3008 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetVersion(System.String)">
3009 <summary>
3010 Gets the version of the specified framework.
3011 </summary>
3012 <param name="framework">The framework of which the version should be returned.</param>
3013 <returns>
3014 The version of the specified framework.
3015 </returns>
3016 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3017 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3018 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3019 </member>
3020 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetDescription">
3021 <summary>
3022 Gets the description of the current target framework.
3023 </summary>
3024 <returns>
3025 The description of the current target framework.
3026 </returns>
3027 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3028 </member>
3029 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetDescription(System.String)">
3030 <summary>
3031 Gets the description of the specified framework.
3032 </summary>
3033 <param name="framework">The framework of which the description should be returned.</param>
3034 <returns>
3035 The description of the specified framework.
3036 </returns>
3037 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3038 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3039 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3040 </member>
3041 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetClrVersion">
3042 <summary>
3043 Gets the Common Language Runtime version of the current target
3044 framework.
3045 </summary>
3046 <returns>
3047 The Common Language Runtime version of the current target framework.
3048 </returns>
3049 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3050 </member>
3051 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetClrVersion(System.String)">
3052 <summary>
3053 Gets the Common Language Runtime version of the specified framework.
3054 </summary>
3055 <param name="framework">The framework of which the Common Language Runtime version should be returned.</param>
3056 <returns>
3057 The Common Language Runtime version of 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.GetFrameworkDirectory(System.String)">
3064 <summary>
3065 Gets the framework directory of the specified framework.
3066 </summary>
3067 <param name="framework">The framework of which the framework directory should be returned.</param>
3068 <returns>
3069 The framework directory of the specified framework.
3070 </returns>
3071 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3072 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3073 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3074 </member>
3075 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetAssemblyDirectory(System.String)">
3076 <summary>
3077 Gets the assembly directory of the specified framework.
3078 </summary>
3079 <param name="framework">The framework of which the assembly directory should be returned.</param>
3080 <returns>
3081 The assembly directory of the specified framework.
3082 </returns>
3083 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3084 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3085 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3086 </member>
3087 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetSdkDirectory(System.String)">
3088 <summary>
3089 Gets the SDK directory of the specified framework.
3090 </summary>
3091 <param name="framework">The framework of which the SDK directory should be returned.</param>
3092 <returns>
3093 The SDK directory of the specified framework, or an empty
3094 <see cref="T:System.String"/> if the SDK of the specified framework is not
3095 installed.
3096 </returns>
3097 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3098 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3099 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3100 </member>
3101 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetToolPath(System.String)">
3102 <summary>
3103 Gets the absolute path of the specified tool for the current
3104 target framework.
3105 </summary>
3106 <param name="tool">The file name of the tool to search for.</param>
3107 <returns>
3108 The absolute path to <paramref name="tool"/> if found in one of the
3109 configured tool paths; otherwise, an error is reported.
3110 </returns>
3111 <exception cref="T:System.IO.FileNotFoundException"><paramref name="tool"/> could not be found in the configured tool paths.</exception>
3112 <remarks>
3113 <para>
3114 The configured tool paths are scanned in the order in which they
3115 are defined in the framework configuration.
3116 </para>
3117 <para>
3118 The file name of the tool to search should include the extension.
3119 </para>
3120 </remarks>
3121 <example>
3122 <para>Use <b>gacutil</b> to install an assembly in the GAC.</para>
3123 <code>
3124 <![CDATA[
3125 <exec program="${framework::get-tool-path('gacutil.exe')}" managed="strict">
3126 <arg value="/i" />
3127 <arg file="Cegeka.HealthFramework.dll" />
3128 </exec>
3129 ]]>
3130 </code>
3131 </example>
3132 </member>
3133 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeEngine(System.String)">
3134 <summary>
3135 Gets the runtime engine of the specified framework.
3136 </summary>
3137 <param name="framework">The framework of which the runtime engine should be returned.</param>
3138 <returns>
3139 The full path to the runtime engine of the specified framework, or
3140 an empty <see cref="T:System.String"/> if no runtime engine is defined
3141 for the specified framework.
3142 </returns>
3143 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3144 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
3145 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
3146 </member>
3147 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFrameworks(NAnt.Core.FrameworkTypes)">
3148 <summary>
3149 Gets a comma-separated list of frameworks filtered by the specified
3150 <see cref="T:NAnt.Core.FrameworkTypes"/>.
3151 </summary>
3152 <param name="types">A bitwise combination of <see cref="T:NAnt.Core.FrameworkTypes"/> values that filter the frameworks to retrieve.</param>
3153 <returns>
3154 A comma-separated list of frameworks filtered by the specified
3155 <see cref="T:NAnt.Core.FrameworkTypes"/>, sorted on name.
3156 </returns>
3157 <example>
3158 <para>
3159 Define a <b>build-all</b> target that executes the <b>build</b>
3160 target once for each installed framework targeting compact
3161 devices.
3162 </para>
3163 <code>
3164 <![CDATA[
3165 <target name="build-all">
3166 <foreach item="String" in="${framework::get-frameworks('installed compact')}" delim="," property="framework">
3167 <property name="nant.settings.currentframework" value="${framework}" />
3168 <call target="build" />
3169 </foreach>
3170 </target>
3171
3172 <target name="build">
3173 ...
3174 </target>
3175 ]]>
3176 </code>
3177 </example>
3178 </member>
3179 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFramework(System.String)">
3180 <summary>
3181 Checks whether the specified framework is valid.
3182 </summary>
3183 <param name="framework">The framework to check.</param>
3184 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
3185 </member>
3186 <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.Parse(System.String)">
3187 <summary>
3188 Converts the specified string representation of a number to its
3189 32-bit signed integer equivalent.
3190 </summary>
3191 <param name="s">A string containing a number to convert.</param>
3192 <returns>
3193 A 32-bit signed integer equivalent to the number contained in
3194 <paramref name="s"/>.
3195 </returns>
3196 <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception>
3197 <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>
3198 <remarks>
3199 The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
3200 used to supply formatting information about <paramref name="s"/>.
3201 </remarks>
3202 </member>
3203 <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.ToString(System.Int32)">
3204 <summary>
3205 Converts the specified <see cref="T:System.Int32"/> to its equivalent string
3206 representation.
3207 </summary>
3208 <param name="value">A <see cref="T:System.Int32"/> to convert.</param>
3209 <returns>
3210 The string representation of <paramref name="value"/>, consisting
3211 of a negative sign if the value is negative, and a sequence of
3212 digits ranging from 0 to 9 with no leading zeroes.
3213 </returns>
3214 <remarks>
3215 <paramref name="value"/> is formatted with the
3216 <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
3217 </remarks>
3218 </member>
3219 <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.Parse(System.String)">
3220 <summary>
3221 Converts the specified string representation of a number to its
3222 64-bit signed integer equivalent.
3223 </summary>
3224 <param name="s">A string containing a number to convert.</param>
3225 <returns>
3226 A 64-bit signed integer equivalent to the number contained in
3227 <paramref name="s"/>.
3228 </returns>
3229 <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception>
3230 <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>
3231 <remarks>
3232 The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
3233 used to supply formatting information about <paramref name="s"/>.
3234 </remarks>
3235 </member>
3236 <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.ToString(System.Int64)">
3237 <summary>
3238 Converts the specified <see cref="T:System.Int64"/> to its equivalent string
3239 representation.
3240 </summary>
3241 <param name="value">A <see cref="T:System.Int64"/> to convert.</param>
3242 <returns>
3243 The string representation of <paramref name="value"/>, consisting
3244 of a negative sign if the value is negative, and a sequence of
3245 digits ranging from 0 to 9 with no leading zeroes.
3246 </returns>
3247 <remarks>
3248 <paramref name="value"/> is formatted with the
3249 <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
3250 </remarks>
3251 </member>
3252 <member name="M:NAnt.Core.Functions.MathFunctions.Round(System.Double)">
3253 <summary>
3254 Rounds the value to the nearest whole number
3255 </summary>
3256 <param name="value">Number to be rounded, can be anything convertible to a double.</param>
3257 <returns>
3258 Rounded value.
3259 </returns>
3260 </member>
3261 <member name="M:NAnt.Core.Functions.MathFunctions.Floor(System.Double)">
3262 <summary>
3263 Returns the largest whole number less than or equal to the specified
3264 number.
3265 </summary>
3266 <param name="value">value to be , can be anything convertible to a double</param>
3267 <returns>
3268 The largest whole number less than or equal to the specified number.
3269 </returns>
3270 </member>
3271 <member name="M:NAnt.Core.Functions.MathFunctions.Ceiling(System.Double)">
3272 <summary>
3273 Returns the smallest whole number greater than or equal to the specified number
3274 </summary>
3275 <param name="value">value</param>
3276 <returns>
3277 The smallest whole number greater than or equal to the specified number.
3278 </returns>
3279 </member>
3280 <member name="M:NAnt.Core.Functions.MathFunctions.Abs(System.Double)">
3281 <summary>
3282 Returns the absolute value of the specified number
3283 </summary>
3284 <param name="value">value to take the absolute value from</param>
3285 <returns>
3286 <paramref name="value" /> when <paramref name="value" /> is greater
3287 than or equal to zero; otherwise, -<paramref name="value" />.
3288 </returns>
3289 </member>
3290 <member name="M:NAnt.Core.Functions.NAntFunctions.GetBaseDirectory">
3291 <summary>
3292 Gets the base directory of the appdomain in which NAnt is running.
3293 </summary>
3294 <returns>
3295 The base directory of the appdomain in which NAnt is running.
3296 </returns>
3297 </member>
3298 <member name="M:NAnt.Core.Functions.NAntFunctions.GetAssembly">
3299 <summary>
3300 Gets the NAnt assembly.
3301 </summary>
3302 <returns>
3303 The NAnt assembly.
3304 </returns>
3305 </member>
3306 <member name="M:NAnt.Core.Functions.NAntFunctions.ScanProbingPaths(System.String)">
3307 <summary>
3308 Searches the probing paths of the current target framework for the
3309 specified file.
3310 </summary>
3311 <param name="fileName">The name of the file to search for.</param>
3312 <returns>
3313 The absolute path to <paramref name="fileName"/> if found in one of the
3314 configured probing; otherwise, an error is reported.
3315 </returns>
3316 <exception cref="T:System.IO.FileNotFoundException"><paramref name="fileName"/> could not be found in the configured probing paths.</exception>
3317 <remarks>
3318 <para>
3319 The (relative) probing paths are resolved relative to the base
3320 directory of the appdomain in which NAnt is running.
3321 </para>
3322 <para>
3323 The configured probing paths are scanned recursively in the order
3324 in which they are defined in the framework configuration.
3325 </para>
3326 <para>
3327 The file name to search should include the extension.
3328 </para>
3329 </remarks>
3330 <example>
3331 <para>
3332 Compile an assembly referencing the <c>nunit.framework</c> assembly
3333 for the current target framework that is shipped as part of the
3334 NAnt distribution.
3335 </para>
3336 <code>
3337 <![CDATA[
3338 <csc target="library" output="NAnt.Core.Tests.dll">
3339 <sources basedir="NAnt.Core">
3340 <include name="**/*.cs" />
3341 </sources>
3342 <references>
3343 <include name="NAnt.Core.dll" />
3344 <include name="${framework::get-lib-path('nunit.framework.dll')}" />
3345 </references>
3346 </csc>
3347 ]]>
3348 </code>
3349 </example>
3350 </member>
3351 <member name="M:NAnt.Core.Functions.NAntFunctions.ScanProbingPaths(System.String,System.String)">
3352 <summary>
3353 Searches the probing paths of the current target framework for the
3354 specified file.
3355 </summary>
3356 <param name="baseDirectory">The directory to use a base directory for the probing paths.</param>
3357 <param name="fileName">The name of the file to search for.</param>
3358 <returns>
3359 The absolute path to <paramref name="fileName"/> if found in one of the
3360 configured probing; otherwise, an error is reported.
3361 </returns>
3362 <exception cref="T:System.IO.FileNotFoundException"><paramref name="fileName"/> could not be found in the configured probing paths.</exception>
3363 <remarks>
3364 <para>
3365 The (relative) probing paths are resolved relative to the specified
3366 base directory.
3367 </para>
3368 <para>
3369 The configured probing paths are scanned recursively in the order
3370 in which they are defined in the framework configuration.
3371 </para>
3372 <para>
3373 The file name to search should include the extension.
3374 </para>
3375 </remarks>
3376 <example>
3377 <para>
3378 Compile an assembly referencing the <c>nunit.framework</c> assembly
3379 for the current target framework that is shipped as part of the
3380 NAnt distribution.
3381 </para>
3382 <code>
3383 <![CDATA[
3384 <csc target="library" output="NAnt.Core.Tests.dll">
3385 <sources basedir="NAnt.Core">
3386 <include name="**/*.cs" />
3387 </sources>
3388 <references>
3389 <include name="NAnt.Core.dll" />
3390 <include name="${framework::get-lib-path('nunit.framework.dll')}" />
3391 </references>
3392 </csc>
3393 ]]>
3394 </code>
3395 </example>
3396 </member>
3397 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetName">
3398 <summary>
3399 Gets the name of the current project.
3400 </summary>
3401 <returns>
3402 The name of the current project, or an empty <see cref="T:System.String"/>
3403 if no name is specified in the build file.
3404 </returns>
3405 </member>
3406 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFileUri">
3407 <summary>
3408 Gets the <see cref="T:System.Uri"/> form of the build file.
3409 </summary>
3410 <returns>
3411 The <see cref="T:System.Uri"/> form of the build file, or
3412 an empty <see cref="T:System.String"/> if the project is not file backed.
3413 </returns>
3414 </member>
3415 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFilePath">
3416 <summary>
3417 Gets the local path to the build file.
3418 </summary>
3419 <returns>
3420 The local path of the build file, or an empty <see cref="T:System.String"/>
3421 if the project is not file backed.
3422 </returns>
3423 </member>
3424 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetDefaultTarget">
3425 <summary>
3426 Gets the name of the target that will be executed when no other
3427 build targets are specified.
3428 </summary>
3429 <returns>
3430 The name of the target that will be executed when no other build
3431 targets are specified, or an empty <see cref="T:System.String"/> if no
3432 default target is defined for the project.
3433 </returns>
3434 </member>
3435 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBaseDirectory">
3436 <summary>
3437 Gets the base directory of the current project.
3438 </summary>
3439 <returns>
3440 The base directory of the current project.
3441 </returns>
3442 </member>
3443 <member name="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)">
3444 <summary>
3445 Checks whether the specified target exists.
3446 </summary>
3447 <param name="name">The target to test.</param>
3448 <returns>
3449 <see langword="true" /> if the specified target exists; otherwise,
3450 <see langword="false" />.
3451 </returns>
3452 <example>
3453 <para>
3454 Execute target "clean", if it exists.
3455 </para>
3456 <code>
3457 <![CDATA[
3458 <if test="${target::exists('clean')}">
3459 <call target="clean" />
3460 </if>
3461 ]]>
3462 </code>
3463 </example>
3464 </member>
3465 <member name="M:NAnt.Core.Functions.TargetFunctions.GetCurrentTarget">
3466 <summary>
3467 Gets the name of the target being executed.
3468 </summary>
3469 <returns>
3470 A <see cref="T:System.String"/> that contains the name of the target
3471 being executed.
3472 </returns>
3473 <exception cref="T:System.InvalidOperationException">No target is being executed.</exception>
3474 </member>
3475 <member name="M:NAnt.Core.Functions.TargetFunctions.HasExecuted(System.String)">
3476 <summary>
3477 Checks whether the specified target has already been executed.
3478 </summary>
3479 <param name="name">The target to test.</param>
3480 <returns>
3481 <see langword="true"/> if the specified target has already been
3482 executed; otherwise, <see langword="false"/>.
3483 </returns>
3484 <exception cref="T:System.ArgumentException">Target <paramref name="name"/> does not exist.</exception>
3485 </member>
3486 <member name="M:NAnt.Core.Functions.TaskFunctions.Exists(System.String)">
3487 <summary>
3488 Checks whether the specified task exists.
3489 </summary>
3490 <param name="name">The task to test.</param>
3491 <returns>
3492 <see langword="true" /> if the specified task exists; otherwise,
3493 <see langword="false" />.
3494 </returns>
3495 </member>
3496 <member name="M:NAnt.Core.Functions.TaskFunctions.GetAssembly(System.String)">
3497 <summary>
3498 Returns the <see cref="T:System.Reflection.Assembly"/> from which the specified task
3499 was loaded.
3500 </summary>
3501 <param name="name">The name of the task to get the <see cref="T:System.Reflection.Assembly"/> of.</param>
3502 <returns>
3503 The <see cref="T:System.Reflection.Assembly"/> from which the specified task was loaded.
3504 </returns>
3505 <exception cref="T:System.ArgumentException">Task <paramref name="name"/> is not available.</exception>
3506 </member>
3507 <member name="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)">
3508 <summary>
3509 Checks whether the specified property exists.
3510 </summary>
3511 <param name="name">The property to test.</param>
3512 <returns>
3513 <see langword="true" /> if the specified property exists; otherwise,
3514 <see langword="false" />.
3515 </returns>
3516 <example>
3517 <para>
3518 Execute a set of tasks if the "build.debug" property
3519 exists.
3520 </para>
3521 <code>
3522 <![CDATA[
3523 <if test="${property::exists('build.debug')}">
3524 <echo message="Starting debug build" />
3525 <call target="init-debug" />
3526 <call target="build" />
3527 </if>
3528 ]]>
3529 </code>
3530 </example>
3531 </member>
3532 <member name="M:NAnt.Core.Functions.PropertyFunctions.IsReadOnly(System.String)">
3533 <summary>
3534 Checks whether the specified property is read-only.
3535 </summary>
3536 <param name="name">The property to test.</param>
3537 <returns>
3538 <see langword="true"/> if the specified property is read-only;
3539 otherwise, <see langword="false"/>.
3540 </returns>
3541 <example>
3542 <para>Check whether the "debug" property is read-only.</para>
3543 <code>property::is-readonly('debug')</code>
3544 </example>
3545 <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception>
3546 </member>
3547 <member name="M:NAnt.Core.Functions.PropertyFunctions.IsDynamic(System.String)">
3548 <summary>
3549 Checks whether the specified property is a dynamic property.
3550 </summary>
3551 <param name="name">The property to test.</param>
3552 <returns>
3553 <see langword="true"/> if the specified property is a dynamic
3554 property; otherwise, <see langword="false"/>.
3555 </returns>
3556 <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception>
3557 <example>
3558 <para>
3559 Check whether the "debug" property is a dynamic property.
3560 </para>
3561 <code>property::is-dynamic('debug')</code>
3562 </example>
3563 </member>
3564 <member name="M:NAnt.Core.Functions.PlatformFunctions.GetName">
3565 <summary>
3566 Gets the name of the platform on which NAnt is running.
3567 </summary>
3568 <returns>
3569 The name of the platform on which NAnt is running.
3570 </returns>
3571 </member>
3572 <member name="M:NAnt.Core.Functions.PlatformFunctions.IsWin32">
3573 <summary>
3574 Checks whether NAnt is running on Windows (and not just 32-bit Windows
3575 as the name may lead you to believe).
3576 </summary>
3577 <returns>
3578 <see langword="true" /> if NAnt is running on Windows;
3579 otherwise, <see langword="false" />.
3580 </returns>
3581 </member>
3582 <member name="M:NAnt.Core.Functions.PlatformFunctions.IsWindows">
3583 <summary>
3584 Checks whether NAnt is running on Windows.
3585 </summary>
3586 <returns>
3587 <see langword="true" /> if NAnt is running on Windows;
3588 otherwise, <see langword="false" />.
3589 </returns>
3590 </member>
3591 <member name="M:NAnt.Core.Functions.PlatformFunctions.IsUnix">
3592 <summary>
3593 Checks whether NAnt is running on Unix.
3594 </summary>
3595 <returns>
3596 <see langword="true" /> if NAnt is running on Unix;
3597 otherwise, <see langword="false" />.
3598 </returns>
3599 </member>
3600 <member name="T:NAnt.Core.Functions.OperatingSystemFunctions">
3601 <summary>
3602 Functions that return information about an operating system.
3603 </summary>
3604 </member>
3605 <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetPlatform(System.OperatingSystem)">
3606 <summary>
3607 Gets a <see cref="T:System.PlatformID"/> value that identifies the operating
3608 system platform.
3609 </summary>
3610 <param name="operatingSystem">The operating system.</param>
3611 <returns>
3612 <see cref="T:System.PlatformID"/> value that identifies the operating system
3613 platform.
3614 </returns>
3615 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
3616 </member>
3617 <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)">
3618 <summary>
3619 Gets a <see cref="T:System.Version"/> object that identifies this operating
3620 system.
3621 </summary>
3622 <param name="operatingSystem">The operating system.</param>
3623 <returns>
3624 A <see cref="T:System.Version"/> object that describes the major version,
3625 minor version, build, and revision of the operating system.
3626 </returns>
3627 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
3628 </member>
3629 <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.ToString(System.OperatingSystem)">
3630 <summary>
3631 Converts the value of the specified operating system to its equivalent
3632 <see cref="T:System.String"/> representation.
3633 </summary>
3634 <param name="operatingSystem">The operating system.</param>
3635 <returns>
3636 The <see cref="T:System.String"/> representation of
3637 <paramref name="operatingSystem"/>.
3638 </returns>
3639 <example>
3640 <para>
3641 Output string representation of the current operating system.
3642 </para>
3643 <code>
3644 <![CDATA[
3645 <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" />
3646 ]]>
3647 </code>
3648 <para>If the operating system is Windows 2000, the output is:</para>
3649 <code>
3650 Microsoft Windows NT 5.0.2195.0
3651 </code>
3652 </example>
3653 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
3654 </member>
3655 <member name="M:NAnt.Core.Functions.PathFunctions.GetFullPath(System.String)">
3656 <summary>
3657 Returns the fully qualified path.
3658 </summary>
3659 <param name="path">The file or directory for which to obtain absolute path information.</param>
3660 <returns>
3661 A string containing the fully qualified location of <paramref name="path"/>,
3662 such as "C:\MyFile.txt".
3663 </returns>
3664 <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>
3665 <exception cref="T:System.NotSupportedException"><paramref name="path"/> contains a colon (":").</exception>
3666 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
3667 </member>
3668 <member name="M:NAnt.Core.Functions.PathFunctions.Combine(System.String,System.String)">
3669 <summary>
3670 Combines two paths.
3671 </summary>
3672 <param name="path1">first path</param>
3673 <param name="path2">second path</param>
3674 <returns>
3675 A string containing the combined paths. If one of the specified paths
3676 is a zero-length string, this method returns the other path. If
3677 <paramref name="path2"/> contains an absolute path, this method
3678 returns <paramref name="path2"/>.
3679 </returns>
3680 <exception cref="T:System.ArgumentException"><paramref name="path1"/> or <paramref name="path2"/> contain one or more invalid characters.</exception>
3681 </member>
3682 <member name="M:NAnt.Core.Functions.PathFunctions.ChangeExtension(System.String,System.String)">
3683 <summary>
3684 Changes the extension of the path string.
3685 </summary>
3686 <param name="path">The path information to modify. The path cannot contain any of the characters
3687 defined in <see cref="F:System.IO.Path.InvalidPathChars"/>InvalidPathChars.</param>
3688 <param name="extension">The new extension (with a leading period). Specify a null reference
3689 to remove an existing extension from <paramref name="path"/>.</param>
3690 <returns>
3691 <para>
3692 A string containing the modified path information.
3693 </para>
3694 <para>
3695 On Windows-based desktop platforms, if <paramref name="path"/> is
3696 an empty <see cref="T:System.String"/>, the path information is returned
3697 unmodified. If <paramref name="path"/> has no extension, the returned
3698 path <see cref="T:System.String"/> contains <paramref name="extension"/>
3699 appended to the end of <paramref name="path"/>.
3700 </para>
3701 </returns>
3702 <remarks>
3703 For more information see the <see cref="T:System.IO.Path"/> documentation.
3704 </remarks>
3705 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3706 </member>
3707 <member name="M:NAnt.Core.Functions.PathFunctions.GetDirectoryName(System.String)">
3708 <summary>
3709 Returns the directory information for the specified path string.
3710 </summary>
3711 <param name="path">The path of a file or directory.</param>
3712 <returns>
3713 A <see cref="T:System.String"/> containing directory information for
3714 <paramref name="path"/>, or an empty <see cref="T:System.String"/> if
3715 <paramref name="path"/> denotes a root directory, or does not
3716 contain directory information.
3717 </returns>
3718 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, is empty, or contains only white spaces.</exception>
3719 </member>
3720 <member name="M:NAnt.Core.Functions.PathFunctions.GetExtension(System.String)">
3721 <summary>
3722 Returns the extension for the specified path string.
3723 </summary>
3724 <param name="path">The path string from which to get the extension.</param>
3725 <returns>
3726 A <see cref="T:System.String"/> containing the extension of the specified
3727 <paramref name="path"/> (including the "."), or an empty
3728 <see cref="T:System.String"/> if <paramref name="path"/> does not have
3729 extension information.
3730 </returns>
3731 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3732 </member>
3733 <member name="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)">
3734 <summary>
3735 Returns the filename for the specified path string.
3736 </summary>
3737 <param name="path">The path string from which to obtain the file name and extension.</param>
3738 <returns>
3739 <para>
3740 A <see cref="T:System.String"/> consisting of the characters after the last
3741 directory character in path.
3742 </para>
3743 <para>
3744 If the last character of <paramref name="path"/> is a directory or
3745 volume separator character, an empty <see cref="T:System.String"/> is returned.
3746 </para>
3747 </returns>
3748 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3749 </member>
3750 <member name="M:NAnt.Core.Functions.PathFunctions.GetFileNameWithoutExtension(System.String)">
3751 <summary>
3752 Returns the filename without extension for the specified path string.
3753 </summary>
3754 <param name="path">The path of the file.</param>
3755 <returns>
3756 A <see cref="T:System.String"/> containing the <see cref="T:System.String"/> returned
3757 by <see cref="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)"/>, minus the last period (.) and all
3758 characters following it.
3759 </returns>
3760 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3761 </member>
3762 <member name="M:NAnt.Core.Functions.PathFunctions.GetPathRoot(System.String)">
3763 <summary>
3764 Gets the root directory of the specified path.
3765 </summary>
3766 <param name="path">The path from which to obtain root directory information.</param>
3767 <returns>
3768 A <see cref="T:System.String"/> containing the root directory of
3769 <paramref name="path"/>, such as "C:\", or an empty <see cref="T:System.String"/>
3770 if <paramref name="path"/> does not contain root directory information.
3771 </returns>
3772 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, or is empty.</exception>
3773 </member>
3774 <member name="M:NAnt.Core.Functions.PathFunctions.GetTempFileName">
3775 <summary>
3776 Returns a uniquely named zero-byte temporary file on disk and returns the full path to that file.
3777 </summary>
3778 <returns>
3779 A <see cref="T:System.String"/> containing the name of the temporary file.
3780 </returns>
3781 </member>
3782 <member name="M:NAnt.Core.Functions.PathFunctions.GetTempPath">
3783 <summary>
3784 Gets the path to the temporary directory.
3785 </summary>
3786 <returns>
3787 A <see cref="T:System.String"/> containing the path information of a
3788 temporary directory.
3789 </returns>
3790 </member>
3791 <member name="M:NAnt.Core.Functions.PathFunctions.HasExtension(System.String)">
3792 <summary>
3793 Determines whether a path string includes an extension.
3794 </summary>
3795 <param name="path">The path to search for an extension.</param>
3796 <returns>
3797 <see langword="true"/>. if the characters that follow the last
3798 directory separator or volume separator in the <paramref name="path"/>
3799 include a period (.) followed by one or more characters;
3800 otherwise, <see langword="false"/>.
3801 </returns>
3802 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3803 </member>
3804 <member name="M:NAnt.Core.Functions.PathFunctions.IsPathRooted(System.String)">
3805 <summary>
3806 Determines whether a path string is absolute.
3807 </summary>
3808 <param name="path">The path to test.</param>
3809 <returns>
3810 <see langword="true"/> if path contains an absolute <paramref name="path"/>;
3811 otherwise, <see langword="false"/>.
3812 </returns>
3813 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
3814 </member>
3815 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetVariable(System.String,System.String)">
3816 <summary>
3817 Gets the value of a variable for the specified package.
3818 </summary>
3819 <param name="package">The package for which the variable should be retrieved.</param>
3820 <param name="name">The name of the variable.</param>
3821 <returns>
3822 The value of variable <paramref name="name"/> for the specified
3823 package.
3824 </returns>
3825 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3826 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
3827 </member>
3828 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetLinkFlags(System.String)">
3829 <summary>
3830 Gets the link flags required to compile the package, including all
3831 its dependencies.
3832 </summary>
3833 <param name="package">The package for which the link flags should be retrieved.</param>
3834 <returns>
3835 The link flags required to compile the package.
3836 </returns>
3837 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3838 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
3839 </member>
3840 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetCompileFlags(System.String)">
3841 <summary>
3842 Gets the compile flags required to compile the package, including all
3843 its dependencies.
3844 </summary>
3845 <param name="package">The package for which the compile flags should be retrieved.</param>
3846 <returns>
3847 The pre-processor and compile flags required to compile the package.
3848 </returns>
3849 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3850 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
3851 </member>
3852 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetModVersion(System.String)">
3853 <summary>
3854 Determines the version of the given package.
3855 </summary>
3856 <param name="package">The package to get the version of.</param>
3857 <returns>
3858 The version of the given package.
3859 </returns>
3860 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3861 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
3862 </member>
3863 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsAtLeastVersion(System.String,System.String)">
3864 <summary>
3865 Determines whether the given package is at least version
3866 <paramref name="version"/>.
3867 </summary>
3868 <param name="package">The package to check.</param>
3869 <param name="version">The version the package should at least have.</param>
3870 <returns>
3871 <see langword="true"/> if the given package is at least version
3872 <paramref name="version"/>; otherwise, <see langword="false"/>.
3873 </returns>
3874 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3875 </member>
3876 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsExactVersion(System.String,System.String)">
3877 <summary>
3878 Determines whether the given package is exactly version
3879 <paramref name="version"/>.
3880 </summary>
3881 <param name="package">The package to check.</param>
3882 <param name="version">The version the package should have.</param>
3883 <returns>
3884 <see langword="true"/> if the given package is exactly version
3885 <paramref name="version"/>; otherwise, <see langword="false"/>.
3886 </returns>
3887 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3888 </member>
3889 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsMaxVersion(System.String,System.String)">
3890 <summary>
3891 Determines whether the given package is at no newer than version
3892 <paramref name="version"/>.
3893 </summary>
3894 <param name="package">The package to check.</param>
3895 <param name="version">The version the package should maximum have.</param>
3896 <returns>
3897 <see langword="true"/> if the given package is at no newer than
3898 version <paramref name="version"/>; otherwise, <see langword="false"/>.
3899 </returns>
3900 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3901 </member>
3902 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsBetweenVersion(System.String,System.String,System.String)">
3903 <summary>
3904 Determines whether the given package is between two versions.
3905 </summary>
3906 <param name="package">The package to check.</param>
3907 <param name="minVersion">The version the package should at least have.</param>
3908 <param name="maxVersion">The version the package should maximum have.</param>
3909 <returns>
3910 <see langword="true"/> if the given package is between <paramref name="minVersion"/>
3911 and <paramref name="maxVersion"/>; otherwise, <see langword="false"/>.
3912 </returns>
3913 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3914 </member>
3915 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.Exists(System.String)">
3916 <summary>
3917 Determines whether the given package exists.
3918 </summary>
3919 <param name="package">The package to check.</param>
3920 <returns>
3921 <see langword="true"/> if the package exists; otherwise,
3922 <see langword="false"/>.
3923 </returns>
3924 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
3925 </member>
3926 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigBool(NAnt.Core.Types.Argument[])">
3927 <summary>
3928 Runs pkg-config with the specified arguments and returns a
3929 <see cref="T:System.Boolean"/> based on the exit code.
3930 </summary>
3931 <param name="args">The arguments to pass to pkg-config.</param>
3932 <returns>
3933 <see langword="true"/> if pkg-config exited with exit code 0;
3934 otherwise, <see langword="false"/>
3935 </returns>
3936 </member>
3937 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigString(NAnt.Core.Types.Argument[])">
3938 <summary>
3939 Runs pkg-config with the specified arguments and returns the result
3940 as a <see cref="T:System.String"/>.
3941 </summary>
3942 <param name="args">The arguments to pass to pkg-config.</param>
3943 <returns>
3944 The result of running pkg-config with the specified arguments.
3945 </returns>
3946 </member>
3947 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetTask(System.IO.Stream)">
3948 <summary>
3949 Factory method to return a new instance of ExecTask
3950 </summary>
3951 <param name="stream"></param>
3952 <returns></returns>
3953 </member>
3954 <member name="M:NAnt.Core.Functions.StringFunctions.GetLength(System.String)">
3955 <summary>
3956 Returns the length of the specified string.
3957 </summary>
3958 <param name="s">input string</param>
3959 <returns>
3960 The string's length.
3961 </returns>
3962 <example>
3963 <code>string::get-length('foo') ==> 3</code>
3964 </example>
3965 <example>
3966 <code>string::get-length('') ==> 0</code>
3967 </example>
3968 </member>
3969 <member name="M:NAnt.Core.Functions.StringFunctions.Substring(System.String,System.Int32,System.Int32)">
3970 <summary>
3971 Returns a substring of the specified string.
3972 </summary>
3973 <param name="str">input string</param>
3974 <param name="startIndex">position of the start of the substring</param>
3975 <param name="length">the length of the substring</param>
3976 <returns>
3977 <para>
3978 If the <paramref name="length"/> is greater than zero, the
3979 function returns a substring starting at character position
3980 <paramref name="startIndex"/> with a length of <paramref name="length"/>
3981 characters.
3982 </para>
3983 <para>
3984 If the <paramref name="length"/> is equal to zero, the function
3985 returns an empty string.
3986 </para>
3987 </returns>
3988 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> or <paramref name="length"/> is less than zero.</exception>
3989 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> is greater than the length of <paramref name="str"/>.</exception>
3990 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> plus <paramref name="length"/> indicates a position not within <paramref name="str"/>.</exception>
3991 <example>
3992 <code>string::substring('testing string', 0, 4) ==> 'test'</code>
3993 </example>
3994 <example>
3995 <code>string::substring('testing string', 8, 3) ==> 'str'</code>
3996 </example>
3997 <example>
3998 <code>string::substring('testing string', 8, 0) ==> ''</code>
3999 </example>
4000 <example>
4001 <code>string::substring('testing string', -1, 5) ==> ERROR</code>
4002 </example>
4003 <example>
4004 <code>string::substring('testing string', 8, -1) ==> ERROR</code>
4005 </example>
4006 <example>
4007 <code>string::substring('testing string', 5, 17) ==> ERROR</code>
4008 </example>
4009 </member>
4010 <member name="M:NAnt.Core.Functions.StringFunctions.StartsWith(System.String,System.String)">
4011 <summary>
4012 Tests whether the specified string starts with the specified prefix
4013 string.
4014 </summary>
4015 <param name="s1">test string</param>
4016 <param name="s2">prefix string</param>
4017 <returns>
4018 <see langword="true" /> when <paramref name="s2" /> is a prefix for
4019 the string <paramref name="s1" />. Meaning, the characters at the
4020 beginning of <paramref name="s1" /> are identical to
4021 <paramref name="s2" />; otherwise, <see langword="false" />.
4022 </returns>
4023 <remarks>
4024 This function performs a case-sensitive word search using the
4025 invariant culture.
4026 </remarks>
4027 <example>
4028 <code>string::starts-with('testing string', 'test') ==> true</code>
4029 </example>
4030 <example>
4031 <code>string::starts-with('testing string', 'testing') ==> true</code>
4032 </example>
4033 <example>
4034 <code>string::starts-with('testing string', 'string') ==> false</code>
4035 </example>
4036 <example>
4037 <code>string::starts-with('test', 'testing string') ==> false</code>
4038 </example>
4039 </member>
4040 <member name="M:NAnt.Core.Functions.StringFunctions.EndsWith(System.String,System.String)">
4041 <summary>
4042 Tests whether the specified string ends with the specified suffix
4043 string.
4044 </summary>
4045 <param name="s1">test string</param>
4046 <param name="s2">suffix string</param>
4047 <returns>
4048 <see langword="true" /> when <paramref name="s2" /> is a suffix for
4049 the string <paramref name="s1" />. Meaning, the characters at the
4050 end of <paramref name="s1" /> are identical to
4051 <paramref name="s2" />; otherwise, <see langword="false" />.
4052 </returns>
4053 <remarks>
4054 This function performs a case-sensitive word search using the
4055 invariant culture.
4056 </remarks>
4057 <example>
4058 <code>string::ends-with('testing string', 'string') ==> true</code>
4059 </example>
4060 <example>
4061 <code>string::ends-with('testing string', '') ==> true</code>
4062 </example>
4063 <example>
4064 <code>string::ends-with('testing string', 'bring') ==> false</code>
4065 </example>
4066 <example>
4067 <code>string::ends-with('string', 'testing string') ==> false</code>
4068 </example>
4069 </member>
4070 <member name="M:NAnt.Core.Functions.StringFunctions.ToLower(System.String)">
4071 <summary>
4072 Returns the specified string converted to lowercase.
4073 </summary>
4074 <param name="s">input string</param>
4075 <returns>
4076 The string <paramref name="s" /> in lowercase.
4077 </returns>
4078 <remarks>
4079 The casing rules of the invariant culture are used to convert the
4080 <paramref name="s" /> to lowercase.
4081 </remarks>
4082 <example>
4083 <code>string::to-lower('testing string') ==> 'testing string'</code>
4084 </example>
4085 <example>
4086 <code>string::to-lower('Testing String') ==> 'testing string'</code>
4087 </example>
4088 <example>
4089 <code>string::to-lower('Test 123') ==> 'test 123'</code>
4090 </example>
4091 </member>
4092 <member name="M:NAnt.Core.Functions.StringFunctions.ToUpper(System.String)">
4093 <summary>
4094 Returns the specified string converted to uppercase.
4095 </summary>
4096 <param name="s">input string</param>
4097 <returns>
4098 The string <paramref name="s" /> in uppercase.
4099 </returns>
4100 <remarks>
4101 The casing rules of the invariant culture are used to convert the
4102 <paramref name="s" /> to uppercase.
4103 </remarks>
4104 <example>
4105 <code>string::to-upper('testing string') ==> 'TESTING STRING'</code>
4106 </example>
4107 <example>
4108 <code>string::to-upper('Testing String') ==> 'TESTING STRING'</code>
4109 </example>
4110 <example>
4111 <code>string::to-upper('Test 123') ==> 'TEST 123'</code>
4112 </example>
4113 </member>
4114 <member name="M:NAnt.Core.Functions.StringFunctions.Replace(System.String,System.String,System.String)">
4115 <summary>
4116 Returns a string corresponding to the replacement of a given string
4117 with another in the specified string.
4118 </summary>
4119 <param name="str">input string</param>
4120 <param name="oldValue">A <see cref="T:System.String"/> to be replaced.</param>
4121 <param name="newValue">A <see cref="T:System.String"/> to replace all occurrences of <paramref name="oldValue"/>.</param>
4122 <returns>
4123 A <see cref="T:System.String"/> equivalent to <paramref name="str"/> but
4124 with all instances of <paramref name="oldValue"/> replaced with
4125 <paramref name="newValue"/>.
4126 </returns>
4127 <exception cref="T:System.ArgumentException"><paramref name="oldValue"/> is an empty string.</exception>
4128 <remarks>
4129 This function performs a word (case-sensitive and culture-sensitive)
4130 search to find <paramref name="oldValue"/>.
4131 </remarks>
4132 <example>
4133 <code>string::replace('testing string', 'test', 'winn') ==> 'winning string'</code>
4134 </example>
4135 <example>
4136 <code>string::replace('testing string', 'foo', 'winn') ==> 'testing string'</code>
4137 </example>
4138 <example>
4139 <code>string::replace('testing string', 'ing', '') ==> 'test str'</code>
4140 </example>
4141 <example>
4142 <code>string::replace('banana', 'ana', 'ana') ==> 'banana'</code>
4143 </example>
4144 </member>
4145 <member name="M:NAnt.Core.Functions.StringFunctions.Contains(System.String,System.String)">
4146 <summary>
4147 Tests whether the specified string contains the given search string.
4148 </summary>
4149 <param name="source">The string to search.</param>
4150 <param name="value">The string to locate within <paramref name="source" />.</param>
4151 <returns>
4152 <see langword="true" /> if <paramref name="value" /> is found in
4153 <paramref name="source" />; otherwise, <see langword="false" />.
4154 </returns>
4155 <remarks>
4156 This function performs a case-sensitive word search using the
4157 invariant culture.
4158 </remarks>
4159 <example>
4160 <code>string::contains('testing string', 'test') ==> true</code>
4161 </example>
4162 <example>
4163 <code>string::contains('testing string', '') ==> true</code>
4164 </example>
4165 <example>
4166 <code>string::contains('testing string', 'Test') ==> false</code>
4167 </example>
4168 <example>
4169 <code>string::contains('testing string', 'foo') ==> false</code>
4170 </example>
4171 </member>
4172 <member name="M:NAnt.Core.Functions.StringFunctions.IndexOf(System.String,System.String)">
4173 <summary>
4174 Returns the position of the first occurrence in the specified string
4175 of the given search string.
4176 </summary>
4177 <param name="source">The string to search.</param>
4178 <param name="value">The string to locate within <paramref name="source" />.</param>
4179 <returns>
4180 <para>
4181 The lowest-index position of <paramref name="value" /> in
4182 <paramref name="source" /> if it is found, or -1 if <paramref name="source" />
4183 does not contain <paramref name="value" />.
4184 </para>
4185 <para>
4186 If <paramref name="value" /> is an empty string, the return value
4187 will always be <c>0</c>.
4188 </para>
4189 </returns>
4190 <remarks>
4191 This function performs a case-sensitive word search using the
4192 invariant culture.
4193 </remarks>
4194 <example>
4195 <code>string::index-of('testing string', 'test') ==> 0</code>
4196 </example>
4197 <example>
4198 <code>string::index-of('testing string', '') ==> 0</code>
4199 </example>
4200 <example>
4201 <code>string::index-of('testing string', 'Test') ==> -1</code>
4202 </example>
4203 <example>
4204 <code>string::index-of('testing string', 'ing') ==> 4</code>
4205 </example>
4206 </member>
4207 <member name="M:NAnt.Core.Functions.StringFunctions.LastIndexOf(System.String,System.String)">
4208 <summary>
4209 Returns the position of the last occurrence in the specified string
4210 of the given search string.
4211 </summary>
4212 <param name="source">The string to search.</param>
4213 <param name="value">The string to locate within <paramref name="source" />.</param>
4214 <returns>
4215 <para>
4216 The highest-index position of <paramref name="value" /> in
4217 <paramref name="source" /> if it is found, or -1 if <paramref name="source" />
4218 does not contain <paramref name="value" />.
4219 </para>
4220 <para>
4221 If <paramref name="value" /> is an empty string, the return value
4222 is the last index position in <paramref name="source" />.
4223 </para>
4224 </returns>
4225 <remarks>
4226 This function performs a case-sensitive word search using the
4227 invariant culture.
4228 </remarks>
4229 <example>
4230 <code>string::last-index-of('testing string', 'test') ==> 0</code>
4231 </example>
4232 <example>
4233 <code>string::last-index-of('testing string', '') ==> 13</code>
4234 </example>
4235 <example>
4236 <code>string::last-index-of('testing string', 'Test') ==> -1</code>
4237 </example>
4238 <example>
4239 <code>string::last-index-of('testing string', 'ing') ==> 11</code>
4240 </example>
4241 </member>
4242 <member name="M:NAnt.Core.Functions.StringFunctions.PadLeft(System.String,System.Int32,System.String)">
4243 <summary>
4244 Returns the given string left-padded to the given length.
4245 </summary>
4246 <param name="s">The <see cref="T:System.String"/> that needs to be left-padded.</param>
4247 <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param>
4248 <param name="paddingChar">A Unicode padding character.</param>
4249 <returns>
4250 If the length of <paramref name="s"/> is at least
4251 <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical
4252 to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/>
4253 will be padded on the left with as many <paramref name="paddingChar"/>
4254 characters as needed to create a length of <paramref name="totalWidth"/>.
4255 </returns>
4256 <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception>
4257 <remarks>
4258 Note that only the first character of <paramref name="paddingChar"/>
4259 will be used when padding the result.
4260 </remarks>
4261 <example>
4262 <code>string::pad-left('test', 10, ' ') ==> ' test'</code>
4263 </example>
4264 <example>
4265 <code>string::pad-left('test', 10, 'test') ==> 'tttttttest'</code>
4266 </example>
4267 <example>
4268 <code>string::pad-left('test', 3, ' ') ==> 'test'</code>
4269 </example>
4270 <example>
4271 <code>string::pad-left('test', -4, ' ') ==> ERROR</code>
4272 </example>
4273 </member>
4274 <member name="M:NAnt.Core.Functions.StringFunctions.PadRight(System.String,System.Int32,System.String)">
4275 <summary>
4276 Returns the given string right-padded to the given length.
4277 </summary>
4278 <param name="s">The <see cref="T:System.String"/> that needs to be right-padded.</param>
4279 <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param>
4280 <param name="paddingChar">A Unicode padding character.</param>
4281 <returns>
4282 If the length of <paramref name="s"/> is at least
4283 <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical
4284 to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/>
4285 will be padded on the right with as many <paramref name="paddingChar"/>
4286 characters as needed to create a length of <paramref name="totalWidth"/>.
4287 </returns>
4288 <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception>
4289 <remarks>
4290 Note that only the first character of <paramref name="paddingChar"/>
4291 will be used when padding the result.
4292 </remarks>
4293 <example>
4294 <code>string::pad-right('test', 10, ' ') ==> 'test '</code>
4295 </example>
4296 <example>
4297 <code>string::pad-right('test', 10, 'abcd') ==> 'testaaaaaa'</code>
4298 </example>
4299 <example>
4300 <code>string::pad-right('test', 3, ' ') ==> 'test'</code>
4301 </example>
4302 <example>
4303 <code>string::pad-right('test', -3, ' ') ==> ERROR</code>
4304 </example>
4305 </member>
4306 <member name="M:NAnt.Core.Functions.StringFunctions.Trim(System.String)">
4307 <summary>
4308 Returns the given string trimmed of whitespace.
4309 </summary>
4310 <param name="s">input string</param>
4311 <returns>
4312 The string <paramref name="s" /> with any leading or trailing
4313 white space characters removed.
4314 </returns>
4315 <example>
4316 <code>string::trim(' test ') ==> 'test'</code>
4317 </example>
4318 <example>
4319 <code>string::trim('\t\tfoo \r\n') ==> 'foo'</code>
4320 </example>
4321 </member>
4322 <member name="M:NAnt.Core.Functions.StringFunctions.TrimStart(System.String)">
4323 <summary>
4324 Returns the given string trimmed of leading whitespace.
4325 </summary>
4326 <param name="s">input string</param>
4327 <returns>
4328 The string <paramref name="s" /> with any leading
4329 whites pace characters removed.
4330 </returns>
4331 <example>
4332 <code>string::trim-start(' test ') ==> 'test '</code>
4333 </example>
4334 <example>
4335 <code>string::trim-start('\t\tfoo \r\n') ==> 'foo \r\n'</code>
4336 </example>
4337 </member>
4338 <member name="M:NAnt.Core.Functions.StringFunctions.TrimEnd(System.String)">
4339 <summary>
4340 Returns the given string trimmed of trailing whitespace.
4341 </summary>
4342 <param name="s">input string</param>
4343 <returns>
4344 The string <paramref name="s" /> with any trailing
4345 white space characters removed.
4346 </returns>
4347 <example>
4348 <code>string::trim-end(' test ') ==> ' test'</code>
4349 </example>
4350 <example>
4351 <code>string::trim-end('\t\tfoo \r\n') ==> '\t\tfoo'</code>
4352 </example>
4353 </member>
4354 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalDays(System.TimeSpan)">
4355 <summary>
4356 Returns the total number of days represented by the specified
4357 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional days.
4358 </summary>
4359 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4360 <returns>
4361 The total number of days represented by the given <see cref="T:System.TimeSpan"/>.
4362 </returns>
4363 </member>
4364 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalHours(System.TimeSpan)">
4365 <summary>
4366 Returns the total number of hours represented by the specified
4367 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional hours.
4368 </summary>
4369 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4370 <returns>
4371 The total number of hours represented by the given <see cref="T:System.TimeSpan"/>.
4372 </returns>
4373 </member>
4374 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMinutes(System.TimeSpan)">
4375 <summary>
4376 Returns the total number of minutes represented by the specified
4377 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional minutes.
4378 </summary>
4379 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4380 <returns>
4381 The total number of minutes represented by the given <see cref="T:System.TimeSpan"/>.
4382 </returns>
4383 </member>
4384 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalSeconds(System.TimeSpan)">
4385 <summary>
4386 Returns the total number of seconds represented by the specified
4387 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional seconds.
4388 </summary>
4389 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4390 <returns>
4391 The total number of seconds represented by the given <see cref="T:System.TimeSpan"/>.
4392 </returns>
4393 </member>
4394 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMilliseconds(System.TimeSpan)">
4395 <summary>
4396 Returns the total number of milliseconds represented by the specified
4397 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional milliseconds.
4398 </summary>
4399 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4400 <returns>
4401 The total number of milliseconds represented by the given
4402 <see cref="T:System.TimeSpan"/>.
4403 </returns>
4404 </member>
4405 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetDays(System.TimeSpan)">
4406 <summary>
4407 Returns the number of whole days represented by the specified
4408 <see cref="T:System.TimeSpan"/>.
4409 </summary>
4410 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4411 <returns>
4412 The number of whole days represented by the given
4413 <see cref="T:System.TimeSpan"/>.
4414 </returns>
4415 <example>
4416 <para>
4417 Remove all files that have not been modified in the last 7 days from directory "binaries".</para>
4418 <code>
4419 <![CDATA[
4420 <foreach item="File" in="binaries" property="filename">
4421 <if test="${timespan::get-days(datetime::now() - file::get-last-write-time(filename)) >= 7}">
4422 <delete file="${filename}" />
4423 </if>
4424 </foreach>
4425 ]]>
4426 </code>
4427 </example>
4428 </member>
4429 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetHours(System.TimeSpan)">
4430 <summary>
4431 Returns the number of whole hours represented by the specified
4432 <see cref="T:System.TimeSpan"/>.
4433 </summary>
4434 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4435 <returns>
4436 The number of whole hours represented by the given
4437 <see cref="T:System.TimeSpan"/>.
4438 </returns>
4439 </member>
4440 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMinutes(System.TimeSpan)">
4441 <summary>
4442 Returns the number of whole minutes represented by the specified
4443 <see cref="T:System.TimeSpan"/>.
4444 </summary>
4445 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4446 <returns>
4447 The number of whole minutes represented by the given
4448 <see cref="T:System.TimeSpan"/>.
4449 </returns>
4450 </member>
4451 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetSeconds(System.TimeSpan)">
4452 <summary>
4453 Returns the number of whole seconds represented by the specified
4454 <see cref="T:System.TimeSpan"/>.
4455 </summary>
4456 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4457 <returns>
4458 The number of whole seconds represented by the given
4459 <see cref="T:System.TimeSpan"/>.
4460 </returns>
4461 </member>
4462 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMilliseconds(System.TimeSpan)">
4463 <summary>
4464 Returns the number of whole milliseconds represented by the specified
4465 <see cref="T:System.TimeSpan"/>.
4466 </summary>
4467 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4468 <returns>
4469 The number of whole milliseconds represented by the given
4470 <see cref="T:System.TimeSpan"/>.
4471 </returns>
4472 </member>
4473 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTicks(System.TimeSpan)">
4474 <summary>
4475 Returns the number of ticks contained in the specified
4476 <see cref="T:System.TimeSpan"/>.
4477 </summary>
4478 <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
4479 <returns>
4480 The number of ticks contained in the given <see cref="T:System.TimeSpan"/>.
4481 </returns>
4482 </member>
4483 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromDays(System.Double)">
4484 <summary>
4485 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4486 of days, where the specification is accurate to the nearest millisecond.
4487 </summary>
4488 <param name="value">A number of days, accurate to the nearest millisecond.</param>
4489 <returns>
4490 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4491 </returns>
4492 </member>
4493 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromHours(System.Double)">
4494 <summary>
4495 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4496 of hours, where the specification is accurate to the nearest
4497 millisecond.
4498 </summary>
4499 <param name="value">A number of hours, accurate to the nearest millisecond.</param>
4500 <returns>
4501 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4502 </returns>
4503 </member>
4504 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMinutes(System.Double)">
4505 <summary>
4506 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4507 of minutes, where the specification is accurate to the nearest
4508 millisecond.
4509 </summary>
4510 <param name="value">A number of minutes, accurate to the nearest millisecond.</param>
4511 <returns>
4512 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4513 </returns>
4514 </member>
4515 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromSeconds(System.Double)">
4516 <summary>
4517 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4518 of seconds, where the specification is accurate to the nearest
4519 millisecond.
4520 </summary>
4521 <param name="value">A number of seconds, accurate to the nearest millisecond.</param>
4522 <returns>
4523 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4524 </returns>
4525 </member>
4526 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMilliseconds(System.Double)">
4527 <summary>
4528 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
4529 of milliseconds.
4530 </summary>
4531 <param name="value">A number of milliseconds.</param>
4532 <returns>
4533 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4534 </returns>
4535 </member>
4536 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromTicks(System.Int64)">
4537 <summary>
4538 Returns a <see cref="T:System.TimeSpan"/> that represents a specified time,
4539 where the specification is in units of ticks.
4540 </summary>
4541 <param name="value">A number of ticks that represent a time.</param>
4542 <returns>
4543 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
4544 </returns>
4545 </member>
4546 <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.Parse(System.String)">
4547 <summary>
4548 Constructs a <see cref="T:System.TimeSpan"/> from a time indicated by a
4549 specified string.
4550 </summary>
4551 <param name="s">A string.</param>
4552 <returns>
4553 A <see cref="T:System.TimeSpan"/> that corresponds to <paramref name="s"/>.
4554 </returns>
4555 <exception cref="T:System.FormatException"><paramref name="s"/> has an invalid format.</exception>
4556 <exception cref="T:System.OverflowException">At least one of the hours, minutes, or seconds components is outside its valid range.</exception>
4557 </member>
4558 <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.ToString(System.TimeSpan)">
4559 <summary>
4560 Converts the specified <see cref="T:System.TimeSpan"/> to its equivalent
4561 string representation.
4562 </summary>
4563 <param name="value">A <see cref="T:System.TimeSpan"/> to convert.</param>
4564 <returns>
4565 The string representation of <paramref name="value"/>. The format
4566 of the return value is of the form: [-][d.]hh:mm:ss[.ff].
4567 </returns>
4568 </member>
4569 <member name="M:NAnt.Core.Functions.VersionFunctions.GetMajor(System.Version)">
4570 <summary>
4571 Gets the value of the major component of a given version.
4572 </summary>
4573 <param name="version">A version.</param>
4574 <returns>
4575 The major version number.
4576 </returns>
4577 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4578 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4579 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4580 </member>
4581 <member name="M:NAnt.Core.Functions.VersionFunctions.GetMinor(System.Version)">
4582 <summary>
4583 Gets the value of the minor component of a given version.
4584 </summary>
4585 <param name="version">A version.</param>
4586 <returns>
4587 The minor version number.
4588 </returns>
4589 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4590 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4591 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4592 </member>
4593 <member name="M:NAnt.Core.Functions.VersionFunctions.GetBuild(System.Version)">
4594 <summary>
4595 Gets the value of the build component of a given version.
4596 </summary>
4597 <param name="version">A version.</param>
4598 <returns>
4599 The build number, or -1 if the build number is undefined.
4600 </returns>
4601 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4602 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4603 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4604 </member>
4605 <member name="M:NAnt.Core.Functions.VersionFunctions.GetRevision(System.Version)">
4606 <summary>
4607 Gets the value of the revision component of a given version.
4608 </summary>
4609 <param name="version">A version.</param>
4610 <returns>
4611 The revision number, or -1 if the revision number is undefined.
4612 </returns>
4613 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4614 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4615 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4616 </member>
4617 <member name="M:NAnt.Core.Functions.VersionConversionFunctions.Parse(System.String)">
4618 <summary>
4619 Converts the specified string representation of a version to
4620 its <see cref="T:System.Version"/> equivalent.
4621 </summary>
4622 <param name="version">A string containing the major, minor, build, and revision numbers, where each number is delimited with a period character ('.').</param>
4623 <returns>
4624 A <see cref="T:System.Version"/> instance representing the specified
4625 <see cref="T:System.String"/>.
4626 </returns>
4627 <exception cref="T:System.ArgumentException"><paramref name="version"/> has fewer than two components or more than four components.</exception>
4628 <exception cref="T:System.ArgumentOutOfRangeException">A major, minor, build, or revision component is less than zero.</exception>
4629 <exception cref="T:System.FormatException">At least one component of <paramref name="version"/> does not parse to a decimal integer.</exception>
4630 </member>
4631 <member name="M:NAnt.Core.Functions.VersionConversionFunctions.ToString(System.Version)">
4632 <summary>
4633 Converts the specified <see cref="T:System.Version"/> to its equivalent
4634 string representation.
4635 </summary>
4636 <param name="value">A <see cref="T:System.Version"/> to convert.</param>
4637 <returns>
4638 The string representation of the values of the major, minor, build,
4639 and revision components of the specified <see cref="T:System.Version"/>.
4640 </returns>
4641 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
4642 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
4643 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
4644 </member>
4645 <member name="T:NAnt.Core.Tasks.AttribTask">
4646 <summary>
4647 Changes the file attributes of a file or set of files and directories.
4648 </summary>
4649 <remarks>
4650 <para>
4651 <see cref="T:NAnt.Core.Tasks.AttribTask"/> does not have the concept of turning
4652 attributes off. Instead you specify all the attributes that you want
4653 turned on and the rest are turned off by default.
4654 </para>
4655 <para>
4656 Refer to the <see cref="T:System.IO.FileAttributes"/> enumeration in the .NET SDK
4657 for more information about file attributes.
4658 </para>
4659 </remarks>
4660 <example>
4661 <para>
4662 Set the <c>read-only</c> file attribute for the specified file in
4663 the project directory.
4664 </para>
4665 <code>
4666 <![CDATA[
4667 <attrib file="myfile.txt" readonly="true" />
4668 ]]>
4669 </code>
4670 </example>
4671 <example>
4672 <para>
4673 Set the <c>normal</c> file attribute for the specified file.
4674 </para>
4675 <code>
4676 <![CDATA[
4677 <attrib file="myfile.txt" normal="true" />
4678 ]]>
4679 </code>
4680 </example>
4681 <example>
4682 <para>
4683 Set the <c>normal</c> file attribute for all executable files in
4684 the current project directory and sub-directories.
4685 </para>
4686 <code>
4687 <![CDATA[
4688 <attrib normal="true">
4689 <fileset>
4690 <include name="**/*.exe" />
4691 <include name="bin" />
4692 </fileset>
4693 </attrib>
4694 ]]>
4695 </code>
4696 </example>
4697 </member>
4698 <member name="T:NAnt.Core.Task">
4699 <summary>
4700 Provides the abstract base class for tasks.
4701 </summary>
4702 <remarks>
4703 A task is a piece of code that can be executed.
4704 </remarks>
4705 </member>
4706 <member name="M:NAnt.Core.Task.Execute">
4707 <summary>
4708 Executes the task unless it is skipped.
4709 </summary>
4710 </member>
4711 <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String)">
4712 <summary>
4713 Logs a message with the given priority.
4714 </summary>
4715 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
4716 <param name="message">The message to be logged.</param>
4717 <remarks>
4718 <para>
4719 The actual logging is delegated to the project.
4720 </para>
4721 <para>
4722 If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a
4723 message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the
4724 priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>
4725 when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>.
4726 </para>
4727 <para>
4728 This will allow individual tasks to run in verbose mode while
4729 the build log itself is still configured with threshold
4730 <see cref="F:NAnt.Core.Level.Info"/>.
4731 </para>
4732 <para>
4733 The threshold of the project is not taken into account to determine
4734 whether a message should be passed to the logging infrastructure,
4735 as build listeners might be interested in receiving all messages.
4736 </para>
4737 </remarks>
4738 </member>
4739 <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String,System.Object[])">
4740 <summary>
4741 Logs a formatted message with the given priority.
4742 </summary>
4743 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
4744 <param name="message">The message to log, containing zero or more format items.</param>
4745 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
4746 <remarks>
4747 <para>
4748 The actual logging is delegated to the project.
4749 </para>
4750 <para>
4751 If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a
4752 message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the
4753 priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>.
4754 when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>.
4755 </para>
4756 <para>
4757 This will allow individual tasks to run in verbose mode while
4758 the build log itself is still configured with threshold
4759 <see cref="F:NAnt.Core.Level.Info"/>.
4760 </para>
4761 </remarks>
4762 </member>
4763 <member name="M:NAnt.Core.Task.IsLogEnabledFor(NAnt.Core.Level)">
4764 <summary>
4765 Determines whether build output is enabled for the given
4766 <see cref="T:NAnt.Core.Level"/>.
4767 </summary>
4768 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to check.</param>
4769 <returns>
4770 <see langword="true"/> if messages with the given <see cref="T:NAnt.Core.Level"/>
4771 should be passed on to the logging infrastructure; otherwise,
4772 <see langword="false"/>.
4773 </returns>
4774 <remarks>
4775 The threshold of the project is not taken into account to determine
4776 whether a message should be passed to the logging infrastructure,
4777 as build listeners might be interested in receiving all messages.
4778 </remarks>
4779 </member>
4780 <member name="M:NAnt.Core.Task.InitializeTaskConfiguration">
4781 <summary>
4782 Initializes the configuration of the task using configuration
4783 settings retrieved from the NAnt configuration file.
4784 </summary>
4785 <remarks>
4786 TO-DO : Remove this temporary hack when a permanent solution is
4787 available for loading the default values from the configuration
4788 file if a build element is constructed from code.
4789 </remarks>
4790 </member>
4791 <member name="M:NAnt.Core.Task.Initialize">
4792 <summary>Initializes the task.</summary>
4793 </member>
4794 <member name="M:NAnt.Core.Task.InitializeTask(System.Xml.XmlNode)">
4795 <summary>Initializes the task.</summary>
4796 </member>
4797 <member name="M:NAnt.Core.Task.ExecuteTask">
4798 <summary>Executes the task.</summary>
4799 </member>
4800 <member name="M:NAnt.Core.Task.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)">
4801 <summary>
4802 Locates the XML node for the specified attribute in either the
4803 configuration section of the extension assembly or the.project.
4804 </summary>
4805 <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param>
4806 <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>
4807 <returns>
4808 The XML configuration node for the specified attribute, or
4809 <see langword="null" /> if no corresponding XML node could be
4810 located.
4811 </returns>
4812 <remarks>
4813 If there's a valid current framework, the configuration section for
4814 that framework will first be searched. If no corresponding
4815 configuration node can be located in that section, the framework-neutral
4816 section of the project configuration node will be searched.
4817 </remarks>
4818 </member>
4819 <member name="P:NAnt.Core.Task.FailOnError">
4820 <summary>
4821 Determines if task failure stops the build, or is just reported.
4822 The default is <see langword="true" />.
4823 </summary>
4824 </member>
4825 <member name="P:NAnt.Core.Task.Verbose">
4826 <summary>
4827 Determines whether the task should report detailed build log messages.
4828 The default is <see langword="false" />.
4829 </summary>
4830 </member>
4831 <member name="P:NAnt.Core.Task.IfDefined">
4832 <summary>
4833 If <see langword="true" /> then the task will be executed; otherwise,
4834 skipped. The default is <see langword="true" />.
4835 </summary>
4836 </member>
4837 <member name="P:NAnt.Core.Task.UnlessDefined">
4838 <summary>
4839 Opposite of <see cref="P:NAnt.Core.Task.IfDefined"/>. If <see langword="false"/>
4840 then the task will be executed; otherwise, skipped. The default is
4841 <see langword="false"/>.
4842 </summary>
4843 </member>
4844 <member name="P:NAnt.Core.Task.Name">
4845 <summary>
4846 The name of the task.
4847 </summary>
4848 </member>
4849 <member name="P:NAnt.Core.Task.LogPrefix">
4850 <summary>
4851 The prefix used when sending messages to the log.
4852 </summary>
4853 </member>
4854 <member name="P:NAnt.Core.Task.Threshold">
4855 <summary>
4856 Gets or sets the log threshold for this <see cref="T:NAnt.Core.Task"/>. By
4857 default the threshold of a task is <see cref="F:NAnt.Core.Level.Debug"/>,
4858 causing no messages to be filtered in the task itself.
4859 </summary>
4860 <value>
4861 The log threshold level for this <see cref="T:NAnt.Core.Task"/>.
4862 </value>
4863 <remarks>
4864 When the threshold of a <see cref="T:NAnt.Core.Task"/> is higher than the
4865 threshold of the <see cref="T:NAnt.Core.Project"/>, then all messages will
4866 still be delivered to the build listeners.
4867 </remarks>
4868 </member>
4869 <member name="P:NAnt.Core.Task.TaskBuilder">
4870 <summary>
4871 Returns the TaskBuilder used to construct an instance of this
4872 <see cref="T:NAnt.Core.Task"/>.
4873 </summary>
4874 </member>
4875 <member name="P:NAnt.Core.Tasks.AttribTask.File">
4876 <summary>
4877 The name of the file which will have its attributes set. This is
4878 provided as an alternate to using the task's fileset.
4879 </summary>
4880 </member>
4881 <member name="P:NAnt.Core.Tasks.AttribTask.AttribFileSet">
4882 <summary>
4883 All the matching files and directories in this fileset will have
4884 their attributes set.
4885 </summary>
4886 </member>
4887 <member name="P:NAnt.Core.Tasks.AttribTask.ArchiveAttrib">
4888 <summary>
4889 Set the archive attribute. The default is <see langword="false" />.
4890 </summary>
4891 </member>
4892 <member name="P:NAnt.Core.Tasks.AttribTask.HiddenAttrib">
4893 <summary>
4894 Set the hidden attribute. The default is <see langword="false" />.
4895 </summary>
4896 </member>
4897 <member name="P:NAnt.Core.Tasks.AttribTask.NormalAttrib">
4898 <summary>
4899 Set the normal file attributes. This attribute is only valid if used
4900 alone. The default is <see langword="false" />.
4901 </summary>
4902 </member>
4903 <member name="P:NAnt.Core.Tasks.AttribTask.ReadOnlyAttrib">
4904 <summary>
4905 Set the read-only attribute. The default is <see langword="false" />.
4906 </summary>
4907 </member>
4908 <member name="P:NAnt.Core.Tasks.AttribTask.SystemAttrib">
4909 <summary>
4910 Set the system attribute. The default is <see langword="false" />.
4911 </summary>
4912 </member>
4913 <member name="T:NAnt.Core.Tasks.AvailableTask">
4914 <summary>
4915 Checks if a resource is available at runtime.
4916 </summary>
4917 <remarks>
4918 <para>
4919 The specified property is set to <see langword="true"/> if the
4920 requested resource is available at runtime, and <see langword="false"/>
4921 if the resource is not available.
4922 </para>
4923 <note>
4924 we advise you to use the following functions instead:
4925 </note>
4926 <list type="table">
4927 <listheader>
4928 <term>Function</term>
4929 <description>Description</description>
4930 </listheader>
4931 <item>
4932 <term><see cref="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)"/></term>
4933 <description>Determines whether the specified file exists.</description>
4934 </item>
4935 <item>
4936 <term><see cref="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)"/></term>
4937 <description>Determines whether the given path refers to an existing directory on disk.</description>
4938 </item>
4939 <item>
4940 <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)"/></term>
4941 <description>Checks whether the specified framework exists..</description>
4942 </item>
4943 <item>
4944 <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)"/></term>
4945 <description>Checks whether the SDK for the specified framework is installed.</description>
4946 </item>
4947 </list>
4948 </remarks>
4949 <example>
4950 <para>
4951 Sets the <c>myfile.present</c> property to <see langword="true"/> if the
4952 file is available on the filesystem and <see langword="false"/> if the
4953 file is not available.
4954 </para>
4955 <code>
4956 <![CDATA[
4957 <available type="File" resource="myfile.txt" property="myfile.present" />
4958 ]]>
4959 </code>
4960 </example>
4961 <example>
4962 <para>
4963 Sets the <c>build.dir.present</c> property to <see langword="true"/>
4964 if the directory is available on the filesystem and <see langword="false"/>
4965 if the directory is not available.
4966 </para>
4967 <code>
4968 <![CDATA[
4969 <available type="Directory" resource="build" property="build.dir.present" />
4970 ]]>
4971 </code>
4972 </example>
4973 <example>
4974 <para>
4975 Sets the <c>mono-0.21.framework.present</c> property to <see langword="true"/>
4976 if the Mono 0.21 framework is available on the current system and
4977 <see langword="false"/> if the framework is not available.
4978 </para>
4979 <code>
4980 <![CDATA[
4981 <available type="Framework" resource="mono-0.21" property="mono-0.21.framework.present" />
4982 ]]>
4983 </code>
4984 </example>
4985 <example>
4986 <para>
4987 Sets the <c>net-1.1.frameworksdk.present</c> property to <see langword="true"/>
4988 if the .NET 1.1 Framework SDK is available on the current system and
4989 <see langword="false"/> if the SDK is not available.
4990 </para>
4991 <code>
4992 <![CDATA[
4993 <available type="FrameworkSDK" resource="net-1.1" property="net-1.1.frameworksdk.present" />
4994 ]]>
4995 </code>
4996 </example>
4997 </member>
4998 <member name="M:NAnt.Core.Tasks.AvailableTask.ExecuteTask">
4999 <summary>
5000 Executes the task.
5001 </summary>
5002 <remarks>
5003 <para>
5004 Sets the property identified by <see cref="P:NAnt.Core.Tasks.AvailableTask.PropertyName"/> to
5005 <see langword="true"/> when the resource exists and to <see langword="false"/>
5006 when the resource doesn't exist.
5007 </para>
5008 </remarks>
5009 <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception>
5010 </member>
5011 <member name="M:NAnt.Core.Tasks.AvailableTask.Evaluate">
5012 <summary>
5013 Evaluates the availability of a resource.
5014 </summary>
5015 <returns>
5016 <see langword="true"/> if the resource is available; otherwise,
5017 <see langword="false"/>.
5018 </returns>
5019 <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception>
5020 </member>
5021 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFile">
5022 <summary>
5023 Checks if the file specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/> property is
5024 available on the filesystem.
5025 </summary>
5026 <returns>
5027 <see langword="true"/> when the file exists; otherwise, <see langword="false"/>.
5028 </returns>
5029 </member>
5030 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckDirectory">
5031 <summary>
5032 Checks if the directory specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
5033 property is available on the filesystem.
5034 </summary>
5035 <returns>
5036 <see langword="true"/> when the directory exists; otherwise, <see langword="false"/>.
5037 </returns>
5038 </member>
5039 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFramework">
5040 <summary>
5041 Checks if the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
5042 property is available on the current system.
5043 </summary>
5044 <returns>
5045 <see langword="true"/> when the framework is available; otherwise,
5046 <see langword="false"/>.
5047 </returns>
5048 </member>
5049 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFrameworkSDK">
5050 <summary>
5051 Checks if the SDK for the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
5052 property is available on the current system.
5053 </summary>
5054 <returns>
5055 <see langword="true"/> when the SDK for the specified framework is
5056 available; otherwise, <see langword="false"/>.
5057 </returns>
5058 </member>
5059 <member name="P:NAnt.Core.Tasks.AvailableTask.Resource">
5060 <summary>
5061 The resource which must be available.
5062 </summary>
5063 </member>
5064 <member name="P:NAnt.Core.Tasks.AvailableTask.Type">
5065 <summary>
5066 The type of resource which must be present.
5067 </summary>
5068 </member>
5069 <member name="P:NAnt.Core.Tasks.AvailableTask.PropertyName">
5070 <summary>
5071 The property that must be set if the resource is available.
5072 </summary>
5073 </member>
5074 <member name="T:NAnt.Core.Tasks.AvailableTask.ResourceType">
5075 <summary>
5076 Defines the possible resource checks.
5077 </summary>
5078 </member>
5079 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.File">
5080 <summary>
5081 Determines whether a given file exists.
5082 </summary>
5083 </member>
5084 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Directory">
5085 <summary>
5086 Determines whether a given directory exists.
5087 </summary>
5088 </member>
5089 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Framework">
5090 <summary>
5091 Determines whether a given framework is available.
5092 </summary>
5093 </member>
5094 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.FrameworkSDK">
5095 <summary>
5096 Determines whether a given SDK is available.
5097 </summary>
5098 </member>
5099 <member name="T:NAnt.Core.Tasks.CallTask">
5100 <summary>
5101 Calls a NAnt target in the current project.
5102 </summary>
5103 <remarks>
5104 <para>
5105 When the <see cref="T:NAnt.Core.Tasks.CallTask"/> is used to execute a target, both that
5106 target and all its dependent targets will be re-executed.
5107 </para>
5108 <para>
5109 To avoid dependent targets from being executed more than once, two
5110 options are available:
5111 </para>
5112 <list type="bullet">
5113 <item>
5114 <description>
5115 Add an "unless" attribute with value "${<see href="../functions/target.has-executed.html">target::has-executed</see>('<c><target name></c>')}"
5116 to the dependent targets.
5117 </description>
5118 </item>
5119 <item>
5120 <description>
5121 Set the <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute on the
5122 <see cref="T:NAnt.Core.Tasks.CallTask"/> to <see langword="false "/> (<c>recommended</c>).
5123 </description>
5124 </item>
5125 </list>
5126 </remarks>
5127 <example>
5128 <para>
5129 Call the target "build".
5130 </para>
5131 <code>
5132 <![CDATA[
5133 <call target="build" />
5134 ]]>
5135 </code>
5136 </example>
5137 <example>
5138 <para>
5139 This shows how a project could 'compile' a debug and release build
5140 using a common compile target.
5141 </para>
5142 <code>
5143 <![CDATA[
5144 <project default="build">
5145 <property name="debug" value="false" />
5146 <target name="init">
5147 <echo message="initializing" />
5148 </target>
5149 <target name="compile" depends="init">
5150 <echo message="compiling with debug = ${debug}" />
5151 </target>
5152 <target name="build">
5153 <property name="debug" value="false" />
5154 <call target="compile" />
5155 <property name="debug" value="true" />
5156 <call target="compile" />
5157 </target>
5158 </project>
5159 ]]>
5160 </code>
5161 <para>
5162 The <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> parameter of the
5163 <see cref="T:NAnt.Core.Tasks.CallTask"/> defaults to <see langword="true"/>,
5164 causing the "init" target to be executed for both
5165 the "debug" and "release" build.
5166 </para>
5167 <para>
5168 This results in the following build log:
5169 </para>
5170 <code>
5171 build:
5172
5173 init:
5174 [echo] initializing
5175
5176 compile:
5177
5178 [echo] compiling with debug = false
5179
5180 init:
5181
5182 [echo] initializing
5183
5184 compile:
5185
5186 [echo] compiling with debug = true
5187
5188 BUILD SUCCEEDED
5189 </code>
5190 <para>
5191 If the "init" should only be executed once, set the
5192 <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute of the <see cref="T:NAnt.Core.Tasks.CallTask"/>
5193 to <see langword="false"/>.
5194 </para>
5195 <para>
5196 The build log would then look like this:
5197 </para>
5198 <code>
5199 build:
5200
5201 init:
5202 [echo] initializing
5203
5204 compile:
5205
5206 [echo] compiling with debug = false
5207
5208 compile:
5209
5210 [echo] compiling with debug = true
5211
5212 BUILD SUCCEEDED
5213 </code>
5214 </example>
5215 </member>
5216 <member name="M:NAnt.Core.Tasks.CallTask.ExecuteTask">
5217 <summary>
5218 Executes the specified target.
5219 </summary>
5220 </member>
5221 <member name="M:NAnt.Core.Tasks.CallTask.Initialize">
5222 <summary>
5223 Makes sure the <see cref="T:NAnt.Core.Tasks.CallTask"/> is not calling its own
5224 parent.
5225 </summary>
5226 </member>
5227 <member name="P:NAnt.Core.Tasks.CallTask.TargetName">
5228 <summary>
5229 NAnt target to call.
5230 </summary>
5231 </member>
5232 <member name="P:NAnt.Core.Tasks.CallTask.ForceExecute">
5233 <summary>
5234 Force an execute even if the target has already been executed. The
5235 default is <see langword="false" />.
5236 </summary>
5237 </member>
5238 <member name="P:NAnt.Core.Tasks.CallTask.CascadeDependencies">
5239 <summary>
5240 Execute the specified targets dependencies -- even if they have been
5241 previously executed. The default is <see langword="true" />.
5242 </summary>
5243 </member>
5244 <member name="T:NAnt.Core.Tasks.CopyTask">
5245 <summary>
5246 Copies a file or set of files to a new file or directory.
5247 </summary>
5248 <remarks>
5249 <para>
5250 Files are only copied if the source file is newer than the destination
5251 file, or if the destination file does not exist. However, you can
5252 explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/> attribute.
5253 </para>
5254 <para>
5255 When a <see cref="T:NAnt.Core.Types.FileSet"/> is used to select files to copy, the
5256 <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set. Files that are
5257 located under the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/> will
5258 be copied to a directory under the destination directory matching the
5259 path relative to the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/>,
5260 unless the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/> attribute is set to
5261 <see langword="true"/>.
5262 </para>
5263 <para>
5264 Files that are not located under the the base directory of the
5265 <see cref="T:NAnt.Core.Types.FileSet"/> will be copied directly under to the destination
5266 directory, regardless of the value of the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/>
5267 attribute.
5268 </para>
5269 <h4>Encoding</h4>
5270 <para>
5271 Unless an encoding is specified, the encoding associated with the
5272 system's current ANSI code page is used.
5273 </para>
5274 <para>
5275 An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
5276 file is automatically recognized, if the file starts with the
5277 appropriate byte order marks.
5278 </para>
5279 <note>
5280 If you employ filters in your copy operation, you should limit the copy
5281 to text files. Binary files will be corrupted by the copy operation.
5282 </note>
5283 </remarks>
5284 <example>
5285 <para>
5286 Copy a single file while changing its encoding from "latin1" to
5287 "utf-8".
5288 </para>
5289 <code>
5290 <![CDATA[
5291 <copy
5292 file="myfile.txt"
5293 tofile="mycopy.txt"
5294 inputencoding="latin1"
5295 outputencoding="utf-8" />
5296 ]]>
5297 </code>
5298 </example>
5299 <example>
5300 <para>Copy a set of files to a new directory.</para>
5301 <code>
5302 <![CDATA[
5303 <copy todir="${build.dir}">
5304 <fileset basedir="bin">
5305 <include name="*.dll" />
5306 </fileset>
5307 </copy>
5308 ]]>
5309 </code>
5310 </example>
5311 <example>
5312 <para>
5313 Copy a set of files to a directory, replacing <c>@TITLE@</c> with
5314 "Foo Bar" in all files.
5315 </para>
5316 <code>
5317 <![CDATA[
5318 <copy todir="../backup/dir">
5319 <fileset basedir="src_dir">
5320 <include name="**/*" />
5321 </fileset>
5322 <filterchain>
5323 <replacetokens>
5324 <token key="TITLE" value="Foo Bar" />
5325 </replacetokens>
5326 </filterchain>
5327 </copy>
5328 ]]>
5329 </code>
5330 </example>
5331 </member>
5332 <member name="M:NAnt.Core.Tasks.CopyTask.#ctor">
5333 <summary>
5334 Initialize new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>.
5335 </summary>
5336 </member>
5337 <member name="M:NAnt.Core.Tasks.CopyTask.Initialize">
5338 <summary>
5339 Checks whether the task is initialized with valid attributes.
5340 </summary>
5341 </member>
5342 <member name="M:NAnt.Core.Tasks.CopyTask.ExecuteTask">
5343 <summary>
5344 Executes the Copy task.
5345 </summary>
5346 <exception cref="T:NAnt.Core.BuildException">A file that has to be copied does not exist or could not be copied.</exception>
5347 </member>
5348 <member name="M:NAnt.Core.Tasks.CopyTask.DoFileOperations">
5349 <summary>
5350 Actually does the file copies.
5351 </summary>
5352 </member>
5353 <member name="P:NAnt.Core.Tasks.CopyTask.SourceFile">
5354 <summary>
5355 The file to copy.
5356 </summary>
5357 </member>
5358 <member name="P:NAnt.Core.Tasks.CopyTask.ToFile">
5359 <summary>
5360 The file to copy to.
5361 </summary>
5362 </member>
5363 <member name="P:NAnt.Core.Tasks.CopyTask.ToDirectory">
5364 <summary>
5365 The directory to copy to.
5366 </summary>
5367 </member>
5368 <member name="P:NAnt.Core.Tasks.CopyTask.Overwrite">
5369 <summary>
5370 Overwrite existing files even if the destination files are newer.
5371 The default is <see langword="false" />.
5372 </summary>
5373 </member>
5374 <member name="P:NAnt.Core.Tasks.CopyTask.Flatten">
5375 <summary>
5376 Ignore directory structure of source directory, copy all files into
5377 a single directory, specified by the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/>
5378 attribute. The default is <see langword="false"/>.
5379 </summary>
5380 </member>
5381 <member name="P:NAnt.Core.Tasks.CopyTask.IncludeEmptyDirs">
5382 <summary>
5383 Copy any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>.
5384 The default is <see langword="true"/>.
5385 </summary>
5386 </member>
5387 <member name="P:NAnt.Core.Tasks.CopyTask.CopyFileSet">
5388 <summary>
5389 Used to select the files to copy. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
5390 the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set.
5391 </summary>
5392 </member>
5393 <member name="P:NAnt.Core.Tasks.CopyTask.Filters">
5394 <summary>
5395 Chain of filters used to alter the file's content as it is copied.
5396 </summary>
5397 </member>
5398 <member name="P:NAnt.Core.Tasks.CopyTask.InputEncoding">
5399 <summary>
5400 The encoding to use when reading files. The default is the system's
5401 current ANSI code page.
5402 </summary>
5403 </member>
5404 <member name="P:NAnt.Core.Tasks.CopyTask.OutputEncoding">
5405 <summary>
5406 The encoding to use when writing the files. The default is
5407 the encoding of the input file.
5408 </summary>
5409 </member>
5410 <member name="P:NAnt.Core.Tasks.CopyTask.FileCopyMap">
5411 <summary>
5412 The set of files to perform a file operation on.
5413 </summary>
5414 <remarks>
5415 <para>
5416 The key of the <see cref="T:System.Collections.Hashtable"/> is the absolute path of
5417 the destination file and the value is a <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/>
5418 holding the path and last write time of the most recently updated
5419 source file that is selected to be copied or moved to the
5420 destination file.
5421 </para>
5422 <para>
5423 On Windows, the <see cref="T:System.Collections.Hashtable"/> is case-insensitive.
5424 </para>
5425 </remarks>
5426 </member>
5427 <member name="T:NAnt.Core.Tasks.CopyTask.FileDateInfo">
5428 <summary>
5429 Holds the absolute paths and last write time of a given file.
5430 </summary>
5431 </member>
5432 <member name="M:NAnt.Core.Tasks.CopyTask.FileDateInfo.#ctor(System.String,System.DateTime)">
5433 <summary>
5434 Initializes a new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/>
5435 class for the specified file and last write time.
5436 </summary>
5437 <param name="path">The absolute path of the file.</param>
5438 <param name="lastWriteTime">The last write time of the file.</param>
5439 </member>
5440 <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.Path">
5441 <summary>
5442 Gets the absolute path of the current file.
5443 </summary>
5444 <value>
5445 The absolute path of the current file.
5446 </value>
5447 </member>
5448 <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.LastWriteTime">
5449 <summary>
5450 Gets the time when the current file was last written to.
5451 </summary>
5452 <value>
5453 The time when the current file was last written to.
5454 </value>
5455 </member>
5456 <member name="T:NAnt.Core.Tasks.DeleteTask">
5457 <summary>
5458 Deletes a file, fileset or directory.
5459 </summary>
5460 <remarks>
5461 <para>
5462 Deletes either a single file, all files in a specified directory and
5463 its sub-directories, or a set of files specified by one or more filesets.
5464 </para>
5465 <para>
5466 If the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> or <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/> attribute is
5467 set then the fileset contents will be ignored. To delete the files
5468 in the fileset ommit the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> and <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/>
5469 attributes in the <c><delete></c> element.
5470 </para>
5471 <para>
5472 If the specified file or directory does not exist, no error is
5473 reported.
5474 </para>
5475 <note>
5476 Read-only files cannot be deleted. Use the <see cref="T:NAnt.Core.Tasks.AttribTask"/>
5477 first to remove the read-only attribute.
5478 </note>
5479 </remarks>
5480 <example>
5481 <para>Delete a single file.</para>
5482 <code>
5483 <![CDATA[
5484 <delete file="myfile.txt" />
5485 ]]>
5486 </code>
5487 </example>
5488 <example>
5489 <para>
5490 Delete a directory and the contents within. If the directory does not
5491 exist, no error is reported.
5492 </para>
5493 <code>
5494 <![CDATA[
5495 <delete dir="${build.dir}" />
5496 ]]>
5497 </code>
5498 </example>
5499 <example>
5500 <para>
5501 Delete a set of files.
5502 </para>
5503 <code>
5504 <![CDATA[
5505 <delete>
5506 <fileset>
5507 <include name="${basename}-??.exe" />
5508 <include name="${basename}-??.pdb" />
5509 </fileset>
5510 </delete>
5511 ]]>
5512 </code>
5513 </example>
5514 </member>
5515 <member name="M:NAnt.Core.Tasks.DeleteTask.Initialize">
5516 <summary>
5517 Ensures the supplied attributes are valid.
5518 </summary>
5519 </member>
5520 <member name="P:NAnt.Core.Tasks.DeleteTask.File">
5521 <summary>
5522 The file to delete.
5523 </summary>
5524 </member>
5525 <member name="P:NAnt.Core.Tasks.DeleteTask.Directory">
5526 <summary>
5527 The directory to delete.
5528 </summary>
5529 </member>
5530 <member name="P:NAnt.Core.Tasks.DeleteTask.IncludeEmptyDirs">
5531 <summary>
5532 Remove any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>.
5533 The default is <see langword="true"/>.
5534 </summary>
5535 </member>
5536 <member name="P:NAnt.Core.Tasks.DeleteTask.DeleteFileSet">
5537 <summary>
5538 All the files in the file set will be deleted.
5539 </summary>
5540 </member>
5541 <member name="P:NAnt.Core.Tasks.DeleteTask.Verbose">
5542 <summary>
5543 Controls whether to show the name of each deleted file or directory.
5544 The default is <see langword="false" />.
5545 </summary>
5546 </member>
5547 <member name="T:NAnt.Core.Tasks.DescriptionTask">
5548 <summary>
5549 An empty task that allows a build file to contain a description.
5550 </summary>
5551 <example>
5552 <para>Set a description.</para>
5553 <code>
5554 <![CDATA[
5555 <description>This is a description.</description>
5556 ]]>
5557 </code>
5558 </example>
5559 </member>
5560 <member name="T:NAnt.Core.Tasks.EchoTask">
5561 <summary>
5562 Writes a message to the build log or a specified file.
5563 </summary>
5564 <remarks>
5565 <para>
5566 The message can be specified using the <see cref="P:NAnt.Core.Tasks.EchoTask.Message"/> attribute
5567 or as inline content. If neither is included - or the message contains
5568 only whitespace - then an empty message will be emitted in the output.
5569 </para>
5570 <para>
5571 Macros in the message will be expanded.
5572 </para>
5573 <para>
5574 When writing to a file, the <see cref="P:NAnt.Core.Tasks.EchoTask.MessageLevel"/> attribute is
5575 ignored.
5576 </para>
5577 <note>
5578 Since NAnt 0.86, a newline will no longer be implictly added when
5579 writing a message to a file.
5580 </note>
5581 </remarks>
5582 <example>
5583 <para>
5584 Writes a message with level <see cref="F:NAnt.Core.Level.Debug"/> to the build log.
5585 </para>
5586 <code>
5587 <![CDATA[
5588 <echo message="Hello, World!" level="Debug" />
5589 ]]>
5590 </code>
5591 </example>
5592 <example>
5593 <para>
5594 Writes a two-line message to the build log using inline content.
5595 </para>
5596 <code>
5597 <![CDATA[
5598 <echo>First line
5599 Second line</echo>
5600 ]]>
5601 </code>
5602 </example>
5603 <example>
5604 <para>
5605 Writes a two-line message to the build log using the <see cref="P:NAnt.Core.Tasks.EchoTask.Message"/> attribute.
5606 </para>
5607 <code>
5608 <![CDATA[
5609 <echo message='First line
5610 Second line</echo>
5611 ]]>
5612 </code>
5613 </example>
5614 <example>
5615 <para>
5616 Writes a message with expanded macro to the build log.
5617 </para>
5618 <code>
5619 <![CDATA[
5620 <echo message="Base build directory = ${nant.project.basedir}" />
5621 ]]>
5622 </code>
5623 </example>
5624 <example>
5625 <para>
5626 Functionally equivalent to the previous example.
5627 </para>
5628 <code>
5629 <![CDATA[
5630 <echo>Base build directory = ${nant.project.basedir}</echo>
5631 ]]>
5632 </code>
5633 </example>
5634 <example>
5635 <para>
5636 Writes the previous message to a file in the project directory,
5637 overwriting the file if it exists.
5638 </para>
5639 <code>
5640 <![CDATA[
5641 <echo file="buildmessage.txt">Base build directory = ${nant.project.basedir}</echo>
5642 ]]>
5643 </code>
5644 </example>
5645 </member>
5646 <member name="M:NAnt.Core.Tasks.EchoTask.ExecuteTask">
5647 <summary>
5648 Outputs the message to the build log or the specified file.
5649 </summary>
5650 </member>
5651 <member name="P:NAnt.Core.Tasks.EchoTask.Encoding">
5652 <summary>
5653 The encoding to use when writing message to a file. The default is
5654 UTF-8 encoding without a Byte Order Mark (BOM).
5655 </summary>
5656 </member>
5657 <member name="P:NAnt.Core.Tasks.EchoTask.Message">
5658 <summary>
5659 The message to output.
5660 </summary>
5661 </member>
5662 <member name="P:NAnt.Core.Tasks.EchoTask.Contents">
5663 <summary>
5664 Gets or sets the inline content that should be output.
5665 </summary>
5666 <value>
5667 The inline content that should be output.
5668 </value>
5669 </member>
5670 <member name="P:NAnt.Core.Tasks.EchoTask.File">
5671 <summary>
5672 The file to write the message to.
5673 </summary>
5674 </member>
5675 <member name="P:NAnt.Core.Tasks.EchoTask.Append">
5676 <summary>
5677 Determines whether the <see cref="T:NAnt.Core.Tasks.EchoTask"/> should append to the
5678 file, or overwrite it. By default, the file will be overwritten.
5679 </summary>
5680 <value>
5681 <see langword="true"/> if output should be appended to the file;
5682 otherwise, <see langword="false"/>. The default is
5683 <see langword="false"/>.
5684 </value>
5685 </member>
5686 <member name="P:NAnt.Core.Tasks.EchoTask.MessageLevel">
5687 <summary>
5688 The logging level with which the message should be output. The default
5689 is <see cref="F:NAnt.Core.Level.Info"/>.
5690 </summary>
5691 </member>
5692 <member name="T:NAnt.Core.Tasks.ExecTask">
5693 <summary>
5694 Executes a system command.
5695 </summary>
5696 <remarks>
5697 <para>
5698 Use of nested <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"/> element(s)
5699 is advised over the <see cref="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments"/> parameter, as
5700 it supports automatic quoting and can resolve relative to absolute
5701 paths.
5702 </para>
5703 </remarks>
5704 <example>
5705 <para>Ping "nant.sourceforge.net".</para>
5706 <code>
5707 <![CDATA[
5708 <exec program="ping">
5709 <arg value="nant.sourceforge.net" />
5710 </exec>
5711 ]]>
5712 </code>
5713 </example>
5714 <example>
5715 <para>
5716 Execute a java application using <c>IKVM.NET</c> that requires the
5717 Apache FOP jars, and a set of custom jars.
5718 </para>
5719 <code>
5720 <![CDATA[
5721 <path id="fop-classpath">
5722 <pathelement file="${fop.dist.dir}/build/fop.jar" />
5723 <pathelement file="${fop.dist.dir}/lib/xercesImpl-2.2.1.jar" />
5724 <pathelement file="${fop.dist.dir}/lib/avalon-framework-cvs-20020806.jar" />
5725 <pathelement file="${fop.dist.dir}/lib/batik.jar" />
5726 </path>
5727 <exec program="ikvm.exe" useruntimeengine="true">
5728 <arg value="-cp" />
5729 <arg>
5730 <path>
5731 <pathelement dir="conf" />
5732 <path refid="fop-classpath" />
5733 <pathelement file="lib/mylib.jar" />
5734 <pathelement file="lib/otherlib.zip" />
5735 </path>
5736 </arg>
5737 <arg value="org.me.MyProg" />
5738 </exec>
5739 ]]>
5740 </code>
5741 <para>
5742 Assuming the base directory of the build file is "c:\ikvm-test" and
5743 the value of the "fop.dist.dir" property is "c:\fop", then the value
5744 of the <c>-cp</c> argument that is passed to<c>ikvm.exe</c> is
5745 "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"
5746 on a DOS-based system.
5747 </para>
5748 </example>
5749 </member>
5750 <member name="T:NAnt.Core.Tasks.ExternalProgramBase">
5751 <summary>
5752 Provides the abstract base class for tasks that execute external applications.
5753 </summary>
5754 <remarks>
5755 <para>
5756 When a <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/> is applied to the
5757 deriving class and <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName"/> does not return an
5758 absolute path, then the program to execute will first be searched for
5759 in the location specified by <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/>.
5760 </para>
5761 <para>
5762 If the program does not exist in that location, then the list of tool
5763 paths of the current target framework will be scanned in the order in
5764 which they are defined in the NAnt configuration file.
5765 </para>
5766 </remarks>
5767 </member>
5768 <member name="F:NAnt.Core.Tasks.ExternalProgramBase.UnknownExitCode">
5769 <summary>
5770 Defines the exit code that will be returned by <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode"/>
5771 if the process could not be started, or did not exit (in time).
5772 </summary>
5773 </member>
5774 <member name="F:NAnt.Core.Tasks.ExternalProgramBase._lockObject">
5775 <summary>
5776 Will be used to ensure thread-safe operations.
5777 </summary>
5778 </member>
5779 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.ExecuteTask">
5780 <summary>
5781 Starts the external process and captures its output.
5782 </summary>
5783 <exception cref="T:NAnt.Core.BuildException">
5784 <para>The external process did not finish within the configured timeout.</para>
5785 <para>-or-</para>
5786 <para>The exit code of the external process indicates a failure.</para>
5787 </exception>
5788 </member>
5789 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.PrepareProcess(System.Diagnostics.Process)">
5790 <summary>
5791 Updates the <see cref="T:System.Diagnostics.ProcessStartInfo"/> of the specified
5792 <see cref="T:System.Diagnostics.Process"/>.
5793 </summary>
5794 <param name="process">The <see cref="T:System.Diagnostics.Process"/> of which the <see cref="T:System.Diagnostics.ProcessStartInfo"/> should be updated.</param>
5795 </member>
5796 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StartProcess">
5797 <summary>
5798 Starts the process and handles errors.
5799 </summary>
5800 <returns>The <see cref="T:System.Diagnostics.Process"/> that was started.</returns>
5801 </member>
5802 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Output">
5803 <summary>
5804 Reads from the stream until the external program is ended.
5805 </summary>
5806 </member>
5807 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Error">
5808 <summary>
5809 Reads from the stream until the external program is ended.
5810 </summary>
5811 </member>
5812 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.DetermineFilePath">
5813 <summary>
5814 Determines the path of the external program that should be executed.
5815 </summary>
5816 <returns>
5817 A fully qualifies pathname including the program name.
5818 </returns>
5819 <exception cref="T:NAnt.Core.BuildException">The task is not available or not configured for the current framework.</exception>
5820 </member>
5821 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName">
5822 <summary>
5823 The name of the executable that should be used to launch the
5824 external program.
5825 </summary>
5826 <value>
5827 The name of the executable that should be used to launch the external
5828 program, or <see langword="null" /> if no name is specified.
5829 </value>
5830 <remarks>
5831 If available, the configured value in the NAnt configuration
5832 file will be used if no name is specified.
5833 </remarks>
5834 </member>
5835 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramFileName">
5836 <summary>
5837 Gets the filename of the external program to start.
5838 </summary>
5839 <value>
5840 The filename of the external program.
5841 </value>
5842 <remarks>
5843 Override in derived classes to explicitly set the location of the
5844 external tool.
5845 </remarks>
5846 </member>
5847 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramArguments">
5848 <summary>
5849 Gets the command-line arguments for the external program.
5850 </summary>
5851 <value>
5852 The command-line arguments for the external program.
5853 </value>
5854 </member>
5855 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Output">
5856 <summary>
5857 Gets the file to which the standard output should be redirected.
5858 </summary>
5859 <value>
5860 The file to which the standard output should be redirected, or
5861 <see langword="null" /> if the standard output should not be
5862 redirected.
5863 </value>
5864 <remarks>
5865 The default implementation will never allow the standard output
5866 to be redirected to a file. Deriving classes should override this
5867 property to change this behaviour.
5868 </remarks>
5869 </member>
5870 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputAppend">
5871 <summary>
5872 Gets a value indicating whether output will be appended to the
5873 <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>.
5874 </summary>
5875 <value>
5876 <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>;
5877 otherwise, <see langword="false"/>.
5878 </value>
5879 </member>
5880 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.BaseDirectory">
5881 <summary>
5882 Gets the working directory for the application.
5883 </summary>
5884 <value>
5885 The working directory for the application.
5886 </value>
5887 </member>
5888 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.TimeOut">
5889 <summary>
5890 The maximum amount of time the application is allowed to execute,
5891 expressed in milliseconds. Defaults to no time-out.
5892 </summary>
5893 </member>
5894 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments">
5895 <summary>
5896 The command-line arguments for the external program.
5897 </summary>
5898 </member>
5899 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine">
5900 <summary>
5901 Specifies whether the external program is a managed application
5902 which should be executed using a runtime engine, if configured.
5903 The default is <see langword="false"/>.
5904 </summary>
5905 <value>
5906 <see langword="true"/> if the external program should be executed
5907 using a runtime engine; otherwise, <see langword="false"/>.
5908 </value>
5909 <remarks>
5910 <para>
5911 The value of <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is only used from
5912 <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/>, and then only if its value is set to
5913 <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>. In which case
5914 <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/> returns <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/>
5915 if <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is <see langword="true"/>.
5916 </para>
5917 <para>
5918 In all other cases, the value of <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/>
5919 is ignored.
5920 </para>
5921 </remarks>
5922 </member>
5923 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Managed">
5924 <summary>
5925 Specifies whether the external program should be treated as a managed
5926 application, possibly forcing it to be executed under the currently
5927 targeted version of the CLR.
5928 </summary>
5929 <value>
5930 A <see cref="T:NAnt.Core.Types.ManagedExecution"/> indicating how the program should
5931 be treated.
5932 </value>
5933 <remarks>
5934 <para>
5935 If <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/> is set to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>,
5936 which is the default value, and <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is
5937 <see langword="true"/> then <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/>
5938 is returned.
5939 </para>
5940 <para>
5941 When the changing <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/> to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>,
5942 then <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is set to <see langword="false"/>;
5943 otherwise, it is changed to <see langword="true"/>.
5944 </para>
5945 </remarks>
5946 </member>
5947 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputWriter">
5948 <summary>
5949 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which standard output
5950 messages of the external program will be written.
5951 </summary>
5952 <value>
5953 The <see cref="T:System.IO.TextWriter"/> to which standard output messages of
5954 the external program will be written.
5955 </value>
5956 <remarks>
5957 By default, standard output messages wil be written to the build log
5958 with level <see cref="F:NAnt.Core.Level.Info"/>.
5959 </remarks>
5960 </member>
5961 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ErrorWriter">
5962 <summary>
5963 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which error output
5964 of the external program will be written.
5965 </summary>
5966 <value>
5967 The <see cref="T:System.IO.TextWriter"/> to which error output of the external
5968 program will be written.
5969 </value>
5970 <remarks>
5971 By default, error output wil be written to the build log with level
5972 <see cref="F:NAnt.Core.Level.Warning"/>.
5973 </remarks>
5974 </member>
5975 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode">
5976 <summary>
5977 Gets the value that the process specified when it terminated.
5978 </summary>
5979 <value>
5980 The code that the associated process specified when it terminated,
5981 or <c>-1000</c> if the process could not be started or did not
5982 exit (in time).
5983 </value>
5984 </member>
5985 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProcessId">
5986 <summary>
5987 Gets the unique identifier for the spawned application.
5988 </summary>
5989 </member>
5990 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Spawn">
5991 <summary>
5992 Gets or sets a value indicating whether the application should be
5993 spawned. If you spawn an application, its output will not be logged
5994 by NAnt. The default is <see langword="false" />.
5995 </summary>
5996 </member>
5997 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.CommandLine">
5998 <summary>
5999 Gets the command-line arguments, separated by spaces.
6000 </summary>
6001 </member>
6002 <member name="M:NAnt.Core.Tasks.ExecTask.Initialize">
6003 <summary>
6004 Performs additional checks after the task has been initialized.
6005 </summary>
6006 <exception cref="T:NAnt.Core.BuildException"><see cref="P:NAnt.Core.Tasks.ExecTask.FileName"/> does not hold a valid file name.</exception>
6007 </member>
6008 <member name="M:NAnt.Core.Tasks.ExecTask.ExecuteTask">
6009 <summary>
6010 Executes the external program.
6011 </summary>
6012 </member>
6013 <member name="P:NAnt.Core.Tasks.ExecTask.FileName">
6014 <summary>
6015 The program to execute without command arguments.
6016 </summary>
6017 <remarks>
6018 The path will not be evaluated to a full path using the project
6019 base directory.
6020 </remarks>
6021 </member>
6022 <member name="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments">
6023 <summary>
6024 The command-line arguments for the program. These will be
6025 passed as is to the external program. When quoting is necessary,
6026 these must be explictly set as part of the value. Consider using
6027 nested <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"/> elements instead.
6028 </summary>
6029 </member>
6030 <member name="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet">
6031 <summary>
6032 Environment variables to pass to the program.
6033 </summary>
6034 </member>
6035 <member name="P:NAnt.Core.Tasks.ExecTask.WorkingDirectory">
6036 <summary>
6037 The directory in which the command will be executed.
6038 </summary>
6039 <value>
6040 The directory in which the command will be executed. The default
6041 is the project's base directory.
6042 </value>
6043 <remarks>
6044 <para>
6045 The working directory will be evaluated relative to the project's
6046 base directory if it is relative.
6047 </para>
6048 </remarks>
6049 </member>
6050 <member name="P:NAnt.Core.Tasks.ExecTask.ResultProperty">
6051 <summary>
6052 <para>
6053 The name of a property in which the exit code of the program should
6054 be stored. Only of interest if <see cref="P:NAnt.Core.Task.FailOnError"/> is
6055 <see langword="false"/>.
6056 </para>
6057 <para>
6058 If the exit code of the program is "-1000" then the program could
6059 not be started, or did not exit (in time).
6060 </para>
6061 </summary>
6062 </member>
6063 <member name="P:NAnt.Core.Tasks.ExecTask.UseRuntimeEngine">
6064 <summary>
6065 Specifies whether the external program should be executed using a
6066 runtime engine, if configured. The default is <see langword="false" />.
6067 </summary>
6068 <value>
6069 <see langword="true" /> if the external program should be executed
6070 using a runtime engine; otherwise, <see langword="false" />.
6071 </value>
6072 </member>
6073 <member name="P:NAnt.Core.Tasks.ExecTask.Managed">
6074 <summary>
6075 Specifies whether the external program is a managed application
6076 which should be executed using a runtime engine, if configured.
6077 The default is <see langword="false" />.
6078 </summary>
6079 <value>
6080 <see langword="true" /> if the external program should be executed
6081 using a runtime engine; otherwise, <see langword="false" />.
6082 </value>
6083 </member>
6084 <member name="P:NAnt.Core.Tasks.ExecTask.ProgramFileName">
6085 <summary>
6086 Gets the filename of the external program to start.
6087 </summary>
6088 <value>
6089 The filename of the external program.
6090 </value>
6091 </member>
6092 <member name="P:NAnt.Core.Tasks.ExecTask.ProgramArguments">
6093 <summary>
6094 Gets the command-line arguments for the external program.
6095 </summary>
6096 <value>
6097 The command-line arguments for the external program.
6098 </value>
6099 </member>
6100 <member name="P:NAnt.Core.Tasks.ExecTask.BaseDirectory">
6101 <summary>
6102 The directory the program is in.
6103 </summary>
6104 <remarks>
6105 <value>
6106 The directory the program is in. The default is the project's base
6107 directory.
6108 </value>
6109 <para>
6110 The basedir will be evaluated relative to the project's base
6111 directory if it is relative.
6112 </para>
6113 </remarks>
6114 </member>
6115 <member name="P:NAnt.Core.Tasks.ExecTask.Output">
6116 <summary>
6117 The file to which the standard output will be redirected.
6118 </summary>
6119 <remarks>
6120 By default, the standard output is redirected to the console.
6121 </remarks>
6122 </member>
6123 <member name="P:NAnt.Core.Tasks.ExecTask.OutputAppend">
6124 <summary>
6125 Gets or sets a value indicating whether output should be appended
6126 to the output file. The default is <see langword="false"/>.
6127 </summary>
6128 <value>
6129 <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExecTask.Output"/>;
6130 otherwise, <see langword="false"/>.
6131 </value>
6132 </member>
6133 <member name="P:NAnt.Core.Tasks.ExecTask.Spawn">
6134 <summary>
6135 Gets or sets a value indicating whether the application should be
6136 spawned. If you spawn an application, its output will not be logged
6137 by NAnt. The default is <see langword="false" />.
6138 </summary>
6139 </member>
6140 <member name="P:NAnt.Core.Tasks.ExecTask.ProcessIdProperty">
6141 <summary>
6142 The name of a property in which the unique identifier of the spawned
6143 application should be stored. Only of interest if <see cref="P:NAnt.Core.Tasks.ExecTask.Spawn"/>
6144 is <see langword="true"/>.
6145 </summary>
6146 </member>
6147 <member name="T:NAnt.Core.Tasks.FailTask">
6148 <summary>
6149 Exits the current build by throwing a <see cref="T:NAnt.Core.BuildException"/>,
6150 optionally printing additional information.
6151 </summary>
6152 <remarks>
6153 <para>
6154 The cause of the build failure can be specified using the <see cref="P:NAnt.Core.Tasks.FailTask.Message"/>
6155 attribute or as inline content.
6156 </para>
6157 <para>
6158 Macros in the message will be expanded.
6159 </para>
6160 </remarks>
6161 <example>
6162 <para>Exits the current build without giving further information.</para>
6163 <code>
6164 <![CDATA[
6165 <fail />
6166 ]]>
6167 </code>
6168 </example>
6169 <example>
6170 <para>Exits the current build and writes a message to the build log.</para>
6171 <code>
6172 <![CDATA[
6173 <fail message="Something wrong here." />
6174 ]]>
6175 </code>
6176 </example>
6177 <example>
6178 <para>Functionally equivalent to the previous example.</para>
6179 <code>
6180 <![CDATA[
6181 <fail>Something wrong here.</fail>
6182 ]]>
6183 </code>
6184 </example>
6185 </member>
6186 <member name="P:NAnt.Core.Tasks.FailTask.Message">
6187 <summary>
6188 A message giving further information on why the build exited.
6189 </summary>
6190 <remarks>
6191 Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive.
6192 </remarks>
6193 </member>
6194 <member name="P:NAnt.Core.Tasks.FailTask.Contents">
6195 <summary>
6196 Gets or sets the inline content that should be output in the build
6197 log, giving further information on why the build exited.
6198 </summary>
6199 <value>
6200 The inline content that should be output in the build log.
6201 </value>
6202 <remarks>
6203 Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive.
6204 </remarks>
6205 </member>
6206 <member name="T:NAnt.Core.Tasks.GetTask">
6207 <summary>
6208 Gets a particular file from a URL source.
6209 </summary>
6210 <remarks>
6211 <para>
6212 Options include verbose reporting and timestamp based fetches.
6213 </para>
6214 <para>
6215 Currently, only HTTP and UNC protocols are supported. FTP support may
6216 be added when more pluggable protocols are added to the System.Net
6217 assembly.
6218 </para>
6219 <para>
6220 The <see cref="P:NAnt.Core.Tasks.GetTask.UseTimeStamp"/> option enables you to control downloads
6221 so that the remote file is only fetched if newer than the local copy.
6222 If there is no local copy, the download always takes place. When a file
6223 is downloaded, the timestamp of the downloaded file is set to the remote
6224 timestamp.
6225 </para>
6226 <note>
6227 This timestamp facility only works on downloads using the HTTP protocol.
6228 </note>
6229 </remarks>
6230 <example>
6231 <para>
6232 Gets the index page of the NAnt home page, and stores it in the file
6233 <c>help/index.html</c> relative to the project base directory.
6234 </para>
6235 <code>
6236 <![CDATA[
6237 <get src="http://nant.sourceforge.org/" dest="help/index.html" />
6238 ]]>
6239 </code>
6240 </example>
6241 <example>
6242 <para>
6243 Gets the index page of a secured web site using the given credentials,
6244 while connecting using the specified password-protected proxy server.
6245 </para>
6246 <code>
6247 <![CDATA[
6248 <get src="http://password.protected.site/index.html" dest="secure/index.html">
6249 <credentials username="user" password="guess" domain="mydomain" />
6250 <proxy host="proxy.company.com" port="8080">
6251 <credentials username="proxyuser" password="dunno" />
6252 </proxy>
6253 </get>
6254 ]]>
6255 </code>
6256 </example>
6257 </member>
6258 <member name="M:NAnt.Core.Tasks.GetTask.Initialize">
6259 <summary>
6260 Initializes task and ensures the supplied attributes are valid.
6261 </summary>
6262 </member>
6263 <member name="M:NAnt.Core.Tasks.GetTask.ExecuteTask">
6264 <summary>
6265 This is where the work is done
6266 </summary>
6267 </member>
6268 <member name="M:NAnt.Core.Tasks.GetTask.TouchFile(System.IO.FileInfo,System.DateTime)">
6269 <summary>
6270 Sets the timestamp of a given file to a specified time.
6271 </summary>
6272 </member>
6273 <member name="P:NAnt.Core.Tasks.GetTask.Source">
6274 <summary>
6275 The URL from which to retrieve a file.
6276 </summary>
6277 </member>
6278 <member name="P:NAnt.Core.Tasks.GetTask.DestinationFile">
6279 <summary>
6280 The file where to store the retrieved file.
6281 </summary>
6282 </member>
6283 <member name="P:NAnt.Core.Tasks.GetTask.HttpProxy">
6284 <summary>
6285 If inside a firewall, proxy server/port information
6286 Format: {proxy server name}:{port number}
6287 Example: proxy.mycompany.com:8080
6288 </summary>
6289 </member>
6290 <member name="P:NAnt.Core.Tasks.GetTask.Proxy">
6291 <summary>
6292 The network proxy to use to access the Internet resource.
6293 </summary>
6294 </member>
6295 <member name="P:NAnt.Core.Tasks.GetTask.Credentials">
6296 <summary>
6297 The network credentials used for authenticating the request with
6298 the Internet resource.
6299 </summary>
6300 </member>
6301 <member name="P:NAnt.Core.Tasks.GetTask.IgnoreErrors">
6302 <summary>
6303 Log errors but don't treat as fatal. The default is <see langword="false" />.
6304 </summary>
6305 </member>
6306 <member name="P:NAnt.Core.Tasks.GetTask.UseTimeStamp">
6307 <summary>
6308 Conditionally download a file based on the timestamp of the local
6309 copy. HTTP only. The default is <see langword="false" />.
6310 </summary>
6311 </member>
6312 <member name="P:NAnt.Core.Tasks.GetTask.Timeout">
6313 <summary>
6314 The length of time, in milliseconds, until the request times out.
6315 The default is <c>100000</c> milliseconds.
6316 </summary>
6317 </member>
6318 <member name="P:NAnt.Core.Tasks.GetTask.Certificates">
6319 <summary>
6320 The security certificates to associate with the request.
6321 </summary>
6322 </member>
6323 <member name="T:NAnt.Core.Tasks.IfTask">
6324 <summary>
6325 Checks the conditional attributes and executes the children if
6326 <see langword="true"/>.
6327 </summary>
6328 <remarks>
6329 <para>
6330 If no conditions are checked, all child tasks are executed.
6331 </para>
6332 <para>
6333 If more than one attribute is used, they are &&'d. The first
6334 to fail stops the check.
6335 </para>
6336 <para>
6337 The order of condition evaluation is, <see cref="P:NAnt.Core.Tasks.IfTask.TargetNameExists"/>,
6338 <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameExists"/>, <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue"/>,
6339 <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>.
6340 </para>
6341 <note>
6342 instead of using the deprecated attributes, we advise you to use the
6343 following functions in combination with the <see cref="P:NAnt.Core.Tasks.IfTask.Test"/>
6344 attribute:
6345 </note>
6346 <list type="table">
6347 <listheader>
6348 <term>Function</term>
6349 <description>Description</description>
6350 </listheader>
6351 <item>
6352 <term><see cref="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)"/></term>
6353 <description>Checks whether the specified property exists.</description>
6354 </item>
6355 <item>
6356 <term><see cref="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)"/></term>
6357 <description>Checks whether the specified target exists.</description>
6358 </item>
6359 </list>
6360 </remarks>
6361 <example>
6362 <para>Tests the value of a property using expressions.</para>
6363 <code>
6364 <![CDATA[
6365 <if test="${build.configuration=='release'}">
6366 <echo>Build release configuration</echo>
6367 </if>
6368 ]]>
6369 </code>
6370 </example>
6371 <example>
6372 <para>Tests the the output of a function.</para>
6373 <code>
6374 <![CDATA[
6375 <if test="${not file::exists(filename) or file::get-length(filename) = 0}">
6376 <echo message="The version file ${filename} doesn't exist or is empty!" />
6377 </if>
6378 ]]>
6379 </code>
6380 </example>
6381 <example>
6382 <para><c>(Deprecated)</c> Check that a target exists.</para>
6383 <code>
6384 <![CDATA[
6385 <target name="myTarget" />
6386 <if targetexists="myTarget">
6387 <echo message="myTarget exists" />
6388 </if>
6389 ]]>
6390 </code>
6391 </example>
6392 <example>
6393 <para><c>(Deprecated)</c> Check existence of a property.</para>
6394 <code>
6395 <![CDATA[
6396 <if propertyexists="myProp">
6397 <echo message="myProp Exists. Value='${myProp}'" />
6398 </if>
6399 ]]>
6400 </code>
6401 </example>
6402 <example>
6403 <para><c>(Deprecated)</c> Check that a property value is true.</para>
6404 <code>
6405 <![CDATA[
6406 <if propertytrue="myProp">
6407 <echo message="myProp is true. Value='${myProp}'" />
6408 </if>
6409 ]]>
6410 </code>
6411 </example>
6412 <example>
6413 <para>
6414 <c>(Deprecated)</c> Check that a property exists and is <see langword="true"/>
6415 (uses multiple conditions).
6416 </para>
6417 <code>
6418 <![CDATA[
6419 <if propertyexists="myProp" propertytrue="myProp">
6420 <echo message="myProp is '${myProp}'" />
6421 </if>
6422 ]]>
6423 </code>
6424 <para>which is the same as</para>
6425 <code>
6426 <![CDATA[
6427 <if propertyexists="myProp">
6428 <if propertytrue="myProp">
6429 <echo message="myProp is '${myProp}'" />
6430 </if>
6431 </if>
6432 ]]>
6433 </code>
6434 </example>
6435 <example>
6436 <para>
6437 <c>(Deprecated)</c> Check file dates. If <c>myfile.dll</c> is uptodate,
6438 then do stuff.
6439 </para>
6440 <code>
6441 <![CDATA[
6442 <if uptodatefile="myfile.dll" comparefile="myfile.cs">
6443 <echo message="myfile.dll is newer/same-date as myfile.cs" />
6444 </if>
6445 ]]>
6446 </code>
6447 <para>or</para>
6448 <code>
6449 <![CDATA[
6450 <if uptodatefile="myfile.dll">
6451 <comparefiles>
6452 <include name="*.cs" />
6453 </comparefiles>
6454 <echo message="myfile.dll is newer/same-date as myfile.cs" />
6455 </if>
6456 ]]>
6457 </code>
6458 <para>or</para>
6459 <code>
6460 <![CDATA[
6461 <if>
6462 <uptodatefiles>
6463 <include name="myfile.dll" />
6464 </uptodatefiles>
6465 <comparefiles>
6466 <include name="*.cs" />
6467 </comparefiles>
6468 <echo message="myfile.dll is newer/same-date as myfile.cs" />
6469 </if>
6470 ]]>
6471 </code>
6472 </example>
6473 </member>
6474 <member name="T:NAnt.Core.TaskContainer">
6475 <summary>
6476 Executes embedded tasks in the order in which they are defined.
6477 </summary>
6478 </member>
6479 <member name="M:NAnt.Core.TaskContainer.Initialize">
6480 <summary>
6481 Automatically exclude build elements that are defined on the task
6482 from things that get executed, as they are evaluated normally during
6483 XML task initialization.
6484 </summary>
6485 </member>
6486 <member name="M:NAnt.Core.TaskContainer.ExecuteChildTasks">
6487 <summary>
6488 Creates and executes the embedded (child XML nodes) elements.
6489 </summary>
6490 <remarks>
6491 Skips any element defined by the host <see cref="T:NAnt.Core.Task"/> that has
6492 a <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> defined.
6493 </remarks>
6494 </member>
6495 <member name="P:NAnt.Core.TaskContainer.CustomXmlProcessing">
6496 <summary>
6497 Gets a value indicating whether the element is performing additional
6498 processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
6499 initialize the element.
6500 </summary>
6501 <value>
6502 <see langword="true"/>, as a <see cref="T:NAnt.Core.TaskContainer"/> is
6503 responsable for creating tasks from the nested build elements.
6504 </value>
6505 </member>
6506 <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFile">
6507 <summary>
6508 The file to compare if uptodate.
6509 </summary>
6510 </member>
6511 <member name="P:NAnt.Core.Tasks.IfTask.CompareFile">
6512 <summary>
6513 The file to check against for the uptodate file.
6514 </summary>
6515 </member>
6516 <member name="P:NAnt.Core.Tasks.IfTask.CompareFiles">
6517 <summary>
6518 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the comparison files for
6519 the <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>(s) check.
6520 </summary>
6521 </member>
6522 <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFiles">
6523 <summary>
6524 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the uptodate files for
6525 the <see cref="P:NAnt.Core.Tasks.IfTask.CompareFile"/>(s) check.
6526 </summary>
6527 </member>
6528 <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue">
6529 <summary>
6530 Used to test whether a property is true.
6531 </summary>
6532 </member>
6533 <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameExists">
6534 <summary>
6535 Used to test whether a property exists.
6536 </summary>
6537 </member>
6538 <member name="P:NAnt.Core.Tasks.IfTask.TargetNameExists">
6539 <summary>
6540 Used to test whether a target exists.
6541 </summary>
6542 </member>
6543 <member name="P:NAnt.Core.Tasks.IfTask.Test">
6544 <summary>
6545 Used to test arbitrary boolean expression.
6546 </summary>
6547 </member>
6548 <member name="T:NAnt.Core.Tasks.IfNotTask">
6549 <summary>
6550 The opposite of the <c>if</c> task.
6551 </summary>
6552 <example>
6553 <para>Check that a property does not exist.</para>
6554 <code>
6555 <![CDATA[
6556 <ifnot propertyexists="myProp">
6557 <echo message="myProp does not exist."/>
6558 </if>
6559 ]]>
6560 </code>
6561 <para>Check that a property value is not true.</para>
6562 <code>
6563 <![CDATA[
6564 <ifnot propertytrue="myProp">
6565 <echo message="myProp is not true."/>
6566 </if>
6567 ]]>
6568 </code>
6569 </example>
6570 <example>
6571 <para>Check that a target does not exist.</para>
6572 <code>
6573 <![CDATA[
6574 <ifnot targetexists="myTarget">
6575 <echo message="myTarget does not exist."/>
6576 </if>
6577 ]]>
6578 </code>
6579 </example>
6580 </member>
6581 <member name="T:NAnt.Core.Tasks.IncludeTask">
6582 <summary>
6583 Includes an external build file.
6584 </summary>
6585 <remarks>
6586 <para>
6587 This task is used to break your build file into smaller chunks. You
6588 can load a partial build file and have it included into the build file.
6589 </para>
6590 <note>
6591 Any global (project level) tasks in the included build file are executed
6592 when this task is executed. Tasks in target elements are only executed
6593 if that target is executed.
6594 </note>
6595 <note>
6596 The project element attributes are ignored.
6597 </note>
6598 <note>
6599 This task can only be in the global (project level) section of the
6600 build file.
6601 </note>
6602 <note>
6603 This task can only include files from the file system.
6604 </note>
6605 </remarks>
6606 <example>
6607 <para>
6608 Include a task that fetches the project version from the
6609 <c>GetProjectVersion.include</c> build file.
6610 </para>
6611 <code>
6612 <![CDATA[
6613 <include buildfile="GetProjectVersion.include" />
6614 ]]>
6615 </code>
6616 </example>
6617 </member>
6618 <member name="F:NAnt.Core.Tasks.IncludeTask._includedFileNames">
6619 <summary>
6620 Used to check for recursived includes.
6621 </summary>
6622 </member>
6623 <member name="M:NAnt.Core.Tasks.IncludeTask.Initialize">
6624 <summary>
6625 Verifies parameters.
6626 </summary>
6627 </member>
6628 <member name="P:NAnt.Core.Tasks.IncludeTask.BuildFileName">
6629 <summary>
6630 Build file to include.
6631 </summary>
6632 </member>
6633 <member name="T:NAnt.Core.Tasks.LoadFileTask">
6634 <summary>
6635 Load a text file into a single property.
6636 </summary>
6637 <remarks>
6638 <para>
6639 Unless an encoding is specified, the encoding associated with the
6640 system's current ANSI code page is used.
6641 </para>
6642 <para>
6643 An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
6644 file is automatically recognized, if the file starts with the appropriate
6645 byte order marks.
6646 </para>
6647 </remarks>
6648 <example>
6649 <para>
6650 Load file <c>message.txt</c> into property "message".
6651 </para>
6652 <code>
6653 <![CDATA[
6654 <loadfile
6655 file="message.txt"
6656 property="message" />
6657 ]]>
6658 </code>
6659 </example>
6660 <example>
6661 <para>
6662 Load a file using the "latin-1" encoding.
6663 </para>
6664 <code>
6665 <![CDATA[
6666 <loadfile
6667 file="loadfile.xml"
6668 property="encoded-file"
6669 encoding="iso-8859-1" />
6670 ]]>
6671 </code>
6672 </example>
6673 <example>
6674 <para>
6675 Load a file, replacing all <c>@NOW@</c> tokens with the current
6676 date/time.
6677 </para>
6678 <code>
6679 <![CDATA[
6680 <loadfile file="token.txt" property="token-file">
6681 <filterchain>
6682 <replacetokens>
6683 <token key="NOW" value="${datetime::now()}" />
6684 </replacetokens>
6685 </filterchain>
6686 </loadfile>
6687 ]]>
6688 </code>
6689 </example>
6690 </member>
6691 <member name="P:NAnt.Core.Tasks.LoadFileTask.File">
6692 <summary>
6693 The file to load.
6694 </summary>
6695 </member>
6696 <member name="P:NAnt.Core.Tasks.LoadFileTask.Property">
6697 <summary>
6698 The name of the property to save the content to.
6699 </summary>
6700 </member>
6701 <member name="P:NAnt.Core.Tasks.LoadFileTask.Encoding">
6702 <summary>
6703 The encoding to use when loading the file. The default is the encoding
6704 associated with the system's current ANSI code page.
6705 </summary>
6706 </member>
6707 <member name="P:NAnt.Core.Tasks.LoadFileTask.FilterChain">
6708 <summary>
6709 The filterchain definition to use.
6710 </summary>
6711 </member>
6712 <member name="T:NAnt.Core.Tasks.LoadTasksTask">
6713 <summary>
6714 Loads tasks form a given assembly or all assemblies in a given directory
6715 or <see cref="T:NAnt.Core.Types.FileSet"/>.
6716 </summary>
6717 <example>
6718 <para>
6719 Load tasks from a single assembly.
6720 </para>
6721 <code>
6722 <![CDATA[
6723 <loadtasks assembly="c:foo\NAnt.Contrib.Tasks.dll" />
6724 ]]>
6725 </code>
6726 </example>
6727 <example>
6728 <para>
6729 Scan a single directory for task assemblies.
6730 </para>
6731 <code>
6732 <![CDATA[
6733 <loadtasks path="c:\foo" />
6734 ]]>
6735 </code>
6736 </example>
6737 <example>
6738 <para>
6739 Use a <see cref="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet"/> containing both a directory and an
6740 assembly.
6741 </para>
6742 <code>
6743 <![CDATA[
6744 <loadtasks>
6745 <fileset>
6746 <include name="C:\cvs\NAntContrib\build" />
6747 <include name="C:\cvs\NAntContrib\build\NAnt.Contrib.Tasks.dll" />
6748 </fileset>
6749 </loadtasks>
6750 ]]>
6751 </code>
6752 </example>
6753 </member>
6754 <member name="M:NAnt.Core.Tasks.LoadTasksTask.ExecuteTask">
6755 <summary>
6756 Executes the Load Tasks task.
6757 </summary>
6758 <exception cref="T:NAnt.Core.BuildException">Specified assembly or path does not exist.</exception>
6759 </member>
6760 <member name="M:NAnt.Core.Tasks.LoadTasksTask.Initialize">
6761 <summary>
6762 Validates the attributes.
6763 </summary>
6764 <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>
6765 </member>
6766 <member name="P:NAnt.Core.Tasks.LoadTasksTask.AssemblyPath">
6767 <summary>
6768 An assembly to load tasks from.
6769 </summary>
6770 </member>
6771 <member name="P:NAnt.Core.Tasks.LoadTasksTask.Path">
6772 <summary>
6773 A directory to scan for task assemblies.
6774 </summary>
6775 </member>
6776 <member name="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet">
6777 <summary>
6778 Used to select which directories or individual assemblies to scan.
6779 </summary>
6780 </member>
6781 <member name="T:NAnt.Core.Tasks.LoopTask">
6782 <summary>
6783 Loops over a set of items.
6784 </summary>
6785 <remarks>
6786 <para>
6787 Can loop over files in directory, lines in a file, etc.
6788 </para>
6789 <para>
6790 The property value is stored before the loop is done, and restored
6791 when the loop is finished.
6792 </para>
6793 <para>
6794 The property is returned to its normal value once it is used. Read-only
6795 parameters cannot be overridden in this loop.
6796 </para>
6797 </remarks>
6798 <example>
6799 <para>Loops over the files in <c>c:\</c>.</para>
6800 <code>
6801 <![CDATA[
6802 <foreach item="File" in="c:\" property="filename">
6803 <echo message="${filename}" />
6804 </foreach>
6805 ]]>
6806 </code>
6807 </example>
6808 <example>
6809 <para>Loops over all files in the project directory.</para>
6810 <code>
6811 <![CDATA[
6812 <foreach item="File" property="filename">
6813 <in>
6814 <items>
6815 <include name="**" />
6816 </items>
6817 </in>
6818 <do>
6819 <echo message="${filename}" />
6820 </do>
6821 </foreach>
6822 ]]>
6823 </code>
6824 </example>
6825 <example>
6826 <para>Loops over the folders in <c>c:\</c>.</para>
6827 <code>
6828 <![CDATA[
6829 <foreach item="Folder" in="c:\" property="foldername">
6830 <echo message="${foldername}" />
6831 </foreach>
6832 ]]>
6833 </code>
6834 </example>
6835 <example>
6836 <para>Loops over all folders in the project directory.</para>
6837 <code>
6838 <![CDATA[
6839 <foreach item="Folder" property="foldername">
6840 <in>
6841 <items>
6842 <include name="**" />
6843 </items>
6844 </in>
6845 <do>
6846 <echo message="${foldername}" />
6847 </do>
6848 </foreach>
6849 ]]>
6850 </code>
6851 </example>
6852 <example>
6853 <para>Loops over a list.</para>
6854 <code>
6855 <![CDATA[
6856 <foreach item="String" in="1 2,3" delim=" ," property="count">
6857 <echo message="${count}" />
6858 </foreach>
6859 ]]>
6860 </code>
6861 </example>
6862 <example>
6863 <para>
6864 Loops over lines in the file <c>properties.csv</c>, where each line
6865 is of the format name,value.
6866 </para>
6867 <code>
6868 <![CDATA[
6869 <foreach item="Line" in="properties.csv" delim="," property="x,y">
6870 <echo message="Read pair ${x}=${y}" />
6871 </foreach>
6872 ]]>
6873 </code>
6874 </example>
6875 </member>
6876 <member name="P:NAnt.Core.Tasks.LoopTask.Property">
6877 <summary>
6878 The NAnt property name(s) that should be used for the current
6879 iterated item.
6880 </summary>
6881 <remarks>
6882 If specifying multiple properties, separate them with a comma.
6883 </remarks>
6884 </member>
6885 <member name="P:NAnt.Core.Tasks.LoopTask.ItemType">
6886 <summary>
6887 The type of iteration that should be done.
6888 </summary>
6889 </member>
6890 <member name="P:NAnt.Core.Tasks.LoopTask.TrimType">
6891 <summary>
6892 The type of whitespace trimming that should be done. The default
6893 is <see cref="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None"/>.
6894 </summary>
6895 </member>
6896 <member name="P:NAnt.Core.Tasks.LoopTask.Source">
6897 <summary>
6898 The source of the iteration.
6899 </summary>
6900 </member>
6901 <member name="P:NAnt.Core.Tasks.LoopTask.Delimiter">
6902 <summary>
6903 The deliminator char.
6904 </summary>
6905 </member>
6906 <member name="P:NAnt.Core.Tasks.LoopTask.InElement">
6907 <summary>
6908 Stuff to operate in. Just like the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/>
6909 attribute, but supports more complicated things like a <see cref="T:NAnt.Core.Types.FileSet"/>
6910 and such.
6911 <note>
6912 Please remove the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/> attribute if you
6913 are using this element.
6914 </note>
6915 </summary>
6916 </member>
6917 <member name="P:NAnt.Core.Tasks.LoopTask.StuffToDo">
6918 <summary>
6919 Tasks to execute for each matching item.
6920 </summary>
6921 </member>
6922 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None">
6923 <summary>
6924 Do not remove any white space characters.
6925 </summary>
6926 </member>
6927 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.End">
6928 <summary>
6929 Remove all white space characters from the end of the current
6930 item.
6931 </summary>
6932 </member>
6933 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Start">
6934 <summary>
6935 Remove all white space characters from the beginning of the
6936 current item.
6937 </summary>
6938 </member>
6939 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Both">
6940 <summary>
6941 Remove all white space characters from the beginning and end of
6942 the current item.
6943 </summary>
6944 </member>
6945 <member name="T:NAnt.Core.Tasks.MailTask">
6946 <summary>
6947 Sends an SMTP message.
6948 </summary>
6949 <remarks>
6950 <para>
6951 Text and text files to include in the message body may be specified as
6952 well as binary attachments.
6953 </para>
6954 </remarks>
6955 <example>
6956 <para>
6957 Sends an email from <c>nant@sourceforge.net</c> to three recipients
6958 with a subject about the attachments. The body of the message will be
6959 the combined contents of all <c>.txt</c> files in the base directory.
6960 All zip files in the base directory will be included as attachments.
6961 The message will be sent using the <c>smtpserver.anywhere.com</c> SMTP
6962 server.
6963 </para>
6964 <code>
6965 <![CDATA[
6966 <mail
6967 from="nant@sourceforge.net"
6968 tolist="recipient1@sourceforge.net"
6969 cclist="recipient2@sourceforge.net"
6970 bcclist="recipient3@sourceforge.net"
6971 subject="Msg 7: With attachments"
6972 mailhost="smtpserver.anywhere.com">
6973 <files>
6974 <include name="*.txt" />
6975 </files>
6976 <attachments>
6977 <include name="*.zip" />
6978 </attachments>
6979 </mail>
6980 ]]>
6981 </code>
6982 </example>
6983 </member>
6984 <member name="M:NAnt.Core.Tasks.MailTask.Initialize">
6985 <summary>
6986 Initializes task and ensures the supplied attributes are valid.
6987 </summary>
6988 </member>
6989 <member name="M:NAnt.Core.Tasks.MailTask.ExecuteTask">
6990 <summary>
6991 This is where the work is done.
6992 </summary>
6993 </member>
6994 <member name="M:NAnt.Core.Tasks.MailTask.ReadFile(System.String)">
6995 <summary>
6996 Reads a text file and returns the content
6997 in a string.
6998 </summary>
6999 <param name="filename">The file to read content of.</param>
7000 <returns>
7001 The content of the specified file.
7002 </returns>
7003 </member>
7004 <member name="P:NAnt.Core.Tasks.MailTask.From">
7005 <summary>
7006 Email address of sender.
7007 </summary>
7008 </member>
7009 <member name="P:NAnt.Core.Tasks.MailTask.ToList">
7010 <summary>
7011 Semicolon-separated list of recipient email addresses.
7012 </summary>
7013 </member>
7014 <member name="P:NAnt.Core.Tasks.MailTask.CcList">
7015 <summary>
7016 Semicolon-separated list of CC: recipient email addresses.
7017 </summary>
7018 </member>
7019 <member name="P:NAnt.Core.Tasks.MailTask.BccList">
7020 <summary>
7021 Semicolon-separated list of BCC: recipient email addresses.
7022 </summary>
7023 </member>
7024 <member name="P:NAnt.Core.Tasks.MailTask.Mailhost">
7025 <summary>
7026 Host name of mail server. The default is <c>localhost</c>.
7027 </summary>
7028 </member>
7029 <member name="P:NAnt.Core.Tasks.MailTask.Message">
7030 <summary>
7031 Text to send in body of email message.
7032 </summary>
7033 </member>
7034 <member name="P:NAnt.Core.Tasks.MailTask.Subject">
7035 <summary>
7036 Text to send in subject line of email message.
7037 </summary>
7038 </member>
7039 <member name="P:NAnt.Core.Tasks.MailTask.Format">
7040 <summary>
7041 Format of the message. The default is <see cref="F:System.Web.Mail.MailFormat.Text"/>.
7042 </summary>
7043 </member>
7044 <member name="P:NAnt.Core.Tasks.MailTask.Files">
7045 <summary>
7046 Files that are transmitted as part of the body of the email message.
7047 </summary>
7048 </member>
7049 <member name="P:NAnt.Core.Tasks.MailTask.Attachments">
7050 <summary>
7051 Attachments that are transmitted with the message.
7052 </summary>
7053 </member>
7054 <member name="T:NAnt.Core.Tasks.MkDirTask">
7055 <summary>
7056 Creates a directory and any non-existent parent directory if necessary.
7057 </summary>
7058 <example>
7059 <para>Create the directory <c>build</c>.</para>
7060 <code>
7061 <![CDATA[
7062 <mkdir dir="build" />
7063 ]]>
7064 </code>
7065 </example>
7066 <example>
7067 <para>Create the directory tree <c>one/two/three</c>.</para>
7068 <code>
7069 <![CDATA[
7070 <mkdir dir="one/two/three" />
7071 ]]>
7072 </code>
7073 </example>
7074 </member>
7075 <member name="M:NAnt.Core.Tasks.MkDirTask.ExecuteTask">
7076 <summary>
7077 Creates the directory specified by the <see cref="P:NAnt.Core.Tasks.MkDirTask.Dir"/> property.
7078 </summary>
7079 <exception cref="T:NAnt.Core.BuildException">The directory could not be created.</exception>
7080 </member>
7081 <member name="P:NAnt.Core.Tasks.MkDirTask.Dir">
7082 <summary>
7083 The directory to create.
7084 </summary>
7085 </member>
7086 <member name="T:NAnt.Core.Tasks.MoveTask">
7087 <summary>
7088 Moves a file or set of files to a new file or directory.
7089 </summary>
7090 <remarks>
7091 <para>
7092 Files are only moved if the source file is newer than the destination
7093 file, or if the destination file does not exist. However, you can
7094 explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/>
7095 attribute.
7096 </para>
7097 <para>
7098 A <see cref="T:NAnt.Core.Types.FileSet"/> can be used to select files to move. To use
7099 a <see cref="T:NAnt.Core.Types.FileSet"/>, the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/>
7100 attribute must be set.
7101 </para>
7102 <h3>Encoding</h3>
7103 <para>
7104 Unless an encoding is specified, the encoding associated with the
7105 system's current ANSI code page is used.
7106 </para>
7107 <para>
7108 An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
7109 file is automatically recognized, if the file starts with the
7110 appropriate byte order marks.
7111 </para>
7112 <note>
7113 If you employ filters in your move operation, you should limit the
7114 move to text files. Binary files will be corrupted by the move
7115 operation.
7116 </note>
7117 </remarks>
7118 <example>
7119 <para>
7120 Move a single file while changing its encoding from "latin1" to
7121 "utf-8".
7122 </para>
7123 <code>
7124 <![CDATA[
7125 <move
7126 file="myfile.txt"
7127 tofile="mycopy.txt"
7128 inputencoding="latin1"
7129 outputencoding="utf-8" />
7130 ]]>
7131 </code>
7132 </example>
7133 <example>
7134 <para>Move a set of files.</para>
7135 <code>
7136 <![CDATA[
7137 <move todir="${build.dir}">
7138 <fileset basedir="bin">
7139 <include name="*.dll" />
7140 </fileset>
7141 </move>
7142 ]]>
7143 </code>
7144 </example>
7145 <example>
7146 <para>
7147 Move a set of files to a directory, replacing <c>@TITLE@</c> with
7148 "Foo Bar" in all files.
7149 </para>
7150 <code>
7151 <![CDATA[
7152 <move todir="../backup/dir">
7153 <fileset basedir="src_dir">
7154 <include name="**/*" />
7155 </fileset>
7156 <filterchain>
7157 <replacetokens>
7158 <token key="TITLE" value="Foo Bar" />
7159 </replacetokens>
7160 </filterchain>
7161 </move>
7162 ]]>
7163 </code>
7164 </example>
7165 </member>
7166 <member name="M:NAnt.Core.Tasks.MoveTask.DoFileOperations">
7167 <summary>
7168 Actually does the file moves.
7169 </summary>
7170 </member>
7171 <member name="P:NAnt.Core.Tasks.MoveTask.SourceFile">
7172 <summary>
7173 The file to move.
7174 </summary>
7175 </member>
7176 <member name="P:NAnt.Core.Tasks.MoveTask.ToFile">
7177 <summary>
7178 The file to move to.
7179 </summary>
7180 </member>
7181 <member name="P:NAnt.Core.Tasks.MoveTask.ToDirectory">
7182 <summary>
7183 The directory to move to.
7184 </summary>
7185 </member>
7186 <member name="P:NAnt.Core.Tasks.MoveTask.CopyFileSet">
7187 <summary>
7188 Used to select the files to move. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
7189 the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/> attribute must be set.
7190 </summary>
7191 </member>
7192 <member name="P:NAnt.Core.Tasks.MoveTask.Flatten">
7193 <summary>
7194 Ignore directory structure of source directory, move all files into
7195 a single directory, specified by the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/>
7196 attribute. The default is <see langword="false"/>.
7197 </summary>
7198 </member>
7199 <member name="P:NAnt.Core.Tasks.MoveTask.Filters">
7200 <summary>
7201 Chain of filters used to alter the file's content as it is moved.
7202 </summary>
7203 </member>
7204 <member name="T:NAnt.Core.Tasks.NAntSchemaTask">
7205 <summary>
7206 Creates an XSD File for all available tasks.
7207 </summary>
7208 <remarks>
7209 <para>
7210 This can be used in conjuntion with the command-line option to do XSD
7211 Schema validation on the build file.
7212 </para>
7213 </remarks>
7214 <example>
7215 <para>Creates a <c>NAnt.xsd</c> file in the current project directory.</para>
7216 <code>
7217 <![CDATA[
7218 <nantschema output="NAnt.xsd" />
7219 ]]>
7220 </code>
7221 </example>
7222 </member>
7223 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.WriteSchema(System.IO.Stream,System.Type[],System.Type[],System.String)">
7224 <summary>
7225 Creates a NAnt Schema for given types
7226 </summary>
7227 <param name="stream">The output stream to save the schema to. If <see langword="null" />, writing is ignored, no exception generated.</param>
7228 <param name="tasks">The list of tasks to generate XML Schema for.</param>
7229 <param name="dataTypes">The list of datatypes to generate XML Schema for.</param>
7230 <param name="targetNS">The target namespace to output.</param>
7231 <returns>The new NAnt Schema.</returns>
7232 </member>
7233 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdAttribute(System.String,System.Boolean)">
7234 <summary>
7235 Creates a new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.
7236 </summary>
7237 <param name="name">The name of the attribute.</param>
7238 <param name="required">Value indicating whether the attribute should be required.</param>
7239 <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.</returns>
7240 </member>
7241 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdSequence(System.Decimal,System.Decimal)">
7242 <summary>
7243 Creates a new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.
7244 </summary>
7245 <param name="min">The minimum value to allow for this choice</param>
7246 <param name="max">The maximum value to allow, Decimal.MaxValue sets it to 'unbound'</param>
7247 <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.</returns>
7248 </member>
7249 <member name="P:NAnt.Core.Tasks.NAntSchemaTask.OutputFile">
7250 <summary>
7251 The name of the output file to which the XSD should be written.
7252 </summary>
7253 </member>
7254 <member name="P:NAnt.Core.Tasks.NAntSchemaTask.TargetNamespace">
7255 <summary>
7256 The target namespace for the output. Defaults to "http://tempuri.org/nant-donotuse.xsd"
7257 </summary>
7258 </member>
7259 <member name="P:NAnt.Core.Tasks.NAntSchemaTask.ForType">
7260 <summary>
7261 The <see cref="T:System.Type"/> for which an XSD should be created. If not
7262 specified, an XSD will be created for all available tasks.
7263 </summary>
7264 </member>
7265 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator.#ctor(System.Type[],System.Type[],System.String)">
7266 <summary>
7267 Creates a new instance of the <see cref="T:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator"/>
7268 class.
7269 </summary>
7270 <param name="tasks">Tasks for which a schema should be generated.</param>
7271 <param name="dataTypes">Data Types for which a schema should be generated.</param>
7272 <param name="targetNS">The namespace to use.
7273 <example> http://tempuri.org/nant.xsd </example>
7274 </param>
7275 </member>
7276 <member name="T:NAnt.Core.Tasks.NAntTask">
7277 <summary>
7278 Runs NAnt on a supplied build file, or a set of build files.
7279 </summary>
7280 <remarks>
7281 <para>
7282 By default, all the properties of the current project will be available
7283 in the new project. Alternatively, you can set <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>
7284 to <see langword="false"/> to not copy any properties to the new
7285 project.
7286 </para>
7287 <para>
7288 You can also set properties in the new project from the old project by
7289 using nested property tags. These properties are always passed to the
7290 new project regardless of the setting of <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>.
7291 This allows you to parameterize your subprojects.
7292 </para>
7293 <para>
7294 References to data types can also be passed to the new project, but by
7295 default they are not. If you set the <see cref="P:NAnt.Core.Tasks.NAntTask.InheritRefs"/> to
7296 <see langword="true"/>, all references will be copied.
7297 </para>
7298 </remarks>
7299 <example>
7300 <para>
7301 Build a project located in a different directory if the <c>debug</c>
7302 property is not <see langword="true"/>.
7303 </para>
7304 <code>
7305 <![CDATA[
7306 <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build" unless="${debug}" />
7307 ]]>
7308 </code>
7309 </example>
7310 <example>
7311 <para>
7312 Build a project while adding a set of properties to that project.
7313 </para>
7314 <code>
7315 <![CDATA[
7316 <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build">
7317 <properties>
7318 <property name="build.dir" value="c:/buildserver" />
7319 <property name="build.debug" value="false" />
7320 <property name="lib.dir" value="c:/shared/lib" readonly="true" />
7321 </properties>
7322 </nant>
7323 ]]>
7324 </code>
7325 </example>
7326 <example>
7327 <para>
7328 Build all projects named <c>default.build</c> located anywhere under
7329 the project base directory.
7330 </para>
7331 <code>
7332 <![CDATA[
7333 <nant>
7334 <buildfiles>
7335 <include name="**/default.build" />
7336 <!-- avoid recursive execution of current build file -->
7337 <exclude name="${project::get-buildfile-path()}" />
7338 </buildfiles>
7339 </nant>
7340 ]]>
7341 </code>
7342 </example>
7343 </member>
7344 <member name="M:NAnt.Core.Tasks.NAntTask.Initialize">
7345 <summary>
7346 Validates the <see cref="T:NAnt.Core.Tasks.NAntTask"/> element.
7347 </summary>
7348 </member>
7349 <member name="P:NAnt.Core.Tasks.NAntTask.BuildFile">
7350 <summary>
7351 The build file to build.
7352 </summary>
7353 </member>
7354 <member name="P:NAnt.Core.Tasks.NAntTask.DefaultTarget">
7355 <summary>
7356 The target to execute. To specify more than one target seperate
7357 targets with a space. Targets are executed in order if possible.
7358 The default is to use target specified in the project's default
7359 attribute.
7360 </summary>
7361 </member>
7362 <member name="P:NAnt.Core.Tasks.NAntTask.BuildFiles">
7363 <summary>
7364 Used to specify a set of build files to process.
7365 </summary>
7366 </member>
7367 <member name="P:NAnt.Core.Tasks.NAntTask.InheritAll">
7368 <summary>
7369 Specifies whether current property values should be inherited by
7370 the executed project. The default is <see langword="true" />.
7371 </summary>
7372 </member>
7373 <member name="P:NAnt.Core.Tasks.NAntTask.InheritRefs">
7374 <summary>
7375 Specifies whether all references will be copied to the new project.
7376 The default is <see langword="false" />.
7377 </summary>
7378 </member>
7379 <member name="P:NAnt.Core.Tasks.NAntTask.OverrideProperties">
7380 <summary>
7381 Specifies a collection of properties that should be created in the
7382 executed project. Note, existing properties with identical names
7383 that are not read-only will be overwritten.
7384 </summary>
7385 </member>
7386 <member name="T:NAnt.Core.Tasks.PropertyTask">
7387 <summary>
7388 Sets a property in the current project.
7389 </summary>
7390 <remarks>
7391 <note>NAnt uses a number of predefined properties.</note>
7392 </remarks>
7393 <example>
7394 <para>
7395 Define a <c>debug</c> property with value <see langword="true" />.
7396 </para>
7397 <code>
7398 <![CDATA[
7399 <property name="debug" value="true" />
7400 ]]>
7401 </code>
7402 </example>
7403 <example>
7404 <para>
7405 Use the user-defined <c>debug</c> property.
7406 </para>
7407 <code>
7408 <![CDATA[
7409 <property name="trace" value="${debug}" />
7410 ]]>
7411 </code>
7412 </example>
7413 <example>
7414 <para>
7415 Define a read-only property. This is just like passing in the param
7416 on the command line.
7417 </para>
7418 <code>
7419 <![CDATA[
7420 <property name="do_not_touch_ME" value="hammer" readonly="true" />
7421 ]]>
7422 </code>
7423 </example>
7424 <example>
7425 <para>
7426 Define a property, but do not overwrite the value if the property already exists (eg. it was specified on the command line).
7427 </para>
7428 <code>
7429 <![CDATA[
7430 <project name="property-example">
7431 <property name="debug" value="true" overwrite="false" />
7432 <echo message="debug: ${debug}" />
7433 </project>
7434 ]]>
7435 </code>
7436 <para>
7437 Executing this build file with the command line option <c>-D:debug=false</c>,
7438 would cause the value specified on the command line to remain unaltered.
7439 </para>
7440 <code>
7441 <![CDATA[
7442 [echo] debug: false
7443 ]]>
7444 </code>
7445 </example>
7446 </member>
7447 <member name="P:NAnt.Core.Tasks.PropertyTask.PropertyName">
7448 <summary>
7449 The name of the NAnt property to set.
7450 </summary>
7451 </member>
7452 <member name="P:NAnt.Core.Tasks.PropertyTask.Value">
7453 <summary>
7454 The value to assign to the NAnt property.
7455 </summary>
7456 </member>
7457 <member name="P:NAnt.Core.Tasks.PropertyTask.ReadOnly">
7458 <summary>
7459 Specifies whether the property is read-only or not.
7460 The default is <see langword="false" />.
7461 </summary>
7462 </member>
7463 <member name="P:NAnt.Core.Tasks.PropertyTask.Dynamic">
7464 <summary>
7465 Specifies whether references to other properties should not be
7466 expanded when the value of the property is set, but expanded when
7467 the property is actually used. By default, properties will be
7468 expanded when set.
7469 </summary>
7470 </member>
7471 <member name="P:NAnt.Core.Tasks.PropertyTask.Overwrite">
7472 <summary>
7473 Specifies whether the value of a property should be overwritten if
7474 the property already exists (unless the property is read-only).
7475 The default is <see langword="true" />.
7476 </summary>
7477 </member>
7478 <member name="T:NAnt.Core.Tasks.RegexTask">
7479 <summary>
7480 Sets project properties based on the evaluatuion of a regular expression.
7481 </summary>
7482 <remarks>
7483 <para>
7484 The <see cref="P:NAnt.Core.Tasks.RegexTask.Pattern"/> attribute must contain one or more
7485 <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpcongroupingconstructs.asp">
7486 named grouping constructs</see>, which represents the names of the
7487 properties to be set. These named grouping constructs can be enclosed
7488 by angle brackets (?<name>) or single quotes (?'name').
7489 </para>
7490 <note>
7491 In the build file, use the XML element <![CDATA[<]]> to specify <,
7492 and <![CDATA[>]]> to specify >.
7493 </note>
7494 <note>
7495 The named grouping construct must not contain any punctuation and it
7496 cannot begin with a number.
7497 </note>
7498 </remarks>
7499 <example>
7500 <para>
7501 Find the last word in the given string and stores it in the property
7502 <c>lastword</c>.
7503 </para>
7504 <code>
7505 <![CDATA[
7506 <regex pattern="(?'lastword'\w+)$" input="This is a test sentence" />
7507 <echo message="${lastword}" />
7508 ]]>
7509 </code>
7510 </example>
7511 <example>
7512 <para>
7513 Split the full filename and extension of a filename.
7514 </para>
7515 <code>
7516 <![CDATA[
7517 <regex pattern="^(?'filename'.*)\.(?'extension'\w+)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" />
7518 ]]>
7519 </code>
7520 </example>
7521 <example>
7522 <para>
7523 Split the path and the filename. (This checks for <c>/</c> or <c>\</c>
7524 as the path separator).
7525 </para>
7526 <code>
7527 <![CDATA[
7528 <regex pattern="^(?'path'.*(\\|/)|(/|\\))(?'file'.*)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" />
7529 ]]>
7530 </code>
7531 <para>
7532 Results in path=<c>d:\Temp\SomeDir\SomeDir\</c> and file=<c>bla.xml</c>.
7533 </para>
7534 </example>
7535 </member>
7536 <member name="M:NAnt.Core.Tasks.RegexTask.ExecuteTask">
7537 <summary>
7538 Executes the task.
7539 </summary>
7540 </member>
7541 <member name="P:NAnt.Core.Tasks.RegexTask.Pattern">
7542 <summary>
7543 Represents the regular expression to be evalued.
7544 </summary>
7545 <value>
7546 The regular expression to be evalued.
7547 </value>
7548 <remarks>
7549 The pattern must contain one or more named constructs, which may
7550 not contain any punctuation and cannot begin with a number.
7551 </remarks>
7552 </member>
7553 <member name="P:NAnt.Core.Tasks.RegexTask.Options">
7554 <summary>
7555 A comma separated list of options to pass to the regex engine. The
7556 default is <see cref="F:System.Text.RegularExpressions.RegexOptions.None"/>.
7557 </summary>
7558 </member>
7559 <member name="P:NAnt.Core.Tasks.RegexTask.Input">
7560 <summary>
7561 Represents the input for the regular expression.
7562 </summary>
7563 <value>
7564 The input for the regular expression.
7565 </value>
7566 </member>
7567 <member name="T:NAnt.Core.Tasks.SetEnvTask">
7568 <summary>
7569 Sets an environment variable or a whole collection of them. Use an empty
7570 <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute to clear a variable.
7571 </summary>
7572 <remarks>
7573 <note>
7574 Variables will be set for the current NAnt process and all child
7575 processes that NAnt spawns (compilers, shell tools, etc). If the
7576 intention is to only set a variable for a single child process, then
7577 using the <see cref="T:NAnt.Core.Tasks.ExecTask"/> and its nested <see cref="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet"/>
7578 element might be a better option.
7579 </note>
7580 <note>
7581 Expansion of inline environment variables is performed using the syntax
7582 of the current platform. So on Windows platforms using the string %PATH%
7583 in the <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute will result in the value of
7584 the PATH variable being expanded in place before the variable is set.
7585 </note>
7586 </remarks>
7587 <example>
7588 <para>Set the MONO_PATH environment variable on a *nix platform.</para>
7589 <code>
7590 <![CDATA[
7591 <setenv name=="MONO_PATH" value="/home/jimbob/dev/foo:%MONO_PATH%"/>
7592 ]]>
7593 </code>
7594 </example>
7595 <example>
7596 <para>Set a collection of environment variables. Note the nested variable used to set var3.</para>
7597 <code>
7598 <![CDATA[
7599 <setenv>
7600 <variable name="var1" value="value2" />
7601 <variable name="var2" value="value2" />
7602 <variable name="var3" value="value3:%var2%" />
7603 </setenv>
7604 ]]>
7605 </code>
7606 </example>
7607 <example>
7608 <para>Set environment variables using nested path elements.</para>
7609 <code>
7610 <![CDATA[
7611 <path id="build.path">
7612 <pathelement dir="c:/windows" />
7613 <pathelement dir="c:/cygwin/usr/local/bin" />
7614 </path>
7615 <setenv>
7616 <variable name="build_path" >
7617 <path refid="build.path" />
7618 </variable>
7619 <variable name="path2">
7620 <path>
7621 <pathelement dir="c:/windows" />
7622 <pathelement dir="c:/cygwin/usr/local/bin" />
7623 </path>
7624 </variable>
7625 </setenv>
7626 ]]>
7627 </code>
7628 </example>
7629 </member>
7630 <member name="M:NAnt.Core.Tasks.SetEnvTask.SetEnvironmentVariable(System.String,System.String)">
7631 <summary>
7632 Win32 DllImport for the SetEnvironmentVariable function.
7633 </summary>
7634 <param name="lpName"></param>
7635 <param name="lpValue"></param>
7636 <returns></returns>
7637 </member>
7638 <member name="M:NAnt.Core.Tasks.SetEnvTask.setenv(System.String,System.String,System.Int32)">
7639 <summary>
7640 *nix dllimport for the setenv function.
7641 </summary>
7642 <param name="name"></param>
7643 <param name="value"></param>
7644 <param name="overwrite"></param>
7645 <returns>
7646 <c>0</c> if the execution is successful; otherwise, <c>-1</c>.
7647 </returns>
7648 </member>
7649 <member name="M:NAnt.Core.Tasks.SetEnvTask.unsetenv(System.String)">
7650 <summary>
7651 Deletes all instances of the variable name.
7652 </summary>
7653 <param name="name">The variable to unset.</param>
7654 <returns>
7655 <c>0</c> if the execution is successful; otherwise, <c>-1</c>.
7656 </returns>
7657 </member>
7658 <member name="M:NAnt.Core.Tasks.SetEnvTask.Initialize">
7659 <summary>
7660 Checks whether the task is initialized with valid attributes.
7661 </summary>
7662 </member>
7663 <member name="M:NAnt.Core.Tasks.SetEnvTask.ExecuteTask">
7664 <summary>
7665 Set the environment variables
7666 </summary>
7667 </member>
7668 <member name="M:NAnt.Core.Tasks.SetEnvTask.SetSingleEnvironmentVariable(System.String,System.String)">
7669 <summary>
7670 Do the actual work here.
7671 </summary>
7672 <param name="name">The name of the environment variable.</param>
7673 <param name="value">The value of the environment variable.</param>
7674 </member>
7675 <member name="P:NAnt.Core.Tasks.SetEnvTask.EnvName">
7676 <summary>
7677 The name of a single Environment variable to set
7678 </summary>
7679 </member>
7680 <member name="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue">
7681 <summary>
7682 The literal value for the environment variable.
7683 </summary>
7684 </member>
7685 <member name="P:NAnt.Core.Tasks.SetEnvTask.File">
7686 <summary>
7687 The value for a file-based environment variable. NAnt will convert
7688 it to an absolute filename.
7689 </summary>
7690 </member>
7691 <member name="P:NAnt.Core.Tasks.SetEnvTask.Directory">
7692 <summary>
7693 The value for a directory-based environment variable. NAnt will
7694 convert it to an absolute path.
7695 </summary>
7696 </member>
7697 <member name="P:NAnt.Core.Tasks.SetEnvTask.Path">
7698 <summary>
7699 The value for a PATH like environment variable. You can use
7700 <c>:</c> or <c>;</c> as path separators and NAnt will convert it to
7701 the platform's local conventions.
7702 </summary>
7703 </member>
7704 <member name="T:NAnt.Core.Tasks.SleepTask">
7705 <summary>
7706 A task for sleeping a specified period of time, useful when a build or deployment process
7707 requires an interval between tasks.
7708 </summary>
7709 <example>
7710 <para>Sleep 1 hour, 2 minutes, 3 seconds and 4 milliseconds.</para>
7711 <code>
7712 <![CDATA[
7713 <sleep hours="1" minutes="2" seconds="3" milliseconds="4" />
7714 ]]>
7715 </code>
7716 </example>
7717 <example>
7718 <para>Sleep 123 milliseconds.</para>
7719 <code>
7720 <![CDATA[
7721 <sleep milliseconds="123" />
7722 ]]>
7723 </code>
7724 </example>
7725 </member>
7726 <member name="M:NAnt.Core.Tasks.SleepTask.Initialize">
7727 <summary>
7728 Verify parameters.
7729 </summary>
7730 </member>
7731 <member name="M:NAnt.Core.Tasks.SleepTask.GetSleepTime">
7732 <summary>
7733 Return time to sleep.
7734 </summary>
7735 </member>
7736 <member name="M:NAnt.Core.Tasks.SleepTask.DoSleep(System.Int32)">
7737 <summary>
7738 Sleeps for the specified number of milliseconds.
7739 </summary>
7740 <param name="millis">Number of milliseconds to sleep.</param>
7741 </member>
7742 <member name="P:NAnt.Core.Tasks.SleepTask.Hours">
7743 <summary>
7744 Hours to add to the sleep time.
7745 </summary>
7746 </member>
7747 <member name="P:NAnt.Core.Tasks.SleepTask.Minutes">
7748 <summary>
7749 Minutes to add to the sleep time.
7750 </summary>
7751 </member>
7752 <member name="P:NAnt.Core.Tasks.SleepTask.Seconds">
7753 <summary>
7754 Seconds to add to the sleep time.
7755 </summary>
7756 </member>
7757 <member name="P:NAnt.Core.Tasks.SleepTask.Milliseconds">
7758 <summary>
7759 Milliseconds to add to the sleep time.
7760 </summary>
7761 </member>
7762 <member name="T:NAnt.Core.Tasks.StyleTask">
7763 <summary>
7764 Processes a document via XSLT.
7765 </summary>
7766 <example>
7767 <para>Create a report in HTML.</para>
7768 <code>
7769 <![CDATA[
7770 <style style="report.xsl" in="data.xml" out="report.html" />
7771 ]]>
7772 </code>
7773 </example>
7774 <example>
7775 <para>Create a report in HTML, with a param.</para>
7776 <code>
7777 <![CDATA[
7778 <style style="report.xsl" in="data.xml" out="report.html">
7779 <parameters>
7780 <parameter name="reportType" namespaceuri="" value="Plain" />
7781 </parameters>
7782 </style>
7783 ]]>
7784 </code>
7785 </example>
7786 <example>
7787 <para>Create a report in HTML, with a expanded param.</para>
7788 <code>
7789 <![CDATA[
7790 <style style="report.xsl" in="data.xml" out="report.html">
7791 <parameters>
7792 <parameter name="reportType" namespaceuri="" value="${report.type}" />
7793 </parameters>
7794 </style>
7795 ]]>
7796 </code>
7797 </example>
7798 <example>
7799 <para>Create some code based on a directory of templates.</para>
7800 <code>
7801 <![CDATA[
7802 <style style="CodeGenerator.xsl" extension="java">
7803 <infiles>
7804 <include name="*.xml" />
7805 </infiles>
7806 <parameters>
7807 <parameter name="reportType" namespaceuri="" value="Plain" if="${report.plain}" />
7808 </parameters>
7809 <style>
7810 ]]>
7811 </code>
7812 </example>
7813 <example>
7814 <para>Create a report in HTML, with an extension object.</para>
7815 <code>
7816 <![CDATA[
7817 <style style="report.xsl" in="data.xml" out="report.html">
7818 <extensionobjects>
7819 <extensionobject namespaceuri="urn:Formatter" typename="XsltExtensionObjects.Formatter" assembly="XsltExtensionObjects.dll" />
7820 </extensionobjects>
7821 </style>
7822 ]]>
7823 </code>
7824 </example>
7825 </member>
7826 <member name="P:NAnt.Core.Tasks.StyleTask.DestDir">
7827 <summary>
7828 Directory in which to store the results. The default is the project
7829 base directory.
7830 </summary>
7831 </member>
7832 <member name="P:NAnt.Core.Tasks.StyleTask.Extension">
7833 <summary>
7834 Desired file extension to be used for the targets. The default is
7835 <c>html</c>.
7836 </summary>
7837 </member>
7838 <member name="P:NAnt.Core.Tasks.StyleTask.XsltFile">
7839 <summary>
7840 URI or path that points to the stylesheet to use. If given as path, it can
7841 be relative to the project's basedir or absolute.
7842 </summary>
7843 </member>
7844 <member name="P:NAnt.Core.Tasks.StyleTask.SrcFile">
7845 <summary>
7846 Specifies a single XML document to be styled. Should be used with
7847 the <see cref="P:NAnt.Core.Tasks.StyleTask.OutputFile"/> attribute.
7848 </summary>
7849 </member>
7850 <member name="P:NAnt.Core.Tasks.StyleTask.OutputFile">
7851 <summary>
7852 Specifies the output name for the styled result from the <see cref="P:NAnt.Core.Tasks.StyleTask.SrcFile"/>
7853 attribute.
7854 </summary>
7855 </member>
7856 <member name="P:NAnt.Core.Tasks.StyleTask.InFiles">
7857 <summary>
7858 Specifies a group of input files to which to apply the stylesheet.
7859 </summary>
7860 </member>
7861 <member name="P:NAnt.Core.Tasks.StyleTask.Parameters">
7862 <summary>
7863 XSLT parameters to be passed to the XSLT transformation.
7864 </summary>
7865 </member>
7866 <member name="P:NAnt.Core.Tasks.StyleTask.ExtensionObjects">
7867 <summary>
7868 XSLT extension objects to be passed to the XSLT transformation.
7869 </summary>
7870 </member>
7871 <member name="P:NAnt.Core.Tasks.StyleTask.Proxy">
7872 <summary>
7873 The network proxy to use to access the Internet resource.
7874 </summary>
7875 </member>
7876 <member name="T:NAnt.Core.Tasks.SysInfoTask">
7877 <summary>
7878 Sets properties with system information.
7879 </summary>
7880 <remarks>
7881 <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>
7882 <list type="table">
7883 <listheader>
7884 <term>Property</term>
7885 <description>Value</description>
7886 </listheader>
7887 <item>
7888 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.clr.version</term>
7889 <description>Common Language Runtime version number.</description>
7890 </item>
7891 <item>
7892 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.env.*</term>
7893 <description>Environment variables (e.g., <<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.env.PATH).</description>
7894 </item>
7895 <item>
7896 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.platform</term>
7897 <description>Operating system platform ID.</description>
7898 </item>
7899 <item>
7900 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.version</term>
7901 <description>Operating system version.</description>
7902 </item>
7903 <item>
7904 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os</term>
7905 <description>Operating system version string.</description>
7906 </item>
7907 <item>
7908 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.applicationdata</term>
7909 <description>The directory that serves as a common repository for application-specific data for the current roaming user.</description>
7910 </item>
7911 <item>
7912 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.commonapplicationdata</term>
7913 <description>The directory that serves as a common repository for application-specific data that is used by all users.</description>
7914 </item>
7915 <item>
7916 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.commonprogramfiles</term>
7917 <description>The directory for components that are shared across applications.</description>
7918 </item>
7919 <item>
7920 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.desktopdirectory</term>
7921 <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>
7922 </item>
7923 <item>
7924 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.programfiles</term>
7925 <description>The Program Files directory.</description>
7926 </item>
7927 <item>
7928 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.system</term>
7929 <description>The System directory.</description>
7930 </item>
7931 <item>
7932 <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.temp</term>
7933 <description>The temporary directory.</description>
7934 </item>
7935 </list>
7936 <para>
7937 When the name of an environment variable is not a valid property name,
7938 the task will fail. In that case, set <see cref="P:NAnt.Core.Task.FailOnError"/> to
7939 <see langword="true"/> to allow that environment variable to be
7940 skipped.
7941 </para>
7942 <note>
7943 we advise you to use the following functions instead:
7944 </note>
7945 <list type="table">
7946 <listheader>
7947 <term>Function</term>
7948 <description>Description</description>
7949 </listheader>
7950 <item>
7951 <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/></term>
7952 <description>Gets a <see cref="T:System.OperatingSystem"/> object that identifies this operating system.</description>
7953 </item>
7954 <item>
7955 <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)"/></term>
7956 <description>Gets the path to a system special folder.</description>
7957 </item>
7958 <item>
7959 <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)"/></term>
7960 <description>Returns the value of a environment variable.</description>
7961 </item>
7962 <item>
7963 <term><see cref="M:NAnt.Core.Functions.PathFunctions.GetTempPath"/></term>
7964 <description>Gets the path to the temporary directory.</description>
7965 </item>
7966 <item>
7967 <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/></term>
7968 <description>Gets the Common Language Runtime version.</description>
7969 </item>
7970 </list>
7971 </remarks>
7972 <example>
7973 <para>Register the properties with the default property prefix.</para>
7974 <code>
7975 <![CDATA[
7976 <sysinfo />
7977 ]]>
7978 </code>
7979 </example>
7980 <example>
7981 <para>Register the properties without a prefix.</para>
7982 <code>
7983 <![CDATA[
7984 <sysinfo prefix="" />
7985 ]]>
7986 </code>
7987 </example>
7988 <example>
7989 <para>Register properties and display a summary.</para>
7990 <code>
7991 <![CDATA[
7992 <sysinfo verbose="true" />
7993 ]]>
7994 </code>
7995 </example>
7996 </member>
7997 <member name="P:NAnt.Core.Tasks.SysInfoTask.Prefix">
7998 <summary>
7999 The string to prefix the property names with. The default is "sys.".
8000 </summary>
8001 </member>
8002 <member name="T:NAnt.Core.Tasks.TouchTask">
8003 <summary>
8004 Touches a file or set of files -- corresponds to the Unix touch command.
8005 </summary>
8006 <remarks>
8007 <para>
8008 If the file specified does not exist, the task will create it.
8009 </para>
8010 </remarks>
8011 <example>
8012 <para>Touch the <c>Main.cs</c> file. The current time is used.</para>
8013 <code>
8014 <![CDATA[
8015 <touch file="Main.cs" />
8016 ]]>
8017 </code>
8018 </example>
8019 <example>
8020 <para>
8021 Touch all executable files in the project base directory and its
8022 subdirectories.
8023 </para>
8024 <code>
8025 <![CDATA[
8026 <touch>
8027 <fileset>
8028 <include name="**/*.exe" />
8029 <include name="**/*.dll" />
8030 </fileset>
8031 </touch>
8032 ]]>
8033 </code>
8034 </example>
8035 </member>
8036 <member name="M:NAnt.Core.Tasks.TouchTask.Initialize">
8037 <summary>
8038 Ensures the supplied attributes are valid.
8039 </summary>
8040 </member>
8041 <member name="P:NAnt.Core.Tasks.TouchTask.File">
8042 <summary>
8043 The file to touch.
8044 </summary>
8045 </member>
8046 <member name="P:NAnt.Core.Tasks.TouchTask.Millis">
8047 <summary>
8048 Specifies the new modification time of the file(s) in milliseconds
8049 since midnight Jan 1 1970.
8050 </summary>
8051 </member>
8052 <member name="P:NAnt.Core.Tasks.TouchTask.Datetime">
8053 <summary>
8054 Specifies the new modification time of the file in the format
8055 MM/DD/YYYY HH:MM:SS.
8056 </summary>
8057 </member>
8058 <member name="P:NAnt.Core.Tasks.TouchTask.TouchFileSet">
8059 <summary>
8060 Used to select files that should be touched.
8061 </summary>
8062 </member>
8063 <member name="T:NAnt.Core.Tasks.TStampTask">
8064 <summary>
8065 Sets properties with the current date and time.
8066 </summary>
8067 <remarks>
8068 <para>
8069 By default the <see cref="T:NAnt.Core.Tasks.TStampTask"/> displays the current date
8070 and time and sets the following properties:
8071 </para>
8072 <list type="bullet">
8073 <item><description>tstamp.date to yyyyMMdd</description></item>
8074 <item><description>tstamp.time to HHmm</description></item>
8075 <item><description>tstamp.now using the default DateTime.ToString() method</description></item>
8076 </list>
8077 <para>
8078 To set an additional property with a custom date/time use the
8079 <see cref="P:NAnt.Core.Tasks.TStampTask.Property"/> and <see cref="P:NAnt.Core.Tasks.TStampTask.Pattern"/> attributes.
8080 To set a number of additional properties with the exact same date and
8081 time use the <see cref="P:NAnt.Core.Tasks.TStampTask.Formatters"/> nested element (see example).
8082 </para>
8083 <para>
8084 The date and time string displayed by the <see cref="T:NAnt.Core.Tasks.TStampTask"/>
8085 uses the computer's default long date and time string format. You
8086 might consider setting these to the
8087 <see href="http://www.cl.cam.ac.uk/~mgk25/iso-time.html">ISO 8601 standard
8088 for date and time notation</see>.
8089 </para>
8090 </remarks>
8091 <example>
8092 <para>Set the <c>build.date</c> property.</para>
8093 <code>
8094 <![CDATA[
8095 <tstamp property="build.date" pattern="yyyyMMdd" verbose="true" />
8096 ]]>
8097 </code>
8098 </example>
8099 <example>
8100 <para>Set a number of properties for Ant like compatibility.</para>
8101 <code>
8102 <![CDATA[
8103 <tstamp verbose="true">
8104 <formatter property="TODAY" pattern="dd MMM yyyy"/>
8105 <formatter property="DSTAMP" pattern="yyyyMMdd" unless="${date.not.needed}" />
8106 <formatter property="TSTAMP" pattern="HHmm" if="${need.hours}" />
8107 </tstamp>
8108 ]]>
8109 </code>
8110 </example>
8111 </member>
8112 <member name="P:NAnt.Core.Tasks.TStampTask.Property">
8113 <summary>
8114 The property to receive the date/time string in the given pattern.
8115 </summary>
8116 </member>
8117 <member name="P:NAnt.Core.Tasks.TStampTask.Pattern">
8118 <summary>The date/time pattern to be used.</summary>
8119 <remarks>
8120 <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>
8121 <list type="table">
8122 <listheader>
8123 <description>Format Character</description>
8124 <description>Description Example Format Pattern (en-US)</description>
8125 </listheader>
8126 <item><description>d</description><description>MM/dd/yyyy</description></item>
8127 <item><description>D</description><description>dddd, dd MMMM yyyy</description></item>
8128 <item><description>f</description><description>dddd, dd MMMM yyyy HH:mm</description></item>
8129 <item><description>F</description><description>dddd, dd MMMM yyyy HH:mm:ss</description></item>
8130 <item><description>g</description><description>MM/dd/yyyy HH:mm</description></item>
8131 <item><description>G</description><description>MM/dd/yyyy HH:mm:ss</description></item>
8132 <item><description>m, M</description><description>MMMM dd</description></item>
8133 <item><description>r, R</description><description>ddd, dd MMM yyyy HH':'mm':'ss 'GMT'</description></item>
8134 <item><description>s</description><description>yyyy'-'MM'-'dd'T'HH':'mm':'ss</description></item>
8135 <item><description>t</description><description>HH:mm</description></item>
8136 <item><description>T</description><description>HH:mm:ss</description></item>
8137 <item><description>u</description><description>yyyy'-'MM'-'dd HH':'mm':'ss'Z'</description></item>
8138 <item><description>U</description><description>dddd, dd MMMM yyyy HH:mm:ss</description></item>
8139 <item><description>y, Y</description><description>yyyy MMMM</description></item>
8140 </list>
8141 <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>
8142 <list type="table">
8143 <listheader>
8144 <description>Format</description>
8145 <description>Pattern Description</description>
8146 </listheader>
8147 <item><description>d</description><description>The day of the month. Single-digit days will not have a leading zero.</description></item>
8148 <item><description>dd</description><description>The day of the month. Single-digit days will have a leading zero.</description></item>
8149 <item><description>ddd</description><description>The abbreviated name of the day of the week.</description></item>
8150 <item><description>dddd</description><description>The full name of the day of the week.</description></item>
8151 <item><description>M</description><description>The numeric month. Single-digit months will not have a leading zero.</description></item>
8152 <item><description>MM</description><description>The numeric month. Single-digit months will have a leading zero.</description></item>
8153 <item><description>MMM</description><description>The abbreviated name of the month.</description></item>
8154 <item><description>MMMM</description><description>The full name of the month.</description></item>
8155 <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>
8156 <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>
8157 <item><description>yyyy</description><description>The year in four digits, including the century.</description></item>
8158 <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>
8159 <item><description>h</description><description>The hour in a 12-hour clock. Single-digit hours will not have a leading zero.</description></item>
8160 <item><description>hh</description><description>The hour in a 12-hour clock. Single-digit hours will have a leading zero.</description></item>
8161 <item><description>H</description><description>The hour in a 24-hour clock. Single-digit hours will not have a leading zero.</description></item>
8162 <item><description>HH</description><description>The hour in a 24-hour clock. Single-digit hours will have a leading zero.</description></item>
8163 <item><description>m</description><description>The minute. Single-digit minutes will not have a leading zero.</description></item>
8164 <item><description>mm</description><description>The minute. Single-digit minutes will have a leading zero.</description></item>
8165 <item><description>s</description><description>The second. Single-digit seconds will not have a leading zero.</description></item>
8166 <item><description>ss</description><description>The second. Single-digit seconds will have a leading zero.</description></item>
8167 <item><description>f</description><description>The fraction of a second in single-digit precision. The remaining digits are truncated.</description></item>
8168 <item><description>ff</description><description>The fraction of a second in double-digit precision. The remaining digits are truncated.</description></item>
8169 <item><description>fff</description><description>The fraction of a second in three-digit precision. The remaining digits are truncated.</description></item>
8170 <item><description>ffff</description><description>The fraction of a second in four-digit precision. The remaining digits are truncated.</description></item>
8171 <item><description>fffff</description><description>The fraction of a second in five-digit precision. The remaining digits are truncated. </description></item>
8172 <item><description>ffffff</description><description>The fraction of a second in six-digit precision. The remaining digits are truncated. </description></item>
8173 <item><description>fffffff</description><description>The fraction of a second in seven-digit precision. The remaining digits are truncated. </description></item>
8174 <item><description>t</description><description>The first character in the AM/PM designator.</description></item>
8175 <item><description>tt</description><description>The AM/PM designator. </description></item>
8176 <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>
8177 <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>
8178 <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>
8179 <item><description>:</description><description>The default time separator.</description></item>
8180 <item><description>/</description><description>The default date separator.</description></item>
8181 <item><description>\ c</description><description>Pattern Where c is any character. Displays the character literally. To display the backslash character, use "\\". </description></item>
8182 </list>
8183 </remarks>
8184 </member>
8185 <member name="T:NAnt.Core.Tasks.UpToDateTask">
8186 <summary>
8187 Check modification dates on groups of files.
8188 </summary>
8189 <remarks>
8190 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
8191 is set to <see langword="false"/>.
8192 </remarks>
8193 <example>
8194 <para>
8195 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
8196 to either <see langword="true"/> or <see langword="false"/>.
8197 </para>
8198 <code>
8199 <![CDATA[
8200 <uptodate property="myfile.dll.uptodate">
8201 <sourcefiles>
8202 <include name="myfile.cs" />
8203 </sourcefiles>
8204 <targetfiles>
8205 <include name="myfile.dll" />
8206 </targetfiles>
8207 </uptodate>
8208 ]]>
8209 </code>
8210 </example>
8211 </member>
8212 <member name="P:NAnt.Core.Tasks.UpToDateTask.PropertyName">
8213 <summary>
8214 Property that will be set to <see langword="true" /> or <see langword="false" /> depending on the
8215 result of the date check.
8216 </summary>
8217 </member>
8218 <member name="P:NAnt.Core.Tasks.UpToDateTask.SourceFiles">
8219 <summary>
8220 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains list of source files.
8221 </summary>
8222 </member>
8223 <member name="P:NAnt.Core.Tasks.UpToDateTask.TargetFiles">
8224 <summary>
8225 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains list of target files.
8226 </summary>
8227 </member>
8228 <member name="T:NAnt.Core.Tasks.XmlPeekTask">
8229 <summary>
8230 Extracts text from an XML file at the location specified by an XPath
8231 expression.
8232 </summary>
8233 <remarks>
8234 <para>
8235 If the XPath expression specifies multiple nodes the node index is used
8236 to determine which of the nodes' text is returned.
8237 </para>
8238 </remarks>
8239 <example>
8240 <para>
8241 The example provided assumes that the following XML file (App.config)
8242 exists in the current build directory.
8243 </para>
8244 <code>
8245 <![CDATA[
8246 <?xml version="1.0" encoding="utf-8" ?>
8247 <configuration xmlns="http://www.gordic.cz/shared/project-config/v_1.0.0.0">
8248 <appSettings>
8249 <add key="server" value="testhost.somecompany.com" />
8250 </appSettings>
8251 </configuration>
8252 ]]>
8253 </code>
8254 </example>
8255 <example>
8256 <para>
8257 The example will read the server value from the above
8258 configuration file.
8259 </para>
8260 <code>
8261 <![CDATA[
8262 <xmlpeek
8263 file="App.config"
8264 xpath="/x:configuration/x:appSettings/x:add[@key = 'server']/@value"
8265 property="configuration.server">
8266 <namespaces>
8267 <namespace prefix="x" uri="http://www.gordic.cz/shared/project-config/v_1.0.0.0" />
8268 </namespaces>
8269 </xmlpeek>
8270 ]]>
8271 </code>
8272 </example>
8273 </member>
8274 <member name="M:NAnt.Core.Tasks.XmlPeekTask.ExecuteTask">
8275 <summary>
8276 Executes the XML peek task.
8277 </summary>
8278 </member>
8279 <member name="M:NAnt.Core.Tasks.XmlPeekTask.LoadDocument(System.String)">
8280 <summary>
8281 Loads an XML document from a file on disk.
8282 </summary>
8283 <param name="fileName">The file name of the file to load the XML document from.</param>
8284 <returns>
8285 A <see cref="T:System.Xml.XmlDocument">document</see> containing
8286 the document object representing the file.
8287 </returns>
8288 </member>
8289 <member name="M:NAnt.Core.Tasks.XmlPeekTask.GetNodeContents(System.String,System.Xml.XmlDocument,System.Int32)">
8290 <summary>
8291 Gets the contents of the node specified by the XPath expression.
8292 </summary>
8293 <param name="xpath">The XPath expression used to determine which nodes to choose from.</param>
8294 <param name="document">The XML document to select the nodes from.</param>
8295 <param name="nodeIndex">The node index in the case where multiple nodes satisfy the expression.</param>
8296 <returns>
8297 The contents of the node specified by the XPath expression.
8298 </returns>
8299 </member>
8300 <member name="P:NAnt.Core.Tasks.XmlPeekTask.XmlFile">
8301 <summary>
8302 The name of the file that contains the XML document
8303 that is going to be peeked at.
8304 </summary>
8305 </member>
8306 <member name="P:NAnt.Core.Tasks.XmlPeekTask.NodeIndex">
8307 <summary>
8308 The index of the node that gets its text returned when the query
8309 returns multiple nodes.
8310 </summary>
8311 </member>
8312 <member name="P:NAnt.Core.Tasks.XmlPeekTask.Property">
8313 <summary>
8314 The property that receives the text representation of the XML inside
8315 the node returned from the XPath expression.
8316 </summary>
8317 </member>
8318 <member name="P:NAnt.Core.Tasks.XmlPeekTask.XPath">
8319 <summary>
8320 The XPath expression used to select which node to read.
8321 </summary>
8322 </member>
8323 <member name="P:NAnt.Core.Tasks.XmlPeekTask.Namespaces">
8324 <summary>
8325 Namespace definitions to resolve prefixes in the XPath expression.
8326 </summary>
8327 </member>
8328 <member name="T:NAnt.Core.Tasks.XmlPokeTask">
8329 <summary>
8330 Replaces text in an XML file at the location specified by an XPath
8331 expression.
8332 </summary>
8333 <remarks>
8334 <para>
8335 The location specified by the XPath expression must exist, it will
8336 not create the parent elements for you. However, provided you have
8337 a root element you could use a series of the tasks to build the
8338 XML file up if necessary.
8339 </para>
8340 </remarks>
8341 <example>
8342 <para>
8343 Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
8344 to <c>productionhost.somecompany.com</c>.
8345 </para>
8346 <para>XML file:</para>
8347 <code>
8348 <![CDATA[
8349 <?xml version="1.0" encoding="utf-8" ?>
8350 <configuration>
8351 <appSettings>
8352 <add key="server" value="testhost.somecompany.com" />
8353 </appSettings>
8354 </configuration>
8355 ]]>
8356 </code>
8357 <para>Build fragment:</para>
8358 <code>
8359 <![CDATA[
8360 <xmlpoke
8361 file="App.config"
8362 xpath="/configuration/appSettings/add[@key = 'server']/@value"
8363 value="productionhost.somecompany.com" />
8364 ]]>
8365 </code>
8366 </example>
8367 <example>
8368 <para>
8369 Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
8370 </para>
8371 <para>XML file:</para>
8372 <code>
8373 <![CDATA[
8374 <?xml version="1.0" encoding="utf-8" ?>
8375 <Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
8376 </Commands>
8377 ]]>
8378 </code>
8379 <para>Build fragment:</para>
8380 <code>
8381 <![CDATA[
8382 <xmlpoke file="test.xml" xpath="/Commands/@xsi:noNamespaceSchemaLocation" value="d:\Commands.xsd">
8383 <namespaces>
8384 <namespace prefix="xsi" uri="http://www.w3.org/2001/XMLSchema-instance" />
8385 </namespaces>
8386 </xmlpoke>
8387 ]]>
8388 </code>
8389 </example>
8390 </member>
8391 <member name="M:NAnt.Core.Tasks.XmlPokeTask.ExecuteTask">
8392 <summary>
8393 Executes the XML poke task.
8394 </summary>
8395 </member>
8396 <member name="M:NAnt.Core.Tasks.XmlPokeTask.LoadDocument(System.String,System.Boolean)">
8397 <summary>
8398 Loads an XML document from a file on disk.
8399 </summary>
8400 <param name="fileName">
8401 The file name of the file to load the XML document from.
8402 </param>
8403 <param name="preserveWhitespace">
8404 Value for XmlDocument.PreserveWhitespace that is set before the xml is loaded.
8405 </param>
8406 <returns>
8407 An <see cref="T:System.Xml.XmlDocument"/> containing
8408 the document object model representing the file.
8409 </returns>
8410 </member>
8411 <member name="M:NAnt.Core.Tasks.XmlPokeTask.SelectNodes(System.String,System.Xml.XmlDocument,System.Xml.XmlNamespaceManager)">
8412 <summary>
8413 Given an XML document and an expression, returns a list of nodes
8414 which match the expression criteria.
8415 </summary>
8416 <param name="xpath">
8417 The XPath expression used to select the nodes.
8418 </param>
8419 <param name="document">
8420 The XML document that is searched.
8421 </param>
8422 <param name="nsMgr">
8423 An <see cref="T:System.Xml.XmlNamespaceManager"/> to use for resolving namespaces
8424 for prefixes in the XPath expression.
8425 </param>
8426 <returns>
8427 An <see cref="T:System.Xml.XmlNodeList"/> containing references to the nodes
8428 that matched the XPath expression.
8429 </returns>
8430 </member>
8431 <member name="M:NAnt.Core.Tasks.XmlPokeTask.UpdateNodes(System.Xml.XmlNodeList,System.String)">
8432 <summary>
8433 Given a node list, replaces the XML within those nodes.
8434 </summary>
8435 <param name="nodes">
8436 The list of nodes to replace the contents of.
8437 </param>
8438 <param name="value">
8439 The text to replace the contents with.
8440 </param>
8441 </member>
8442 <member name="M:NAnt.Core.Tasks.XmlPokeTask.SaveDocument(System.Xml.XmlDocument,System.String)">
8443 <summary>
8444 Saves the XML document to a file.
8445 </summary>
8446 <param name="document">The XML document to be saved.</param>
8447 <param name="fileName">The file name to save the XML document under.</param>
8448 </member>
8449 <member name="P:NAnt.Core.Tasks.XmlPokeTask.XmlFile">
8450 <summary>
8451 The name of the file that contains the XML document that is going
8452 to be poked.
8453 </summary>
8454 </member>
8455 <member name="P:NAnt.Core.Tasks.XmlPokeTask.XPath">
8456 <summary>
8457 The XPath expression used to select which nodes are to be modified.
8458 </summary>
8459 </member>
8460 <member name="P:NAnt.Core.Tasks.XmlPokeTask.Value">
8461 <summary>
8462 The value that replaces the contents of the selected nodes.
8463 </summary>
8464 </member>
8465 <member name="P:NAnt.Core.Tasks.XmlPokeTask.Namespaces">
8466 <summary>
8467 Namespace definitions to resolve prefixes in the XPath expression.
8468 </summary>
8469 </member>
8470 <member name="P:NAnt.Core.Tasks.XmlPokeTask.PreserveWhitespace">
8471 <summary>
8472 Namespace definitions to resolve prefixes in the XPath expression.
8473 </summary>
8474 </member>
8475 <member name="T:NAnt.Core.Types.Argument">
8476 <summary>
8477 Represents a command-line argument.
8478 </summary>
8479 <remarks>
8480 <para>
8481 When passed to an external application, the argument will be quoted
8482 when appropriate. This does not apply to the <see cref="P:NAnt.Core.Types.Argument.Line"/>
8483 parameter, which is always passed as is.
8484 </para>
8485 </remarks>
8486 <example>
8487 <para>
8488 A single command-line argument containing a space character.
8489 </para>
8490 <code>
8491 <![CDATA[
8492 <arg value="-l -a" />
8493 ]]>
8494 </code>
8495 </example>
8496 <example>
8497 <para>
8498 Two separate command-line arguments.
8499 </para>
8500 <code>
8501 <![CDATA[
8502 <arg line="-l -a" />
8503 ]]>
8504 </code>
8505 </example>
8506 <example>
8507 <para>
8508 A single command-line argument with the value <c>\dir;\dir2;\dir3</c>
8509 on DOS-based systems and <c>/dir:/dir2:/dir3</c> on Unix-like systems.
8510 </para>
8511 <code>
8512 <![CDATA[
8513 <arg path="/dir;/dir2:\dir3" />
8514 ]]>
8515 </code>
8516 </example>
8517 </member>
8518 <member name="M:NAnt.Core.Types.Argument.#ctor">
8519 <summary>
8520 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class.
8521 </summary>
8522 </member>
8523 <member name="M:NAnt.Core.Types.Argument.#ctor(System.String)">
8524 <summary>
8525 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
8526 with the specified command-line argument.
8527 </summary>
8528 </member>
8529 <member name="M:NAnt.Core.Types.Argument.#ctor(System.IO.FileInfo)">
8530 <summary>
8531 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
8532 with the given file.
8533 </summary>
8534 </member>
8535 <member name="M:NAnt.Core.Types.Argument.#ctor(NAnt.Core.Types.PathSet)">
8536 <summary>
8537 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
8538 with the given path.
8539 </summary>
8540 </member>
8541 <member name="M:NAnt.Core.Types.Argument.ToString">
8542 <summary>
8543 Returns the argument as a <see cref="T:System.String"/>.
8544 </summary>
8545 <returns>
8546 The argument as a <see cref="T:System.String"/>.
8547 </returns>
8548 <remarks>
8549 File and individual path elements will be quoted if necessary.
8550 </remarks>
8551 </member>
8552 <member name="M:NAnt.Core.Types.Argument.QuoteArgument(System.String)">
8553 <summary>
8554 Quotes a command line argument if it contains a single quote or a
8555 space.
8556 </summary>
8557 <param name="argument">The command line argument.</param>
8558 <returns>
8559 A quoted command line argument if <paramref name="argument" />
8560 contains a single quote or a space; otherwise,
8561 <paramref name="argument" />.
8562 </returns>
8563 </member>
8564 <member name="P:NAnt.Core.Types.Argument.Value">
8565 <summary>
8566 A single command-line argument; can contain space characters.
8567 </summary>
8568 </member>
8569 <member name="P:NAnt.Core.Types.Argument.File">
8570 <summary>
8571 The name of a file as a single command-line argument; will be
8572 replaced with the absolute filename of the file.
8573 </summary>
8574 </member>
8575 <member name="P:NAnt.Core.Types.Argument.Directory">
8576 <summary>
8577 The value for a directory-based command-line argument; will be
8578 replaced with the absolute path of the directory.
8579 </summary>
8580 </member>
8581 <member name="P:NAnt.Core.Types.Argument.Path">
8582 <summary>
8583 The value for a PATH-like command-line argument; you can use
8584 <c>:</c> or <c>;</c> as path separators and NAnt will convert it
8585 to the platform's local conventions, while resolving references to
8586 environment variables.
8587 </summary>
8588 <remarks>
8589 Individual parts will be replaced with the absolute path, resolved
8590 relative to the project base directory.
8591 </remarks>
8592 </member>
8593 <member name="P:NAnt.Core.Types.Argument.PathSet">
8594 <summary>
8595 Sets a single command-line argument and treats it like a PATH - ensures
8596 the right separator for the local platform is used.
8597 </summary>
8598 </member>
8599 <member name="P:NAnt.Core.Types.Argument.Line">
8600 <summary>
8601 List of command-line arguments; will be passed to the executable
8602 as is.
8603 </summary>
8604 </member>
8605 <member name="P:NAnt.Core.Types.Argument.IfDefined">
8606 <summary>
8607 Indicates if the argument should be passed to the external program.
8608 If <see langword="true" /> then the argument will be passed;
8609 otherwise, skipped. The default is <see langword="true" />.
8610 </summary>
8611 </member>
8612 <member name="P:NAnt.Core.Types.Argument.UnlessDefined">
8613 <summary>
8614 Indicates if the argument should not be passed to the external
8615 program. If <see langword="false" /> then the argument will be
8616 passed; otherwise, skipped. The default is <see langword="false" />.
8617 </summary>
8618 </member>
8619 <member name="P:NAnt.Core.Types.Argument.StringValue">
8620 <summary>
8621 Gets string value corresponding with the argument.
8622 </summary>
8623 </member>
8624 <member name="T:NAnt.Core.Types.ArgumentCollection">
8625 <summary>
8626 Contains a collection of <see cref="T:NAnt.Core.Types.Argument"/> elements.
8627 </summary>
8628 </member>
8629 <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor">
8630 <summary>
8631 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class.
8632 </summary>
8633 </member>
8634 <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor(NAnt.Core.Types.ArgumentCollection)">
8635 <summary>
8636 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class
8637 with the specified <see cref="T:NAnt.Core.Types.ArgumentCollection"/> instance.
8638 </summary>
8639 </member>
8640 <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor(NAnt.Core.Types.Argument[])">
8641 <summary>
8642 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class
8643 with the specified array of <see cref="T:NAnt.Core.Types.Argument"/> instances.
8644 </summary>
8645 </member>
8646 <member name="M:NAnt.Core.Types.ArgumentCollection.Add(NAnt.Core.Types.Argument)">
8647 <summary>
8648 Adds a <see cref="T:NAnt.Core.Types.Argument"/> to the end of the collection.
8649 </summary>
8650 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to be added to the end of the collection.</param>
8651 <returns>The position into which the new element was inserted.</returns>
8652 </member>
8653 <member name="M:NAnt.Core.Types.ArgumentCollection.AddRange(NAnt.Core.Types.Argument[])">
8654 <summary>
8655 Adds the elements of a <see cref="T:NAnt.Core.Types.Argument"/> array to the end of the collection.
8656 </summary>
8657 <param name="items">The array of <see cref="T:NAnt.Core.Types.Argument"/> elements to be added to the end of the collection.</param>
8658 </member>
8659 <member name="M:NAnt.Core.Types.ArgumentCollection.AddRange(NAnt.Core.Types.ArgumentCollection)">
8660 <summary>
8661 Adds the elements of a <see cref="T:NAnt.Core.Types.ArgumentCollection"/> to the end of the collection.
8662 </summary>
8663 <param name="items">The <see cref="T:NAnt.Core.Types.ArgumentCollection"/> to be added to the end of the collection.</param>
8664 </member>
8665 <member name="M:NAnt.Core.Types.ArgumentCollection.Contains(NAnt.Core.Types.Argument)">
8666 <summary>
8667 Determines whether a <see cref="T:NAnt.Core.Types.Argument"/> is in the collection.
8668 </summary>
8669 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to locate in the collection.</param>
8670 <returns>
8671 <see langword="true"/> if <paramref name="item"/> is found in the
8672 collection; otherwise, <see langword="false"/>.
8673 </returns>
8674 </member>
8675 <member name="M:NAnt.Core.Types.ArgumentCollection.Contains(System.String)">
8676 <summary>
8677 Determines whether a <see cref="T:NAnt.Core.Types.Argument"/> with the specified
8678 value is in the collection.
8679 </summary>
8680 <param name="value">The argument value to locate in the collection.</param>
8681 <returns>
8682 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.Argument"/> with value
8683 <paramref name="value"/> is found in the collection; otherwise,
8684 <see langword="false"/>.
8685 </returns>
8686 </member>
8687 <member name="M:NAnt.Core.Types.ArgumentCollection.CopyTo(NAnt.Core.Types.Argument[],System.Int32)">
8688 <summary>
8689 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
8690 </summary>
8691 <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>
8692 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
8693 </member>
8694 <member name="M:NAnt.Core.Types.ArgumentCollection.IndexOf(NAnt.Core.Types.Argument)">
8695 <summary>
8696 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Argument"/> object in the collection.
8697 </summary>
8698 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> object for which the index is returned.</param>
8699 <returns>
8700 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.
8701 </returns>
8702 </member>
8703 <member name="M:NAnt.Core.Types.ArgumentCollection.Insert(System.Int32,NAnt.Core.Types.Argument)">
8704 <summary>
8705 Inserts a <see cref="T:NAnt.Core.Types.Argument"/> into the collection at the specified index.
8706 </summary>
8707 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
8708 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to insert.</param>
8709 </member>
8710 <member name="M:NAnt.Core.Types.ArgumentCollection.GetEnumerator">
8711 <summary>
8712 Returns an enumerator that can iterate through the collection.
8713 </summary>
8714 <returns>
8715 A <see cref="T:NAnt.Core.Types.ArgumentEnumerator"/> for the entire collection.
8716 </returns>
8717 </member>
8718 <member name="M:NAnt.Core.Types.ArgumentCollection.Remove(NAnt.Core.Types.Argument)">
8719 <summary>
8720 Removes a member from the collection.
8721 </summary>
8722 <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to remove from the collection.</param>
8723 </member>
8724 <member name="P:NAnt.Core.Types.ArgumentCollection.Item(System.Int32)">
8725 <summary>
8726 Gets or sets the element at the specified index.
8727 </summary>
8728 <param name="index">The zero-based index of the element to get or set.</param>
8729 </member>
8730 <member name="P:NAnt.Core.Types.ArgumentCollection.Item(System.String)">
8731 <summary>
8732 Gets the <see cref="T:NAnt.Core.Types.Argument"/> with the specified value.
8733 </summary>
8734 <param name="value">The value of the <see cref="T:NAnt.Core.Types.Argument"/> to get.</param>
8735 </member>
8736 <member name="T:NAnt.Core.Types.ArgumentEnumerator">
8737 <summary>
8738 Enumerates the <see cref="T:NAnt.Core.Types.Argument"/> elements of a <see cref="T:NAnt.Core.Types.ArgumentCollection"/>.
8739 </summary>
8740 </member>
8741 <member name="M:NAnt.Core.Types.ArgumentEnumerator.#ctor(NAnt.Core.Types.ArgumentCollection)">
8742 <summary>
8743 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentEnumerator"/> class
8744 with the specified <see cref="T:NAnt.Core.Types.ArgumentCollection"/>.
8745 </summary>
8746 <param name="arguments">The collection that should be enumerated.</param>
8747 </member>
8748 <member name="M:NAnt.Core.Types.ArgumentEnumerator.MoveNext">
8749 <summary>
8750 Advances the enumerator to the next element of the collection.
8751 </summary>
8752 <returns>
8753 <see langword="true" /> if the enumerator was successfully advanced
8754 to the next element; <see langword="false" /> if the enumerator has
8755 passed the end of the collection.
8756 </returns>
8757 </member>
8758 <member name="M:NAnt.Core.Types.ArgumentEnumerator.Reset">
8759 <summary>
8760 Sets the enumerator to its initial position, which is before the
8761 first element in the collection.
8762 </summary>
8763 </member>
8764 <member name="P:NAnt.Core.Types.ArgumentEnumerator.Current">
8765 <summary>
8766 Gets the current element in the collection.
8767 </summary>
8768 <returns>
8769 The current element in the collection.
8770 </returns>
8771 </member>
8772 <member name="T:NAnt.Core.Types.Credential">
8773 <summary>
8774 Provides credentials for password-based authentication schemes.
8775 </summary>
8776 </member>
8777 <member name="M:NAnt.Core.Types.Credential.#ctor">
8778 <summary>
8779 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Credential"/> class.
8780 </summary>
8781 </member>
8782 <member name="M:NAnt.Core.Types.Credential.GetCredential">
8783 <summary>
8784 Returns a <see cref="T:System.Net.NetworkCredential"/> instance representing
8785 the current <see cref="T:NAnt.Core.Types.Credential"/>.
8786 </summary>
8787 <returns>
8788 A <see cref="T:System.Net.NetworkCredential"/> instance representing the current
8789 <see cref="T:NAnt.Core.Types.Credential"/>, or <see langword="null"/> if the
8790 credentials should not be used to provide authentication information
8791 to the external resource.
8792 </returns>
8793 </member>
8794 <member name="P:NAnt.Core.Types.Credential.Domain">
8795 <summary>
8796 The domain or computer name that verifies the credentials.
8797 </summary>
8798 </member>
8799 <member name="P:NAnt.Core.Types.Credential.Password">
8800 <summary>
8801 The password for the user name associated with the credentials.
8802 </summary>
8803 </member>
8804 <member name="P:NAnt.Core.Types.Credential.UserName">
8805 <summary>
8806 The user name associated with the credentials.
8807 </summary>
8808 </member>
8809 <member name="P:NAnt.Core.Types.Credential.IfDefined">
8810 <summary>
8811 Indicates if the credentials should be used to provide authentication
8812 information to the external resource. If <see langword="true" /> then
8813 the credentials will be passed; otherwise, not. The default is
8814 <see langword="true" />.
8815 </summary>
8816 </member>
8817 <member name="P:NAnt.Core.Types.Credential.UnlessDefined">
8818 <summary>
8819 Indicates if the credentials should not be used to provide authentication
8820 information to the external resource. If <see langword="false" /> then the
8821 credentials will be passed; otherwise, not. The default is
8822 <see langword="false" />.
8823 </summary>
8824 </member>
8825 <member name="T:NAnt.Core.Types.DirSet">
8826 <summary>
8827 A specialized <see cref="T:NAnt.Core.Types.FileSet"/> used for specifying a set of
8828 directories.
8829 </summary>
8830 <remarks>
8831 Hint for supporting tasks that the included directories instead of
8832 files should be used.
8833 </remarks>
8834 </member>
8835 <member name="T:NAnt.Core.Types.FileSet">
8836 <summary>
8837 Filesets are groups of files. These files can be found in a directory
8838 tree starting in a base directory and are matched by patterns taken
8839 from a number of patterns. Filesets can appear inside tasks that support
8840 this feature or at the project level, i.e., as children of <c><project></c>.
8841 </summary>
8842 <remarks>
8843 <h3>Patterns</h3>
8844 <para>
8845 As described earlier, patterns are used for the inclusion and exclusion.
8846 These patterns look very much like the patterns used in DOS and UNIX:
8847 </para>
8848 <list type="bullet">
8849 <item>
8850 <description>
8851 <para>'<c>*</c>' matches zero or more characters</para>
8852 <para>For example:</para>
8853 <para>
8854 <c>*.cs</c> matches <c>.cs</c>, <c>x.cs</c> and <c>FooBar.cs</c>,
8855 but not <c>FooBar.xml</c> (does not end with <c>.cs</c>).
8856 </para>
8857 </description>
8858 </item>
8859 <item>
8860 <description>
8861 <para>'<c>?</c>' matches one character</para>
8862 <para>For example:</para>
8863 <para>
8864 <c>?.cs</c> matches <c>x.cs</c>, <c>A.cs</c>, but not
8865 <c>.cs</c> or <c>xyz.cs</c> (both don't have one character
8866 before <c>.cs</c>).
8867 </para>
8868 </description>
8869 </item>
8870 </list>
8871 <para>
8872 Combinations of <c>*</c>'s and <c>?</c>'s are allowed.
8873 </para>
8874 <para>
8875 Matching is done per-directory. This means that first the first directory
8876 in the pattern is matched against the first directory in the path to match.
8877 Then the second directory is matched, and so on. For example, when we have
8878 the pattern <c>/?abc/*/*.cs</c> and the path <c>/xabc/foobar/test.cs</c>,
8879 the first <c>?abc</c> is matched with <c>xabc</c>, then <c>*</c> is matched
8880 with <c>foobar</c>, and finally <c>*.cs</c> is matched with <c>test.cs</c>.
8881 They all match, so the path matches the pattern.
8882 </para>
8883 <para>
8884 To make things a bit more flexible, we added one extra feature, which makes
8885 it possible to match multiple directory levels. This can be used to match a
8886 complete directory tree, or a file anywhere in the directory tree. To do this,
8887 <c>**</c> must be used as the name of a directory. When <c>**</c> is used as
8888 the name of a directory in the pattern, it matches zero or more directories.
8889 For example: <c>/test/**</c> matches all files/directories under <c>/test/</c>,
8890 such as <c>/test/x.cs</c>, or <c>/test/foo/bar/xyz.html</c>, but not <c>/xyz.xml</c>.
8891 </para>
8892 <para>
8893 There is one "shorthand" - if a pattern ends with <c>/</c> or <c>\</c>, then
8894 <c>**</c> is appended. For example, <c>mypackage/test/</c> is interpreted as
8895 if it were <c>mypackage/test/**</c>.
8896 </para>
8897 <h3>Case-Sensitivity</h3>
8898 <para>
8899 By default, pattern matching is case-sensitive on Unix and case-insensitive
8900 on other platforms. The <see cref="P:NAnt.Core.Types.FileSet.CaseSensitive"/> parameter can be used
8901 to override this.
8902 </para>
8903 <h3>Default Excludes</h3>
8904 <para>
8905 There are a set of definitions that are excluded by default from all
8906 tasks that use filesets. They are:
8907 </para>
8908 <list type="bullet">
8909 <item>
8910 <description>
8911 **/*~
8912 </description>
8913 </item>
8914 <item>
8915 <description>
8916 **/#*#
8917 </description>
8918 </item>
8919 <item>
8920 <description>
8921 **/.#*
8922 </description>
8923 </item>
8924 <item>
8925 <description>
8926 **/%*%
8927 </description>
8928 </item>
8929 <item>
8930 <description>
8931 **/CVS
8932 </description>
8933 </item>
8934 <item>
8935 <description>
8936 **/CVS/**
8937 </description>
8938 </item>
8939 <item>
8940 <description>
8941 **/.cvsignore
8942 </description>
8943 </item>
8944 <item>
8945 <description>
8946 **/.svn
8947 </description>
8948 </item>
8949 <item>
8950 <description>
8951 **/.svn/**
8952 </description>
8953 </item>
8954 <item>
8955 <description>
8956 **/_svn
8957 </description>
8958 </item>
8959 <item>
8960 <description>
8961 **/_svn/**
8962 </description>
8963 </item>
8964 <item>
8965 <description>
8966 **/SCCS
8967 </description>
8968 </item>
8969 <item>
8970 <description>
8971 **/SCCS/**
8972 </description>
8973 </item>
8974 <item>
8975 <description>
8976 **/vssver.scc
8977 </description>
8978 </item>
8979 <item>
8980 <description>
8981 **/vssver2.scc
8982 </description>
8983 </item>
8984 <item>
8985 <description>
8986 **/_vti_cnf/**
8987 </description>
8988 </item>
8989 </list>
8990 <para>
8991 If you do not want these default excludes applied, you may disable them
8992 by setting <see cref="P:NAnt.Core.Types.FileSet.DefaultExcludes"/> to <see langword="false"/>.
8993 </para>
8994 </remarks>
8995 <example>
8996 <list type="table">
8997 <listheader>
8998 <term>Pattern</term>
8999 <description>Match</description>
9000 </listheader>
9001 <item>
9002 <term><c>**/CVS/*</c></term>
9003 <description>
9004 <para>
9005 Matches all files in <c>CVS</c> directories that can be
9006 located anywhere in the directory tree.
9007 </para>
9008 <para>Matches:</para>
9009 <list type="bullet">
9010 <item>
9011 <description>CVS/Repository</description>
9012 </item>
9013 <item>
9014 <description>org/apache/CVS/Entries</description>
9015 </item>
9016 <item>
9017 <description>org/apache/jakarta/tools/ant/CVS/Entries</description>
9018 </item>
9019 </list>
9020 <para>But not:</para>
9021 <list type="bullet">
9022 <item>
9023 <description>org/apache/CVS/foo/bar/Entries (<c>foo/bar/</c> part does not match)</description>
9024 </item>
9025 </list>
9026 </description>
9027 </item>
9028 <item>
9029 <term><c>org/apache/jakarta/**</c></term>
9030 <description>
9031 <para>
9032 Matches all files in the <c>org/apache/jakarta</c> directory
9033 tree.
9034 </para>
9035 <para>Matches:</para>
9036 <list type="bullet">
9037 <item>
9038 <description>org/apache/jakarta/tools/ant/docs/index.html</description>
9039 </item>
9040 <item>
9041 <description>org/apache/jakarta/test.xml</description>
9042 </item>
9043 </list>
9044 <para>But not:</para>
9045 <list type="bullet">
9046 <item>
9047 <description>org/apache/xyz.java (<c>jakarta/</c> part is missing)</description>
9048 </item>
9049 </list>
9050 </description>
9051 </item>
9052 <item>
9053 <term><c>org/apache/**/CVS/*</c></term>
9054 <description>
9055 <para>
9056 Matches all files in <c>CVS</c> directories that are located
9057 anywhere in the directory tree under <c>org/apache</c>.
9058 </para>
9059 <para>Matches:</para>
9060 <list type="bullet">
9061 <item>
9062 <description>org/apache/CVS/Entries</description>
9063 </item>
9064 <item>
9065 <description>org/apache/jakarta/tools/ant/CVS/Entries</description>
9066 </item>
9067 </list>
9068 <para>But not:</para>
9069 <list type="bullet">
9070 <item>
9071 <description>org/apache/CVS/foo/bar/Entries (<c>foo/bar/</c> part does not match)</description>
9072 </item>
9073 </list>
9074 </description>
9075 </item>
9076 <item>
9077 <term><c>**/test/**</c></term>
9078 <description>
9079 <para>
9080 Matches all files that have a <c>test</c> element in their
9081 path, including <c>test</c> as a filename.
9082 </para>
9083 </description>
9084 </item>
9085 </list>
9086 </example>
9087 <seealso cref="T:NAnt.Core.Types.PatternSet"/>
9088 </member>
9089 <member name="M:NAnt.Core.Types.FileSet.#ctor">
9090 <summary>
9091 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FileSet"/> class.
9092 </summary>
9093 </member>
9094 <member name="M:NAnt.Core.Types.FileSet.#ctor(NAnt.Core.Types.FileSet)">
9095 <summary>
9096 copy constructor
9097 </summary>
9098 <param name="fs"></param>
9099 </member>
9100 <member name="M:NAnt.Core.Types.FileSet.Clone">
9101 <summary>
9102 Creates a shallow copy of the <see cref="T:NAnt.Core.Types.FileSet"/>.
9103 </summary>
9104 <returns>
9105 A shallow copy of the <see cref="T:NAnt.Core.Types.FileSet"/>.
9106 </returns>
9107 </member>
9108 <member name="M:NAnt.Core.Types.FileSet.AddPatternSet(NAnt.Core.Types.PatternSet)">
9109 <summary>
9110 Adds a nested set of patterns, or references a standalone patternset.
9111 </summary>
9112 </member>
9113 <member name="M:NAnt.Core.Types.FileSet.CopyTo(NAnt.Core.Types.FileSet)">
9114 <summary>
9115 Copies all instance data of the <see cref="T:NAnt.Core.Types.FileSet"/> to a given
9116 <see cref="T:NAnt.Core.Types.FileSet"/>.
9117 </summary>
9118 </member>
9119 <member name="M:NAnt.Core.Types.FileSet.FindMoreRecentLastWriteTime(System.String,System.DateTime)">
9120 <summary>
9121 Determines if a file has a more recent last write time than the
9122 given time, or no longer exists.
9123 </summary>
9124 <param name="fileName">A file to check the last write time against.</param>
9125 <param name="targetLastWriteTime">The datetime to compare against.</param>
9126 <returns>
9127 The name of the file that has a last write time greater than
9128 <paramref name="targetLastWriteTime" /> or that no longer exists;
9129 otherwise, <see langword="null" />.
9130 </returns>
9131 </member>
9132 <member name="M:NAnt.Core.Types.FileSet.FindMoreRecentLastWriteTime(System.Collections.Specialized.StringCollection,System.DateTime)">
9133 <summary>
9134 Determines if one of the given files has a more recent last write
9135 time than the given time. If one of the given files no longer exists,
9136 the target will be considered out-of-date.
9137 </summary>
9138 <param name="fileNames">A collection of filenames to check the last write time against.</param>
9139 <param name="targetLastWriteTime">The datetime to compare against.</param>
9140 <returns>
9141 The name of the first file that has a last write time greater than
9142 <paramref name="targetLastWriteTime" />; otherwise, null.
9143 </returns>
9144 </member>
9145 <member name="P:NAnt.Core.Types.FileSet.CaseSensitive">
9146 <summary>
9147 Indicates whether include and exclude patterns must be treated in a
9148 case-sensitive way. The default is <see langword="true" /> on Unix;
9149 otherwise, <see langword="false" />.
9150 </summary>
9151 </member>
9152 <member name="P:NAnt.Core.Types.FileSet.FailOnEmpty">
9153 <summary>
9154 When set to <see langword="true"/>, causes the fileset element to
9155 throw a <see cref="T:NAnt.Core.ValidationException"/> when no files match the
9156 includes and excludes criteria. The default is <see langword="false"/>.
9157 </summary>
9158 </member>
9159 <member name="P:NAnt.Core.Types.FileSet.DefaultExcludes">
9160 <summary>
9161 Indicates whether default excludes should be used or not.
9162 The default is <see langword="true" />.
9163 </summary>
9164 </member>
9165 <member name="P:NAnt.Core.Types.FileSet.BaseDirectory">
9166 <summary>
9167 The base of the directory of this fileset. The default is the project
9168 base directory.
9169 </summary>
9170 </member>
9171 <member name="P:NAnt.Core.Types.FileSet.Includes">
9172 <summary>
9173 Gets the collection of include patterns.
9174 </summary>
9175 </member>
9176 <member name="P:NAnt.Core.Types.FileSet.Excludes">
9177 <summary>
9178 Gets the collection of exclude patterns.
9179 </summary>
9180 </member>
9181 <member name="P:NAnt.Core.Types.FileSet.AsIs">
9182 <summary>
9183 Gets the collection of files that will be added to the
9184 <see cref="T:NAnt.Core.Types.FileSet"/> without pattern matching or checking if the
9185 file exists.
9186 </summary>
9187 </member>
9188 <member name="P:NAnt.Core.Types.FileSet.FileNames">
9189 <summary>
9190 Gets the collection of file names that match the fileset.
9191 </summary>
9192 <value>
9193 A collection that contains the file names that match the
9194 <see cref="T:NAnt.Core.Types.FileSet"/>.
9195 </value>
9196 </member>
9197 <member name="P:NAnt.Core.Types.FileSet.DirectoryNames">
9198 <summary>
9199 Gets the collection of directory names that match the fileset.
9200 </summary>
9201 <value>
9202 A collection that contains the directory names that match the
9203 <see cref="T:NAnt.Core.Types.FileSet"/>.
9204 </value>
9205 </member>
9206 <member name="P:NAnt.Core.Types.FileSet.ScannedDirectories">
9207 <summary>
9208 Gets the collection of directory names that were scanned for files.
9209 </summary>
9210 <value>
9211 A collection that contains the directory names that were scanned for
9212 files.
9213 </value>
9214 </member>
9215 <member name="P:NAnt.Core.Types.FileSet.SetIncludes">
9216 <summary>
9217 The items to include in the fileset.
9218 </summary>
9219 </member>
9220 <member name="P:NAnt.Core.Types.FileSet.IncludeElements">
9221 <summary>
9222 The items to include in the fileset.
9223 </summary>
9224 </member>
9225 <member name="P:NAnt.Core.Types.FileSet.SetExcludes">
9226 <summary>
9227 The items to exclude from the fileset.
9228 </summary>
9229 </member>
9230 <member name="P:NAnt.Core.Types.FileSet.ExcludeElements">
9231 <summary>
9232 The items to exclude from the fileset.
9233 </summary>
9234 </member>
9235 <member name="P:NAnt.Core.Types.FileSet.SetIncludesList">
9236 <summary>
9237 The files from which a list of patterns or files to include should
9238 be obtained.
9239 </summary>
9240 </member>
9241 <member name="P:NAnt.Core.Types.FileSet.IncludesFiles">
9242 <summary>
9243 The files from which a list of patterns or files to include should
9244 be obtained.
9245 </summary>
9246 </member>
9247 <member name="P:NAnt.Core.Types.FileSet.ExcludesFiles">
9248 <summary>
9249 The files from which a list of patterns or files to exclude should
9250 be obtained.
9251 </summary>
9252 </member>
9253 <member name="P:NAnt.Core.Types.FileSet.MostRecentLastWriteTimeFile">
9254 <summary>
9255 Determines the most recently modified file in the fileset (by LastWriteTime of the <see cref="T:System.IO.FileInfo"/>).
9256 </summary>
9257 <returns>
9258 The <see cref="T:System.IO.FileInfo"/> of the file that has the newest (closest to present) last write time.
9259 </returns>
9260 </member>
9261 <member name="P:NAnt.Core.Types.FileSet.Exclude.Pattern">
9262 <summary>
9263 The pattern or file name to exclude.
9264 </summary>
9265 </member>
9266 <member name="P:NAnt.Core.Types.FileSet.Exclude.IfDefined">
9267 <summary>
9268 If <see langword="true" /> then the pattern will be excluded;
9269 otherwise, skipped. The default is <see langword="true" />.
9270 </summary>
9271 </member>
9272 <member name="P:NAnt.Core.Types.FileSet.Exclude.UnlessDefined">
9273 <summary>
9274 Opposite of <see cref="P:NAnt.Core.Types.FileSet.Exclude.IfDefined"/>. If <see langword="false"/>
9275 then the pattern will be excluded; otherwise, skipped. The default
9276 is <see langword="false"/>.
9277 </summary>
9278 </member>
9279 <member name="P:NAnt.Core.Types.FileSet.Include.AsIs">
9280 <summary>
9281 If <see langword="true"/> then the file name will be added to
9282 the <see cref="T:NAnt.Core.Types.FileSet"/> without pattern matching or checking
9283 if the file exists. The default is <see langword="false"/>.
9284 </summary>
9285 </member>
9286 <member name="P:NAnt.Core.Types.FileSet.Include.FromPath">
9287 <summary>
9288 If <see langword="true" /> then the file will be searched for
9289 on the path. The default is <see langword="false" />.
9290 </summary>
9291 </member>
9292 <member name="P:NAnt.Core.Types.FileSet.Include.Pattern">
9293 <summary>
9294 The pattern or file name to include.
9295 </summary>
9296 </member>
9297 <member name="P:NAnt.Core.Types.FileSet.Include.IfDefined">
9298 <summary>
9299 If <see langword="true" /> then the pattern will be included;
9300 otherwise, skipped. The default is <see langword="true" />.
9301 </summary>
9302 </member>
9303 <member name="P:NAnt.Core.Types.FileSet.Include.UnlessDefined">
9304 <summary>
9305 Opposite of <see cref="P:NAnt.Core.Types.FileSet.Include.IfDefined"/>. If <see langword="false"/>
9306 then the pattern will be included; otherwise, skipped. The default
9307 is <see langword="false"/>.
9308 </summary>
9309 </member>
9310 <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.Patterns">
9311 <summary>
9312 Gets the list of patterns in <see cref="P:NAnt.Core.Types.FileSet.ExcludesFile.PatternFile"/>.
9313 </summary>
9314 </member>
9315 <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.IfDefined">
9316 <summary>
9317 If <see langword="true" /> then the patterns will be excluded;
9318 otherwise, skipped. The default is <see langword="true" />.
9319 </summary>
9320 </member>
9321 <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.UnlessDefined">
9322 <summary>
9323 Opposite of <see cref="P:NAnt.Core.Types.FileSet.ExcludesFile.IfDefined"/>. If <see langword="false"/>
9324 then the patterns will be excluded; otherwise, skipped. The default
9325 is <see langword="false"/>.
9326 </summary>
9327 </member>
9328 <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.PatternFile">
9329 <summary>
9330 The name of a file; each line of this file is taken to be a
9331 pattern.
9332 </summary>
9333 </member>
9334 <member name="P:NAnt.Core.Types.FileSet.IncludesFile.AsIs">
9335 <summary>
9336 If <see langword="true"/> then the patterns in the include file
9337 will be added to the <see cref="T:NAnt.Core.Types.FileSet"/> without pattern
9338 matching or checking if the file exists. The default is
9339 <see langword="false"/>.
9340 </summary>
9341 </member>
9342 <member name="P:NAnt.Core.Types.FileSet.IncludesFile.FromPath">
9343 <summary>
9344 If <see langword="true" /> then the patterns in the include file
9345 will be searched for on the path. The default is <see langword="false" />.
9346 </summary>
9347 </member>
9348 <member name="P:NAnt.Core.Types.FileSet.IncludesFile.IfDefined">
9349 <summary>
9350 If <see langword="true" /> then the patterns will be included;
9351 otherwise, skipped. The default is <see langword="true" />.
9352 </summary>
9353 </member>
9354 <member name="P:NAnt.Core.Types.FileSet.IncludesFile.UnlessDefined">
9355 <summary>
9356 Opposite of <see cref="P:NAnt.Core.Types.FileSet.IncludesFile.IfDefined"/>. If <see langword="false"/>
9357 then the patterns will be included; otherwise, skipped. The default
9358 is <see langword="false"/>.
9359 </summary>
9360 </member>
9361 <member name="M:NAnt.Core.Types.DirSet.#ctor">
9362 <summary>
9363 Initializes a new instance of the <see cref="T:NAnt.Core.Types.DirSet"/> class.
9364 </summary>
9365 </member>
9366 <member name="M:NAnt.Core.Types.DirSet.#ctor(NAnt.Core.Types.FileSet)">
9367 <summary>
9368 Copy constructor for <see cref="T:NAnt.Core.Types.FileSet"/>. Required in order to
9369 assign references of <see cref="T:NAnt.Core.Types.FileSet"/> type where
9370 <see cref="T:NAnt.Core.Types.DirSet"/> is used.
9371 </summary>
9372 <param name="fs">A <see cref="T:NAnt.Core.Types.FileSet"/> instance to create a <see cref="T:NAnt.Core.Types.DirSet"/> from.</param>
9373 </member>
9374 <member name="T:NAnt.Core.Types.EnvironmentVariable">
9375 <summary>
9376 Represents an environment variable.
9377 </summary>
9378 </member>
9379 <member name="M:NAnt.Core.Types.EnvironmentVariable.#ctor(System.String,System.String)">
9380 <summary>
9381 Initializes a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instance with the
9382 specified name and value.
9383 </summary>
9384 <param name="name">The name of the environment variable.</param>
9385 <param name="value">The value of the environment variable.</param>
9386 </member>
9387 <member name="M:NAnt.Core.Types.EnvironmentVariable.#ctor">
9388 <summary>
9389 Initializes a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instance.
9390 </summary>
9391 </member>
9392 <member name="P:NAnt.Core.Types.EnvironmentVariable.VariableName">
9393 <summary>
9394 The name of the environment variable.
9395 </summary>
9396 </member>
9397 <member name="P:NAnt.Core.Types.EnvironmentVariable.LiteralValue">
9398 <summary>
9399 The literal value for the environment variable.
9400 </summary>
9401 </member>
9402 <member name="P:NAnt.Core.Types.EnvironmentVariable.File">
9403 <summary>
9404 The value for a file-based environment variable. NAnt will convert
9405 it to an absolute filename.
9406 </summary>
9407 </member>
9408 <member name="P:NAnt.Core.Types.EnvironmentVariable.Directory">
9409 <summary>
9410 The value for a directory-based environment variable. NAnt will
9411 convert it to an absolute path.
9412 </summary>
9413 </member>
9414 <member name="P:NAnt.Core.Types.EnvironmentVariable.Path">
9415 <summary>
9416 The value for a PATH like environment variable. You can use
9417 <c>:</c> or <c>;</c> as path separators and NAnt will convert it to
9418 the platform's local conventions.
9419 </summary>
9420 </member>
9421 <member name="P:NAnt.Core.Types.EnvironmentVariable.PathSet">
9422 <summary>
9423 Sets a single environment variable and treats it like a PATH -
9424 ensures the right separator for the local platform is used.
9425 </summary>
9426 </member>
9427 <member name="P:NAnt.Core.Types.EnvironmentVariable.Value">
9428 <summary>
9429 Gets the value of the environment variable.
9430 </summary>
9431 </member>
9432 <member name="P:NAnt.Core.Types.EnvironmentVariable.IfDefined">
9433 <summary>
9434 Indicates if the environment variable should be passed to the
9435 external program. If <see langword="true" /> then the environment
9436 variable will be passed; otherwise, skipped. The default is
9437 <see langword="true" />.
9438 </summary>
9439 </member>
9440 <member name="P:NAnt.Core.Types.EnvironmentVariable.UnlessDefined">
9441 <summary>
9442 Indicates if the environment variable should not be passed to the
9443 external program. If <see langword="false" /> then the environment
9444 variable will be passed; otherwise, skipped. The default is
9445 <see langword="false" />.
9446 </summary>
9447 </member>
9448 <member name="T:NAnt.Core.Types.EnvironmentSet">
9449 <summary>
9450 A set of environment variables.
9451 </summary>
9452 </member>
9453 <member name="P:NAnt.Core.Types.EnvironmentSet.Options">
9454 <summary>
9455 Environment variable to pass to a program.
9456 </summary>
9457 </member>
9458 <member name="P:NAnt.Core.Types.EnvironmentSet.EnvironmentVariables">
9459 <summary>
9460 Environment variable to pass to a program.
9461 </summary>
9462 </member>
9463 <member name="T:NAnt.Core.Types.EnvironmentVariableCollection">
9464 <summary>
9465 Contains a collection of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements.
9466 </summary>
9467 </member>
9468 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor">
9469 <summary>
9470 Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class.
9471 </summary>
9472 </member>
9473 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor(NAnt.Core.Types.EnvironmentVariableCollection)">
9474 <summary>
9475 Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class
9476 with the specified <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> instance.
9477 </summary>
9478 </member>
9479 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor(NAnt.Core.Types.EnvironmentVariable[])">
9480 <summary>
9481 Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class
9482 with the specified array of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instances.
9483 </summary>
9484 </member>
9485 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Add(NAnt.Core.Types.EnvironmentVariable)">
9486 <summary>
9487 Adds a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to the end of the collection.
9488 </summary>
9489 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to be added to the end of the collection.</param>
9490 <returns>The position into which the new element was inserted.</returns>
9491 </member>
9492 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.AddRange(NAnt.Core.Types.EnvironmentVariable[])">
9493 <summary>
9494 Adds the elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> array to the end of the collection.
9495 </summary>
9496 <param name="items">The array of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements to be added to the end of the collection.</param>
9497 </member>
9498 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.AddRange(NAnt.Core.Types.EnvironmentVariableCollection)">
9499 <summary>
9500 Adds the elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> to the end of the collection.
9501 </summary>
9502 <param name="items">The <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> to be added to the end of the collection.</param>
9503 </member>
9504 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Contains(NAnt.Core.Types.EnvironmentVariable)">
9505 <summary>
9506 Determines whether a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> is in the collection.
9507 </summary>
9508 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to locate in the collection.</param>
9509 <returns>
9510 <see langword="true"/> if <paramref name="item"/> is found in the
9511 collection; otherwise, <see langword="false"/>.
9512 </returns>
9513 </member>
9514 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Contains(System.String)">
9515 <summary>
9516 Determines whether a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with the specified
9517 value is in the collection.
9518 </summary>
9519 <param name="value">The argument value to locate in the collection.</param>
9520 <returns>
9521 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with value
9522 <paramref name="value"/> is found in the collection; otherwise,
9523 <see langword="false"/>.
9524 </returns>
9525 </member>
9526 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.CopyTo(NAnt.Core.Types.EnvironmentVariable[],System.Int32)">
9527 <summary>
9528 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
9529 </summary>
9530 <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>
9531 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
9532 </member>
9533 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.IndexOf(NAnt.Core.Types.EnvironmentVariable)">
9534 <summary>
9535 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> object in the collection.
9536 </summary>
9537 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> object for which the index is returned.</param>
9538 <returns>
9539 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.
9540 </returns>
9541 </member>
9542 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Insert(System.Int32,NAnt.Core.Types.EnvironmentVariable)">
9543 <summary>
9544 Inserts a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> into the collection at the specified index.
9545 </summary>
9546 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
9547 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to insert.</param>
9548 </member>
9549 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.GetEnumerator">
9550 <summary>
9551 Returns an enumerator that can iterate through the collection.
9552 </summary>
9553 <returns>
9554 A <see cref="T:NAnt.Core.Types.EnvironmentVariableEnumerator"/> for the entire collection.
9555 </returns>
9556 </member>
9557 <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Remove(NAnt.Core.Types.EnvironmentVariable)">
9558 <summary>
9559 Removes a member from the collection.
9560 </summary>
9561 <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to remove from the collection.</param>
9562 </member>
9563 <member name="P:NAnt.Core.Types.EnvironmentVariableCollection.Item(System.Int32)">
9564 <summary>
9565 Gets or sets the element at the specified index.
9566 </summary>
9567 <param name="index">The zero-based index of the element to get or set.</param>
9568 </member>
9569 <member name="P:NAnt.Core.Types.EnvironmentVariableCollection.Item(System.String)">
9570 <summary>
9571 Gets the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with the specified name.
9572 </summary>
9573 <param name="name">The name of the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to get.</param>
9574 </member>
9575 <member name="T:NAnt.Core.Types.EnvironmentVariableEnumerator">
9576 <summary>
9577 Enumerates the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/>.
9578 </summary>
9579 </member>
9580 <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.#ctor(NAnt.Core.Types.EnvironmentVariableCollection)">
9581 <summary>
9582 Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableEnumerator"/> class
9583 with the specified <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/>.
9584 </summary>
9585 <param name="arguments">The collection that should be enumerated.</param>
9586 </member>
9587 <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.MoveNext">
9588 <summary>
9589 Advances the enumerator to the next element of the collection.
9590 </summary>
9591 <returns>
9592 <see langword="true" /> if the enumerator was successfully advanced
9593 to the next element; <see langword="false" /> if the enumerator has
9594 passed the end of the collection.
9595 </returns>
9596 </member>
9597 <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.Reset">
9598 <summary>
9599 Sets the enumerator to its initial position, which is before the
9600 first element in the collection.
9601 </summary>
9602 </member>
9603 <member name="P:NAnt.Core.Types.EnvironmentVariableEnumerator.Current">
9604 <summary>
9605 Gets the current element in the collection.
9606 </summary>
9607 <returns>
9608 The current element in the collection.
9609 </returns>
9610 </member>
9611 <member name="P:NAnt.Core.Types.Formatter.Property">
9612 <summary>
9613 The name of the NAnt property to set.
9614 </summary>
9615 </member>
9616 <member name="P:NAnt.Core.Types.Formatter.Pattern">
9617 <summary>
9618 The string pattern to use to format the property.
9619 </summary>
9620 </member>
9621 <member name="P:NAnt.Core.Types.Formatter.IfDefined">
9622 <summary>
9623 Indicates if the formatter should be used to format the timestamp.
9624 If <see langword="true" /> then the formatter will be used;
9625 otherwise, skipped. The default is <see langword="true" />.
9626 </summary>
9627 </member>
9628 <member name="P:NAnt.Core.Types.Formatter.UnlessDefined">
9629 <summary>
9630 Indicates if the formatter should be not used to format the
9631 timestamp. If <see langword="false" /> then the formatter will be
9632 used; otherwise, skipped. The default is <see langword="false" />.
9633 </summary>
9634 </member>
9635 <member name="T:NAnt.Core.Types.FormatterCollection">
9636 <summary>
9637 Contains a collection of <see cref="T:NAnt.Core.Types.Formatter"/> elements.
9638 </summary>
9639 </member>
9640 <member name="M:NAnt.Core.Types.FormatterCollection.#ctor">
9641 <summary>
9642 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class.
9643 </summary>
9644 </member>
9645 <member name="M:NAnt.Core.Types.FormatterCollection.#ctor(NAnt.Core.Types.FormatterCollection)">
9646 <summary>
9647 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class
9648 with the specified <see cref="T:NAnt.Core.Types.FormatterCollection"/> instance.
9649 </summary>
9650 </member>
9651 <member name="M:NAnt.Core.Types.FormatterCollection.#ctor(NAnt.Core.Types.Formatter[])">
9652 <summary>
9653 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class
9654 with the specified array of <see cref="T:NAnt.Core.Types.Formatter"/> instances.
9655 </summary>
9656 </member>
9657 <member name="M:NAnt.Core.Types.FormatterCollection.Add(NAnt.Core.Types.Formatter)">
9658 <summary>
9659 Adds a <see cref="T:NAnt.Core.Types.Formatter"/> to the end of the collection.
9660 </summary>
9661 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to be added to the end of the collection.</param>
9662 <returns>The position into which the new element was inserted.</returns>
9663 </member>
9664 <member name="M:NAnt.Core.Types.FormatterCollection.AddRange(NAnt.Core.Types.Formatter[])">
9665 <summary>
9666 Adds the elements of a <see cref="T:NAnt.Core.Types.Formatter"/> array to the end of the collection.
9667 </summary>
9668 <param name="items">The array of <see cref="T:NAnt.Core.Types.Formatter"/> elements to be added to the end of the collection.</param>
9669 </member>
9670 <member name="M:NAnt.Core.Types.FormatterCollection.AddRange(NAnt.Core.Types.FormatterCollection)">
9671 <summary>
9672 Adds the elements of a <see cref="T:NAnt.Core.Types.FormatterCollection"/> to the end of the collection.
9673 </summary>
9674 <param name="items">The <see cref="T:NAnt.Core.Types.FormatterCollection"/> to be added to the end of the collection.</param>
9675 </member>
9676 <member name="M:NAnt.Core.Types.FormatterCollection.Contains(NAnt.Core.Types.Formatter)">
9677 <summary>
9678 Determines whether a <see cref="T:NAnt.Core.Types.Formatter"/> is in the collection.
9679 </summary>
9680 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to locate in the collection.</param>
9681 <returns>
9682 <see langword="true"/> if <paramref name="item"/> is found in the
9683 collection; otherwise, <see langword="false"/>.
9684 </returns>
9685 </member>
9686 <member name="M:NAnt.Core.Types.FormatterCollection.CopyTo(NAnt.Core.Types.Formatter[],System.Int32)">
9687 <summary>
9688 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
9689 </summary>
9690 <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>
9691 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
9692 </member>
9693 <member name="M:NAnt.Core.Types.FormatterCollection.IndexOf(NAnt.Core.Types.Formatter)">
9694 <summary>
9695 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Formatter"/> object in the collection.
9696 </summary>
9697 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> object for which the index is returned.</param>
9698 <returns>
9699 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.
9700 </returns>
9701 </member>
9702 <member name="M:NAnt.Core.Types.FormatterCollection.Insert(System.Int32,NAnt.Core.Types.Formatter)">
9703 <summary>
9704 Inserts a <see cref="T:NAnt.Core.Types.Formatter"/> into the collection at the specified index.
9705 </summary>
9706 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
9707 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to insert.</param>
9708 </member>
9709 <member name="M:NAnt.Core.Types.FormatterCollection.GetEnumerator">
9710 <summary>
9711 Returns an enumerator that can iterate through the collection.
9712 </summary>
9713 <returns>
9714 A <see cref="T:NAnt.Core.Types.FormatterEnumerator"/> for the entire collection.
9715 </returns>
9716 </member>
9717 <member name="M:NAnt.Core.Types.FormatterCollection.Remove(NAnt.Core.Types.Formatter)">
9718 <summary>
9719 Removes a member from the collection.
9720 </summary>
9721 <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to remove from the collection.</param>
9722 </member>
9723 <member name="P:NAnt.Core.Types.FormatterCollection.Item(System.Int32)">
9724 <summary>
9725 Gets or sets the element at the specified index.
9726 </summary>
9727 <param name="index">The zero-based index of the element to get or set.</param>
9728 </member>
9729 <member name="T:NAnt.Core.Types.FormatterEnumerator">
9730 <summary>
9731 Enumerates the <see cref="T:NAnt.Core.Types.Formatter"/> elements of a <see cref="T:NAnt.Core.Types.FormatterCollection"/>.
9732 </summary>
9733 </member>
9734 <member name="M:NAnt.Core.Types.FormatterEnumerator.#ctor(NAnt.Core.Types.FormatterCollection)">
9735 <summary>
9736 Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterEnumerator"/> class
9737 with the specified <see cref="T:NAnt.Core.Types.FormatterCollection"/>.
9738 </summary>
9739 <param name="arguments">The collection that should be enumerated.</param>
9740 </member>
9741 <member name="M:NAnt.Core.Types.FormatterEnumerator.MoveNext">
9742 <summary>
9743 Advances the enumerator to the next element of the collection.
9744 </summary>
9745 <returns>
9746 <see langword="true" /> if the enumerator was successfully advanced
9747 to the next element; <see langword="false" /> if the enumerator has
9748 passed the end of the collection.
9749 </returns>
9750 </member>
9751 <member name="M:NAnt.Core.Types.FormatterEnumerator.Reset">
9752 <summary>
9753 Sets the enumerator to its initial position, which is before the
9754 first element in the collection.
9755 </summary>
9756 </member>
9757 <member name="P:NAnt.Core.Types.FormatterEnumerator.Current">
9758 <summary>
9759 Gets the current element in the collection.
9760 </summary>
9761 <returns>
9762 The current element in the collection.
9763 </returns>
9764 </member>
9765 <member name="T:NAnt.Core.Types.ManagedExecution">
9766 <summary>
9767 Specifies the execution mode for managed applications.
9768 </summary>
9769 <remarks>
9770 <para>
9771 For backward compatibility, the following string values can also be
9772 used in build files:
9773 </para>
9774 <list type="table">
9775 <listheader>
9776 <term>Value</term>
9777 <description>Corresponding field</description>
9778 </listheader>
9779 <item>
9780 <term>"true"</term>
9781 <description><see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/></description>
9782 </item>
9783 <item>
9784 <term>"false"</term>
9785 <description><see cref="F:NAnt.Core.Types.ManagedExecution.Default"/></description>
9786 </item>
9787 </list>
9788 <para>
9789 Even if set to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>, the operating system can still
9790 run the program as a managed application.
9791 </para>
9792 <para>On Linux this can be done through <b>binfmt_misc</b>, while on
9793 Windows installing the .NET Framework redistributable caused managed
9794 applications to run on the MS CLR by default.
9795 </para>
9796 </remarks>
9797 </member>
9798 <member name="F:NAnt.Core.Types.ManagedExecution.Default">
9799 <summary>
9800 Do not threat the program as a managed application.
9801 </summary>
9802 </member>
9803 <member name="F:NAnt.Core.Types.ManagedExecution.Auto">
9804 <summary>
9805 Leave it up to the CLR to determine which specific version of
9806 the CLR will be used to run the application.
9807 </summary>
9808 </member>
9809 <member name="F:NAnt.Core.Types.ManagedExecution.Strict">
9810 <summary>
9811 Forces an application to run against the currently targeted
9812 version of a given CLR.
9813 </summary>
9814 </member>
9815 <member name="T:NAnt.Core.Types.ManagedExecutionConverter">
9816 <summary>
9817 Specialized <see cref="T:System.ComponentModel.EnumConverter"/> that also supports
9818 case-insensitive conversion of "true" to
9819 <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/> and "false" to
9820 <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>.
9821 </summary>
9822 </member>
9823 <member name="M:NAnt.Core.Types.ManagedExecutionConverter.#ctor">
9824 <summary>
9825 Initializes a new instance of the <see cref="T:NAnt.Core.Types.ManagedExecutionConverter"/>
9826 class.
9827 </summary>
9828 </member>
9829 <member name="M:NAnt.Core.Types.ManagedExecutionConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
9830 <summary>
9831 Converts the given object to the type of this converter, using the
9832 specified context and culture information.
9833 </summary>
9834 <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
9835 <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
9836 <param name="value">The <see cref="T:System.Object"/> to convert.</param>
9837 <returns>
9838 An <see cref="T:System.Object"/> that represents the converted value.
9839 </returns>
9840 </member>
9841 <member name="T:NAnt.Core.Types.Option">
9842 <summary>
9843 Represents an option.
9844 </summary>
9845 </member>
9846 <member name="M:NAnt.Core.Types.Option.#ctor(System.String,System.String)">
9847 <summary>
9848 name, value constructor
9849 </summary>
9850 <param name="name"></param>
9851 <param name="value"></param>
9852 </member>
9853 <member name="M:NAnt.Core.Types.Option.#ctor">
9854 <summary>
9855 Default constructor
9856 </summary>
9857 </member>
9858 <member name="P:NAnt.Core.Types.Option.OptionName">
9859 <summary>
9860 Name of the option.
9861 </summary>
9862 </member>
9863 <member name="P:NAnt.Core.Types.Option.Value">
9864 <summary>
9865 Value of the option. The default is <see langword="null" />.
9866 </summary>
9867 </member>
9868 <member name="P:NAnt.Core.Types.Option.IfDefined">
9869 <summary>
9870 Indicates if the option should be passed to the task.
9871 If <see langword="true" /> then the option will be passed;
9872 otherwise, skipped. The default is <see langword="true" />.
9873 </summary>
9874 </member>
9875 <member name="P:NAnt.Core.Types.Option.UnlessDefined">
9876 <summary>
9877 Indicates if the option should not be passed to the task.
9878 If <see langword="false" /> then the option will be passed;
9879 otherwise, skipped. The default is <see langword="false" />.
9880 </summary>
9881 </member>
9882 <member name="T:NAnt.Core.Types.OptionCollection">
9883 <summary>
9884 Contains a collection of <see cref="T:NAnt.Core.Types.Option"/> elements.
9885 </summary>
9886 </member>
9887 <member name="M:NAnt.Core.Types.OptionCollection.#ctor">
9888 <summary>
9889 Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class.
9890 </summary>
9891 </member>
9892 <member name="M:NAnt.Core.Types.OptionCollection.#ctor(NAnt.Core.Types.OptionCollection)">
9893 <summary>
9894 Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class
9895 with the specified <see cref="T:NAnt.Core.Types.OptionCollection"/> instance.
9896 </summary>
9897 </member>
9898 <member name="M:NAnt.Core.Types.OptionCollection.#ctor(NAnt.Core.Types.Option[])">
9899 <summary>
9900 Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class
9901 with the specified array of <see cref="T:NAnt.Core.Types.Option"/> instances.
9902 </summary>
9903 </member>
9904 <member name="M:NAnt.Core.Types.OptionCollection.Add(NAnt.Core.Types.Option)">
9905 <summary>
9906 Adds a <see cref="T:NAnt.Core.Types.Option"/> to the end of the collection.
9907 </summary>
9908 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to be added to the end of the collection.</param>
9909 <returns>The position into which the new element was inserted.</returns>
9910 </member>
9911 <member name="M:NAnt.Core.Types.OptionCollection.AddRange(NAnt.Core.Types.Option[])">
9912 <summary>
9913 Adds the elements of a <see cref="T:NAnt.Core.Types.Option"/> array to the end of the collection.
9914 </summary>
9915 <param name="items">The array of <see cref="T:NAnt.Core.Types.Option"/> elements to be added to the end of the collection.</param>
9916 </member>
9917 <member name="M:NAnt.Core.Types.OptionCollection.AddRange(NAnt.Core.Types.OptionCollection)">
9918 <summary>
9919 Adds the elements of a <see cref="T:NAnt.Core.Types.OptionCollection"/> to the end of the collection.
9920 </summary>
9921 <param name="items">The <see cref="T:NAnt.Core.Types.OptionCollection"/> to be added to the end of the collection.</param>
9922 </member>
9923 <member name="M:NAnt.Core.Types.OptionCollection.Contains(NAnt.Core.Types.Option)">
9924 <summary>
9925 Determines whether a <see cref="T:NAnt.Core.Types.Option"/> is in the collection.
9926 </summary>
9927 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to locate in the collection.</param>
9928 <returns>
9929 <see langword="true"/> if <paramref name="item"/> is found in the
9930 collection; otherwise, <see langword="false"/>.
9931 </returns>
9932 </member>
9933 <member name="M:NAnt.Core.Types.OptionCollection.Contains(System.String)">
9934 <summary>
9935 Determines whether a <see cref="T:NAnt.Core.Types.Option"/> for the specified
9936 task is in the collection.
9937 </summary>
9938 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Types.Option"/> should be located in the collection.</param>
9939 <returns>
9940 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.Option"/> for the specified
9941 task is found in the collection; otherwise, <see langword="false"/>.
9942 </returns>
9943 </member>
9944 <member name="M:NAnt.Core.Types.OptionCollection.CopyTo(NAnt.Core.Types.Option[],System.Int32)">
9945 <summary>
9946 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
9947 </summary>
9948 <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>
9949 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
9950 </member>
9951 <member name="M:NAnt.Core.Types.OptionCollection.IndexOf(NAnt.Core.Types.Option)">
9952 <summary>
9953 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Option"/> object in the collection.
9954 </summary>
9955 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> object for which the index is returned.</param>
9956 <returns>
9957 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.
9958 </returns>
9959 </member>
9960 <member name="M:NAnt.Core.Types.OptionCollection.Insert(System.Int32,NAnt.Core.Types.Option)">
9961 <summary>
9962 Inserts a <see cref="T:NAnt.Core.Types.Option"/> into the collection at the specified index.
9963 </summary>
9964 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
9965 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to insert.</param>
9966 </member>
9967 <member name="M:NAnt.Core.Types.OptionCollection.GetEnumerator">
9968 <summary>
9969 Returns an enumerator that can iterate through the collection.
9970 </summary>
9971 <returns>
9972 A <see cref="T:NAnt.Core.Types.OptionEnumerator"/> for the entire collection.
9973 </returns>
9974 </member>
9975 <member name="M:NAnt.Core.Types.OptionCollection.Remove(NAnt.Core.Types.Option)">
9976 <summary>
9977 Removes a member from the collection.
9978 </summary>
9979 <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to remove from the collection.</param>
9980 </member>
9981 <member name="P:NAnt.Core.Types.OptionCollection.Item(System.Int32)">
9982 <summary>
9983 Gets or sets the element at the specified index.
9984 </summary>
9985 <param name="index">The zero-based index of the element to get or set.</param>
9986 </member>
9987 <member name="P:NAnt.Core.Types.OptionCollection.Item(System.String)">
9988 <summary>
9989 Gets the <see cref="T:NAnt.Core.Types.Option"/> with the specified name.
9990 </summary>
9991 <param name="name">The name of the option that should be located in the collection.</param>
9992 </member>
9993 <member name="T:NAnt.Core.Types.OptionEnumerator">
9994 <summary>
9995 Enumerates the <see cref="T:NAnt.Core.Types.Option"/> elements of a <see cref="T:NAnt.Core.Types.OptionCollection"/>.
9996 </summary>
9997 </member>
9998 <member name="M:NAnt.Core.Types.OptionEnumerator.#ctor(NAnt.Core.Types.OptionCollection)">
9999 <summary>
10000 Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionEnumerator"/> class
10001 with the specified <see cref="T:NAnt.Core.Types.OptionCollection"/>.
10002 </summary>
10003 <param name="arguments">The collection that should be enumerated.</param>
10004 </member>
10005 <member name="M:NAnt.Core.Types.OptionEnumerator.MoveNext">
10006 <summary>
10007 Advances the enumerator to the next element of the collection.
10008 </summary>
10009 <returns>
10010 <see langword="true" /> if the enumerator was successfully advanced
10011 to the next element; <see langword="false" /> if the enumerator has
10012 passed the end of the collection.
10013 </returns>
10014 </member>
10015 <member name="M:NAnt.Core.Types.OptionEnumerator.Reset">
10016 <summary>
10017 Sets the enumerator to its initial position, which is before the
10018 first element in the collection.
10019 </summary>
10020 </member>
10021 <member name="P:NAnt.Core.Types.OptionEnumerator.Current">
10022 <summary>
10023 Gets the current element in the collection.
10024 </summary>
10025 <returns>
10026 The current element in the collection.
10027 </returns>
10028 </member>
10029 <member name="T:NAnt.Core.Types.PathElement">
10030 <summary>
10031 Represents a nested path element.
10032 </summary>
10033 </member>
10034 <member name="P:NAnt.Core.Types.PathElement.File">
10035 <summary>
10036 The name of a file to add to the path. Will be replaced with
10037 the absolute path of the file.
10038 </summary>
10039 </member>
10040 <member name="P:NAnt.Core.Types.PathElement.Directory">
10041 <summary>
10042 The name of a directory to add to the path. Will be replaced with
10043 the absolute path of the directory.
10044 </summary>
10045 </member>
10046 <member name="P:NAnt.Core.Types.PathElement.Path">
10047 <summary>
10048 A string that will be treated as a path-like string. You can use
10049 <c>:</c> or <c>;</c> as path separators and NAnt will convert it
10050 to the platform's local conventions, while resolving references
10051 to environment variables.
10052 </summary>
10053 </member>
10054 <member name="P:NAnt.Core.Types.PathElement.IfDefined">
10055 <summary>
10056 If <see langword="true" /> then the entry will be added to the
10057 path; otherwise, skipped. The default is <see langword="true" />.
10058 </summary>
10059 </member>
10060 <member name="P:NAnt.Core.Types.PathElement.UnlessDefined">
10061 <summary>
10062 Opposite of <see cref="P:NAnt.Core.Types.PathElement.IfDefined"/>. If <see langword="false"/>
10063 then the entry will be added to the path; otherwise, skipped.
10064 The default is <see langword="false"/>.
10065 </summary>
10066 </member>
10067 <member name="P:NAnt.Core.Types.PathElement.Parts">
10068 <summary>
10069 Gets the parts of a path represented by this element.
10070 </summary>
10071 <value>
10072 A <see cref="T:System.Collections.Specialized.StringCollection"/> containing the parts of a path
10073 represented by this element.
10074 </value>
10075 </member>
10076 <member name="T:NAnt.Core.Types.PathSet">
10077 <summary>
10078 <para>
10079 Paths are groups of files and/or directories that need to be passed as a single
10080 unit. The order in which parts of the path are specified in the build file is
10081 retained, and duplicate parts are automatically suppressed.
10082 </para>
10083 </summary>
10084 <example>
10085 <para>
10086 Define a global <c><path></c> that can be referenced by other
10087 tasks or types.
10088 </para>
10089 <code>
10090 <![CDATA[
10091 <path id="includes-path">
10092 <pathelement path="%INCLUDE%" />
10093 <pathelement dir="${build.dir}/include" />
10094 </path>
10095 ]]>
10096 </code>
10097 </example>
10098 </member>
10099 <member name="M:NAnt.Core.Types.PathSet.#ctor">
10100 <summary>
10101 Initializes a new instance of the <see cref="T:NAnt.Core.Types.PathSet"/> class.
10102 </summary>
10103 </member>
10104 <member name="M:NAnt.Core.Types.PathSet.#ctor(NAnt.Core.Project,System.String)">
10105 <summary>
10106 Invoked by <see cref="T:NAnt.Core.Element.AttributeConfigurator"/> for build
10107 attributes with an underlying <see cref="T:NAnt.Core.Types.PathSet"/> type.
10108 </summary>
10109 <param name="project">The <see cref="T:NAnt.Core.Project"/> to be used to resolve relative paths.</param>
10110 <param name="path">The string representing a path.</param>
10111 </member>
10112 <member name="M:NAnt.Core.Types.PathSet.ToString">
10113 <summary>
10114 Returns a textual representation of the path, which can be used as
10115 PATH environment variable definition.
10116 </summary>
10117 <returns>
10118 A textual representation of the path.
10119 </returns>
10120 </member>
10121 <member name="M:NAnt.Core.Types.PathSet.AddPath(NAnt.Core.Types.PathSet)">
10122 <summary>
10123 Defines a set of path elements to add to the current path.
10124 </summary>
10125 <param name="path">The <see cref="T:NAnt.Core.Types.PathSet"/> to add.</param>
10126 </member>
10127 <member name="M:NAnt.Core.Types.PathSet.AddPathElement(NAnt.Core.Types.PathElement)">
10128 <summary>
10129 Defines a path element to add to the current path.
10130 </summary>
10131 <param name="pathElement">The <see cref="T:NAnt.Core.Types.PathElement"/> to add.</param>
10132 </member>
10133 <member name="M:NAnt.Core.Types.PathSet.GetElements">
10134 <summary>
10135 Returns all path elements defined by this path object.
10136 </summary>
10137 <returns>
10138 A list of path elements.
10139 </returns>
10140 </member>
10141 <member name="M:NAnt.Core.Types.PathSet.TranslatePath(NAnt.Core.Project,System.String)">
10142 <summary>
10143 Splits a PATH (with ; or : as separators) into its parts, while
10144 resolving references to environment variables.
10145 </summary>
10146 <param name="project">The <see cref="T:NAnt.Core.Project"/> to be used to resolve relative paths.</param>
10147 <param name="source">The path to translate.</param>
10148 <returns>
10149 A PATH split up its parts, with references to environment variables
10150 resolved and duplicate entries removed.
10151 </returns>
10152 </member>
10153 <member name="M:NAnt.Core.Types.Pattern.#ctor">
10154 <summary>
10155 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Pattern"/> class.
10156 </summary>
10157 </member>
10158 <member name="P:NAnt.Core.Types.Pattern.PatternName">
10159 <summary>
10160 The name pattern to include/exclude.
10161 </summary>
10162 </member>
10163 <member name="P:NAnt.Core.Types.Pattern.IfDefined">
10164 <summary>
10165 If <see langword="true" /> then the pattern will be used;
10166 otherwise, skipped. The default is <see langword="true" />.
10167 </summary>
10168 </member>
10169 <member name="P:NAnt.Core.Types.Pattern.UnlessDefined">
10170 <summary>
10171 If <see langword="false" /> then the pattern will be used;
10172 otherwise, skipped. The default is <see langword="false" />.
10173 </summary>
10174 </member>
10175 <member name="T:NAnt.Core.Types.PatternCollection">
10176 <summary>
10177 Contains a collection of <see cref="T:NAnt.Core.Types.Pattern"/> elements.
10178 </summary>
10179 </member>
10180 <member name="M:NAnt.Core.Types.PatternCollection.#ctor">
10181 <summary>
10182 Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternCollection"/> class.
10183 </summary>
10184 </member>
10185 <member name="M:NAnt.Core.Types.PatternCollection.Clear">
10186 <summary>
10187 Removes all items from the <see cref="T:NAnt.Core.Types.PatternCollection"/>.
10188 </summary>
10189 </member>
10190 <member name="M:NAnt.Core.Types.PatternCollection.Add(NAnt.Core.Types.Pattern)">
10191 <summary>
10192 Adds a <see cref="T:NAnt.Core.Types.Pattern"/> to the end of the collection.
10193 </summary>
10194 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to be added to the end of the collection.</param>
10195 <returns>The position into which the new element was inserted.</returns>
10196 </member>
10197 <member name="M:NAnt.Core.Types.PatternCollection.AddRange(NAnt.Core.Types.Pattern[])">
10198 <summary>
10199 Adds the elements of a <see cref="T:NAnt.Core.Types.Pattern"/> array to the end of the collection.
10200 </summary>
10201 <param name="items">The array of <see cref="T:NAnt.Core.Types.Pattern"/> elements to be added to the end of the collection.</param>
10202 </member>
10203 <member name="M:NAnt.Core.Types.PatternCollection.AddRange(NAnt.Core.Types.PatternCollection)">
10204 <summary>
10205 Adds the elements of a <see cref="T:NAnt.Core.Types.PatternCollection"/> to the end of the collection.
10206 </summary>
10207 <param name="items">The <see cref="T:NAnt.Core.Types.PatternCollection"/> to be added to the end of the collection.</param>
10208 </member>
10209 <member name="M:NAnt.Core.Types.PatternCollection.Contains(NAnt.Core.Types.Pattern)">
10210 <summary>
10211 Determines whether a <see cref="T:NAnt.Core.Types.Pattern"/> is in the collection.
10212 </summary>
10213 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to locate in the collection.</param>
10214 <returns>
10215 <see langword="true"/> if <paramref name="item"/> is found in the
10216 collection; otherwise, <see langword="false"/>.
10217 </returns>
10218 </member>
10219 <member name="M:NAnt.Core.Types.PatternCollection.CopyTo(NAnt.Core.Types.Pattern[],System.Int32)">
10220 <summary>
10221 Copies the entire collection to a compatible one-dimensional array,
10222 starting at the specified index of the target array.
10223 </summary>
10224 <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>
10225 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
10226 </member>
10227 <member name="M:NAnt.Core.Types.PatternCollection.IndexOf(NAnt.Core.Types.Pattern)">
10228 <summary>
10229 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Pattern"/> object in the collection.
10230 </summary>
10231 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> object for which the index is returned.</param>
10232 <returns>
10233 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.
10234 </returns>
10235 </member>
10236 <member name="M:NAnt.Core.Types.PatternCollection.Insert(System.Int32,NAnt.Core.Types.Pattern)">
10237 <summary>
10238 Inserts a <see cref="T:NAnt.Core.Types.Pattern"/> into the collection at the specified index.
10239 </summary>
10240 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
10241 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to insert.</param>
10242 </member>
10243 <member name="M:NAnt.Core.Types.PatternCollection.GetEnumerator">
10244 <summary>
10245 Returns an enumerator that can iterate through the collection.
10246 </summary>
10247 <returns>
10248 A <see cref="T:NAnt.Core.Types.PatternEnumerator"/> for the entire collection.
10249 </returns>
10250 </member>
10251 <member name="M:NAnt.Core.Types.PatternCollection.Remove(NAnt.Core.Types.Pattern)">
10252 <summary>
10253 Removes a member from the collection.
10254 </summary>
10255 <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to remove from the collection.</param>
10256 </member>
10257 <member name="P:NAnt.Core.Types.PatternCollection.Item(System.Int32)">
10258 <summary>
10259 Gets or sets the element at the specified index.
10260 </summary>
10261 <param name="index">The zero-based index of the element to get or set.</param>
10262 </member>
10263 <member name="T:NAnt.Core.Types.PatternEnumerator">
10264 <summary>
10265 Enumerates the <see cref="T:NAnt.Core.Types.Pattern"/> elements of a <see cref="T:NAnt.Core.Types.PatternCollection"/>.
10266 </summary>
10267 </member>
10268 <member name="M:NAnt.Core.Types.PatternEnumerator.#ctor(NAnt.Core.Types.PatternCollection)">
10269 <summary>
10270 Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternEnumerator"/> class
10271 with the specified <see cref="T:NAnt.Core.Types.PatternCollection"/>.
10272 </summary>
10273 <param name="arguments">The collection that should be enumerated.</param>
10274 </member>
10275 <member name="M:NAnt.Core.Types.PatternEnumerator.MoveNext">
10276 <summary>
10277 Advances the enumerator to the next element of the collection.
10278 </summary>
10279 <returns>
10280 <see langword="true" /> if the enumerator was successfully advanced
10281 to the next element; <see langword="false" /> if the enumerator has
10282 passed the end of the collection.
10283 </returns>
10284 </member>
10285 <member name="M:NAnt.Core.Types.PatternEnumerator.Reset">
10286 <summary>
10287 Sets the enumerator to its initial position, which is before the
10288 first element in the collection.
10289 </summary>
10290 </member>
10291 <member name="P:NAnt.Core.Types.PatternEnumerator.Current">
10292 <summary>
10293 Gets the current element in the collection.
10294 </summary>
10295 <returns>
10296 The current element in the collection.
10297 </returns>
10298 </member>
10299 <member name="P:NAnt.Core.Types.PatternEnumerator.System#Collections#IEnumerator#Current">
10300 <summary>
10301 Gets the current element in the collection.
10302 </summary>
10303 <returns>
10304 The current element in the collection.
10305 </returns>
10306 </member>
10307 <member name="T:NAnt.Core.Types.PatternSet">
10308 <summary>
10309 A set of patterns, mostly used to include or exclude certain files.
10310 </summary>
10311 <remarks>
10312 <para>
10313 The individual patterns support <c>if</c> and <c>unless</c> attributes
10314 to specify that the element should only be used if or unless a given
10315 condition is met.
10316 </para>
10317 <para>
10318 The <see cref="P:NAnt.Core.Types.PatternSet.IncludesFile"/> and <see cref="P:NAnt.Core.Types.PatternSet.ExcludesFile"/>
10319 elements load patterns from a file. When the file is a relative path,
10320 it will be resolved relative to the project base directory in which
10321 the patternset is defined. Each line of this file is taken to be a
10322 pattern.
10323 </para>
10324 <para>
10325 The number sign (#) as the first non-blank character in a line denotes
10326 that all text following it is a comment:
10327 </para>
10328 <code>
10329 <![CDATA[
10330 EventLog.cs
10331 # requires Mono.Posix
10332 SysLogEventLogImpl.cs
10333 # uses the win32 eventlog API
10334 Win32EventLogImpl.cs
10335 ]]>
10336 </code>
10337 <para>
10338 Patterns can be grouped to sets, and later be referenced by their
10339 <see cref="P:NAnt.Core.DataTypeBase.ID"/>.
10340 </para>
10341 <para>
10342 When used as a standalone element (global type), any properties that
10343 are referenced will be resolved when the definition is processed, not
10344 when it actually used. Passing a reference to a nested build file
10345 will not cause the properties to be re-evaluated.
10346 </para>
10347 <para>
10348 To improve reuse of globally defined patternsets, avoid referencing
10349 any properties altogether.
10350 </para>
10351 </remarks>
10352 <example>
10353 <para>
10354 Define a set of patterns that matches all .cs files that do not contain
10355 the text <c>Test</c> in their name.
10356 </para>
10357 <code>
10358 <![CDATA[
10359 <patternset id="non.test.sources">
10360 <include name="**/*.cs" />
10361 <exclude name="**/*Test*" />
10362 </patternset>
10363 ]]>
10364 </code>
10365 </example>
10366 <example>
10367 <para>
10368 Define two sets. One holding C# sources, and one holding VB sources.
10369 Both sets only include test sources when the <c>test</c> property is
10370 set. A third set combines both C# and VB sources.
10371 </para>
10372 <code>
10373 <![CDATA[
10374 <patternset id="cs.sources">
10375 <include name="src/**/*.cs" />
10376 <include name="test/**/*.cs" if=${property::exist('test')}" />
10377 </patternset>
10378
10379 <patternset id="vb.sources">
10380 <include name="src/**/*.vb" />
10381 <include name="test/**/*.vb" if=${property::exist('test')}" />
10382 </patternset>
10383
10384 <patternset id="all.sources">
10385 <patternset refid="cs.sources" />
10386 <patternset refid="vb.sources" />
10387 </patternset>
10388 ]]>
10389 </code>
10390 </example>
10391 <example>
10392 <para>
10393 Define a set from patterns in a file.
10394 </para>
10395 <code>
10396 <![CDATA[
10397 <patternset id="sources">
10398 <includesfile name="test.sources" />
10399 <includesfile name="non.test.sources" />
10400 </patternset>
10401 ]]>
10402 </code>
10403 </example>
10404 <example>
10405 <para>
10406 Defines a patternset with patterns that are loaded from an external
10407 file, and shows the behavior when that patternset is passed as a
10408 reference to a nested build script.
10409 </para>
10410 <para>
10411 External file "c:\foo\build\service.lst" holding patterns
10412 of source files to include for the Foo.Service assembly:
10413 </para>
10414 <code>
10415 <![CDATA[
10416 AssemblyInfo.cs
10417 *Channel.cs
10418 ServiceFactory.cs]]></code>
10419 <para>
10420 Main build script located in "c:\foo\default.build":
10421 </para>
10422 <code>
10423 <![CDATA[
10424 <project name="main" default="build">
10425 <property name="build.debug" value="true" />
10426
10427 <patternset id="service.sources">
10428 <include name="TraceListener.cs" if="${build.debug}" />
10429 <includesfile name="build/service.lst" />
10430 </patternset>
10431
10432 <property name="build.debug" value="false" />
10433
10434 <target name="build">
10435 <nant buildfile="service/default.build" inheritrefs="true" />
10436 </target>
10437 </project>]]></code>
10438 <para>
10439 Nested build script located in "c:\foo\services\default.build"
10440 which uses the patternset to feed sources files to the C# compiler:
10441 </para>
10442 <code>
10443 <![CDATA[
10444 <project name="service" default="build">
10445 <target name="build">
10446 <csc output="../bin/Foo.Service.dll" target="library">
10447 <fileset basedir="src">
10448 <patternset refid="service.sources" />
10449 </fileset>
10450 </csc>
10451 </target>
10452 </project>]]></code>
10453 <para>
10454 At the time when the patternset is used in the "service"
10455 build script, the following source files in "c:\foo\services\src"
10456 match the defined patterns:
10457 </para>
10458 <code>
10459 <![CDATA[
10460 AssemblyInfo.cs
10461 MsmqChannel.cs
10462 SmtpChannel.cs
10463 ServiceFactory.cs
10464 TraceListener.cs]]></code>
10465 <para>
10466 You should have observed that:
10467 </para>
10468 <list type="bullet">
10469 <item>
10470 <description>
10471 although the patternset is used from the "service"
10472 build script, the path to the external file is resolved relative
10473 to the base directory of the "main" build script in
10474 which the patternset is defined.
10475 </description>
10476 </item>
10477 <item>
10478 <description>
10479 the "TraceListener.cs" file is included, even though
10480 the "build.debug" property was changed to <b>false</b>
10481 after the patternset was defined (but before it was passed to
10482 the nested build, and used).
10483 </description>
10484 </item>
10485 </list>
10486 </example>
10487 <seealso cref="T:NAnt.Core.Types.FileSet"/>
10488 </member>
10489 <member name="M:NAnt.Core.Types.PatternSet.#ctor">
10490 <summary>
10491 Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternSet"/> class.
10492 </summary>
10493 </member>
10494 <member name="M:NAnt.Core.Types.PatternSet.Append(NAnt.Core.Types.PatternSet)">
10495 <summary>
10496 Adds a nested set of patterns, or references other standalone
10497 patternset.
10498 </summary>
10499 <param name="patternSet">The <see cref="T:NAnt.Core.Types.PatternSet"/> to add.</param>
10500 </member>
10501 <member name="P:NAnt.Core.Types.PatternSet.Include">
10502 <summary>
10503 Defines a single pattern for files to include.
10504 </summary>
10505 </member>
10506 <member name="P:NAnt.Core.Types.PatternSet.IncludesFile">
10507 <summary>
10508 Loads multiple patterns of files to include from a given file, set
10509 using the <see cref="P:NAnt.Core.Types.Pattern.PatternName"/> parameter.
10510 </summary>
10511 </member>
10512 <member name="P:NAnt.Core.Types.PatternSet.Exclude">
10513 <summary>
10514 Defines a single pattern for files to exclude.
10515 </summary>
10516 </member>
10517 <member name="P:NAnt.Core.Types.PatternSet.ExcludesFile">
10518 <summary>
10519 Loads multiple patterns of files to exclude from a given file, set
10520 using the <see cref="P:NAnt.Core.Types.Pattern.PatternName"/> parameter.
10521 </summary>
10522 </member>
10523 <member name="T:NAnt.Core.Types.Proxy">
10524 <summary>
10525 Contains HTTP proxy settings used to process requests to Internet
10526 resources.
10527 </summary>
10528 </member>
10529 <member name="M:NAnt.Core.Types.Proxy.#ctor">
10530 <summary>
10531 Initializes a new instance of the <see cref="T:NAnt.Core.Types.Proxy"/> class.
10532 </summary>
10533 </member>
10534 <member name="M:NAnt.Core.Types.Proxy.GetWebProxy">
10535 <summary>
10536 Gets a <see cref="T:System.Net.WebProxy"/> instance representing the current
10537 <see cref="T:NAnt.Core.Types.Proxy"/>.
10538 </summary>
10539 <returns>
10540 A <see cref="T:System.Net.WebProxy"/> instance representing the current
10541 <see cref="T:NAnt.Core.Types.Proxy"/>, or <see langword="GlobalProxySelection.Select"/>
10542 if this proxy should not be used to connect to the external resource.
10543 </returns>
10544 </member>
10545 <member name="P:NAnt.Core.Types.Proxy.Host">
10546 <summary>
10547 The name of the proxy host.
10548 </summary>
10549 </member>
10550 <member name="P:NAnt.Core.Types.Proxy.Port">
10551 <summary>
10552 The port number on <see cref="P:NAnt.Core.Types.Proxy.Host"/> to use.
10553 </summary>
10554 </member>
10555 <member name="P:NAnt.Core.Types.Proxy.BypassOnLocal">
10556 <summary>
10557 Specifies whether to bypass the proxy server for local addresses.
10558 The default is <see langword="false" />.
10559 </summary>
10560 </member>
10561 <member name="P:NAnt.Core.Types.Proxy.Credentials">
10562 <summary>
10563 The credentials to submit to the proxy server for authentication.
10564 </summary>
10565 </member>
10566 <member name="P:NAnt.Core.Types.Proxy.IfDefined">
10567 <summary>
10568 Indicates if the proxy should be used to connect to the external
10569 resource. If <see langword="true" /> then the proxy will be used;
10570 otherwise, not. The default is <see langword="true" />.
10571 </summary>
10572 </member>
10573 <member name="P:NAnt.Core.Types.Proxy.UnlessDefined">
10574 <summary>
10575 Indicates if the proxy should not be used to connect to the external
10576 resource. If <see langword="false" /> then the proxy will be used;
10577 otherwise, not. The default is <see langword="false" />.
10578 </summary>
10579 </member>
10580 <member name="T:NAnt.Core.Types.RawXml">
10581 <summary>
10582 Represents an element of which the XML is processed by its parent task
10583 or type.
10584 </summary>
10585 </member>
10586 <member name="P:NAnt.Core.Types.RawXml.Xml">
10587 <summary>
10588 Gets the XML that this element represents.
10589 </summary>
10590 </member>
10591 <member name="P:NAnt.Core.Types.RawXml.CustomXmlProcessing">
10592 <summary>
10593 Gets a value indicating whether the element is performing additional
10594 processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
10595 initialize the element.
10596 </summary>
10597 <value>
10598 <see langword="true"/>, as the XML that represents this build
10599 element is processed by the containing task or type.
10600 </value>
10601 </member>
10602 <member name="T:NAnt.Core.Types.Token">
10603 <summary>
10604 ReplaceTokens filter token.
10605 </summary>
10606 </member>
10607 <member name="P:NAnt.Core.Types.Token.Key">
10608 <summary>
10609 Token to be replaced.
10610 </summary>
10611 </member>
10612 <member name="P:NAnt.Core.Types.Token.Value">
10613 <summary>
10614 New value of token.
10615 </summary>
10616 </member>
10617 <member name="P:NAnt.Core.Types.Token.IfDefined">
10618 <summary>
10619 Indicates if the token should be used to replace values.
10620 If <see langword="true" /> then the token will be used;
10621 otherwise, not. The default is <see langword="true" />.
10622 </summary>
10623 </member>
10624 <member name="P:NAnt.Core.Types.Token.UnlessDefined">
10625 <summary>
10626 Indicates if the token should not be used to replace values.
10627 If <see langword="false" /> then the token will be used;
10628 otherwise, not. The default is <see langword="false" />.
10629 </summary>
10630 </member>
10631 <member name="T:NAnt.Core.Types.XmlNamespace">
10632 <summary>
10633 Represents an XML namespace.
10634 </summary>
10635 </member>
10636 <member name="P:NAnt.Core.Types.XmlNamespace.Prefix">
10637 <summary>
10638 The prefix to associate with the namespace.
10639 </summary>
10640 </member>
10641 <member name="P:NAnt.Core.Types.XmlNamespace.Uri">
10642 <summary>
10643 The associated XML namespace URI.
10644 </summary>
10645 </member>
10646 <member name="P:NAnt.Core.Types.XmlNamespace.IfDefined">
10647 <summary>
10648 Indicates if the namespace should be added to the <see cref="T:System.Xml.XmlNamespaceManager"/>.
10649 If <see langword="true"/> then the namespace will be added;
10650 otherwise, skipped. The default is <see langword="true"/>.
10651 </summary>
10652 </member>
10653 <member name="P:NAnt.Core.Types.XmlNamespace.UnlessDefined">
10654 <summary>
10655 Indicates if the namespace should not be added to the <see cref="T:System.Xml.XmlNamespaceManager"/>.
10656 list. If <see langword="false"/> then the parameter will be
10657 added; otherwise, skipped. The default is <see langword="false"/>.
10658 </summary>
10659 </member>
10660 <member name="T:NAnt.Core.Types.XmlNamespaceCollection">
10661 <summary>
10662 Contains a collection of <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements.
10663 </summary>
10664 </member>
10665 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor">
10666 <summary>
10667 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class.
10668 </summary>
10669 </member>
10670 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor(NAnt.Core.Types.XmlNamespaceCollection)">
10671 <summary>
10672 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class
10673 with the specified <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> instance.
10674 </summary>
10675 </member>
10676 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor(NAnt.Core.Types.XmlNamespace[])">
10677 <summary>
10678 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class
10679 with the specified array of <see cref="T:NAnt.Core.Types.XmlNamespace"/> instances.
10680 </summary>
10681 </member>
10682 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Add(NAnt.Core.Types.XmlNamespace)">
10683 <summary>
10684 Adds a <see cref="T:NAnt.Core.Types.XmlNamespace"/> to the end of the collection.
10685 </summary>
10686 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to be added to the end of the collection.</param>
10687 <returns>The position into which the new element was inserted.</returns>
10688 </member>
10689 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.AddRange(NAnt.Core.Types.XmlNamespace[])">
10690 <summary>
10691 Adds the elements of a <see cref="T:NAnt.Core.Types.XmlNamespace"/> array to the end of the collection.
10692 </summary>
10693 <param name="items">The array of <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements to be added to the end of the collection.</param>
10694 </member>
10695 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.AddRange(NAnt.Core.Types.XmlNamespaceCollection)">
10696 <summary>
10697 Adds the elements of a <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> to the end of the collection.
10698 </summary>
10699 <param name="items">The <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> to be added to the end of the collection.</param>
10700 </member>
10701 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Contains(NAnt.Core.Types.XmlNamespace)">
10702 <summary>
10703 Determines whether a <see cref="T:NAnt.Core.Types.XmlNamespace"/> is in the collection.
10704 </summary>
10705 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to locate in the collection.</param>
10706 <returns>
10707 <see langword="true"/> if <paramref name="item"/> is found in the
10708 collection; otherwise, <see langword="false"/>.
10709 </returns>
10710 </member>
10711 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Contains(System.String)">
10712 <summary>
10713 Determines whether a <see cref="T:NAnt.Core.Types.XmlNamespace"/> with the specified
10714 value is in the collection.
10715 </summary>
10716 <param name="value">The argument value to locate in the collection.</param>
10717 <returns>
10718 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XmlNamespace"/> with
10719 value <paramref name="value"/> is found in the collection; otherwise,
10720 <see langword="false"/>.
10721 </returns>
10722 </member>
10723 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.CopyTo(NAnt.Core.Types.XmlNamespace[],System.Int32)">
10724 <summary>
10725 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
10726 </summary>
10727 <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>
10728 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
10729 </member>
10730 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.IndexOf(NAnt.Core.Types.XmlNamespace)">
10731 <summary>
10732 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XmlNamespace"/> object in the collection.
10733 </summary>
10734 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> object for which the index is returned.</param>
10735 <returns>
10736 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.
10737 </returns>
10738 </member>
10739 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Insert(System.Int32,NAnt.Core.Types.XmlNamespace)">
10740 <summary>
10741 Inserts a <see cref="T:NAnt.Core.Types.XmlNamespace"/> into the collection at the specified index.
10742 </summary>
10743 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
10744 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to insert.</param>
10745 </member>
10746 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.GetEnumerator">
10747 <summary>
10748 Returns an enumerator that can iterate through the collection.
10749 </summary>
10750 <returns>
10751 A <see cref="T:NAnt.Core.Types.XmlNamespaceEnumerator"/> for the entire collection.
10752 </returns>
10753 </member>
10754 <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Remove(NAnt.Core.Types.XmlNamespace)">
10755 <summary>
10756 Removes a member from the collection.
10757 </summary>
10758 <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to remove from the collection.</param>
10759 </member>
10760 <member name="P:NAnt.Core.Types.XmlNamespaceCollection.Item(System.Int32)">
10761 <summary>
10762 Gets or sets the element at the specified index.
10763 </summary>
10764 <param name="index">The zero-based index of the element to get or set.</param>
10765 </member>
10766 <member name="P:NAnt.Core.Types.XmlNamespaceCollection.Item(System.String)">
10767 <summary>
10768 Gets the <see cref="T:NAnt.Core.Types.XmlNamespace"/> with the specified prefix.
10769 </summary>
10770 <param name="value">The prefix of the <see cref="T:NAnt.Core.Types.XmlNamespace"/> to get.</param>
10771 </member>
10772 <member name="T:NAnt.Core.Types.XmlNamespaceEnumerator">
10773 <summary>
10774 Enumerates the <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements of a <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/>.
10775 </summary>
10776 </member>
10777 <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.#ctor(NAnt.Core.Types.XmlNamespaceCollection)">
10778 <summary>
10779 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceEnumerator"/> class
10780 with the specified <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/>.
10781 </summary>
10782 <param name="arguments">The collection that should be enumerated.</param>
10783 </member>
10784 <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.MoveNext">
10785 <summary>
10786 Advances the enumerator to the next element of the collection.
10787 </summary>
10788 <returns>
10789 <see langword="true" /> if the enumerator was successfully advanced
10790 to the next element; <see langword="false" /> if the enumerator has
10791 passed the end of the collection.
10792 </returns>
10793 </member>
10794 <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.Reset">
10795 <summary>
10796 Sets the enumerator to its initial position, which is before the
10797 first element in the collection.
10798 </summary>
10799 </member>
10800 <member name="P:NAnt.Core.Types.XmlNamespaceEnumerator.Current">
10801 <summary>
10802 Gets the current element in the collection.
10803 </summary>
10804 <returns>
10805 The current element in the collection.
10806 </returns>
10807 </member>
10808 <member name="T:NAnt.Core.Types.XsltExtensionObject">
10809 <summary>
10810 Represents an XSLT extension object. The object should have a default
10811 parameterless constructor and the return value should be one of the
10812 four basic XPath data types of number, string, Boolean or node set.
10813 </summary>
10814 </member>
10815 <member name="M:NAnt.Core.Types.XsltExtensionObject.#ctor">
10816 <summary>
10817 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10818 class.
10819 </summary>
10820 </member>
10821 <member name="P:NAnt.Core.Types.XsltExtensionObject.NamespaceUri">
10822 <summary>
10823 The namespace URI to associate with the extension object.
10824 </summary>
10825 <value>
10826 The namespace URI to associate with the extension object, or
10827 <see cref="F:System.String.Empty"/> if not set.
10828 </value>
10829 </member>
10830 <member name="P:NAnt.Core.Types.XsltExtensionObject.TypeName">
10831 <summary>
10832 The full type name of the XSLT extension object.
10833 </summary>
10834 </member>
10835 <member name="P:NAnt.Core.Types.XsltExtensionObject.AssemblyPath">
10836 <summary>
10837 The assembly which contains the XSLT extension object.
10838 </summary>
10839 </member>
10840 <member name="P:NAnt.Core.Types.XsltExtensionObject.IfDefined">
10841 <summary>
10842 Indicates if the extension object should be added to the XSLT argument
10843 list. If <see langword="true" /> then the extension object will be
10844 added; otherwise, skipped. The default is <see langword="true" />.
10845 </summary>
10846 </member>
10847 <member name="P:NAnt.Core.Types.XsltExtensionObject.UnlessDefined">
10848 <summary>
10849 Indicates if the extension object should not be added to the XSLT argument
10850 list. If <see langword="false" /> then the extension object will be
10851 added; otherwise, skipped. The default is <see langword="false" />.
10852 </summary>
10853 </member>
10854 <member name="T:NAnt.Core.Types.XsltExtensionObjectCollection">
10855 <summary>
10856 Contains a collection of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> elements.
10857 </summary>
10858 </member>
10859 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor">
10860 <summary>
10861 Initializes a new instance of the
10862 <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class.
10863 </summary>
10864 </member>
10865 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor(NAnt.Core.Types.XsltExtensionObjectCollection)">
10866 <summary>
10867 Initializes a new instance of the
10868 <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class with the
10869 specified <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> instance.
10870 </summary>
10871 </member>
10872 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor(NAnt.Core.Types.XsltExtensionObject[])">
10873 <summary>
10874 Initializes a new instance of the
10875 <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class with the
10876 specified array of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> instances.
10877 </summary>
10878 </member>
10879 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Add(NAnt.Core.Types.XsltExtensionObject)">
10880 <summary>
10881 Adds a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to the end of the collection.
10882 </summary>
10883 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to be added
10884 to the end of the collection.</param>
10885 <returns>The position into which the new element was inserted.</returns>
10886 </member>
10887 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.AddRange(NAnt.Core.Types.XsltExtensionObject[])">
10888 <summary>
10889 Adds the elements of a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> array to the
10890 end of the collection.
10891 </summary>
10892 <param name="items">The array of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10893 elements to be added to the end of the collection.</param>
10894 </member>
10895 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.AddRange(NAnt.Core.Types.XsltExtensionObjectCollection)">
10896 <summary>
10897 Adds the elements of a <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>
10898 to the end of the collection.
10899 </summary>
10900 <param name="items">The <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>
10901 to be added to the end of the collection.</param>
10902 </member>
10903 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Contains(NAnt.Core.Types.XsltExtensionObject)">
10904 <summary>
10905 Determines whether a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> is in the
10906 collection.
10907 </summary>
10908 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to locate
10909 in the collection.</param>
10910 <returns>
10911 <see langword="true"/> if <paramref name="item"/> is found in the
10912 collection; otherwise, <see langword="false"/>.
10913 </returns>
10914 </member>
10915 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Contains(System.String)">
10916 <summary>
10917 Determines whether a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> with the
10918 specified value is in the collection.
10919 </summary>
10920 <param name="value">The argument value to locate in the
10921 collection.</param>
10922 <returns>
10923 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10924 with value <paramref name="value"/> is found in the collection;
10925 otherwise, <see langword="false"/>.
10926 </returns>
10927 </member>
10928 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.CopyTo(NAnt.Core.Types.XsltExtensionObject[],System.Int32)">
10929 <summary>
10930 Copies the entire collection to a compatible one-dimensional array,
10931 starting at the specified index of the target array.
10932 </summary>
10933 <param name="array">The one-dimensional array that is the
10934 destination of the elements copied from the collection. The array
10935 must have zero-based indexing.</param>
10936 <param name="index">The zero-based index in <paramref name="array"/>
10937 at which copying begins.</param>
10938 </member>
10939 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.IndexOf(NAnt.Core.Types.XsltExtensionObject)">
10940 <summary>
10941 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10942 object in the collection.
10943 </summary>
10944 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> object for
10945 which the index is returned.</param>
10946 <returns>
10947 The index of the specified <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>. If the
10948 <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> is not currently a member of the
10949 collection, it returns -1.
10950 </returns>
10951 </member>
10952 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Insert(System.Int32,NAnt.Core.Types.XsltExtensionObject)">
10953 <summary>
10954 Inserts a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> into the collection at
10955 the specified index.
10956 </summary>
10957 <param name="index">The zero-based index at which
10958 <paramref name="item"/> should be inserted.</param>
10959 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to
10960 insert.</param>
10961 </member>
10962 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.GetEnumerator">
10963 <summary>
10964 Returns an enumerator that can iterate through the collection.
10965 </summary>
10966 <returns>
10967 A <see cref="T:NAnt.Core.Types.XsltExtensionObjectEnumerator"/> for the entire
10968 collection.
10969 </returns>
10970 </member>
10971 <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Remove(NAnt.Core.Types.XsltExtensionObject)">
10972 <summary>
10973 Removes a member from the collection.
10974 </summary>
10975 <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to remove
10976 from the collection.</param>
10977 </member>
10978 <member name="P:NAnt.Core.Types.XsltExtensionObjectCollection.Item(System.Int32)">
10979 <summary>
10980 Gets or sets the element at the specified index.
10981 </summary>
10982 <param name="index">The zero-based index of the element to get
10983 or set.</param>
10984 </member>
10985 <member name="P:NAnt.Core.Types.XsltExtensionObjectCollection.Item(System.String)">
10986 <summary>
10987 Gets the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> with the specified name.
10988 </summary>
10989 <param name="value">The name of the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
10990 to get.</param>
10991 </member>
10992 <member name="T:NAnt.Core.Types.XsltExtensionObjectEnumerator">
10993 <summary>
10994 Enumerates the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> elements of a
10995 <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>.
10996 </summary>
10997 </member>
10998 <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.#ctor(NAnt.Core.Types.XsltExtensionObjectCollection)">
10999 <summary>
11000 Initializes a new instance of the
11001 <see cref="T:NAnt.Core.Types.XsltExtensionObjectEnumerator"/> class
11002 with the specified <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>.
11003 </summary>
11004 <param name="arguments">The collection that should be
11005 enumerated.</param>
11006 </member>
11007 <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.MoveNext">
11008 <summary>
11009 Advances the enumerator to the next element of the collection.
11010 </summary>
11011 <returns>
11012 <see langword="true" /> if the enumerator was successfully advanced
11013 to the next element; <see langword="false" /> if the enumerator has
11014 passed the end of the collection.
11015 </returns>
11016 </member>
11017 <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.Reset">
11018 <summary>
11019 Sets the enumerator to its initial position, which is before the
11020 first element in the collection.
11021 </summary>
11022 </member>
11023 <member name="P:NAnt.Core.Types.XsltExtensionObjectEnumerator.Current">
11024 <summary>
11025 Gets the current element in the collection.
11026 </summary>
11027 <returns>
11028 The current element in the collection.
11029 </returns>
11030 </member>
11031 <member name="T:NAnt.Core.Types.XsltParameter">
11032 <summary>
11033 Represents an XSLT parameter.
11034 </summary>
11035 </member>
11036 <member name="M:NAnt.Core.Types.XsltParameter.#ctor">
11037 <summary>
11038 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameter"/>
11039 class.
11040 </summary>
11041 </member>
11042 <member name="P:NAnt.Core.Types.XsltParameter.ParameterName">
11043 <summary>
11044 The name of the XSLT parameter.
11045 </summary>
11046 <value>
11047 The name of the XSLT parameter, or <see cref="F:System.String.Empty"/> if
11048 not set.
11049 </value>
11050 </member>
11051 <member name="P:NAnt.Core.Types.XsltParameter.NamespaceUri">
11052 <summary>
11053 The namespace URI to associate with the parameter.
11054 </summary>
11055 <value>
11056 The namespace URI to associate with the parameter, or
11057 <see cref="F:System.String.Empty"/> if not set.
11058 </value>
11059 </member>
11060 <member name="P:NAnt.Core.Types.XsltParameter.Value">
11061 <summary>
11062 The value of the XSLT parameter.
11063 </summary>
11064 <value>
11065 The value of the XSLT parameter, or <see cref="F:System.String.Empty"/> if
11066 not set.
11067 </value>
11068 </member>
11069 <member name="P:NAnt.Core.Types.XsltParameter.IfDefined">
11070 <summary>
11071 Indicates if the parameter should be added to the XSLT argument list.
11072 If <see langword="true" /> then the parameter will be added;
11073 otherwise, skipped. The default is <see langword="true" />.
11074 </summary>
11075 </member>
11076 <member name="P:NAnt.Core.Types.XsltParameter.UnlessDefined">
11077 <summary>
11078 Indicates if the parameter should not be added to the XSLT argument
11079 list. If <see langword="false" /> then the parameter will be
11080 added; otherwise, skipped. The default is <see langword="false" />.
11081 </summary>
11082 </member>
11083 <member name="T:NAnt.Core.Types.XsltParameterCollection">
11084 <summary>
11085 Contains a collection of <see cref="T:NAnt.Core.Types.XsltParameter"/> elements.
11086 </summary>
11087 </member>
11088 <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor">
11089 <summary>
11090 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class.
11091 </summary>
11092 </member>
11093 <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor(NAnt.Core.Types.XsltParameterCollection)">
11094 <summary>
11095 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class
11096 with the specified <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> instance.
11097 </summary>
11098 </member>
11099 <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor(NAnt.Core.Types.XsltParameter[])">
11100 <summary>
11101 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class
11102 with the specified array of <see cref="T:NAnt.Core.Types.XsltParameter"/> instances.
11103 </summary>
11104 </member>
11105 <member name="M:NAnt.Core.Types.XsltParameterCollection.Add(NAnt.Core.Types.XsltParameter)">
11106 <summary>
11107 Adds a <see cref="T:NAnt.Core.Types.XsltParameter"/> to the end of the collection.
11108 </summary>
11109 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to be added to the end of the collection.</param>
11110 <returns>The position into which the new element was inserted.</returns>
11111 </member>
11112 <member name="M:NAnt.Core.Types.XsltParameterCollection.AddRange(NAnt.Core.Types.XsltParameter[])">
11113 <summary>
11114 Adds the elements of a <see cref="T:NAnt.Core.Types.XsltParameter"/> array to the end of the collection.
11115 </summary>
11116 <param name="items">The array of <see cref="T:NAnt.Core.Types.XsltParameter"/> elements to be added to the end of the collection.</param>
11117 </member>
11118 <member name="M:NAnt.Core.Types.XsltParameterCollection.AddRange(NAnt.Core.Types.XsltParameterCollection)">
11119 <summary>
11120 Adds the elements of a <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> to the end of the collection.
11121 </summary>
11122 <param name="items">The <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> to be added to the end of the collection.</param>
11123 </member>
11124 <member name="M:NAnt.Core.Types.XsltParameterCollection.Contains(NAnt.Core.Types.XsltParameter)">
11125 <summary>
11126 Determines whether a <see cref="T:NAnt.Core.Types.XsltParameter"/> is in the collection.
11127 </summary>
11128 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to locate in the collection.</param>
11129 <returns>
11130 <see langword="true"/> if <paramref name="item"/> is found in the
11131 collection; otherwise, <see langword="false"/>.
11132 </returns>
11133 </member>
11134 <member name="M:NAnt.Core.Types.XsltParameterCollection.Contains(System.String)">
11135 <summary>
11136 Determines whether a <see cref="T:NAnt.Core.Types.XsltParameter"/> with the specified
11137 value is in the collection.
11138 </summary>
11139 <param name="value">The argument value to locate in the collection.</param>
11140 <returns>
11141 <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XsltParameter"/> with
11142 value <paramref name="value"/> is found in the collection; otherwise,
11143 <see langword="false"/>.
11144 </returns>
11145 </member>
11146 <member name="M:NAnt.Core.Types.XsltParameterCollection.CopyTo(NAnt.Core.Types.XsltParameter[],System.Int32)">
11147 <summary>
11148 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
11149 </summary>
11150 <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>
11151 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
11152 </member>
11153 <member name="M:NAnt.Core.Types.XsltParameterCollection.IndexOf(NAnt.Core.Types.XsltParameter)">
11154 <summary>
11155 Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XsltParameter"/> object in the collection.
11156 </summary>
11157 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> object for which the index is returned.</param>
11158 <returns>
11159 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.
11160 </returns>
11161 </member>
11162 <member name="M:NAnt.Core.Types.XsltParameterCollection.Insert(System.Int32,NAnt.Core.Types.XsltParameter)">
11163 <summary>
11164 Inserts a <see cref="T:NAnt.Core.Types.XsltParameter"/> into the collection at the specified index.
11165 </summary>
11166 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
11167 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to insert.</param>
11168 </member>
11169 <member name="M:NAnt.Core.Types.XsltParameterCollection.GetEnumerator">
11170 <summary>
11171 Returns an enumerator that can iterate through the collection.
11172 </summary>
11173 <returns>
11174 A <see cref="T:NAnt.Core.Types.XsltParameterEnumerator"/> for the entire collection.
11175 </returns>
11176 </member>
11177 <member name="M:NAnt.Core.Types.XsltParameterCollection.Remove(NAnt.Core.Types.XsltParameter)">
11178 <summary>
11179 Removes a member from the collection.
11180 </summary>
11181 <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to remove from the collection.</param>
11182 </member>
11183 <member name="P:NAnt.Core.Types.XsltParameterCollection.Item(System.Int32)">
11184 <summary>
11185 Gets or sets the element at the specified index.
11186 </summary>
11187 <param name="index">The zero-based index of the element to get or set.</param>
11188 </member>
11189 <member name="P:NAnt.Core.Types.XsltParameterCollection.Item(System.String)">
11190 <summary>
11191 Gets the <see cref="T:NAnt.Core.Types.XsltParameter"/> with the specified name.
11192 </summary>
11193 <param name="value">The name of the <see cref="T:NAnt.Core.Types.XsltParameter"/> to get.</param>
11194 </member>
11195 <member name="T:NAnt.Core.Types.XsltParameterEnumerator">
11196 <summary>
11197 Enumerates the <see cref="T:NAnt.Core.Types.XsltParameter"/> elements of a <see cref="T:NAnt.Core.Types.XsltParameterCollection"/>.
11198 </summary>
11199 </member>
11200 <member name="M:NAnt.Core.Types.XsltParameterEnumerator.#ctor(NAnt.Core.Types.XsltParameterCollection)">
11201 <summary>
11202 Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterEnumerator"/> class
11203 with the specified <see cref="T:NAnt.Core.Types.XsltParameterCollection"/>.
11204 </summary>
11205 <param name="arguments">The collection that should be enumerated.</param>
11206 </member>
11207 <member name="M:NAnt.Core.Types.XsltParameterEnumerator.MoveNext">
11208 <summary>
11209 Advances the enumerator to the next element of the collection.
11210 </summary>
11211 <returns>
11212 <see langword="true" /> if the enumerator was successfully advanced
11213 to the next element; <see langword="false" /> if the enumerator has
11214 passed the end of the collection.
11215 </returns>
11216 </member>
11217 <member name="M:NAnt.Core.Types.XsltParameterEnumerator.Reset">
11218 <summary>
11219 Sets the enumerator to its initial position, which is before the
11220 first element in the collection.
11221 </summary>
11222 </member>
11223 <member name="P:NAnt.Core.Types.XsltParameterEnumerator.Current">
11224 <summary>
11225 Gets the current element in the collection.
11226 </summary>
11227 <returns>
11228 The current element in the collection.
11229 </returns>
11230 </member>
11231 <member name="T:NAnt.Core.Util.AssemblyResolver">
11232 <summary>
11233 Resolves assemblies by caching assemblies that were loaded.
11234 </summary>
11235 </member>
11236 <member name="M:NAnt.Core.Util.AssemblyResolver.#ctor">
11237 <summary>
11238 Initializes an instanse of the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
11239 class.
11240 </summary>
11241 </member>
11242 <member name="M:NAnt.Core.Util.AssemblyResolver.#ctor(NAnt.Core.Task)">
11243 <summary>
11244 Initializes an instanse of the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
11245 class in the context of the given <see cref="T:NAnt.Core.Task"/>.
11246 </summary>
11247 </member>
11248 <member name="M:NAnt.Core.Util.AssemblyResolver.Attach">
11249 <summary>
11250 Installs the assembly resolver by hooking up to the
11251 <see cref="F:System.AppDomain.AssemblyResolve"/> event.
11252 </summary>
11253 </member>
11254 <member name="M:NAnt.Core.Util.AssemblyResolver.Detach">
11255 <summary>
11256 Uninstalls the assembly resolver.
11257 </summary>
11258 </member>
11259 <member name="M:NAnt.Core.Util.AssemblyResolver.AssemblyResolve(System.Object,System.ResolveEventArgs)">
11260 <summary>
11261 Resolves an assembly not found by the system using the assembly
11262 cache.
11263 </summary>
11264 <param name="sender">The source of the event.</param>
11265 <param name="args">A <see cref="T:System.ResolveEventArgs"/> that contains the event data.</param>
11266 <returns>
11267 The loaded assembly, or <see langword="null"/> if not found.
11268 </returns>
11269 </member>
11270 <member name="M:NAnt.Core.Util.AssemblyResolver.AssemblyLoad(System.Object,System.AssemblyLoadEventArgs)">
11271 <summary>
11272 Occurs when an assembly is loaded. The loaded assembly is added
11273 to the assembly cache.
11274 </summary>
11275 <param name="sender">The source of the event.</param>
11276 <param name="args">An <see cref="T:System.AssemblyLoadEventArgs"/> that contains the event data.</param>
11277 </member>
11278 <member name="M:NAnt.Core.Util.AssemblyResolver.Log(NAnt.Core.Level,System.String,System.Object[])">
11279 <summary>
11280 Logs a message with the given priority.
11281 </summary>
11282 <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
11283 <param name="message">The message to log, containing zero or more format items.</param>
11284 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
11285 <remarks>
11286 The actual logging is delegated to the <see cref="T:NAnt.Core.Task"/> in which
11287 the <see cref="T:NAnt.Core.Util.AssemblyResolver"/> is executing
11288 </remarks>
11289 </member>
11290 <member name="F:NAnt.Core.Util.AssemblyResolver._assemblyCache">
11291 <summary>
11292 Holds the loaded assemblies.
11293 </summary>
11294 </member>
11295 <member name="F:NAnt.Core.Util.AssemblyResolver._task">
11296 <summary>
11297 Holds the <see cref="T:NAnt.Core.Task"/> in which the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
11298 is executing.
11299 </summary>
11300 <value>
11301 The <see cref="T:NAnt.Core.Task"/> in which the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
11302 is executing or <see langword="null"/> if the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
11303 is not executing in the context of a <see cref="T:NAnt.Core.Task"/>.
11304 </value>
11305 </member>
11306 <member name="T:NAnt.Core.Util.CommandLineArgument">
11307 <summary>
11308 Represents a valid command-line argument.
11309 </summary>
11310 </member>
11311 <member name="M:NAnt.Core.Util.CommandLineArgument.Finish(System.Object)">
11312 <summary>
11313 Sets the value of the argument on the specified object.
11314 </summary>
11315 <param name="destination">The object on which the value of the argument should be set.</param>
11316 <exception cref="T:NAnt.Core.Util.CommandLineArgumentException">The argument is required and no value was specified.</exception>
11317 <exception cref="T:System.NotSupportedException">
11318 <para>
11319 The matching property is collection-based, but is not initialized
11320 and cannot be written to.
11321 </para>
11322 <para>-or-</para>
11323 <para>
11324 The matching property is collection-based, but has no strongly-typed
11325 Add method.
11326 </para>
11327 <para>-or-</para>
11328 <para>
11329 The matching property is collection-based, but the signature of the
11330 Add method is not supported.
11331 </para>
11332 </exception>
11333 </member>
11334 <member name="M:NAnt.Core.Util.CommandLineArgument.SetValue(System.String)">
11335 <summary>
11336 Assigns the specified value to the argument.
11337 </summary>
11338 <param name="value">The value that should be assigned to the argument.</param>
11339 <exception cref="T:NAnt.Core.Util.CommandLineArgumentException">
11340 <para>Duplicate argument.</para>
11341 <para>-or-</para>
11342 <para>Invalid value.</para>
11343 </exception>
11344 </member>
11345 <member name="M:NAnt.Core.Util.CommandLineArgument.IsNameValueCollectionType(System.Type)">
11346 <summary>
11347 Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is a
11348 <see cref="T:System.Collections.Specialized.NameValueCollection"/>.
11349 </summary>
11350 <value>
11351 <see langword="true"/> if <paramref name="type"/> can be assigned
11352 to <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise, <see langword="false"/>.
11353 </value>
11354 </member>
11355 <member name="M:NAnt.Core.Util.CommandLineArgument.IsCollectionType(System.Type)">
11356 <summary>
11357 Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is collection-based.
11358 </summary>
11359 <value>
11360 <see langword="true"/> if <paramref name="type"/> can be assigned
11361 to <see cref="T:System.Collections.ICollection"/> and is not backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
11362 that can be assigned to <see cref="T:System.Collections.Specialized.NameValueCollection"/>;
11363 otherwise, <see langword="false"/>.
11364 </value>
11365 </member>
11366 <member name="M:NAnt.Core.Util.CommandLineArgument.IsArrayType(System.Type)">
11367 <summary>
11368 Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is an array.
11369 </summary>
11370 <value>
11371 <see langword="true"/> if <paramref name="type"/> is an array;
11372 otherwise, <see langword="false"/>.
11373 </value>
11374 </member>
11375 <member name="P:NAnt.Core.Util.CommandLineArgument.Property">
11376 <summary>
11377 Gets the property that backs the argument.
11378 </summary>
11379 <value>
11380 The property that backs the arguments.
11381 </value>
11382 </member>
11383 <member name="P:NAnt.Core.Util.CommandLineArgument.ValueType">
11384 <summary>
11385 Gets the underlying <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument.
11386 </summary>
11387 <value>
11388 The underlying <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument.
11389 </value>
11390 <remarks>
11391 If the <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument is a collection type,
11392 this property will returns the underlying type of that collection.
11393 </remarks>
11394 </member>
11395 <member name="P:NAnt.Core.Util.CommandLineArgument.LongName">
11396 <summary>
11397 Gets the long name of the argument.
11398 </summary>
11399 <value>The long name of the argument.</value>
11400 </member>
11401 <member name="P:NAnt.Core.Util.CommandLineArgument.ShortName">
11402 <summary>
11403 Gets the short name of the argument.
11404 </summary>
11405 <value>The short name of the argument.</value>
11406 </member>
11407 <member name="P:NAnt.Core.Util.CommandLineArgument.Description">
11408 <summary>
11409 Gets the description of the argument.
11410 </summary>
11411 <value>The description of the argument.</value>
11412 </member>
11413 <member name="P:NAnt.Core.Util.CommandLineArgument.IsRequired">
11414 <summary>
11415 Gets a value indicating whether the argument is required.
11416 </summary>
11417 <value>
11418 <see langword="true" /> if the argument is required; otherwise,
11419 <see langword="false" />.
11420 </value>
11421 </member>
11422 <member name="P:NAnt.Core.Util.CommandLineArgument.SeenValue">
11423 <summary>
11424 Gets a value indicating whether a mathing command-line argument
11425 was already found.
11426 </summary>
11427 <value>
11428 <see langword="true" /> if a matching command-line argument was
11429 already found; otherwise, <see langword="false" />.
11430 </value>
11431 </member>
11432 <member name="P:NAnt.Core.Util.CommandLineArgument.AllowMultiple">
11433 <summary>
11434 Gets a value indicating whether the argument can be specified multiple
11435 times.
11436 </summary>
11437 <value>
11438 <see langword="true" /> if the argument may be specified multiple
11439 times; otherwise, <see langword="false" />.
11440 </value>
11441 </member>
11442 <member name="P:NAnt.Core.Util.CommandLineArgument.Unique">
11443 <summary>
11444 Gets a value indicating whether the argument can only be specified once
11445 with a certain value.
11446 </summary>
11447 <value>
11448 <see langword="true" /> if the argument should always have a unique
11449 value; otherwise, <see langword="false" />.
11450 </value>
11451 </member>
11452 <member name="P:NAnt.Core.Util.CommandLineArgument.Type">
11453 <summary>
11454 Gets the <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the property to which the argument
11455 is applied.
11456 </summary>
11457 <value>
11458 The <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the property to which the argument is
11459 applied.
11460 </value>
11461 </member>
11462 <member name="P:NAnt.Core.Util.CommandLineArgument.IsCollection">
11463 <summary>
11464 Gets a value indicating whether the argument is collection-based.
11465 </summary>
11466 <value>
11467 <see langword="true"/> if the argument is backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
11468 that can be assigned to <see cref="T:System.Collections.ICollection"/> and is not backed
11469 by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> that can be assigned to
11470 <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise, <see langword="false"/>.
11471 </value>
11472 </member>
11473 <member name="P:NAnt.Core.Util.CommandLineArgument.IsNameValueCollection">
11474 <summary>
11475 Gets a value indicating whether the argument is a set of name/value
11476 pairs.
11477 </summary>
11478 <value>
11479 <see langword="true"/> if the argument is backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
11480 that can be assigned to <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise,
11481 <see langword="false"/>.
11482 </value>
11483 </member>
11484 <member name="P:NAnt.Core.Util.CommandLineArgument.IsArray">
11485 <summary>
11486 Gets a value indicating whether the argument is array-based.
11487 </summary>
11488 <value>
11489 <see langword="true" /> if the argument is backed by an array;
11490 otherwise, <see langword="false" />.
11491 </value>
11492 </member>
11493 <member name="P:NAnt.Core.Util.CommandLineArgument.IsDefault">
11494 <summary>
11495 Gets a value indicating whether the argument is the default argument.
11496 </summary>
11497 <value>
11498 <see langword="true" /> if the argument is the default argument;
11499 otherwise, <see langword="false" />.
11500 </value>
11501 </member>
11502 <member name="P:NAnt.Core.Util.CommandLineArgument.IsExclusive">
11503 <summary>
11504 Gets a value indicating whether the argument cannot be combined with
11505 other arguments.
11506 </summary>
11507 <value>
11508 <see langword="true" /> if the argument cannot be combined with other
11509 arguments; otherwise, <see langword="false" />.
11510 </value>
11511 </member>
11512 <member name="T:NAnt.Core.Util.CommandLineArgumentAttribute">
11513 <summary>
11514 Allows control of command line parsing.
11515 </summary>
11516 </member>
11517 <member name="M:NAnt.Core.Util.CommandLineArgumentAttribute.#ctor(NAnt.Core.Util.CommandLineArgumentTypes)">
11518 <summary>
11519 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> class
11520 with the specified argument type.
11521 </summary>
11522 <param name="argumentType">Specifies the checking to be done on the argument.</param>
11523 </member>
11524 <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Type">
11525 <summary>
11526 Gets or sets the checking to be done on the argument.
11527 </summary>
11528 <value>The checking that should be done on the argument.</value>
11529 </member>
11530 <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Name">
11531 <summary>
11532 Gets or sets the long name of the argument.
11533 </summary>
11534 <value>The long name of the argument.</value>
11535 </member>
11536 <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.ShortName">
11537 <summary>
11538 Gets or sets the short name of the argument.
11539 </summary>
11540 <value>The short name of the argument.</value>
11541 </member>
11542 <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Description">
11543 <summary>
11544 Gets or sets the description of the argument.
11545 </summary>
11546 <value>The description of the argument.</value>
11547 </member>
11548 <member name="T:NAnt.Core.Util.CommandLineArgumentCollection">
11549 <summary>
11550 Contains a strongly typed collection of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> objects.
11551 </summary>
11552 </member>
11553 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor">
11554 <summary>
11555 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class.
11556 </summary>
11557 </member>
11558 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor(NAnt.Core.Util.CommandLineArgumentCollection)">
11559 <summary>
11560 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class
11561 with the specified <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> instance.
11562 </summary>
11563 </member>
11564 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor(NAnt.Core.Util.CommandLineArgument[])">
11565 <summary>
11566 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class
11567 with the specified array of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> instances.
11568 </summary>
11569 </member>
11570 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Add(NAnt.Core.Util.CommandLineArgument)">
11571 <summary>
11572 Adds a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to the end of the collection.
11573 </summary>
11574 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to be added to the end of the collection.</param>
11575 <returns>The position into which the new element was inserted.</returns>
11576 </member>
11577 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.AddRange(NAnt.Core.Util.CommandLineArgument[])">
11578 <summary>
11579 Adds the elements of a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> array to the end of the collection.
11580 </summary>
11581 <param name="items">The array of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> elements to be added to the end of the collection.</param>
11582 </member>
11583 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.AddRange(NAnt.Core.Util.CommandLineArgumentCollection)">
11584 <summary>
11585 Adds the elements of a <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> to the end of the collection.
11586 </summary>
11587 <param name="items">The <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> to be added to the end of the collection.</param>
11588 </member>
11589 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Contains(NAnt.Core.Util.CommandLineArgument)">
11590 <summary>
11591 Determines whether a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> is in the collection.
11592 </summary>
11593 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to locate in the collection.</param>
11594 <returns>
11595 <see langword="true"/> if <paramref name="item"/> is found in the
11596 collection; otherwise, <see langword="false"/>.
11597 </returns>
11598 </member>
11599 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.CopyTo(NAnt.Core.Util.CommandLineArgument[],System.Int32)">
11600 <summary>
11601 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
11602 </summary>
11603 <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>
11604 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
11605 </member>
11606 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.IndexOf(NAnt.Core.Util.CommandLineArgument)">
11607 <summary>
11608 Retrieves the index of a specified <see cref="T:NAnt.Core.Util.CommandLineArgument"/> object in the collection.
11609 </summary>
11610 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> object for which the index is returned.</param>
11611 <returns>
11612 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.
11613 </returns>
11614 </member>
11615 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Insert(System.Int32,NAnt.Core.Util.CommandLineArgument)">
11616 <summary>
11617 Inserts a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> into the collection at the specified index.
11618 </summary>
11619 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
11620 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to insert.</param>
11621 </member>
11622 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.GetEnumerator">
11623 <summary>
11624 Returns an enumerator that can iterate through the collection.
11625 </summary>
11626 <returns>
11627 A <see cref="T:NAnt.Core.Util.CommandLineArgumentEnumerator"/> for the entire collection.
11628 </returns>
11629 </member>
11630 <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Remove(NAnt.Core.Util.CommandLineArgument)">
11631 <summary>
11632 Removes a member from the collection.
11633 </summary>
11634 <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to remove from the collection.</param>
11635 </member>
11636 <member name="P:NAnt.Core.Util.CommandLineArgumentCollection.Item(System.Int32)">
11637 <summary>
11638 Gets or sets the element at the specified index.
11639 </summary>
11640 <param name="index">The zero-based index of the element to get or set.</param>
11641 </member>
11642 <member name="P:NAnt.Core.Util.CommandLineArgumentCollection.Item(System.String)">
11643 <summary>
11644 Gets the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> with the specified name.
11645 </summary>
11646 <param name="name">The name of the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to get.</param>
11647 </member>
11648 <member name="T:NAnt.Core.Util.CommandLineArgumentEnumerator">
11649 <summary>
11650 Enumerates the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> elements of a <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/>.
11651 </summary>
11652 </member>
11653 <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.#ctor(NAnt.Core.Util.CommandLineArgumentCollection)">
11654 <summary>
11655 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentEnumerator"/> class
11656 with the specified <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/>.
11657 </summary>
11658 <param name="arguments">The collection that should be enumerated.</param>
11659 </member>
11660 <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.MoveNext">
11661 <summary>
11662 Advances the enumerator to the next element of the collection.
11663 </summary>
11664 <returns>
11665 <see langword="true" /> if the enumerator was successfully advanced
11666 to the next element; <see langword="false" /> if the enumerator has
11667 passed the end of the collection.
11668 </returns>
11669 </member>
11670 <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.Reset">
11671 <summary>
11672 Sets the enumerator to its initial position, which is before the
11673 first element in the collection.
11674 </summary>
11675 </member>
11676 <member name="P:NAnt.Core.Util.CommandLineArgumentEnumerator.Current">
11677 <summary>
11678 Gets the current element in the collection.
11679 </summary>
11680 <returns>
11681 The current element in the collection.
11682 </returns>
11683 </member>
11684 <member name="T:NAnt.Core.Util.CommandLineArgumentException">
11685 <summary>
11686 The exception that is thrown when one of the command-line arguments provided
11687 is not valid.
11688 </summary>
11689 </member>
11690 <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor">
11691 <summary>
11692 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class.
11693 </summary>
11694 </member>
11695 <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.String)">
11696 <summary>
11697 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
11698 with a descriptive message.
11699 </summary>
11700 <param name="message">A descriptive message to include with the exception.</param>
11701 </member>
11702 <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.String,System.Exception)">
11703 <summary>
11704 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
11705 with a descriptive message and an inner exception.
11706 </summary>
11707 <param name="message">A descriptive message to include with the exception.</param>
11708 <param name="innerException">A nested exception that is the cause of the current exception.</param>
11709 </member>
11710 <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
11711 <summary>
11712 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
11713 with serialized data.
11714 </summary>
11715 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
11716 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
11717 </member>
11718 <member name="T:NAnt.Core.Util.CommandLineArgumentTypes">
11719 <summary>
11720 Used to control parsing of command-line arguments.
11721 </summary>
11722 </member>
11723 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Required">
11724 <summary>
11725 Indicates that this field is required. An error will be displayed
11726 if it is not present when parsing arguments.
11727 </summary>
11728 </member>
11729 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Unique">
11730 <summary>
11731 Only valid in conjunction with Multiple.
11732 Duplicate values will result in an error.
11733 </summary>
11734 </member>
11735 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Multiple">
11736 <summary>
11737 Inidicates that the argument may be specified more than once.
11738 Only valid if the argument is a collection
11739 </summary>
11740 </member>
11741 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Exclusive">
11742 <summary>
11743 Inidicates that if this argument is specified, no other arguments may be specified.
11744 </summary>
11745 </member>
11746 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.AtMostOnce">
11747 <summary>
11748 The default type for non-collection arguments.
11749 The argument is not required, but an error will be reported if it is specified more than once.
11750 </summary>
11751 </member>
11752 <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.MultipleUnique">
11753 <summary>
11754 The default type for collection arguments.
11755 The argument is permitted to occur multiple times, but duplicate
11756 values will cause an error to be reported.
11757 </summary>
11758 </member>
11759 <member name="T:NAnt.Core.Util.CommandLineParser">
11760 <summary>
11761 Commandline parser.
11762 </summary>
11763 </member>
11764 <member name="M:NAnt.Core.Util.CommandLineParser.#ctor(System.Type,System.Boolean)">
11765 <summary>
11766 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineParser"/> class
11767 using possible arguments deducted from the specific <see cref="T:System.Type"/>.
11768 </summary>
11769 <param name="argumentSpecification">The <see cref="T:System.Type"/> from which the possible command-line arguments should be retrieved.</param>
11770 <param name="supportsResponseFile">A <see cref="T:System.Boolean"/> value indicating whether or not a response file is able to be used. </param>
11771 <exception cref="T:System.ArgumentNullException"><paramref name="argumentSpecification"/> is a null reference.</exception>
11772 </member>
11773 <member name="M:NAnt.Core.Util.CommandLineParser.Parse(System.String[],System.Object)">
11774 <summary>
11775 Parses an argument list.
11776 </summary>
11777 <param name="args">The arguments to parse.</param>
11778 <param name="destination">The destination object on which properties will be set corresponding to the specified arguments.</param>
11779 <exception cref="T:System.ArgumentNullException"><paramref name="destination"/> is a null reference.</exception>
11780 <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>
11781 </member>
11782 <member name="M:NAnt.Core.Util.CommandLineParser.ParseArguments(System.String,System.Char[])">
11783 <summary>
11784 Splits a string and removes any empty strings from the
11785 result. Same functionality as the
11786 public string[] Split(char[] separator, StringSplitOptions options)
11787 method in .Net 2.0. Replace with that call when 2.0 is standard.
11788 </summary>
11789 <param name="sourceString"></param>
11790 <param name="delimiters"></param>
11791 <returns>the array of strings</returns>
11792 </member>
11793 <member name="M:NAnt.Core.Util.CommandLineParser.ProcessResponseFile(System.String)">
11794 <summary>
11795 Read a response file and parse the arguments as usual.
11796 </summary>
11797 <param name="file">The response file to load arguments</param>
11798 </member>
11799 <member name="M:NAnt.Core.Util.CommandLineParser.ParseArgumentList(System.String[])">
11800 <summary>
11801 Parse the argument list using the
11802 </summary>
11803 <param name="args"></param>
11804 </member>
11805 <member name="M:NAnt.Core.Util.CommandLineParser.GetCommandLineAttribute(System.Reflection.PropertyInfo)">
11806 <summary>
11807 Returns the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> that's applied
11808 on the specified property.
11809 </summary>
11810 <param name="propertyInfo">The property of which applied <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> should be returned.</param>
11811 <returns>
11812 The <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> that's applied to the
11813 <paramref name="propertyInfo"/>, or a null reference if none was applied.
11814 </returns>
11815 </member>
11816 <member name="P:NAnt.Core.Util.CommandLineParser.LogoBanner">
11817 <summary>
11818 Gets a logo banner using version and copyright attributes defined on the
11819 <see cref="M:System.Reflection.Assembly.GetEntryAssembly"/> or the
11820 <see cref="M:System.Reflection.Assembly.GetCallingAssembly"/>.
11821 </summary>
11822 <value>
11823 A logo banner.
11824 </value>
11825 </member>
11826 <member name="P:NAnt.Core.Util.CommandLineParser.Usage">
11827 <summary>
11828 Gets the usage instructions.
11829 </summary>
11830 <value>The usage instructions.</value>
11831 </member>
11832 <member name="P:NAnt.Core.Util.CommandLineParser.NoArgs">
11833 <summary>
11834 Gets a value indicating whether no arguments were specified on the
11835 command line.
11836 </summary>
11837 </member>
11838 <member name="T:NAnt.Core.Util.DefaultCommandLineArgumentAttribute">
11839 <summary>
11840 Marks a command-line option as being the default option. When the name of
11841 a command-line argument is not specified, this option will be assumed.
11842 </summary>
11843 </member>
11844 <member name="M:NAnt.Core.Util.DefaultCommandLineArgumentAttribute.#ctor(NAnt.Core.Util.CommandLineArgumentTypes)">
11845 <summary>
11846 Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> class
11847 with the specified argument type.
11848 </summary>
11849 <param name="argumentType">Specifies the checking to be done on the argument.</param>
11850 </member>
11851 <member name="T:NAnt.Core.Util.FileUtils">
11852 <summary>
11853 Provides modified version for Copy and Move from the File class that
11854 allow for filter chain processing.
11855 </summary>
11856 </member>
11857 <member name="M:NAnt.Core.Util.FileUtils.CopyFile(System.String,System.String,NAnt.Core.Filters.FilterChain,System.Text.Encoding,System.Text.Encoding)">
11858 <summary>
11859 Copies a file filtering its content through the filter chain.
11860 </summary>
11861 <param name="sourceFileName">The file to copy</param>
11862 <param name="destFileName">The file to copy to</param>
11863 <param name="filterChain">Chain of filters to apply when copying, or <see langword="null" /> is no filters should be applied.</param>
11864 <param name="inputEncoding">The encoding used to read the soure file.</param>
11865 <param name="outputEncoding">The encoding used to write the destination file.</param>
11866 </member>
11867 <member name="M:NAnt.Core.Util.FileUtils.MoveFile(System.String,System.String,NAnt.Core.Filters.FilterChain,System.Text.Encoding,System.Text.Encoding)">
11868 <summary>
11869 Moves a file filtering its content through the filter chain.
11870 </summary>
11871 <param name="sourceFileName">The file to move.</param>
11872 <param name="destFileName">The file to move move to.</param>
11873 <param name="filterChain">Chain of filters to apply when moving, or <see langword="null" /> is no filters should be applied.</param>
11874 <param name="inputEncoding">The encoding used to read the soure file.</param>
11875 <param name="outputEncoding">The encoding used to write the destination file.</param>
11876 </member>
11877 <member name="M:NAnt.Core.Util.FileUtils.ReadFile(System.String,NAnt.Core.Filters.FilterChain,System.Text.Encoding)">
11878 <summary>
11879 Reads a file filtering its content through the filter chain.
11880 </summary>
11881 <param name="fileName">The file to read.</param>
11882 <param name="filterChain">Chain of filters to apply when reading, or <see langword="null" /> is no filters should be applied.</param>
11883 <param name="inputEncoding">The encoding used to read the file.</param>
11884 <remarks>
11885 If <paramref name="inputEncoding" /> is <see langword="null" />,
11886 then the system's ANSI code page will be used to read the file.
11887 </remarks>
11888 </member>
11889 <member name="M:NAnt.Core.Util.FileUtils.GetTempDirectory">
11890 <summary>
11891 Returns a uniquely named empty temporary directory on disk.
11892 </summary>
11893 <value>
11894 A <see cref="T:System.IO.DirectoryInfo"/> representing the temporary directory.
11895 </value>
11896 </member>
11897 <member name="M:NAnt.Core.Util.FileUtils.CombinePaths(System.String,System.String)">
11898 <summary>
11899 Combines two path strings.
11900 </summary>
11901 <param name="path1">The first path.</param>
11902 <param name="path2">The second path.</param>
11903 <returns>
11904 A string containing the combined paths. If one of the specified
11905 paths is a zero-length string, this method returns the other path.
11906 If <paramref name="path2"/> contains an absolute path, this method
11907 returns <paramref name="path2"/>.
11908 </returns>
11909 <remarks>
11910 <para>
11911 On *nix, processing is delegated to <see cref="M:System.IO.Path.Combine(System.String,System.String)"/>.
11912 </para>
11913 <para>
11914 On Windows, this method normalized the paths to avoid running into
11915 the 260 character limit of a path and converts forward slashes in
11916 both <paramref name="path1"/> and <paramref name="path2"/> to
11917 the platform's directory separator character.
11918 </para>
11919 </remarks>
11920 </member>
11921 <member name="M:NAnt.Core.Util.FileUtils.GetFullPath(System.String)">
11922 <summary>
11923 Returns Absolute Path (Fix for 260 Char Limit of Path.GetFullPath(...))
11924 </summary>
11925 <param name="path">The file or directory for which to obtain absolute path information.</param>
11926 <returns>Path Resolved</returns>
11927 <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>
11928 <exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
11929 </member>
11930 <member name="M:NAnt.Core.Util.FileUtils.GetHomeDirectory">
11931 <summary>
11932 Returns the home directory of the current user.
11933 </summary>
11934 <returns>
11935 The home directory of the current user.
11936 </returns>
11937 </member>
11938 <member name="M:NAnt.Core.Util.FileUtils.ResolveFile(System.String[],System.String,System.Boolean)">
11939 <summary>
11940 Scans a list of directories for the specified filename.
11941 </summary>
11942 <param name="directories">The list of directories to search.</param>
11943 <param name="fileName">The name of the file to look for.</param>
11944 <param name="recursive">Specifies whether the directory should be searched recursively.</param>
11945 <remarks>
11946 The directories are scanned in the order in which they are defined.
11947 </remarks>
11948 <returns>
11949 The absolute path to the specified file, or null if the file was
11950 not found.
11951 </returns>
11952 </member>
11953 <member name="T:NAnt.Core.Util.GacCache">
11954 <summary>
11955 Helper class for determining whether assemblies are located in the
11956 Global Assembly Cache.
11957 </summary>
11958 </member>
11959 <member name="M:NAnt.Core.Util.GacCache.#ctor(NAnt.Core.Project)">
11960 <summary>
11961 Initializes a new instance of the <see cref="T:NAnt.Core.Util.GacCache"/> class in
11962 the context of the given <see cref="P:NAnt.Core.Util.GacCache.Project"/>.
11963 </summary>
11964 </member>
11965 <member name="M:NAnt.Core.Util.GacCache.IsAssemblyInGac(System.String)">
11966 <summary>
11967 Determines whether an assembly is installed in the Global
11968 Assembly Cache given its file name or path.
11969 </summary>
11970 <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
11971 <returns>
11972 <see langword="true"/> if <paramref name="assemblyFile"/> is
11973 installed in the Global Assembly Cache; otherwise,
11974 <see langword="false"/>.
11975 </returns>
11976 <remarks>
11977 <para>
11978 To determine whether the specified assembly is installed in the
11979 Global Assembly Cache, the assembly is loaded into a separate
11980 <see cref="T:System.AppDomain"/>.
11981 </para>
11982 <para>
11983 If the family of the current runtime framework does not match the
11984 family of the current target framework, this method will return
11985 <see langword="false"/> for all assemblies as there's no way to
11986 determine whether a given assembly is in the Global Assembly Cache
11987 for another framework family than the family of the current runtime
11988 framework.
11989 </para>
11990 </remarks>
11991 </member>
11992 <member name="F:NAnt.Core.Util.GacCache._domain">
11993 <summary>
11994 Holds the <see cref="T:System.AppDomain"/> in which assemblies will be loaded
11995 to determine whether they are in the Global Assembly Cache.
11996 </summary>
11997 </member>
11998 <member name="F:NAnt.Core.Util.GacCache._project">
11999 <summary>
12000 Holds the <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
12001 </summary>
12002 </member>
12003 <member name="F:NAnt.Core.Util.GacCache._gacQueryCache">
12004 <summary>
12005 Holds a list of assembly files for which already has been determined
12006 whether they are located in the Global Assembly Cache.
12007 </summary>
12008 <remarks>
12009 <para>
12010 The key of the <see cref="T:System.Collections.Hashtable"/> is the full path to the
12011 assembly file and the value is a <see cref="T:System.Boolean"/> indicating
12012 whether the assembly is located in the Global Assembly Cache.
12013 </para>
12014 </remarks>
12015 </member>
12016 <member name="F:NAnt.Core.Util.GacCache._disposed">
12017 <summary>
12018 Holds a value indicating whether the object has been disposed.
12019 </summary>
12020 </member>
12021 <member name="P:NAnt.Core.Util.GacCache.Project">
12022 <summary>
12023 Gets the <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
12024 </summary>
12025 <value>
12026 The <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
12027 </value>
12028 </member>
12029 <member name="M:NAnt.Core.Util.GacCache.GacResolver.InitializeLifetimeService">
12030 <summary>
12031 Obtains a lifetime service object to control the lifetime policy for
12032 this instance.
12033 </summary>
12034 <returns>
12035 An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
12036 policy for this instance. This is the current lifetime service object
12037 for this instance if one exists; otherwise, a new lifetime service
12038 object initialized with a lease that will never time out.
12039 </returns>
12040 </member>
12041 <member name="M:NAnt.Core.Util.GacCache.GacResolver.IsAssemblyInGac(System.String)">
12042 <summary>
12043 Determines whether an assembly is installed in the Global
12044 Assembly Cache given its file name or path.
12045 </summary>
12046 <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
12047 <returns>
12048 <see langword="true" /> if <paramref name="assemblyFile" /> is
12049 installed in the Global Assembly Cache; otherwise,
12050 <see langword="false" />.
12051 </returns>
12052 </member>
12053 <member name="T:NAnt.Core.Util.ReflectionUtils">
12054 <summary>
12055 Provides a set of helper methods related to reflection.
12056 </summary>
12057 </member>
12058 <member name="M:NAnt.Core.Util.ReflectionUtils.#ctor">
12059 <summary>
12060 Initializes a new instance of the <see cref="T:NAnt.Core.Util.ReflectionUtils"/> class.
12061 </summary>
12062 <remarks>
12063 Uses a private access modifier to prevent instantiation of this class.
12064 </remarks>
12065 </member>
12066 <member name="M:NAnt.Core.Util.ReflectionUtils.GetTypeFromString(System.String,System.Boolean)">
12067 <summary>
12068 Loads the type specified in the type string with assembly qualified name.
12069 </summary>
12070 <param name="typeName">The assembly qualified name of the type to load.</param>
12071 <param name="throwOnError">Flag set to <see langword="true"/> to throw an exception if the type cannot be loaded.</param>
12072 <exception cref="T:System.TypeLoadException">
12073 <paramref name="throwOnError"/> is <see langword="true"/> and
12074 an error is encountered while loading the <see cref="T:System.Type"/>, or
12075 <paramref name="typeName"/> is not an assembly qualified name.
12076 </exception>
12077 <remarks>
12078 If the <see cref="T:System.Type"/> cannot be instantiated from the assembly
12079 qualified type name, then we'll try to instantiate the type using its
12080 simple type name from an already loaded assembly with an assembly
12081 name mathing the assembly in the assembly qualified type name.
12082 </remarks>
12083 <returns>
12084 The type loaded or <see langword="null"/> if it could not be loaded.
12085 </returns>
12086 </member>
12087 <member name="T:NAnt.Core.Util.ResourceUtils">
12088 <summary>
12089 Provides resource support to NAnt assemblies. This class cannot
12090 be inherited from.
12091 </summary>
12092 </member>
12093 <member name="M:NAnt.Core.Util.ResourceUtils.#ctor">
12094 <summary>
12095 Prevents the <see cref="T:NAnt.Core.Util.ResourceUtils"/> class from being
12096 instantiated explicitly.
12097 </summary>
12098 </member>
12099 <member name="M:NAnt.Core.Util.ResourceUtils.RegisterSharedAssembly(System.Reflection.Assembly)">
12100 <summary>
12101 Registers the assembly to be used as the fallback if resources
12102 aren't found in the local satellite assembly.
12103 </summary>
12104 <param name="assembly">
12105 A <see cref="T:System.Reflection.Assembly"/> that represents the
12106 assembly to register.
12107 </param>
12108 <example>
12109 The following example shows how to register a shared satellite
12110 assembly.
12111 <code>
12112 <![CDATA[
12113 Assembly sharedAssembly = Assembly.Load("MyResources.dll");
12114 ResourceUtils.RegisterSharedAssembly(sharedAssembly);
12115 ]]>
12116 </code>
12117 </example>
12118 </member>
12119 <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String)">
12120 <summary>
12121 Returns the value of the specified string resource.
12122 </summary>
12123 <param name="name">
12124 A <see cref="T:System.String"/> that contains the name of the
12125 resource to get.
12126 </param>
12127 <returns>
12128 A <see cref="T:System.String"/> that contains the value of the
12129 resource localized for the current culture.
12130 </returns>
12131 <remarks>
12132 The returned resource is localized for the cultural settings of the
12133 current <see cref="T:System.Threading.Thread"/>.
12134 <note>
12135 The <c>GetString</c> method is thread-safe.
12136 </note>
12137 </remarks>
12138 <example>
12139 The following example demonstrates the <c>GetString</c> method using
12140 the cultural settings of the current <see cref="T:System.Threading.Thread"/>.
12141 <code>
12142 <![CDATA[
12143 string localizedString = ResourceUtils.GetString("String_HelloWorld");
12144 ]]>
12145 </code>
12146 </example>
12147 </member>
12148 <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String,System.Globalization.CultureInfo)">
12149 <summary>
12150 Returns the value of the specified string resource localized for
12151 the specified culture.
12152 </summary>
12153 <param name="name"></param>
12154 <param name="culture"></param>
12155 <returns>
12156 A <see cref="T:System.String"/> that contains the value of the
12157 resource localized for the specified culture.
12158 </returns>
12159 <remarks>
12160 <note>
12161 The <c>GetString</c> method is thread-safe.
12162 </note>
12163 </remarks>
12164 <example>
12165 The following example demonstrates the <c>GetString</c> method using
12166 a specific culture.
12167 <code>
12168 <![CDATA[
12169 CultureInfo culture = CultureInfo.CreateSpecificCulture("en-US");
12170 string localizedString = ResourceUtils.GetString("String_HelloWorld", culture);
12171 ]]>
12172 </code>
12173 </example>
12174 </member>
12175 <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String,System.Globalization.CultureInfo,System.Reflection.Assembly)">
12176 <summary>
12177 Returns the value of the specified string resource localized for
12178 the specified culture for the specified assembly.
12179 </summary>
12180 <param name="name">
12181 A <see cref="T:System.String"/> that contains the name of the
12182 resource to get.
12183 </param>
12184 <param name="culture">
12185 A <see cref="T:System.Globalization.CultureInfo"/> that represents
12186 the culture for which the resource is localized.
12187 </param>
12188 <param name="assembly">
12189 A <see cref="T:System.Reflection.Assembly"/>
12190 </param>
12191 <returns>
12192 A <see cref="T:System.String"/> that contains the value of the
12193 resource localized for the specified culture.
12194 </returns>
12195 <remarks>
12196 <note>
12197 The <c>GetString</c> method is thread-safe.
12198 </note>
12199 </remarks>
12200 <example>
12201 The following example demonstrates the <c>GetString</c> method using
12202 specific culture and assembly.
12203 <code>
12204 <![CDATA[
12205 CultureInfo culture = CultureInfo.CreateSpecificCulture("en-US");
12206 Assembly assembly = Assembly.GetCallingAssembly();
12207 string localizedString = ResourceUtils.GetString("String_HelloWorld", culture, assembly);
12208 ]]>
12209 </code>
12210 </example>
12211 </member>
12212 <member name="M:NAnt.Core.Util.ResourceUtils.RegisterAssembly(System.Reflection.Assembly)">
12213 <summary>
12214 Registers the specified assembly.
12215 </summary>
12216 <param name="assembly">
12217 A <see cref="T:System.Reflection.Assembly"/> that represents the
12218 assembly to register.
12219 </param>
12220 </member>
12221 <member name="M:NAnt.Core.Util.ResourceUtils.GetResourceName(System.String)">
12222 <summary>
12223 Determines the manifest resource name of the resource holding the
12224 localized strings.
12225 </summary>
12226 <param name="assemblyName">The name of the assembly.</param>
12227 <returns>
12228 The manifest resource name of the resource holding the localized
12229 strings for the specified assembly.
12230 </returns>
12231 <remarks>
12232 The manifest resource name of the resource holding the localized
12233 strings should match the name of the assembly, minus <c>Tasks</c>
12234 suffix.
12235 </remarks>
12236 </member>
12237 <member name="T:NAnt.Core.Util.StringUtils">
12238 <summary>
12239 Groups a set of useful <see cref="T:System.String"/> manipulation and validation
12240 methods.
12241 </summary>
12242 </member>
12243 <member name="M:NAnt.Core.Util.StringUtils.#ctor">
12244 <summary>
12245 Initializes a new instance of the <see cref="T:NAnt.Core.Util.StringUtils"/> class.
12246 </summary>
12247 <remarks>
12248 Prevents instantiation of the <see cref="T:NAnt.Core.Util.StringUtils"/> class.
12249 </remarks>
12250 </member>
12251 <member name="M:NAnt.Core.Util.StringUtils.EndsWith(System.String,System.Char)">
12252 <summary>
12253 Determines whether the last character of the given <see cref="T:System.String"/>
12254 matches the specified character.
12255 </summary>
12256 <param name="value">The string.</param>
12257 <param name="c">The character.</param>
12258 <returns>
12259 <see langword="true"/> if the last character of <paramref name="value"/>
12260 matches <paramref name="c"/>; otherwise, <see langword="false"/>.
12261 </returns>
12262 <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null"/>.</exception>
12263 </member>
12264 <member name="M:NAnt.Core.Util.StringUtils.IsNullOrEmpty(System.String)">
12265 <summary>
12266 Indicates whether or not the specified <see cref="T:System.String"/> is
12267 <see langword="null"/> or an <see cref="F:System.String.Empty"/> string.
12268 </summary>
12269 <param name="value">The value to check.</param>
12270 <returns>
12271 <see langword="true"/> if <paramref name="value"/> is <see langword="null"/>
12272 or an empty string (""); otherwise, <see langword="false"/>.
12273 </returns>
12274 </member>
12275 <member name="M:NAnt.Core.Util.StringUtils.ConvertEmptyToNull(System.String)">
12276 <summary>
12277 Converts an empty string ("") to <see langword="null" />.
12278 </summary>
12279 <param name="value">The value to convert.</param>
12280 <returns>
12281 <see langword="null" /> if <paramref name="value" /> is an empty
12282 string ("") or <see langword="null" />; otherwise, <paramref name="value" />.
12283 </returns>
12284 </member>
12285 <member name="M:NAnt.Core.Util.StringUtils.ConvertNullToEmpty(System.String)">
12286 <summary>
12287 Converts <see langword="null" /> to an empty string.
12288 </summary>
12289 <param name="value">The value to convert.</param>
12290 <returns>
12291 An empty string if <paramref name="value" /> is <see langword="null" />;
12292 otherwise, <paramref name="value" />.
12293 </returns>
12294 </member>
12295 <member name="M:NAnt.Core.Util.StringUtils.Join(System.String,System.Collections.Specialized.StringCollection)">
12296 <summary>
12297 Concatenates a specified separator <see cref="T:System.String"/> between each
12298 element of a specified <see cref="T:System.Collections.Specialized.StringCollection"/>, yielding a
12299 single concatenated string.
12300 </summary>
12301 <param name="separator">A <see cref="T:System.String"/>.</param>
12302 <param name="value">A <see cref="T:System.Collections.Specialized.StringCollection"/>.</param>
12303 <returns>
12304 A <see cref="T:System.String"/> consisting of the elements of <paramref name="value"/>
12305 interspersed with the separator string.
12306 </returns>
12307 <remarks>
12308 <para>
12309 For example if <paramref name="separator"/> is ", " and the elements
12310 of <paramref name="value"/> are "apple", "orange", "grape", and "pear",
12311 <see cref="M:NAnt.Core.Util.StringUtils.Join(System.String,System.Collections.Specialized.StringCollection)"/> returns "apple, orange,
12312 grape, pear".
12313 </para>
12314 <para>
12315 If <paramref name="separator"/> is <see langword="null"/>, an empty
12316 string (<see cref="F:System.String.Empty"/>) is used instead.
12317 </para>
12318 </remarks>
12319 </member>
12320 <member name="M:NAnt.Core.Util.StringUtils.Clone(System.Collections.Specialized.StringCollection)">
12321 <summary>
12322 Creates a shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
12323 </summary>
12324 <param name="stringCollection">The <see cref="T:System.Collections.Specialized.StringCollection"/> that should be copied.</param>
12325 <returns>
12326 A shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
12327 </returns>
12328 </member>
12329 <member name="T:NAnt.Core.BuildException">
12330 <summary>
12331 Thrown whenever an error occurs during the build.
12332 </summary>
12333 </member>
12334 <member name="F:NAnt.Core.BuildException._location">
12335 <summary>
12336 The location of the exception in the build document (xml file).
12337 </summary>
12338 </member>
12339 <member name="M:NAnt.Core.BuildException.#ctor">
12340 <summary>
12341 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class.
12342 </summary>
12343 </member>
12344 <member name="M:NAnt.Core.BuildException.#ctor(System.String)">
12345 <summary>
12346 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12347 with a descriptive message.
12348 </summary>
12349 <param name="message">A descriptive message to include with the exception.</param>
12350 </member>
12351 <member name="M:NAnt.Core.BuildException.#ctor(System.String,System.Exception)">
12352 <summary>
12353 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12354 with the specified descriptive message and inner exception.
12355 </summary>
12356 <param name="message">A descriptive message to include with the exception.</param>
12357 <param name="innerException">A nested exception that is the cause of the current exception.</param>
12358 </member>
12359 <member name="M:NAnt.Core.BuildException.#ctor(System.String,NAnt.Core.Location)">
12360 <summary>
12361 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12362 with a descriptive message and the location in the build file that
12363 caused the exception.
12364 </summary>
12365 <param name="message">A descriptive message to include with the exception.</param>
12366 <param name="location">The location in the build file where the exception occured.</param>
12367 </member>
12368 <member name="M:NAnt.Core.BuildException.#ctor(System.String,NAnt.Core.Location,System.Exception)">
12369 <summary>
12370 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12371 with a descriptive message, the location in the build file and an
12372 instance of the exception that is the cause of the current exception.
12373 </summary>
12374 <param name="message">A descriptive message to include with the exception.</param>
12375 <param name="location">The location in the build file where the exception occured.</param>
12376 <param name="innerException">A nested exception that is the cause of the current exception.</param>
12377 </member>
12378 <member name="M:NAnt.Core.BuildException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
12379 <summary>
12380 Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
12381 with serialized data.
12382 </summary>
12383 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
12384 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
12385 </member>
12386 <member name="M:NAnt.Core.BuildException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
12387 <summary>
12388 Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
12389 </summary>
12390 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
12391 <param name="context">The destination for this serialization.</param>
12392 </member>
12393 <member name="M:NAnt.Core.BuildException.ToString">
12394 <summary>
12395 Creates and returns a string representation of the current
12396 exception.
12397 </summary>
12398 <returns>
12399 A string representation of the current exception.
12400 </returns>
12401 </member>
12402 <member name="P:NAnt.Core.BuildException.RawMessage">
12403 <summary>
12404 Gets the raw message as specified when the exception was
12405 constructed.
12406 </summary>
12407 <value>
12408 The raw message as specified when the exception was
12409 constructed.
12410 </value>
12411 </member>
12412 <member name="P:NAnt.Core.BuildException.Location">
12413 <summary>
12414 Gets the location in the build file of the element from which the
12415 exception originated.
12416 </summary>
12417 <value>
12418 The location in the build file of the element from which the
12419 exception originated.
12420 </value>
12421 </member>
12422 <member name="P:NAnt.Core.BuildException.Message">
12423 <summary>
12424 Gets a message that describes the current exception.
12425 </summary>
12426 <value>
12427 The error message that explains the reason for the exception.
12428 </value>
12429 <remarks>
12430 Adds location information to the message, if available.
12431 </remarks>
12432 </member>
12433 <member name="T:NAnt.Core.CommandLineOptions">
12434 <summary>
12435 Represents the set of command-line options supported by NAnt.
12436 </summary>
12437 </member>
12438 <member name="P:NAnt.Core.CommandLineOptions.TargetFramework">
12439 <summary>
12440 Gets or sets the target framework to use (overrides
12441 NAnt.exe.config settings)
12442 </summary>
12443 <value>
12444 The framework that should be used.
12445 </value>
12446 <remarks>
12447 For a list of possible frameworks, see NAnt.exe.config, possible
12448 values include "net-1.0", "net-1.1", etc.
12449 </remarks>
12450 </member>
12451 <member name="P:NAnt.Core.CommandLineOptions.DefaultFramework">
12452 <summary>
12453 Gets or sets the target framework to use (overrides
12454 NAnt.exe.config settings)
12455 </summary>
12456 <value>
12457 The framework that should be used.
12458 </value>
12459 <remarks>
12460 For a list of possible frameworks, see NAnt.exe.config, possible
12461 values include "net-1.0", "net-1.1", etc.
12462 </remarks>
12463 </member>
12464 <member name="P:NAnt.Core.CommandLineOptions.BuildFile">
12465 <summary>
12466 Gets or sets the buildfile that should be executed.
12467 </summary>
12468 <value>
12469 The buildfile that should be executed.
12470 </value>
12471 <remarks>
12472 Can be both a file or an URI.
12473 </remarks>
12474 </member>
12475 <member name="P:NAnt.Core.CommandLineOptions.Verbose">
12476 <summary>
12477 Gets or sets a value indicating whether more information should be
12478 displayed during the build process.
12479 </summary>
12480 <value>
12481 <see langword="true" /> if more information should be displayed;
12482 otherwise, <see langword="false" />. The default is <see langword="false" />.
12483 </value>
12484 </member>
12485 <member name="P:NAnt.Core.CommandLineOptions.Debug">
12486 <summary>
12487 Gets or sets a value indicating whether debug information should be
12488 displayed during the build process.
12489 </summary>
12490 <value>
12491 <see langword="true" /> if debug information should be displayed;
12492 otherwise, <see langword="false" />. The default is <see langword="false" />.
12493 </value>
12494 </member>
12495 <member name="P:NAnt.Core.CommandLineOptions.Quiet">
12496 <summary>
12497 Gets or sets a value indicating whether only error and debug debug messages should be
12498 displayed during the build process.
12499 </summary>
12500 <value>
12501 <see langword="true" /> if only error or warning messages should be
12502 displayed; otherwise, <see langword="false" />. The default is
12503 <see langword="false" />.
12504 </value>
12505 </member>
12506 <member name="P:NAnt.Core.CommandLineOptions.EmacsMode">
12507 <summary>
12508 Gets or sets a value indicating whether to produce emacs (and other
12509 editor) friendly output.
12510 </summary>
12511 <value>
12512 <see langword="true" /> if output is to be unadorned so that emacs
12513 and other editors can parse files names, etc. The default is
12514 <see langword="false" />.
12515 </value>
12516 </member>
12517 <member name="P:NAnt.Core.CommandLineOptions.FindInParent">
12518 <summary>
12519 Gets a value indicating whether parent directories should be searched
12520 for a buildfile.
12521 </summary>
12522 <value>
12523 <see langword="true" /> if parent directories should be searched for
12524 a build file; otherwise, <see langword="false" />. The default is
12525 <see langword="false" />.
12526 </value>
12527 </member>
12528 <member name="P:NAnt.Core.CommandLineOptions.IndentationLevel">
12529 <summary>
12530 Gets or sets the indentation level of the build output.
12531 </summary>
12532 <value>
12533 The indentation level of the build output. The default is <c>0</c>.
12534 </value>
12535 </member>
12536 <member name="P:NAnt.Core.CommandLineOptions.Properties">
12537 <summary>
12538 Gets or sets the list of properties that should be set.
12539 </summary>
12540 <value>
12541 The list of properties that should be set.
12542 </value>
12543 </member>
12544 <member name="P:NAnt.Core.CommandLineOptions.LoggerType">
12545 <summary>
12546 Gets or sets the <see cref="T:System.Type"/> of logger to add to the list
12547 of listeners.
12548 </summary>
12549 <value>
12550 The <see cref="T:System.Type"/> of logger to add to the list of
12551 listeners.
12552 </value>
12553 <remarks>
12554 The <see cref="P:NAnt.Core.CommandLineOptions.LoggerType"/> should derive from <see cref="T:NAnt.Core.IBuildLogger"/>.
12555 </remarks>
12556 </member>
12557 <member name="P:NAnt.Core.CommandLineOptions.LogFile">
12558 <summary>
12559 Gets or sets the name of the file to log output to.
12560 </summary>
12561 <value>
12562 The name of the file to log output to.
12563 </value>
12564 </member>
12565 <member name="P:NAnt.Core.CommandLineOptions.Listeners">
12566 <summary>
12567 Gets a collection containing fully qualified type names of classes
12568 implementating <see cref="T:NAnt.Core.IBuildListener"/> that should be added
12569 to the project as listeners.
12570 </summary>
12571 <value>
12572 A collection of fully qualified type names that should be added as
12573 listeners to the <see cref="T:NAnt.Core.Project"/>.
12574 </value>
12575 </member>
12576 <member name="P:NAnt.Core.CommandLineOptions.ExtensionAssemblies">
12577 <summary>
12578 Gets a collection of assemblies to load extensions from.
12579 </summary>
12580 <value>
12581 A collection of assemblies to load extensions from.
12582 </value>
12583 </member>
12584 <member name="P:NAnt.Core.CommandLineOptions.ShowProjectHelp">
12585 <summary>
12586 Gets or sets a value indicating whether <see cref="T:NAnt.Core.Project"/> help
12587 should be printed.
12588 </summary>
12589 <value>
12590 <see langword="true"/> if <see cref="T:NAnt.Core.Project"/> help should be
12591 printed; otherwise, <see langword="false"/>. The default is
12592 <see langword="false"/>.
12593 </value>
12594 </member>
12595 <member name="P:NAnt.Core.CommandLineOptions.NoLogo">
12596 <summary>
12597 Gets or sets a value indicating whether the logo banner should be
12598 printed.
12599 </summary>
12600 <value>
12601 <see langword="true" /> if the logo banner should be printed; otherwise,
12602 <see langword="false" />. The default is <see langword="false" />.
12603 </value>
12604 </member>
12605 <member name="P:NAnt.Core.CommandLineOptions.ShowHelp">
12606 <summary>
12607 Gets or sets a value indicating whether the NAnt help should be
12608 printed.
12609 </summary>
12610 <value>
12611 <see langword="true" /> if NAnt help should be printed; otherwise,
12612 <see langword="false" />. The default is <see langword="false" />.
12613 </value>
12614 </member>
12615 <member name="P:NAnt.Core.CommandLineOptions.Targets">
12616 <summary>
12617 Gets a collection containing the targets that should be executed.
12618 </summary>
12619 <value>
12620 A collection that contains the targets that should be executed.
12621 </value>
12622 </member>
12623 <member name="T:NAnt.Core.ConfigurationSection">
12624 <summary>
12625 Custom configuration section handler for the <nantsettings/> element.
12626 </summary>
12627 </member>
12628 <member name="M:NAnt.Core.ConfigurationSection.Create(System.Object,System.Object,System.Xml.XmlNode)">
12629 <summary>
12630 This just passed things through. Return the node read from the config file.
12631 </summary>
12632 </member>
12633 <member name="T:NAnt.Core.ConsoleDriver">
12634 <summary>
12635 Main entry point to NAnt that is called by the ConsoleStub.
12636 </summary>
12637 </member>
12638 <member name="M:NAnt.Core.ConsoleDriver.Main(System.String[])">
12639 <summary>
12640 Starts NAnt. This is the Main entry point.
12641 </summary>
12642 <param name="args">Command Line args, or whatever you want to pass it. They will treated as Command Line args.</param>
12643 <returns>
12644 The exit code.
12645 </returns>
12646 </member>
12647 <member name="M:NAnt.Core.ConsoleDriver.ShowProjectHelp(System.Xml.XmlDocument)">
12648 <summary>
12649 Prints the projecthelp to the console.
12650 </summary>
12651 <param name="buildDoc">The build file to show help for.</param>
12652 <remarks>
12653 <paramref name="buildDoc" /> is loaded and transformed with
12654 <c>ProjectHelp.xslt</c>, which is an embedded resource.
12655 </remarks>
12656 </member>
12657 <member name="M:NAnt.Core.ConsoleDriver.GetBuildFileName(System.String,System.String,System.Boolean)">
12658 <summary>
12659 Gets the file name for the build file in the specified directory.
12660 </summary>
12661 <param name="directory">The directory to look for a build file. When in doubt use Environment.CurrentDirectory for directory.</param>
12662 <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>
12663 <param name="findInParent">Whether or not to search the parent directories for a build file.</param>
12664 <returns>The path to the build file or <c>null</c> if no build file could be found.</returns>
12665 </member>
12666 <member name="M:NAnt.Core.ConsoleDriver.LoadExtensionAssemblies(System.Collections.Specialized.StringCollection,NAnt.Core.Project)">
12667 <summary>
12668 Loads the extension assemblies in the current <see cref="T:System.AppDomain"/>
12669 and scans them for extensions.
12670 </summary>
12671 <param name="extensionAssemblies">The extension assemblies to load.</param>
12672 <param name="project">The <see cref="T:NAnt.Core.Project"/> which will be used to output messages to the build log.</param>
12673 </member>
12674 <member name="M:NAnt.Core.ConsoleDriver.CreateLogger(System.String)">
12675 <summary>
12676 Dynamically constructs an <see cref="T:NAnt.Core.IBuildLogger"/> instance of
12677 the class specified.
12678 </summary>
12679 <remarks>
12680 <para>
12681 At this point, only looks in the assembly where <see cref="T:NAnt.Core.IBuildLogger"/>
12682 is defined.
12683 </para>
12684 </remarks>
12685 <param name="typeName">The fully qualified name of the logger that should be instantiated.</param>
12686 <exception cref="T:System.TypeLoadException">Type <paramref name="typeName"/> could not be loaded.</exception>
12687 <exception cref="T:System.ArgumentException"><paramref name="typeName"/> does not implement <see cref="T:NAnt.Core.IBuildLogger"/>.</exception>
12688 </member>
12689 <member name="M:NAnt.Core.ConsoleDriver.CreateListener(System.String)">
12690 <summary>
12691 Dynamically constructs an <see cref="T:NAnt.Core.IBuildListener"/> instance of
12692 the class specified.
12693 </summary>
12694 <remarks>
12695 <para>
12696 At this point, only looks in the assembly where <see cref="T:NAnt.Core.IBuildListener"/>
12697 is defined.
12698 </para>
12699 </remarks>
12700 <param name="typeName">The fully qualified name of the listener that should be instantiated.</param>
12701 <exception cref="T:System.TypeLoadException">Type <paramref name="typeName"/> could not be loaded.</exception>
12702 <exception cref="T:System.ArgumentException"><paramref name="typeName"/> does not implement <see cref="T:NAnt.Core.IBuildListener"/>.</exception>
12703 </member>
12704 <member name="M:NAnt.Core.ConsoleDriver.AddBuildListeners(NAnt.Core.CommandLineOptions,NAnt.Core.Project)">
12705 <summary>
12706 Add the listeners specified in the command line arguments,
12707 along with the default listener, to the specified project.
12708 </summary>
12709 <param name="cmdlineOptions">The command-line options.</param>
12710 <param name="project">The <see cref="T:NAnt.Core.Project"/> to add listeners to.</param>
12711 </member>
12712 <member name="M:NAnt.Core.ConsoleDriver.ShowHelp(NAnt.Core.Util.CommandLineParser)">
12713 <summary>
12714 Spits out generic help info to the console.
12715 </summary>
12716 </member>
12717 <member name="M:NAnt.Core.ConsoleDriver.WriteException(System.Exception)">
12718 <summary>
12719 Write the message of the specified <see cref="T:System.Exception"/> and
12720 the inner exceptions to <see cref="P:System.Console.Error"/>.
12721 </summary>
12722 <param name="cause">The <see cref="T:System.Exception"/> to write to <see cref="P:System.Console.Error"/>.</param>
12723 </member>
12724 <member name="M:NAnt.Core.DataTypeBaseBuilder.#ctor(System.Reflection.Assembly,System.String)">
12725 <summary>
12726 Creates a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> class
12727 for the specified <see cref="T:NAnt.Core.DataTypeBase"/> class in the specified
12728 <see cref="T:System.Reflection.Assembly"/>.
12729 </summary>
12730 <remarks>
12731 An <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the specified <see cref="T:System.Reflection.Assembly"/>
12732 is cached for future use.
12733 </remarks>
12734 <param name="assembly">The <see cref="T:System.Reflection.Assembly"/> containing the <see cref="T:NAnt.Core.DataTypeBase"/>.</param>
12735 <param name="className">The class representing the <see cref="T:NAnt.Core.DataTypeBase"/>.</param>
12736 </member>
12737 <member name="M:NAnt.Core.DataTypeBaseBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
12738 <summary>
12739 Creates a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
12740 class for the specified <see cref="T:NAnt.Core.DataTypeBase"/> class in the
12741 <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> specified.
12742 </summary>
12743 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.DataTypeBase"/>.</param>
12744 <param name="className">The class representing the <see cref="T:NAnt.Core.DataTypeBase"/>.</param>
12745 </member>
12746 <member name="P:NAnt.Core.DataTypeBaseBuilder.ClassName">
12747 <summary>
12748 Gets the name of the <see cref="T:NAnt.Core.DataTypeBase"/> class that can be
12749 created using this <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>.
12750 </summary>
12751 <value>
12752 The name of the <see cref="T:NAnt.Core.DataTypeBase"/> class that can be created
12753 using this <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>.
12754 </value>
12755 </member>
12756 <member name="P:NAnt.Core.DataTypeBaseBuilder.DataTypeName">
12757 <summary>
12758 Gets the name of the data type which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
12759 can create.
12760 </summary>
12761 <value>
12762 The name of the data type which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
12763 can create.
12764 </value>
12765 </member>
12766 <member name="T:NAnt.Core.DataTypeBaseBuilderCollection">
12767 <summary>
12768 Contains a strongly typed collection of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> objects.
12769 </summary>
12770 </member>
12771 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor">
12772 <summary>
12773 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class.
12774 </summary>
12775 </member>
12776 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor(NAnt.Core.DataTypeBaseBuilderCollection)">
12777 <summary>
12778 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class
12779 with the specified <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> instance.
12780 </summary>
12781 </member>
12782 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor(NAnt.Core.DataTypeBaseBuilder[])">
12783 <summary>
12784 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class
12785 with the specified array of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
12786 </summary>
12787 </member>
12788 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Add(NAnt.Core.DataTypeBaseBuilder)">
12789 <summary>
12790 Adds a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to the end of the collection.
12791 </summary>
12792 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to be added to the end of the collection.</param>
12793 <returns>The position into which the new element was inserted.</returns>
12794 </member>
12795 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.AddRange(NAnt.Core.DataTypeBaseBuilder[])">
12796 <summary>
12797 Adds the elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> array to the end of the collection.
12798 </summary>
12799 <param name="items">The array of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> elements to be added to the end of the collection.</param>
12800 </member>
12801 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.AddRange(NAnt.Core.DataTypeBaseBuilderCollection)">
12802 <summary>
12803 Adds the elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> to the end of the collection.
12804 </summary>
12805 <param name="items">The <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> to be added to the end of the collection.</param>
12806 </member>
12807 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Contains(NAnt.Core.DataTypeBaseBuilder)">
12808 <summary>
12809 Determines whether a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> is in the collection.
12810 </summary>
12811 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to locate in the collection.</param>
12812 <returns>
12813 <see langword="true"/> if <paramref name="item"/> is found in the
12814 collection; otherwise, <see langword="false"/>.
12815 </returns>
12816 </member>
12817 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Contains(System.String)">
12818 <summary>
12819 Determines whether a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for the specified
12820 task is in the collection.
12821 </summary>
12822 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> should be located in the collection.</param>
12823 <returns>
12824 <see langword="true"/> if a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for
12825 the specified task is found in the collection; otherwise,
12826 <see langword="false"/>.
12827 </returns>
12828 </member>
12829 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.CopyTo(NAnt.Core.DataTypeBaseBuilder[],System.Int32)">
12830 <summary>
12831 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
12832 </summary>
12833 <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>
12834 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
12835 </member>
12836 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.IndexOf(NAnt.Core.DataTypeBaseBuilder)">
12837 <summary>
12838 Retrieves the index of a specified <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> object in the collection.
12839 </summary>
12840 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> object for which the index is returned.</param>
12841 <returns>
12842 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.
12843 </returns>
12844 </member>
12845 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Insert(System.Int32,NAnt.Core.DataTypeBaseBuilder)">
12846 <summary>
12847 Inserts a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> into the collection at the specified index.
12848 </summary>
12849 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
12850 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to insert.</param>
12851 </member>
12852 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.GetEnumerator">
12853 <summary>
12854 Returns an enumerator that can iterate through the collection.
12855 </summary>
12856 <returns>
12857 A <see cref="T:NAnt.Core.DataTypeBaseBuilderEnumerator"/> for the entire collection.
12858 </returns>
12859 </member>
12860 <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Remove(NAnt.Core.DataTypeBaseBuilder)">
12861 <summary>
12862 Removes a member from the collection.
12863 </summary>
12864 <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to remove from the collection.</param>
12865 </member>
12866 <member name="P:NAnt.Core.DataTypeBaseBuilderCollection.Item(System.Int32)">
12867 <summary>
12868 Gets or sets the element at the specified index.
12869 </summary>
12870 <param name="index">The zero-based index of the element to get or set.</param>
12871 </member>
12872 <member name="P:NAnt.Core.DataTypeBaseBuilderCollection.Item(System.String)">
12873 <summary>
12874 Gets the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for the specified task.
12875 </summary>
12876 <param name="dataTypeName">The name of task for which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> should be located in the collection.</param>
12877 </member>
12878 <member name="T:NAnt.Core.DataTypeBaseBuilderEnumerator">
12879 <summary>
12880 Enumerates the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/>.
12881 </summary>
12882 </member>
12883 <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.#ctor(NAnt.Core.DataTypeBaseBuilderCollection)">
12884 <summary>
12885 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderEnumerator"/> class
12886 with the specified <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/>.
12887 </summary>
12888 <param name="arguments">The collection that should be enumerated.</param>
12889 </member>
12890 <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.MoveNext">
12891 <summary>
12892 Advances the enumerator to the next element of the collection.
12893 </summary>
12894 <returns>
12895 <see langword="true" /> if the enumerator was successfully advanced
12896 to the next element; <see langword="false" /> if the enumerator has
12897 passed the end of the collection.
12898 </returns>
12899 </member>
12900 <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.Reset">
12901 <summary>
12902 Sets the enumerator to its initial position, which is before the
12903 first element in the collection.
12904 </summary>
12905 </member>
12906 <member name="P:NAnt.Core.DataTypeBaseBuilderEnumerator.Current">
12907 <summary>
12908 Gets the current element in the collection.
12909 </summary>
12910 <returns>
12911 The current element in the collection.
12912 </returns>
12913 </member>
12914 <member name="M:NAnt.Core.DataTypeBaseDictionary.#ctor">
12915 <summary>
12916 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseDictionary"/> class.
12917 </summary>
12918 </member>
12919 <member name="M:NAnt.Core.DataTypeBaseDictionary.#ctor(System.Int32)">
12920 <summary>
12921 Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseDictionary"/> class
12922 with the specified capacity.
12923 </summary>
12924 </member>
12925 <member name="M:NAnt.Core.DataTypeBaseDictionary.Inherit(NAnt.Core.DataTypeBaseDictionary)">
12926 <summary>
12927 Inherits Properties from an existing property
12928 dictionary Instance
12929 </summary>
12930 <param name="source">DataType list to inherit</param>
12931 </member>
12932 <member name="T:NAnt.Core.DirectoryScanner">
12933 <summary>
12934 Used for searching filesystem based on given include/exclude rules.
12935 </summary>
12936 <example>
12937 <para>Simple client code for testing the class.</para>
12938 <code>
12939 while (true) {
12940 DirectoryScanner scanner = new DirectoryScanner();
12941 Console.Write("Scan Basedirectory : ");
12942 string s = Console.ReadLine();
12943 if (s.Length == 0) break;
12944 scanner.BaseDirectory = s;
12945 while(true) {
12946 Console.Write("Include pattern : ");
12947 s = Console.ReadLine();
12948 if (s.Length == 0) break;
12949 scanner.Includes.Add(s);
12950 }
12951 while(true) {
12952 Console.Write("Exclude pattern : ");
12953 s = Console.ReadLine();
12954 if (s.Length == 0) break;
12955 scanner.Excludes.Add(s);
12956 }
12957 foreach (string name in scanner.FileNames)
12958 Console.WriteLine("file:" + name);
12959 foreach (string name in scanner.DirectoryNames)
12960 Console.WriteLine("dir :" + name);
12961 Console.WriteLine("");
12962 }
12963 </code>
12964 </example>
12965 </member>
12966 <member name="M:NAnt.Core.DirectoryScanner.#ctor">
12967 <summary>
12968 Initializes a new instance of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
12969 </summary>
12970 <remarks>
12971 On unix, patterns are matching case-sensitively; otherwise, they
12972 are matched case-insensitively.
12973 </remarks>
12974 </member>
12975 <member name="M:NAnt.Core.DirectoryScanner.#ctor(System.Boolean)">
12976 <summary>
12977 Initializes a new instance of the <see cref="T:NAnt.Core.DirectoryScanner"/>
12978 specifying whether patterns are to be match case-sensitively.
12979 </summary>
12980 <param name="caseSensitive">Specifies whether patterns are to be matched case-sensititely.</param>
12981 </member>
12982 <member name="M:NAnt.Core.DirectoryScanner.Clone">
12983 <summary>
12984 Creates a shallow copy of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
12985 </summary>
12986 <returns>
12987 A shallow copy of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
12988 </returns>
12989 </member>
12990 <member name="M:NAnt.Core.DirectoryScanner.Scan">
12991 <summary>
12992 Uses <see cref="P:NAnt.Core.DirectoryScanner.Includes"/> and <see cref="P:NAnt.Core.DirectoryScanner.Excludes"/> search criteria (relative to
12993 <see cref="P:NAnt.Core.DirectoryScanner.BaseDirectory"/> or absolute), to search for filesystem objects.
12994 </summary>
12995 </member>
12996 <member name="M:NAnt.Core.DirectoryScanner.ConvertPatterns(System.Collections.Specialized.StringCollection,System.Collections.ArrayList,System.Collections.Specialized.StringCollection,System.Boolean)">
12997 <summary>
12998 Parses specified NAnt search patterns for search directories and
12999 corresponding regex patterns.
13000 </summary>
13001 <param name="nantPatterns">In. NAnt patterns. Absolute or relative paths.</param>
13002 <param name="regexPatterns">Out. Regex patterns. Absolute canonical paths.</param>
13003 <param name="nonRegexFiles">Out. Non-regex files. Absolute canonical paths.</param>
13004 <param name="addSearchDirectories">In. Whether to allow a pattern to add search directories.</param>
13005 </member>
13006 <member name="M:NAnt.Core.DirectoryScanner.ParseSearchDirectoryAndPattern(System.Boolean,System.String,System.String@,System.Boolean@,System.Boolean@,System.String@)">
13007 <summary>
13008 Given a NAnt search pattern returns a search directory and an regex
13009 search pattern.
13010 </summary>
13011 <param name="isInclude">Whether this pattern is an include or exclude pattern</param>
13012 <param name="originalNAntPattern">NAnt searh pattern (relative to the Basedirectory OR absolute, relative paths refering to parent directories ( ../ ) also supported)</param>
13013 <param name="searchDirectory">Out. Absolute canonical path to the directory to be searched</param>
13014 <param name="recursive">Out. Whether the pattern is potentially recursive or not</param>
13015 <param name="isRegex">Out. Whether this is a regex pattern or not</param>
13016 <param name="regexPattern">Out. Regex search pattern (absolute canonical path)</param>
13017 </member>
13018 <member name="M:NAnt.Core.DirectoryScanner.ScanDirectory(System.String,System.Boolean)">
13019 <summary>
13020 Searches a directory recursively for files and directories matching
13021 the search criteria.
13022 </summary>
13023 <param name="path">Directory in which to search (absolute canonical path)</param>
13024 <param name="recursive">Whether to scan recursively or not</param>
13025 </member>
13026 <member name="M:NAnt.Core.DirectoryScanner.ToRegexPattern(System.String)">
13027 <summary>
13028 Converts search pattern to a regular expression pattern.
13029 </summary>
13030 <param name="nantPattern">Search pattern relative to the search directory.</param>
13031 <returns>Regular expresssion</returns>
13032 </member>
13033 <member name="P:NAnt.Core.DirectoryScanner.CaseSensitive">
13034 <summary>
13035 Gets or set a value indicating whether or not to use case-sensitive
13036 pattern matching.
13037 </summary>
13038 </member>
13039 <member name="P:NAnt.Core.DirectoryScanner.Includes">
13040 <summary>
13041 Gets the collection of include patterns.
13042 </summary>
13043 </member>
13044 <member name="P:NAnt.Core.DirectoryScanner.Excludes">
13045 <summary>
13046 Gets the collection of exclude patterns.
13047 </summary>
13048 </member>
13049 <member name="P:NAnt.Core.DirectoryScanner.BaseDirectory">
13050 <summary>
13051 The base directory to scan. The default is the
13052 <see cref="P:System.Environment.CurrentDirectory">current directory</see>.
13053 </summary>
13054 </member>
13055 <member name="P:NAnt.Core.DirectoryScanner.FileNames">
13056 <summary>
13057 Gets the list of files that match the given patterns.
13058 </summary>
13059 </member>
13060 <member name="P:NAnt.Core.DirectoryScanner.DirectoryNames">
13061 <summary>
13062 Gets the list of directories that match the given patterns.
13063 </summary>
13064 </member>
13065 <member name="P:NAnt.Core.DirectoryScanner.ScannedDirectories">
13066 <summary>
13067 Gets the list of directories that were scanned for files.
13068 </summary>
13069 </member>
13070 <member name="M:NAnt.Core.StringCollectionWithGoodToString.Clone">
13071 <summary>
13072 Creates a shallow copy of the <see cref="T:NAnt.Core.StringCollectionWithGoodToString"/>.
13073 </summary>
13074 <returns>
13075 A shallow copy of the <see cref="T:NAnt.Core.StringCollectionWithGoodToString"/>.
13076 </returns>
13077 </member>
13078 <member name="M:NAnt.Core.StringCollectionWithGoodToString.ToString">
13079 <summary>
13080 Creates a string representing a list of the strings in the collection.
13081 </summary>
13082 <returns>
13083 A string that represents the contents.
13084 </returns>
13085 </member>
13086 <member name="M:NAnt.Core.DirScannerStringCollection.#ctor(System.Boolean)">
13087 <summary>
13088 Initialize a new instance of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
13089 class specifying whether or not string comparison should be
13090 case-sensitive.
13091 </summary>
13092 <param name="caseSensitive">Specifies whether or not string comparison should be case-sensitive.</param>
13093 </member>
13094 <member name="M:NAnt.Core.DirScannerStringCollection.Clone">
13095 <summary>
13096 Creates a shallow copy of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
13097 </summary>
13098 <returns>
13099 A shallow copy of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
13100 </returns>
13101 </member>
13102 <member name="M:NAnt.Core.DirScannerStringCollection.Contains(System.String)">
13103 <summary>
13104 Determines whether the specified string is in the
13105 <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
13106 </summary>
13107 <param name="value">The string to locate in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>. The value can be <see langword="null"/>.</param>
13108 <returns>
13109 <seee langword="true"/> if value is found in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>; otherwise, <see langword="false"/>.
13110 </returns>
13111 <remarks>
13112 String comparisons within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
13113 are only case-sensitive if <see cref="P:NAnt.Core.DirScannerStringCollection.CaseSensitive"/> is
13114 <see langword="true"/>
13115 </remarks>
13116 </member>
13117 <member name="M:NAnt.Core.DirScannerStringCollection.IndexOf(System.String)">
13118 <summary>
13119 Searches for the specified string and returns the zero-based index
13120 of the first occurrence within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
13121 </summary>
13122 <param name="value">The string to locate. The value can be <see langword="null"/>.</param>
13123 <returns>
13124 The zero-based index of the first occurrence of <paramref name="value"/>
13125 in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>, if found; otherwise, -1.
13126 </returns>
13127 <remarks>
13128 String comparisons within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
13129 are only case-sensitive if <see cref="P:NAnt.Core.DirScannerStringCollection.CaseSensitive"/> is
13130 <see langword="true"/>.
13131 </remarks>
13132 </member>
13133 <member name="P:NAnt.Core.DirScannerStringCollection.CaseSensitive">
13134 <summary>
13135 Gets a value indicating whether string comparison is case-sensitive.
13136 </summary>
13137 <value>
13138 A value indicating whether string comparison is case-sensitive.
13139 </value>
13140 </member>
13141 <member name="M:NAnt.Core.ExpressionEvaluator.GetPropertyValue(System.String)">
13142 <summary>
13143 Gets the value of the specified property.
13144 </summary>
13145 <param name="propertyName">The name of the property to get the value of.</param>
13146 <returns>
13147 The value of the specified property.
13148 </returns>
13149 </member>
13150 <member name="T:NAnt.Core.ExpressionTokenizer">
13151 <summary>
13152 Splits an input string into a sequence of tokens used during parsing.
13153 </summary>
13154 </member>
13155 <member name="T:NAnt.Core.ExpressionTokenizer.TokenType">
13156 <summary>
13157 Available tokens
13158 </summary>
13159 </member>
13160 <member name="T:NAnt.Core.FrameworkInfo">
13161 <summary>
13162 Encalsulates information about installed frameworks incuding version
13163 information and directory locations for finding tools.
13164 </summary>
13165 </member>
13166 <member name="M:NAnt.Core.FrameworkInfo.ResolveAssembly(System.String)">
13167 <summary>
13168 Resolves the specified assembly to a full path by matching it
13169 against the reference assemblies.
13170 </summary>
13171 <param name="fileName">The file name of the assembly to resolve (without path information).</param>
13172 <returns>
13173 An absolute path to the assembly, or <see langword="null" /> if the
13174 assembly could not be found or no reference assemblies are configured
13175 for the current framework.
13176 </returns>
13177 <remarks>
13178 Whether the file name is matched case-sensitively depends on the
13179 operating system.
13180 </remarks>
13181 </member>
13182 <member name="M:NAnt.Core.FrameworkInfo.GetToolPath(System.String)">
13183 <summary>
13184 Searches the list of tool paths of the current framework for the
13185 given file, and returns the absolute path if found.
13186 </summary>
13187 <param name="tool">The file name of the tool to search for.</param>
13188 <returns>
13189 The absolute path to <paramref name="tool"/> if found in one of the
13190 configured tool paths; otherwise, <see langword="null"/>.
13191 </returns>
13192 <exception cref="T:System.ArgumentNullException"><paramref name="tool"/> is <see langword="null"/>.</exception>
13193 <remarks>
13194 <para>
13195 The configured tool paths are scanned in the order in which they
13196 are defined in the framework configuration.
13197 </para>
13198 <para>
13199 The file name of the tool to search should include the extension.
13200 </para>
13201 </remarks>
13202 </member>
13203 <member name="M:NAnt.Core.FrameworkInfo.GetXmlAttributeValue(System.Xml.XmlNode,System.String)">
13204 <summary>
13205 Gets the value of the specified attribute from the specified node.
13206 </summary>
13207 <param name="xmlNode">The node of which the attribute value should be retrieved.</param>
13208 <param name="attributeName">The attribute of which the value should be returned.</param>
13209 <returns>
13210 The value of the attribute with the specified name or <see langword="null" />
13211 if the attribute does not exist or has no value.
13212 </returns>
13213 </member>
13214 <member name="P:NAnt.Core.FrameworkInfo.Name">
13215 <summary>
13216 Gets the name of the framework.
13217 </summary>
13218 <value>
13219 The name of the framework.
13220 </value>
13221 </member>
13222 <member name="P:NAnt.Core.FrameworkInfo.Family">
13223 <summary>
13224 Gets the family of the framework.
13225 </summary>
13226 <value>
13227 The family of the framework.
13228 </value>
13229 </member>
13230 <member name="P:NAnt.Core.FrameworkInfo.Description">
13231 <summary>
13232 Gets the description of the framework.
13233 </summary>
13234 <value>
13235 The description of the framework.
13236 </value>
13237 </member>
13238 <member name="P:NAnt.Core.FrameworkInfo.Vendor">
13239 <summary>
13240 Gets the vendor of the framework.
13241 </summary>
13242 <value>
13243 The vendor of the framework.
13244 </value>
13245 </member>
13246 <member name="P:NAnt.Core.FrameworkInfo.Version">
13247 <summary>
13248 Gets the version of the framework.
13249 </summary>
13250 <value>
13251 The version of the framework.
13252 </value>
13253 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13254 <remarks>
13255 When <see cref="P:NAnt.Core.FrameworkInfo.Version"/> is not configured, the framework is not
13256 considered valid.
13257 </remarks>
13258 </member>
13259 <member name="P:NAnt.Core.FrameworkInfo.ClrVersion">
13260 <summary>
13261 Gets the Common Language Runtime version of the framework.
13262 </summary>
13263 <value>
13264 The Common Language Runtime version of the framework.
13265 </value>
13266 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13267 <remarks>
13268 When <see cref="P:NAnt.Core.FrameworkInfo.ClrVersion"/> is <see langword="null"/>, the
13269 framework is not considered valid.
13270 </remarks>
13271 </member>
13272 <member name="P:NAnt.Core.FrameworkInfo.ClrType">
13273 <summary>
13274 Gets the CLR type of the framework.
13275 </summary>
13276 <value>
13277 The CLR type of the framework.
13278 </value>
13279 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13280 </member>
13281 <member name="P:NAnt.Core.FrameworkInfo.VisualStudioVersion">
13282 <summary>
13283 Gets the Visual Studio version that corresponds with this
13284 framework.
13285 </summary>
13286 <value>
13287 The Visual Studio version that corresponds with this framework.
13288 </value>
13289 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13290 <exception cref="T:NAnt.Core.BuildException">There is no version of Visual Studio that corresponds with this framework.</exception>
13291 </member>
13292 <member name="P:NAnt.Core.FrameworkInfo.FrameworkDirectory">
13293 <summary>
13294 Gets the base directory of the framework tools for the framework.
13295 </summary>
13296 <value>
13297 The base directory of the framework tools for the framework.
13298 </value>
13299 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13300 </member>
13301 <member name="P:NAnt.Core.FrameworkInfo.Runtime">
13302 <summary>
13303 Gets the runtime information for this framework.
13304 </summary>
13305 <value>
13306 The runtime information for the framework or <see langword="null"/>
13307 if no runtime information is configured for the framework.
13308 </value>
13309 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13310 </member>
13311 <member name="P:NAnt.Core.FrameworkInfo.FrameworkAssemblyDirectory">
13312 <summary>
13313 Gets the directory where the system assemblies for the framework
13314 are located.
13315 </summary>
13316 <value>
13317 The directory where the system assemblies for the framework are
13318 located.
13319 </value>
13320 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13321 </member>
13322 <member name="P:NAnt.Core.FrameworkInfo.SdkDirectory">
13323 <summary>
13324 Gets the directory containing the SDK tools for the framework.
13325 </summary>
13326 <value>
13327 The directory containing the SDK tools for the framework or a null
13328 reference if the configured sdk directory does not exist, or is not
13329 valid.
13330 </value>
13331 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13332 </member>
13333 <member name="P:NAnt.Core.FrameworkInfo.Project">
13334 <summary>
13335 Gets the <see cref="P:NAnt.Core.FrameworkInfo.Project"/> used to initialize this framework.
13336 </summary>
13337 <value>
13338 The <see cref="P:NAnt.Core.FrameworkInfo.Project"/> used to initialize this framework.
13339 </value>
13340 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13341 </member>
13342 <member name="P:NAnt.Core.FrameworkInfo.TaskAssemblies">
13343 <summary>
13344 Gets the set of assemblies and directories that should scanned for
13345 NAnt tasks, types or functions.
13346 </summary>
13347 <value>
13348 The set of assemblies and directories that should be scanned for
13349 NAnt tasks, types or functions.
13350 </value>
13351 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13352 </member>
13353 <member name="P:NAnt.Core.FrameworkInfo.IsValid">
13354 <summary>
13355 Returns a value indicating whether the current framework is valid.
13356 </summary>
13357 <value>
13358 <see langword="true" /> if the framework is installed and correctly
13359 configured; otherwise, <see langword="false" />.
13360 </value>
13361 </member>
13362 <member name="P:NAnt.Core.FrameworkInfo.ReferenceAssemblies">
13363 <summary>
13364 Gets the reference assemblies for the current framework.
13365 </summary>
13366 <value>
13367 The reference assemblies for the current framework.
13368 </value>
13369 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13370 </member>
13371 <member name="P:NAnt.Core.FrameworkInfo.ToolPaths">
13372 <summary>
13373 Gets the tool paths for the current framework.
13374 </summary>
13375 <value>
13376 The tool paths for the current framework.
13377 </value>
13378 <exception cref="T:System.ArgumentException">The framework is not valid.</exception>
13379 </member>
13380 <member name="P:NAnt.Core.FrameworkInfo.NamespaceManager">
13381 <summary>
13382 Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
13383 </summary>
13384 <value>
13385 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
13386 </value>
13387 <remarks>
13388 The <see cref="P:NAnt.Core.FrameworkInfo.NamespaceManager"/> defines the current namespace
13389 scope and provides methods for looking up namespace information.
13390 </remarks>
13391 </member>
13392 <member name="M:NAnt.Core.FrameworkInfoDictionary.#ctor">
13393 <summary>
13394 Initializes a new instance of the <see cref="T:NAnt.Core.FrameworkInfoDictionary"/> class.
13395 </summary>
13396 </member>
13397 <member name="M:NAnt.Core.FrameworkInfoDictionary.#ctor(System.Int32)">
13398 <summary>
13399 Initializes a new instance of the <see cref="T:NAnt.Core.FrameworkInfoDictionary"/> class
13400 with the specified capacity.
13401 </summary>
13402 </member>
13403 <member name="T:NAnt.Core.FrameworkTypes">
13404 <summary>
13405 Defines the types of frameworks.
13406 </summary>
13407 </member>
13408 <member name="F:NAnt.Core.FrameworkTypes.NotInstalled">
13409 <summary>
13410 Frameworks that are supported on the current platform, but are not
13411 installed.
13412 </summary>
13413 </member>
13414 <member name="F:NAnt.Core.FrameworkTypes.Installed">
13415 <summary>
13416 Frameworks that are installed on the current system.
13417 </summary>
13418 </member>
13419 <member name="F:NAnt.Core.FrameworkTypes.InstallStateMask">
13420 <summary>
13421 Retrieves installation state attributes.
13422 </summary>
13423 </member>
13424 <member name="F:NAnt.Core.FrameworkTypes.Desktop">
13425 <summary>
13426 Frameworks that typically target full desktop devices.
13427 </summary>
13428 </member>
13429 <member name="F:NAnt.Core.FrameworkTypes.Compact">
13430 <summary>
13431 Frameworks that target compact devices.
13432 </summary>
13433 </member>
13434 <member name="F:NAnt.Core.FrameworkTypes.Browser">
13435 <summary>
13436 Frameworks that run in a browser.
13437 </summary>
13438 </member>
13439 <member name="F:NAnt.Core.FrameworkTypes.DeviceMask">
13440 <summary>
13441 Retrieves device attributes.
13442 </summary>
13443 </member>
13444 <member name="F:NAnt.Core.FrameworkTypes.Mono">
13445 <summary>
13446 Frameworks released as part of the open-source <see href="http://www.mono-project.com">Mono</see>
13447 project.
13448 </summary>
13449 </member>
13450 <member name="F:NAnt.Core.FrameworkTypes.MS">
13451 <summary>
13452 Frameworks released by Microsoft.
13453 </summary>
13454 </member>
13455 <member name="F:NAnt.Core.FrameworkTypes.VendorMask">
13456 <summary>
13457 Retrieves vendor attributes.
13458 </summary>
13459 </member>
13460 <member name="F:NAnt.Core.FrameworkTypes.All">
13461 <summary>
13462 All frameworks supported on the current platform, regarless of their
13463 installation state, target device or vendor.
13464 </summary>
13465 </member>
13466 <member name="T:NAnt.Core.Location">
13467 <summary>
13468 Stores the file name, line number and column number to record a position
13469 in a text file.
13470 </summary>
13471 </member>
13472 <member name="M:NAnt.Core.Location.#ctor(System.String,System.Int32,System.Int32)">
13473 <summary>
13474 Creates a location consisting of a file name, line number and
13475 column number.
13476 </summary>
13477 <remarks>
13478 <paramref name="fileName" /> can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt.
13479 </remarks>
13480 </member>
13481 <member name="M:NAnt.Core.Location.#ctor(System.String)">
13482 <summary>
13483 Creates a location consisting of a file name.
13484 </summary>
13485 <remarks>
13486 <paramref name="fileName" /> can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt.
13487 </remarks>
13488 </member>
13489 <member name="M:NAnt.Core.Location.#ctor">
13490 <summary>
13491 Creates an "unknown" location.
13492 </summary>
13493 </member>
13494 <member name="M:NAnt.Core.Location.Init(System.String,System.Int32,System.Int32)">
13495 <summary>Private Init function.</summary>
13496 </member>
13497 <member name="M:NAnt.Core.Location.ToString">
13498 <summary>
13499 Returns the file name, line number and a trailing space. An error
13500 message can be appended easily. For unknown locations, returns
13501 an empty string.
13502 </summary>
13503 </member>
13504 <member name="P:NAnt.Core.Location.FileName">
13505 <summary>
13506 Gets a string containing the file name for the location.
13507 </summary>
13508 <remarks>
13509 The file name includes both the file path and the extension.
13510 </remarks>
13511 </member>
13512 <member name="P:NAnt.Core.Location.LineNumber">
13513 <summary>
13514 Gets the line number for the location.
13515 </summary>
13516 <remarks>
13517 Lines start at 1. Will be zero if not specified.
13518 </remarks>
13519 </member>
13520 <member name="P:NAnt.Core.Location.ColumnNumber">
13521 <summary>
13522 Gets the column number for the location.
13523 </summary>
13524 <remarks>
13525 Columns start a 1. Will be zero if not specified.
13526 </remarks>
13527 </member>
13528 <member name="T:NAnt.Core.LocationMap">
13529 <summary>
13530 Maps XML nodes to the text positions from their original source.
13531 </summary>
13532 </member>
13533 <member name="M:NAnt.Core.LocationMap.#ctor">
13534 <summary>
13535 Initializes a new instance of the <see cref="T:NAnt.Core.LocationMap"/> class.
13536 </summary>
13537 </member>
13538 <member name="M:NAnt.Core.LocationMap.FileIsMapped(System.String)">
13539 <summary>
13540 Determines if a file has been loaded by the current project.
13541 </summary>
13542 <param name="fileOrUri">The file to check.</param>
13543 <returns>
13544 <see langword="true" /> if the specified file has already been loaded
13545 by the current project; otherwise, <see langword="false" />.
13546 </returns>
13547 </member>
13548 <member name="M:NAnt.Core.LocationMap.Add(System.Xml.XmlDocument)">
13549 <summary>
13550 Adds an <see cref="T:System.Xml.XmlDocument"/> to the map.
13551 </summary>
13552 <remarks>
13553 An <see cref="T:System.Xml.XmlDocument"/> can only be added to the map once.
13554 </remarks>
13555 </member>
13556 <member name="M:NAnt.Core.LocationMap.GetLocation(System.Xml.XmlNode)">
13557 <summary>
13558 Returns the <see cref="T:NAnt.Core.Location"/> in the XML file for the given node.
13559 </summary>
13560 <remarks>
13561 The <paramref name="node"/> must be from an <see cref="T:System.Xml.XmlDocument"/>
13562 that has been added to the map.
13563 </remarks>
13564 </member>
13565 <member name="T:NAnt.Core.LocationMap.TextPosition">
13566 <summary>
13567 Represents a position in the build file.
13568 </summary>
13569 </member>
13570 <member name="M:NAnt.Core.LocationMap.TextPosition.#ctor(System.Int32,System.Int32)">
13571 <summary>
13572 Initializes a new instance of the <see cref="T:NAnt.Core.LocationMap.TextPosition"/>
13573 with the speified line and column.
13574 </summary>
13575 <param name="line">The line coordinate of the position.</param>
13576 <param name="column">The column coordinate of the position.</param>
13577 </member>
13578 <member name="F:NAnt.Core.LocationMap.TextPosition.Line">
13579 <summary>
13580 The line coordinate of the position.
13581 </summary>
13582 </member>
13583 <member name="F:NAnt.Core.LocationMap.TextPosition.Column">
13584 <summary>
13585 The column coordinate of the position.
13586 </summary>
13587 </member>
13588 <member name="T:NAnt.Core.Level">
13589 <summary>
13590 Defines the set of levels recognised by the NAnt logging system.
13591 </summary>
13592 </member>
13593 <member name="F:NAnt.Core.Level.Debug">
13594 <summary>
13595 Designates fine-grained informational events that are most useful
13596 to debug a build process.
13597 </summary>
13598 </member>
13599 <member name="F:NAnt.Core.Level.Verbose">
13600 <summary>
13601 Designates events that offer a more detailed view of the build
13602 process.
13603 </summary>
13604 </member>
13605 <member name="F:NAnt.Core.Level.Info">
13606 <summary>
13607 Designates informational events that are useful for getting a
13608 high-level view of the build process.
13609 </summary>
13610 </member>
13611 <member name="F:NAnt.Core.Level.Warning">
13612 <summary>
13613 Designates potentionally harmful events.
13614 </summary>
13615 </member>
13616 <member name="F:NAnt.Core.Level.Error">
13617 <summary>
13618 Designates error events.
13619 </summary>
13620 </member>
13621 <member name="F:NAnt.Core.Level.None">
13622 <summary>
13623 Can be used to suppress all messages.
13624 </summary>
13625 <remarks>
13626 No events should be logged with this <see cref="T:NAnt.Core.Level"/>.
13627 </remarks>
13628 </member>
13629 <member name="T:NAnt.Core.LevelConverter">
13630 <summary>
13631 Specialized <see cref="T:System.ComponentModel.EnumConverter"/> for <see cref="T:NAnt.Core.Level"/>
13632 that ignores case when converting from string.
13633 </summary>
13634 </member>
13635 <member name="M:NAnt.Core.LevelConverter.#ctor">
13636 <summary>
13637 Initializes a new instance of the <see cref="T:NAnt.Core.LevelConverter"/>
13638 class.
13639 </summary>
13640 </member>
13641 <member name="M:NAnt.Core.LevelConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
13642 <summary>
13643 Converts the given object to the type of this converter, using the
13644 specified context and culture information.
13645 </summary>
13646 <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
13647 <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
13648 <param name="value">The <see cref="T:System.Object"/> to convert.</param>
13649 <returns>
13650 An <see cref="T:System.Object"/> that represents the converted value.
13651 </returns>
13652 </member>
13653 <member name="T:NAnt.Core.BuildEventArgs">
13654 <summary>
13655 Class representing an event occurring during a build.
13656 </summary>
13657 <remarks>
13658 <para>
13659 An event is built by specifying either a project, a task or a target.
13660 </para>
13661 <para>
13662 A <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event will only have a <see cref="P:NAnt.Core.BuildEventArgs.Project"/>
13663 reference.
13664 </para>
13665 <para>
13666 A <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level event will have <see cref="P:NAnt.Core.BuildEventArgs.Project"/> and
13667 <see cref="P:NAnt.Core.BuildEventArgs.Target"/> references.
13668 </para>
13669 <para>
13670 A <see cref="P:NAnt.Core.BuildEventArgs.Task"/> level event will have <see cref="P:NAnt.Core.BuildEventArgs.Project"/>,
13671 <see cref="P:NAnt.Core.BuildEventArgs.Target"/> and <see cref="P:NAnt.Core.BuildEventArgs.Task"/> references.
13672 </para>
13673 </remarks>
13674 </member>
13675 <member name="M:NAnt.Core.BuildEventArgs.#ctor">
13676 <summary>
13677 Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
13678 class.
13679 </summary>
13680 </member>
13681 <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Project)">
13682 <summary>
13683 Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
13684 class for a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event.
13685 </summary>
13686 <param name="project">The <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that emitted the event.</param>
13687 </member>
13688 <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Target)">
13689 <summary>
13690 Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
13691 class for a <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level event.
13692 </summary>
13693 <param name="target">The <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that emitted the event.</param>
13694 </member>
13695 <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Task)">
13696 <summary>
13697 Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
13698 class for a <see cref="P:NAnt.Core.BuildEventArgs.Task"/> level event.
13699 </summary>
13700 <param name="task">The <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that emitted the event.</param>
13701 </member>
13702 <member name="P:NAnt.Core.BuildEventArgs.Message">
13703 <summary>
13704 Gets or sets the message associated with this event.
13705 </summary>
13706 <value>
13707 The message associated with this event.
13708 </value>
13709 </member>
13710 <member name="P:NAnt.Core.BuildEventArgs.MessageLevel">
13711 <summary>
13712 Gets or sets the priority level associated with this event.
13713 </summary>
13714 <value>
13715 The priority level associated with this event.
13716 </value>
13717 </member>
13718 <member name="P:NAnt.Core.BuildEventArgs.Exception">
13719 <summary>
13720 Gets or sets the <see cref="P:NAnt.Core.BuildEventArgs.Exception"/> associated with this event.
13721 </summary>
13722 <value>
13723 The <see cref="P:NAnt.Core.BuildEventArgs.Exception"/> associated with this event.
13724 </value>
13725 </member>
13726 <member name="P:NAnt.Core.BuildEventArgs.Project">
13727 <summary>
13728 Gets the <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that fired this event.
13729 </summary>
13730 <value>
13731 The <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that fired this event.
13732 </value>
13733 </member>
13734 <member name="P:NAnt.Core.BuildEventArgs.Target">
13735 <summary>
13736 Gets the <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that fired this event.
13737 </summary>
13738 <value>
13739 The <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that fired this event, or a null reference
13740 if this is a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event.
13741 </value>
13742 </member>
13743 <member name="P:NAnt.Core.BuildEventArgs.Task">
13744 <summary>
13745 Gets the <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that fired this event.
13746 </summary>
13747 <value>
13748 The <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that fired this event, or <see langword="null"/>
13749 if this is a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> or <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level
13750 event.
13751 </value>
13752 </member>
13753 <member name="T:NAnt.Core.BuildEventHandler">
13754 <summary>
13755 Represents the method that handles the build events.
13756 </summary>
13757 <param name="sender">The source of the event.</param>
13758 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
13759 </member>
13760 <member name="T:NAnt.Core.IBuildListener">
13761 <summary>
13762 Instances of classes that implement this interface can register to be
13763 notified when things happen during a build.
13764 </summary>
13765 </member>
13766 <member name="M:NAnt.Core.IBuildListener.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
13767 <summary>
13768 Signals that a build has started.
13769 </summary>
13770 <param name="sender">The source of the event.</param>
13771 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13772 <remarks>
13773 This event is fired before any targets have started.
13774 </remarks>
13775 </member>
13776 <member name="M:NAnt.Core.IBuildListener.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
13777 <summary>
13778 Signals that the last target has finished.
13779 </summary>
13780 <param name="sender">The source of the event.</param>
13781 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13782 <remarks>
13783 This event will still be fired if an error occurred during the build.
13784 </remarks>
13785 </member>
13786 <member name="M:NAnt.Core.IBuildListener.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
13787 <summary>
13788 Signals that a target has started.
13789 </summary>
13790 <param name="sender">The source of the event.</param>
13791 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13792 </member>
13793 <member name="M:NAnt.Core.IBuildListener.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
13794 <summary>
13795 Signals that a target has finished.
13796 </summary>
13797 <param name="sender">The source of the event.</param>
13798 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13799 <remarks>
13800 This event will still be fired if an error occurred during the build.
13801 </remarks>
13802 </member>
13803 <member name="M:NAnt.Core.IBuildListener.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
13804 <summary>
13805 Signals that a task has started.
13806 </summary>
13807 <param name="sender">The source of the event.</param>
13808 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13809 </member>
13810 <member name="M:NAnt.Core.IBuildListener.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
13811 <summary>
13812 Signals that a task has finished.
13813 </summary>
13814 <param name="sender">The source of the event.</param>
13815 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13816 <remarks>
13817 This event will still be fired if an error occurred during the build.
13818 </remarks>
13819 </member>
13820 <member name="M:NAnt.Core.IBuildListener.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
13821 <summary>
13822 Signals that a message has been logged.
13823 </summary>
13824 <param name="sender">The source of the event.</param>
13825 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13826 </member>
13827 <member name="T:NAnt.Core.IBuildLogger">
13828 <summary>
13829 Interface used by NAnt to log the build output.
13830 </summary>
13831 <remarks>
13832 Depending on the supplied command-line arguments, NAnt will set the
13833 <see cref="P:NAnt.Core.IBuildLogger.OutputWriter"/> to <see cref="P:System.Console.Out"/> or a
13834 <see cref="T:System.IO.StreamWriter"/> with a file as backend store.
13835 </remarks>
13836 </member>
13837 <member name="M:NAnt.Core.IBuildLogger.Flush">
13838 <summary>
13839 Flushes buffered build events or messages to the underlying storage.
13840 </summary>
13841 </member>
13842 <member name="P:NAnt.Core.IBuildLogger.Threshold">
13843 <summary>
13844 Gets or sets the highest level of message this logger should respond
13845 to.
13846 </summary>
13847 <value>The highest level of message this logger should respond to.</value>
13848 <remarks>
13849 Only messages with a message level higher than or equal to the given
13850 level should actually be written to the log.
13851 </remarks>
13852 </member>
13853 <member name="P:NAnt.Core.IBuildLogger.EmacsMode">
13854 <summary>
13855 Gets or sets a value indicating whether to produce emacs (and other
13856 editor) friendly output.
13857 </summary>
13858 <value>
13859 <see langword="true" /> if output is to be unadorned so that emacs
13860 and other editors can parse files names, etc.
13861 </value>
13862 </member>
13863 <member name="P:NAnt.Core.IBuildLogger.OutputWriter">
13864 <summary>
13865 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
13866 to send its output.
13867 </summary>
13868 </member>
13869 <member name="M:NAnt.Core.DefaultLogger.#ctor">
13870 <summary>
13871 Initializes a new instance of the <see cref="T:NAnt.Core.DefaultLogger"/>
13872 class.
13873 </summary>
13874 </member>
13875 <member name="M:NAnt.Core.DefaultLogger.Flush">
13876 <summary>
13877 Flushes buffered build events or messages to the underlying storage.
13878 </summary>
13879 </member>
13880 <member name="M:NAnt.Core.DefaultLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
13881 <summary>
13882 Signals that a build has started.
13883 </summary>
13884 <param name="sender">The source of the event.</param>
13885 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13886 <remarks>
13887 This event is fired before any targets have started.
13888 </remarks>
13889 </member>
13890 <member name="M:NAnt.Core.DefaultLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
13891 <summary>
13892 Signals that the last target has finished.
13893 </summary>
13894 <param name="sender">The source of the event.</param>
13895 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13896 <remarks>
13897 This event will still be fired if an error occurred during the build.
13898 </remarks>
13899 </member>
13900 <member name="M:NAnt.Core.DefaultLogger.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
13901 <summary>
13902 Signals that a target has started.
13903 </summary>
13904 <param name="sender">The source of the event.</param>
13905 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13906 </member>
13907 <member name="M:NAnt.Core.DefaultLogger.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
13908 <summary>
13909 Signals that a task has finished.
13910 </summary>
13911 <param name="sender">The source of the event.</param>
13912 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13913 <remarks>
13914 This event will still be fired if an error occurred during the build.
13915 </remarks>
13916 </member>
13917 <member name="M:NAnt.Core.DefaultLogger.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
13918 <summary>
13919 Signals that a task has started.
13920 </summary>
13921 <param name="sender">The source of the event.</param>
13922 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13923 </member>
13924 <member name="M:NAnt.Core.DefaultLogger.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
13925 <summary>
13926 Signals that a task has finished.
13927 </summary>
13928 <param name="sender">The source of the event.</param>
13929 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13930 <remarks>
13931 This event will still be fired if an error occurred during the build.
13932 </remarks>
13933 </member>
13934 <member name="M:NAnt.Core.DefaultLogger.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
13935 <summary>
13936 Signals that a message has been logged.
13937 </summary>
13938 <param name="sender">The source of the event.</param>
13939 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
13940 <remarks>
13941 Only messages with a priority higher or equal to the threshold of
13942 the logger will actually be output in the build log.
13943 </remarks>
13944 </member>
13945 <member name="M:NAnt.Core.DefaultLogger.Log(System.String)">
13946 <summary>
13947 Empty implementation which allows derived classes to receive the
13948 output that is generated in this logger.
13949 </summary>
13950 <param name="message">The message being logged.</param>
13951 </member>
13952 <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.Level,System.String,System.Int32)">
13953 <summary>
13954 Outputs an indented message to the build log if its priority is
13955 greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
13956 logger.
13957 </summary>
13958 <param name="messageLevel">The priority of the message to output.</param>
13959 <param name="message">The message to output.</param>
13960 <param name="indentationLength">The number of characters that the message should be indented.</param>
13961 </member>
13962 <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.BuildEventArgs)">
13963 <summary>
13964 Outputs an indented message to the build log if its priority is
13965 greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
13966 logger.
13967 </summary>
13968 <param name="e">The event to output.</param>
13969 </member>
13970 <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.BuildEventArgs,System.Int32)">
13971 <summary>
13972 Outputs an indented message to the build log if its priority is
13973 greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
13974 logger.
13975 </summary>
13976 <param name="e">The event to output.</param>
13977 <param name="indentationLength">The number of characters that the message should be indented.</param>
13978 </member>
13979 <member name="F:NAnt.Core.DefaultLogger._buildReports">
13980 <summary>
13981 Holds a stack of reports for all running builds.
13982 </summary>
13983 </member>
13984 <member name="P:NAnt.Core.DefaultLogger.Threshold">
13985 <summary>
13986 Gets or sets the highest level of message this logger should respond
13987 to.
13988 </summary>
13989 <value>
13990 The highest level of message this logger should respond to.
13991 </value>
13992 <remarks>
13993 Only messages with a message level higher than or equal to the given
13994 level should be written to the log.
13995 </remarks>
13996 </member>
13997 <member name="P:NAnt.Core.DefaultLogger.EmacsMode">
13998 <summary>
13999 Gets or sets a value indicating whether to produce emacs (and other
14000 editor) friendly output.
14001 </summary>
14002 <value>
14003 <see langword="true" /> if output is to be unadorned so that emacs
14004 and other editors can parse files names, etc. The default is
14005 <see langword="false" />.
14006 </value>
14007 </member>
14008 <member name="P:NAnt.Core.DefaultLogger.OutputWriter">
14009 <summary>
14010 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
14011 to send its output.
14012 </summary>
14013 <value>
14014 The <see cref="T:System.IO.TextWriter"/> to which the logger sends its output.
14015 </value>
14016 </member>
14017 <member name="T:NAnt.Core.BuildReport">
14018 <summary>
14019 Used to store information about a build, to allow better reporting to
14020 the user.
14021 </summary>
14022 </member>
14023 <member name="F:NAnt.Core.BuildReport.Errors">
14024 <summary>
14025 Errors encountered so far.
14026 </summary>
14027 </member>
14028 <member name="F:NAnt.Core.BuildReport.Warnings">
14029 <summary>
14030 Warnings encountered so far.
14031 </summary>
14032 </member>
14033 <member name="F:NAnt.Core.BuildReport.StartTime">
14034 <summary>
14035 The start time of the build process.
14036 </summary>
14037 </member>
14038 <member name="T:NAnt.Core.MailLogger">
14039 <summary>
14040 Buffers log messages from DefaultLogger, and sends an e-mail with the
14041 results.
14042 </summary>
14043 <remarks>
14044 The following properties are used to send the mail :
14045 <list type="table">
14046 <listheader>
14047 <term>Property</term>
14048 <description>Description</description>
14049 </listheader>
14050 <item>
14051 <term>MailLogger.mailhost</term>
14052 <description>Mail server to use. [default: localhost]</description>
14053 </item>
14054 <item>
14055 <term>MailLogger.from</term>
14056 <description>The address of the e-mail sender.</description>
14057 </item>
14058 <item>
14059 <term>MailLogger.failure.notify</term>
14060 <description>Send build failure e-mails ? [default: true]</description>
14061 </item>
14062 <item>
14063 <term>MailLogger.success.notify</term>
14064 <description>Send build success e-mails ? [default: true]</description>
14065 </item>
14066 <item>
14067 <term>MailLogger.failure.to</term>
14068 <description>The address to send build failure messages to.</description>
14069 </item>
14070 <item>
14071 <term>MailLogger.success.to</term>
14072 <description>The address to send build success messages to.</description>
14073 </item>
14074 <item>
14075 <term>MailLogger.failure.subject</term>
14076 <description>The subject of build failure messages. [default: "Build Failure"]</description>
14077 </item>
14078 <item>
14079 <term>MailLogger.success.subject</term>
14080 <description>The subject of build success messages. [default: "Build Success"]</description>
14081 </item>
14082 <item>
14083 <term>MailLogger.success.attachments</term>
14084 <description>The ID of a fileset holdng set of files to attach when the build is successful.</description>
14085 </item>
14086 <item>
14087 <term>MailLogger.failure.attachments</term>
14088 <description>The ID of a fileset holdng set of files to attach when the build fails.</description>
14089 </item>
14090 <item>
14091 <term>MailLogger.body.encoding</term>
14092 <description>The encoding type of the body of the e-mail message. [default: system's ANSI code page]</description>
14093 </item>
14094 <item>
14095 <term>MailLogger.smtp.username</term>
14096 <description>The name of the user to login to the SMTP server.</description>
14097 </item>
14098 <item>
14099 <term>MailLogger.smtp.password</term>
14100 <description>The password of the specified user.</description>
14101 </item>
14102 <item>
14103 <term>MailLogger.smtp.enablessl</term>
14104 <description>Specifies whether to use SSL to encrypt the connection. [default: false]</description>
14105 </item>
14106 <item>
14107 <term>MailLogger.smtp.port</term>
14108 <description>The SMTP server port to connect to. [default: 25]</description>
14109 </item>
14110 </list>
14111 </remarks>
14112 </member>
14113 <member name="M:NAnt.Core.MailLogger.#ctor">
14114 <summary>
14115 Initializes a new instance of the <see cref="T:NAnt.Core.MailLogger"/>
14116 class.
14117 </summary>
14118 </member>
14119 <member name="M:NAnt.Core.MailLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
14120 <summary>
14121 Signals that a build has started.
14122 </summary>
14123 <param name="sender">The source of the event.</param>
14124 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
14125 <remarks>
14126 This event is fired before any targets have started.
14127 </remarks>
14128 </member>
14129 <member name="M:NAnt.Core.MailLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
14130 <summary>
14131 Signals that the last target has finished, and send an e-mail with
14132 the build results.
14133 </summary>
14134 <param name="sender">The source of the event.</param>
14135 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
14136 </member>
14137 <member name="M:NAnt.Core.MailLogger.Log(System.String)">
14138 <summary>
14139 Receives and buffers log messages.
14140 </summary>
14141 <param name="message">The message being logged.</param>
14142 </member>
14143 <member name="M:NAnt.Core.MailLogger.GetPropertyValue(NAnt.Core.PropertyDictionary,System.String,System.String,System.Boolean)">
14144 <summary>
14145 Gets the value of the specified property.
14146 </summary>
14147 <param name="properties">Properties to obtain value from.</param>
14148 <param name="name">Suffix of property name. "MailLogger" will be prepended internally.</param>
14149 <param name="defaultValue">Value returned if property is not present in <paramref name="properties"/>.</param>
14150 <param name="required">Value indicating whether the property should exist, or have a default value set.</param>
14151 <returns>
14152 The value of the specified property; or the default value if the
14153 property is not present in <paramref name="properties"/>.
14154 </returns>
14155 <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>
14156 </member>
14157 <member name="F:NAnt.Core.MailLogger._buffer">
14158 <summary>
14159 Buffer in which the message is constructed prior to sending.
14160 </summary>
14161 </member>
14162 <member name="F:NAnt.Core.MailLogger._projectStack">
14163 <summary>
14164 Holds the stack of currently executing projects.
14165 </summary>
14166 </member>
14167 <member name="T:NAnt.Core.BuildListenerCollection">
14168 <summary>
14169 Contains a strongly typed collection of <see cref="T:NAnt.Core.IBuildListener"/>
14170 objects.
14171 </summary>
14172 </member>
14173 <member name="M:NAnt.Core.BuildListenerCollection.#ctor">
14174 <summary>
14175 Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
14176 class.
14177 </summary>
14178 </member>
14179 <member name="M:NAnt.Core.BuildListenerCollection.#ctor(NAnt.Core.BuildListenerCollection)">
14180 <summary>
14181 Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
14182 class with the specified <see cref="T:NAnt.Core.BuildListenerCollection"/> instance.
14183 </summary>
14184 </member>
14185 <member name="M:NAnt.Core.BuildListenerCollection.#ctor(NAnt.Core.IBuildListener[])">
14186 <summary>
14187 Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
14188 class with the specified array of <see cref="T:NAnt.Core.IBuildListener"/> instances.
14189 </summary>
14190 </member>
14191 <member name="M:NAnt.Core.BuildListenerCollection.Add(NAnt.Core.IBuildListener)">
14192 <summary>
14193 Adds a <see cref="T:NAnt.Core.IBuildListener"/> to the end of the collection.
14194 </summary>
14195 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to be added to the end of the collection.</param>
14196 <returns>The position into which the new element was inserted.</returns>
14197 </member>
14198 <member name="M:NAnt.Core.BuildListenerCollection.AddRange(NAnt.Core.IBuildListener[])">
14199 <summary>
14200 Adds the elements of a <see cref="T:NAnt.Core.IBuildListener"/> array to the end of the collection.
14201 </summary>
14202 <param name="items">The array of <see cref="T:NAnt.Core.IBuildListener"/> elements to be added to the end of the collection.</param>
14203 </member>
14204 <member name="M:NAnt.Core.BuildListenerCollection.AddRange(NAnt.Core.BuildListenerCollection)">
14205 <summary>
14206 Adds the elements of a <see cref="T:NAnt.Core.BuildListenerCollection"/> to the end of the collection.
14207 </summary>
14208 <param name="items">The <see cref="T:NAnt.Core.BuildListenerCollection"/> to be added to the end of the collection.</param>
14209 </member>
14210 <member name="M:NAnt.Core.BuildListenerCollection.Contains(NAnt.Core.IBuildListener)">
14211 <summary>
14212 Determines whether a <see cref="T:NAnt.Core.IBuildListener"/> is in the collection.
14213 </summary>
14214 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to locate in the collection.</param>
14215 <returns>
14216 <see langword="true"/> if <paramref name="item"/> is found in the
14217 collection; otherwise, <see langword="false"/>.
14218 </returns>
14219 </member>
14220 <member name="M:NAnt.Core.BuildListenerCollection.CopyTo(NAnt.Core.IBuildListener[],System.Int32)">
14221 <summary>
14222 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
14223 </summary>
14224 <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>
14225 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
14226 </member>
14227 <member name="M:NAnt.Core.BuildListenerCollection.IndexOf(NAnt.Core.IBuildListener)">
14228 <summary>
14229 Retrieves the index of a specified <see cref="T:NAnt.Core.IBuildListener"/> object in the collection.
14230 </summary>
14231 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> object for which the index is returned.</param>
14232 <returns>
14233 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.
14234 </returns>
14235 </member>
14236 <member name="M:NAnt.Core.BuildListenerCollection.Insert(System.Int32,NAnt.Core.IBuildListener)">
14237 <summary>
14238 Inserts a <see cref="T:NAnt.Core.IBuildListener"/> into the collection at the specified index.
14239 </summary>
14240 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
14241 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to insert.</param>
14242 </member>
14243 <member name="M:NAnt.Core.BuildListenerCollection.GetEnumerator">
14244 <summary>
14245 Returns an enumerator that can iterate through the collection.
14246 </summary>
14247 <returns>
14248 A <see cref="T:NAnt.Core.BuildListenerEnumerator"/> for the entire collection.
14249 </returns>
14250 </member>
14251 <member name="M:NAnt.Core.BuildListenerCollection.Remove(NAnt.Core.IBuildListener)">
14252 <summary>
14253 Removes a member from the collection.
14254 </summary>
14255 <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to remove from the collection.</param>
14256 </member>
14257 <member name="P:NAnt.Core.BuildListenerCollection.Item(System.Int32)">
14258 <summary>
14259 Gets or sets the element at the specified index.
14260 </summary>
14261 <param name="index">The zero-based index of the element to get or set.</param>
14262 </member>
14263 <member name="T:NAnt.Core.BuildListenerEnumerator">
14264 <summary>
14265 Enumerates the <see cref="T:NAnt.Core.IBuildListener"/> elements of a <see cref="T:NAnt.Core.BuildListenerCollection"/>.
14266 </summary>
14267 </member>
14268 <member name="M:NAnt.Core.BuildListenerEnumerator.#ctor(NAnt.Core.BuildListenerCollection)">
14269 <summary>
14270 Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerEnumerator"/> class
14271 with the specified <see cref="T:NAnt.Core.BuildListenerCollection"/>.
14272 </summary>
14273 <param name="arguments">The collection that should be enumerated.</param>
14274 </member>
14275 <member name="M:NAnt.Core.BuildListenerEnumerator.MoveNext">
14276 <summary>
14277 Advances the enumerator to the next element of the collection.
14278 </summary>
14279 <returns>
14280 <see langword="true" /> if the enumerator was successfully advanced
14281 to the next element; <see langword="false" /> if the enumerator has
14282 passed the end of the collection.
14283 </returns>
14284 </member>
14285 <member name="M:NAnt.Core.BuildListenerEnumerator.Reset">
14286 <summary>
14287 Sets the enumerator to its initial position, which is before the
14288 first element in the collection.
14289 </summary>
14290 </member>
14291 <member name="P:NAnt.Core.BuildListenerEnumerator.Current">
14292 <summary>
14293 Gets the current element in the collection.
14294 </summary>
14295 <returns>
14296 The current element in the collection.
14297 </returns>
14298 </member>
14299 <member name="T:NAnt.Core.LogWriter">
14300 <summary>
14301 Implements a <see cref="T:System.IO.TextWriter"/> for writing information to
14302 the NAnt logging infrastructure.
14303 </summary>
14304 </member>
14305 <member name="M:NAnt.Core.LogWriter.#ctor(NAnt.Core.Task,NAnt.Core.Level,System.IFormatProvider)">
14306 <summary>
14307 Initializes a new instance of the <see cref="T:NAnt.Core.LogWriter"/> class
14308 for the specified <see cref="T:NAnt.Core.Task"/> with the specified output
14309 level and format provider.
14310 </summary>
14311 <param name="task">Determines the indentation level.</param>
14312 <param name="outputLevel">The <see cref="T:NAnt.Core.Level"/> with which messages will be output to the build log.</param>
14313 <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> object that controls formatting.</param>
14314 </member>
14315 <member name="M:NAnt.Core.LogWriter.Write(System.Char[])">
14316 <summary>
14317 Writes a character array to the buffer.
14318 </summary>
14319 <param name="chars">The character array to write to the text stream.</param>
14320 </member>
14321 <member name="M:NAnt.Core.LogWriter.Write(System.String)">
14322 <summary>
14323 Writes a string to the buffer.
14324 </summary>
14325 <param name="value"></param>
14326 </member>
14327 <member name="M:NAnt.Core.LogWriter.WriteLine">
14328 <summary>
14329 Writes an empty string to the logging infrastructure.
14330 </summary>
14331 </member>
14332 <member name="M:NAnt.Core.LogWriter.WriteLine(System.String)">
14333 <summary>
14334 Writes a string to the logging infrastructure.
14335 </summary>
14336 <param name="value">The string to write. If <paramref name="value" /> is a null reference, only the line termination characters are written.</param>
14337 </member>
14338 <member name="M:NAnt.Core.LogWriter.WriteLine(System.String,System.Object[])">
14339 <summary>
14340 Writes out a formatted string using the same semantics as
14341 <see cref="M:System.String.Format(System.String,System.Object[])"/>.
14342 </summary>
14343 <param name="line">The formatting string.</param>
14344 <param name="args">The object array to write into format string.</param>
14345 </member>
14346 <member name="M:NAnt.Core.LogWriter.Flush">
14347 <summary>
14348 Causes any buffered data to be written to the logging infrastructure.
14349 </summary>
14350 </member>
14351 <member name="M:NAnt.Core.LogWriter.Close">
14352 <summary>
14353 Closes the current writer and releases any system resources
14354 associated with the writer.
14355 </summary>
14356 </member>
14357 <member name="M:NAnt.Core.LogWriter.InitializeLifetimeService">
14358 <summary>
14359 Obtains a lifetime service object to control the lifetime policy for
14360 this instance.
14361 </summary>
14362 <returns>
14363 An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
14364 policy for this instance. This is the current lifetime service object
14365 for this instance if one exists; otherwise, a new lifetime service
14366 object initialized with a lease that will never time out.
14367 </returns>
14368 </member>
14369 <member name="P:NAnt.Core.LogWriter.Encoding">
14370 <summary>
14371 Gets the <see cref="P:NAnt.Core.LogWriter.Encoding"/> in which the output is written.
14372 </summary>
14373 <value>
14374 The <see cref="T:NAnt.Core.LogWriter"/> always writes output in UTF8
14375 encoding.
14376 </value>
14377 </member>
14378 <member name="P:NAnt.Core.LogWriter.OutputLevel">
14379 <summary>
14380 Gets the <see cref="T:NAnt.Core.Level"/> with which messages will be output to
14381 the build log.
14382 </summary>
14383 </member>
14384 <member name="T:NAnt.Core.PathScanner">
14385 <summary>
14386 Used to search for files on the PATH.
14387 </summary>
14388 <remarks>
14389 <para>
14390 The local directory is not searched (since this would already be covered
14391 by normal use of the includes element).
14392 </para>
14393 <para>
14394 Also, advanced pattern matching isn't supported: you need to know the
14395 exact name of the file.
14396 </para>
14397 </remarks>
14398 </member>
14399 <member name="M:NAnt.Core.PathScanner.System#ICloneable#Clone">
14400 <summary>
14401 Creates a shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
14402 </summary>
14403 <returns>
14404 A shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
14405 </returns>
14406 </member>
14407 <member name="M:NAnt.Core.PathScanner.Clone">
14408 <summary>
14409 Creates a shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
14410 </summary>
14411 <returns>
14412 A shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
14413 </returns>
14414 </member>
14415 <member name="M:NAnt.Core.PathScanner.Add(System.String)">
14416 <summary>
14417 Adds a file to the list of files to be scanned for.
14418 </summary>
14419 <param name="fileName">The filename or search pattern to add to the list.</param>
14420 </member>
14421 <member name="M:NAnt.Core.PathScanner.Scan">
14422 <summary>
14423 Scans all direcetories in the PATH environment variable for files.
14424 </summary>
14425 <returns>
14426 List of matching files found in the PATH.
14427 </returns>
14428 </member>
14429 <member name="M:NAnt.Core.PathScanner.Scan(System.String)">
14430 <summary>
14431 Scans all directories in the given environment variable for files.
14432 </summary>
14433 <param name="name">The environment variable of which the directories should be scanned.</param>
14434 <returns>
14435 List of matching files found in the directory of the given
14436 environment variable.
14437 </returns>
14438 </member>
14439 <member name="M:NAnt.Core.PathScanner.Clone(System.Collections.Specialized.StringCollection)">
14440 <summary>
14441 Creates a shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
14442 </summary>
14443 <param name="stringCollection">The <see cref="T:System.Collections.Specialized.StringCollection"/> that should be copied.</param>
14444 <returns>
14445 A shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
14446 </returns>
14447 </member>
14448 <member name="P:NAnt.Core.PlatformHelper.Is64Bit">
14449 <summary>
14450 Returns a value indicating whether NAnt is running in 64-bit mode.
14451 </summary>
14452 <value>
14453 <see langword="true" /> if NAnt is running in 64-bit mode; otherwise,
14454 <see langword="false" />.
14455 </value>
14456 </member>
14457 <member name="P:NAnt.Core.PlatformHelper.Is32Bit">
14458 <summary>
14459 Returns a value indicating whether NAnt is running in 32-bit mode.
14460 </summary>
14461 <remarks>
14462 Note that even if the platform is 64-bit, NAnt may be running in
14463 32-bit mode.
14464 </remarks>
14465 <value>
14466 <see langword="true" /> if NAnt is running in 32-bit mode; otherwise,
14467 <see langword="false" />.
14468 </value>
14469 </member>
14470 <member name="P:NAnt.Core.PlatformHelper.IsWindows">
14471 <summary>
14472 Returns a value indicating whether NAnt is running on Windows.
14473 </summary>
14474 <value>
14475 <see langword="true" /> if NAnt is running on Windows;
14476 otherwise, <see langword="false" />.
14477 </value>
14478 </member>
14479 <member name="T:NAnt.Core.Project">
14480 <summary>
14481 Central representation of a NAnt project.
14482 </summary>
14483 <example>
14484 <para>
14485 The <see cref="M:NAnt.Core.Project.Run"/> method will initialize the project with the build
14486 file specified in the constructor and execute the default target.
14487 </para>
14488 <code>
14489 <![CDATA[
14490 Project p = new Project("foo.build", Level.Info);
14491 p.Run();
14492 ]]>
14493 </code>
14494 </example>
14495 <example>
14496 <para>
14497 If no target is given, the default target will be executed if specified
14498 in the project.
14499 </para>
14500 <code>
14501 <![CDATA[
14502 Project p = new Project("foo.build", Level.Info);
14503 p.Execute("build");
14504 ]]>
14505 </code>
14506 </example>
14507 </member>
14508 <member name="F:NAnt.Core.Project.Visiting">
14509 <summary>
14510 Constant for the "visiting" state, used when traversing a DFS of
14511 target dependencies.
14512 </summary>
14513 </member>
14514 <member name="F:NAnt.Core.Project.Visited">
14515 <summary>
14516 Constant for the "visited" state, used when traversing a DFS of
14517 target dependencies.
14518 </summary>
14519 </member>
14520 <member name="F:NAnt.Core.Project.logger">
14521 <summary>
14522 Holds the logger for this class.
14523 </summary>
14524 </member>
14525 <member name="F:NAnt.Core.Project._threshold">
14526 <summary>
14527 Holds the default threshold for build loggers.
14528 </summary>
14529 </member>
14530 <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32)">
14531 <summary>
14532 Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
14533 document, message threshold and indentation level.
14534 </summary>
14535 <param name="doc">Any valid build format will do.</param>
14536 <param name="threshold">The message threshold.</param>
14537 <param name="indentLevel">The project indentation level.</param>
14538 </member>
14539 <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32,System.Xml.XmlNode)">
14540 <summary>
14541 Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
14542 document, message threshold and indentation level, and using
14543 the specified <see cref="T:System.Xml.XmlNode"/> to load internal configuration
14544 settings.
14545 </summary>
14546 <param name="doc">Any valid build format will do.</param>
14547 <param name="threshold">The message threshold.</param>
14548 <param name="indentLevel">The project indentation level.</param>
14549 <param name="configurationNode">The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize configuration settings.</param>
14550 <remarks>
14551 This constructor is useful for developers using NAnt as a class
14552 library.
14553 </remarks>
14554 </member>
14555 <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Level,System.Int32)">
14556 <summary>
14557 Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
14558 source, message threshold and indentation level.
14559 </summary>
14560 <param name="uriOrFilePath">
14561 <para>The full path to the build file.</para>
14562 <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
14563 </param>
14564 <param name="threshold">The message threshold.</param>
14565 <param name="indentLevel">The project indentation level.</param>
14566 <remarks>
14567 If the source is a uri of form 'file:///path' then use the path part.
14568 </remarks>
14569 </member>
14570 <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Level,System.Int32,System.Xml.XmlNode)">
14571 <summary>
14572 Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
14573 source, message threshold and indentation level, and using
14574 the specified <see cref="T:System.Xml.XmlNode"/> to load internal configuration
14575 settings.
14576 </summary>
14577 <param name="uriOrFilePath">
14578 <para>The full path to the build file.</para>
14579 <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
14580 </param>
14581 <param name="threshold">The message threshold.</param>
14582 <param name="indentLevel">The project indentation level.</param>
14583 <param name="configurationNode">The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize configuration settings.</param>
14584 <exception cref="T:System.ArgumentNullException"><paramref name="configurationNode"/> is <see langword="null"/>.</exception>
14585 <remarks>
14586 If the source is a uri of form 'file:///path' then use the path part.
14587 </remarks>
14588 </member>
14589 <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Project)">
14590 <summary>
14591 Initializes a <see cref="T:NAnt.Core.Project"/> as subproject of the specified
14592 <see cref="T:NAnt.Core.Project"/>.
14593 </summary>
14594 <param name="uriOrFilePath">
14595 <para>The full path to the build file.</para>
14596 <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
14597 </param>
14598 <param name="parent">The parent <see cref="T:NAnt.Core.Project"/>.</param>
14599 <remarks>
14600 Optimized for framework initialization projects, by skipping automatic
14601 discovery of extension assemblies and framework configuration.
14602 </remarks>
14603 </member>
14604 <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument)">
14605 <summary>
14606 Initializes a <see cref="T:NAnt.Core.Project"/> with <see cref="P:NAnt.Core.Project.Threshold"/>
14607 set to <see cref="F:NAnt.Core.Level.None"/>, and <see cref="P:NAnt.Core.Project.IndentationLevel"/>
14608 set to 0.
14609 </summary>
14610 <param name="doc">An <see cref="T:System.Xml.XmlDocument"/> containing the build script.</param>
14611 <remarks>
14612 Optimized for framework initialization projects, by skipping automatic
14613 discovery of extension assemblies and framework configuration.
14614 </remarks>
14615 </member>
14616 <member name="M:NAnt.Core.Project.GetFrameworks(NAnt.Core.FrameworkTypes)">
14617 <summary>
14618 Gets the list of supported frameworks filtered by the specified
14619 <see cref="T:NAnt.Core.FrameworkTypes"/> parameter.
14620 </summary>
14621 <param name="types">A bitwise combination of <see cref="T:NAnt.Core.FrameworkTypes"/> values that filter the frameworks to retrieve.</param>
14622 <returns>
14623 An array of type <see cref="T:NAnt.Core.FrameworkInfo"/> that contains the
14624 frameworks specified by the <paramref name="types"/> parameter,
14625 sorted on name.
14626 </returns>
14627 </member>
14628 <member name="M:NAnt.Core.Project.GetLocation(System.Xml.XmlNode)">
14629 <summary>
14630 Returns the <see cref="T:NAnt.Core.Location"/> of the given node in an XML
14631 file loaded by NAnt.
14632 </summary>
14633 <remarks>
14634 <para>
14635 The <paramref name="node"/> must be from an <see cref="T:System.Xml.XmlDocument"/>
14636 that has been loaded by NAnt.
14637 </para>
14638 <para>
14639 NAnt also does not process any of the following node types:
14640 </para>
14641 <list type="bullet">
14642 <item>
14643 <description><see cref="F:System.Xml.XmlNodeType.Whitespace"/></description>
14644 </item>
14645 <item>
14646 <description><see cref="F:System.Xml.XmlNodeType.EndElement"/></description>
14647 </item>
14648 <item>
14649 <description><see cref="F:System.Xml.XmlNodeType.ProcessingInstruction"/></description>
14650 </item>
14651 <item>
14652 <description><see cref="F:System.Xml.XmlNodeType.XmlDeclaration"/></description>
14653 </item>
14654 <item>
14655 <description><see cref="F:System.Xml.XmlNodeType.DocumentType"/></description>
14656 </item>
14657 </list>
14658 <para>
14659 As a result, no location information is available for these nodes.
14660 </para>
14661 </remarks>
14662 <param name="node">The <see cref="T:System.Xml.XmlNode"/> to get the <see cref="T:NAnt.Core.Location"/> for.</param>
14663 <returns>
14664 <see cref="T:NAnt.Core.Location"/> of the given node in an XML file loaded by NAnt, or
14665 <see cref="F:NAnt.Core.Location.UnknownLocation"/> if the node was not loaded from
14666 an XML file.
14667 </returns>
14668 <exception cref="T:System.ArgumentException">
14669 <para><paramref name="node"/> is from an XML file that was not loaded by NAnt.</para>
14670 <para>-or</para>
14671 <para><paramref name="node"/> was not processed by NAnt (eg. an XML declaration).</para>
14672 </exception>
14673 </member>
14674 <member name="M:NAnt.Core.Project.OnBuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
14675 <summary>
14676 Dispatches a <see cref="F:NAnt.Core.Project.BuildStarted"/> event to the build listeners
14677 for this <see cref="T:NAnt.Core.Project"/>.
14678 </summary>
14679 <param name="sender">The source of the event.</param>
14680 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14681 </member>
14682 <member name="M:NAnt.Core.Project.OnBuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
14683 <summary>
14684 Dispatches a <see cref="F:NAnt.Core.Project.BuildFinished"/> event to the build listeners
14685 for this <see cref="T:NAnt.Core.Project"/>.
14686 </summary>
14687 <param name="sender">The source of the event.</param>
14688 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14689 </member>
14690 <member name="M:NAnt.Core.Project.OnTargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
14691 <summary>
14692 Dispatches a <see cref="F:NAnt.Core.Project.TargetStarted"/> event to the build listeners
14693 for this <see cref="T:NAnt.Core.Project"/>.
14694 </summary>
14695 <param name="sender">The source of the event.</param>
14696 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14697 </member>
14698 <member name="M:NAnt.Core.Project.OnTargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
14699 <summary>
14700 Dispatches a <see cref="F:NAnt.Core.Project.TargetFinished"/> event to the build listeners
14701 for this <see cref="T:NAnt.Core.Project"/>.
14702 </summary>
14703 <param name="sender">The source of the event.</param>
14704 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14705 </member>
14706 <member name="M:NAnt.Core.Project.OnTaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
14707 <summary>
14708 Dispatches a <see cref="F:NAnt.Core.Project.TaskStarted"/> event to the build listeners
14709 for this <see cref="T:NAnt.Core.Project"/>.
14710 </summary>
14711 <param name="sender">The source of the event.</param>
14712 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14713 </member>
14714 <member name="M:NAnt.Core.Project.OnTaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
14715 <summary>
14716 Dispatches the <see cref="F:NAnt.Core.Project.TaskFinished"/> event to the build listeners
14717 for this <see cref="T:NAnt.Core.Project"/>.
14718 </summary>
14719 <param name="sender">The source of the event.</param>
14720 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14721 </member>
14722 <member name="M:NAnt.Core.Project.OnMessageLogged(NAnt.Core.BuildEventArgs)">
14723 <summary>
14724 Dispatches a <see cref="F:NAnt.Core.Project.MessageLogged"/> event to the build listeners
14725 for this <see cref="T:NAnt.Core.Project"/>.
14726 </summary>
14727 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
14728 </member>
14729 <member name="M:NAnt.Core.Project.Log(NAnt.Core.Level,System.String)">
14730 <summary>
14731 Writes a <see cref="T:NAnt.Core.Project"/> level message to the build log with
14732 the given <see cref="T:NAnt.Core.Level"/>.
14733 </summary>
14734 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
14735 <param name="message">The message to log.</param>
14736 </member>
14737 <member name="M:NAnt.Core.Project.Log(NAnt.Core.Level,System.String,System.Object[])">
14738 <summary>
14739 Writes a <see cref="T:NAnt.Core.Project"/> level formatted message to the build
14740 log with the given <see cref="T:NAnt.Core.Level"/>.
14741 </summary>
14742 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
14743 <param name="message">The message to log, containing zero or more format items.</param>
14744 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
14745 </member>
14746 <member name="M:NAnt.Core.Project.Log(NAnt.Core.Task,NAnt.Core.Level,System.String)">
14747 <summary>
14748 Writes a <see cref="T:NAnt.Core.Task"/> task level message to the build log
14749 with the given <see cref="T:NAnt.Core.Level"/>.
14750 </summary>
14751 <param name="task">The <see cref="T:NAnt.Core.Task"/> from which the message originated.</param>
14752 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
14753 <param name="message">The message to log.</param>
14754 </member>
14755 <member name="M:NAnt.Core.Project.Log(NAnt.Core.Target,NAnt.Core.Level,System.String)">
14756 <summary>
14757 Writes a <see cref="T:NAnt.Core.Target"/> level message to the build log with
14758 the given <see cref="T:NAnt.Core.Level"/>.
14759 </summary>
14760 <param name="target">The <see cref="T:NAnt.Core.Target"/> from which the message orignated.</param>
14761 <param name="messageLevel">The level to log at.</param>
14762 <param name="message">The message to log.</param>
14763 </member>
14764 <member name="M:NAnt.Core.Project.Execute">
14765 <summary>
14766 Executes the default target.
14767 </summary>
14768 <remarks>
14769 No top level error handling is done. Any <see cref="T:NAnt.Core.BuildException"/>
14770 will be passed onto the caller.
14771 </remarks>
14772 </member>
14773 <member name="M:NAnt.Core.Project.Execute(System.String)">
14774 <summary>
14775 Executes a specific target, and its dependencies.
14776 </summary>
14777 <param name="targetName">The name of the target to execute.</param>
14778 <remarks>
14779 Global tasks are not executed.
14780 </remarks>
14781 </member>
14782 <member name="M:NAnt.Core.Project.Execute(System.String,System.Boolean)">
14783 <summary>
14784 Executes a specific target.
14785 </summary>
14786 <param name="targetName">The name of the target to execute.</param>
14787 <param name="forceDependencies">Whether dependencies should be forced to execute</param>
14788 <remarks>
14789 Global tasks are not executed.
14790 </remarks>
14791 </member>
14792 <member name="M:NAnt.Core.Project.Run">
14793 <summary>
14794 Executes the default target and wraps in error handling and time
14795 stamping.
14796 </summary>
14797 <returns>
14798 <see langword="true" /> if the build was successful; otherwise,
14799 <see langword="false" />.
14800 </returns>
14801 </member>
14802 <member name="M:NAnt.Core.Project.CreateTask(System.Xml.XmlNode)">
14803 <summary>
14804 Creates a new <see ref="Task"/> from the given <see cref="T:System.Xml.XmlNode"/>.
14805 </summary>
14806 <param name="taskNode">The <see cref="T:NAnt.Core.Task"/> definition.</param>
14807 <returns>The new <see cref="T:NAnt.Core.Task"/> instance.</returns>
14808 </member>
14809 <member name="M:NAnt.Core.Project.CreateTask(System.Xml.XmlNode,NAnt.Core.Target)">
14810 <summary>
14811 Creates a new <see cref="T:NAnt.Core.Task"/> from the given <see cref="T:System.Xml.XmlNode"/>
14812 within a <see cref="T:NAnt.Core.Target"/>.
14813 </summary>
14814 <param name="taskNode">The <see cref="T:NAnt.Core.Task"/> definition.</param>
14815 <param name="target">The owner <see cref="T:NAnt.Core.Target"/>.</param>
14816 <returns>The new <see cref="T:NAnt.Core.Task"/> instance.</returns>
14817 </member>
14818 <member name="M:NAnt.Core.Project.ExpandProperties(System.String,NAnt.Core.Location)">
14819 <summary>
14820 Expands a <see cref="T:System.String"/> from known properties.
14821 </summary>
14822 <param name="input">The <see cref="T:System.String"/> with replacement tokens.</param>
14823 <param name="location">The location in the build file. Used to throw more accurate exceptions.</param>
14824 <returns>The expanded and replaced <see cref="T:System.String"/>.</returns>
14825 </member>
14826 <member name="M:NAnt.Core.Project.GetFullPath(System.String)">
14827 <summary>
14828 Combines the specified path with the <see cref="P:NAnt.Core.Project.BaseDirectory"/> of
14829 the <see cref="T:NAnt.Core.Project"/> to form a full path to file or directory.
14830 </summary>
14831 <param name="path">The relative or absolute path.</param>
14832 <returns>
14833 A rooted path, or the <see cref="P:NAnt.Core.Project.BaseDirectory"/> of the <see cref="T:NAnt.Core.Project"/>
14834 if the <paramref name="path"/> parameter is a null reference.
14835 </returns>
14836 </member>
14837 <member name="M:NAnt.Core.Project.CreateDefaultLogger">
14838 <summary>
14839 Creates the default <see cref="T:NAnt.Core.IBuildLogger"/> and attaches it to
14840 the <see cref="T:NAnt.Core.Project"/>.
14841 </summary>
14842 </member>
14843 <member name="M:NAnt.Core.Project.Indent">
14844 <summary>
14845 Increases the <see cref="P:NAnt.Core.Project.IndentationLevel"/> of the <see cref="T:NAnt.Core.Project"/>.
14846 </summary>
14847 </member>
14848 <member name="M:NAnt.Core.Project.Unindent">
14849 <summary>
14850 Decreases the <see cref="P:NAnt.Core.Project.IndentationLevel"/> of the <see cref="T:NAnt.Core.Project"/>.
14851 </summary>
14852 </member>
14853 <member name="M:NAnt.Core.Project.DetachBuildListeners">
14854 <summary>
14855 Detaches the currently attached <see cref="T:NAnt.Core.IBuildListener"/> instances
14856 from the <see cref="T:NAnt.Core.Project"/>.
14857 </summary>
14858 </member>
14859 <member name="M:NAnt.Core.Project.AttachBuildListeners(NAnt.Core.BuildListenerCollection)">
14860 <summary>
14861 Attaches the specified build listeners to the <see cref="T:NAnt.Core.Project"/>.
14862 </summary>
14863 <param name="listeners">The <see cref="T:NAnt.Core.IBuildListener"/> instances to attach to the <see cref="T:NAnt.Core.Project"/>.</param>
14864 <remarks>
14865 The currently attached <see cref="T:NAnt.Core.IBuildListener"/> instances will
14866 be detached before the new <see cref="T:NAnt.Core.IBuildListener"/> instances
14867 are attached.
14868 </remarks>
14869 </member>
14870 <member name="M:NAnt.Core.Project.CtorHelper(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32,NAnt.Core.Optimizations)">
14871 <summary>
14872 Inits stuff:
14873 <para>TypeFactory: Calls Initialize and AddProject </para>
14874 <para>Log.IndentSize set to 12</para>
14875 <para>Project properties are initialized ("nant.* stuff set")</para>
14876 <list type="nant.items">
14877 <listheader>NAnt Props:</listheader>
14878 <item>nant.filename</item>
14879 <item>nant.version</item>
14880 <item>nant.location</item>
14881 <item>nant.project.name</item>
14882 <item>nant.project.buildfile (if doc has baseuri)</item>
14883 <item>nant.project.basedir</item>
14884 <item>nant.project.default = defaultTarget</item>
14885 </list>
14886 </summary>
14887 <param name="doc">An <see cref="T:System.Xml.XmlDocument"/> representing the project definition.</param>
14888 <param name="threshold">The project message threshold.</param>
14889 <param name="indentLevel">The project indentation level.</param>
14890 <param name="optimization">Optimization flags.</param>
14891 <exception cref="T:System.ArgumentNullException"><paramref name="doc"/> is <see langword="null"/>.</exception>
14892 </member>
14893 <member name="M:NAnt.Core.Project.InitializeProjectDocument(System.Xml.XmlDocument)">
14894 <summary>
14895 This method is only meant to be used by the <see cref="T:NAnt.Core.Project"/>
14896 class and <see cref="T:NAnt.Core.Tasks.IncludeTask"/>.
14897 </summary>
14898 </member>
14899 <member name="M:NAnt.Core.Project.LoadBuildFile(System.String)">
14900 <summary>
14901 Creates a new <see cref="T:System.Xml.XmlDocument"/> based on the project
14902 definition.
14903 </summary>
14904 <param name="uriOrFilePath">
14905 <para>The full path to the build file.</para>
14906 <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
14907 </param>
14908 <returns>
14909 An <see cref="T:System.Xml.XmlDocument"/> based on the specified project
14910 definition.
14911 </returns>
14912 </member>
14913 <member name="M:NAnt.Core.Project.ConfigurePlatformProperties">
14914 <summary>
14915 Configures the platform properties for the current platform.
14916 </summary>
14917 <exception cref="T:NAnt.Core.BuildException">NAnt does not support the current platform.</exception>
14918 </member>
14919 <member name="M:NAnt.Core.Project.UpdateTargetFrameworkProperties">
14920 <summary>
14921 Updates dependent properties when the <see cref="P:NAnt.Core.Project.TargetFramework"/>
14922 is set.
14923 </summary>
14924 </member>
14925 <member name="M:NAnt.Core.Project.TopologicalTargetSort(System.String,NAnt.Core.TargetCollection)">
14926 <summary>
14927 Topologically sorts a set of targets.
14928 </summary>
14929 <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>
14930 <param name="targets">A collection of <see cref="T:NAnt.Core.Target"/> instances.</param>
14931 <returns>
14932 A collection of <see cref="T:NAnt.Core.Target"/> instances in sorted order.
14933 </returns>
14934 <exception cref="T:NAnt.Core.BuildException">There is a cyclic dependecy among the targets, or a named target does not exist.</exception>
14935 </member>
14936 <member name="M:NAnt.Core.Project.TopologicalTargetSort(System.String,NAnt.Core.TargetCollection,System.Collections.Hashtable,System.Collections.Stack,NAnt.Core.TargetCollection)">
14937 <summary>
14938 <para>
14939 Performs a single step in a recursive depth-first-search traversal
14940 of the target dependency tree.
14941 </para>
14942 <para>
14943 The current target is first set to the "visiting" state, and pushed
14944 onto the "visiting" stack.
14945 </para>
14946 <para>
14947 An exception is then thrown if any child of the current node is in
14948 the visiting state, as that implies a circular dependency. The
14949 exception contains details of the cycle, using elements of the
14950 "visiting" stack.
14951 </para>
14952 <para>
14953 If any child has not already been "visited", this method is called
14954 recursively on it.
14955 </para>
14956 <para>
14957 The current target is then added to the ordered list of targets.
14958 Note that this is performed after the children have been visited in
14959 order to get the correct order. The current target is set to the
14960 "visited" state.
14961 </para>
14962 <para>
14963 By the time this method returns, the ordered list contains the
14964 sequence of targets up to and including the current target.
14965 </para>
14966 </summary>
14967 <param name="root">The current target to inspect. Must not be <see langword="null"/>.</param>
14968 <param name="targets">A collection of <see cref="T:NAnt.Core.Target"/> instances.</param>
14969 <param name="state">A mapping from targets to states The states in question are "VISITING" and "VISITED". Must not be <see langword="null"/>.</param>
14970 <param name="visiting">A stack of targets which are currently being visited. Must not be <see langword="null"/>.</param>
14971 <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>
14972 <exception cref="T:NAnt.Core.BuildException">
14973 <para>A non-existent target is specified</para>
14974 <para>-or-</para>
14975 <para>A circular dependency is detected.</para>
14976 </exception>
14977 </member>
14978 <member name="M:NAnt.Core.Project.CreateCircularException(System.String,System.Collections.Stack)">
14979 <summary>
14980 Builds an appropriate exception detailing a specified circular
14981 dependency.
14982 </summary>
14983 <param name="end">The dependency to stop at. Must not be <see langword="null"/>.</param>
14984 <param name="stack">A stack of dependencies. Must not be <see langword="null"/>.</param>
14985 <returns>
14986 A <see cref="T:NAnt.Core.BuildException"/> detailing the specified circular
14987 dependency.
14988 </returns>
14989 </member>
14990 <member name="P:NAnt.Core.Project.IndentationLevel">
14991 <summary>
14992 Gets or sets the indendation level of the build output.
14993 </summary>
14994 <value>
14995 The indentation level of the build output.
14996 </value>
14997 <remarks>
14998 To change the <see cref="P:NAnt.Core.Project.IndentationLevel"/>, the <see cref="M:NAnt.Core.Project.Indent"/>
14999 and <see cref="M:NAnt.Core.Project.Unindent"/> methods should be used.
15000 </remarks>
15001 </member>
15002 <member name="P:NAnt.Core.Project.IndentationSize">
15003 <summary>
15004 Gets or sets the indentation size of the build output.
15005 </summary>
15006 <value>
15007 The indendation size of the build output.
15008 </value>
15009 </member>
15010 <member name="P:NAnt.Core.Project.Threshold">
15011 <summary>
15012 Gets or sets the default threshold level for build loggers.
15013 </summary>
15014 <value>
15015 The default threshold level for build loggers.
15016 </value>
15017 </member>
15018 <member name="P:NAnt.Core.Project.ProjectName">
15019 <summary>
15020 Gets the name of the <see cref="T:NAnt.Core.Project"/>.
15021 </summary>
15022 <value>
15023 The name of the <see cref="T:NAnt.Core.Project"/> or an empty <see cref="T:System.String"/>
15024 if no name is specified.
15025 </value>
15026 </member>
15027 <member name="P:NAnt.Core.Project.BaseDirectory">
15028 <summary>
15029 Gets or sets the base directory used for relative references.
15030 </summary>
15031 <value>
15032 The base directory used for relative references.
15033 </value>
15034 <exception cref="T:NAnt.Core.BuildException">The directory is not rooted.</exception>
15035 <remarks>
15036 <para>
15037 The <see cref="P:NAnt.Core.Project.BaseDirectory"/> gets and sets the built-in property
15038 named "nant.project.basedir".
15039 </para>
15040 </remarks>
15041 </member>
15042 <member name="P:NAnt.Core.Project.NamespaceManager">
15043 <summary>
15044 Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
15045 </summary>
15046 <value>
15047 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
15048 </value>
15049 <remarks>
15050 The <see cref="P:NAnt.Core.Project.NamespaceManager"/> defines the current namespace
15051 scope and provides methods for looking up namespace information.
15052 </remarks>
15053 </member>
15054 <member name="P:NAnt.Core.Project.BuildFileUri">
15055 <summary>
15056 Gets the <see cref="T:System.Uri"/> form of the current project definition.
15057 </summary>
15058 <value>
15059 The <see cref="T:System.Uri"/> form of the current project definition.
15060 </value>
15061 </member>
15062 <member name="P:NAnt.Core.Project.Frameworks">
15063 <summary>
15064 Gets a collection of available .NET frameworks.
15065 </summary>
15066 <value>
15067 A collection of available .NET frameworks.
15068 </value>
15069 </member>
15070 <member name="P:NAnt.Core.Project.RuntimeFramework">
15071 <summary>
15072 Gets the framework in which NAnt is currently running.
15073 </summary>
15074 <value>
15075 The framework in which NAnt is currently running.
15076 </value>
15077 </member>
15078 <member name="P:NAnt.Core.Project.TargetFramework">
15079 <summary>
15080 Gets or sets the framework to use for compilation.
15081 </summary>
15082 <value>
15083 The framework to use for compilation.
15084 </value>
15085 <exception cref="T:System.ArgumentNullException">The value specified is <see langword="null"/>.</exception>
15086 <exception cref="T:NAnt.Core.BuildException">The specified framework is not installed, or not configured correctly.</exception>
15087 <remarks>
15088 We will use compiler tools and system assemblies for this framework
15089 in framework-related tasks.
15090 </remarks>
15091 </member>
15092 <member name="P:NAnt.Core.Project.PlatformName">
15093 <summary>
15094 Gets the name of the platform on which NAnt is currently running.
15095 </summary>
15096 <value>
15097 The name of the platform on which NAnt is currently running.
15098 </value>
15099 <remarks>
15100 <para>
15101 Possible values are:
15102 </para>
15103 <list type="bullet">
15104 <item>
15105 <description>win32</description>
15106 </item>
15107 <item>
15108 <description>unix</description>
15109 </item>
15110 </list>
15111 </remarks>
15112 <exception cref="T:NAnt.Core.BuildException">NAnt does not support the current platform.</exception>
15113 </member>
15114 <member name="P:NAnt.Core.Project.CurrentTarget">
15115 <summary>
15116 Gets the current target.
15117 </summary>
15118 <value>
15119 The current target, or <see langword="null" /> if no target is
15120 executing.
15121 </value>
15122 </member>
15123 <member name="P:NAnt.Core.Project.BuildFileLocalName">
15124 <summary>
15125 Gets the path to the build file.
15126 </summary>
15127 <value>
15128 The path to the build file, or <see langword="null" /> if the build
15129 document is not file backed.
15130 </value>
15131 </member>
15132 <member name="P:NAnt.Core.Project.Document">
15133 <summary>
15134 Gets the active <see cref="T:NAnt.Core.Project"/> definition.
15135 </summary>
15136 <value>
15137 The active <see cref="T:NAnt.Core.Project"/> definition.
15138 </value>
15139 </member>
15140 <member name="P:NAnt.Core.Project.ConfigurationNode">
15141 <summary>
15142 Gets the <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize
15143 configuration settings.
15144 </summary>
15145 <value>
15146 The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize
15147 configuration settings.
15148 </value>
15149 </member>
15150 <member name="P:NAnt.Core.Project.DefaultTargetName">
15151 <remarks>
15152 Gets the name of the target that will be executed when no other
15153 build targets are specified.
15154 </remarks>
15155 <value>
15156 The name of the target that will be executed when no other
15157 build targets are specified, or <see langword="null" /> if no
15158 default target is specified in the build file.
15159 </value>
15160 </member>
15161 <member name="P:NAnt.Core.Project.Verbose">
15162 <summary>
15163 Gets a value indicating whether tasks should output more build log
15164 messages.
15165 </summary>
15166 <value>
15167 <see langword="true" /> if tasks should output more build log message;
15168 otherwise, <see langword="false" />.
15169 </value>
15170 </member>
15171 <member name="P:NAnt.Core.Project.BuildTargets">
15172 <summary>
15173 The list of targets to build.
15174 </summary>
15175 <remarks>
15176 Targets are built in the order they appear in the collection. If
15177 the collection is empty the default target will be built.
15178 </remarks>
15179 </member>
15180 <member name="P:NAnt.Core.Project.Properties">
15181 <summary>
15182 Gets the properties defined in this project.
15183 </summary>
15184 <value>The properties defined in this project.</value>
15185 <remarks>
15186 <para>
15187 This is the collection of properties that are defined by the system
15188 and property task statements.
15189 </para>
15190 <para>
15191 These properties can be used in expansion.
15192 </para>
15193 </remarks>
15194 </member>
15195 <member name="P:NAnt.Core.Project.FrameworkNeutralProperties">
15196 <summary>
15197 Gets the framework-neutral properties defined in the NAnt
15198 configuration file.
15199 </summary>
15200 <value>
15201 The framework-neutral properties defined in the NAnt configuration
15202 file.
15203 </value>
15204 <remarks>
15205 <para>
15206 This is the collection of read-only properties that are defined in
15207 the NAnt configuration file.
15208 </para>
15209 <para>
15210 These properties can only be used for expansion in framework-specific
15211 and framework-neutral configuration settings. These properties are
15212 not available for expansion in the build file.
15213 </para>
15214 </remarks>
15215 </member>
15216 <member name="P:NAnt.Core.Project.DataTypeReferences">
15217 <summary>
15218 Gets the <see cref="T:NAnt.Core.DataTypeBase"/> instances defined in this project.
15219 </summary>
15220 <value>
15221 The <see cref="T:NAnt.Core.DataTypeBase"/> instances defined in this project.
15222 </value>
15223 <remarks>
15224 <para>
15225 This is the collection of <see cref="T:NAnt.Core.DataTypeBase"/> instances that
15226 are defined by <see cref="T:NAnt.Core.DataTypeBase"/> (eg fileset) declarations.
15227 </para>
15228 </remarks>
15229 </member>
15230 <member name="P:NAnt.Core.Project.Targets">
15231 <summary>
15232 Gets the targets defined in this project.
15233 </summary>
15234 <value>
15235 The targets defined in this project.
15236 </value>
15237 </member>
15238 <member name="P:NAnt.Core.Project.BuildListeners">
15239 <summary>
15240 Gets the build listeners for this project.
15241 </summary>
15242 <value>
15243 The build listeners for this project.
15244 </value>
15245 </member>
15246 <member name="T:NAnt.Core.Optimizations">
15247 <summary>
15248 Allow the project construction to be optimized.
15249 </summary>
15250 <remarks>
15251 Use this with care!
15252 </remarks>
15253 </member>
15254 <member name="F:NAnt.Core.Optimizations.None">
15255 <summary>
15256 Do not perform any optimizations.
15257 </summary>
15258 </member>
15259 <member name="F:NAnt.Core.Optimizations.SkipAutomaticDiscovery">
15260 <summary>
15261 The project base directory must not be automatically scanned
15262 for extension assemblies.
15263 </summary>
15264 </member>
15265 <member name="F:NAnt.Core.Optimizations.SkipFrameworkConfiguration">
15266 <summary>
15267 Do not scan the project configuration for frameworks, and
15268 do not configure the runtime and target framework.
15269 </summary>
15270 </member>
15271 <member name="F:NAnt.Core.ProjectSettingsLoader.ScannedTasks">
15272 <summary>
15273 Holds a value indicating whether a scan for tasks, types and functions
15274 has already been performed for the current runtime framework.
15275 </summary>
15276 </member>
15277 <member name="M:NAnt.Core.ProjectSettingsLoader.#ctor(NAnt.Core.Project)">
15278 <summary>
15279 Initializes a new instance of the <see cref="T:NAnt.Core.ProjectSettingsLoader"/>
15280 class for the given <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/>.
15281 </summary>
15282 <param name="project">The <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> that should be configured.</param>
15283 </member>
15284 <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessSettings">
15285 <summary>
15286 Loads and processes settings from the specified <see cref="T:System.Xml.XmlNode"/>
15287 of the configuration file.
15288 </summary>
15289 </member>
15290 <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessFrameworks(System.Xml.XmlNode)">
15291 <summary>
15292 Processes the framework nodes of the given platform node.
15293 </summary>
15294 <param name="platformNode">An <see cref="T:System.Xml.XmlNode"/> representing the platform on which NAnt is running.</param>
15295 </member>
15296 <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessGlobalProperties(System.Xml.XmlNodeList)">
15297 <summary>
15298 Reads the list of global properties specified in the NAnt configuration
15299 file.
15300 </summary>
15301 <param name="propertyNodes">An <see cref="T:System.Xml.XmlNodeList"/> representing global properties.</param>
15302 </member>
15303 <member name="M:NAnt.Core.ProjectSettingsLoader.GetXmlAttributeValue(System.Xml.XmlNode,System.String)">
15304 <summary>
15305 Gets the value of the specified attribute from the specified node.
15306 </summary>
15307 <param name="xmlNode">The node of which the attribute value should be retrieved.</param>
15308 <param name="attributeName">The attribute of which the value should be returned.</param>
15309 <returns>
15310 The value of the attribute with the specified name or <see langword="null" />
15311 if the attribute does not exist or has no value.
15312 </returns>
15313 </member>
15314 <member name="P:NAnt.Core.ProjectSettingsLoader.Project">
15315 <summary>
15316 Gets the underlying <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> instance.
15317 </summary>
15318 <value>
15319 The underlying <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> instance.
15320 </value>
15321 </member>
15322 <member name="P:NAnt.Core.ProjectSettingsLoader.NamespaceManager">
15323 <summary>
15324 Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
15325 </summary>
15326 <value>
15327 The <see cref="T:System.Xml.XmlNamespaceManager"/>.
15328 </value>
15329 <remarks>
15330 The <see cref="P:NAnt.Core.ProjectSettingsLoader.NamespaceManager"/> defines the current namespace
15331 scope and provides methods for looking up namespace information.
15332 </remarks>
15333 </member>
15334 <member name="F:NAnt.Core.PropertyDictionary.Visiting">
15335 <summary>
15336 Constant for the "visiting" state, used when traversing a DFS of
15337 property references.
15338 </summary>
15339 </member>
15340 <member name="F:NAnt.Core.PropertyDictionary.Visited">
15341 <summary>
15342 Constant for the "visited" state, used when travesing a DFS of
15343 property references.
15344 </summary>
15345 </member>
15346 <member name="M:NAnt.Core.PropertyDictionary.#ctor(NAnt.Core.Project)">
15347 <summary>
15348 Initializes a new instance of the <see cref="T:NAnt.Core.PropertyDictionary"/>
15349 class holding properties for the given <see cref="P:NAnt.Core.PropertyDictionary.Project"/>
15350 instance.
15351 </summary>
15352 <param name="project">The project for which the dictionary will hold properties.</param>
15353 </member>
15354 <member name="M:NAnt.Core.PropertyDictionary.OnInsert(System.Object,System.Object)">
15355 <summary>
15356 Performs additional custom processes before inserting a new element
15357 into the <see cref="T:System.Collections.DictionaryBase"/> instance.
15358 </summary>
15359 <param name="key">The key of the element to insert.</param>
15360 <param name="value">The value of the element to insert.</param>
15361 </member>
15362 <member name="M:NAnt.Core.PropertyDictionary.OnRemove(System.Object,System.Object)">
15363 <summary>
15364 Performs additional custom processes before removing an element
15365 from the <see cref="T:System.Collections.DictionaryBase"/> instance.
15366 </summary>
15367 <param name="key">The key of the element to remove.</param>
15368 <param name="value">The value of the element to remove.</param>
15369 </member>
15370 <member name="M:NAnt.Core.PropertyDictionary.OnValidate(System.Object,System.Object)">
15371 <summary>
15372 Performs additional custom processes when validating the element
15373 with the specified key and value.
15374 </summary>
15375 <param name="key">The key of the element to validate.</param>
15376 <param name="value">The value of the element to validate.</param>
15377 </member>
15378 <member name="M:NAnt.Core.PropertyDictionary.AddReadOnly(System.String,System.String)">
15379 <summary>
15380 Adds a property that cannot be changed.
15381 </summary>
15382 <param name="name">The name of the property.</param>
15383 <param name="value">The value to assign to the property.</param>
15384 <remarks>
15385 Properties added with this method can never be changed. Note that
15386 they are removed if the <see cref="M:System.Collections.DictionaryBase.Clear"/> method is called.
15387 </remarks>
15388 </member>
15389 <member name="M:NAnt.Core.PropertyDictionary.MarkDynamic(System.String)">
15390 <summary>
15391 Marks a property as a property of which the value is expanded at
15392 execution time.
15393 </summary>
15394 <param name="name">The name of the property to mark as dynamic.</param>
15395 </member>
15396 <member name="M:NAnt.Core.PropertyDictionary.Add(System.String,System.String)">
15397 <summary>
15398 Adds a property to the collection.
15399 </summary>
15400 <param name="name">The name of the property.</param>
15401 <param name="value">The value to assign to the property.</param>
15402 </member>
15403 <member name="M:NAnt.Core.PropertyDictionary.IsReadOnlyProperty(System.String)">
15404 <summary>
15405 Determines whether the specified property is listed as read-only.
15406 </summary>
15407 <param name="name">The name of the property to check.</param>
15408 <returns>
15409 <see langword="true" /> if the property is listed as read-only;
15410 otherwise, <see langword="false" />.
15411 </returns>
15412 </member>
15413 <member name="M:NAnt.Core.PropertyDictionary.IsDynamicProperty(System.String)">
15414 <summary>
15415 Determines whether the specified property is listed as dynamic.
15416 </summary>
15417 <param name="name">The name of the property to check.</param>
15418 <returns>
15419 <see langword="true" /> if the property is listed as dynamic;
15420 otherwise, <see langword="false" />.
15421 </returns>
15422 </member>
15423 <member name="M:NAnt.Core.PropertyDictionary.Inherit(NAnt.Core.PropertyDictionary,System.Collections.Specialized.StringCollection)">
15424 <summary>
15425 Inherits properties from an existing property dictionary Instance.
15426 </summary>
15427 <param name="source">Property list to inherit.</param>
15428 <param name="excludes">The list of properties to exclude during inheritance.</param>
15429 </member>
15430 <member name="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location)">
15431 <summary>
15432 Expands a <see cref="T:System.String"/> from known properties.
15433 </summary>
15434 <param name="input">The replacement tokens.</param>
15435 <param name="location">The <see cref="T:NAnt.Core.Location"/> to pass through for any exceptions.</param>
15436 <returns>The expanded and replaced string.</returns>
15437 </member>
15438 <member name="M:NAnt.Core.PropertyDictionary.Contains(System.String)">
15439 <summary>
15440 Determines whether a property already exists.
15441 </summary>
15442 <param name="name">The name of the property to check.</param>
15443 <returns>
15444 <see langword="true" /> if the specified property already exists;
15445 otherwise, <see langword="false" />.
15446 </returns>
15447 </member>
15448 <member name="M:NAnt.Core.PropertyDictionary.Remove(System.String)">
15449 <summary>
15450 Removes the property with the specified name.
15451 </summary>
15452 <param name="name">The name of the property to remove.</param>
15453 </member>
15454 <member name="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location,System.Collections.Hashtable,System.Collections.Stack)">
15455 <summary>
15456 Expands a <see cref="T:System.String"/> from known properties.
15457 </summary>
15458 <param name="input">The replacement tokens.</param>
15459 <param name="location">The <see cref="T:NAnt.Core.Location"/> to pass through for any exceptions.</param>
15460 <param name="state">A mapping from properties to states. The states in question are "VISITING" and "VISITED". Must not be <see langword="null"/>.</param>
15461 <param name="visiting">A stack of properties which are currently being visited. Must not be <see langword="null"/>.</param>
15462 <returns>The expanded and replaced string.</returns>
15463 </member>
15464 <member name="M:NAnt.Core.PropertyDictionary.EvaluateEmbeddedExpressions(System.String,NAnt.Core.Location,System.Collections.Hashtable,System.Collections.Stack)">
15465 <summary>
15466 Evaluates the given expression string and returns the result
15467 </summary>
15468 <param name="input"></param>
15469 <param name="location"></param>
15470 <param name="state"></param>
15471 <param name="visiting"></param>
15472 <returns></returns>
15473 </member>
15474 <member name="M:NAnt.Core.PropertyDictionary.CheckDeprecation(System.String)">
15475 <summary>
15476 Checks whether the specified property is deprecated.
15477 </summary>
15478 <param name="name">The property to check.</param>
15479 </member>
15480 <member name="M:NAnt.Core.PropertyDictionary.CreateCircularException(System.String,System.Collections.Stack)">
15481 <summary>
15482 Builds an appropriate exception detailing a specified circular
15483 reference.
15484 </summary>
15485 <param name="end">The property reference to stop at. Must not be <see langword="null"/>.</param>
15486 <param name="stack">A stack of property references. Must not be <see langword="null"/>.</param>
15487 <returns>
15488 A <see cref="T:NAnt.Core.BuildException"/> detailing the specified circular
15489 dependency.
15490 </returns>
15491 </member>
15492 <member name="F:NAnt.Core.PropertyDictionary._readOnlyProperties">
15493 <summary>
15494 Maintains a list of the property names that are readonly.
15495 </summary>
15496 </member>
15497 <member name="F:NAnt.Core.PropertyDictionary._dynamicProperties">
15498 <summary>
15499 Maintains a list of the property names of which the value is expanded
15500 on usage, not at initalization.
15501 </summary>
15502 </member>
15503 <member name="F:NAnt.Core.PropertyDictionary._project">
15504 <summary>
15505 The project for which the dictionary holds properties.
15506 </summary>
15507 </member>
15508 <member name="P:NAnt.Core.PropertyDictionary.Item(System.String)">
15509 <summary>
15510 Indexer property.
15511 </summary>
15512 </member>
15513 <member name="P:NAnt.Core.PropertyDictionary.Project">
15514 <summary>
15515 Gets the project for which the dictionary holds properties.
15516 </summary>
15517 <value>
15518 The project for which the dictionary holds properties.
15519 </value>
15520 </member>
15521 <member name="M:NAnt.Core.Target.#ctor">
15522 <summary>
15523 Initializes a new instance of the <see cref="T:NAnt.Core.Target"/> class.
15524 </summary>
15525 </member>
15526 <member name="M:NAnt.Core.Target.System#ICloneable#Clone">
15527 <summary>
15528 Creates a shallow copy of the <see cref="T:NAnt.Core.Target"/>.
15529 </summary>
15530 <returns>
15531 A shallow copy of the <see cref="T:NAnt.Core.Target"/>.
15532 </returns>
15533 </member>
15534 <member name="M:NAnt.Core.Target.Clone">
15535 <summary>
15536 Creates a shallow copy of the <see cref="T:NAnt.Core.Target"/>.
15537 </summary>
15538 <returns>
15539 A shallow copy of the <see cref="T:NAnt.Core.Target"/>.
15540 </returns>
15541 </member>
15542 <member name="M:NAnt.Core.Target.Execute">
15543 <summary>
15544 Executes dependent targets first, then the target.
15545 </summary>
15546 </member>
15547 <member name="P:NAnt.Core.Target.Executed">
15548 <summary>
15549 This indicates whether the target has already executed.
15550 </summary>
15551 </member>
15552 <member name="P:NAnt.Core.Target.Name">
15553 <summary>
15554 The name of the target.
15555 </summary>
15556 <remarks>
15557 <para>
15558 Hides <see cref="P:NAnt.Core.Element.Name"/> to have <see cref="T:NAnt.Core.Target"/>
15559 return the name of target, not the name of XML element - which
15560 would always be <c>target</c>.
15561 </para>
15562 <para>
15563 Note: Properties are not allowed in the name.
15564 </para>
15565 </remarks>
15566 </member>
15567 <member name="P:NAnt.Core.Target.IfCondition">
15568 <summary>
15569 If <see langword="true" /> then the target will be executed;
15570 otherwise, skipped. The default is <see langword="true" />.
15571 </summary>
15572 </member>
15573 <member name="P:NAnt.Core.Target.IfDefined">
15574 <summary>
15575 Gets a value indicating whether the target should be executed.
15576 </summary>
15577 <value>
15578 <see langword="true" /> if the target should be executed; otherwise,
15579 <see langword="false" />.
15580 </value>
15581 </member>
15582 <member name="P:NAnt.Core.Target.UnlessCondition">
15583 <summary>
15584 Opposite of <see cref="P:NAnt.Core.Target.IfDefined"/>. If <see langword="false"/>
15585 then the target will be executed; otherwise, skipped. The default
15586 is <see langword="false"/>.
15587 </summary>
15588 </member>
15589 <member name="P:NAnt.Core.Target.UnlessDefined">
15590 <summary>
15591 Gets a value indicating whether the target should NOT be executed.
15592 </summary>
15593 <value>
15594 <see langword="true" /> if the target should NOT be executed;
15595 otherwise, <see langword="false" />.
15596 </value>
15597 </member>
15598 <member name="P:NAnt.Core.Target.Description">
15599 <summary>
15600 The description of the target.
15601 </summary>
15602 </member>
15603 <member name="P:NAnt.Core.Target.DependsListString">
15604 <summary>
15605 Space separated list of targets that this target depends on.
15606 </summary>
15607 </member>
15608 <member name="P:NAnt.Core.Target.Dependencies">
15609 <summary>
15610 A collection of target names that must be executed before this
15611 target.
15612 </summary>
15613 </member>
15614 <member name="M:NAnt.Core.TargetCollection.Find(System.String)">
15615 <summary>
15616 Finds a target by name.
15617 </summary>
15618 <param name="targetName">The name of the target to find.</param>
15619 <returns>
15620 The <see cref="T:NAnt.Core.Target"/> with the specified name, or
15621 <see langword="null"/> if no <see cref="T:NAnt.Core.Target"/> exists with
15622 the given name.
15623 </returns>
15624 </member>
15625 <member name="M:NAnt.Core.TargetCollection.ToString(System.String)">
15626 <summary>
15627 Gets the names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>
15628 combined into one list separated by the given <see cref="T:System.String"/>.
15629 </summary>
15630 <returns>
15631 A <see cref="T:System.String"/> that contains a list of the names of the
15632 targets in the <see cref="T:NAnt.Core.TargetCollection"/>, separated by
15633 the specified <paramref name="separator"/>.
15634 </returns>
15635 </member>
15636 <member name="M:NAnt.Core.TargetCollection.ToString">
15637 <summary>
15638 Gets the names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>
15639 combined into one comma-separated list.
15640 </summary>
15641 <returns>
15642 A <see cref="T:System.String"/> that contains a comma-separated list of the
15643 names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>.
15644 </returns>
15645 </member>
15646 <member name="M:NAnt.Core.TaskBuilder.#ctor(System.Reflection.Assembly,System.String)">
15647 <summary>
15648 Creates a new instance of the <see cref="T:NAnt.Core.TaskBuilder"/> class
15649 for the specified <see cref="T:NAnt.Core.Task"/> class in the specified
15650 <see cref="T:System.Reflection.Assembly"/>.
15651 </summary>
15652 <remarks>
15653 An <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the specified <see cref="T:System.Reflection.Assembly"/>
15654 is cached for future use.
15655 </remarks>
15656 <param name="assembly">The <see cref="T:System.Reflection.Assembly"/> containing the <see cref="T:NAnt.Core.Task"/>.</param>
15657 <param name="className">The class representing the <see cref="T:NAnt.Core.Task"/>.</param>
15658 </member>
15659 <member name="M:NAnt.Core.TaskBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
15660 <summary>
15661 Creates a new instance of the <see cref="T:NAnt.Core.TaskBuilder"/> class
15662 for the specified <see cref="T:NAnt.Core.Task"/> class in the specified
15663 <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.
15664 </summary>
15665 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.Task"/>.</param>
15666 <param name="className">The class representing the <see cref="T:NAnt.Core.Task"/>.</param>
15667 </member>
15668 <member name="P:NAnt.Core.TaskBuilder.ClassName">
15669 <summary>
15670 Gets the name of the <see cref="T:NAnt.Core.Task"/> class that can be created
15671 using this <see cref="T:NAnt.Core.TaskBuilder"/>.
15672 </summary>
15673 <value>
15674 The name of the <see cref="T:NAnt.Core.Task"/> class that can be created using
15675 this <see cref="T:NAnt.Core.TaskBuilder"/>.
15676 </value>
15677 </member>
15678 <member name="P:NAnt.Core.TaskBuilder.TaskName">
15679 <summary>
15680 Gets the name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/>
15681 can create.
15682 </summary>
15683 <value>
15684 The name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/> can
15685 create.
15686 </value>
15687 </member>
15688 <member name="T:NAnt.Core.TaskBuilderCollection">
15689 <summary>
15690 Contains a strongly typed collection of <see cref="T:NAnt.Core.TaskBuilder"/> objects.
15691 </summary>
15692 </member>
15693 <member name="M:NAnt.Core.TaskBuilderCollection.#ctor">
15694 <summary>
15695 Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class.
15696 </summary>
15697 </member>
15698 <member name="M:NAnt.Core.TaskBuilderCollection.#ctor(NAnt.Core.TaskBuilderCollection)">
15699 <summary>
15700 Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class
15701 with the specified <see cref="T:NAnt.Core.TaskBuilderCollection"/> instance.
15702 </summary>
15703 </member>
15704 <member name="M:NAnt.Core.TaskBuilderCollection.#ctor(NAnt.Core.TaskBuilder[])">
15705 <summary>
15706 Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class
15707 with the specified array of <see cref="T:NAnt.Core.TaskBuilder"/> instances.
15708 </summary>
15709 </member>
15710 <member name="M:NAnt.Core.TaskBuilderCollection.Add(NAnt.Core.TaskBuilder)">
15711 <summary>
15712 Adds a <see cref="T:NAnt.Core.TaskBuilder"/> to the end of the collection.
15713 </summary>
15714 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to be added to the end of the collection.</param>
15715 <returns>The position into which the new element was inserted.</returns>
15716 </member>
15717 <member name="M:NAnt.Core.TaskBuilderCollection.AddRange(NAnt.Core.TaskBuilder[])">
15718 <summary>
15719 Adds the elements of a <see cref="T:NAnt.Core.TaskBuilder"/> array to the end of the collection.
15720 </summary>
15721 <param name="items">The array of <see cref="T:NAnt.Core.TaskBuilder"/> elements to be added to the end of the collection.</param>
15722 </member>
15723 <member name="M:NAnt.Core.TaskBuilderCollection.AddRange(NAnt.Core.TaskBuilderCollection)">
15724 <summary>
15725 Adds the elements of a <see cref="T:NAnt.Core.TaskBuilderCollection"/> to the end of the collection.
15726 </summary>
15727 <param name="items">The <see cref="T:NAnt.Core.TaskBuilderCollection"/> to be added to the end of the collection.</param>
15728 </member>
15729 <member name="M:NAnt.Core.TaskBuilderCollection.Contains(NAnt.Core.TaskBuilder)">
15730 <summary>
15731 Determines whether a <see cref="T:NAnt.Core.TaskBuilder"/> is in the collection.
15732 </summary>
15733 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to locate in the collection.</param>
15734 <returns>
15735 <see langword="true"/> if <paramref name="item"/> is found in the
15736 collection; otherwise, <see langword="false"/>.
15737 </returns>
15738 </member>
15739 <member name="M:NAnt.Core.TaskBuilderCollection.Contains(System.String)">
15740 <summary>
15741 Determines whether a <see cref="T:NAnt.Core.TaskBuilder"/> for the specified
15742 task is in the collection.
15743 </summary>
15744 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.TaskBuilder"/> should be located in the collection.</param>
15745 <returns>
15746 <see langword="true"/> if a <see cref="T:NAnt.Core.TaskBuilder"/> for the
15747 specified task is found in the collection; otherwise, <see langword="false"/>.
15748 </returns>
15749 </member>
15750 <member name="M:NAnt.Core.TaskBuilderCollection.CopyTo(NAnt.Core.TaskBuilder[],System.Int32)">
15751 <summary>
15752 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
15753 </summary>
15754 <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>
15755 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
15756 </member>
15757 <member name="M:NAnt.Core.TaskBuilderCollection.IndexOf(NAnt.Core.TaskBuilder)">
15758 <summary>
15759 Retrieves the index of a specified <see cref="T:NAnt.Core.TaskBuilder"/> object in the collection.
15760 </summary>
15761 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> object for which the index is returned.</param>
15762 <returns>
15763 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.
15764 </returns>
15765 </member>
15766 <member name="M:NAnt.Core.TaskBuilderCollection.Insert(System.Int32,NAnt.Core.TaskBuilder)">
15767 <summary>
15768 Inserts a <see cref="T:NAnt.Core.TaskBuilder"/> into the collection at the specified index.
15769 </summary>
15770 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
15771 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to insert.</param>
15772 </member>
15773 <member name="M:NAnt.Core.TaskBuilderCollection.GetEnumerator">
15774 <summary>
15775 Returns an enumerator that can iterate through the collection.
15776 </summary>
15777 <returns>
15778 A <see cref="T:NAnt.Core.TaskBuilderEnumerator"/> for the entire collection.
15779 </returns>
15780 </member>
15781 <member name="M:NAnt.Core.TaskBuilderCollection.Remove(NAnt.Core.TaskBuilder)">
15782 <summary>
15783 Removes a member from the collection.
15784 </summary>
15785 <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to remove from the collection.</param>
15786 </member>
15787 <member name="P:NAnt.Core.TaskBuilderCollection.Item(System.Int32)">
15788 <summary>
15789 Gets or sets the element at the specified index.
15790 </summary>
15791 <param name="index">The zero-based index of the element to get or set.</param>
15792 </member>
15793 <member name="P:NAnt.Core.TaskBuilderCollection.Item(System.String)">
15794 <summary>
15795 Gets the <see cref="T:NAnt.Core.TaskBuilder"/> for the specified task.
15796 </summary>
15797 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.TaskBuilder"/> should be located in the collection.</param>
15798 </member>
15799 <member name="T:NAnt.Core.TaskBuilderEnumerator">
15800 <summary>
15801 Enumerates the <see cref="T:NAnt.Core.TaskBuilder"/> elements of a <see cref="T:NAnt.Core.TaskBuilderCollection"/>.
15802 </summary>
15803 </member>
15804 <member name="M:NAnt.Core.TaskBuilderEnumerator.#ctor(NAnt.Core.TaskBuilderCollection)">
15805 <summary>
15806 Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderEnumerator"/> class
15807 with the specified <see cref="T:NAnt.Core.TaskBuilderCollection"/>.
15808 </summary>
15809 <param name="arguments">The collection that should be enumerated.</param>
15810 </member>
15811 <member name="M:NAnt.Core.TaskBuilderEnumerator.MoveNext">
15812 <summary>
15813 Advances the enumerator to the next element of the collection.
15814 </summary>
15815 <returns>
15816 <see langword="true" /> if the enumerator was successfully advanced
15817 to the next element; <see langword="false" /> if the enumerator has
15818 passed the end of the collection.
15819 </returns>
15820 </member>
15821 <member name="M:NAnt.Core.TaskBuilderEnumerator.Reset">
15822 <summary>
15823 Sets the enumerator to its initial position, which is before the
15824 first element in the collection.
15825 </summary>
15826 </member>
15827 <member name="P:NAnt.Core.TaskBuilderEnumerator.Current">
15828 <summary>
15829 Gets the current element in the collection.
15830 </summary>
15831 <returns>
15832 The current element in the collection.
15833 </returns>
15834 </member>
15835 <member name="T:NAnt.Core.TypeFactory">
15836 <summary>
15837 Comprises all of the loaded, and available, tasks.
15838 Use these static methods to register, initialize and create a task.
15839 </summary>
15840 </member>
15841 <member name="M:NAnt.Core.TypeFactory.ScanAssembly(System.String,NAnt.Core.Task)">
15842 <summary>
15843 Scans the given assembly for tasks, types, functions and filters.
15844 </summary>
15845 <param name="assemblyFile">The assembly to scan for tasks, types, functions and filters.</param>
15846 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15847 </member>
15848 <member name="M:NAnt.Core.TypeFactory.ScanAssembly(System.Reflection.Assembly,NAnt.Core.Task)">
15849 <summary>
15850 Scans the given assembly for tasks, types, functions and filters.
15851 </summary>
15852 <param name="assembly">The assembly to scan for tasks, types, functions and filters.</param>
15853 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15854 <returns>
15855 <see langword="true"/> if <paramref name="assembly"/> contains at
15856 least one "extension"; otherwise, <see langword="false"/>.
15857 </returns>
15858 </member>
15859 <member name="M:NAnt.Core.TypeFactory.ScanDir(System.String,NAnt.Core.Task,System.Boolean)">
15860 <summary>
15861 Scans the path for any task assemblies and adds them.
15862 </summary>
15863 <param name="path">The directory to scan in.</param>
15864 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15865 <param name="failOnError"><see cref="T:System.Boolean"/> indicating whether scanning of the directory should halt on first error.</param>
15866 </member>
15867 <member name="M:NAnt.Core.TypeFactory.AddProject(NAnt.Core.Project)">
15868 <summary>
15869 Adds any task assemblies in the project base directory
15870 and its <c>tasks</c> subdirectory.
15871 </summary>
15872 <param name="project">The project to work from.</param>
15873 </member>
15874 <member name="M:NAnt.Core.TypeFactory.AddProject(NAnt.Core.Project,System.Boolean)">
15875 <summary>
15876 Registers the project with <see cref="T:NAnt.Core.TypeFactory"/>, and optionally
15877 scan the <see cref="P:NAnt.Core.Project.BaseDirectory"/> for extension assemblies.
15878 </summary>
15879 <param name="project">The project to work from.</param>
15880 <param name="scan">Specified whether to scan the <see cref="P:NAnt.Core.Project.BaseDirectory"/> for extension assemblies.</param>
15881 </member>
15882 <member name="M:NAnt.Core.TypeFactory.LookupFunction(System.String,NAnt.Core.Extensibility.FunctionArgument[],NAnt.Core.Project)">
15883 <summary>
15884 Looks up a function by name and argument count.
15885 </summary>
15886 <param name="functionName">The name of the function to lookup, including namespace prefix.</param>
15887 <param name="args">The argument of the function to lookup.</param>
15888 <param name="project">The <see cref="T:NAnt.Core.Project"/> in which the function is invoked.</param>
15889 <returns>
15890 A <see cref="T:System.Reflection.MethodInfo"/> representing the function, or
15891 <see langword="null"/> if a function with the given name and
15892 arguments does not exist.
15893 </returns>
15894 </member>
15895 <member name="M:NAnt.Core.TypeFactory.CreateTask(System.Xml.XmlNode,NAnt.Core.Project)">
15896 <summary>
15897 Creates a new <see cref="T:NAnt.Core.Task"/> instance for the given XML and
15898 <see cref="T:NAnt.Core.Project"/>.
15899 </summary>
15900 <param name="taskNode">The XML to initialize the task with.</param>
15901 <param name="proj">The <see cref="T:NAnt.Core.Project"/> that the <see cref="T:NAnt.Core.Task"/> belongs to.</param>
15902 <returns>
15903 The new <see cref="T:NAnt.Core.Task"/> instance.
15904 </returns>
15905 </member>
15906 <member name="M:NAnt.Core.TypeFactory.ScanTypeForTasks(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
15907 <summary>
15908 Scans a given <see cref="T:System.Type"/> for tasks.
15909 </summary>
15910 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
15911 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
15912 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15913 <returns>
15914 <see langword="true"/> if <paramref name="type"/> represents a
15915 <see cref="T:NAnt.Core.Task"/>; otherwise, <see langword="false"/>.
15916 </returns>
15917 </member>
15918 <member name="M:NAnt.Core.TypeFactory.ScanTypeForDataTypes(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
15919 <summary>
15920 Scans a given <see cref="T:System.Type"/> for data type.
15921 </summary>
15922 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
15923 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
15924 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15925 <returns>
15926 <see langword="true"/> if <paramref name="type"/> represents a
15927 data type; otherwise, <see langword="false"/>.
15928 </returns>
15929 </member>
15930 <member name="M:NAnt.Core.TypeFactory.ScanTypeForFunctions(System.Type,NAnt.Core.Task)">
15931 <summary>
15932 Scans a given <see cref="T:System.Type"/> for functions.
15933 </summary>
15934 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
15935 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15936 <returns>
15937 <see langword="true"/> if <paramref name="type"/> represents a
15938 valid set of funtions; otherwise, <see langword="false"/>.
15939 </returns>
15940 </member>
15941 <member name="M:NAnt.Core.TypeFactory.ScanTypeForFilters(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
15942 <summary>
15943 Scans a given <see cref="T:System.Type"/> for filters.
15944 </summary>
15945 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
15946 <param name="type">The <see cref="T:System.Type"/> to scan.</param>
15947 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
15948 <returns>
15949 <see langword="true"/> if <paramref name="type"/> represents a
15950 <see cref="T:NAnt.Core.Filters.Filter"/>; otherwise, <see langword="false"/>.
15951 </returns>
15952 </member>
15953 <member name="P:NAnt.Core.TypeFactory.TaskBuilders">
15954 <summary>
15955 Gets the list of loaded <see cref="T:NAnt.Core.TaskBuilder"/> instances.
15956 </summary>
15957 <value>
15958 List of loaded <see cref="T:NAnt.Core.TaskBuilder"/> instances.
15959 </value>
15960 </member>
15961 <member name="P:NAnt.Core.TypeFactory.DataTypeBuilders">
15962 <summary>
15963 Gets the list of loaded <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
15964 </summary>
15965 <value>
15966 List of loaded <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
15967 </value>
15968 </member>
15969 <member name="P:NAnt.Core.TypeFactory.FilterBuilders">
15970 <summary>
15971 Gets the list of loaded <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
15972 </summary>
15973 <value>
15974 List of loaded <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
15975 </value>
15976 </member>
15977 <member name="M:NAnt.Core.ValidationException.#ctor">
15978 <summary>
15979 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15980 class.
15981 </summary>
15982 </member>
15983 <member name="M:NAnt.Core.ValidationException.#ctor(System.String)">
15984 <summary>
15985 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15986 class with a descriptive message.
15987 </summary>
15988 <param name="message">A descriptive message to include with the exception.</param>
15989 </member>
15990 <member name="M:NAnt.Core.ValidationException.#ctor(System.String,System.Exception)">
15991 <summary>
15992 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
15993 class with the specified descriptive message and inner exception.
15994 </summary>
15995 <param name="message">A descriptive message to include with the exception.</param>
15996 <param name="innerException">A nested exception that is the cause of the current exception.</param>
15997 </member>
15998 <member name="M:NAnt.Core.ValidationException.#ctor(System.String,NAnt.Core.Location)">
15999 <summary>
16000 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
16001 class with a descriptive message and the location in the build file
16002 that caused the exception.
16003 </summary>
16004 <param name="message">A descriptive message to include with the exception.</param>
16005 <param name="location">The location in the build file where the exception occured.</param>
16006 </member>
16007 <member name="M:NAnt.Core.ValidationException.#ctor(System.String,NAnt.Core.Location,System.Exception)">
16008 <summary>
16009 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
16010 class with a descriptive message, the location in the build file and
16011 an instance of the exception that is the cause of the current
16012 exception.
16013 </summary>
16014 <param name="message">A descriptive message to include with the exception.</param>
16015 <param name="location">The location in the build file where the exception occured.</param>
16016 <param name="innerException">A nested exception that is the cause of the current exception.</param>
16017 </member>
16018 <member name="M:NAnt.Core.ValidationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
16019 <summary>
16020 Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
16021 class with serialized data.
16022 </summary>
16023 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
16024 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
16025 </member>
16026 <member name="T:NAnt.Core.XmlLogger">
16027 <summary>
16028 Used to wrap log messages in xml <message/> elements.
16029 </summary>
16030 </member>
16031 <member name="F:NAnt.Core.XmlLogger._projectStack">
16032 <summary>
16033 Holds the stack of currently executing projects.
16034 </summary>
16035 </member>
16036 <member name="M:NAnt.Core.XmlLogger.#ctor">
16037 <summary>
16038 Initializes a new instance of the <see cref="T:NAnt.Core.XmlLogger"/> class.
16039 </summary>
16040 </member>
16041 <member name="M:NAnt.Core.XmlLogger.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
16042 <summary>
16043 Initializes a new instance of the <see cref="T:NAnt.Core.XmlLogger"/> class
16044 with serialized data.
16045 </summary>
16046 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
16047 <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
16048 </member>
16049 <member name="M:NAnt.Core.XmlLogger.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
16050 <summary>
16051 Populates <paramref name="info"/> with the data needed to serialize
16052 the <see cref="T:NAnt.Core.XmlLogger"/> instance.
16053 </summary>
16054 <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
16055 <param name="context">The destination for this serialization.</param>
16056 </member>
16057 <member name="M:NAnt.Core.XmlLogger.ToString">
16058 <summary>
16059 Returns the contents of log captured.
16060 </summary>
16061 </member>
16062 <member name="M:NAnt.Core.XmlLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
16063 <summary>
16064 Signals that a build has started.
16065 </summary>
16066 <param name="sender">The source of the event.</param>
16067 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
16068 <remarks>
16069 This event is fired before any targets have started.
16070 </remarks>
16071 </member>
16072 <member name="M:NAnt.Core.XmlLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
16073 <summary>
16074 Signals that the last target has finished.
16075 </summary>
16076 <param name="sender">The source of the event.</param>
16077 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
16078 <remarks>
16079 This event will still be fired if an error occurred during the build.
16080 </remarks>
16081 </member>
16082 <member name="M:NAnt.Core.XmlLogger.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
16083 <summary>
16084 Signals that a target has started.
16085 </summary>
16086 <param name="sender">The source of the event.</param>
16087 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
16088 </member>
16089 <member name="M:NAnt.Core.XmlLogger.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
16090 <summary>
16091 Signals that a target has finished.
16092 </summary>
16093 <param name="sender">The source of the event.</param>
16094 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
16095 <remarks>
16096 This event will still be fired if an error occurred during the build.
16097 </remarks>
16098 </member>
16099 <member name="M:NAnt.Core.XmlLogger.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
16100 <summary>
16101 Signals that a task has started.
16102 </summary>
16103 <param name="sender">The source of the event.</param>
16104 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
16105 </member>
16106 <member name="M:NAnt.Core.XmlLogger.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
16107 <summary>
16108 Signals that a task has finished.
16109 </summary>
16110 <param name="sender">The source of the event.</param>
16111 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
16112 <remarks>
16113 This event will still be fired if an error occurred during the build.
16114 </remarks>
16115 </member>
16116 <member name="M:NAnt.Core.XmlLogger.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
16117 <summary>
16118 Signals that a message has been logged.
16119 </summary>
16120 <param name="sender">The source of the event.</param>
16121 <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
16122 <remarks>
16123 Only messages with a priority higher or equal to the threshold of
16124 the logger will actually be output in the build log.
16125 </remarks>
16126 </member>
16127 <member name="M:NAnt.Core.XmlLogger.Flush">
16128 <summary>
16129 Flushes buffered build events or messages to the underlying storage.
16130 </summary>
16131 </member>
16132 <member name="P:NAnt.Core.XmlLogger.Threshold">
16133 <summary>
16134 Gets or sets the highest level of message this logger should respond
16135 to.
16136 </summary>
16137 <value>
16138 The highest level of message this logger should respond to.
16139 </value>
16140 <remarks>
16141 Only messages with a message level higher than or equal to the given
16142 level should be written to the log.
16143 </remarks>
16144 </member>
16145 <member name="P:NAnt.Core.XmlLogger.EmacsMode">
16146 <summary>
16147 Gets or sets a value indicating whether to produce emacs (and other
16148 editor) friendly output.
16149 </summary>
16150 <value>
16151 <see langword="false" /> as it has no meaning in XML format.
16152 </value>
16153 </member>
16154 <member name="P:NAnt.Core.XmlLogger.OutputWriter">
16155 <summary>
16156 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
16157 to send its output.
16158 </summary>
16159 </member>
16160 </members>
16161</doc>