PageRenderTime 129ms CodeModel.GetById 25ms RepoModel.GetById 1ms app.codeStats 1ms

/tools/nant/NAnt.Core.xml

http://github.com/philiplaureano/LinFu
XML | 10512 lines | 10490 code | 21 blank | 1 comment | 0 complexity | fbb84cdf29ffa44e9e2c7beaee9a47da MD5 | raw file
  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. [BuildAttribute("out", Required=true)]
  48. public string Output {
  49. get { return _out; }
  50. set { _out = value; }
  51. }
  52. [BuildAttribute("optimize")]
  53. [BooleanValidator()]
  54. public bool Optimize {
  55. get { return _optimize; }
  56. set { _optimize = value; }
  57. }
  58. [BuildAttribute("warnlevel")]
  59. [Int32Validator(0,4)] // limit values to 0-4
  60. public int WarnLevel {
  61. get { return _warnLevel; }
  62. set { _warnLevel = value; }
  63. }
  64. [BuildElement("sources")]
  65. public FileSet Sources {
  66. get { return _sources; }
  67. set { _sources = value; }
  68. }
  69. #endregion Public Instance Properties
  70. #region Private Instance Fields
  71. private string _out = null;
  72. private bool _optimize = false;
  73. private int _warnLevel = 4;
  74. private FileSet _sources = new FileSet();
  75. #endregion Private Instance Fields
  76. </code>
  77. </example>
  78. </member>
  79. <member name="M:NAnt.Core.Attributes.BuildAttributeAttribute.#ctor(System.String)">
  80. <summary>
  81. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildAttributeAttribute"/> with the
  82. specified name.
  83. </summary>
  84. <param name="name">The name of the attribute.</param>
  85. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  86. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  87. </member>
  88. <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Name">
  89. <summary>
  90. Gets or sets the name of the XML attribute.
  91. </summary>
  92. <value>
  93. The name of the XML attribute.
  94. </value>
  95. </member>
  96. <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Required">
  97. <summary>
  98. Gets or sets a value indicating whether the attribute is required.
  99. </summary>
  100. <value>
  101. <see langword="true" /> if the attribute is required; otherwise,
  102. <see langword="false" />. The default is <see langword="false" />.
  103. </value>
  104. </member>
  105. <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ExpandProperties">
  106. <summary>
  107. Gets or sets a value indicating whether property references should
  108. be expanded.
  109. </summary>
  110. <value>
  111. <see langword="true" /> if properties should be expanded; otherwise
  112. <see langword="false" />. The default is <see langword="true" />.
  113. </value>
  114. </member>
  115. <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ProcessXml">
  116. <summary>
  117. Used to specify how this attribute will be handled as the XML is
  118. parsed and given to the element.
  119. </summary>
  120. <value>
  121. <see langword="true" /> if XML should be processed; otherwise
  122. <see langword="false" />. The default is <see langword="true" />.
  123. </value>
  124. </member>
  125. <member name="T:NAnt.Core.Attributes.BuildElementArrayAttribute">
  126. <summary>
  127. Indicates that property should be treated as a XML arrayList
  128. </summary>
  129. <remarks>
  130. <para>
  131. Should only be applied to properties exposing strongly typed arrays or
  132. strongly typed collections.
  133. </para>
  134. <para>
  135. The XML format is like this:
  136. <code>
  137. <![CDATA[
  138. <task>
  139. <elementName ... />
  140. <elementName ... />
  141. <elementName ... />
  142. <elementName ... />
  143. </task>
  144. ]]>
  145. </code>
  146. </para>
  147. </remarks>
  148. </member>
  149. <member name="T:NAnt.Core.Attributes.BuildElementAttribute">
  150. <summary>
  151. Indicates that the property should be treated as an XML element and
  152. further processing should be done.
  153. </summary>
  154. <remarks>
  155. <para>
  156. The XML format is like this:
  157. <code>
  158. <![CDATA[
  159. <task>
  160. <elementName ...>
  161. <morestuff />
  162. </elementName>
  163. </task>
  164. ]]>
  165. </code>
  166. </para>
  167. </remarks>
  168. </member>
  169. <member name="M:NAnt.Core.Attributes.BuildElementAttribute.#ctor(System.String)">
  170. <summary>
  171. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> with the
  172. specified name.
  173. </summary>
  174. <param name="name">The name of the attribute.</param>
  175. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  176. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  177. </member>
  178. <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Name">
  179. <summary>
  180. Gets or sets the name of the attribute.
  181. </summary>
  182. <value>
  183. The name of the attribute.
  184. </value>
  185. </member>
  186. <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Required">
  187. <summary>
  188. Gets or sets a value indicating whether the attribute is required.
  189. </summary>
  190. <value>
  191. <see langword="true" /> if the attribute is required; otherwise,
  192. <see langword="false" />. The default is <see langword="false" />.
  193. </value>
  194. </member>
  195. <member name="P:NAnt.Core.Attributes.BuildElementAttribute.ProcessXml">
  196. <summary>
  197. Used to specify how this element will be handled as the XML is parsed
  198. and given to the element.
  199. </summary>
  200. <value>
  201. <see langword="true" /> if XML should be processed; otherwise
  202. <see langword="false" />. The default is <see langword="true" />.
  203. </value>
  204. </member>
  205. <member name="M:NAnt.Core.Attributes.BuildElementArrayAttribute.#ctor(System.String)">
  206. <summary>
  207. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementArrayAttribute"/>
  208. with the specified name.
  209. </summary>
  210. <param name="name">The name of the attribute.</param>
  211. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  212. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  213. </member>
  214. <member name="P:NAnt.Core.Attributes.BuildElementArrayAttribute.ElementType">
  215. <summary>
  216. Gets or sets the type of objects that this container holds.
  217. </summary>
  218. <value>
  219. The type of the elements that this container holds.
  220. </value>
  221. <remarks>
  222. <para>
  223. This can be used for validation and schema generation.
  224. </para>
  225. <para>
  226. If not specified, the type of the elements will be determined using
  227. reflection.
  228. </para>
  229. </remarks>
  230. <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null"/>.</exception>
  231. </member>
  232. <member name="T:NAnt.Core.Attributes.BuildElementCollectionAttribute">
  233. <summary>
  234. Indicates that the property should be treated as a container for a
  235. collection of build elements.
  236. </summary>
  237. <remarks>
  238. <para>
  239. Should only be applied to properties exposing strongly typed arrays or
  240. strongly typed collections.
  241. </para>
  242. <para>
  243. The XML format is like this:
  244. <code>
  245. <![CDATA[
  246. <task>
  247. <collectionName>
  248. <elementName ... />
  249. <elementName ... />
  250. <elementName ... />
  251. <elementName ... />
  252. </collectionName>
  253. </task>
  254. ]]>
  255. </code>
  256. </para>
  257. </remarks>
  258. </member>
  259. <member name="M:NAnt.Core.Attributes.BuildElementCollectionAttribute.#ctor(System.String,System.String)">
  260. <summary>
  261. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementCollectionAttribute"/> with the
  262. specified name and child element name.
  263. </summary>
  264. <param name="collectionName">The name of the collection.</param>
  265. <param name="childName">The name of the child elements in the collection</param>
  266. <exception cref="T:System.ArgumentNullException"><paramref name="childName"/> is <see langword="null"/>.</exception>
  267. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="childName"/> is a zero-length <see cref="T:System.String"/>.</exception>
  268. </member>
  269. <member name="P:NAnt.Core.Attributes.BuildElementCollectionAttribute.ChildElementName">
  270. <summary>
  271. The name of the child element within the collection.
  272. </summary>
  273. <value>
  274. The name to check for in the XML of the elements in the collection.
  275. </value>
  276. <remarks>
  277. This can be used for validation and schema generation.
  278. </remarks>
  279. </member>
  280. <member name="T:NAnt.Core.Attributes.DateTimeValidatorAttribute">
  281. <summary>
  282. Used to indicate that a property should be able to be converted into a
  283. <see cref="T:System.DateTime"/>.
  284. </summary>
  285. </member>
  286. <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.#ctor">
  287. <summary>
  288. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.DateTimeValidatorAttribute"/>
  289. class.
  290. </summary>
  291. </member>
  292. <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.Validate(System.Object)">
  293. <summary>
  294. Checks if the specified value can be converted to a <see cref="T:System.DateTime"/>.
  295. </summary>
  296. <param name="value">The value to be checked.</param>
  297. <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> cannot be converted to a <see cref="T:System.DateTime"/>.</exception>
  298. </member>
  299. <member name="T:NAnt.Core.Attributes.ElementNameAttribute">
  300. <summary>
  301. Indicates that class should be treated as a NAnt element.
  302. </summary>
  303. <remarks>
  304. Attach this attribute to a subclass of Element to have NAnt be able
  305. to recognize it. The name should be short but must not confict
  306. with any other element already in use.
  307. </remarks>
  308. </member>
  309. <member name="M:NAnt.Core.Attributes.ElementNameAttribute.#ctor(System.String)">
  310. <summary>
  311. Initializes a new instance of the <see cre="ElementNameAttribute"/>
  312. with the specified name.
  313. </summary>
  314. <param name="name">The name of the element.</param>
  315. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  316. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  317. </member>
  318. <member name="P:NAnt.Core.Attributes.ElementNameAttribute.Name">
  319. <summary>
  320. Gets or sets the name of the element.
  321. </summary>
  322. <value>
  323. The name of the element.
  324. </value>
  325. </member>
  326. <member name="T:NAnt.Core.Attributes.FileSetAttribute">
  327. <summary>
  328. Indicates that a property should be treated as a XML file set for the
  329. task.
  330. </summary>
  331. </member>
  332. <member name="M:NAnt.Core.Attributes.FileSetAttribute.#ctor(System.String)">
  333. <summary>
  334. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FileSetAttribute"/> with the
  335. specified name.
  336. </summary>
  337. <param name="name">The name of the attribute.</param>
  338. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  339. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  340. </member>
  341. <member name="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute">
  342. <summary>
  343. Indicates that the value of the property to which the attribute is
  344. assigned, can be configured on the framework-level in the NAnt application
  345. configuration file.
  346. </summary>
  347. <example>
  348. <para>
  349. The following example shows a property of which the value can be
  350. configured for a specific framework in the NAnt configuration file.
  351. </para>
  352. <code lang="C#">
  353. [FrameworkConfigurable("exename", Required=true)]
  354. public virtual string ExeName {
  355. get { return _exeName; }
  356. set { _exeName = value; }
  357. }
  358. </code>
  359. </example>
  360. </member>
  361. <member name="M:NAnt.Core.Attributes.FrameworkConfigurableAttribute.#ctor(System.String)">
  362. <summary>
  363. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute"/>
  364. with the specified attribute name.
  365. </summary>
  366. <param name="name">The name of the framework configuration attribute.</param>
  367. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception>
  368. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  369. </member>
  370. <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Name">
  371. <summary>
  372. Gets or sets the name of the framework configuration attribute.
  373. </summary>
  374. <value>The name of the framework configuration attribute.</value>
  375. </member>
  376. <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Required">
  377. <summary>
  378. Gets or sets a value indicating whether the configuration attribute
  379. is required.
  380. </summary>
  381. <value>
  382. <see langword="true" /> if the configuration attribute is required;
  383. otherwise, <see langword="true" />. The default is <see langword="false" />.
  384. </value>
  385. </member>
  386. <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.ExpandProperties">
  387. <summary>
  388. Gets or sets a value indicating whether property references should
  389. be expanded.
  390. </summary>
  391. <value>
  392. <see langword="true" /> if properties should be expanded; otherwise
  393. <see langword="false" />. The default is <see langword="true" />.
  394. </value>
  395. </member>
  396. <member name="T:NAnt.Core.Attributes.FunctionAttribute">
  397. <summary>
  398. Indicates that the method should be exposed as a function in NAnt build
  399. files.
  400. </summary>
  401. <remarks>
  402. Attach this attribute to a method of a class that derives from
  403. <see cref="T:NAnt.Core.FunctionSetBase"/> to have NAnt be able to recognize it.
  404. </remarks>
  405. </member>
  406. <member name="M:NAnt.Core.Attributes.FunctionAttribute.#ctor(System.String)">
  407. <summary>
  408. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionAttribute"/>
  409. class with the specified name.
  410. </summary>
  411. <param name="name">The name of the function.</param>
  412. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  413. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  414. </member>
  415. <member name="P:NAnt.Core.Attributes.FunctionAttribute.Name">
  416. <summary>
  417. Gets or sets the name of the function.
  418. </summary>
  419. <value>
  420. The name of the function.
  421. </value>
  422. </member>
  423. <member name="T:NAnt.Core.Attributes.FunctionSetAttribute">
  424. <summary>
  425. Indicates that class should be treated as a set of functions.
  426. </summary>
  427. <remarks>
  428. Attach this attribute to a class that derives from <see cref="T:NAnt.Core.FunctionSetBase"/>
  429. to have NAnt be able to recognize it as containing custom functions.
  430. </remarks>
  431. </member>
  432. <member name="M:NAnt.Core.Attributes.FunctionSetAttribute.#ctor(System.String,System.String)">
  433. <summary>
  434. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionSetAttribute"/>
  435. class with the specified name.
  436. </summary>
  437. <param name="prefix">The prefix used to distinguish the functions.</param>
  438. <param name="category">The category of the functions.</param>
  439. <exception cref="T:System.ArgumentNullException">
  440. <para><paramref name="prefix"/> is <see langword="null"/>.</para>
  441. <para>-or-</para>
  442. <para><paramref name="category"/> is <see langword="null"/>.</para>
  443. </exception>
  444. <exception cref="T:System.ArgumentOutOfRangeException">
  445. <para><paramref name="prefix"/> is a zero-length <see cref="T:System.String"/>.</para>
  446. <para>-or-</para>
  447. <para><paramref name="category"/> is a zero-length <see cref="T:System.String"/>.</para>
  448. </exception>
  449. </member>
  450. <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Category">
  451. <summary>
  452. Gets or sets the category of the function set.
  453. </summary>
  454. <value>
  455. The name of the category of the function set.
  456. </value>
  457. <remarks>
  458. This will be displayed in the user docs.
  459. </remarks>
  460. </member>
  461. <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Prefix">
  462. <summary>
  463. Gets or sets the prefix of all functions in this function set.
  464. </summary>
  465. <value>
  466. The prefix of the functions in this function set.
  467. </value>
  468. </member>
  469. <member name="T:NAnt.Core.Attributes.Int32ValidatorAttribute">
  470. <summary>
  471. Indicates that property should be able to be converted into a <see cref="T:System.Int32"/>
  472. within the given range.
  473. </summary>
  474. </member>
  475. <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor">
  476. <summary>
  477. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/>
  478. class.
  479. </summary>
  480. </member>
  481. <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor(System.Int32,System.Int32)">
  482. <summary>
  483. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/>
  484. class with the specied minimum and maximum values.
  485. </summary>
  486. <param name="minValue">The minimum value.</param>
  487. <param name="maxValue">The maximum value.</param>
  488. </member>
  489. <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.Validate(System.Object)">
  490. <summary>
  491. Checks whether the specified value can be converted to an <see cref="T:System.Int32"/>
  492. and whether the value lies within the range defined by the <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/>
  493. and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/> properties.
  494. </summary>
  495. <param name="value">The value to be checked.</param>
  496. <exception cref="T:NAnt.Core.ValidationException">
  497. <para>
  498. <paramref name="value"/> cannot be converted to an <see cref="T:System.Int32"/>.
  499. </para>
  500. <para>-or-</para>
  501. <para>
  502. <paramref name="value"/> is not in the range defined by <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/>
  503. and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/>.
  504. </para>
  505. </exception>
  506. </member>
  507. <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue">
  508. <summary>
  509. Gets or sets the minimum value.
  510. </summary>
  511. <value>
  512. The minimum value. The default is <see cref="F:System.Int32.MinValue"/>.
  513. </value>
  514. </member>
  515. <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue">
  516. <summary>
  517. Gets or sets the maximum value.
  518. </summary>
  519. <value>
  520. The maximum value. The default is <see cref="F:System.Int32.MaxValue"/>.
  521. </value>
  522. </member>
  523. <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.Base">
  524. <summary>
  525. The base of the number to validate, which must be 2, 8, 10, or 16.
  526. </summary>
  527. <value>
  528. The base of the number to validate.
  529. </value>
  530. <remarks>
  531. The default is 10.
  532. </remarks>
  533. </member>
  534. <member name="T:NAnt.Core.Attributes.LocationType">
  535. <summary>
  536. Defines possible locations in which a task executable can be located.
  537. </summary>
  538. </member>
  539. <member name="F:NAnt.Core.Attributes.LocationType.FrameworkDir">
  540. <summary>
  541. Locates the task executable in the current Framework directory.
  542. </summary>
  543. </member>
  544. <member name="F:NAnt.Core.Attributes.LocationType.FrameworkSdkDir">
  545. <summary>
  546. Locates the task executable in the current Framework SDK directory.
  547. </summary>
  548. </member>
  549. <member name="T:NAnt.Core.Attributes.ProgramLocationAttribute">
  550. <summary>
  551. Indicates the location that a task executable can be located in.
  552. </summary>
  553. <remarks>
  554. <para>
  555. When applied to a task deriving from <see cref="T:NAnt.Core.Tasks.ExternalProgramBase"/>,
  556. the program to execute will first be searched for in the designated
  557. location.
  558. </para>
  559. <para>
  560. If the program does not exist in that location, and the file name is
  561. not an absolute path then the list of tool paths of the current
  562. target framework will be searched (in the order in which they are
  563. defined in the NAnt configuration file).
  564. </para>
  565. </remarks>
  566. </member>
  567. <member name="M:NAnt.Core.Attributes.ProgramLocationAttribute.#ctor(NAnt.Core.Attributes.LocationType)">
  568. <summary>
  569. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/>
  570. with the specified location.
  571. </summary>
  572. <param type="type">The <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the attribute.</param>
  573. </member>
  574. <member name="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType">
  575. <summary>
  576. Gets or sets the <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the task.
  577. </summary>
  578. <value>
  579. The location type of the task to which the attribute is assigned.
  580. </value>
  581. </member>
  582. <member name="T:NAnt.Core.Attributes.StringValidatorAttribute">
  583. <summary>
  584. Used to indicate whether a <see cref="T:System.String"/> property should allow
  585. an empty string value or not.
  586. </summary>
  587. </member>
  588. <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.#ctor">
  589. <summary>
  590. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>
  591. class.
  592. </summary>
  593. </member>
  594. <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.Validate(System.Object)">
  595. <summary>
  596. Checks if the specified value adheres to the rules defined by the
  597. properties of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>.
  598. </summary>
  599. <param name="value">The value to be checked.</param>
  600. <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>
  601. </member>
  602. <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.AllowEmpty">
  603. <summary>
  604. Gets or sets a value indicating whether an empty string or
  605. <see langword="null" /> should be a considered a valid value.
  606. </summary>
  607. <value>
  608. <see langword="true" /> if an empty string or <see langword="null" />
  609. should be considered a valid value; otherwise, <see langword="false" />.
  610. The default is <see langword="true" />.
  611. </value>
  612. </member>
  613. <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.Expression">
  614. <summary>
  615. Gets or sets a regular expression. The string will be validated to
  616. determine if it matches the expression.
  617. </summary>
  618. <value>
  619. <see cref="N:System.Text.RegularExpressions"/>
  620. </value>
  621. </member>
  622. <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.ExpressionErrorMessage">
  623. <summary>
  624. An optional error message that can be used to better describe the
  625. regular expression error.
  626. </summary>
  627. </member>
  628. <member name="T:NAnt.Core.Attributes.TaskAttributeAttribute">
  629. <summary>
  630. Indicates that property should be treated as a XML attribute for the
  631. task.
  632. </summary>
  633. <example>
  634. Examples of how to specify task attributes
  635. <code>
  636. // task XmlType default is string
  637. [TaskAttribute("out", Required=true)]
  638. string _out = null; // assign default value here
  639. [TaskAttribute("optimize")]
  640. [BooleanValidator()]
  641. // during ExecuteTask you can safely use Convert.ToBoolean(_optimize)
  642. string _optimize = Boolean.FalseString;
  643. [TaskAttribute("warnlevel")]
  644. [Int32Validator(0,4)] // limit values to 0-4
  645. // during ExecuteTask you can safely use Convert.ToInt32(_optimize)
  646. string _warnlevel = "0";
  647. [BuildElement("sources")]
  648. FileSet _sources = new FileSet();
  649. </code>
  650. NOTE: Attribute values must be of type of string if you want
  651. to be able to have macros. The field stores the exact value during
  652. Initialize. Just before ExecuteTask is called NAnt will expand
  653. all the macros with the current values.
  654. </example>
  655. </member>
  656. <member name="M:NAnt.Core.Attributes.TaskAttributeAttribute.#ctor(System.String)">
  657. <summary>
  658. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskAttributeAttribute"/>
  659. with the specified attribute name.
  660. </summary>
  661. <param name="name">The name of the task attribute.</param>
  662. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception>
  663. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  664. </member>
  665. <member name="T:NAnt.Core.Attributes.TaskNameAttribute">
  666. <summary>
  667. Indicates that class should be treated as a task.
  668. </summary>
  669. <remarks>
  670. Attach this attribute to a subclass of Task to have NAnt be able
  671. to recognize it. The name should be short but must not confict
  672. with any other task already in use.
  673. </remarks>
  674. </member>
  675. <member name="M:NAnt.Core.Attributes.TaskNameAttribute.#ctor(System.String)">
  676. <summary>
  677. Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskNameAttribute"/>
  678. with the specified name.
  679. </summary>
  680. <param name="name">The name of the task.</param>
  681. <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
  682. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
  683. </member>
  684. <member name="T:NAnt.Core.Element">
  685. <summary>
  686. Models a NAnt XML element in the build file.
  687. </summary>
  688. <remarks>
  689. <para>
  690. Automatically validates attributes in the element based on attributes
  691. applied to members in derived classes.
  692. </para>
  693. </remarks>
  694. </member>
  695. <member name="M:NAnt.Core.Element.#ctor">
  696. <summary>
  697. Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class.
  698. </summary>
  699. </member>
  700. <member name="M:NAnt.Core.Element.#ctor(NAnt.Core.Element)">
  701. <summary>
  702. Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class
  703. from the specified element.
  704. </summary>
  705. <param name="e">The element that should be used to create a new instance of the <see cref="T:NAnt.Core.Element"/> class.</param>
  706. </member>
  707. <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode)">
  708. <summary>
  709. Performs default initialization.
  710. </summary>
  711. <remarks>
  712. Derived classes that wish to add custom initialization should override
  713. the <see cref="M:NAnt.Core.Element.Initialize"/> method.
  714. </remarks>
  715. </member>
  716. <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String)">
  717. <summary>
  718. Logs a message with the given priority.
  719. </summary>
  720. <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
  721. <param name="message">The message to be logged.</param>
  722. <remarks>
  723. The actual logging is delegated to the project.
  724. </remarks>
  725. </member>
  726. <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String,System.Object[])">
  727. <summary>
  728. Logs a message with the given priority.
  729. </summary>
  730. <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
  731. <param name="message">The message to log, containing zero or more format items.</param>
  732. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  733. <remarks>
  734. The actual logging is delegated to the project.
  735. </remarks>
  736. </member>
  737. <member name="M:NAnt.Core.Element.InitializeElement(System.Xml.XmlNode)">
  738. <summary>
  739. Derived classes should override to this method to provide extra
  740. initialization and validation not covered by the base class.
  741. </summary>
  742. <param name="elementNode">The XML node of the element to use for initialization.</param>
  743. </member>
  744. <member name="M:NAnt.Core.Element.Initialize">
  745. <summary>
  746. Derived classes should override to this method to provide extra
  747. initialization and validation not covered by the base class.
  748. </summary>
  749. <remarks>
  750. Access to the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize
  751. this <see cref="T:NAnt.Core.Element"/> is available through <see cref="P:NAnt.Core.Element.XmlNode"/>.
  752. </remarks>
  753. </member>
  754. <member name="M:NAnt.Core.Element.CopyTo(NAnt.Core.Element)">
  755. <summary>
  756. Copies all instance data of the <see cref="T:NAnt.Core.Element"/> to a given
  757. <see cref="T:NAnt.Core.Element"/>.
  758. </summary>
  759. </member>
  760. <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
  761. <summary>
  762. Performs initialization using the given set of properties.
  763. </summary>
  764. </member>
  765. <member name="M:NAnt.Core.Element.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
  766. <summary>
  767. Initializes all build attributes and child elements.
  768. </summary>
  769. </member>
  770. <member name="M:NAnt.Core.Element.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)">
  771. <summary>
  772. Locates the XML node for the specified attribute in the project
  773. configuration node.
  774. </summary>
  775. <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param>
  776. <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>
  777. <returns>
  778. The XML configuration node for the specified attribute, or
  779. <see langword="null" /> if no corresponding XML node could be
  780. located.
  781. </returns>
  782. <remarks>
  783. If there's a valid current framework, the configuration section for
  784. that framework will first be searched. If no corresponding
  785. configuration node can be located in that section, the framework-neutral
  786. section of the project configuration node will be searched.
  787. </remarks>
  788. </member>
  789. <member name="M:NAnt.Core.Element.GetElementNameFromType(System.Type)">
  790. <summary>
  791. Returns the <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> of the
  792. <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned to the specified
  793. <see cref="T:System.Type"/>.
  794. </summary>
  795. <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>
  796. <returns>
  797. The <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> assigned to the specified
  798. <see cref="T:System.Type"/> or a null reference is no <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/>
  799. is assigned to the <paramref name="type"/>.
  800. </returns>
  801. </member>
  802. <member name="P:NAnt.Core.Element.Parent">
  803. <summary>
  804. Gets or sets the parent of the element.
  805. </summary>
  806. <value>
  807. The parent of the element.
  808. </value>
  809. <remarks>
  810. This will be the parent <see cref="T:NAnt.Core.Task"/>, <see cref="T:NAnt.Core.Target"/>, or
  811. <see cref="P:NAnt.Core.Element.Project"/> depending on where the element is defined.
  812. </remarks>
  813. </member>
  814. <member name="P:NAnt.Core.Element.Name">
  815. <summary>
  816. Gets the name of the XML element used to initialize this element.
  817. </summary>
  818. <value>
  819. The name of the XML element used to initialize this element.
  820. </value>
  821. </member>
  822. <member name="P:NAnt.Core.Element.Project">
  823. <summary>
  824. Gets or sets the <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs.
  825. </summary>
  826. <value>
  827. The <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs.
  828. </value>
  829. </member>
  830. <member name="P:NAnt.Core.Element.Properties">
  831. <summary>
  832. Gets the properties local to this <see cref="T:NAnt.Core.Element"/> and the
  833. <see cref="P:NAnt.Core.Element.Project"/>.
  834. </summary>
  835. <value>
  836. The properties local to this <see cref="T:NAnt.Core.Element"/> and the <see cref="P:NAnt.Core.Element.Project"/>.
  837. </value>
  838. </member>
  839. <member name="P:NAnt.Core.Element.NamespaceManager">
  840. <summary>
  841. Gets or sets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
  842. </summary>
  843. <value>
  844. The <see cref="T:System.Xml.XmlNamespaceManager"/>.
  845. </value>
  846. <remarks>
  847. The <see cref="P:NAnt.Core.Element.NamespaceManager"/> defines the current namespace
  848. scope and provides methods for looking up namespace information.
  849. </remarks>
  850. </member>
  851. <member name="P:NAnt.Core.Element.XmlNode">
  852. <summary>
  853. Gets or sets the XML node of the element.
  854. </summary>
  855. <value>
  856. The XML node of the element.
  857. </value>
  858. </member>
  859. <member name="P:NAnt.Core.Element.Location">
  860. <summary>
  861. Gets or sets the location in the build file where the element is
  862. defined.
  863. </summary>
  864. <value>
  865. The location in the build file where the element is defined.
  866. </value>
  867. </member>
  868. <member name="P:NAnt.Core.Element.CustomXmlProcessing">
  869. <summary>
  870. Gets a value indicating whether the element is performing additional
  871. processing using the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to
  872. initialize the element.
  873. </summary>
  874. <value>
  875. <see langword="false"/>.
  876. </value>
  877. <remarks>
  878. <para>
  879. Elements that need to perform additional processing of the
  880. <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize the element, should
  881. override this property and return <see langword="true"/>.
  882. </para>
  883. <para>
  884. When <see langword="true"/>, no build errors will be reported for
  885. unknown nested build elements.
  886. </para>
  887. </remarks>
  888. </member>
  889. <member name="T:NAnt.Core.Element.AttributeConfigurator">
  890. <summary>
  891. Configures an <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using meta-data provided by
  892. assigned attributes.
  893. </summary>
  894. </member>
  895. <member name="M:NAnt.Core.Element.AttributeConfigurator.#ctor(NAnt.Core.Element,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
  896. <summary>
  897. Initializes a new instance of the <see cref="T:NAnt.Core.Element.AttributeConfigurator"/>
  898. class for the given <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>.
  899. </summary>
  900. <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>
  901. <param name="elementNode">The <see cref="P:NAnt.Core.Element.XmlNode"/> to initialize the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> with.</param>
  902. <param name="properties">The <see cref="T:NAnt.Core.PropertyDictionary"/> to use for property expansion.</param>
  903. <param name="targetFramework">The framework that the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> should target.</param>
  904. <exception cref="T:System.ArgumentNullException">
  905. <para><paramref name="element"/> is <see langword="null"/>.</para>
  906. <para>-or-</para>
  907. <para><paramref name="elementNode"/> is <see langword="null"/>.</para>
  908. <para>-or-</para>
  909. <para><paramref name="properties"/> is <see langword="null"/>.</para>
  910. </exception>
  911. </member>
  912. <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)">
  913. <summary>
  914. Creates a child <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using property set/get methods.
  915. </summary>
  916. <param name="propInf">The <see cref="T:System.Reflection.PropertyInfo"/> instance that represents the property of the current class.</param>
  917. <param name="getter">A <see cref="T:System.Reflection.MethodInfo"/> representing the get accessor for the property.</param>
  918. <param name="setter">A <see cref="T:System.Reflection.MethodInfo"/> representing the set accessor for the property.</param>
  919. <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>
  920. <param name="properties">The collection of property values to use for macro expansion.</param>
  921. <param name="framework">The <see cref="T:NAnt.Core.FrameworkInfo"/> from which to obtain framework-specific information.</param>
  922. <returns>The <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> child.</returns>
  923. </member>
  924. <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateAttributeSetter(System.Type)">
  925. <summary>
  926. Creates an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given
  927. <see cref="T:System.Type"/>.
  928. </summary>
  929. <param name="attributeType">The <see cref="T:System.Type"/> for which an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> should be created.</param>
  930. <returns>
  931. An <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given <see cref="T:System.Type"/>.
  932. </returns>
  933. </member>
  934. <member name="F:NAnt.Core.Element.AttributeConfigurator._element">
  935. <summary>
  936. Holds the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that should be initialized.
  937. </summary>
  938. </member>
  939. <member name="F:NAnt.Core.Element.AttributeConfigurator._elementXml">
  940. <summary>
  941. Holds the <see cref="P:NAnt.Core.Element.XmlNode"/> that should be used to initialize
  942. the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>.
  943. </summary>
  944. </member>
  945. <member name="F:NAnt.Core.Element.AttributeConfigurator._properties">
  946. <summary>
  947. Holds the dictionary that should be used for property
  948. expansion.
  949. </summary>
  950. </member>
  951. <member name="F:NAnt.Core.Element.AttributeConfigurator._targetFramework">
  952. <summary>
  953. Holds the framework that should be targeted by the
  954. <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that we're configuring, or
  955. <see langword="null"/> if there's no current target
  956. framework.
  957. </summary>
  958. </member>
  959. <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedAttributes">
  960. <summary>
  961. Holds the names of the attributes that still need to be
  962. processed.
  963. </summary>
  964. </member>
  965. <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedChildNodes">
  966. <summary>
  967. Holds the names of the child nodes that still need to be
  968. processed.
  969. </summary>
  970. </member>
  971. <member name="F:NAnt.Core.Element.AttributeConfigurator.logger">
  972. <summary>
  973. Holds the logger for the current class.
  974. </summary>
  975. </member>
  976. <member name="F:NAnt.Core.Element.AttributeConfigurator.AttributeSetters">
  977. <summary>
  978. Holds the cache of <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> instances.
  979. </summary>
  980. </member>
  981. <member name="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager">
  982. <summary>
  983. Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
  984. </summary>
  985. <value>
  986. The <see cref="T:System.Xml.XmlNamespaceManager"/>.
  987. </value>
  988. <remarks>
  989. The <see cref="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager"/> defines the current namespace
  990. scope and provides methods for looking up namespace information.
  991. </remarks>
  992. </member>
  993. <member name="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter">
  994. <summary>
  995. Internal interface used for setting element attributes.
  996. </summary>
  997. </member>
  998. <member name="T:NAnt.Core.Configuration.DirList">
  999. <summary>
  1000. Represents an explicitly named list of directories.
  1001. </summary>
  1002. <remarks>
  1003. A <see cref="T:NAnt.Core.Configuration.DirList"/> is useful when you want to capture a list of
  1004. directories regardless whether they currently exist.
  1005. </remarks>
  1006. </member>
  1007. <member name="P:NAnt.Core.Configuration.DirList.Directory">
  1008. <summary>
  1009. The base of the directory of this dirlist. The default is the project
  1010. base directory.
  1011. </summary>
  1012. </member>
  1013. <member name="P:NAnt.Core.Configuration.ManagedExecutionMode.Environment">
  1014. <summary>
  1015. Gets the collection of environment variables that should be passed
  1016. to external programs that are launched.
  1017. </summary>
  1018. <value>
  1019. <summary>
  1020. The collection of environment variables that should be passed
  1021. to external programs that are launched.
  1022. </summary>
  1023. </value>
  1024. </member>
  1025. <member name="P:NAnt.Core.Configuration.RuntimeEngine.Arguments">
  1026. <summary>
  1027. The command-line arguments for the runtime engine.
  1028. </summary>
  1029. </member>
  1030. <member name="T:NAnt.Core.Extensibility.ExtensionAssembly">
  1031. <summary>
  1032. Represents an <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> in which one or more extensions
  1033. are found.
  1034. </summary>
  1035. </member>
  1036. <member name="M:NAnt.Core.Extensibility.ExtensionAssembly.#ctor(System.Reflection.Assembly)">
  1037. <summary>
  1038. Initializes a new instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>
  1039. class for a given <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/>.
  1040. </summary>
  1041. <remarks>
  1042. The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> instance is not cached for
  1043. future use. If this is required, use <see cref="M:NAnt.Core.Extensibility.ExtensionAssembly.Create(System.Reflection.Assembly)"/>.
  1044. </remarks>
  1045. <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>
  1046. </member>
  1047. <member name="M:NAnt.Core.Extensibility.ExtensionAssembly.Create(System.Reflection.Assembly)">
  1048. <summary>
  1049. Creates an <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the specified
  1050. <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> and caches it for future use.
  1051. </summary>
  1052. <remarks>
  1053. If an <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the same assembly is
  1054. available in the cache, then this cached instance is returned.
  1055. </remarks>
  1056. <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>
  1057. <returns>
  1058. The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the specified <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/>.
  1059. </returns>
  1060. </member>
  1061. <member name="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly">
  1062. <summary>
  1063. Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> containing extensions.
  1064. </summary>
  1065. </member>
  1066. <member name="M:NAnt.Core.Extensibility.ExtensionBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly)">
  1067. <summary>
  1068. Initializes a instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionBuilder"/>
  1069. class for an extension in a given <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/>.
  1070. </summary>
  1071. <param name="extensionAssembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/> in which the extension is found.</param>
  1072. <exception cref="T:System.ArgumentNullException"><paramref name="extensionAssembly"/> is <see langword="null"/>.</exception>
  1073. </member>
  1074. <member name="M:NAnt.Core.Extensibility.ExtensionBuilder.#ctor(System.Reflection.Assembly)">
  1075. <summary>
  1076. Initializes a instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionBuilder"/>
  1077. class for an extension in a given <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/>.
  1078. </summary>
  1079. <param name="assembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> in which the extension is found.</param>
  1080. <exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is <see langword="null"/>.</exception>
  1081. </member>
  1082. <member name="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly">
  1083. <summary>
  1084. Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/> in which the extension
  1085. was found.
  1086. </summary>
  1087. </member>
  1088. <member name="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly">
  1089. <summary>
  1090. Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> from which the extension will
  1091. be created.
  1092. </summary>
  1093. <value>
  1094. The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> containing the extension.
  1095. </value>
  1096. </member>
  1097. <member name="M:NAnt.Core.Extensibility.PluginConsumerAttribute.#ctor(System.Type)">
  1098. <summary>
  1099. Initializes a new instance of the <see cref="T:NAnt.Core.Extensibility.PluginConsumerAttribute"/>
  1100. with the specified type.
  1101. </summary>
  1102. <param name="type">The type of the <see cref="T:NAnt.Core.Extensibility.IPlugin"/> to consume.</param>
  1103. <exception cref="T:System.ArgumentNullException"><paramref name="type"/> is <see langword="null"/>.</exception>
  1104. </member>
  1105. <member name="T:NAnt.Core.Extensibility.PluginScanner">
  1106. <summary>
  1107. Responsible for scanning types for plugins, and maintaining a cache of
  1108. <see cref="T:NAnt.Core.Extensibility.PluginBuilder"/> instances.
  1109. </summary>
  1110. </member>
  1111. <member name="M:NAnt.Core.Extensibility.PluginScanner.ScanTypeForPlugins(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
  1112. <summary>
  1113. Scans a given <see cref="T:System.Type"/> for plugins.
  1114. </summary>
  1115. <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
  1116. <param name="type">The <see cref="T:System.Type"/> to scan.</param>
  1117. <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
  1118. <returns>
  1119. <see langword="true"/> if <paramref name="type"/> represents a
  1120. <see cref="T:NAnt.Core.Extensibility.IPlugin"/>; otherwise, <see langword="false"/>.
  1121. </returns>
  1122. </member>
  1123. <member name="M:NAnt.Core.Extensibility.PluginScanner.RegisterPlugins(NAnt.Core.Extensibility.IPluginConsumer)">
  1124. <summary>
  1125. Registers matching plugins for the specified <see cref="T:NAnt.Core.Extensibility.IPluginConsumer"/>.
  1126. </summary>
  1127. <param name="consumer">The <see cref="T:NAnt.Core.Extensibility.IPluginConsumer"/> which plugins must be registered for.</param>
  1128. <exception cref="T:System.ArgumentNullException"><paramref name="consumer"/> is <see langword="null"/>.</exception>
  1129. </member>
  1130. <member name="T:NAnt.Core.Filters.ChainableReader">
  1131. <summary>
  1132. Functions as a chainable TextReader
  1133. </summary>
  1134. <remarks>
  1135. Implements a abstraction over a TextReader that allows the class to represent
  1136. either a TextReader or another ChainableReader to which it is chained.
  1137. By passing a ChainableReader as a constructor paramater it is possiable to
  1138. chain many ChainableReaders together. The last ChainableReader in the chain must
  1139. be based on a TextReader.
  1140. </remarks>
  1141. </member>
  1142. <member name="M:NAnt.Core.Filters.ChainableReader.Chain(NAnt.Core.Filters.ChainableReader)">
  1143. <summary>
  1144. Makes it so all calls to Read and Peek are passed the ChainableReader
  1145. passed as a parameter.
  1146. </summary>
  1147. <param name="parentChainedReader">ChainableReader to forward calls to</param>
  1148. </member>
  1149. <member name="M:NAnt.Core.Filters.ChainableReader.Chain(System.IO.TextReader)">
  1150. <summary>
  1151. Makes it so all calls to Read and Peek are passed the TextReader
  1152. passed as a parameter.
  1153. </summary>
  1154. <param name="baseReader">TextReader to forward calls to</param>
  1155. </member>
  1156. <member name="M:NAnt.Core.Filters.ChainableReader.Peek">
  1157. <summary>
  1158. Forwards Peek calls to the TextReader or ChainableReader passed in the corresponding constructor.
  1159. </summary>
  1160. <returns>Character or -1 if end of stream</returns>
  1161. </member>
  1162. <member name="M:NAnt.Core.Filters.ChainableReader.Read">
  1163. <summary>
  1164. Forwards Read calls to the TextReader or ChainableReader passed in the corresponding constructor.
  1165. </summary>
  1166. <returns>
  1167. Character or -1 if end of stream.
  1168. </returns>
  1169. </member>
  1170. <member name="M:NAnt.Core.Filters.ChainableReader.Close">
  1171. <summary>
  1172. Closes the reader.
  1173. </summary>
  1174. </member>
  1175. <member name="M:NAnt.Core.Filters.ChainableReader.Dispose">
  1176. <summary>
  1177. Calls close and supresses the finalizer for the object.
  1178. </summary>
  1179. </member>
  1180. <member name="P:NAnt.Core.Filters.ChainableReader.Base">
  1181. <summary>
  1182. Gets a value indicating if the reader is backed by a stream in the
  1183. chain.
  1184. </summary>
  1185. <value>
  1186. <see langword="true" /> if the reader is backed by a stream;
  1187. otherwise, <see langword="false" />.
  1188. </value>
  1189. </member>
  1190. <member name="T:NAnt.Core.Filters.Filter">
  1191. <summary>
  1192. Allows a file's content to be modified while performing an operation.
  1193. </summary>
  1194. </member>
  1195. <member name="M:NAnt.Core.Filters.Filter.InitializeFilter">
  1196. <summary>
  1197. Called after construction and after properties are set. Allows
  1198. for filter initialization.
  1199. </summary>
  1200. </member>
  1201. <member name="P:NAnt.Core.Filters.Filter.IfDefined">
  1202. <summary>
  1203. If <see langword="true" /> then the filter will be used; otherwise,
  1204. skipped. The default is <see langword="true" />.
  1205. </summary>
  1206. </member>
  1207. <member name="P:NAnt.Core.Filters.Filter.UnlessDefined">
  1208. <summary>
  1209. Opposite of <see cref="P:NAnt.Core.Filters.Filter.IfDefined"/>. If <see langword="false"/>
  1210. then the filter will be executed; otherwise, skipped. The default
  1211. is <see langword="false"/>.
  1212. </summary>
  1213. </member>
  1214. <member name="M:NAnt.Core.Filters.FilterBuilder.#ctor(System.Reflection.Assembly,System.String)">
  1215. <summary>
  1216. Creates a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> class
  1217. for the specified <see cref="T:NAnt.Core.Filters.Filter"/> class in the specified
  1218. <see cref="T:System.Reflection.Assembly"/>.
  1219. </summary>
  1220. <remarks>
  1221. An <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the specified <see cref="T:System.Reflection.Assembly"/>
  1222. is cached for future use.
  1223. </remarks>
  1224. <param name="assembly">The <see cref="T:System.Reflection.Assembly"/> containing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
  1225. <param name="className">The class representing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
  1226. </member>
  1227. <member name="M:NAnt.Core.Filters.FilterBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
  1228. <summary>
  1229. Creates a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> class
  1230. for the specified <see cref="T:NAnt.Core.Filters.Filter"/> class in the specified
  1231. <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.
  1232. </summary>
  1233. <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
  1234. <param name="className">The class representing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
  1235. </member>
  1236. <member name="P:NAnt.Core.Filters.FilterBuilder.ClassName">
  1237. <summary>
  1238. Gets the name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created
  1239. using this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>.
  1240. </summary>
  1241. <value>
  1242. The name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created using
  1243. this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>.
  1244. </value>
  1245. </member>
  1246. <member name="P:NAnt.Core.Filters.FilterBuilder.FilterName">
  1247. <summary>
  1248. Gets the name of the filter which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/>
  1249. can create.
  1250. </summary>
  1251. <value>
  1252. The name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/> can
  1253. create.
  1254. </value>
  1255. </member>
  1256. <member name="T:NAnt.Core.Filters.FilterBuilderCollection">
  1257. <summary>
  1258. Contains a strongly typed collection of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> objects.
  1259. </summary>
  1260. </member>
  1261. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor">
  1262. <summary>
  1263. Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class.
  1264. </summary>
  1265. </member>
  1266. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilderCollection)">
  1267. <summary>
  1268. Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class
  1269. with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> instance.
  1270. </summary>
  1271. </member>
  1272. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilder[])">
  1273. <summary>
  1274. Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class
  1275. with the specified array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
  1276. </summary>
  1277. </member>
  1278. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Add(NAnt.Core.Filters.FilterBuilder)">
  1279. <summary>
  1280. Adds a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to the end of the collection.
  1281. </summary>
  1282. <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to be added to the end of the collection.</param>
  1283. <returns>The position into which the new element was inserted.</returns>
  1284. </member>
  1285. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilder[])">
  1286. <summary>
  1287. Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> array to the end of the collection.
  1288. </summary>
  1289. <param name="items">The array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements to be added to the end of the collection.</param>
  1290. </member>
  1291. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilderCollection)">
  1292. <summary>
  1293. Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to the end of the collection.
  1294. </summary>
  1295. <param name="items">The <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to be added to the end of the collection.</param>
  1296. </member>
  1297. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(NAnt.Core.Filters.FilterBuilder)">
  1298. <summary>
  1299. Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> is in the collection.
  1300. </summary>
  1301. <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to locate in the collection.</param>
  1302. <returns>
  1303. <see langword="true"/> if <paramref name="item"/> is found in the
  1304. collection; otherwise, <see langword="false"/>.
  1305. </returns>
  1306. </member>
  1307. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(System.String)">
  1308. <summary>
  1309. Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified
  1310. task is in the collection.
  1311. </summary>
  1312. <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> should be located in the collection.</param>
  1313. <returns>
  1314. <see langword="true"/> if a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for
  1315. the specified task is found in the collection; otherwise,
  1316. <see langword="false"/>.
  1317. </returns>
  1318. </member>
  1319. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.CopyTo(NAnt.Core.Filters.FilterBuilder[],System.Int32)">
  1320. <summary>
  1321. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  1322. </summary>
  1323. <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>
  1324. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  1325. </member>
  1326. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.IndexOf(NAnt.Core.Filters.FilterBuilder)">
  1327. <summary>
  1328. Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object in the collection.
  1329. </summary>
  1330. <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object for which the index is returned.</param>
  1331. <returns>
  1332. 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.
  1333. </returns>
  1334. </member>
  1335. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Insert(System.Int32,NAnt.Core.Filters.FilterBuilder)">
  1336. <summary>
  1337. Inserts a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> into the collection at the specified index.
  1338. </summary>
  1339. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  1340. <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to insert.</param>
  1341. </member>
  1342. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.GetEnumerator">
  1343. <summary>
  1344. Returns an enumerator that can iterate through the collection.
  1345. </summary>
  1346. <returns>
  1347. A <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> for the entire collection.
  1348. </returns>
  1349. </member>
  1350. <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Remove(NAnt.Core.Filters.FilterBuilder)">
  1351. <summary>
  1352. Removes a member from the collection.
  1353. </summary>
  1354. <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to remove from the collection.</param>
  1355. </member>
  1356. <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.Int32)">
  1357. <summary>
  1358. Gets or sets the element at the specified index.
  1359. </summary>
  1360. <param name="index">The zero-based index of the element to get or set.</param>
  1361. </member>
  1362. <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.String)">
  1363. <summary>
  1364. Gets the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified task.
  1365. </summary>
  1366. <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>
  1367. </member>
  1368. <member name="T:NAnt.Core.Filters.FilterBuilderEnumerator">
  1369. <summary>
  1370. Enumerates the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>.
  1371. </summary>
  1372. </member>
  1373. <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.#ctor(NAnt.Core.Filters.FilterBuilderCollection)">
  1374. <summary>
  1375. Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> class
  1376. with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>.
  1377. </summary>
  1378. <param name="arguments">The collection that should be enumerated.</param>
  1379. </member>
  1380. <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.MoveNext">
  1381. <summary>
  1382. Advances the enumerator to the next element of the collection.
  1383. </summary>
  1384. <returns>
  1385. <see langword="true" /> if the enumerator was successfully advanced
  1386. to the next element; <see langword="false" /> if the enumerator has
  1387. passed the end of the collection.
  1388. </returns>
  1389. </member>
  1390. <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.Reset">
  1391. <summary>
  1392. Sets the enumerator to its initial position, which is before the
  1393. first element in the collection.
  1394. </summary>
  1395. </member>
  1396. <member name="P:NAnt.Core.Filters.FilterBuilderEnumerator.Current">
  1397. <summary>
  1398. Gets the current element in the collection.
  1399. </summary>
  1400. <returns>
  1401. The current element in the collection.
  1402. </returns>
  1403. </member>
  1404. <member name="T:NAnt.Core.Filters.FilterChain">
  1405. <summary>
  1406. Represent a chain of NAnt filters that can be applied to a <see cref="T:NAnt.Core.Task"/>.
  1407. </summary>
  1408. <remarks>
  1409. <para>
  1410. A FilterChain represents a collection of one or more filters that can
  1411. be appled to a <see cref="T:NAnt.Core.Task"/> such as the <see cref="T:NAnt.Core.Tasks.CopyTask"/>.
  1412. In the case of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>, the contents of the copied
  1413. files are filtered through each filter specified in the filter chain.
  1414. Filtering occurs in the order the filters are specified with filtered
  1415. output of one filter feeding into another.
  1416. </para>
  1417. <para>
  1418. :--------:---&gt;:----------:---&gt;:----------: ... :----------:---&gt;:--------:<br/>
  1419. :.Source.:---&gt;:.Filter 1.:---&gt;:.Filter 2.: ... :.Filter n.:---&gt;:.target.:<br/>
  1420. :--------:---&gt;:----------:---&gt;:----------: ... :----------:---&gt;:--------:<br/>
  1421. </para>
  1422. <para>
  1423. A list of all filters that come with NAnt is available <see href="../filters/index.html">here</see>.
  1424. </para>
  1425. <para>
  1426. The following tasks support filtering with a FilterChain:
  1427. </para>
  1428. <list type="bullet">
  1429. <item>
  1430. <description><see cref="T:NAnt.Core.Tasks.CopyTask"/></description>
  1431. </item>
  1432. <item>
  1433. <description><see cref="T:NAnt.Core.Tasks.MoveTask"/></description>
  1434. </item>
  1435. </list>
  1436. </remarks>
  1437. <example>
  1438. <para>
  1439. Replace all occurrences of @NOW@ with the current date/time and
  1440. replace tabs with spaces in all copied files.
  1441. </para>
  1442. <code>
  1443. <![CDATA[
  1444. <property name="NOW" value="${datetime::now()}" />
  1445. <copy todir="out">
  1446. <fileset basedir="in">
  1447. <include name="**/*" />
  1448. </fileset>
  1449. <filterchain>
  1450. <replacetokens>
  1451. <token key="NOW" value="${TODAY}" />
  1452. </replacetokens>
  1453. <tabstospaces />
  1454. </filterchain>
  1455. </copy>
  1456. ]]>
  1457. </code>
  1458. </example>
  1459. </member>
  1460. <member name="T:NAnt.Core.DataTypeBase">
  1461. <summary>
  1462. Provides the abstract base class for types.
  1463. </summary>
  1464. </member>
  1465. <member name="M:NAnt.Core.DataTypeBase.Reset">
  1466. <summary>
  1467. Should be overridden by derived classes. clones the referenced types
  1468. data into the current instance.
  1469. </summary>
  1470. </member>
  1471. <member name="M:NAnt.Core.DataTypeBase.CopyTo(NAnt.Core.DataTypeBase)">
  1472. <summary>
  1473. Copies all instance data of the <see cref="T:NAnt.Core.DataTypeBase"/> to a given
  1474. <see cref="T:NAnt.Core.DataTypeBase"/>.
  1475. </summary>
  1476. </member>
  1477. <member name="P:NAnt.Core.DataTypeBase.ID">
  1478. <summary>
  1479. The ID used to be referenced later.
  1480. </summary>
  1481. </member>
  1482. <member name="P:NAnt.Core.DataTypeBase.RefID">
  1483. <summary>
  1484. The ID to use as the reference.
  1485. </summary>
  1486. </member>
  1487. <member name="P:NAnt.Core.DataTypeBase.CanBeReferenced">
  1488. <summary>
  1489. Gets a value indicating whether a reference to the type can be
  1490. defined.
  1491. </summary>
  1492. <remarks>
  1493. Only types with an <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned
  1494. to it, can be referenced.
  1495. </remarks>
  1496. </member>
  1497. <member name="P:NAnt.Core.DataTypeBase.Name">
  1498. <summary>
  1499. Gets the name of the datatype.
  1500. </summary>
  1501. <value>
  1502. The name of the datatype.
  1503. </value>
  1504. </member>
  1505. <member name="M:NAnt.Core.Filters.FilterChain.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
  1506. <summary>
  1507. Initializes all build attributes and child elements.
  1508. </summary>
  1509. <remarks>
  1510. <see cref="T:NAnt.Core.Filters.FilterChain"/> needs to maintain the order in which the
  1511. filters are specified in the build file.
  1512. </remarks>
  1513. </member>
  1514. <member name="M:NAnt.Core.Filters.FilterChain.GetBaseFilter(NAnt.Core.Filters.PhysicalTextReader)">
  1515. <summary>
  1516. Used to to instantiate and return the chain of stream based filters.
  1517. </summary>
  1518. <param name="physicalTextReader">The <see cref="T:NAnt.Core.Filters.PhysicalTextReader"/> that is the source of input to the filter chain.</param>
  1519. <remarks>
  1520. The <paramref name="physicalTextReader"/> is the first <see cref="T:NAnt.Core.Filters.Filter"/>
  1521. in the chain, which is based on a physical stream that feeds the chain.
  1522. </remarks>
  1523. <returns>
  1524. The last <see cref="T:NAnt.Core.Filters.Filter"/> in the chain.
  1525. </returns>
  1526. </member>
  1527. <member name="P:NAnt.Core.Filters.FilterChain.Filters">
  1528. <summary>
  1529. The filters to apply.
  1530. </summary>
  1531. </member>
  1532. <member name="P:NAnt.Core.Filters.FilterChain.InputEncoding">
  1533. <summary>
  1534. The encoding to assume when filter-copying files. The default is
  1535. system's current ANSI code page.
  1536. </summary>
  1537. </member>
  1538. <member name="T:NAnt.Core.Filters.FilterChain.FilterChainConfigurator">
  1539. <summary>
  1540. Configurator that initializes filters in the order in which they've
  1541. been specified in the build file.
  1542. </summary>
  1543. </member>
  1544. <member name="T:NAnt.Core.Filters.FilterCollection">
  1545. <summary>
  1546. Contains a collection of <see cref="T:NAnt.Core.Filters.Filter"/> elements.
  1547. </summary>
  1548. </member>
  1549. <member name="M:NAnt.Core.Filters.FilterCollection.#ctor">
  1550. <summary>
  1551. Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class.
  1552. </summary>
  1553. </member>
  1554. <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.FilterCollection)">
  1555. <summary>
  1556. Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class
  1557. with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/> instance.
  1558. </summary>
  1559. </member>
  1560. <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.Filter[])">
  1561. <summary>
  1562. Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class
  1563. with the specified array of <see cref="T:NAnt.Core.Filters.Filter"/> instances.
  1564. </summary>
  1565. </member>
  1566. <member name="M:NAnt.Core.Filters.FilterCollection.Add(NAnt.Core.Filters.Filter)">
  1567. <summary>
  1568. Adds a <see cref="T:NAnt.Core.Filters.Filter"/> to the end of the collection.
  1569. </summary>
  1570. <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to be added to the end of the collection.</param>
  1571. <returns>The position into which the new element was inserted.</returns>
  1572. </member>
  1573. <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.Filter[])">
  1574. <summary>
  1575. Adds the elements of a <see cref="T:NAnt.Core.Filters.Filter"/> array to the end of the collection.
  1576. </summary>
  1577. <param name="items">The array of <see cref="T:NAnt.Core.Filters.Filter"/> elements to be added to the end of the collection.</param>
  1578. </member>
  1579. <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.FilterCollection)">
  1580. <summary>
  1581. Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/> to the end of the collection.
  1582. </summary>
  1583. <param name="items">The <see cref="T:NAnt.Core.Filters.FilterCollection"/> to be added to the end of the collection.</param>
  1584. </member>
  1585. <member name="M:NAnt.Core.Filters.FilterCollection.Contains(NAnt.Core.Filters.Filter)">
  1586. <summary>
  1587. Determines whether a <see cref="T:NAnt.Core.Filters.Filter"/> is in the collection.
  1588. </summary>
  1589. <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to locate in the collection.</param>
  1590. <returns>
  1591. <see langword="true"/> if <paramref name="item"/> is found in the
  1592. collection; otherwise, <see langword="false"/>.
  1593. </returns>
  1594. </member>
  1595. <member name="M:NAnt.Core.Filters.FilterCollection.CopyTo(NAnt.Core.Filters.Filter[],System.Int32)">
  1596. <summary>
  1597. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  1598. </summary>
  1599. <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>
  1600. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  1601. </member>
  1602. <member name="M:NAnt.Core.Filters.FilterCollection.IndexOf(NAnt.Core.Filters.Filter)">
  1603. <summary>
  1604. Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.Filter"/> object in the collection.
  1605. </summary>
  1606. <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> object for which the index is returned.</param>
  1607. <returns>
  1608. 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.
  1609. </returns>
  1610. </member>
  1611. <member name="M:NAnt.Core.Filters.FilterCollection.Insert(System.Int32,NAnt.Core.Filters.Filter)">
  1612. <summary>
  1613. Inserts a <see cref="T:NAnt.Core.Filters.Filter"/> into the collection at the specified index.
  1614. </summary>
  1615. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  1616. <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to insert.</param>
  1617. </member>
  1618. <member name="M:NAnt.Core.Filters.FilterCollection.GetEnumerator">
  1619. <summary>
  1620. Returns an enumerator that can iterate through the collection.
  1621. </summary>
  1622. <returns>
  1623. A <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> for the entire collection.
  1624. </returns>
  1625. </member>
  1626. <member name="M:NAnt.Core.Filters.FilterCollection.Remove(NAnt.Core.Filters.Filter)">
  1627. <summary>
  1628. Removes a member from the collection.
  1629. </summary>
  1630. <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to remove from the collection.</param>
  1631. </member>
  1632. <member name="P:NAnt.Core.Filters.FilterCollection.Item(System.Int32)">
  1633. <summary>
  1634. Gets or sets the element at the specified index.
  1635. </summary>
  1636. <param name="index">The zero-based index of the element to get or set.</param>
  1637. </member>
  1638. <member name="T:NAnt.Core.Filters.FilterEnumerator">
  1639. <summary>
  1640. Enumerates the <see cref="T:NAnt.Core.Filters.Filter"/> elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/>.
  1641. </summary>
  1642. </member>
  1643. <member name="M:NAnt.Core.Filters.FilterEnumerator.#ctor(NAnt.Core.Filters.FilterCollection)">
  1644. <summary>
  1645. Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> class
  1646. with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/>.
  1647. </summary>
  1648. <param name="arguments">The collection that should be enumerated.</param>
  1649. </member>
  1650. <member name="M:NAnt.Core.Filters.FilterEnumerator.MoveNext">
  1651. <summary>
  1652. Advances the enumerator to the next element of the collection.
  1653. </summary>
  1654. <returns>
  1655. <see langword="true" /> if the enumerator was successfully advanced
  1656. to the next element; <see langword="false" /> if the enumerator has
  1657. passed the end of the collection.
  1658. </returns>
  1659. </member>
  1660. <member name="M:NAnt.Core.Filters.FilterEnumerator.Reset">
  1661. <summary>
  1662. Sets the enumerator to its initial position, which is before the
  1663. first element in the collection.
  1664. </summary>
  1665. </member>
  1666. <member name="P:NAnt.Core.Filters.FilterEnumerator.Current">
  1667. <summary>
  1668. Gets the current element in the collection.
  1669. </summary>
  1670. <returns>
  1671. The current element in the collection.
  1672. </returns>
  1673. </member>
  1674. <member name="T:NAnt.Core.Filters.PhysicalTextReader">
  1675. <summary>
  1676. Represents a physical <see cref="T:System.IO.TextReader"/>. That is a reader based
  1677. on a stream.
  1678. </summary>
  1679. <remarks>
  1680. Used by <see cref="T:NAnt.Core.Filters.ChainableReader"/> to represent a <see cref="T:NAnt.Core.Filters.Filter"/>
  1681. based on a <see cref="T:System.IO.TextReader"/> in the chain.
  1682. </remarks>
  1683. </member>
  1684. <member name="T:NAnt.Core.Filters.ExpandProperties">
  1685. <summary>
  1686. Parses NAnt properties and expressions
  1687. </summary>
  1688. <remarks>
  1689. <para>
  1690. This filter parses any NAnt properties or expressions found in its input,
  1691. inlining their values in its output.
  1692. </para>
  1693. <para>
  1694. Note: Due to limitations on buffering, expressions longer than 2048
  1695. characters are not guaranteed to be expanded.
  1696. </para>
  1697. Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
  1698. </remarks>
  1699. <example>
  1700. <para>Replace all properties with their corresponding values.</para>
  1701. <code>
  1702. <![CDATA[
  1703. <expandproperties />
  1704. ]]>
  1705. </code>
  1706. </example>
  1707. </member>
  1708. <member name="F:NAnt.Core.Filters.ExpandProperties._buffer">
  1709. <summary>
  1710. Holds data for expression expansion between input and output.
  1711. </summary>
  1712. </member>
  1713. <member name="M:NAnt.Core.Filters.ExpandProperties.InitializeFilter">
  1714. <summary>
  1715. Called after construction and after properties are set. Allows
  1716. for filter initialization.
  1717. </summary>
  1718. </member>
  1719. <member name="M:NAnt.Core.Filters.ExpandProperties.Read">
  1720. <summary>
  1721. Reads the next character applying the filter logic.
  1722. </summary>
  1723. <returns>Char as an int or -1 if at the end of the stream</returns>
  1724. </member>
  1725. <member name="M:NAnt.Core.Filters.ExpandProperties.Peek">
  1726. <summary>
  1727. Reads the next character applying the filter logic without advancing the current position in the stream.
  1728. </summary>
  1729. <returns>Char as an int or -1 if at the end of the stream</returns>
  1730. </member>
  1731. <member name="M:NAnt.Core.Filters.ExpandProperties.Advance">
  1732. <summary>
  1733. Moves to the next character.
  1734. </summary>
  1735. </member>
  1736. <member name="M:NAnt.Core.Filters.ExpandProperties.ReplenishBuffer">
  1737. <summary>
  1738. Refills the buffer, running our input through
  1739. <see cref="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location)"/>.)
  1740. </summary>
  1741. </member>
  1742. <member name="P:NAnt.Core.Filters.ExpandProperties.AtEnd">
  1743. <summary>
  1744. Determines whether we've passed the end of our data.
  1745. </summary>
  1746. </member>
  1747. <member name="T:NAnt.Core.Filters.ReplaceString">
  1748. <summary>
  1749. Replaces all occurrences of a given string in the original input with
  1750. user-supplied replacement string.
  1751. </summary>
  1752. <remarks>
  1753. <para>
  1754. This filter replaces all occurrences of a given string in the original
  1755. input stream with a user-supplied replacement string. By default string
  1756. comparisons are case sensitive but this can be changed by setting the
  1757. optional <see cref="P:NAnt.Core.Filters.ReplaceString.IgnoreCase"/> attribute to <see langword="true"/>.
  1758. </para>
  1759. <para>
  1760. To use this filter specify the string to be replaced with the
  1761. <see cref="P:NAnt.Core.Filters.ReplaceString.From"/> attribute and the string to replace it with using the
  1762. <see cref="P:NAnt.Core.Filters.ReplaceString.To"/> attribute.
  1763. </para>
  1764. <para>
  1765. Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
  1766. </para>
  1767. </remarks>
  1768. <example>
  1769. <para>
  1770. Replace all occurrences of "3.14" with "PI".
  1771. </para>
  1772. <code>
  1773. <![CDATA[
  1774. <replacestring from="3.14" to="PI" />
  1775. ]]>
  1776. </code>
  1777. </example>
  1778. <example>
  1779. <para>
  1780. Replace all occurrences of "string", "String", etc. with "System.String".
  1781. </para>
  1782. <code>
  1783. <![CDATA[
  1784. <replacestring from="String" to="System.String" ignorecase="true" />
  1785. ]]>
  1786. </code>
  1787. </example>
  1788. </member>
  1789. <member name="M:NAnt.Core.Filters.ReplaceString.Chain(NAnt.Core.Filters.ChainableReader)">
  1790. <summary>
  1791. Construct that allows this filter to be chained to the one
  1792. in the parameter chainedReader.
  1793. </summary>
  1794. <param name="chainedReader">Filter that the filter will be chained to</param>
  1795. </member>
  1796. <member name="M:NAnt.Core.Filters.ReplaceString.Read">
  1797. <summary>
  1798. Reads the next character applying the filter logic.
  1799. </summary>
  1800. <returns>Char as an int or -1 if at the end of the stream</returns>
  1801. </member>
  1802. <member name="M:NAnt.Core.Filters.ReplaceString.Peek">
  1803. <summary>
  1804. Reads the next character applying the filter logic without
  1805. advancing the current position in the stream.
  1806. Peek currently is not supported.
  1807. </summary>
  1808. <returns>
  1809. Char as an int or -1 if at the end of the stream.
  1810. </returns>
  1811. </member>
  1812. <member name="M:NAnt.Core.Filters.ReplaceString.FindString(System.Int32,System.Boolean@,System.String@)">
  1813. <summary>
  1814. <para>
  1815. Helper function used to search for the filter's traget string. If the string
  1816. is found the result is true. If the string was not found false is returned and
  1817. nonMatchingChars contains the characters that were read to determine if the
  1818. string is present.
  1819. </para>
  1820. <para>
  1821. It is assumed the stream is positioned at the character after the first character
  1822. in the target string.
  1823. </para>
  1824. </summary>
  1825. <param name="startChar">First character in target string</param>
  1826. <param name="streamEnded">Ture if the stream ended while search for the string.</param>
  1827. <param name="nonMatchingChars">Characters that were read while searching for the string.</param>
  1828. <returns></returns>
  1829. </member>
  1830. <member name="M:NAnt.Core.Filters.ReplaceString.GetNextCharacter(NAnt.Core.Filters.ReplaceString.AcquireCharDelegate)">
  1831. <summary>
  1832. Returns the next character in the stream replacing the specified character. Using the
  1833. <see cref="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
  1834. </summary>
  1835. <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
  1836. <returns>Char as an int or -1 if at the end of the stream</returns>
  1837. </member>
  1838. <member name="M:NAnt.Core.Filters.ReplaceString.CompareCharacters(System.Int32,System.Int32)">
  1839. <summary>
  1840. Compares to characters taking into account the _ignoreCase flag.
  1841. </summary>
  1842. <param name="char1"></param>
  1843. <param name="char2"></param>
  1844. <returns></returns>
  1845. </member>
  1846. <member name="P:NAnt.Core.Filters.ReplaceString.From">
  1847. <summary>
  1848. The string to be replaced.
  1849. </summary>
  1850. </member>
  1851. <member name="P:NAnt.Core.Filters.ReplaceString.To">
  1852. <summary>
  1853. The new value for the replaced string.
  1854. Am empty string is permissible.
  1855. </summary>
  1856. </member>
  1857. <member name="P:NAnt.Core.Filters.ReplaceString.IgnoreCase">
  1858. <summary>
  1859. Determines if case will be ignored.
  1860. The default is <see langword="false" />.
  1861. </summary>
  1862. </member>
  1863. <member name="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate">
  1864. <summary>
  1865. Delegate for Read and Peek. Allows the same implementation
  1866. to be used for both methods.
  1867. </summary>
  1868. </member>
  1869. <member name="T:NAnt.Core.Filters.ReplaceTokens">
  1870. <summary>
  1871. Replaces tokens in the original input with user-supplied values.
  1872. </summary>
  1873. <remarks>
  1874. <para>
  1875. This filter replaces all token surrounded by a beginning and ending
  1876. token. The default beginning and ending tokens both default to '@'. The
  1877. optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.BeginToken"/> and <see cref="P:NAnt.Core.Filters.ReplaceTokens.EndToken"/> attributes
  1878. can be specified to change either token. By default string
  1879. comparisons are case sensitive but this can be changed by setting the
  1880. optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> attribute to <see langword="true"/>.
  1881. </para>
  1882. <para>
  1883. Tokens are specified by using the <see cref="T:NAnt.Core.Types.Token"/> element. It is
  1884. possible to specify from 1 to n tokens and replacement values. Values can
  1885. be any valid NAnt expression.
  1886. </para>
  1887. <para>
  1888. Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
  1889. </para>
  1890. </remarks>
  1891. <example>
  1892. <para>
  1893. Replace all occurrences of the string @DATE@ with the value of property
  1894. "TODAY".
  1895. </para>
  1896. <code>
  1897. <![CDATA[
  1898. <replacetokens>
  1899. <token key="DATE" value="${TODAY}" />
  1900. </replacetokens>
  1901. ]]>
  1902. </code>
  1903. </example>
  1904. <example>
  1905. <para>
  1906. Replace all occurrences of the string &lt;DATE&gt; with the value of
  1907. property "TODAY".
  1908. </para>
  1909. <code>
  1910. <![CDATA[
  1911. <replacetokens begintoken="&lt;" endtoken="&gt;">
  1912. <token key="DATE" value="${TODAY}" />
  1913. </replacetokens>
  1914. ]]>
  1915. </code>
  1916. </example>
  1917. </member>
  1918. <member name="M:NAnt.Core.Filters.ReplaceTokens.Chain(NAnt.Core.Filters.ChainableReader)">
  1919. <summary>
  1920. Construct that allows this filter to be chained to the one
  1921. in the parameter chainedReader.
  1922. </summary>
  1923. <param name="chainedReader">Filter that the filter will be chained to</param>
  1924. </member>
  1925. <member name="M:NAnt.Core.Filters.ReplaceTokens.Read">
  1926. <summary>
  1927. Reads the next character applying the filter logic.
  1928. </summary>
  1929. <returns>Char as an int or -1 if at the end of the stream</returns>
  1930. </member>
  1931. <member name="M:NAnt.Core.Filters.ReplaceTokens.Peek">
  1932. <summary>
  1933. Reads the next character applying the filter logic without
  1934. advancing the current position in the stream.
  1935. Peek currently is not supported.
  1936. </summary>
  1937. <returns>
  1938. Char as an int or -1 if at the end of the stream.
  1939. </returns>
  1940. </member>
  1941. <member name="M:NAnt.Core.Filters.ReplaceTokens.Initialize">
  1942. <summary>
  1943. Initialize the filter by setting its parameters.
  1944. </summary>
  1945. </member>
  1946. <member name="M:NAnt.Core.Filters.ReplaceTokens.FindTokenContents(System.Boolean@,System.Boolean@,System.Boolean@)">
  1947. <summary>
  1948. Finds a token give that we are positioned at a beginning token character. Either a
  1949. token replacement is returned or the characters that were read looking for the token.
  1950. </summary>
  1951. <param name="tokenNotFound">A token was not found</param>
  1952. <param name="unknownToken">A token was found by there is no replacement</param>
  1953. <param name="streamEnded">The stream ended while looking for the token</param>
  1954. <returns>Either the replacement token or the characters that were read looking for the token</returns>
  1955. </member>
  1956. <member name="M:NAnt.Core.Filters.ReplaceTokens.GetNextCharacter(NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate)">
  1957. <summary>
  1958. Returns the next character in the stream replacing the specified character. Using the
  1959. <see cref="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
  1960. </summary>
  1961. <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
  1962. <returns>Char as an int or -1 if at the end of the stream</returns>
  1963. </member>
  1964. <member name="M:NAnt.Core.Filters.ReplaceTokens.CompareCharacters(System.Int32,System.Int32)">
  1965. <summary>
  1966. Compares to characters taking <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> into account.
  1967. </summary>
  1968. <param name="char1"></param>
  1969. <param name="char2"></param>
  1970. <returns>
  1971. </returns>
  1972. </member>
  1973. <member name="P:NAnt.Core.Filters.ReplaceTokens.BeginToken">
  1974. <summary>
  1975. Marks the beginning of a token. The default is "@".
  1976. </summary>
  1977. </member>
  1978. <member name="P:NAnt.Core.Filters.ReplaceTokens.EndToken">
  1979. <summary>
  1980. Marks the end of a token. The default is "@".
  1981. </summary>
  1982. </member>
  1983. <member name="P:NAnt.Core.Filters.ReplaceTokens.Tokens">
  1984. <summary>
  1985. Tokens and replacement values.
  1986. </summary>
  1987. </member>
  1988. <member name="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase">
  1989. <summary>
  1990. Determines if case will be ignored.
  1991. The default is <see langword="false" />.
  1992. </summary>
  1993. </member>
  1994. <member name="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate">
  1995. <summary>
  1996. Delegate for Read and Peek. Allows the same implementation
  1997. to be used for both methods.
  1998. </summary>
  1999. </member>
  2000. <member name="T:NAnt.Core.Filters.TabsToSpaces">
  2001. <summary>
  2002. Converts tabs to spaces.
  2003. </summary>
  2004. <remarks>
  2005. <para>
  2006. The <see cref="T:NAnt.Core.Filters.TabsToSpaces"/> filter replaces tabs in a text file
  2007. with spaces.
  2008. </para>
  2009. <para>
  2010. Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
  2011. </para>
  2012. </remarks>
  2013. <example>
  2014. <para>Replace all tabs with four spaces.</para>
  2015. <code>
  2016. <![CDATA[
  2017. <tabtospaces tablength="4" />
  2018. ]]>
  2019. </code>
  2020. </example>
  2021. </member>
  2022. <member name="M:NAnt.Core.Filters.TabsToSpaces.Chain(NAnt.Core.Filters.ChainableReader)">
  2023. <summary>
  2024. Construct that allows this filter to be chained to the one
  2025. in the parameter chainedReader.
  2026. </summary>
  2027. <param name="chainedReader">Filter that the filter will be chained to</param>
  2028. </member>
  2029. <member name="M:NAnt.Core.Filters.TabsToSpaces.Peek">
  2030. <summary>
  2031. <para>Retrieves the next character with moving the position in the stream.</para>
  2032. <note>This method is not implemented</note>
  2033. </summary>
  2034. <returns>-1 if end of stream otherwise a character</returns>
  2035. </member>
  2036. <member name="M:NAnt.Core.Filters.TabsToSpaces.Read">
  2037. <summary>
  2038. <para>Retrieves the next character in the stream.</para>
  2039. </summary>
  2040. <returns>-1 if end of stream otherwise a character</returns>
  2041. </member>
  2042. <member name="M:NAnt.Core.Filters.TabsToSpaces.GetNextCharacter(NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate)">
  2043. <summary>
  2044. Returns the next character in the stream replacing the specified character. Using the
  2045. <see cref="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
  2046. </summary>
  2047. <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
  2048. <returns>Char as an int or -1 if at the end of the stream</returns>
  2049. </member>
  2050. <member name="P:NAnt.Core.Filters.TabsToSpaces.TabLength">
  2051. <summary>
  2052. The number of spaces used when converting a tab. The default is
  2053. "8".
  2054. </summary>
  2055. </member>
  2056. <member name="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate">
  2057. <summary>
  2058. Delegate for Read and Peek. Allows the same implementation
  2059. to be used for both methods.
  2060. </summary>
  2061. </member>
  2062. <member name="T:NAnt.Core.Functions.AssemblyFunctions">
  2063. <summary>
  2064. Functions to return information for a given assembly.
  2065. </summary>
  2066. </member>
  2067. <member name="P:NAnt.Core.FunctionSetBase.Project">
  2068. <summary>
  2069. Gets or sets the <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will
  2070. reference.
  2071. </summary>
  2072. <value>
  2073. The <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will reference.
  2074. </value>
  2075. </member>
  2076. <member name="M:NAnt.Core.Functions.AssemblyFunctions.LoadFromFile(System.String)">
  2077. <summary>
  2078. Loads an assembly given its file name or path.
  2079. </summary>
  2080. <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
  2081. <returns>
  2082. The loaded assembly.
  2083. </returns>
  2084. <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
  2085. <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>
  2086. <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception>
  2087. <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>
  2088. </member>
  2089. <member name="M:NAnt.Core.Functions.AssemblyFunctions.Load(System.String)">
  2090. <summary>
  2091. Loads an assembly given the long form of its name.
  2092. </summary>
  2093. <param name="assemblyString">The long form of the assembly name.</param>
  2094. <returns>
  2095. The loaded assembly.
  2096. </returns>
  2097. <exception cref="T:System.ArgumentNullException"><paramref name="assemblyString"/> is a <see langword="null"/>.</exception>
  2098. <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyString"/> is not found.</exception>
  2099. <example>
  2100. <para>
  2101. Determine the location of the Microsoft Access 11 Primary Interop
  2102. Assembly by loading it using its fully qualified name, and copy it
  2103. to the build directory.
  2104. </para>
  2105. <code>
  2106. <![CDATA[
  2107. <property name="access.pia.path" value="${assembly::get-location(assembly::load('Microsoft.Office.Interop.Access, Version=11.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c'))}" />
  2108. <copy file="${access.pia.path}" todir="${build.dir}" />
  2109. ]]>
  2110. </code>
  2111. </example>
  2112. </member>
  2113. <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetFullName(System.Reflection.Assembly)">
  2114. <summary>
  2115. Gets the full name of the assembly, also known as the display name.
  2116. </summary>
  2117. <param name="assembly">The assembly to get the full name for.</param>
  2118. <returns>
  2119. The full name of the assembly, also known as the display name.
  2120. </returns>
  2121. </member>
  2122. <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)">
  2123. <summary>
  2124. Gets an <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly.
  2125. </summary>
  2126. <param name="assembly">The assembly to get an <see cref="T:System.Reflection.AssemblyName"/> for.</param>
  2127. <returns>
  2128. An <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly.
  2129. </returns>
  2130. <seealso cref="T:NAnt.Core.Functions.AssemblyNameFunctions"/>
  2131. </member>
  2132. <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetLocation(System.Reflection.Assembly)">
  2133. <summary>
  2134. Gets the physical location, in codebase format, of the loaded file
  2135. that contains the manifest.
  2136. </summary>
  2137. <param name="assembly">The assembly to get the location for.</param>
  2138. <returns>
  2139. The location of the specified assembly.
  2140. </returns>
  2141. </member>
  2142. <member name="T:NAnt.Core.Functions.AssemblyNameFunctions">
  2143. <summary>
  2144. Functions that return information about an assembly's identity.
  2145. </summary>
  2146. </member>
  2147. <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetCodeBase(System.Reflection.AssemblyName)">
  2148. <summary>
  2149. Gets the location of the assembly as a URL.
  2150. </summary>
  2151. <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
  2152. <returns>
  2153. The location of the assembly as a URL.
  2154. </returns>
  2155. <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
  2156. </member>
  2157. <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetEscapedCodeBase(System.Reflection.AssemblyName)">
  2158. <summary>
  2159. Gets the URI, including escape characters, that represents the codebase.
  2160. </summary>
  2161. <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
  2162. <returns>
  2163. The URI, including escape characters, that represents the codebase.
  2164. </returns>
  2165. <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
  2166. </member>
  2167. <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetFullName(System.Reflection.AssemblyName)">
  2168. <summary>
  2169. Gets the full name of the assembly, also known as the display name.
  2170. </summary>
  2171. <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
  2172. <returns>
  2173. The full name of the assembly, also known as the display name.
  2174. </returns>
  2175. <example>
  2176. <para>
  2177. Output the full name of the <c>nunit.framework</c> assembly to the
  2178. build log.
  2179. </para>
  2180. <code>
  2181. <![CDATA[
  2182. <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
  2183. ]]>
  2184. </code>
  2185. </example>
  2186. <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
  2187. </member>
  2188. <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetName(System.Reflection.AssemblyName)">
  2189. <summary>
  2190. Gets the simple, unencrypted name of the assembly.
  2191. </summary>
  2192. <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
  2193. <returns>
  2194. The simple, unencrypted name of the assembly.
  2195. </returns>
  2196. <example>
  2197. <para>
  2198. Output the simple name of the <c>nunit.framework</c> assembly to
  2199. the build log.
  2200. </para>
  2201. <code>
  2202. <![CDATA[
  2203. <echo message="${assemblyname::get-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
  2204. ]]>
  2205. </code>
  2206. </example>
  2207. <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
  2208. </member>
  2209. <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)">
  2210. <summary>
  2211. Gets the version of the assembly.
  2212. </summary>
  2213. <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
  2214. <returns>
  2215. The version of the assembly.
  2216. </returns>
  2217. <example>
  2218. <para>
  2219. Output the major version of the <c>nunit.framework</c> assembly
  2220. to the build log.
  2221. </para>
  2222. <code>
  2223. <![CDATA[
  2224. <echo message="${version::get-major-version(assemblyname::get-version(assemblyname::get-assembly-name('nunit.framework.dll')))}" />
  2225. ]]>
  2226. </code>
  2227. </example>
  2228. <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
  2229. <seealso cref="T:NAnt.Core.Functions.VersionFunctions"/>
  2230. </member>
  2231. <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetAssemblyName(System.String)">
  2232. <summary>
  2233. Gets the <see cref="T:System.Reflection.AssemblyName"/> for a given file.
  2234. </summary>
  2235. <param name="assemblyFile">The assembly file for which to get the <see cref="T:System.Reflection.AssemblyName"/>.</param>
  2236. <returns>
  2237. An <see cref="T:System.Reflection.AssemblyName"/> object representing the given file.
  2238. </returns>
  2239. <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
  2240. <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> does not exist.</exception>
  2241. <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception>
  2242. <remarks>
  2243. The assembly is not added to this domain.
  2244. </remarks>
  2245. <example>
  2246. <para>
  2247. Output the full name of the <c>nunit.framework</c> assembly to the
  2248. build log.
  2249. </para>
  2250. <code>
  2251. <![CDATA[
  2252. <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
  2253. ]]>
  2254. </code>
  2255. </example>
  2256. </member>
  2257. <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.Parse(System.String)">
  2258. <summary>
  2259. Converts the specified string representation of a logical value to
  2260. its <see cref="T:System.Boolean"/> equivalent.
  2261. </summary>
  2262. <param name="s">A string containing the value to convert.</param>
  2263. <returns>
  2264. <see langword="true"/> if <paramref name="s"/> is equivalent to
  2265. "True"; otherwise, <see langword="false"/>.
  2266. </returns>
  2267. <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>
  2268. </member>
  2269. <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.ToString(System.Boolean)">
  2270. <summary>
  2271. Converts the specified <see cref="T:System.Boolean"/> to its equivalent string
  2272. representation.
  2273. </summary>
  2274. <param name="value">A <see cref="T:System.Boolean"/> to convert.</param>
  2275. <returns>
  2276. "True" if <paramref name="value"/> is <see langword="true"/>, or
  2277. "False" if <paramref name="value"/> is <see langword="false"/>.
  2278. </returns>
  2279. </member>
  2280. <member name="M:NAnt.Core.Functions.ConversionFunctions.ToInt(System.Int32)">
  2281. <summary>
  2282. Converts the argument to an integer.
  2283. </summary>
  2284. <param name="value">value to be converted</param>
  2285. <returns><paramref name="value" /> converted to integer. The function fails with an exception when the conversion is not possible.</returns>
  2286. </member>
  2287. <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDouble(System.Double)">
  2288. <summary>
  2289. Converts the argument to double
  2290. </summary>
  2291. <param name="value">The value to be converted.</param>
  2292. <returns><paramref name="value" /> converted to double. The function fails with an exception when the conversion is not possible.</returns>
  2293. </member>
  2294. <member name="M:NAnt.Core.Functions.ConversionFunctions.ConvertToString(System.String)">
  2295. <summary>
  2296. Converts the argument to a string.
  2297. </summary>
  2298. <param name="value">The value to be converted.</param>
  2299. <returns>
  2300. <paramref name="value" /> converted to string. The function fails
  2301. with an exception when the conversion is not possible.
  2302. </returns>
  2303. <remarks>
  2304. Named method ConvertToString as a static ToString method would break
  2305. CLS compliance.
  2306. </remarks>
  2307. </member>
  2308. <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDateTime(System.DateTime)">
  2309. <summary>
  2310. Converts the argument to a datetime.
  2311. </summary>
  2312. <param name="value">value to be converted</param>
  2313. <returns><paramref name="value" /> converted to datetime. The function fails with an exception when the conversion is not possible.</returns>
  2314. </member>
  2315. <member name="M:NAnt.Core.Functions.ConversionFunctions.ToBoolean(System.Boolean)">
  2316. <summary>
  2317. Converts the argument to a boolean
  2318. </summary>
  2319. <param name="value">The string value to be converted to boolean. Must be 'true' or 'false'.</param>
  2320. <returns>
  2321. <paramref name="value" /> converted to boolean. The function fails
  2322. with an exception when the conversion is not possible.
  2323. </returns>
  2324. </member>
  2325. <member name="M:NAnt.Core.Functions.DateTimeFunctions.Now">
  2326. <summary>
  2327. Gets a <see cref="T:System.DateTime"/> that is the current local date and
  2328. time on this computer.
  2329. </summary>
  2330. <returns>
  2331. A <see cref="T:System.DateTime"/> whose value is the current date and time.
  2332. </returns>
  2333. </member>
  2334. <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetYear(System.DateTime)">
  2335. <summary>
  2336. Gets the year component of the specified date.
  2337. </summary>
  2338. <param name="date">The date of which to get the year component.</param>
  2339. <returns>
  2340. The year, between 1 and 9999.
  2341. </returns>
  2342. </member>
  2343. <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMonth(System.DateTime)">
  2344. <summary>
  2345. Gets the month component of the specified date.
  2346. </summary>
  2347. <param name="date">The date of which to get the month component.</param>
  2348. <returns>
  2349. The month, between 1 and 12.
  2350. </returns>
  2351. </member>
  2352. <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDay(System.DateTime)">
  2353. <summary>
  2354. Gets the day of the month represented by the specified date.
  2355. </summary>
  2356. <param name="date">The date of which to get the day of the month.</param>
  2357. <returns>
  2358. The day value, between 1 and 31.
  2359. </returns>
  2360. </member>
  2361. <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetHour(System.DateTime)">
  2362. <summary>
  2363. Gets the hour component of the specified date.
  2364. </summary>
  2365. <param name="date">The date of which to get the hour component.</param>
  2366. <returns>
  2367. The hour, between 0 and 23.
  2368. </returns>
  2369. </member>
  2370. <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMinute(System.DateTime)">
  2371. <summary>
  2372. Gets the minute component of the specified date.
  2373. </summary>
  2374. <param name="date">The date of which to get the minute component.</param>
  2375. <returns>
  2376. The minute, between 0 and 59.
  2377. </returns>
  2378. </member>
  2379. <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetSecond(System.DateTime)">
  2380. <summary>
  2381. Gets the seconds component of the specified date.
  2382. </summary>
  2383. <param name="date">The date of which to get the seconds component.</param>
  2384. <returns>
  2385. The seconds, between 0 and 59.
  2386. </returns>
  2387. </member>
  2388. <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMillisecond(System.DateTime)">
  2389. <summary>
  2390. Gets the milliseconds component of the specified date.
  2391. </summary>
  2392. <param name="date">The date of which to get the milliseconds component.</param>
  2393. <returns>
  2394. The millisecond, between 0 and 999.
  2395. </returns>
  2396. </member>
  2397. <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetTicks(System.DateTime)">
  2398. <summary>
  2399. Gets the number of ticks that represent the specified date.
  2400. </summary>
  2401. <param name="date">The date of which to get the number of ticks.</param>
  2402. <returns>
  2403. The number of ticks that represent the date and time of the
  2404. specified date.
  2405. </returns>
  2406. </member>
  2407. <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfWeek(System.DateTime)">
  2408. <summary>
  2409. Gets the day of the week represented by the specified date.
  2410. </summary>
  2411. <param name="date">The date of which to get the day of the week.</param>
  2412. <returns>
  2413. The day of the week, ranging from zero, indicating Sunday, to six,
  2414. indicating Saturday.
  2415. </returns>
  2416. </member>
  2417. <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfYear(System.DateTime)">
  2418. <summary>
  2419. Gets the day of the year represented by the specified date.
  2420. </summary>
  2421. <param name="date">The date of which to get the day of the year.</param>
  2422. <returns>
  2423. The day of the year, between 1 and 366.
  2424. </returns>
  2425. </member>
  2426. <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDaysInMonth(System.Int32,System.Int32)">
  2427. <summary>
  2428. Returns the number of days in the specified month of the specified
  2429. year.
  2430. </summary>
  2431. <param name="year">The year.</param>
  2432. <param name="month">The month (a number ranging from 1 to 12).</param>
  2433. <returns>
  2434. The number of days in <paramref name="month"/> for the specified
  2435. <paramref name="year"/>.
  2436. </returns>
  2437. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="month"/> is less than 1 or greater than 12.</exception>
  2438. </member>
  2439. <member name="M:NAnt.Core.Functions.DateTimeFunctions.IsLeapYear(System.Int32)">
  2440. <summary>
  2441. Returns an indication whether the specified year is a leap year.
  2442. </summary>
  2443. <param name="year">A 4-digit year.</param>
  2444. <returns>
  2445. <see langword="true" /> if <paramref name="year" /> is a leap year;
  2446. otherwise, <see langword="false" />.
  2447. </returns>
  2448. </member>
  2449. <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.Parse(System.String)">
  2450. <summary>
  2451. Converts the specified string representation of a date and time to
  2452. its <see cref="T:System.DateTime"/> equivalent.
  2453. </summary>
  2454. <param name="s">A string containing a date and time to convert.</param>
  2455. <returns>
  2456. A <see cref="T:System.DateTime"/> equivalent to the date and time contained
  2457. in <paramref name="s"/>.
  2458. </returns>
  2459. <exception cref="T:System.FormatException"><paramref name="s"/> does not contain a valid string representation of a date and time.</exception>
  2460. <remarks>
  2461. The <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture is
  2462. used to supply formatting information about <paramref name="s"/>.
  2463. </remarks>
  2464. </member>
  2465. <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.ToString(System.DateTime)">
  2466. <summary>
  2467. Converts the specified <see cref="T:System.DateTime"/> to its equivalent
  2468. string representation.
  2469. </summary>
  2470. <param name="value">A <see cref="T:System.DateTime"/> to convert.</param>
  2471. <returns>
  2472. A string representation of <paramref name="value"/> formatted using
  2473. the general format specifier ("G").
  2474. </returns>
  2475. <remarks>
  2476. <paramref name="value"/> is formatted with the
  2477. <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture.
  2478. </remarks>
  2479. </member>
  2480. <member name="T:NAnt.Core.Functions.DirectoryFunctions">
  2481. <summary>
  2482. Groups a set of functions for dealing with directories.
  2483. </summary>
  2484. </member>
  2485. <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCreationTime(System.String)">
  2486. <summary>
  2487. Returns the creation date and time of the specified directory.
  2488. </summary>
  2489. <param name="path">The directory for which to obtain creation date and time information.</param>
  2490. <returns>
  2491. The creation date and time of the specified directory.
  2492. </returns>
  2493. <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
  2494. <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>
  2495. <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
  2496. </member>
  2497. <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastWriteTime(System.String)">
  2498. <summary>
  2499. Returns the date and time the specified directory was last written to.
  2500. </summary>
  2501. <param name="path">The directory for which to obtain write date and time information.</param>
  2502. <returns>
  2503. The date and time the specified directory was last written to.
  2504. </returns>
  2505. <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
  2506. <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>
  2507. <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
  2508. </member>
  2509. <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastAccessTime(System.String)">
  2510. <summary>
  2511. Returns the date and time the specified directory was last accessed.
  2512. </summary>
  2513. <param name="path">The directory for which to obtain access date and time information.</param>
  2514. <returns>
  2515. The date and time the specified directory was last accessed.
  2516. </returns>
  2517. <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
  2518. <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>
  2519. <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
  2520. <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
  2521. </member>
  2522. <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCurrentDirectory">
  2523. <summary>
  2524. Gets the current working directory.
  2525. </summary>
  2526. <returns>
  2527. A <see cref="T:System.String"/> containing the path of the current working
  2528. directory.
  2529. </returns>
  2530. </member>
  2531. <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetParentDirectory(System.String)">
  2532. <summary>
  2533. Retrieves the parent directory of the specified path.
  2534. </summary>
  2535. <param name="path">The path for which to retrieve the parent directory.</param>
  2536. <returns>
  2537. The parent directory, or an empty <see cref="T:System.String"/> if
  2538. <paramref name="path"/> is the root directory, including the root
  2539. of a UNC server or share name.
  2540. </returns>
  2541. <exception cref="T:System.IO.IOException">The directory specified by <paramref name="path"/> is read-only.</exception>
  2542. <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>
  2543. <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
  2544. <exception cref="T:System.IO.DirectoryNotFoundException">The specified path was not found.</exception>
  2545. <example>
  2546. <para>
  2547. Copy "readme.txt" from the current working directory to
  2548. its parent directory.
  2549. </para>
  2550. <code>
  2551. <![CDATA[
  2552. <property name="current.dir" value="${directory::get-current-directory()}" />
  2553. <property name="current.dir.parent" value="${directory::get-parent-directory(current.dir)}" />
  2554. <copy file="${path::combine(current.dir, 'readme.txt')} todir="${current.dir.parent}" />
  2555. ]]>
  2556. </code>
  2557. </example>
  2558. </member>
  2559. <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetDirectoryRoot(System.String)">
  2560. <summary>
  2561. Returns the volume information, root information, or both for the
  2562. specified path.
  2563. </summary>
  2564. <param name="path">The path for which to retrieve the parent directory.</param>
  2565. <returns>
  2566. A string containing the volume information, root information, or
  2567. both for the specified path.
  2568. </returns>
  2569. <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>
  2570. <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
  2571. </member>
  2572. <member name="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)">
  2573. <summary>
  2574. Determines whether the given path refers to an existing directory
  2575. on disk.
  2576. </summary>
  2577. <param name="path">The path to test.</param>
  2578. <returns>
  2579. <see langword="true" /> if <paramref name="path" /> refers to an
  2580. existing directory; otherwise, <see langword="false" />.
  2581. </returns>
  2582. <example>
  2583. <para>Remove directory "test", if it exists.</para>
  2584. <code>
  2585. <![CDATA[
  2586. <delete dir="test" if="${directory::exists('test')}" />
  2587. ]]>
  2588. </code>
  2589. </example>
  2590. </member>
  2591. <member name="T:NAnt.Core.Functions.DnsFunctions">
  2592. <summary>
  2593. Functions for requesting information from DNS.
  2594. </summary>
  2595. </member>
  2596. <member name="M:NAnt.Core.Functions.DnsFunctions.GetHostName">
  2597. <summary>
  2598. Gets the host name of the local computer.
  2599. </summary>
  2600. <returns>
  2601. A string that contains the DNS host name of the local computer.
  2602. </returns>
  2603. <exception cref="T:System.Net.Sockets.SocketException">An error is encountered when resolving the local host name.</exception>
  2604. </member>
  2605. <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.Parse(System.String)">
  2606. <summary>
  2607. Converts the specified string representation of a number to its
  2608. double-precision floating point number equivalent.
  2609. </summary>
  2610. <param name="s">A string containing a number to convert.</param>
  2611. <returns>
  2612. A double-precision floating point number equivalent to the numeric
  2613. value or symbol specified in <paramref name="s"/>.
  2614. </returns>
  2615. <exception cref="T:System.FormatException"><paramref name="s"/> is not a number in a valid format.</exception>
  2616. <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>
  2617. <remarks>
  2618. The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
  2619. used to supply formatting information about <paramref name="s"/>.
  2620. </remarks>
  2621. </member>
  2622. <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.ToString(System.Double)">
  2623. <summary>
  2624. Converts the specified <see cref="T:System.Double"/> to its equivalent
  2625. string representation.
  2626. </summary>
  2627. <param name="value">A <see cref="T:System.Double"/> to convert.</param>
  2628. <returns>
  2629. The string representation of <paramref name="value"/> formatted
  2630. using the general format specifier ("G").
  2631. </returns>
  2632. <remarks>
  2633. <paramref name="value"/> is formatted with the
  2634. <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
  2635. </remarks>
  2636. </member>
  2637. <member name="T:NAnt.Core.Functions.EnvironmentFunctions">
  2638. <summary>
  2639. Provide information about the current environment and platform.
  2640. </summary>
  2641. </member>
  2642. <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)">
  2643. <summary>
  2644. Gets the path to the system special folder identified by the
  2645. specified enumeration.
  2646. </summary>
  2647. <param name="folder">An enumerated constant that identifies a system special folder.</param>
  2648. <returns>
  2649. The path to the specified system special folder, if that folder
  2650. physically exists on your computer; otherwise, the empty string ("").
  2651. </returns>
  2652. <exception cref="T:System.ArgumentException"><paramref name="folder"/> is not a member of <see cref="T:System.Environment.SpecialFolder"/>.</exception>
  2653. <example>
  2654. <para>
  2655. Copy "out.log" from the project base directory to the
  2656. program files directory.
  2657. </para>
  2658. <code>
  2659. <![CDATA[
  2660. <copy file="out.log" todir="${environment::get-folder-path('ProgramFiles')}" />
  2661. ]]>
  2662. </code>
  2663. </example>
  2664. </member>
  2665. <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetMachineName">
  2666. <summary>
  2667. Gets the NetBIOS name of this local computer.
  2668. </summary>
  2669. <returns>
  2670. The NetBIOS name of this local computer.
  2671. </returns>
  2672. <exception cref="T:System.InvalidOperationException">The name of this computer cannot be obtained.</exception>
  2673. </member>
  2674. <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem">
  2675. <summary>
  2676. Gets an <see cref="T:System.OperatingSystem"/> object that represents the
  2677. current operating system.
  2678. </summary>
  2679. <returns>
  2680. An <see cref="T:System.OperatingSystem"/> object that contains the current
  2681. platform identifier and version number.
  2682. </returns>
  2683. <example>
  2684. <para>
  2685. Output string representation of the current operating system.
  2686. </para>
  2687. <code>
  2688. <![CDATA[
  2689. <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" />
  2690. ]]>
  2691. </code>
  2692. <para>If the operating system is Windows 2000, the output is:</para>
  2693. <code>
  2694. Microsoft Windows NT 5.0.2195.0
  2695. </code>
  2696. </example>
  2697. <seealso cref="T:NAnt.Core.Functions.OperatingSystemFunctions"/>
  2698. </member>
  2699. <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetUserName">
  2700. <summary>
  2701. Gets the user name of the person who started the current thread.
  2702. </summary>
  2703. <returns>
  2704. The name of the person logged on to the system who started the
  2705. current thread.
  2706. </returns>
  2707. <example>
  2708. <para>
  2709. Modify the home directory of the current user on unix-based systems.
  2710. </para>
  2711. <code>
  2712. <![CDATA[
  2713. <exec program="usermod">
  2714. <arg value="-d" />
  2715. <arg value="/home/temp" />
  2716. <arg value="${environment::get-user-name()}" />
  2717. </exec>
  2718. ]]>
  2719. </code>
  2720. </example>
  2721. </member>
  2722. <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)">
  2723. <summary>
  2724. Returns the value of the specified environment variable.
  2725. </summary>
  2726. <param name="name">The environment variable of which the value should be returned.</param>
  2727. <returns>
  2728. The value of the specified environment variable.
  2729. </returns>
  2730. <exception cref="T:System.ArgumentException">Environment variable <paramref name="name"/> does not exist.</exception>
  2731. </member>
  2732. <member name="M:NAnt.Core.Functions.EnvironmentFunctions.VariableExists(System.String)">
  2733. <summary>
  2734. Gets a value indicating whether the specified environment variable
  2735. exists.
  2736. </summary>
  2737. <param name="name">The environment variable that should be checked.</param>
  2738. <returns>
  2739. <see langword="true" /> if the environment variable exists; otherwise,
  2740. <see langword="false" />.
  2741. </returns>
  2742. <example>
  2743. <para>
  2744. Execute a set of tasks only if the &quot;BUILD_DEBUG&quot; environment
  2745. variable is set.
  2746. </para>
  2747. <code>
  2748. <![CDATA[
  2749. <if test="${environment::variable-exists('BUILD_DEBUG')}">
  2750. ...
  2751. </if>
  2752. ]]>
  2753. </code>
  2754. </example>
  2755. </member>
  2756. <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion">
  2757. <summary>
  2758. Gets a <see cref="T:System.Version"/> object that describes the major,
  2759. minor, build, and revision numbers of the Common Language Runtime.
  2760. </summary>
  2761. <returns>
  2762. A Version object.
  2763. </returns>
  2764. <example>
  2765. <para>Output the major version of the CLR.</para>
  2766. <code>
  2767. <![CDATA[
  2768. <echo message="Major version=${version::get-major(environment::get-version())}" />
  2769. ]]>
  2770. </code>
  2771. </example>
  2772. </member>
  2773. <member name="M:NAnt.Core.Functions.EnvironmentFunctions.NewLine">
  2774. <summary>
  2775. Gets the newline string defined for this environment.
  2776. </summary>
  2777. <returns>
  2778. A string containing CRLF for non-Unix platforms, or LF for Unix
  2779. platforms.
  2780. </returns>
  2781. <example>
  2782. <para>Output two lines in a log file.</para>
  2783. <code>
  2784. <![CDATA[
  2785. <echo file="build.log" message="First line${environment::newline()}Second line" />
  2786. ]]>
  2787. </code>
  2788. </example>
  2789. </member>
  2790. <member name="T:NAnt.Core.Functions.FileFunctions">
  2791. <summary>
  2792. Groups a set of functions for dealing with files.
  2793. </summary>
  2794. </member>
  2795. <member name="M:NAnt.Core.Functions.FileFunctions.GetCreationTime(System.String)">
  2796. <summary>
  2797. Returns the creation date and time of the specified file.
  2798. </summary>
  2799. <param name="path">The file for which to obtain creation date and time information.</param>
  2800. <returns>
  2801. The creation date and time of the specified file.
  2802. </returns>
  2803. <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
  2804. <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>
  2805. <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
  2806. <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
  2807. </member>
  2808. <member name="M:NAnt.Core.Functions.FileFunctions.GetLastWriteTime(System.String)">
  2809. <summary>
  2810. Returns the date and time the specified file was last written to.
  2811. </summary>
  2812. <param name="path">The file for which to obtain write date and time information.</param>
  2813. <returns>
  2814. The date and time the specified file was last written to.
  2815. </returns>
  2816. <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
  2817. <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>
  2818. <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
  2819. </member>
  2820. <member name="M:NAnt.Core.Functions.FileFunctions.GetLastAccessTime(System.String)">
  2821. <summary>
  2822. Returns the date and time the specified file was last accessed.
  2823. </summary>
  2824. <param name="path">The file for which to obtain access date and time information.</param>
  2825. <returns>
  2826. The date and time the specified file was last accessed.
  2827. </returns>
  2828. <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
  2829. <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>
  2830. <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
  2831. <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
  2832. </member>
  2833. <member name="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)">
  2834. <summary>
  2835. Determines whether the specified file exists.
  2836. </summary>
  2837. <param name="file">The file to check.</param>
  2838. <returns>
  2839. <see langword="true" /> if <paramref name="file" /> refers to an
  2840. existing file; otherwise, <see langword="false" />.
  2841. </returns>
  2842. <example>
  2843. <para>Execute a set of tasks, if file "output.xml" does not exist.</para>
  2844. <code>
  2845. <![CDATA[
  2846. <if test="${not file::exists('output.xml')}">
  2847. ...
  2848. </if>
  2849. ]]>
  2850. </code>
  2851. </example>
  2852. </member>
  2853. <member name="M:NAnt.Core.Functions.FileFunctions.UpToDate(System.String,System.String)">
  2854. <summary>
  2855. Determines whether <paramref name="targetFile"/> is more or equal
  2856. up-to-date than <paramref name="srcFile"/>.
  2857. </summary>
  2858. <param name="srcFile">The file to check against the target file.</param>
  2859. <param name="targetFile">The file for which we want to determine the status.</param>
  2860. <returns>
  2861. <see langword="true"/> if <paramref name="targetFile"/> is more
  2862. or equal up-to-date than <paramref name="srcFile"/>; otherwise,
  2863. <see langword="false"/>.
  2864. </returns>
  2865. <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>
  2866. <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>
  2867. </member>
  2868. <member name="M:NAnt.Core.Functions.FileFunctions.GetLength(System.String)">
  2869. <summary>
  2870. Gets the length of the file.
  2871. </summary>
  2872. <param name="file">filename</param>
  2873. <returns>
  2874. Length in bytes, of the file named <paramref name="file"/>.
  2875. </returns>
  2876. <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception>
  2877. </member>
  2878. <member name="M:NAnt.Core.Functions.FileFunctions.IsAssembly(System.String)">
  2879. <summary>
  2880. Checks if a given file is an assembly.
  2881. </summary>
  2882. <param name="assemblyFile">The name or path of the file to be checked.</param>
  2883. <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>
  2884. <exception cref="T:System.ArgumentNullException"><paramref name="assemblyFile"/> is a null <see cref="T:System.String"/>.</exception>
  2885. <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
  2886. <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>
  2887. <exception cref="T:System.Security.SecurityException">The caller does not have path discovery permission.</exception>
  2888. </member>
  2889. <member name="T:NAnt.Core.Functions.FileVersionInfoFunctions">
  2890. <summary>
  2891. Functions that provide version information for a physical file on disk.
  2892. </summary>
  2893. </member>
  2894. <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetVersionInfo(System.String)">
  2895. <summary>
  2896. Returns a <see cref="T:System.Diagnostics.FileVersionInfo"/> representing the version
  2897. information associated with the specified file.
  2898. </summary>
  2899. <param name="fileName">The file to retrieve the version information for.</param>
  2900. <returns>
  2901. A <see cref="T:System.Diagnostics.FileVersionInfo"/> containing information about the file.
  2902. </returns>
  2903. <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception>
  2904. </member>
  2905. <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetCompanyName(System.Diagnostics.FileVersionInfo)">
  2906. <summary>
  2907. Gets the name of the company that produced the file.
  2908. </summary>
  2909. <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
  2910. <returns>
  2911. The name of the company that produced the file.
  2912. </returns>
  2913. </member>
  2914. <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetFileVersion(System.Diagnostics.FileVersionInfo)">
  2915. <summary>
  2916. Gets the file version of a file.
  2917. </summary>
  2918. <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
  2919. <returns>
  2920. The file version of a file.
  2921. </returns>
  2922. <see cref="T:NAnt.Core.Functions.VersionFunctions"/>
  2923. </member>
  2924. <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductName(System.Diagnostics.FileVersionInfo)">
  2925. <summary>
  2926. Gets the name of the product the file is distributed with.
  2927. </summary>
  2928. <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
  2929. <returns>
  2930. The name of the product the file is distributed with.
  2931. </returns>
  2932. </member>
  2933. <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductVersion(System.Diagnostics.FileVersionInfo)">
  2934. <summary>
  2935. Gets the product version of a file.
  2936. </summary>
  2937. <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
  2938. <returns>
  2939. The product version of a file.
  2940. </returns>
  2941. <see cref="T:NAnt.Core.Functions.VersionFunctions"/>
  2942. </member>
  2943. <member name="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)">
  2944. <summary>
  2945. Checks whether the specified framework exists, and is valid.
  2946. </summary>
  2947. <param name="framework">The framework to test.</param>
  2948. <returns>
  2949. <see langword="true" /> if the specified framework exists ; otherwise,
  2950. <see langword="false" />.
  2951. </returns>
  2952. </member>
  2953. <member name="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)">
  2954. <summary>
  2955. Checks whether the SDK for the specified framework is installed.
  2956. </summary>
  2957. <param name="framework">The framework to test.</param>
  2958. <returns>
  2959. <see langword="true"/> if the SDK for specified framework is installed;
  2960. otherwise, <see langword="false"/>.
  2961. </returns>
  2962. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
  2963. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
  2964. </member>
  2965. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework">
  2966. <summary>
  2967. Gets the identifier of the current target framework.
  2968. </summary>
  2969. <returns>
  2970. The identifier of the current target framework.
  2971. </returns>
  2972. </member>
  2973. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework">
  2974. <summary>
  2975. Gets the identifier of the runtime framework.
  2976. </summary>
  2977. <returns>
  2978. The identifier of the runtime framework.
  2979. </returns>
  2980. </member>
  2981. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFamily(System.String)">
  2982. <summary>
  2983. Gets the family of the specified framework.
  2984. </summary>
  2985. <param name="framework">The framework of which the family should be returned.</param>
  2986. <returns>
  2987. The family of the specified framework.
  2988. </returns>
  2989. <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
  2990. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
  2991. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
  2992. </member>
  2993. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetVersion">
  2994. <summary>
  2995. Gets the version of the current target framework.
  2996. </summary>
  2997. <returns>
  2998. The version of the current target framework.
  2999. </returns>
  3000. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
  3001. </member>
  3002. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetVersion(System.String)">
  3003. <summary>
  3004. Gets the version of the specified framework.
  3005. </summary>
  3006. <param name="framework">The framework of which the version should be returned.</param>
  3007. <returns>
  3008. The version of the specified framework.
  3009. </returns>
  3010. <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
  3011. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
  3012. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
  3013. </member>
  3014. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetDescription">
  3015. <summary>
  3016. Gets the description of the current target framework.
  3017. </summary>
  3018. <returns>
  3019. The description of the current target framework.
  3020. </returns>
  3021. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
  3022. </member>
  3023. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetDescription(System.String)">
  3024. <summary>
  3025. Gets the description of the specified framework.
  3026. </summary>
  3027. <param name="framework">The framework of which the description should be returned.</param>
  3028. <returns>
  3029. The description of the specified framework.
  3030. </returns>
  3031. <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
  3032. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
  3033. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
  3034. </member>
  3035. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetClrVersion">
  3036. <summary>
  3037. Gets the Common Language Runtime version of the current target
  3038. framework.
  3039. </summary>
  3040. <returns>
  3041. The Common Language Runtime version of the current target framework.
  3042. </returns>
  3043. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
  3044. </member>
  3045. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetClrVersion(System.String)">
  3046. <summary>
  3047. Gets the Common Language Runtime version of the specified framework.
  3048. </summary>
  3049. <param name="framework">The framework of which the Common Language Runtime version should be returned.</param>
  3050. <returns>
  3051. The Common Language Runtime version of the specified framework.
  3052. </returns>
  3053. <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
  3054. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
  3055. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
  3056. </member>
  3057. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFrameworkDirectory(System.String)">
  3058. <summary>
  3059. Gets the framework directory of the specified framework.
  3060. </summary>
  3061. <param name="framework">The framework of which the framework directory should be returned.</param>
  3062. <returns>
  3063. The framework directory of the specified framework.
  3064. </returns>
  3065. <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
  3066. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
  3067. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
  3068. </member>
  3069. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetAssemblyDirectory(System.String)">
  3070. <summary>
  3071. Gets the assembly directory of the specified framework.
  3072. </summary>
  3073. <param name="framework">The framework of which the assembly directory should be returned.</param>
  3074. <returns>
  3075. The assembly directory of the specified framework.
  3076. </returns>
  3077. <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
  3078. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
  3079. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
  3080. </member>
  3081. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetSdkDirectory(System.String)">
  3082. <summary>
  3083. Gets the SDK directory of the specified framework.
  3084. </summary>
  3085. <param name="framework">The framework of which the SDK directory should be returned.</param>
  3086. <returns>
  3087. The SDK directory of the specified framework, or an empty
  3088. <see cref="T:System.String"/> if the SDK of the specified framework is not
  3089. installed.
  3090. </returns>
  3091. <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
  3092. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
  3093. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
  3094. </member>
  3095. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetToolPath(System.String)">
  3096. <summary>
  3097. Gets the absolute path of the specified tool for the current
  3098. target framework.
  3099. </summary>
  3100. <param name="tool">The file name of the tool to search for.</param>
  3101. <returns>
  3102. The absolute path to <paramref name="tool"/> if found in one of the
  3103. configured tool paths; otherwise, an error is reported.
  3104. </returns>
  3105. <exception cref="T:System.IO.FileNotFoundException"><paramref name="tool"/> could not be found in the configured tool paths.</exception>
  3106. <remarks>
  3107. <para>
  3108. The configured tool paths are scanned in the order in which they
  3109. are defined in the framework configuration.
  3110. </para>
  3111. <para>
  3112. The file name of the tool to search should include the extension.
  3113. </para>
  3114. </remarks>
  3115. <example>
  3116. <para>Use <b>gacutil</b> to install an assembly in the GAC.</para>
  3117. <code>
  3118. <![CDATA[
  3119. <exec program="${framework::get-tool-path('gacutil.exe')}" managed="strict">
  3120. <arg value="/i" />
  3121. <arg file="Cegeka.HealthFramework.dll" />
  3122. </exec>
  3123. ]]>
  3124. </code>
  3125. </example>
  3126. </member>
  3127. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeEngine(System.String)">
  3128. <summary>
  3129. Gets the runtime engine of the specified framework.
  3130. </summary>
  3131. <param name="framework">The framework of which the runtime engine should be returned.</param>
  3132. <returns>
  3133. The full path to the runtime engine of the specified framework, or
  3134. an empty <see cref="T:System.String"/> if no runtime engine is defined
  3135. for the specified framework.
  3136. </returns>
  3137. <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
  3138. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
  3139. <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
  3140. </member>
  3141. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFrameworks(NAnt.Core.FrameworkTypes)">
  3142. <summary>
  3143. Gets a comma-separated list of frameworks filtered by the specified
  3144. <see cref="T:NAnt.Core.FrameworkTypes"/>.
  3145. </summary>
  3146. <param name="types">A bitwise combination of <see cref="T:NAnt.Core.FrameworkTypes"/> values that filter the frameworks to retrieve.</param>
  3147. <returns>
  3148. A comma-separated list of frameworks filtered by the specified
  3149. <see cref="T:NAnt.Core.FrameworkTypes"/>, sorted on name.
  3150. </returns>
  3151. <example>
  3152. <para>
  3153. Define a <b>build-all</b> target that executes the <b>build</b>
  3154. target once for each installed framework targeting compact
  3155. devices.
  3156. </para>
  3157. <code>
  3158. <![CDATA[
  3159. <target name="build-all">
  3160. <foreach item="String" in="${framework::get-frameworks('installed compact')}" delim="," property="framework">
  3161. <property name="nant.settings.currentframework" value="${framework}" />
  3162. <call target="build" />
  3163. </foreach>
  3164. </target>
  3165. <target name="build">
  3166. ...
  3167. </target>
  3168. ]]>
  3169. </code>
  3170. </example>
  3171. </member>
  3172. <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFramework(System.String)">
  3173. <summary>
  3174. Checks whether the specified framework is valid.
  3175. </summary>
  3176. <param name="framework">The framework to check.</param>
  3177. <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
  3178. </member>
  3179. <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.Parse(System.String)">
  3180. <summary>
  3181. Converts the specified string representation of a number to its
  3182. 32-bit signed integer equivalent.
  3183. </summary>
  3184. <param name="s">A string containing a number to convert.</param>
  3185. <returns>
  3186. A 32-bit signed integer equivalent to the number contained in
  3187. <paramref name="s"/>.
  3188. </returns>
  3189. <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception>
  3190. <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>
  3191. <remarks>
  3192. The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
  3193. used to supply formatting information about <paramref name="s"/>.
  3194. </remarks>
  3195. </member>
  3196. <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.ToString(System.Int32)">
  3197. <summary>
  3198. Converts the specified <see cref="T:System.Int32"/> to its equivalent string
  3199. representation.
  3200. </summary>
  3201. <param name="value">A <see cref="T:System.Int32"/> to convert.</param>
  3202. <returns>
  3203. The string representation of <paramref name="value"/>, consisting
  3204. of a negative sign if the value is negative, and a sequence of
  3205. digits ranging from 0 to 9 with no leading zeroes.
  3206. </returns>
  3207. <remarks>
  3208. <paramref name="value"/> is formatted with the
  3209. <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
  3210. </remarks>
  3211. </member>
  3212. <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.Parse(System.String)">
  3213. <summary>
  3214. Converts the specified string representation of a number to its
  3215. 64-bit signed integer equivalent.
  3216. </summary>
  3217. <param name="s">A string containing a number to convert.</param>
  3218. <returns>
  3219. A 64-bit signed integer equivalent to the number contained in
  3220. <paramref name="s"/>.
  3221. </returns>
  3222. <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception>
  3223. <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>
  3224. <remarks>
  3225. The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
  3226. used to supply formatting information about <paramref name="s"/>.
  3227. </remarks>
  3228. </member>
  3229. <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.ToString(System.Int64)">
  3230. <summary>
  3231. Converts the specified <see cref="T:System.Int64"/> to its equivalent string
  3232. representation.
  3233. </summary>
  3234. <param name="value">A <see cref="T:System.Int64"/> to convert.</param>
  3235. <returns>
  3236. The string representation of <paramref name="value"/>, consisting
  3237. of a negative sign if the value is negative, and a sequence of
  3238. digits ranging from 0 to 9 with no leading zeroes.
  3239. </returns>
  3240. <remarks>
  3241. <paramref name="value"/> is formatted with the
  3242. <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
  3243. </remarks>
  3244. </member>
  3245. <member name="M:NAnt.Core.Functions.MathFunctions.Round(System.Double)">
  3246. <summary>
  3247. Rounds the value to the nearest whole number
  3248. </summary>
  3249. <param name="value">Number to be rounded, can be anything convertible to a double.</param>
  3250. <returns>
  3251. Rounded value.
  3252. </returns>
  3253. </member>
  3254. <member name="M:NAnt.Core.Functions.MathFunctions.Floor(System.Double)">
  3255. <summary>
  3256. Returns the largest whole number less than or equal to the specified
  3257. number.
  3258. </summary>
  3259. <param name="value">value to be , can be anything convertible to a double</param>
  3260. <returns>
  3261. The largest whole number less than or equal to the specified number.
  3262. </returns>
  3263. </member>
  3264. <member name="M:NAnt.Core.Functions.MathFunctions.Ceiling(System.Double)">
  3265. <summary>
  3266. Returns the smallest whole number greater than or equal to the specified number
  3267. </summary>
  3268. <param name="value">value</param>
  3269. <returns>
  3270. The smallest whole number greater than or equal to the specified number.
  3271. </returns>
  3272. </member>
  3273. <member name="M:NAnt.Core.Functions.MathFunctions.Abs(System.Double)">
  3274. <summary>
  3275. Returns the absolute value of the specified number
  3276. </summary>
  3277. <param name="value">value to take the absolute value from</param>
  3278. <returns>
  3279. <paramref name="value" /> when <paramref name="value" /> is greater
  3280. than or equal to zero; otherwise, -<paramref name="value" />.
  3281. </returns>
  3282. </member>
  3283. <member name="M:NAnt.Core.Functions.NAntFunctions.GetBaseDirectory">
  3284. <summary>
  3285. Gets the base directory of the appdomain in which NAnt is running.
  3286. </summary>
  3287. <returns>
  3288. The base directory of the appdomain in which NAnt is running.
  3289. </returns>
  3290. </member>
  3291. <member name="M:NAnt.Core.Functions.NAntFunctions.GetAssembly">
  3292. <summary>
  3293. Gets the NAnt assembly.
  3294. </summary>
  3295. <returns>
  3296. The NAnt assembly.
  3297. </returns>
  3298. </member>
  3299. <member name="M:NAnt.Core.Functions.NAntFunctions.ScanProbingPaths(System.String)">
  3300. <summary>
  3301. Searches the probing paths of the current target framework for the
  3302. specified file.
  3303. </summary>
  3304. <param name="fileName">The name of the file to search for.</param>
  3305. <returns>
  3306. The absolute path to <paramref name="fileName"/> if found in one of the
  3307. configured probing; otherwise, an error is reported.
  3308. </returns>
  3309. <exception cref="T:System.IO.FileNotFoundException"><paramref name="fileName"/> could not be found in the configured probing paths.</exception>
  3310. <remarks>
  3311. <para>
  3312. The (relative) probing paths are resolved relative to the base
  3313. directory of the appdomain in which NAnt is running.
  3314. </para>
  3315. <para>
  3316. The configured probing paths are scanned recursively in the order
  3317. in which they are defined in the framework configuration.
  3318. </para>
  3319. <para>
  3320. The file name to search should include the extension.
  3321. </para>
  3322. </remarks>
  3323. <example>
  3324. <para>
  3325. Compile an assembly referencing the <c>nunit.framework</c> assembly
  3326. for the current target framework that is shipped as part of the
  3327. NAnt distribution.
  3328. </para>
  3329. <code>
  3330. <![CDATA[
  3331. <csc target="library" output="NAnt.Core.Tests.dll">
  3332. <sources basedir="NAnt.Core">
  3333. <include name="**/*.cs" />
  3334. </sources>
  3335. <references>
  3336. <include name="NAnt.Core.dll" />
  3337. <include name="${framework::get-lib-path('nunit.framework.dll')}" />
  3338. </references>
  3339. </csc>
  3340. ]]>
  3341. </code>
  3342. </example>
  3343. </member>
  3344. <member name="M:NAnt.Core.Functions.NAntFunctions.ScanProbingPaths(System.String,System.String)">
  3345. <summary>
  3346. Searches the probing paths of the current target framework for the
  3347. specified file.
  3348. </summary>
  3349. <param name="baseDirectory">The directory to use a base directory for the probing paths.</param>
  3350. <param name="fileName">The name of the file to search for.</param>
  3351. <returns>
  3352. The absolute path to <paramref name="fileName"/> if found in one of the
  3353. configured probing; otherwise, an error is reported.
  3354. </returns>
  3355. <exception cref="T:System.IO.FileNotFoundException"><paramref name="fileName"/> could not be found in the configured probing paths.</exception>
  3356. <remarks>
  3357. <para>
  3358. The (relative) probing paths are resolved relative to the specified
  3359. base directory.
  3360. </para>
  3361. <para>
  3362. The configured probing paths are scanned recursively in the order
  3363. in which they are defined in the framework configuration.
  3364. </para>
  3365. <para>
  3366. The file name to search should include the extension.
  3367. </para>
  3368. </remarks>
  3369. <example>
  3370. <para>
  3371. Compile an assembly referencing the <c>nunit.framework</c> assembly
  3372. for the current target framework that is shipped as part of the
  3373. NAnt distribution.
  3374. </para>
  3375. <code>
  3376. <![CDATA[
  3377. <csc target="library" output="NAnt.Core.Tests.dll">
  3378. <sources basedir="NAnt.Core">
  3379. <include name="**/*.cs" />
  3380. </sources>
  3381. <references>
  3382. <include name="NAnt.Core.dll" />
  3383. <include name="${framework::get-lib-path('nunit.framework.dll')}" />
  3384. </references>
  3385. </csc>
  3386. ]]>
  3387. </code>
  3388. </example>
  3389. </member>
  3390. <member name="M:NAnt.Core.Functions.ProjectFunctions.GetName">
  3391. <summary>
  3392. Gets the name of the current project.
  3393. </summary>
  3394. <returns>
  3395. The name of the current project, or an empty <see cref="T:System.String"/>
  3396. if no name is specified in the build file.
  3397. </returns>
  3398. </member>
  3399. <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFileUri">
  3400. <summary>
  3401. Gets the <see cref="T:System.Uri"/> form of the build file.
  3402. </summary>
  3403. <returns>
  3404. The <see cref="T:System.Uri"/> form of the build file, or
  3405. an empty <see cref="T:System.String"/> if the project is not file backed.
  3406. </returns>
  3407. </member>
  3408. <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFilePath">
  3409. <summary>
  3410. Gets the local path to the build file.
  3411. </summary>
  3412. <returns>
  3413. The local path of the build file, or an empty <see cref="T:System.String"/>
  3414. if the project is not file backed.
  3415. </returns>
  3416. </member>
  3417. <member name="M:NAnt.Core.Functions.ProjectFunctions.GetDefaultTarget">
  3418. <summary>
  3419. Gets the name of the target that will be executed when no other
  3420. build targets are specified.
  3421. </summary>
  3422. <returns>
  3423. The name of the target that will be executed when no other build
  3424. targets are specified, or an empty <see cref="T:System.String"/> if no
  3425. default target is defined for the project.
  3426. </returns>
  3427. </member>
  3428. <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBaseDirectory">
  3429. <summary>
  3430. Gets the base directory of the current project.
  3431. </summary>
  3432. <returns>
  3433. The base directory of the current project.
  3434. </returns>
  3435. </member>
  3436. <member name="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)">
  3437. <summary>
  3438. Checks whether the specified target exists.
  3439. </summary>
  3440. <param name="name">The target to test.</param>
  3441. <returns>
  3442. <see langword="true" /> if the specified target exists; otherwise,
  3443. <see langword="false" />.
  3444. </returns>
  3445. <example>
  3446. <para>
  3447. Execute target &quot;clean&quot;, if it exists.
  3448. </para>
  3449. <code>
  3450. <![CDATA[
  3451. <if test="${target::exists('clean')}">
  3452. <call target="clean" />
  3453. </if>
  3454. ]]>
  3455. </code>
  3456. </example>
  3457. </member>
  3458. <member name="M:NAnt.Core.Functions.TargetFunctions.GetCurrentTarget">
  3459. <summary>
  3460. Gets the name of the target being executed.
  3461. </summary>
  3462. <returns>
  3463. A <see cref="T:System.String"/> that contains the name of the target
  3464. being executed.
  3465. </returns>
  3466. <exception cref="T:System.InvalidOperationException">No target is being executed.</exception>
  3467. </member>
  3468. <member name="M:NAnt.Core.Functions.TargetFunctions.HasExecuted(System.String)">
  3469. <summary>
  3470. Checks whether the specified target has already been executed.
  3471. </summary>
  3472. <param name="name">The target to test.</param>
  3473. <returns>
  3474. <see langword="true"/> if the specified target has already been
  3475. executed; otherwise, <see langword="false"/>.
  3476. </returns>
  3477. <exception cref="T:System.ArgumentException">Target <paramref name="name"/> does not exist.</exception>
  3478. </member>
  3479. <member name="M:NAnt.Core.Functions.TaskFunctions.Exists(System.String)">
  3480. <summary>
  3481. Checks whether the specified task exists.
  3482. </summary>
  3483. <param name="name">The task to test.</param>
  3484. <returns>
  3485. <see langword="true" /> if the specified task exists; otherwise,
  3486. <see langword="false" />.
  3487. </returns>
  3488. </member>
  3489. <member name="M:NAnt.Core.Functions.TaskFunctions.GetAssembly(System.String)">
  3490. <summary>
  3491. Returns the <see cref="T:System.Reflection.Assembly"/> from which the specified task
  3492. was loaded.
  3493. </summary>
  3494. <param name="name">The name of the task to get the <see cref="T:System.Reflection.Assembly"/> of.</param>
  3495. <returns>
  3496. The <see cref="T:System.Reflection.Assembly"/> from which the specified task was loaded.
  3497. </returns>
  3498. <exception cref="T:System.ArgumentException">Task <paramref name="name"/> is not available.</exception>
  3499. </member>
  3500. <member name="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)">
  3501. <summary>
  3502. Checks whether the specified property exists.
  3503. </summary>
  3504. <param name="name">The property to test.</param>
  3505. <returns>
  3506. <see langword="true" /> if the specified property exists; otherwise,
  3507. <see langword="false" />.
  3508. </returns>
  3509. <example>
  3510. <para>
  3511. Execute a set of tasks if the &quot;build.debug&quot; property
  3512. exists.
  3513. </para>
  3514. <code>
  3515. <![CDATA[
  3516. <if test="${property::exists('build.debug')}">
  3517. <echo message="Starting debug build" />
  3518. <call target="init-debug" />
  3519. <call target="build" />
  3520. </if>
  3521. ]]>
  3522. </code>
  3523. </example>
  3524. </member>
  3525. <member name="M:NAnt.Core.Functions.PropertyFunctions.IsReadOnly(System.String)">
  3526. <summary>
  3527. Checks whether the specified property is read-only.
  3528. </summary>
  3529. <param name="name">The property to test.</param>
  3530. <returns>
  3531. <see langword="true"/> if the specified property is read-only;
  3532. otherwise, <see langword="false"/>.
  3533. </returns>
  3534. <example>
  3535. <para>Check whether the "debug" property is read-only.</para>
  3536. <code>property::is-readonly('debug')</code>
  3537. </example>
  3538. <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception>
  3539. </member>
  3540. <member name="M:NAnt.Core.Functions.PropertyFunctions.IsDynamic(System.String)">
  3541. <summary>
  3542. Checks whether the specified property is a dynamic property.
  3543. </summary>
  3544. <param name="name">The property to test.</param>
  3545. <returns>
  3546. <see langword="true"/> if the specified property is a dynamic
  3547. property; otherwise, <see langword="false"/>.
  3548. </returns>
  3549. <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception>
  3550. <example>
  3551. <para>
  3552. Check whether the "debug" property is a dynamic property.
  3553. </para>
  3554. <code>property::is-dynamic('debug')</code>
  3555. </example>
  3556. </member>
  3557. <member name="M:NAnt.Core.Functions.PlatformFunctions.GetName">
  3558. <summary>
  3559. Gets the name of the platform on which NAnt is running.
  3560. </summary>
  3561. <returns>
  3562. The name of the platform on which NAnt is running.
  3563. </returns>
  3564. </member>
  3565. <member name="M:NAnt.Core.Functions.PlatformFunctions.IsWin32">
  3566. <summary>
  3567. Checks whether NAnt is running on Windows (and not just 32-bit Windows
  3568. as the name may lead you to believe).
  3569. </summary>
  3570. <returns>
  3571. <see langword="true" /> if NAnt is running on Windows;
  3572. otherwise, <see langword="false" />.
  3573. </returns>
  3574. </member>
  3575. <member name="M:NAnt.Core.Functions.PlatformFunctions.IsWindows">
  3576. <summary>
  3577. Checks whether NAnt is running on Windows.
  3578. </summary>
  3579. <returns>
  3580. <see langword="true" /> if NAnt is running on Windows;
  3581. otherwise, <see langword="false" />.
  3582. </returns>
  3583. </member>
  3584. <member name="M:NAnt.Core.Functions.PlatformFunctions.IsUnix">
  3585. <summary>
  3586. Checks whether NAnt is running on Unix.
  3587. </summary>
  3588. <returns>
  3589. <see langword="true" /> if NAnt is running on Unix;
  3590. otherwise, <see langword="false" />.
  3591. </returns>
  3592. </member>
  3593. <member name="T:NAnt.Core.Functions.OperatingSystemFunctions">
  3594. <summary>
  3595. Functions that return information about an operating system.
  3596. </summary>
  3597. </member>
  3598. <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetPlatform(System.OperatingSystem)">
  3599. <summary>
  3600. Gets a <see cref="T:System.PlatformID"/> value that identifies the operating
  3601. system platform.
  3602. </summary>
  3603. <param name="operatingSystem">The operating system.</param>
  3604. <returns>
  3605. <see cref="T:System.PlatformID"/> value that identifies the operating system
  3606. platform.
  3607. </returns>
  3608. <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
  3609. </member>
  3610. <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)">
  3611. <summary>
  3612. Gets a <see cref="T:System.Version"/> object that identifies this operating
  3613. system.
  3614. </summary>
  3615. <param name="operatingSystem">The operating system.</param>
  3616. <returns>
  3617. A <see cref="T:System.Version"/> object that describes the major version,
  3618. minor version, build, and revision of the operating system.
  3619. </returns>
  3620. <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
  3621. </member>
  3622. <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.ToString(System.OperatingSystem)">
  3623. <summary>
  3624. Converts the value of the specified operating system to its equivalent
  3625. <see cref="T:System.String"/> representation.
  3626. </summary>
  3627. <param name="operatingSystem">The operating system.</param>
  3628. <returns>
  3629. The <see cref="T:System.String"/> representation of
  3630. <paramref name="operatingSystem"/>.
  3631. </returns>
  3632. <example>
  3633. <para>
  3634. Output string representation of the current operating system.
  3635. </para>
  3636. <code>
  3637. <![CDATA[
  3638. <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" />
  3639. ]]>
  3640. </code>
  3641. <para>If the operating system is Windows 2000, the output is:</para>
  3642. <code>
  3643. Microsoft Windows NT 5.0.2195.0
  3644. </code>
  3645. </example>
  3646. <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
  3647. </member>
  3648. <member name="M:NAnt.Core.Functions.PathFunctions.GetFullPath(System.String)">
  3649. <summary>
  3650. Returns the fully qualified path.
  3651. </summary>
  3652. <param name="path">The file or directory for which to obtain absolute path information.</param>
  3653. <returns>
  3654. A string containing the fully qualified location of <paramref name="path"/>,
  3655. such as "C:\MyFile.txt".
  3656. </returns>
  3657. <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>
  3658. <exception cref="T:System.NotSupportedException"><paramref name="path"/> contains a colon (":").</exception>
  3659. <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
  3660. </member>
  3661. <member name="M:NAnt.Core.Functions.PathFunctions.Combine(System.String,System.String)">
  3662. <summary>
  3663. Combines two paths.
  3664. </summary>
  3665. <param name="path1">first path</param>
  3666. <param name="path2">second path</param>
  3667. <returns>
  3668. A string containing the combined paths. If one of the specified paths
  3669. is a zero-length string, this method returns the other path. If
  3670. <paramref name="path2"/> contains an absolute path, this method
  3671. returns <paramref name="path2"/>.
  3672. </returns>
  3673. <exception cref="T:System.ArgumentException"><paramref name="path1"/> or <paramref name="path2"/> contain one or more invalid characters.</exception>
  3674. </member>
  3675. <member name="M:NAnt.Core.Functions.PathFunctions.ChangeExtension(System.String,System.String)">
  3676. <summary>
  3677. Changes the extension of the path string.
  3678. </summary>
  3679. <param name="path">The path information to modify. The path cannot contain any of the characters
  3680. defined in <see cref="F:System.IO.Path.InvalidPathChars"/>InvalidPathChars.</param>
  3681. <param name="extension">The new extension (with a leading period). Specify a null reference
  3682. to remove an existing extension from <paramref name="path"/>.</param>
  3683. <returns>
  3684. <para>
  3685. A string containing the modified path information.
  3686. </para>
  3687. <para>
  3688. On Windows-based desktop platforms, if <paramref name="path"/> is
  3689. an empty <see cref="T:System.String"/>, the path information is returned
  3690. unmodified. If <paramref name="path"/> has no extension, the returned
  3691. path <see cref="T:System.String"/> contains <paramref name="extension"/>
  3692. appended to the end of <paramref name="path"/>.
  3693. </para>
  3694. </returns>
  3695. <remarks>
  3696. For more information see the <see cref="T:System.IO.Path"/> documentation.
  3697. </remarks>
  3698. <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
  3699. </member>
  3700. <member name="M:NAnt.Core.Functions.PathFunctions.GetDirectoryName(System.String)">
  3701. <summary>
  3702. Returns the directory information for the specified path string.
  3703. </summary>
  3704. <param name="path">The path of a file or directory.</param>
  3705. <returns>
  3706. A <see cref="T:System.String"/> containing directory information for
  3707. <paramref name="path"/>, or an empty <see cref="T:System.String"/> if
  3708. <paramref name="path"/> denotes a root directory, or does not
  3709. contain directory information.
  3710. </returns>
  3711. <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, is empty, or contains only white spaces.</exception>
  3712. </member>
  3713. <member name="M:NAnt.Core.Functions.PathFunctions.GetExtension(System.String)">
  3714. <summary>
  3715. Returns the extension for the specified path string.
  3716. </summary>
  3717. <param name="path">The path string from which to get the extension.</param>
  3718. <returns>
  3719. A <see cref="T:System.String"/> containing the extension of the specified
  3720. <paramref name="path"/> (including the "."), or an empty
  3721. <see cref="T:System.String"/> if <paramref name="path"/> does not have
  3722. extension information.
  3723. </returns>
  3724. <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
  3725. </member>
  3726. <member name="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)">
  3727. <summary>
  3728. Returns the filename for the specified path string.
  3729. </summary>
  3730. <param name="path">The path string from which to obtain the file name and extension.</param>
  3731. <returns>
  3732. <para>
  3733. A <see cref="T:System.String"/> consisting of the characters after the last
  3734. directory character in path.
  3735. </para>
  3736. <para>
  3737. If the last character of <paramref name="path"/> is a directory or
  3738. volume separator character, an empty <see cref="T:System.String"/> is returned.
  3739. </para>
  3740. </returns>
  3741. <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
  3742. </member>
  3743. <member name="M:NAnt.Core.Functions.PathFunctions.GetFileNameWithoutExtension(System.String)">
  3744. <summary>
  3745. Returns the filename without extension for the specified path string.
  3746. </summary>
  3747. <param name="path">The path of the file.</param>
  3748. <returns>
  3749. A <see cref="T:System.String"/> containing the <see cref="T:System.String"/> returned
  3750. by <see cref="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)"/>, minus the last period (.) and all
  3751. characters following it.
  3752. </returns>
  3753. <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
  3754. </member>
  3755. <member name="M:NAnt.Core.Functions.PathFunctions.GetPathRoot(System.String)">
  3756. <summary>
  3757. Gets the root directory of the specified path.
  3758. </summary>
  3759. <param name="path">The path from which to obtain root directory information.</param>
  3760. <returns>
  3761. A <see cref="T:System.String"/> containing the root directory of
  3762. <paramref name="path"/>, such as "C:\", or an empty <see cref="T:System.String"/>
  3763. if <paramref name="path"/> does not contain root directory information.
  3764. </returns>
  3765. <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, or is empty.</exception>
  3766. </member>
  3767. <member name="M:NAnt.Core.Functions.PathFunctions.GetTempFileName">
  3768. <summary>
  3769. Returns a uniquely named zero-byte temporary file on disk and returns the full path to that file.
  3770. </summary>
  3771. <returns>
  3772. A <see cref="T:System.String"/> containing the name of the temporary file.
  3773. </returns>
  3774. </member>
  3775. <member name="M:NAnt.Core.Functions.PathFunctions.GetTempPath">
  3776. <summary>
  3777. Gets the path to the temporary directory.
  3778. </summary>
  3779. <returns>
  3780. A <see cref="T:System.String"/> containing the path information of a
  3781. temporary directory.
  3782. </returns>
  3783. </member>
  3784. <member name="M:NAnt.Core.Functions.PathFunctions.HasExtension(System.String)">
  3785. <summary>
  3786. Determines whether a path string includes an extension.
  3787. </summary>
  3788. <param name="path">The path to search for an extension.</param>
  3789. <returns>
  3790. <see langword="true"/>. if the characters that follow the last
  3791. directory separator or volume separator in the <paramref name="path"/>
  3792. include a period (.) followed by one or more characters;
  3793. otherwise, <see langword="false"/>.
  3794. </returns>
  3795. <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
  3796. </member>
  3797. <member name="M:NAnt.Core.Functions.PathFunctions.IsPathRooted(System.String)">
  3798. <summary>
  3799. Determines whether a path string is absolute.
  3800. </summary>
  3801. <param name="path">The path to test.</param>
  3802. <returns>
  3803. <see langword="true"/> if path contains an absolute <paramref name="path"/>;
  3804. otherwise, <see langword="false"/>.
  3805. </returns>
  3806. <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
  3807. </member>
  3808. <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetVariable(System.String,System.String)">
  3809. <summary>
  3810. Gets the value of a variable for the specified package.
  3811. </summary>
  3812. <param name="package">The package for which the variable should be retrieved.</param>
  3813. <param name="name">The name of the variable.</param>
  3814. <returns>
  3815. The value of variable <paramref name="name"/> for the specified
  3816. package.
  3817. </returns>
  3818. <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
  3819. <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
  3820. </member>
  3821. <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetLinkFlags(System.String)">
  3822. <summary>
  3823. Gets the link flags required to compile the package, including all
  3824. its dependencies.
  3825. </summary>
  3826. <param name="package">The package for which the link flags should be retrieved.</param>
  3827. <returns>
  3828. The link flags required to compile the package.
  3829. </returns>
  3830. <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
  3831. <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
  3832. </member>
  3833. <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetCompileFlags(System.String)">
  3834. <summary>
  3835. Gets the compile flags required to compile the package, including all
  3836. its dependencies.
  3837. </summary>
  3838. <param name="package">The package for which the compile flags should be retrieved.</param>
  3839. <returns>
  3840. The pre-processor and compile flags required to compile the package.
  3841. </returns>
  3842. <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
  3843. <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
  3844. </member>
  3845. <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetModVersion(System.String)">
  3846. <summary>
  3847. Determines the version of the given package.
  3848. </summary>
  3849. <param name="package">The package to get the version of.</param>
  3850. <returns>
  3851. The version of the given package.
  3852. </returns>
  3853. <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
  3854. <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
  3855. </member>
  3856. <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsAtLeastVersion(System.String,System.String)">
  3857. <summary>
  3858. Determines whether the given package is at least version
  3859. <paramref name="version"/>.
  3860. </summary>
  3861. <param name="package">The package to check.</param>
  3862. <param name="version">The version the package should at least have.</param>
  3863. <returns>
  3864. <see langword="true"/> if the given package is at least version
  3865. <paramref name="version"/>; otherwise, <see langword="false"/>.
  3866. </returns>
  3867. <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
  3868. </member>
  3869. <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsExactVersion(System.String,System.String)">
  3870. <summary>
  3871. Determines whether the given package is exactly version
  3872. <paramref name="version"/>.
  3873. </summary>
  3874. <param name="package">The package to check.</param>
  3875. <param name="version">The version the package should have.</param>
  3876. <returns>
  3877. <see langword="true"/> if the given package is exactly version
  3878. <paramref name="version"/>; otherwise, <see langword="false"/>.
  3879. </returns>
  3880. <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
  3881. </member>
  3882. <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsMaxVersion(System.String,System.String)">
  3883. <summary>
  3884. Determines whether the given package is at no newer than version
  3885. <paramref name="version"/>.
  3886. </summary>
  3887. <param name="package">The package to check.</param>
  3888. <param name="version">The version the package should maximum have.</param>
  3889. <returns>
  3890. <see langword="true"/> if the given package is at no newer than
  3891. version <paramref name="version"/>; otherwise, <see langword="false"/>.
  3892. </returns>
  3893. <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
  3894. </member>
  3895. <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsBetweenVersion(System.String,System.String,System.String)">
  3896. <summary>
  3897. Determines whether the given package is between two versions.
  3898. </summary>
  3899. <param name="package">The package to check.</param>
  3900. <param name="minVersion">The version the package should at least have.</param>
  3901. <param name="maxVersion">The version the package should maximum have.</param>
  3902. <returns>
  3903. <see langword="true"/> if the given package is between <paramref name="minVersion"/>
  3904. and <paramref name="maxVersion"/>; otherwise, <see langword="false"/>.
  3905. </returns>
  3906. <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
  3907. </member>
  3908. <member name="M:NAnt.Core.Functions.PkgConfigFunctions.Exists(System.String)">
  3909. <summary>
  3910. Determines whether the given package exists.
  3911. </summary>
  3912. <param name="package">The package to check.</param>
  3913. <returns>
  3914. <see langword="true"/> if the package exists; otherwise,
  3915. <see langword="false"/>.
  3916. </returns>
  3917. <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
  3918. </member>
  3919. <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigBool(NAnt.Core.Types.Argument[])">
  3920. <summary>
  3921. Runs pkg-config with the specified arguments and returns a
  3922. <see cref="T:System.Boolean"/> based on the exit code.
  3923. </summary>
  3924. <param name="args">The arguments to pass to pkg-config.</param>
  3925. <returns>
  3926. <see langword="true"/> if pkg-config exited with exit code 0;
  3927. otherwise, <see langword="false"/>
  3928. </returns>
  3929. </member>
  3930. <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigString(NAnt.Core.Types.Argument[])">
  3931. <summary>
  3932. Runs pkg-config with the specified arguments and returns the result
  3933. as a <see cref="T:System.String"/>.
  3934. </summary>
  3935. <param name="args">The arguments to pass to pkg-config.</param>
  3936. <returns>
  3937. The result of running pkg-config with the specified arguments.
  3938. </returns>
  3939. </member>
  3940. <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetTask(System.IO.Stream)">
  3941. <summary>
  3942. Factory method to return a new instance of ExecTask
  3943. </summary>
  3944. <param name="stream"></param>
  3945. <returns></returns>
  3946. </member>
  3947. <member name="M:NAnt.Core.Functions.StringFunctions.GetLength(System.String)">
  3948. <summary>
  3949. Returns the length of the specified string.
  3950. </summary>
  3951. <param name="s">input string</param>
  3952. <returns>
  3953. The string's length.
  3954. </returns>
  3955. <example>
  3956. <code>string::get-length('foo') ==> 3</code>
  3957. </example>
  3958. <example>
  3959. <code>string::get-length('') ==> 0</code>
  3960. </example>
  3961. </member>
  3962. <member name="M:NAnt.Core.Functions.StringFunctions.Substring(System.String,System.Int32,System.Int32)">
  3963. <summary>
  3964. Returns a substring of the specified string.
  3965. </summary>
  3966. <param name="str">input string</param>
  3967. <param name="startIndex">position of the start of the substring</param>
  3968. <param name="length">the length of the substring</param>
  3969. <returns>
  3970. <para>
  3971. If the <paramref name="length"/> is greater than zero, the
  3972. function returns a substring starting at character position
  3973. <paramref name="startIndex"/> with a length of <paramref name="length"/>
  3974. characters.
  3975. </para>
  3976. <para>
  3977. If the <paramref name="length"/> is equal to zero, the function
  3978. returns an empty string.
  3979. </para>
  3980. </returns>
  3981. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> or <paramref name="length"/> is less than zero.</exception>
  3982. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> is greater than the length of <paramref name="str"/>.</exception>
  3983. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> plus <paramref name="length"/> indicates a position not within <paramref name="str"/>.</exception>
  3984. <example>
  3985. <code>string::substring('testing string', 0, 4) ==&gt; 'test'</code>
  3986. </example>
  3987. <example>
  3988. <code>string::substring('testing string', 8, 3) ==&gt; 'str'</code>
  3989. </example>
  3990. <example>
  3991. <code>string::substring('testing string', 8, 0) ==&gt; ''</code>
  3992. </example>
  3993. <example>
  3994. <code>string::substring('testing string', -1, 5) ==&gt; ERROR</code>
  3995. </example>
  3996. <example>
  3997. <code>string::substring('testing string', 8, -1) ==&gt; ERROR</code>
  3998. </example>
  3999. <example>
  4000. <code>string::substring('testing string', 5, 17) ==&gt; ERROR</code>
  4001. </example>
  4002. </member>
  4003. <member name="M:NAnt.Core.Functions.StringFunctions.StartsWith(System.String,System.String)">
  4004. <summary>
  4005. Tests whether the specified string starts with the specified prefix
  4006. string.
  4007. </summary>
  4008. <param name="s1">test string</param>
  4009. <param name="s2">prefix string</param>
  4010. <returns>
  4011. <see langword="true" /> when <paramref name="s2" /> is a prefix for
  4012. the string <paramref name="s1" />. Meaning, the characters at the
  4013. beginning of <paramref name="s1" /> are identical to
  4014. <paramref name="s2" />; otherwise, <see langword="false" />.
  4015. </returns>
  4016. <remarks>
  4017. This function performs a case-sensitive word search using the
  4018. invariant culture.
  4019. </remarks>
  4020. <example>
  4021. <code>string::starts-with('testing string', 'test') ==> true</code>
  4022. </example>
  4023. <example>
  4024. <code>string::starts-with('testing string', 'testing') ==> true</code>
  4025. </example>
  4026. <example>
  4027. <code>string::starts-with('testing string', 'string') ==> false</code>
  4028. </example>
  4029. <example>
  4030. <code>string::starts-with('test', 'testing string') ==> false</code>
  4031. </example>
  4032. </member>
  4033. <member name="M:NAnt.Core.Functions.StringFunctions.EndsWith(System.String,System.String)">
  4034. <summary>
  4035. Tests whether the specified string ends with the specified suffix
  4036. string.
  4037. </summary>
  4038. <param name="s1">test string</param>
  4039. <param name="s2">suffix string</param>
  4040. <returns>
  4041. <see langword="true" /> when <paramref name="s2" /> is a suffix for
  4042. the string <paramref name="s1" />. Meaning, the characters at the
  4043. end of <paramref name="s1" /> are identical to
  4044. <paramref name="s2" />; otherwise, <see langword="false" />.
  4045. </returns>
  4046. <remarks>
  4047. This function performs a case-sensitive word search using the
  4048. invariant culture.
  4049. </remarks>
  4050. <example>
  4051. <code>string::ends-with('testing string', 'string') ==> true</code>
  4052. </example>
  4053. <example>
  4054. <code>string::ends-with('testing string', '') ==> true</code>
  4055. </example>
  4056. <example>
  4057. <code>string::ends-with('testing string', 'bring') ==> false</code>
  4058. </example>
  4059. <example>
  4060. <code>string::ends-with('string', 'testing string') ==> false</code>
  4061. </example>
  4062. </member>
  4063. <member name="M:NAnt.Core.Functions.StringFunctions.ToLower(System.String)">
  4064. <summary>
  4065. Returns the specified string converted to lowercase.
  4066. </summary>
  4067. <param name="s">input string</param>
  4068. <returns>
  4069. The string <paramref name="s" /> in lowercase.
  4070. </returns>
  4071. <remarks>
  4072. The casing rules of the invariant culture are used to convert the
  4073. <paramref name="s" /> to lowercase.
  4074. </remarks>
  4075. <example>
  4076. <code>string::to-lower('testing string') ==> 'testing string'</code>
  4077. </example>
  4078. <example>
  4079. <code>string::to-lower('Testing String') ==> 'testing string'</code>
  4080. </example>
  4081. <example>
  4082. <code>string::to-lower('Test 123') ==> 'test 123'</code>
  4083. </example>
  4084. </member>
  4085. <member name="M:NAnt.Core.Functions.StringFunctions.ToUpper(System.String)">
  4086. <summary>
  4087. Returns the specified string converted to uppercase.
  4088. </summary>
  4089. <param name="s">input string</param>
  4090. <returns>
  4091. The string <paramref name="s" /> in uppercase.
  4092. </returns>
  4093. <remarks>
  4094. The casing rules of the invariant culture are used to convert the
  4095. <paramref name="s" /> to uppercase.
  4096. </remarks>
  4097. <example>
  4098. <code>string::to-upper('testing string') ==> 'TESTING STRING'</code>
  4099. </example>
  4100. <example>
  4101. <code>string::to-upper('Testing String') ==> 'TESTING STRING'</code>
  4102. </example>
  4103. <example>
  4104. <code>string::to-upper('Test 123') ==> 'TEST 123'</code>
  4105. </example>
  4106. </member>
  4107. <member name="M:NAnt.Core.Functions.StringFunctions.Replace(System.String,System.String,System.String)">
  4108. <summary>
  4109. Returns a string corresponding to the replacement of a given string
  4110. with another in the specified string.
  4111. </summary>
  4112. <param name="str">input string</param>
  4113. <param name="oldValue">A <see cref="T:System.String"/> to be replaced.</param>
  4114. <param name="newValue">A <see cref="T:System.String"/> to replace all occurrences of <paramref name="oldValue"/>.</param>
  4115. <returns>
  4116. A <see cref="T:System.String"/> equivalent to <paramref name="str"/> but
  4117. with all instances of <paramref name="oldValue"/> replaced with
  4118. <paramref name="newValue"/>.
  4119. </returns>
  4120. <exception cref="T:System.ArgumentException"><paramref name="oldValue"/> is an empty string.</exception>
  4121. <remarks>
  4122. This function performs a word (case-sensitive and culture-sensitive)
  4123. search to find <paramref name="oldValue"/>.
  4124. </remarks>
  4125. <example>
  4126. <code>string::replace('testing string', 'test', 'winn') ==&gt; 'winning string'</code>
  4127. </example>
  4128. <example>
  4129. <code>string::replace('testing string', 'foo', 'winn') ==&gt; 'testing string'</code>
  4130. </example>
  4131. <example>
  4132. <code>string::replace('testing string', 'ing', '') ==&gt; 'test str'</code>
  4133. </example>
  4134. <example>
  4135. <code>string::replace('banana', 'ana', 'ana') ==&gt; 'banana'</code>
  4136. </example>
  4137. </member>
  4138. <member name="M:NAnt.Core.Functions.StringFunctions.Contains(System.String,System.String)">
  4139. <summary>
  4140. Tests whether the specified string contains the given search string.
  4141. </summary>
  4142. <param name="source">The string to search.</param>
  4143. <param name="value">The string to locate within <paramref name="source" />.</param>
  4144. <returns>
  4145. <see langword="true" /> if <paramref name="value" /> is found in
  4146. <paramref name="source" />; otherwise, <see langword="false" />.
  4147. </returns>
  4148. <remarks>
  4149. This function performs a case-sensitive word search using the
  4150. invariant culture.
  4151. </remarks>
  4152. <example>
  4153. <code>string::contains('testing string', 'test') ==> true</code>
  4154. </example>
  4155. <example>
  4156. <code>string::contains('testing string', '') ==> true</code>
  4157. </example>
  4158. <example>
  4159. <code>string::contains('testing string', 'Test') ==> false</code>
  4160. </example>
  4161. <example>
  4162. <code>string::contains('testing string', 'foo') ==> false</code>
  4163. </example>
  4164. </member>
  4165. <member name="M:NAnt.Core.Functions.StringFunctions.IndexOf(System.String,System.String)">
  4166. <summary>
  4167. Returns the position of the first occurrence in the specified string
  4168. of the given search string.
  4169. </summary>
  4170. <param name="source">The string to search.</param>
  4171. <param name="value">The string to locate within <paramref name="source" />.</param>
  4172. <returns>
  4173. <para>
  4174. The lowest-index position of <paramref name="value" /> in
  4175. <paramref name="source" /> if it is found, or -1 if <paramref name="source" />
  4176. does not contain <paramref name="value" />.
  4177. </para>
  4178. <para>
  4179. If <paramref name="value" /> is an empty string, the return value
  4180. will always be <c>0</c>.
  4181. </para>
  4182. </returns>
  4183. <remarks>
  4184. This function performs a case-sensitive word search using the
  4185. invariant culture.
  4186. </remarks>
  4187. <example>
  4188. <code>string::index-of('testing string', 'test') ==> 0</code>
  4189. </example>
  4190. <example>
  4191. <code>string::index-of('testing string', '') ==> 0</code>
  4192. </example>
  4193. <example>
  4194. <code>string::index-of('testing string', 'Test') ==> -1</code>
  4195. </example>
  4196. <example>
  4197. <code>string::index-of('testing string', 'ing') ==> 4</code>
  4198. </example>
  4199. </member>
  4200. <member name="M:NAnt.Core.Functions.StringFunctions.LastIndexOf(System.String,System.String)">
  4201. <summary>
  4202. Returns the position of the last occurrence in the specified string
  4203. of the given search string.
  4204. </summary>
  4205. <param name="source">The string to search.</param>
  4206. <param name="value">The string to locate within <paramref name="source" />.</param>
  4207. <returns>
  4208. <para>
  4209. The highest-index position of <paramref name="value" /> in
  4210. <paramref name="source" /> if it is found, or -1 if <paramref name="source" />
  4211. does not contain <paramref name="value" />.
  4212. </para>
  4213. <para>
  4214. If <paramref name="value" /> is an empty string, the return value
  4215. is the last index position in <paramref name="source" />.
  4216. </para>
  4217. </returns>
  4218. <remarks>
  4219. This function performs a case-sensitive word search using the
  4220. invariant culture.
  4221. </remarks>
  4222. <example>
  4223. <code>string::last-index-of('testing string', 'test') ==> 0</code>
  4224. </example>
  4225. <example>
  4226. <code>string::last-index-of('testing string', '') ==> 13</code>
  4227. </example>
  4228. <example>
  4229. <code>string::last-index-of('testing string', 'Test') ==> -1</code>
  4230. </example>
  4231. <example>
  4232. <code>string::last-index-of('testing string', 'ing') ==> 11</code>
  4233. </example>
  4234. </member>
  4235. <member name="M:NAnt.Core.Functions.StringFunctions.PadLeft(System.String,System.Int32,System.String)">
  4236. <summary>
  4237. Returns the given string left-padded to the given length.
  4238. </summary>
  4239. <param name="s">The <see cref="T:System.String"/> that needs to be left-padded.</param>
  4240. <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param>
  4241. <param name="paddingChar">A Unicode padding character.</param>
  4242. <returns>
  4243. If the length of <paramref name="s"/> is at least
  4244. <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical
  4245. to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/>
  4246. will be padded on the left with as many <paramref name="paddingChar"/>
  4247. characters as needed to create a length of <paramref name="totalWidth"/>.
  4248. </returns>
  4249. <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception>
  4250. <remarks>
  4251. Note that only the first character of <paramref name="paddingChar"/>
  4252. will be used when padding the result.
  4253. </remarks>
  4254. <example>
  4255. <code>string::pad-left('test', 10, ' ') ==&gt; ' test'</code>
  4256. </example>
  4257. <example>
  4258. <code>string::pad-left('test', 10, 'test') ==&gt; 'tttttttest'</code>
  4259. </example>
  4260. <example>
  4261. <code>string::pad-left('test', 3, ' ') ==&gt; 'test'</code>
  4262. </example>
  4263. <example>
  4264. <code>string::pad-left('test', -4, ' ') ==&gt; ERROR</code>
  4265. </example>
  4266. </member>
  4267. <member name="M:NAnt.Core.Functions.StringFunctions.PadRight(System.String,System.Int32,System.String)">
  4268. <summary>
  4269. Returns the given string right-padded to the given length.
  4270. </summary>
  4271. <param name="s">The <see cref="T:System.String"/> that needs to be right-padded.</param>
  4272. <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param>
  4273. <param name="paddingChar">A Unicode padding character.</param>
  4274. <returns>
  4275. If the length of <paramref name="s"/> is at least
  4276. <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical
  4277. to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/>
  4278. will be padded on the right with as many <paramref name="paddingChar"/>
  4279. characters as needed to create a length of <paramref name="totalWidth"/>.
  4280. </returns>
  4281. <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception>
  4282. <remarks>
  4283. Note that only the first character of <paramref name="paddingChar"/>
  4284. will be used when padding the result.
  4285. </remarks>
  4286. <example>
  4287. <code>string::pad-right('test', 10, ' ') ==&gt; 'test '</code>
  4288. </example>
  4289. <example>
  4290. <code>string::pad-right('test', 10, 'abcd') ==&gt; 'testaaaaaa'</code>
  4291. </example>
  4292. <example>
  4293. <code>string::pad-right('test', 3, ' ') ==&gt; 'test'</code>
  4294. </example>
  4295. <example>
  4296. <code>string::pad-right('test', -3, ' ') ==&gt; ERROR</code>
  4297. </example>
  4298. </member>
  4299. <member name="M:NAnt.Core.Functions.StringFunctions.Trim(System.String)">
  4300. <summary>
  4301. Returns the given string trimmed of whitespace.
  4302. </summary>
  4303. <param name="s">input string</param>
  4304. <returns>
  4305. The string <paramref name="s" /> with any leading or trailing
  4306. white space characters removed.
  4307. </returns>
  4308. <example>
  4309. <code>string::trim(' test ') ==> 'test'</code>
  4310. </example>
  4311. <example>
  4312. <code>string::trim('\t\tfoo \r\n') ==> 'foo'</code>
  4313. </example>
  4314. </member>
  4315. <member name="M:NAnt.Core.Functions.StringFunctions.TrimStart(System.String)">
  4316. <summary>
  4317. Returns the given string trimmed of leading whitespace.
  4318. </summary>
  4319. <param name="s">input string</param>
  4320. <returns>
  4321. The string <paramref name="s" /> with any leading
  4322. whites pace characters removed.
  4323. </returns>
  4324. <example>
  4325. <code>string::trim-start(' test ') ==> 'test '</code>
  4326. </example>
  4327. <example>
  4328. <code>string::trim-start('\t\tfoo \r\n') ==> 'foo \r\n'</code>
  4329. </example>
  4330. </member>
  4331. <member name="M:NAnt.Core.Functions.StringFunctions.TrimEnd(System.String)">
  4332. <summary>
  4333. Returns the given string trimmed of trailing whitespace.
  4334. </summary>
  4335. <param name="s">input string</param>
  4336. <returns>
  4337. The string <paramref name="s" /> with any trailing
  4338. white space characters removed.
  4339. </returns>
  4340. <example>
  4341. <code>string::trim-end(' test ') ==> ' test'</code>
  4342. </example>
  4343. <example>
  4344. <code>string::trim-end('\t\tfoo \r\n') ==> '\t\tfoo'</code>
  4345. </example>
  4346. </member>
  4347. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalDays(System.TimeSpan)">
  4348. <summary>
  4349. Returns the total number of days represented by the specified
  4350. <see cref="T:System.TimeSpan"/>, expressed in whole and fractional days.
  4351. </summary>
  4352. <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
  4353. <returns>
  4354. The total number of days represented by the given <see cref="T:System.TimeSpan"/>.
  4355. </returns>
  4356. </member>
  4357. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalHours(System.TimeSpan)">
  4358. <summary>
  4359. Returns the total number of hours represented by the specified
  4360. <see cref="T:System.TimeSpan"/>, expressed in whole and fractional hours.
  4361. </summary>
  4362. <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
  4363. <returns>
  4364. The total number of hours represented by the given <see cref="T:System.TimeSpan"/>.
  4365. </returns>
  4366. </member>
  4367. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMinutes(System.TimeSpan)">
  4368. <summary>
  4369. Returns the total number of minutes represented by the specified
  4370. <see cref="T:System.TimeSpan"/>, expressed in whole and fractional minutes.
  4371. </summary>
  4372. <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
  4373. <returns>
  4374. The total number of minutes represented by the given <see cref="T:System.TimeSpan"/>.
  4375. </returns>
  4376. </member>
  4377. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalSeconds(System.TimeSpan)">
  4378. <summary>
  4379. Returns the total number of seconds represented by the specified
  4380. <see cref="T:System.TimeSpan"/>, expressed in whole and fractional seconds.
  4381. </summary>
  4382. <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
  4383. <returns>
  4384. The total number of seconds represented by the given <see cref="T:System.TimeSpan"/>.
  4385. </returns>
  4386. </member>
  4387. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMilliseconds(System.TimeSpan)">
  4388. <summary>
  4389. Returns the total number of milliseconds represented by the specified
  4390. <see cref="T:System.TimeSpan"/>, expressed in whole and fractional milliseconds.
  4391. </summary>
  4392. <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
  4393. <returns>
  4394. The total number of milliseconds represented by the given
  4395. <see cref="T:System.TimeSpan"/>.
  4396. </returns>
  4397. </member>
  4398. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetDays(System.TimeSpan)">
  4399. <summary>
  4400. Returns the number of whole days represented by the specified
  4401. <see cref="T:System.TimeSpan"/>.
  4402. </summary>
  4403. <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
  4404. <returns>
  4405. The number of whole days represented by the given
  4406. <see cref="T:System.TimeSpan"/>.
  4407. </returns>
  4408. <example>
  4409. <para>
  4410. Remove all files that have not been modified in the last 7 days from directory "binaries".</para>
  4411. <code>
  4412. <![CDATA[
  4413. <foreach item="File" in="binaries" property="filename">
  4414. <if test="${timespan::get-days(datetime::now() - file::get-last-write-time(filename)) >= 7}">
  4415. <delete file="${filename}" />
  4416. </if>
  4417. </foreach>
  4418. ]]>
  4419. </code>
  4420. </example>
  4421. </member>
  4422. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetHours(System.TimeSpan)">
  4423. <summary>
  4424. Returns the number of whole hours represented by the specified
  4425. <see cref="T:System.TimeSpan"/>.
  4426. </summary>
  4427. <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
  4428. <returns>
  4429. The number of whole hours represented by the given
  4430. <see cref="T:System.TimeSpan"/>.
  4431. </returns>
  4432. </member>
  4433. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMinutes(System.TimeSpan)">
  4434. <summary>
  4435. Returns the number of whole minutes represented by the specified
  4436. <see cref="T:System.TimeSpan"/>.
  4437. </summary>
  4438. <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
  4439. <returns>
  4440. The number of whole minutes represented by the given
  4441. <see cref="T:System.TimeSpan"/>.
  4442. </returns>
  4443. </member>
  4444. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetSeconds(System.TimeSpan)">
  4445. <summary>
  4446. Returns the number of whole seconds represented by the specified
  4447. <see cref="T:System.TimeSpan"/>.
  4448. </summary>
  4449. <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
  4450. <returns>
  4451. The number of whole seconds represented by the given
  4452. <see cref="T:System.TimeSpan"/>.
  4453. </returns>
  4454. </member>
  4455. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMilliseconds(System.TimeSpan)">
  4456. <summary>
  4457. Returns the number of whole milliseconds represented by the specified
  4458. <see cref="T:System.TimeSpan"/>.
  4459. </summary>
  4460. <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
  4461. <returns>
  4462. The number of whole milliseconds represented by the given
  4463. <see cref="T:System.TimeSpan"/>.
  4464. </returns>
  4465. </member>
  4466. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTicks(System.TimeSpan)">
  4467. <summary>
  4468. Returns the number of ticks contained in the specified
  4469. <see cref="T:System.TimeSpan"/>.
  4470. </summary>
  4471. <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
  4472. <returns>
  4473. The number of ticks contained in the given <see cref="T:System.TimeSpan"/>.
  4474. </returns>
  4475. </member>
  4476. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromDays(System.Double)">
  4477. <summary>
  4478. Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
  4479. of days, where the specification is accurate to the nearest millisecond.
  4480. </summary>
  4481. <param name="value">A number of days, accurate to the nearest millisecond.</param>
  4482. <returns>
  4483. A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
  4484. </returns>
  4485. </member>
  4486. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromHours(System.Double)">
  4487. <summary>
  4488. Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
  4489. of hours, where the specification is accurate to the nearest
  4490. millisecond.
  4491. </summary>
  4492. <param name="value">A number of hours, accurate to the nearest millisecond.</param>
  4493. <returns>
  4494. A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
  4495. </returns>
  4496. </member>
  4497. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMinutes(System.Double)">
  4498. <summary>
  4499. Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
  4500. of minutes, where the specification is accurate to the nearest
  4501. millisecond.
  4502. </summary>
  4503. <param name="value">A number of minutes, accurate to the nearest millisecond.</param>
  4504. <returns>
  4505. A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
  4506. </returns>
  4507. </member>
  4508. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromSeconds(System.Double)">
  4509. <summary>
  4510. Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
  4511. of seconds, where the specification is accurate to the nearest
  4512. millisecond.
  4513. </summary>
  4514. <param name="value">A number of seconds, accurate to the nearest millisecond.</param>
  4515. <returns>
  4516. A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
  4517. </returns>
  4518. </member>
  4519. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMilliseconds(System.Double)">
  4520. <summary>
  4521. Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
  4522. of milliseconds.
  4523. </summary>
  4524. <param name="value">A number of milliseconds.</param>
  4525. <returns>
  4526. A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
  4527. </returns>
  4528. </member>
  4529. <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromTicks(System.Int64)">
  4530. <summary>
  4531. Returns a <see cref="T:System.TimeSpan"/> that represents a specified time,
  4532. where the specification is in units of ticks.
  4533. </summary>
  4534. <param name="value">A number of ticks that represent a time.</param>
  4535. <returns>
  4536. A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
  4537. </returns>
  4538. </member>
  4539. <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.Parse(System.String)">
  4540. <summary>
  4541. Constructs a <see cref="T:System.TimeSpan"/> from a time indicated by a
  4542. specified string.
  4543. </summary>
  4544. <param name="s">A string.</param>
  4545. <returns>
  4546. A <see cref="T:System.TimeSpan"/> that corresponds to <paramref name="s"/>.
  4547. </returns>
  4548. <exception cref="T:System.FormatException"><paramref name="s"/> has an invalid format.</exception>
  4549. <exception cref="T:System.OverflowException">At least one of the hours, minutes, or seconds components is outside its valid range.</exception>
  4550. </member>
  4551. <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.ToString(System.TimeSpan)">
  4552. <summary>
  4553. Converts the specified <see cref="T:System.TimeSpan"/> to its equivalent
  4554. string representation.
  4555. </summary>
  4556. <param name="value">A <see cref="T:System.TimeSpan"/> to convert.</param>
  4557. <returns>
  4558. The string representation of <paramref name="value"/>. The format
  4559. of the return value is of the form: [-][d.]hh:mm:ss[.ff].
  4560. </returns>
  4561. </member>
  4562. <member name="M:NAnt.Core.Functions.VersionFunctions.GetMajor(System.Version)">
  4563. <summary>
  4564. Gets the value of the major component of a given version.
  4565. </summary>
  4566. <param name="version">A version.</param>
  4567. <returns>
  4568. The major version number.
  4569. </returns>
  4570. <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
  4571. <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
  4572. <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
  4573. </member>
  4574. <member name="M:NAnt.Core.Functions.VersionFunctions.GetMinor(System.Version)">
  4575. <summary>
  4576. Gets the value of the minor component of a given version.
  4577. </summary>
  4578. <param name="version">A version.</param>
  4579. <returns>
  4580. The minor version number.
  4581. </returns>
  4582. <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
  4583. <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
  4584. <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
  4585. </member>
  4586. <member name="M:NAnt.Core.Functions.VersionFunctions.GetBuild(System.Version)">
  4587. <summary>
  4588. Gets the value of the build component of a given version.
  4589. </summary>
  4590. <param name="version">A version.</param>
  4591. <returns>
  4592. The build number, or -1 if the build number is undefined.
  4593. </returns>
  4594. <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
  4595. <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
  4596. <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
  4597. </member>
  4598. <member name="M:NAnt.Core.Functions.VersionFunctions.GetRevision(System.Version)">
  4599. <summary>
  4600. Gets the value of the revision component of a given version.
  4601. </summary>
  4602. <param name="version">A version.</param>
  4603. <returns>
  4604. The revision number, or -1 if the revision number is undefined.
  4605. </returns>
  4606. <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
  4607. <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
  4608. <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
  4609. </member>
  4610. <member name="M:NAnt.Core.Functions.VersionConversionFunctions.Parse(System.String)">
  4611. <summary>
  4612. Converts the specified string representation of a version to
  4613. its <see cref="T:System.Version"/> equivalent.
  4614. </summary>
  4615. <param name="version">A string containing the major, minor, build, and revision numbers, where each number is delimited with a period character ('.').</param>
  4616. <returns>
  4617. A <see cref="T:System.Version"/> instance representing the specified
  4618. <see cref="T:System.String"/>.
  4619. </returns>
  4620. <exception cref="T:System.ArgumentException"><paramref name="version"/> has fewer than two components or more than four components.</exception>
  4621. <exception cref="T:System.ArgumentOutOfRangeException">A major, minor, build, or revision component is less than zero.</exception>
  4622. <exception cref="T:System.FormatException">At least one component of <paramref name="version"/> does not parse to a decimal integer.</exception>
  4623. </member>
  4624. <member name="M:NAnt.Core.Functions.VersionConversionFunctions.ToString(System.Version)">
  4625. <summary>
  4626. Converts the specified <see cref="T:System.Version"/> to its equivalent
  4627. string representation.
  4628. </summary>
  4629. <param name="value">A <see cref="T:System.Version"/> to convert.</param>
  4630. <returns>
  4631. The string representation of the values of the major, minor, build,
  4632. and revision components of the specified <see cref="T:System.Version"/>.
  4633. </returns>
  4634. <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
  4635. <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
  4636. <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
  4637. </member>
  4638. <member name="T:NAnt.Core.Tasks.AttribTask">
  4639. <summary>
  4640. Changes the file attributes of a file or set of files and directories.
  4641. </summary>
  4642. <remarks>
  4643. <para>
  4644. <see cref="T:NAnt.Core.Tasks.AttribTask"/> does not have the concept of turning
  4645. attributes off. Instead you specify all the attributes that you want
  4646. turned on and the rest are turned off by default.
  4647. </para>
  4648. <para>
  4649. Refer to the <see cref="T:System.IO.FileAttributes"/> enumeration in the .NET SDK
  4650. for more information about file attributes.
  4651. </para>
  4652. </remarks>
  4653. <example>
  4654. <para>
  4655. Set the <c>read-only</c> file attribute for the specified file in
  4656. the project directory.
  4657. </para>
  4658. <code>
  4659. <![CDATA[
  4660. <attrib file="myfile.txt" readonly="true" />
  4661. ]]>
  4662. </code>
  4663. </example>
  4664. <example>
  4665. <para>
  4666. Set the <c>normal</c> file attribute for the specified file.
  4667. </para>
  4668. <code>
  4669. <![CDATA[
  4670. <attrib file="myfile.txt" normal="true" />
  4671. ]]>
  4672. </code>
  4673. </example>
  4674. <example>
  4675. <para>
  4676. Set the <c>normal</c> file attribute for all executable files in
  4677. the current project directory and sub-directories.
  4678. </para>
  4679. <code>
  4680. <![CDATA[
  4681. <attrib normal="true">
  4682. <fileset>
  4683. <include name="**/*.exe" />
  4684. <include name="bin" />
  4685. </fileset>
  4686. </attrib>
  4687. ]]>
  4688. </code>
  4689. </example>
  4690. </member>
  4691. <member name="T:NAnt.Core.Task">
  4692. <summary>
  4693. Provides the abstract base class for tasks.
  4694. </summary>
  4695. <remarks>
  4696. A task is a piece of code that can be executed.
  4697. </remarks>
  4698. </member>
  4699. <member name="M:NAnt.Core.Task.Execute">
  4700. <summary>
  4701. Executes the task unless it is skipped.
  4702. </summary>
  4703. </member>
  4704. <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String)">
  4705. <summary>
  4706. Logs a message with the given priority.
  4707. </summary>
  4708. <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
  4709. <param name="message">The message to be logged.</param>
  4710. <remarks>
  4711. <para>
  4712. The actual logging is delegated to the project.
  4713. </para>
  4714. <para>
  4715. If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a
  4716. message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the
  4717. priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>
  4718. when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>.
  4719. </para>
  4720. <para>
  4721. This will allow individual tasks to run in verbose mode while
  4722. the build log itself is still configured with threshold
  4723. <see cref="F:NAnt.Core.Level.Info"/>.
  4724. </para>
  4725. <para>
  4726. The threshold of the project is not taken into account to determine
  4727. whether a message should be passed to the logging infrastructure,
  4728. as build listeners might be interested in receiving all messages.
  4729. </para>
  4730. </remarks>
  4731. </member>
  4732. <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String,System.Object[])">
  4733. <summary>
  4734. Logs a formatted message with the given priority.
  4735. </summary>
  4736. <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
  4737. <param name="message">The message to log, containing zero or more format items.</param>
  4738. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  4739. <remarks>
  4740. <para>
  4741. The actual logging is delegated to the project.
  4742. </para>
  4743. <para>
  4744. If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a
  4745. message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the
  4746. priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>.
  4747. when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>.
  4748. </para>
  4749. <para>
  4750. This will allow individual tasks to run in verbose mode while
  4751. the build log itself is still configured with threshold
  4752. <see cref="F:NAnt.Core.Level.Info"/>.
  4753. </para>
  4754. </remarks>
  4755. </member>
  4756. <member name="M:NAnt.Core.Task.IsLogEnabledFor(NAnt.Core.Level)">
  4757. <summary>
  4758. Determines whether build output is enabled for the given
  4759. <see cref="T:NAnt.Core.Level"/>.
  4760. </summary>
  4761. <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to check.</param>
  4762. <returns>
  4763. <see langword="true"/> if messages with the given <see cref="T:NAnt.Core.Level"/>
  4764. should be passed on to the logging infrastructure; otherwise,
  4765. <see langword="false"/>.
  4766. </returns>
  4767. <remarks>
  4768. The threshold of the project is not taken into account to determine
  4769. whether a message should be passed to the logging infrastructure,
  4770. as build listeners might be interested in receiving all messages.
  4771. </remarks>
  4772. </member>
  4773. <member name="M:NAnt.Core.Task.InitializeTaskConfiguration">
  4774. <summary>
  4775. Initializes the configuration of the task using configuration
  4776. settings retrieved from the NAnt configuration file.
  4777. </summary>
  4778. <remarks>
  4779. TO-DO : Remove this temporary hack when a permanent solution is
  4780. available for loading the default values from the configuration
  4781. file if a build element is constructed from code.
  4782. </remarks>
  4783. </member>
  4784. <member name="M:NAnt.Core.Task.Initialize">
  4785. <summary>Initializes the task.</summary>
  4786. </member>
  4787. <member name="M:NAnt.Core.Task.InitializeTask(System.Xml.XmlNode)">
  4788. <summary>Initializes the task.</summary>
  4789. </member>
  4790. <member name="M:NAnt.Core.Task.ExecuteTask">
  4791. <summary>Executes the task.</summary>
  4792. </member>
  4793. <member name="M:NAnt.Core.Task.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)">
  4794. <summary>
  4795. Locates the XML node for the specified attribute in either the
  4796. configuration section of the extension assembly or the.project.
  4797. </summary>
  4798. <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param>
  4799. <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>
  4800. <returns>
  4801. The XML configuration node for the specified attribute, or
  4802. <see langword="null" /> if no corresponding XML node could be
  4803. located.
  4804. </returns>
  4805. <remarks>
  4806. If there's a valid current framework, the configuration section for
  4807. that framework will first be searched. If no corresponding
  4808. configuration node can be located in that section, the framework-neutral
  4809. section of the project configuration node will be searched.
  4810. </remarks>
  4811. </member>
  4812. <member name="P:NAnt.Core.Task.FailOnError">
  4813. <summary>
  4814. Determines if task failure stops the build, or is just reported.
  4815. The default is <see langword="true" />.
  4816. </summary>
  4817. </member>
  4818. <member name="P:NAnt.Core.Task.Verbose">
  4819. <summary>
  4820. Determines whether the task should report detailed build log messages.
  4821. The default is <see langword="false" />.
  4822. </summary>
  4823. </member>
  4824. <member name="P:NAnt.Core.Task.IfDefined">
  4825. <summary>
  4826. If <see langword="true" /> then the task will be executed; otherwise,
  4827. skipped. The default is <see langword="true" />.
  4828. </summary>
  4829. </member>
  4830. <member name="P:NAnt.Core.Task.UnlessDefined">
  4831. <summary>
  4832. Opposite of <see cref="P:NAnt.Core.Task.IfDefined"/>. If <see langword="false"/>
  4833. then the task will be executed; otherwise, skipped. The default is
  4834. <see langword="false"/>.
  4835. </summary>
  4836. </member>
  4837. <member name="P:NAnt.Core.Task.Name">
  4838. <summary>
  4839. The name of the task.
  4840. </summary>
  4841. </member>
  4842. <member name="P:NAnt.Core.Task.LogPrefix">
  4843. <summary>
  4844. The prefix used when sending messages to the log.
  4845. </summary>
  4846. </member>
  4847. <member name="P:NAnt.Core.Task.Threshold">
  4848. <summary>
  4849. Gets or sets the log threshold for this <see cref="T:NAnt.Core.Task"/>. By
  4850. default the threshold of a task is <see cref="F:NAnt.Core.Level.Debug"/>,
  4851. causing no messages to be filtered in the task itself.
  4852. </summary>
  4853. <value>
  4854. The log threshold level for this <see cref="T:NAnt.Core.Task"/>.
  4855. </value>
  4856. <remarks>
  4857. When the threshold of a <see cref="T:NAnt.Core.Task"/> is higher than the
  4858. threshold of the <see cref="T:NAnt.Core.Project"/>, then all messages will
  4859. still be delivered to the build listeners.
  4860. </remarks>
  4861. </member>
  4862. <member name="P:NAnt.Core.Task.TaskBuilder">
  4863. <summary>
  4864. Returns the TaskBuilder used to construct an instance of this
  4865. <see cref="T:NAnt.Core.Task"/>.
  4866. </summary>
  4867. </member>
  4868. <member name="P:NAnt.Core.Tasks.AttribTask.File">
  4869. <summary>
  4870. The name of the file which will have its attributes set. This is
  4871. provided as an alternate to using the task's fileset.
  4872. </summary>
  4873. </member>
  4874. <member name="P:NAnt.Core.Tasks.AttribTask.AttribFileSet">
  4875. <summary>
  4876. All the matching files and directories in this fileset will have
  4877. their attributes set.
  4878. </summary>
  4879. </member>
  4880. <member name="P:NAnt.Core.Tasks.AttribTask.ArchiveAttrib">
  4881. <summary>
  4882. Set the archive attribute. The default is <see langword="false" />.
  4883. </summary>
  4884. </member>
  4885. <member name="P:NAnt.Core.Tasks.AttribTask.HiddenAttrib">
  4886. <summary>
  4887. Set the hidden attribute. The default is <see langword="false" />.
  4888. </summary>
  4889. </member>
  4890. <member name="P:NAnt.Core.Tasks.AttribTask.NormalAttrib">
  4891. <summary>
  4892. Set the normal file attributes. This attribute is only valid if used
  4893. alone. The default is <see langword="false" />.
  4894. </summary>
  4895. </member>
  4896. <member name="P:NAnt.Core.Tasks.AttribTask.ReadOnlyAttrib">
  4897. <summary>
  4898. Set the read-only attribute. The default is <see langword="false" />.
  4899. </summary>
  4900. </member>
  4901. <member name="P:NAnt.Core.Tasks.AttribTask.SystemAttrib">
  4902. <summary>
  4903. Set the system attribute. The default is <see langword="false" />.
  4904. </summary>
  4905. </member>
  4906. <member name="T:NAnt.Core.Tasks.AvailableTask">
  4907. <summary>
  4908. Checks if a resource is available at runtime.
  4909. </summary>
  4910. <remarks>
  4911. <para>
  4912. The specified property is set to <see langword="true"/> if the
  4913. requested resource is available at runtime, and <see langword="false"/>
  4914. if the resource is not available.
  4915. </para>
  4916. <note>
  4917. we advise you to use the following functions instead:
  4918. </note>
  4919. <list type="table">
  4920. <listheader>
  4921. <term>Function</term>
  4922. <description>Description</description>
  4923. </listheader>
  4924. <item>
  4925. <term><see cref="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)"/></term>
  4926. <description>Determines whether the specified file exists.</description>
  4927. </item>
  4928. <item>
  4929. <term><see cref="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)"/></term>
  4930. <description>Determines whether the given path refers to an existing directory on disk.</description>
  4931. </item>
  4932. <item>
  4933. <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)"/></term>
  4934. <description>Checks whether the specified framework exists..</description>
  4935. </item>
  4936. <item>
  4937. <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)"/></term>
  4938. <description>Checks whether the SDK for the specified framework is installed.</description>
  4939. </item>
  4940. </list>
  4941. </remarks>
  4942. <example>
  4943. <para>
  4944. Sets the <c>myfile.present</c> property to <see langword="true"/> if the
  4945. file is available on the filesystem and <see langword="false"/> if the
  4946. file is not available.
  4947. </para>
  4948. <code>
  4949. <![CDATA[
  4950. <available type="File" resource="myfile.txt" property="myfile.present" />
  4951. ]]>
  4952. </code>
  4953. </example>
  4954. <example>
  4955. <para>
  4956. Sets the <c>build.dir.present</c> property to <see langword="true"/>
  4957. if the directory is available on the filesystem and <see langword="false"/>
  4958. if the directory is not available.
  4959. </para>
  4960. <code>
  4961. <![CDATA[
  4962. <available type="Directory" resource="build" property="build.dir.present" />
  4963. ]]>
  4964. </code>
  4965. </example>
  4966. <example>
  4967. <para>
  4968. Sets the <c>mono-0.21.framework.present</c> property to <see langword="true"/>
  4969. if the Mono 0.21 framework is available on the current system and
  4970. <see langword="false"/> if the framework is not available.
  4971. </para>
  4972. <code>
  4973. <![CDATA[
  4974. <available type="Framework" resource="mono-0.21" property="mono-0.21.framework.present" />
  4975. ]]>
  4976. </code>
  4977. </example>
  4978. <example>
  4979. <para>
  4980. Sets the <c>net-1.1.frameworksdk.present</c> property to <see langword="true"/>
  4981. if the .NET 1.1 Framework SDK is available on the current system and
  4982. <see langword="false"/> if the SDK is not available.
  4983. </para>
  4984. <code>
  4985. <![CDATA[
  4986. <available type="FrameworkSDK" resource="net-1.1" property="net-1.1.frameworksdk.present" />
  4987. ]]>
  4988. </code>
  4989. </example>
  4990. </member>
  4991. <member name="M:NAnt.Core.Tasks.AvailableTask.ExecuteTask">
  4992. <summary>
  4993. Executes the task.
  4994. </summary>
  4995. <remarks>
  4996. <para>
  4997. Sets the property identified by <see cref="P:NAnt.Core.Tasks.AvailableTask.PropertyName"/> to
  4998. <see langword="true"/> when the resource exists and to <see langword="false"/>
  4999. when the resource doesn't exist.
  5000. </para>
  5001. </remarks>
  5002. <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception>
  5003. </member>
  5004. <member name="M:NAnt.Core.Tasks.AvailableTask.Evaluate">
  5005. <summary>
  5006. Evaluates the availability of a resource.
  5007. </summary>
  5008. <returns>
  5009. <see langword="true"/> if the resource is available; otherwise,
  5010. <see langword="false"/>.
  5011. </returns>
  5012. <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception>
  5013. </member>
  5014. <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFile">
  5015. <summary>
  5016. Checks if the file specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/> property is
  5017. available on the filesystem.
  5018. </summary>
  5019. <returns>
  5020. <see langword="true"/> when the file exists; otherwise, <see langword="false"/>.
  5021. </returns>
  5022. </member>
  5023. <member name="M:NAnt.Core.Tasks.AvailableTask.CheckDirectory">
  5024. <summary>
  5025. Checks if the directory specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
  5026. property is available on the filesystem.
  5027. </summary>
  5028. <returns>
  5029. <see langword="true"/> when the directory exists; otherwise, <see langword="false"/>.
  5030. </returns>
  5031. </member>
  5032. <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFramework">
  5033. <summary>
  5034. Checks if the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
  5035. property is available on the current system.
  5036. </summary>
  5037. <returns>
  5038. <see langword="true"/> when the framework is available; otherwise,
  5039. <see langword="false"/>.
  5040. </returns>
  5041. </member>
  5042. <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFrameworkSDK">
  5043. <summary>
  5044. Checks if the SDK for the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
  5045. property is available on the current system.
  5046. </summary>
  5047. <returns>
  5048. <see langword="true"/> when the SDK for the specified framework is
  5049. available; otherwise, <see langword="false"/>.
  5050. </returns>
  5051. </member>
  5052. <member name="P:NAnt.Core.Tasks.AvailableTask.Resource">
  5053. <summary>
  5054. The resource which must be available.
  5055. </summary>
  5056. </member>
  5057. <member name="P:NAnt.Core.Tasks.AvailableTask.Type">
  5058. <summary>
  5059. The type of resource which must be present.
  5060. </summary>
  5061. </member>
  5062. <member name="P:NAnt.Core.Tasks.AvailableTask.PropertyName">
  5063. <summary>
  5064. The property that must be set if the resource is available.
  5065. </summary>
  5066. </member>
  5067. <member name="T:NAnt.Core.Tasks.AvailableTask.ResourceType">
  5068. <summary>
  5069. Defines the possible resource checks.
  5070. </summary>
  5071. </member>
  5072. <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.File">
  5073. <summary>
  5074. Determines whether a given file exists.
  5075. </summary>
  5076. </member>
  5077. <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Directory">
  5078. <summary>
  5079. Determines whether a given directory exists.
  5080. </summary>
  5081. </member>
  5082. <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Framework">
  5083. <summary>
  5084. Determines whether a given framework is available.
  5085. </summary>
  5086. </member>
  5087. <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.FrameworkSDK">
  5088. <summary>
  5089. Determines whether a given SDK is available.
  5090. </summary>
  5091. </member>
  5092. <member name="T:NAnt.Core.Tasks.CallTask">
  5093. <summary>
  5094. Calls a NAnt target in the current project.
  5095. </summary>
  5096. <remarks>
  5097. <para>
  5098. When the <see cref="T:NAnt.Core.Tasks.CallTask"/> is used to execute a target, both that
  5099. target and all its dependent targets will be re-executed.
  5100. </para>
  5101. <para>
  5102. To avoid dependent targets from being executed more than once, two
  5103. options are available:
  5104. </para>
  5105. <list type="bullet">
  5106. <item>
  5107. <description>
  5108. Add an "unless" attribute with value "${<see href="../functions/target.has-executed.html">target::has-executed</see>('<c>&lt;target name&gt;</c>')}"
  5109. to the dependent targets.
  5110. </description>
  5111. </item>
  5112. <item>
  5113. <description>
  5114. Set the <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute on the
  5115. <see cref="T:NAnt.Core.Tasks.CallTask"/> to <see langword="false "/> (<c>recommended</c>).
  5116. </description>
  5117. </item>
  5118. </list>
  5119. </remarks>
  5120. <example>
  5121. <para>
  5122. Call the target "build".
  5123. </para>
  5124. <code>
  5125. <![CDATA[
  5126. <call target="build" />
  5127. ]]>
  5128. </code>
  5129. </example>
  5130. <example>
  5131. <para>
  5132. This shows how a project could 'compile' a debug and release build
  5133. using a common compile target.
  5134. </para>
  5135. <code>
  5136. <![CDATA[
  5137. <project default="build">
  5138. <property name="debug" value="false" />
  5139. <target name="init">
  5140. <echo message="initializing" />
  5141. </target>
  5142. <target name="compile" depends="init">
  5143. <echo message="compiling with debug = ${debug}" />
  5144. </target>
  5145. <target name="build">
  5146. <property name="debug" value="false" />
  5147. <call target="compile" />
  5148. <property name="debug" value="true" />
  5149. <call target="compile" />
  5150. </target>
  5151. </project>
  5152. ]]>
  5153. </code>
  5154. <para>
  5155. The <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> parameter of the
  5156. <see cref="T:NAnt.Core.Tasks.CallTask"/> defaults to <see langword="true"/>,
  5157. causing the "init" target to be executed for both
  5158. the "debug" and "release" build.
  5159. </para>
  5160. <para>
  5161. This results in the following build log:
  5162. </para>
  5163. <code>
  5164. build:
  5165. init:
  5166. [echo] initializing
  5167. compile:
  5168. [echo] compiling with debug = false
  5169. init:
  5170. [echo] initializing
  5171. compile:
  5172. [echo] compiling with debug = true
  5173. BUILD SUCCEEDED
  5174. </code>
  5175. <para>
  5176. If the "init" should only be executed once, set the
  5177. <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute of the <see cref="T:NAnt.Core.Tasks.CallTask"/>
  5178. to <see langword="false"/>.
  5179. </para>
  5180. <para>
  5181. The build log would then look like this:
  5182. </para>
  5183. <code>
  5184. build:
  5185. init:
  5186. [echo] initializing
  5187. compile:
  5188. [echo] compiling with debug = false
  5189. compile:
  5190. [echo] compiling with debug = true
  5191. BUILD SUCCEEDED
  5192. </code>
  5193. </example>
  5194. </member>
  5195. <member name="M:NAnt.Core.Tasks.CallTask.ExecuteTask">
  5196. <summary>
  5197. Executes the specified target.
  5198. </summary>
  5199. </member>
  5200. <member name="M:NAnt.Core.Tasks.CallTask.Initialize">
  5201. <summary>
  5202. Makes sure the <see cref="T:NAnt.Core.Tasks.CallTask"/> is not calling its own
  5203. parent.
  5204. </summary>
  5205. </member>
  5206. <member name="P:NAnt.Core.Tasks.CallTask.TargetName">
  5207. <summary>
  5208. NAnt target to call.
  5209. </summary>
  5210. </member>
  5211. <member name="P:NAnt.Core.Tasks.CallTask.ForceExecute">
  5212. <summary>
  5213. Force an execute even if the target has already been executed. The
  5214. default is <see langword="false" />.
  5215. </summary>
  5216. </member>
  5217. <member name="P:NAnt.Core.Tasks.CallTask.CascadeDependencies">
  5218. <summary>
  5219. Execute the specified targets dependencies -- even if they have been
  5220. previously executed. The default is <see langword="true" />.
  5221. </summary>
  5222. </member>
  5223. <member name="T:NAnt.Core.Tasks.CopyTask">
  5224. <summary>
  5225. Copies a file or set of files to a new file or directory.
  5226. </summary>
  5227. <remarks>
  5228. <para>
  5229. Files are only copied if the source file is newer than the destination
  5230. file, or if the destination file does not exist. However, you can
  5231. explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/> attribute.
  5232. </para>
  5233. <para>
  5234. When a <see cref="T:NAnt.Core.Types.FileSet"/> is used to select files to copy, the
  5235. <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set. Files that are
  5236. located under the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/> will
  5237. be copied to a directory under the destination directory matching the
  5238. path relative to the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/>,
  5239. unless the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/> attribute is set to
  5240. <see langword="true"/>.
  5241. </para>
  5242. <para>
  5243. Files that are not located under the the base directory of the
  5244. <see cref="T:NAnt.Core.Types.FileSet"/> will be copied directly under to the destination
  5245. directory, regardless of the value of the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/>
  5246. attribute.
  5247. </para>
  5248. <h4>Encoding</h4>
  5249. <para>
  5250. Unless an encoding is specified, the encoding associated with the
  5251. system's current ANSI code page is used.
  5252. </para>
  5253. <para>
  5254. An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
  5255. file is automatically recognized, if the file starts with the
  5256. appropriate byte order marks.
  5257. </para>
  5258. <note>
  5259. If you employ filters in your copy operation, you should limit the copy
  5260. to text files. Binary files will be corrupted by the copy operation.
  5261. </note>
  5262. </remarks>
  5263. <example>
  5264. <para>
  5265. Copy a single file while changing its encoding from "latin1" to
  5266. "utf-8".
  5267. </para>
  5268. <code>
  5269. <![CDATA[
  5270. <copy
  5271. file="myfile.txt"
  5272. tofile="mycopy.txt"
  5273. inputencoding="latin1"
  5274. outputencoding="utf-8" />
  5275. ]]>
  5276. </code>
  5277. </example>
  5278. <example>
  5279. <para>Copy a set of files to a new directory.</para>
  5280. <code>
  5281. <![CDATA[
  5282. <copy todir="${build.dir}">
  5283. <fileset basedir="bin">
  5284. <include name="*.dll" />
  5285. </fileset>
  5286. </copy>
  5287. ]]>
  5288. </code>
  5289. </example>
  5290. <example>
  5291. <para>
  5292. Copy a set of files to a directory, replacing <c>@TITLE@</c> with
  5293. "Foo Bar" in all files.
  5294. </para>
  5295. <code>
  5296. <![CDATA[
  5297. <copy todir="../backup/dir">
  5298. <fileset basedir="src_dir">
  5299. <include name="**/*" />
  5300. </fileset>
  5301. <filterchain>
  5302. <replacetokens>
  5303. <token key="TITLE" value="Foo Bar" />
  5304. </replacetokens>
  5305. </filterchain>
  5306. </copy>
  5307. ]]>
  5308. </code>
  5309. </example>
  5310. </member>
  5311. <member name="M:NAnt.Core.Tasks.CopyTask.#ctor">
  5312. <summary>
  5313. Initialize new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>.
  5314. </summary>
  5315. </member>
  5316. <member name="M:NAnt.Core.Tasks.CopyTask.Initialize">
  5317. <summary>
  5318. Checks whether the task is initialized with valid attributes.
  5319. </summary>
  5320. </member>
  5321. <member name="M:NAnt.Core.Tasks.CopyTask.ExecuteTask">
  5322. <summary>
  5323. Executes the Copy task.
  5324. </summary>
  5325. <exception cref="T:NAnt.Core.BuildException">A file that has to be copied does not exist or could not be copied.</exception>
  5326. </member>
  5327. <member name="M:NAnt.Core.Tasks.CopyTask.DoFileOperations">
  5328. <summary>
  5329. Actually does the file copies.
  5330. </summary>
  5331. </member>
  5332. <member name="P:NAnt.Core.Tasks.CopyTask.SourceFile">
  5333. <summary>
  5334. The file to copy.
  5335. </summary>
  5336. </member>
  5337. <member name="P:NAnt.Core.Tasks.CopyTask.ToFile">
  5338. <summary>
  5339. The file to copy to.
  5340. </summary>
  5341. </member>
  5342. <member name="P:NAnt.Core.Tasks.CopyTask.ToDirectory">
  5343. <summary>
  5344. The directory to copy to.
  5345. </summary>
  5346. </member>
  5347. <member name="P:NAnt.Core.Tasks.CopyTask.Overwrite">
  5348. <summary>
  5349. Overwrite existing files even if the destination files are newer.
  5350. The default is <see langword="false" />.
  5351. </summary>
  5352. </member>
  5353. <member name="P:NAnt.Core.Tasks.CopyTask.Flatten">
  5354. <summary>
  5355. Ignore directory structure of source directory, copy all files into
  5356. a single directory, specified by the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/>
  5357. attribute. The default is <see langword="false"/>.
  5358. </summary>
  5359. </member>
  5360. <member name="P:NAnt.Core.Tasks.CopyTask.IncludeEmptyDirs">
  5361. <summary>
  5362. Copy any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>.
  5363. The default is <see langword="true"/>.
  5364. </summary>
  5365. </member>
  5366. <member name="P:NAnt.Core.Tasks.CopyTask.CopyFileSet">
  5367. <summary>
  5368. Used to select the files to copy. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
  5369. the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set.
  5370. </summary>
  5371. </member>
  5372. <member name="P:NAnt.Core.Tasks.CopyTask.Filters">
  5373. <summary>
  5374. Chain of filters used to alter the file's content as it is copied.
  5375. </summary>
  5376. </member>
  5377. <member name="P:NAnt.Core.Tasks.CopyTask.InputEncoding">
  5378. <summary>
  5379. The encoding to use when reading files. The default is the system's
  5380. current ANSI code page.
  5381. </summary>
  5382. </member>
  5383. <member name="P:NAnt.Core.Tasks.CopyTask.OutputEncoding">
  5384. <summary>
  5385. The encoding to use when writing the files. The default is
  5386. the encoding of the input file.
  5387. </summary>
  5388. </member>
  5389. <member name="P:NAnt.Core.Tasks.CopyTask.FileCopyMap">
  5390. <summary>
  5391. The set of files to perform a file operation on.
  5392. </summary>
  5393. <remarks>
  5394. <para>
  5395. The key of the <see cref="T:System.Collections.Hashtable"/> is the absolute path of
  5396. the destination file and the value is a <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/>
  5397. holding the path and last write time of the most recently updated
  5398. source file that is selected to be copied or moved to the
  5399. destination file.
  5400. </para>
  5401. <para>
  5402. On Windows, the <see cref="T:System.Collections.Hashtable"/> is case-insensitive.
  5403. </para>
  5404. </remarks>
  5405. </member>
  5406. <member name="T:NAnt.Core.Tasks.CopyTask.FileDateInfo">
  5407. <summary>
  5408. Holds the absolute paths and last write time of a given file.
  5409. </summary>
  5410. </member>
  5411. <member name="M:NAnt.Core.Tasks.CopyTask.FileDateInfo.#ctor(System.String,System.DateTime)">
  5412. <summary>
  5413. Initializes a new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/>
  5414. class for the specified file and last write time.
  5415. </summary>
  5416. <param name="path">The absolute path of the file.</param>
  5417. <param name="lastWriteTime">The last write time of the file.</param>
  5418. </member>
  5419. <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.Path">
  5420. <summary>
  5421. Gets the absolute path of the current file.
  5422. </summary>
  5423. <value>
  5424. The absolute path of the current file.
  5425. </value>
  5426. </member>
  5427. <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.LastWriteTime">
  5428. <summary>
  5429. Gets the time when the current file was last written to.
  5430. </summary>
  5431. <value>
  5432. The time when the current file was last written to.
  5433. </value>
  5434. </member>
  5435. <member name="T:NAnt.Core.Tasks.DeleteTask">
  5436. <summary>
  5437. Deletes a file, fileset or directory.
  5438. </summary>
  5439. <remarks>
  5440. <para>
  5441. Deletes either a single file, all files in a specified directory and
  5442. its sub-directories, or a set of files specified by one or more filesets.
  5443. </para>
  5444. <para>
  5445. If the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> or <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/> attribute is
  5446. set then the fileset contents will be ignored. To delete the files
  5447. in the fileset ommit the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> and <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/>
  5448. attributes in the <c>&lt;delete&gt;</c> element.
  5449. </para>
  5450. <para>
  5451. If the specified file or directory does not exist, no error is
  5452. reported.
  5453. </para>
  5454. <note>
  5455. Read-only files cannot be deleted. Use the <see cref="T:NAnt.Core.Tasks.AttribTask"/>
  5456. first to remove the read-only attribute.
  5457. </note>
  5458. </remarks>
  5459. <example>
  5460. <para>Delete a single file.</para>
  5461. <code>
  5462. <![CDATA[
  5463. <delete file="myfile.txt" />
  5464. ]]>
  5465. </code>
  5466. </example>
  5467. <example>
  5468. <para>
  5469. Delete a directory and the contents within. If the directory does not
  5470. exist, no error is reported.
  5471. </para>
  5472. <code>
  5473. <![CDATA[
  5474. <delete dir="${build.dir}" />
  5475. ]]>
  5476. </code>
  5477. </example>
  5478. <example>
  5479. <para>
  5480. Delete a set of files.
  5481. </para>
  5482. <code>
  5483. <![CDATA[
  5484. <delete>
  5485. <fileset>
  5486. <include name="${basename}-??.exe" />
  5487. <include name="${basename}-??.pdb" />
  5488. </fileset>
  5489. </delete>
  5490. ]]>
  5491. </code>
  5492. </example>
  5493. </member>
  5494. <member name="M:NAnt.Core.Tasks.DeleteTask.Initialize">
  5495. <summary>
  5496. Ensures the supplied attributes are valid.
  5497. </summary>
  5498. </member>
  5499. <member name="P:NAnt.Core.Tasks.DeleteTask.File">
  5500. <summary>
  5501. The file to delete.
  5502. </summary>
  5503. </member>
  5504. <member name="P:NAnt.Core.Tasks.DeleteTask.Directory">
  5505. <summary>
  5506. The directory to delete.
  5507. </summary>
  5508. </member>
  5509. <member name="P:NAnt.Core.Tasks.DeleteTask.IncludeEmptyDirs">
  5510. <summary>
  5511. Remove any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>.
  5512. The default is <see langword="true"/>.
  5513. </summary>
  5514. </member>
  5515. <member name="P:NAnt.Core.Tasks.DeleteTask.DeleteFileSet">
  5516. <summary>
  5517. All the files in the file set will be deleted.
  5518. </summary>
  5519. </member>
  5520. <member name="P:NAnt.Core.Tasks.DeleteTask.Verbose">
  5521. <summary>
  5522. Controls whether to show the name of each deleted file or directory.
  5523. The default is <see langword="false" />.
  5524. </summary>
  5525. </member>
  5526. <member name="T:NAnt.Core.Tasks.DescriptionTask">
  5527. <summary>
  5528. An empty task that allows a build file to contain a description.
  5529. </summary>
  5530. <example>
  5531. <para>Set a description.</para>
  5532. <code>
  5533. <![CDATA[
  5534. <description>This is a description.</description>
  5535. ]]>
  5536. </code>
  5537. </example>
  5538. </member>
  5539. <member name="T:NAnt.Core.Tasks.EchoTask">
  5540. <summary>
  5541. Writes a message to the build log or a specified file.
  5542. </summary>
  5543. <remarks>
  5544. <para>
  5545. The message can be specified using the <see cref="P:NAnt.Core.Tasks.EchoTask.Message"/> attribute
  5546. or as inline content. If neither is included - or the message contains
  5547. only whitespace - then an empty message will be emitted in the output.
  5548. </para>
  5549. <para>
  5550. Macros in the message will be expanded.
  5551. </para>
  5552. <para>
  5553. When writing to a file, the <see cref="P:NAnt.Core.Tasks.EchoTask.MessageLevel"/> attribute is
  5554. ignored.
  5555. </para>
  5556. <note>
  5557. Since NAnt 0.86, a newline will no longer be implictly added when
  5558. writing a message to a file.
  5559. </note>
  5560. </remarks>
  5561. <example>
  5562. <para>
  5563. Writes a message with level <see cref="F:NAnt.Core.Level.Debug"/> to the build log.
  5564. </para>
  5565. <code>
  5566. <![CDATA[
  5567. <echo message="Hello, World!" level="Debug" />
  5568. ]]>
  5569. </code>
  5570. </example>
  5571. <example>
  5572. <para>
  5573. Writes a two-line message to the build log using inline content.
  5574. </para>
  5575. <code>
  5576. <![CDATA[
  5577. <echo>First line
  5578. Second line</echo>
  5579. ]]>
  5580. </code>
  5581. </example>
  5582. <example>
  5583. <para>
  5584. Writes a two-line message to the build log using the <see cref="P:NAnt.Core.Tasks.EchoTask.Message"/> attribute.
  5585. </para>
  5586. <code>
  5587. <![CDATA[
  5588. <echo message='First line
  5589. Second line</echo>
  5590. ]]>
  5591. </code>
  5592. </example>
  5593. <example>
  5594. <para>
  5595. Writes a message with expanded macro to the build log.
  5596. </para>
  5597. <code>
  5598. <![CDATA[
  5599. <echo message="Base build directory = ${nant.project.basedir}" />
  5600. ]]>
  5601. </code>
  5602. </example>
  5603. <example>
  5604. <para>
  5605. Functionally equivalent to the previous example.
  5606. </para>
  5607. <code>
  5608. <![CDATA[
  5609. <echo>Base build directory = ${nant.project.basedir}</echo>
  5610. ]]>
  5611. </code>
  5612. </example>
  5613. <example>
  5614. <para>
  5615. Writes the previous message to a file in the project directory,
  5616. overwriting the file if it exists.
  5617. </para>
  5618. <code>
  5619. <![CDATA[
  5620. <echo file="buildmessage.txt">Base build directory = ${nant.project.basedir}</echo>
  5621. ]]>
  5622. </code>
  5623. </example>
  5624. </member>
  5625. <member name="M:NAnt.Core.Tasks.EchoTask.ExecuteTask">
  5626. <summary>
  5627. Outputs the message to the build log or the specified file.
  5628. </summary>
  5629. </member>
  5630. <member name="P:NAnt.Core.Tasks.EchoTask.Encoding">
  5631. <summary>
  5632. The encoding to use when writing message to a file. The default is
  5633. UTF-8 encoding without a Byte Order Mark (BOM).
  5634. </summary>
  5635. </member>
  5636. <member name="P:NAnt.Core.Tasks.EchoTask.Message">
  5637. <summary>
  5638. The message to output.
  5639. </summary>
  5640. </member>
  5641. <member name="P:NAnt.Core.Tasks.EchoTask.Contents">
  5642. <summary>
  5643. Gets or sets the inline content that should be output.
  5644. </summary>
  5645. <value>
  5646. The inline content that should be output.
  5647. </value>
  5648. </member>
  5649. <member name="P:NAnt.Core.Tasks.EchoTask.File">
  5650. <summary>
  5651. The file to write the message to.
  5652. </summary>
  5653. </member>
  5654. <member name="P:NAnt.Core.Tasks.EchoTask.Append">
  5655. <summary>
  5656. Determines whether the <see cref="T:NAnt.Core.Tasks.EchoTask"/> should append to the
  5657. file, or overwrite it. By default, the file will be overwritten.
  5658. </summary>
  5659. <value>
  5660. <see langword="true"/> if output should be appended to the file;
  5661. otherwise, <see langword="false"/>. The default is
  5662. <see langword="false"/>.
  5663. </value>
  5664. </member>
  5665. <member name="P:NAnt.Core.Tasks.EchoTask.MessageLevel">
  5666. <summary>
  5667. The logging level with which the message should be output. The default
  5668. is <see cref="F:NAnt.Core.Level.Info"/>.
  5669. </summary>
  5670. </member>
  5671. <member name="T:NAnt.Core.Tasks.ExecTask">
  5672. <summary>
  5673. Executes a system command.
  5674. </summary>
  5675. <remarks>
  5676. <para>
  5677. Use of nested <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"/> element(s)
  5678. is advised over the <see cref="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments"/> parameter, as
  5679. it supports automatic quoting and can resolve relative to absolute
  5680. paths.
  5681. </para>
  5682. </remarks>
  5683. <example>
  5684. <para>Ping "nant.sourceforge.net".</para>
  5685. <code>
  5686. <![CDATA[
  5687. <exec program="ping">
  5688. <arg value="nant.sourceforge.net" />
  5689. </exec>
  5690. ]]>
  5691. </code>
  5692. </example>
  5693. <example>
  5694. <para>
  5695. Execute a java application using <c>IKVM.NET</c> that requires the
  5696. Apache FOP jars, and a set of custom jars.
  5697. </para>
  5698. <code>
  5699. <![CDATA[
  5700. <path id="fop-classpath">
  5701. <pathelement file="${fop.dist.dir}/build/fop.jar" />
  5702. <pathelement file="${fop.dist.dir}/lib/xercesImpl-2.2.1.jar" />
  5703. <pathelement file="${fop.dist.dir}/lib/avalon-framework-cvs-20020806.jar" />
  5704. <pathelement file="${fop.dist.dir}/lib/batik.jar" />
  5705. </path>
  5706. <exec program="ikvm.exe" useruntimeengine="true">
  5707. <arg value="-cp" />
  5708. <arg>
  5709. <path>
  5710. <pathelement dir="conf" />
  5711. <path refid="fop-classpath" />
  5712. <pathelement file="lib/mylib.jar" />
  5713. <pathelement file="lib/otherlib.zip" />
  5714. </path>
  5715. </arg>
  5716. <arg value="org.me.MyProg" />
  5717. </exec>
  5718. ]]>
  5719. </code>
  5720. <para>
  5721. Assuming the base directory of the build file is "c:\ikvm-test" and
  5722. the value of the "fop.dist.dir" property is "c:\fop", then the value
  5723. of the <c>-cp</c> argument that is passed to<c>ikvm.exe</c> is
  5724. "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"
  5725. on a DOS-based system.
  5726. </para>
  5727. </example>
  5728. </member>
  5729. <member name="T:NAnt.Core.Tasks.ExternalProgramBase">
  5730. <summary>
  5731. Provides the abstract base class for tasks that execute external applications.
  5732. </summary>
  5733. <remarks>
  5734. <para>
  5735. When a <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/> is applied to the
  5736. deriving class and <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName"/> does not return an
  5737. absolute path, then the program to execute will first be searched for
  5738. in the location specified by <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/>.
  5739. </para>
  5740. <para>
  5741. If the program does not exist in that location, then the list of tool
  5742. paths of the current target framework will be scanned in the order in
  5743. which they are defined in the NAnt configuration file.
  5744. </para>
  5745. </remarks>
  5746. </member>
  5747. <member name="F:NAnt.Core.Tasks.ExternalProgramBase.UnknownExitCode">
  5748. <summary>
  5749. Defines the exit code that will be returned by <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode"/>
  5750. if the process could not be started, or did not exit (in time).
  5751. </summary>
  5752. </member>
  5753. <member name="F:NAnt.Core.Tasks.ExternalProgramBase._lockObject">
  5754. <summary>
  5755. Will be used to ensure thread-safe operations.
  5756. </summary>
  5757. </member>
  5758. <member name="M:NAnt.Core.Tasks.ExternalProgramBase.ExecuteTask">
  5759. <summary>
  5760. Starts the external process and captures its output.
  5761. </summary>
  5762. <exception cref="T:NAnt.Core.BuildException">
  5763. <para>The external process did not finish within the configured timeout.</para>
  5764. <para>-or-</para>
  5765. <para>The exit code of the external process indicates a failure.</para>
  5766. </exception>
  5767. </member>
  5768. <member name="M:NAnt.Core.Tasks.ExternalProgramBase.PrepareProcess(System.Diagnostics.Process)">
  5769. <summary>
  5770. Updates the <see cref="T:System.Diagnostics.ProcessStartInfo"/> of the specified
  5771. <see cref="T:System.Diagnostics.Process"/>.
  5772. </summary>
  5773. <param name="process">The <see cref="T:System.Diagnostics.Process"/> of which the <see cref="T:System.Diagnostics.ProcessStartInfo"/> should be updated.</param>
  5774. </member>
  5775. <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StartProcess">
  5776. <summary>
  5777. Starts the process and handles errors.
  5778. </summary>
  5779. <returns>The <see cref="T:System.Diagnostics.Process"/> that was started.</returns>
  5780. </member>
  5781. <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Output">
  5782. <summary>
  5783. Reads from the stream until the external program is ended.
  5784. </summary>
  5785. </member>
  5786. <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Error">
  5787. <summary>
  5788. Reads from the stream until the external program is ended.
  5789. </summary>
  5790. </member>
  5791. <member name="M:NAnt.Core.Tasks.ExternalProgramBase.DetermineFilePath">
  5792. <summary>
  5793. Determines the path of the external program that should be executed.
  5794. </summary>
  5795. <returns>
  5796. A fully qualifies pathname including the program name.
  5797. </returns>
  5798. <exception cref="T:NAnt.Core.BuildException">The task is not available or not configured for the current framework.</exception>
  5799. </member>
  5800. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName">
  5801. <summary>
  5802. The name of the executable that should be used to launch the
  5803. external program.
  5804. </summary>
  5805. <value>
  5806. The name of the executable that should be used to launch the external
  5807. program, or <see langword="null" /> if no name is specified.
  5808. </value>
  5809. <remarks>
  5810. If available, the configured value in the NAnt configuration
  5811. file will be used if no name is specified.
  5812. </remarks>
  5813. </member>
  5814. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramFileName">
  5815. <summary>
  5816. Gets the filename of the external program to start.
  5817. </summary>
  5818. <value>
  5819. The filename of the external program.
  5820. </value>
  5821. <remarks>
  5822. Override in derived classes to explicitly set the location of the
  5823. external tool.
  5824. </remarks>
  5825. </member>
  5826. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramArguments">
  5827. <summary>
  5828. Gets the command-line arguments for the external program.
  5829. </summary>
  5830. <value>
  5831. The command-line arguments for the external program.
  5832. </value>
  5833. </member>
  5834. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Output">
  5835. <summary>
  5836. Gets the file to which the standard output should be redirected.
  5837. </summary>
  5838. <value>
  5839. The file to which the standard output should be redirected, or
  5840. <see langword="null" /> if the standard output should not be
  5841. redirected.
  5842. </value>
  5843. <remarks>
  5844. The default implementation will never allow the standard output
  5845. to be redirected to a file. Deriving classes should override this
  5846. property to change this behaviour.
  5847. </remarks>
  5848. </member>
  5849. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputAppend">
  5850. <summary>
  5851. Gets a value indicating whether output will be appended to the
  5852. <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>.
  5853. </summary>
  5854. <value>
  5855. <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>;
  5856. otherwise, <see langword="false"/>.
  5857. </value>
  5858. </member>
  5859. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.BaseDirectory">
  5860. <summary>
  5861. Gets the working directory for the application.
  5862. </summary>
  5863. <value>
  5864. The working directory for the application.
  5865. </value>
  5866. </member>
  5867. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.TimeOut">
  5868. <summary>
  5869. The maximum amount of time the application is allowed to execute,
  5870. expressed in milliseconds. Defaults to no time-out.
  5871. </summary>
  5872. </member>
  5873. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments">
  5874. <summary>
  5875. The command-line arguments for the external program.
  5876. </summary>
  5877. </member>
  5878. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine">
  5879. <summary>
  5880. Specifies whether the external program is a managed application
  5881. which should be executed using a runtime engine, if configured.
  5882. The default is <see langword="false"/>.
  5883. </summary>
  5884. <value>
  5885. <see langword="true"/> if the external program should be executed
  5886. using a runtime engine; otherwise, <see langword="false"/>.
  5887. </value>
  5888. <remarks>
  5889. <para>
  5890. The value of <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is only used from
  5891. <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/>, and then only if its value is set to
  5892. <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>. In which case
  5893. <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/> returns <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/>
  5894. if <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is <see langword="true"/>.
  5895. </para>
  5896. <para>
  5897. In all other cases, the value of <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/>
  5898. is ignored.
  5899. </para>
  5900. </remarks>
  5901. </member>
  5902. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Managed">
  5903. <summary>
  5904. Specifies whether the external program should be treated as a managed
  5905. application, possibly forcing it to be executed under the currently
  5906. targeted version of the CLR.
  5907. </summary>
  5908. <value>
  5909. A <see cref="T:NAnt.Core.Types.ManagedExecution"/> indicating how the program should
  5910. be treated.
  5911. </value>
  5912. <remarks>
  5913. <para>
  5914. If <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/> is set to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>,
  5915. which is the default value, and <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is
  5916. <see langword="true"/> then <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/>
  5917. is returned.
  5918. </para>
  5919. <para>
  5920. When the changing <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/> to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>,
  5921. then <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is set to <see langword="false"/>;
  5922. otherwise, it is changed to <see langword="true"/>.
  5923. </para>
  5924. </remarks>
  5925. </member>
  5926. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputWriter">
  5927. <summary>
  5928. Gets or sets the <see cref="T:System.IO.TextWriter"/> to which standard output
  5929. messages of the external program will be written.
  5930. </summary>
  5931. <value>
  5932. The <see cref="T:System.IO.TextWriter"/> to which standard output messages of
  5933. the external program will be written.
  5934. </value>
  5935. <remarks>
  5936. By default, standard output messages wil be written to the build log
  5937. with level <see cref="F:NAnt.Core.Level.Info"/>.
  5938. </remarks>
  5939. </member>
  5940. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ErrorWriter">
  5941. <summary>
  5942. Gets or sets the <see cref="T:System.IO.TextWriter"/> to which error output
  5943. of the external program will be written.
  5944. </summary>
  5945. <value>
  5946. The <see cref="T:System.IO.TextWriter"/> to which error output of the external
  5947. program will be written.
  5948. </value>
  5949. <remarks>
  5950. By default, error output wil be written to the build log with level
  5951. <see cref="F:NAnt.Core.Level.Warning"/>.
  5952. </remarks>
  5953. </member>
  5954. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode">
  5955. <summary>
  5956. Gets the value that the process specified when it terminated.
  5957. </summary>
  5958. <value>
  5959. The code that the associated process specified when it terminated,
  5960. or <c>-1000</c> if the process could not be started or did not
  5961. exit (in time).
  5962. </value>
  5963. </member>
  5964. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProcessId">
  5965. <summary>
  5966. Gets the unique identifier for the spawned application.
  5967. </summary>
  5968. </member>
  5969. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Spawn">
  5970. <summary>
  5971. Gets or sets a value indicating whether the application should be
  5972. spawned. If you spawn an application, its output will not be logged
  5973. by NAnt. The default is <see langword="false" />.
  5974. </summary>
  5975. </member>
  5976. <member name="P:NAnt.Core.Tasks.ExternalProgramBase.CommandLine">
  5977. <summary>
  5978. Gets the command-line arguments, separated by spaces.
  5979. </summary>
  5980. </member>
  5981. <member name="M:NAnt.Core.Tasks.ExecTask.Initialize">
  5982. <summary>
  5983. Performs additional checks after the task has been initialized.
  5984. </summary>
  5985. <exception cref="T:NAnt.Core.BuildException"><see cref="P:NAnt.Core.Tasks.ExecTask.FileName"/> does not hold a valid file name.</exception>
  5986. </member>
  5987. <member name="M:NAnt.Core.Tasks.ExecTask.ExecuteTask">
  5988. <summary>
  5989. Executes the external program.
  5990. </summary>
  5991. </member>
  5992. <member name="P:NAnt.Core.Tasks.ExecTask.FileName">
  5993. <summary>
  5994. The program to execute without command arguments.
  5995. </summary>
  5996. <remarks>
  5997. The path will not be evaluated to a full path using the project
  5998. base directory.
  5999. </remarks>
  6000. </member>
  6001. <member name="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments">
  6002. <summary>
  6003. The command-line arguments for the program. These will be
  6004. passed as is to the external program. When quoting is necessary,
  6005. these must be explictly set as part of the value. Consider using
  6006. nested <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"/> elements instead.
  6007. </summary>
  6008. </member>
  6009. <member name="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet">
  6010. <summary>
  6011. Environment variables to pass to the program.
  6012. </summary>
  6013. </member>
  6014. <member name="P:NAnt.Core.Tasks.ExecTask.WorkingDirectory">
  6015. <summary>
  6016. The directory in which the command will be executed.
  6017. </summary>
  6018. <value>
  6019. The directory in which the command will be executed. The default
  6020. is the project's base directory.
  6021. </value>
  6022. <remarks>
  6023. <para>
  6024. The working directory will be evaluated relative to the project's
  6025. base directory if it is relative.
  6026. </para>
  6027. </remarks>
  6028. </member>
  6029. <member name="P:NAnt.Core.Tasks.ExecTask.ResultProperty">
  6030. <summary>
  6031. <para>
  6032. The name of a property in which the exit code of the program should
  6033. be stored. Only of interest if <see cref="P:NAnt.Core.Task.FailOnError"/> is
  6034. <see langword="false"/>.
  6035. </para>
  6036. <para>
  6037. If the exit code of the program is "-1000" then the program could
  6038. not be started, or did not exit (in time).
  6039. </para>
  6040. </summary>
  6041. </member>
  6042. <member name="P:NAnt.Core.Tasks.ExecTask.UseRuntimeEngine">
  6043. <summary>
  6044. Specifies whether the external program should be executed using a
  6045. runtime engine, if configured. The default is <see langword="false" />.
  6046. </summary>
  6047. <value>
  6048. <see langword="true" /> if the external program should be executed
  6049. using a runtime engine; otherwise, <see langword="false" />.
  6050. </value>
  6051. </member>
  6052. <member name="P:NAnt.Core.Tasks.ExecTask.Managed">
  6053. <summary>
  6054. Specifies whether the external program is a managed application
  6055. which should be executed using a runtime engine, if configured.
  6056. The default is <see langword="false" />.
  6057. </summary>
  6058. <value>
  6059. <see langword="true" /> if the external program should be executed
  6060. using a runtime engine; otherwise, <see langword="false" />.
  6061. </value>
  6062. </member>
  6063. <member name="P:NAnt.Core.Tasks.ExecTask.ProgramFileName">
  6064. <summary>
  6065. Gets the filename of the external program to start.
  6066. </summary>
  6067. <value>
  6068. The filename of the external program.
  6069. </value>
  6070. </member>
  6071. <member name="P:NAnt.Core.Tasks.ExecTask.ProgramArguments">
  6072. <summary>
  6073. Gets the command-line arguments for the external program.
  6074. </summary>
  6075. <value>
  6076. The command-line arguments for the external program.
  6077. </value>
  6078. </member>
  6079. <member name="P:NAnt.Core.Tasks.ExecTask.BaseDirectory">
  6080. <summary>
  6081. The directory the program is in.
  6082. </summary>
  6083. <remarks>
  6084. <value>
  6085. The directory the program is in. The default is the project's base
  6086. directory.
  6087. </value>
  6088. <para>
  6089. The basedir will be evaluated relative to the project's base
  6090. directory if it is relative.
  6091. </para>
  6092. </remarks>
  6093. </member>
  6094. <member name="P:NAnt.Core.Tasks.ExecTask.Output">
  6095. <summary>
  6096. The file to which the standard output will be redirected.
  6097. </summary>
  6098. <remarks>
  6099. By default, the standard output is redirected to the console.
  6100. </remarks>
  6101. </member>
  6102. <member name="P:NAnt.Core.Tasks.ExecTask.OutputAppend">
  6103. <summary>
  6104. Gets or sets a value indicating whether output should be appended
  6105. to the output file. The default is <see langword="false"/>.
  6106. </summary>
  6107. <value>
  6108. <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExecTask.Output"/>;
  6109. otherwise, <see langword="false"/>.
  6110. </value>
  6111. </member>
  6112. <member name="P:NAnt.Core.Tasks.ExecTask.Spawn">
  6113. <summary>
  6114. Gets or sets a value indicating whether the application should be
  6115. spawned. If you spawn an application, its output will not be logged
  6116. by NAnt. The default is <see langword="false" />.
  6117. </summary>
  6118. </member>
  6119. <member name="P:NAnt.Core.Tasks.ExecTask.ProcessIdProperty">
  6120. <summary>
  6121. The name of a property in which the unique identifier of the spawned
  6122. application should be stored. Only of interest if <see cref="P:NAnt.Core.Tasks.ExecTask.Spawn"/>
  6123. is <see langword="true"/>.
  6124. </summary>
  6125. </member>
  6126. <member name="T:NAnt.Core.Tasks.FailTask">
  6127. <summary>
  6128. Exits the current build by throwing a <see cref="T:NAnt.Core.BuildException"/>,
  6129. optionally printing additional information.
  6130. </summary>
  6131. <remarks>
  6132. <para>
  6133. The cause of the build failure can be specified using the <see cref="P:NAnt.Core.Tasks.FailTask.Message"/>
  6134. attribute or as inline content.
  6135. </para>
  6136. <para>
  6137. Macros in the message will be expanded.
  6138. </para>
  6139. </remarks>
  6140. <example>
  6141. <para>Exits the current build without giving further information.</para>
  6142. <code>
  6143. <![CDATA[
  6144. <fail />
  6145. ]]>
  6146. </code>
  6147. </example>
  6148. <example>
  6149. <para>Exits the current build and writes a message to the build log.</para>
  6150. <code>
  6151. <![CDATA[
  6152. <fail message="Something wrong here." />
  6153. ]]>
  6154. </code>
  6155. </example>
  6156. <example>
  6157. <para>Functionally equivalent to the previous example.</para>
  6158. <code>
  6159. <![CDATA[
  6160. <fail>Something wrong here.</fail>
  6161. ]]>
  6162. </code>
  6163. </example>
  6164. </member>
  6165. <member name="P:NAnt.Core.Tasks.FailTask.Message">
  6166. <summary>
  6167. A message giving further information on why the build exited.
  6168. </summary>
  6169. <remarks>
  6170. Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive.
  6171. </remarks>
  6172. </member>
  6173. <member name="P:NAnt.Core.Tasks.FailTask.Contents">
  6174. <summary>
  6175. Gets or sets the inline content that should be output in the build
  6176. log, giving further information on why the build exited.
  6177. </summary>
  6178. <value>
  6179. The inline content that should be output in the build log.
  6180. </value>
  6181. <remarks>
  6182. Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive.
  6183. </remarks>
  6184. </member>
  6185. <member name="T:NAnt.Core.Tasks.GetTask">
  6186. <summary>
  6187. Gets a particular file from a URL source.
  6188. </summary>
  6189. <remarks>
  6190. <para>
  6191. Options include verbose reporting and timestamp based fetches.
  6192. </para>
  6193. <para>
  6194. Currently, only HTTP and UNC protocols are supported. FTP support may
  6195. be added when more pluggable protocols are added to the System.Net
  6196. assembly.
  6197. </para>
  6198. <para>
  6199. The <see cref="P:NAnt.Core.Tasks.GetTask.UseTimeStamp"/> option enables you to control downloads
  6200. so that the remote file is only fetched if newer than the local copy.
  6201. If there is no local copy, the download always takes place. When a file
  6202. is downloaded, the timestamp of the downloaded file is set to the remote
  6203. timestamp.
  6204. </para>
  6205. <note>
  6206. This timestamp facility only works on downloads using the HTTP protocol.
  6207. </note>
  6208. </remarks>
  6209. <example>
  6210. <para>
  6211. Gets the index page of the NAnt home page, and stores it in the file
  6212. <c>help/index.html</c> relative to the project base directory.
  6213. </para>
  6214. <code>
  6215. <![CDATA[
  6216. <get src="http://nant.sourceforge.org/" dest="help/index.html" />
  6217. ]]>
  6218. </code>
  6219. </example>
  6220. <example>
  6221. <para>
  6222. Gets the index page of a secured web site using the given credentials,
  6223. while connecting using the specified password-protected proxy server.
  6224. </para>
  6225. <code>
  6226. <![CDATA[
  6227. <get src="http://password.protected.site/index.html" dest="secure/index.html">
  6228. <credentials username="user" password="guess" domain="mydomain" />
  6229. <proxy host="proxy.company.com" port="8080">
  6230. <credentials username="proxyuser" password="dunno" />
  6231. </proxy>
  6232. </get>
  6233. ]]>
  6234. </code>
  6235. </example>
  6236. </member>
  6237. <member name="M:NAnt.Core.Tasks.GetTask.Initialize">
  6238. <summary>
  6239. Initializes task and ensures the supplied attributes are valid.
  6240. </summary>
  6241. </member>
  6242. <member name="M:NAnt.Core.Tasks.GetTask.ExecuteTask">
  6243. <summary>
  6244. This is where the work is done
  6245. </summary>
  6246. </member>
  6247. <member name="M:NAnt.Core.Tasks.GetTask.TouchFile(System.IO.FileInfo,System.DateTime)">
  6248. <summary>
  6249. Sets the timestamp of a given file to a specified time.
  6250. </summary>
  6251. </member>
  6252. <member name="P:NAnt.Core.Tasks.GetTask.Source">
  6253. <summary>
  6254. The URL from which to retrieve a file.
  6255. </summary>
  6256. </member>
  6257. <member name="P:NAnt.Core.Tasks.GetTask.DestinationFile">
  6258. <summary>
  6259. The file where to store the retrieved file.
  6260. </summary>
  6261. </member>
  6262. <member name="P:NAnt.Core.Tasks.GetTask.HttpProxy">
  6263. <summary>
  6264. If inside a firewall, proxy server/port information
  6265. Format: {proxy server name}:{port number}
  6266. Example: proxy.mycompany.com:8080
  6267. </summary>
  6268. </member>
  6269. <member name="P:NAnt.Core.Tasks.GetTask.Proxy">
  6270. <summary>
  6271. The network proxy to use to access the Internet resource.
  6272. </summary>
  6273. </member>
  6274. <member name="P:NAnt.Core.Tasks.GetTask.Credentials">
  6275. <summary>
  6276. The network credentials used for authenticating the request with
  6277. the Internet resource.
  6278. </summary>
  6279. </member>
  6280. <member name="P:NAnt.Core.Tasks.GetTask.IgnoreErrors">
  6281. <summary>
  6282. Log errors but don't treat as fatal. The default is <see langword="false" />.
  6283. </summary>
  6284. </member>
  6285. <member name="P:NAnt.Core.Tasks.GetTask.UseTimeStamp">
  6286. <summary>
  6287. Conditionally download a file based on the timestamp of the local
  6288. copy. HTTP only. The default is <see langword="false" />.
  6289. </summary>
  6290. </member>
  6291. <member name="P:NAnt.Core.Tasks.GetTask.Timeout">
  6292. <summary>
  6293. The length of time, in milliseconds, until the request times out.
  6294. The default is <c>100000</c> milliseconds.
  6295. </summary>
  6296. </member>
  6297. <member name="P:NAnt.Core.Tasks.GetTask.Certificates">
  6298. <summary>
  6299. The security certificates to associate with the request.
  6300. </summary>
  6301. </member>
  6302. <member name="T:NAnt.Core.Tasks.IfTask">
  6303. <summary>
  6304. Checks the conditional attributes and executes the children if
  6305. <see langword="true"/>.
  6306. </summary>
  6307. <remarks>
  6308. <para>
  6309. If no conditions are checked, all child tasks are executed.
  6310. </para>
  6311. <para>
  6312. If more than one attribute is used, they are &amp;&amp;'d. The first
  6313. to fail stops the check.
  6314. </para>
  6315. <para>
  6316. The order of condition evaluation is, <see cref="P:NAnt.Core.Tasks.IfTask.TargetNameExists"/>,
  6317. <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameExists"/>, <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue"/>,
  6318. <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>.
  6319. </para>
  6320. <note>
  6321. instead of using the deprecated attributes, we advise you to use the
  6322. following functions in combination with the <see cref="P:NAnt.Core.Tasks.IfTask.Test"/>
  6323. attribute:
  6324. </note>
  6325. <list type="table">
  6326. <listheader>
  6327. <term>Function</term>
  6328. <description>Description</description>
  6329. </listheader>
  6330. <item>
  6331. <term><see cref="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)"/></term>
  6332. <description>Checks whether the specified property exists.</description>
  6333. </item>
  6334. <item>
  6335. <term><see cref="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)"/></term>
  6336. <description>Checks whether the specified target exists.</description>
  6337. </item>
  6338. </list>
  6339. </remarks>
  6340. <example>
  6341. <para>Tests the value of a property using expressions.</para>
  6342. <code>
  6343. <![CDATA[
  6344. <if test="${build.configuration=='release'}">
  6345. <echo>Build release configuration</echo>
  6346. </if>
  6347. ]]>
  6348. </code>
  6349. </example>
  6350. <example>
  6351. <para>Tests the the output of a function.</para>
  6352. <code>
  6353. <![CDATA[
  6354. <if test="${not file::exists(filename) or file::get-length(filename) = 0}">
  6355. <echo message="The version file ${filename} doesn't exist or is empty!" />
  6356. </if>
  6357. ]]>
  6358. </code>
  6359. </example>
  6360. <example>
  6361. <para><c>(Deprecated)</c> Check that a target exists.</para>
  6362. <code>
  6363. <![CDATA[
  6364. <target name="myTarget" />
  6365. <if targetexists="myTarget">
  6366. <echo message="myTarget exists" />
  6367. </if>
  6368. ]]>
  6369. </code>
  6370. </example>
  6371. <example>
  6372. <para><c>(Deprecated)</c> Check existence of a property.</para>
  6373. <code>
  6374. <![CDATA[
  6375. <if propertyexists="myProp">
  6376. <echo message="myProp Exists. Value='${myProp}'" />
  6377. </if>
  6378. ]]>
  6379. </code>
  6380. </example>
  6381. <example>
  6382. <para><c>(Deprecated)</c> Check that a property value is true.</para>
  6383. <code>
  6384. <![CDATA[
  6385. <if propertytrue="myProp">
  6386. <echo message="myProp is true. Value='${myProp}'" />
  6387. </if>
  6388. ]]>
  6389. </code>
  6390. </example>
  6391. <example>
  6392. <para>
  6393. <c>(Deprecated)</c> Check that a property exists and is <see langword="true"/>
  6394. (uses multiple conditions).
  6395. </para>
  6396. <code>
  6397. <![CDATA[
  6398. <if propertyexists="myProp" propertytrue="myProp">
  6399. <echo message="myProp is '${myProp}'" />
  6400. </if>
  6401. ]]>
  6402. </code>
  6403. <para>which is the same as</para>
  6404. <code>
  6405. <![CDATA[
  6406. <if propertyexists="myProp">
  6407. <if propertytrue="myProp">
  6408. <echo message="myProp is '${myProp}'" />
  6409. </if>
  6410. </if>
  6411. ]]>
  6412. </code>
  6413. </example>
  6414. <example>
  6415. <para>
  6416. <c>(Deprecated)</c> Check file dates. If <c>myfile.dll</c> is uptodate,
  6417. then do stuff.
  6418. </para>
  6419. <code>
  6420. <![CDATA[
  6421. <if uptodatefile="myfile.dll" comparefile="myfile.cs">
  6422. <echo message="myfile.dll is newer/same-date as myfile.cs" />
  6423. </if>
  6424. ]]>
  6425. </code>
  6426. <para>or</para>
  6427. <code>
  6428. <![CDATA[
  6429. <if uptodatefile="myfile.dll">
  6430. <comparefiles>
  6431. <include name="*.cs" />
  6432. </comparefiles>
  6433. <echo message="myfile.dll is newer/same-date as myfile.cs" />
  6434. </if>
  6435. ]]>
  6436. </code>
  6437. <para>or</para>
  6438. <code>
  6439. <![CDATA[
  6440. <if>
  6441. <uptodatefiles>
  6442. <include name="myfile.dll" />
  6443. </uptodatefiles>
  6444. <comparefiles>
  6445. <include name="*.cs" />
  6446. </comparefiles>
  6447. <echo message="myfile.dll is newer/same-date as myfile.cs" />
  6448. </if>
  6449. ]]>
  6450. </code>
  6451. </example>
  6452. </member>
  6453. <member name="T:NAnt.Core.TaskContainer">
  6454. <summary>
  6455. Executes embedded tasks in the order in which they are defined.
  6456. </summary>
  6457. </member>
  6458. <member name="M:NAnt.Core.TaskContainer.Initialize">
  6459. <summary>
  6460. Automatically exclude build elements that are defined on the task
  6461. from things that get executed, as they are evaluated normally during
  6462. XML task initialization.
  6463. </summary>
  6464. </member>
  6465. <member name="M:NAnt.Core.TaskContainer.ExecuteChildTasks">
  6466. <summary>
  6467. Creates and executes the embedded (child XML nodes) elements.
  6468. </summary>
  6469. <remarks>
  6470. Skips any element defined by the host <see cref="T:NAnt.Core.Task"/> that has
  6471. a <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> defined.
  6472. </remarks>
  6473. </member>
  6474. <member name="P:NAnt.Core.TaskContainer.CustomXmlProcessing">
  6475. <summary>
  6476. Gets a value indicating whether the element is performing additional
  6477. processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
  6478. initialize the element.
  6479. </summary>
  6480. <value>
  6481. <see langword="true"/>, as a <see cref="T:NAnt.Core.TaskContainer"/> is
  6482. responsable for creating tasks from the nested build elements.
  6483. </value>
  6484. </member>
  6485. <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFile">
  6486. <summary>
  6487. The file to compare if uptodate.
  6488. </summary>
  6489. </member>
  6490. <member name="P:NAnt.Core.Tasks.IfTask.CompareFile">
  6491. <summary>
  6492. The file to check against for the uptodate file.
  6493. </summary>
  6494. </member>
  6495. <member name="P:NAnt.Core.Tasks.IfTask.CompareFiles">
  6496. <summary>
  6497. The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the comparison files for
  6498. the <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>(s) check.
  6499. </summary>
  6500. </member>
  6501. <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFiles">
  6502. <summary>
  6503. The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the uptodate files for
  6504. the <see cref="P:NAnt.Core.Tasks.IfTask.CompareFile"/>(s) check.
  6505. </summary>
  6506. </member>
  6507. <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue">
  6508. <summary>
  6509. Used to test whether a property is true.
  6510. </summary>
  6511. </member>
  6512. <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameExists">
  6513. <summary>
  6514. Used to test whether a property exists.
  6515. </summary>
  6516. </member>
  6517. <member name="P:NAnt.Core.Tasks.IfTask.TargetNameExists">
  6518. <summary>
  6519. Used to test whether a target exists.
  6520. </summary>
  6521. </member>
  6522. <member name="P:NAnt.Core.Tasks.IfTask.Test">
  6523. <summary>
  6524. Used to test arbitrary boolean expression.
  6525. </summary>
  6526. </member>
  6527. <member name="T:NAnt.Core.Tasks.IfNotTask">
  6528. <summary>
  6529. The opposite of the <c>if</c> task.
  6530. </summary>
  6531. <example>
  6532. <para>Check that a property does not exist.</para>
  6533. <code>
  6534. <![CDATA[
  6535. <ifnot propertyexists="myProp">
  6536. <echo message="myProp does not exist."/>
  6537. </if>
  6538. ]]>
  6539. </code>
  6540. <para>Check that a property value is not true.</para>
  6541. <code>
  6542. <![CDATA[
  6543. <ifnot propertytrue="myProp">
  6544. <echo message="myProp is not true."/>
  6545. </if>
  6546. ]]>
  6547. </code>
  6548. </example>
  6549. <example>
  6550. <para>Check that a target does not exist.</para>
  6551. <code>
  6552. <![CDATA[
  6553. <ifnot targetexists="myTarget">
  6554. <echo message="myTarget does not exist."/>
  6555. </if>
  6556. ]]>
  6557. </code>
  6558. </example>
  6559. </member>
  6560. <member name="T:NAnt.Core.Tasks.IncludeTask">
  6561. <summary>
  6562. Includes an external build file.
  6563. </summary>
  6564. <remarks>
  6565. <para>
  6566. This task is used to break your build file into smaller chunks. You
  6567. can load a partial build file and have it included into the build file.
  6568. </para>
  6569. <note>
  6570. Any global (project level) tasks in the included build file are executed
  6571. when this task is executed. Tasks in target elements are only executed
  6572. if that target is executed.
  6573. </note>
  6574. <note>
  6575. The project element attributes are ignored.
  6576. </note>
  6577. <note>
  6578. This task can only be in the global (project level) section of the
  6579. build file.
  6580. </note>
  6581. <note>
  6582. This task can only include files from the file system.
  6583. </note>
  6584. </remarks>
  6585. <example>
  6586. <para>
  6587. Include a task that fetches the project version from the
  6588. <c>GetProjectVersion.include</c> build file.
  6589. </para>
  6590. <code>
  6591. <![CDATA[
  6592. <include buildfile="GetProjectVersion.include" />
  6593. ]]>
  6594. </code>
  6595. </example>
  6596. </member>
  6597. <member name="F:NAnt.Core.Tasks.IncludeTask._includedFileNames">
  6598. <summary>
  6599. Used to check for recursived includes.
  6600. </summary>
  6601. </member>
  6602. <member name="M:NAnt.Core.Tasks.IncludeTask.Initialize">
  6603. <summary>
  6604. Verifies parameters.
  6605. </summary>
  6606. </member>
  6607. <member name="P:NAnt.Core.Tasks.IncludeTask.BuildFileName">
  6608. <summary>
  6609. Build file to include.
  6610. </summary>
  6611. </member>
  6612. <member name="T:NAnt.Core.Tasks.LoadFileTask">
  6613. <summary>
  6614. Load a text file into a single property.
  6615. </summary>
  6616. <remarks>
  6617. <para>
  6618. Unless an encoding is specified, the encoding associated with the
  6619. system's current ANSI code page is used.
  6620. </para>
  6621. <para>
  6622. An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
  6623. file is automatically recognized, if the file starts with the appropriate
  6624. byte order marks.
  6625. </para>
  6626. </remarks>
  6627. <example>
  6628. <para>
  6629. Load file <c>message.txt</c> into property "message".
  6630. </para>
  6631. <code>
  6632. <![CDATA[
  6633. <loadfile
  6634. file="message.txt"
  6635. property="message" />
  6636. ]]>
  6637. </code>
  6638. </example>
  6639. <example>
  6640. <para>
  6641. Load a file using the "latin-1" encoding.
  6642. </para>
  6643. <code>
  6644. <![CDATA[
  6645. <loadfile
  6646. file="loadfile.xml"
  6647. property="encoded-file"
  6648. encoding="iso-8859-1" />
  6649. ]]>
  6650. </code>
  6651. </example>
  6652. <example>
  6653. <para>
  6654. Load a file, replacing all <c>@NOW@</c> tokens with the current
  6655. date/time.
  6656. </para>
  6657. <code>
  6658. <![CDATA[
  6659. <loadfile file="token.txt" property="token-file">
  6660. <filterchain>
  6661. <replacetokens>
  6662. <token key="NOW" value="${datetime::now()}" />
  6663. </replacetokens>
  6664. </filterchain>
  6665. </loadfile>
  6666. ]]>
  6667. </code>
  6668. </example>
  6669. </member>
  6670. <member name="P:NAnt.Core.Tasks.LoadFileTask.File">
  6671. <summary>
  6672. The file to load.
  6673. </summary>
  6674. </member>
  6675. <member name="P:NAnt.Core.Tasks.LoadFileTask.Property">
  6676. <summary>
  6677. The name of the property to save the content to.
  6678. </summary>
  6679. </member>
  6680. <member name="P:NAnt.Core.Tasks.LoadFileTask.Encoding">
  6681. <summary>
  6682. The encoding to use when loading the file. The default is the encoding
  6683. associated with the system's current ANSI code page.
  6684. </summary>
  6685. </member>
  6686. <member name="P:NAnt.Core.Tasks.LoadFileTask.FilterChain">
  6687. <summary>
  6688. The filterchain definition to use.
  6689. </summary>
  6690. </member>
  6691. <member name="T:NAnt.Core.Tasks.LoadTasksTask">
  6692. <summary>
  6693. Loads tasks form a given assembly or all assemblies in a given directory
  6694. or <see cref="T:NAnt.Core.Types.FileSet"/>.
  6695. </summary>
  6696. <example>
  6697. <para>
  6698. Load tasks from a single assembly.
  6699. </para>
  6700. <code>
  6701. <![CDATA[
  6702. <loadtasks assembly="c:foo\NAnt.Contrib.Tasks.dll" />
  6703. ]]>
  6704. </code>
  6705. </example>
  6706. <example>
  6707. <para>
  6708. Scan a single directory for task assemblies.
  6709. </para>
  6710. <code>
  6711. <![CDATA[
  6712. <loadtasks path="c:\foo" />
  6713. ]]>
  6714. </code>
  6715. </example>
  6716. <example>
  6717. <para>
  6718. Use a <see cref="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet"/> containing both a directory and an
  6719. assembly.
  6720. </para>
  6721. <code>
  6722. <![CDATA[
  6723. <loadtasks>
  6724. <fileset>
  6725. <include name="C:\cvs\NAntContrib\build" />
  6726. <include name="C:\cvs\NAntContrib\build\NAnt.Contrib.Tasks.dll" />
  6727. </fileset>
  6728. </loadtasks>
  6729. ]]>
  6730. </code>
  6731. </example>
  6732. </member>
  6733. <member name="M:NAnt.Core.Tasks.LoadTasksTask.ExecuteTask">
  6734. <summary>
  6735. Executes the Load Tasks task.
  6736. </summary>
  6737. <exception cref="T:NAnt.Core.BuildException">Specified assembly or path does not exist.</exception>
  6738. </member>
  6739. <member name="M:NAnt.Core.Tasks.LoadTasksTask.Initialize">
  6740. <summary>
  6741. Validates the attributes.
  6742. </summary>
  6743. <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>
  6744. </member>
  6745. <member name="P:NAnt.Core.Tasks.LoadTasksTask.AssemblyPath">
  6746. <summary>
  6747. An assembly to load tasks from.
  6748. </summary>
  6749. </member>
  6750. <member name="P:NAnt.Core.Tasks.LoadTasksTask.Path">
  6751. <summary>
  6752. A directory to scan for task assemblies.
  6753. </summary>
  6754. </member>
  6755. <member name="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet">
  6756. <summary>
  6757. Used to select which directories or individual assemblies to scan.
  6758. </summary>
  6759. </member>
  6760. <member name="T:NAnt.Core.Tasks.LoopTask">
  6761. <summary>
  6762. Loops over a set of items.
  6763. </summary>
  6764. <remarks>
  6765. <para>
  6766. Can loop over files in directory, lines in a file, etc.
  6767. </para>
  6768. <para>
  6769. The property value is stored before the loop is done, and restored
  6770. when the loop is finished.
  6771. </para>
  6772. <para>
  6773. The property is returned to its normal value once it is used. Read-only
  6774. parameters cannot be overridden in this loop.
  6775. </para>
  6776. </remarks>
  6777. <example>
  6778. <para>Loops over the files in <c>c:\</c>.</para>
  6779. <code>
  6780. <![CDATA[
  6781. <foreach item="File" in="c:\" property="filename">
  6782. <echo message="${filename}" />
  6783. </foreach>
  6784. ]]>
  6785. </code>
  6786. </example>
  6787. <example>
  6788. <para>Loops over all files in the project directory.</para>
  6789. <code>
  6790. <![CDATA[
  6791. <foreach item="File" property="filename">
  6792. <in>
  6793. <items>
  6794. <include name="**" />
  6795. </items>
  6796. </in>
  6797. <do>
  6798. <echo message="${filename}" />
  6799. </do>
  6800. </foreach>
  6801. ]]>
  6802. </code>
  6803. </example>
  6804. <example>
  6805. <para>Loops over the folders in <c>c:\</c>.</para>
  6806. <code>
  6807. <![CDATA[
  6808. <foreach item="Folder" in="c:\" property="foldername">
  6809. <echo message="${foldername}" />
  6810. </foreach>
  6811. ]]>
  6812. </code>
  6813. </example>
  6814. <example>
  6815. <para>Loops over all folders in the project directory.</para>
  6816. <code>
  6817. <![CDATA[
  6818. <foreach item="Folder" property="foldername">
  6819. <in>
  6820. <items>
  6821. <include name="**" />
  6822. </items>
  6823. </in>
  6824. <do>
  6825. <echo message="${foldername}" />
  6826. </do>
  6827. </foreach>
  6828. ]]>
  6829. </code>
  6830. </example>
  6831. <example>
  6832. <para>Loops over a list.</para>
  6833. <code>
  6834. <![CDATA[
  6835. <foreach item="String" in="1 2,3" delim=" ," property="count">
  6836. <echo message="${count}" />
  6837. </foreach>
  6838. ]]>
  6839. </code>
  6840. </example>
  6841. <example>
  6842. <para>
  6843. Loops over lines in the file <c>properties.csv</c>, where each line
  6844. is of the format name,value.
  6845. </para>
  6846. <code>
  6847. <![CDATA[
  6848. <foreach item="Line" in="properties.csv" delim="," property="x,y">
  6849. <echo message="Read pair ${x}=${y}" />
  6850. </foreach>
  6851. ]]>
  6852. </code>
  6853. </example>
  6854. </member>
  6855. <member name="P:NAnt.Core.Tasks.LoopTask.Property">
  6856. <summary>
  6857. The NAnt property name(s) that should be used for the current
  6858. iterated item.
  6859. </summary>
  6860. <remarks>
  6861. If specifying multiple properties, separate them with a comma.
  6862. </remarks>
  6863. </member>
  6864. <member name="P:NAnt.Core.Tasks.LoopTask.ItemType">
  6865. <summary>
  6866. The type of iteration that should be done.
  6867. </summary>
  6868. </member>
  6869. <member name="P:NAnt.Core.Tasks.LoopTask.TrimType">
  6870. <summary>
  6871. The type of whitespace trimming that should be done. The default
  6872. is <see cref="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None"/>.
  6873. </summary>
  6874. </member>
  6875. <member name="P:NAnt.Core.Tasks.LoopTask.Source">
  6876. <summary>
  6877. The source of the iteration.
  6878. </summary>
  6879. </member>
  6880. <member name="P:NAnt.Core.Tasks.LoopTask.Delimiter">
  6881. <summary>
  6882. The deliminator char.
  6883. </summary>
  6884. </member>
  6885. <member name="P:NAnt.Core.Tasks.LoopTask.InElement">
  6886. <summary>
  6887. Stuff to operate in. Just like the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/>
  6888. attribute, but supports more complicated things like a <see cref="T:NAnt.Core.Types.FileSet"/>
  6889. and such.
  6890. <note>
  6891. Please remove the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/> attribute if you
  6892. are using this element.
  6893. </note>
  6894. </summary>
  6895. </member>
  6896. <member name="P:NAnt.Core.Tasks.LoopTask.StuffToDo">
  6897. <summary>
  6898. Tasks to execute for each matching item.
  6899. </summary>
  6900. </member>
  6901. <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None">
  6902. <summary>
  6903. Do not remove any white space characters.
  6904. </summary>
  6905. </member>
  6906. <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.End">
  6907. <summary>
  6908. Remove all white space characters from the end of the current
  6909. item.
  6910. </summary>
  6911. </member>
  6912. <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Start">
  6913. <summary>
  6914. Remove all white space characters from the beginning of the
  6915. current item.
  6916. </summary>
  6917. </member>
  6918. <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Both">
  6919. <summary>
  6920. Remove all white space characters from the beginning and end of
  6921. the current item.
  6922. </summary>
  6923. </member>
  6924. <member name="T:NAnt.Core.Tasks.MailTask">
  6925. <summary>
  6926. Sends an SMTP message.
  6927. </summary>
  6928. <remarks>
  6929. <para>
  6930. Text and text files to include in the message body may be specified as
  6931. well as binary attachments.
  6932. </para>
  6933. </remarks>
  6934. <example>
  6935. <para>
  6936. Sends an email from <c>nant@sourceforge.net</c> to three recipients
  6937. with a subject about the attachments. The body of the message will be
  6938. the combined contents of all <c>.txt</c> files in the base directory.
  6939. All zip files in the base directory will be included as attachments.
  6940. The message will be sent using the <c>smtpserver.anywhere.com</c> SMTP
  6941. server.
  6942. </para>
  6943. <code>
  6944. <![CDATA[
  6945. <mail
  6946. from="nant@sourceforge.net"
  6947. tolist="recipient1@sourceforge.net"
  6948. cclist="recipient2@sourceforge.net"
  6949. bcclist="recipient3@sourceforge.net"
  6950. subject="Msg 7: With attachments"
  6951. mailhost="smtpserver.anywhere.com">
  6952. <files>
  6953. <include name="*.txt" />
  6954. </files>
  6955. <attachments>
  6956. <include name="*.zip" />
  6957. </attachments>
  6958. </mail>
  6959. ]]>
  6960. </code>
  6961. </example>
  6962. </member>
  6963. <member name="M:NAnt.Core.Tasks.MailTask.Initialize">
  6964. <summary>
  6965. Initializes task and ensures the supplied attributes are valid.
  6966. </summary>
  6967. </member>
  6968. <member name="M:NAnt.Core.Tasks.MailTask.ExecuteTask">
  6969. <summary>
  6970. This is where the work is done.
  6971. </summary>
  6972. </member>
  6973. <member name="M:NAnt.Core.Tasks.MailTask.ReadFile(System.String)">
  6974. <summary>
  6975. Reads a text file and returns the content
  6976. in a string.
  6977. </summary>
  6978. <param name="filename">The file to read content of.</param>
  6979. <returns>
  6980. The content of the specified file.
  6981. </returns>
  6982. </member>
  6983. <member name="P:NAnt.Core.Tasks.MailTask.From">
  6984. <summary>
  6985. Email address of sender.
  6986. </summary>
  6987. </member>
  6988. <member name="P:NAnt.Core.Tasks.MailTask.ToList">
  6989. <summary>
  6990. Semicolon-separated list of recipient email addresses.
  6991. </summary>
  6992. </member>
  6993. <member name="P:NAnt.Core.Tasks.MailTask.CcList">
  6994. <summary>
  6995. Semicolon-separated list of CC: recipient email addresses.
  6996. </summary>
  6997. </member>
  6998. <member name="P:NAnt.Core.Tasks.MailTask.BccList">
  6999. <summary>
  7000. Semicolon-separated list of BCC: recipient email addresses.
  7001. </summary>
  7002. </member>
  7003. <member name="P:NAnt.Core.Tasks.MailTask.Mailhost">
  7004. <summary>
  7005. Host name of mail server. The default is <c>localhost</c>.
  7006. </summary>
  7007. </member>
  7008. <member name="P:NAnt.Core.Tasks.MailTask.Message">
  7009. <summary>
  7010. Text to send in body of email message.
  7011. </summary>
  7012. </member>
  7013. <member name="P:NAnt.Core.Tasks.MailTask.Subject">
  7014. <summary>
  7015. Text to send in subject line of email message.
  7016. </summary>
  7017. </member>
  7018. <member name="P:NAnt.Core.Tasks.MailTask.Format">
  7019. <summary>
  7020. Format of the message. The default is <see cref="F:System.Web.Mail.MailFormat.Text"/>.
  7021. </summary>
  7022. </member>
  7023. <member name="P:NAnt.Core.Tasks.MailTask.Files">
  7024. <summary>
  7025. Files that are transmitted as part of the body of the email message.
  7026. </summary>
  7027. </member>
  7028. <member name="P:NAnt.Core.Tasks.MailTask.Attachments">
  7029. <summary>
  7030. Attachments that are transmitted with the message.
  7031. </summary>
  7032. </member>
  7033. <member name="T:NAnt.Core.Tasks.MkDirTask">
  7034. <summary>
  7035. Creates a directory and any non-existent parent directory if necessary.
  7036. </summary>
  7037. <example>
  7038. <para>Create the directory <c>build</c>.</para>
  7039. <code>
  7040. <![CDATA[
  7041. <mkdir dir="build" />
  7042. ]]>
  7043. </code>
  7044. </example>
  7045. <example>
  7046. <para>Create the directory tree <c>one/two/three</c>.</para>
  7047. <code>
  7048. <![CDATA[
  7049. <mkdir dir="one/two/three" />
  7050. ]]>
  7051. </code>
  7052. </example>
  7053. </member>
  7054. <member name="M:NAnt.Core.Tasks.MkDirTask.ExecuteTask">
  7055. <summary>
  7056. Creates the directory specified by the <see cref="P:NAnt.Core.Tasks.MkDirTask.Dir"/> property.
  7057. </summary>
  7058. <exception cref="T:NAnt.Core.BuildException">The directory could not be created.</exception>
  7059. </member>
  7060. <member name="P:NAnt.Core.Tasks.MkDirTask.Dir">
  7061. <summary>
  7062. The directory to create.
  7063. </summary>
  7064. </member>
  7065. <member name="T:NAnt.Core.Tasks.MoveTask">
  7066. <summary>
  7067. Moves a file or set of files to a new file or directory.
  7068. </summary>
  7069. <remarks>
  7070. <para>
  7071. Files are only moved if the source file is newer than the destination
  7072. file, or if the destination file does not exist. However, you can
  7073. explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/>
  7074. attribute.
  7075. </para>
  7076. <para>
  7077. A <see cref="T:NAnt.Core.Types.FileSet"/> can be used to select files to move. To use
  7078. a <see cref="T:NAnt.Core.Types.FileSet"/>, the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/>
  7079. attribute must be set.
  7080. </para>
  7081. <h3>Encoding</h3>
  7082. <para>
  7083. Unless an encoding is specified, the encoding associated with the
  7084. system's current ANSI code page is used.
  7085. </para>
  7086. <para>
  7087. An UTF-8, little-endian Unicode, and big-endian Unicode encoded text
  7088. file is automatically recognized, if the file starts with the
  7089. appropriate byte order marks.
  7090. </para>
  7091. <note>
  7092. If you employ filters in your move operation, you should limit the
  7093. move to text files. Binary files will be corrupted by the move
  7094. operation.
  7095. </note>
  7096. </remarks>
  7097. <example>
  7098. <para>
  7099. Move a single file while changing its encoding from "latin1" to
  7100. "utf-8".
  7101. </para>
  7102. <code>
  7103. <![CDATA[
  7104. <move
  7105. file="myfile.txt"
  7106. tofile="mycopy.txt"
  7107. inputencoding="latin1"
  7108. outputencoding="utf-8" />
  7109. ]]>
  7110. </code>
  7111. </example>
  7112. <example>
  7113. <para>Move a set of files.</para>
  7114. <code>
  7115. <![CDATA[
  7116. <move todir="${build.dir}">
  7117. <fileset basedir="bin">
  7118. <include name="*.dll" />
  7119. </fileset>
  7120. </move>
  7121. ]]>
  7122. </code>
  7123. </example>
  7124. <example>
  7125. <para>
  7126. Move a set of files to a directory, replacing <c>@TITLE@</c> with
  7127. "Foo Bar" in all files.
  7128. </para>
  7129. <code>
  7130. <![CDATA[
  7131. <move todir="../backup/dir">
  7132. <fileset basedir="src_dir">
  7133. <include name="**/*" />
  7134. </fileset>
  7135. <filterchain>
  7136. <replacetokens>
  7137. <token key="TITLE" value="Foo Bar" />
  7138. </replacetokens>
  7139. </filterchain>
  7140. </move>
  7141. ]]>
  7142. </code>
  7143. </example>
  7144. </member>
  7145. <member name="M:NAnt.Core.Tasks.MoveTask.DoFileOperations">
  7146. <summary>
  7147. Actually does the file moves.
  7148. </summary>
  7149. </member>
  7150. <member name="P:NAnt.Core.Tasks.MoveTask.SourceFile">
  7151. <summary>
  7152. The file to move.
  7153. </summary>
  7154. </member>
  7155. <member name="P:NAnt.Core.Tasks.MoveTask.ToFile">
  7156. <summary>
  7157. The file to move to.
  7158. </summary>
  7159. </member>
  7160. <member name="P:NAnt.Core.Tasks.MoveTask.ToDirectory">
  7161. <summary>
  7162. The directory to move to.
  7163. </summary>
  7164. </member>
  7165. <member name="P:NAnt.Core.Tasks.MoveTask.CopyFileSet">
  7166. <summary>
  7167. Used to select the files to move. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
  7168. the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/> attribute must be set.
  7169. </summary>
  7170. </member>
  7171. <member name="P:NAnt.Core.Tasks.MoveTask.Flatten">
  7172. <summary>
  7173. Ignore directory structure of source directory, move all files into
  7174. a single directory, specified by the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/>
  7175. attribute. The default is <see langword="false"/>.
  7176. </summary>
  7177. </member>
  7178. <member name="P:NAnt.Core.Tasks.MoveTask.Filters">
  7179. <summary>
  7180. Chain of filters used to alter the file's content as it is moved.
  7181. </summary>
  7182. </member>
  7183. <member name="T:NAnt.Core.Tasks.NAntSchemaTask">
  7184. <summary>
  7185. Creates an XSD File for all available tasks.
  7186. </summary>
  7187. <remarks>
  7188. <para>
  7189. This can be used in conjuntion with the command-line option to do XSD
  7190. Schema validation on the build file.
  7191. </para>
  7192. </remarks>
  7193. <example>
  7194. <para>Creates a <c>NAnt.xsd</c> file in the current project directory.</para>
  7195. <code>
  7196. <![CDATA[
  7197. <nantschema output="NAnt.xsd" />
  7198. ]]>
  7199. </code>
  7200. </example>
  7201. </member>
  7202. <member name="M:NAnt.Core.Tasks.NAntSchemaTask.WriteSchema(System.IO.Stream,System.Type[],System.Type[],System.String)">
  7203. <summary>
  7204. Creates a NAnt Schema for given types
  7205. </summary>
  7206. <param name="stream">The output stream to save the schema to. If <see langword="null" />, writing is ignored, no exception generated.</param>
  7207. <param name="tasks">The list of tasks to generate XML Schema for.</param>
  7208. <param name="dataTypes">The list of datatypes to generate XML Schema for.</param>
  7209. <param name="targetNS">The target namespace to output.</param>
  7210. <returns>The new NAnt Schema.</returns>
  7211. </member>
  7212. <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdAttribute(System.String,System.Boolean)">
  7213. <summary>
  7214. Creates a new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.
  7215. </summary>
  7216. <param name="name">The name of the attribute.</param>
  7217. <param name="required">Value indicating whether the attribute should be required.</param>
  7218. <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.</returns>
  7219. </member>
  7220. <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdSequence(System.Decimal,System.Decimal)">
  7221. <summary>
  7222. Creates a new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.
  7223. </summary>
  7224. <param name="min">The minimum value to allow for this choice</param>
  7225. <param name="max">The maximum value to allow, Decimal.MaxValue sets it to 'unbound'</param>
  7226. <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.</returns>
  7227. </member>
  7228. <member name="P:NAnt.Core.Tasks.NAntSchemaTask.OutputFile">
  7229. <summary>
  7230. The name of the output file to which the XSD should be written.
  7231. </summary>
  7232. </member>
  7233. <member name="P:NAnt.Core.Tasks.NAntSchemaTask.TargetNamespace">
  7234. <summary>
  7235. The target namespace for the output. Defaults to "http://tempuri.org/nant-donotuse.xsd"
  7236. </summary>
  7237. </member>
  7238. <member name="P:NAnt.Core.Tasks.NAntSchemaTask.ForType">
  7239. <summary>
  7240. The <see cref="T:System.Type"/> for which an XSD should be created. If not
  7241. specified, an XSD will be created for all available tasks.
  7242. </summary>
  7243. </member>
  7244. <member name="M:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator.#ctor(System.Type[],System.Type[],System.String)">
  7245. <summary>
  7246. Creates a new instance of the <see cref="T:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator"/>
  7247. class.
  7248. </summary>
  7249. <param name="tasks">Tasks for which a schema should be generated.</param>
  7250. <param name="dataTypes">Data Types for which a schema should be generated.</param>
  7251. <param name="targetNS">The namespace to use.
  7252. <example> http://tempuri.org/nant.xsd </example>
  7253. </param>
  7254. </member>
  7255. <member name="T:NAnt.Core.Tasks.NAntTask">
  7256. <summary>
  7257. Runs NAnt on a supplied build file, or a set of build files.
  7258. </summary>
  7259. <remarks>
  7260. <para>
  7261. By default, all the properties of the current project will be available
  7262. in the new project. Alternatively, you can set <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>
  7263. to <see langword="false"/> to not copy any properties to the new
  7264. project.
  7265. </para>
  7266. <para>
  7267. You can also set properties in the new project from the old project by
  7268. using nested property tags. These properties are always passed to the
  7269. new project regardless of the setting of <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>.
  7270. This allows you to parameterize your subprojects.
  7271. </para>
  7272. <para>
  7273. References to data types can also be passed to the new project, but by
  7274. default they are not. If you set the <see cref="P:NAnt.Core.Tasks.NAntTask.InheritRefs"/> to
  7275. <see langword="true"/>, all references will be copied.
  7276. </para>
  7277. </remarks>
  7278. <example>
  7279. <para>
  7280. Build a project located in a different directory if the <c>debug</c>
  7281. property is not <see langword="true"/>.
  7282. </para>
  7283. <code>
  7284. <![CDATA[
  7285. <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build" unless="${debug}" />
  7286. ]]>
  7287. </code>
  7288. </example>
  7289. <example>
  7290. <para>
  7291. Build a project while adding a set of properties to that project.
  7292. </para>
  7293. <code>
  7294. <![CDATA[
  7295. <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build">
  7296. <properties>
  7297. <property name="build.dir" value="c:/buildserver" />
  7298. <property name="build.debug" value="false" />
  7299. <property name="lib.dir" value="c:/shared/lib" readonly="true" />
  7300. </properties>
  7301. </nant>
  7302. ]]>
  7303. </code>
  7304. </example>
  7305. <example>
  7306. <para>
  7307. Build all projects named <c>default.build</c> located anywhere under
  7308. the project base directory.
  7309. </para>
  7310. <code>
  7311. <![CDATA[
  7312. <nant>
  7313. <buildfiles>
  7314. <include name="**/default.build" />
  7315. <!-- avoid recursive execution of current build file -->
  7316. <exclude name="${project::get-buildfile-path()}" />
  7317. </buildfiles>
  7318. </nant>
  7319. ]]>
  7320. </code>
  7321. </example>
  7322. </member>
  7323. <member name="M:NAnt.Core.Tasks.NAntTask.Initialize">
  7324. <summary>
  7325. Validates the <see cref="T:NAnt.Core.Tasks.NAntTask"/> element.
  7326. </summary>
  7327. </member>
  7328. <member name="P:NAnt.Core.Tasks.NAntTask.BuildFile">
  7329. <summary>
  7330. The build file to build.
  7331. </summary>
  7332. </member>
  7333. <member name="P:NAnt.Core.Tasks.NAntTask.DefaultTarget">
  7334. <summary>
  7335. The target to execute. To specify more than one target seperate
  7336. targets with a space. Targets are executed in order if possible.
  7337. The default is to use target specified in the project's default
  7338. attribute.
  7339. </summary>
  7340. </member>
  7341. <member name="P:NAnt.Core.Tasks.NAntTask.BuildFiles">
  7342. <summary>
  7343. Used to specify a set of build files to process.
  7344. </summary>
  7345. </member>
  7346. <member name="P:NAnt.Core.Tasks.NAntTask.InheritAll">
  7347. <summary>
  7348. Specifies whether current property values should be inherited by
  7349. the executed project. The default is <see langword="true" />.
  7350. </summary>
  7351. </member>
  7352. <member name="P:NAnt.Core.Tasks.NAntTask.InheritRefs">
  7353. <summary>
  7354. Specifies whether all references will be copied to the new project.
  7355. The default is <see langword="false" />.
  7356. </summary>
  7357. </member>
  7358. <member name="P:NAnt.Core.Tasks.NAntTask.OverrideProperties">
  7359. <summary>
  7360. Specifies a collection of properties that should be created in the
  7361. executed project. Note, existing properties with identical names
  7362. that are not read-only will be overwritten.
  7363. </summary>
  7364. </member>
  7365. <member name="T:NAnt.Core.Tasks.PropertyTask">
  7366. <summary>
  7367. Sets a property in the current project.
  7368. </summary>
  7369. <remarks>
  7370. <note>NAnt uses a number of predefined properties.</note>
  7371. </remarks>
  7372. <example>
  7373. <para>
  7374. Define a <c>debug</c> property with value <see langword="true" />.
  7375. </para>
  7376. <code>
  7377. <![CDATA[
  7378. <property name="debug" value="true" />
  7379. ]]>
  7380. </code>
  7381. </example>
  7382. <example>
  7383. <para>
  7384. Use the user-defined <c>debug</c> property.
  7385. </para>
  7386. <code>
  7387. <![CDATA[
  7388. <property name="trace" value="${debug}" />
  7389. ]]>
  7390. </code>
  7391. </example>
  7392. <example>
  7393. <para>
  7394. Define a read-only property. This is just like passing in the param
  7395. on the command line.
  7396. </para>
  7397. <code>
  7398. <![CDATA[
  7399. <property name="do_not_touch_ME" value="hammer" readonly="true" />
  7400. ]]>
  7401. </code>
  7402. </example>
  7403. <example>
  7404. <para>
  7405. Define a property, but do not overwrite the value if the property already exists (eg. it was specified on the command line).
  7406. </para>
  7407. <code>
  7408. <![CDATA[
  7409. <project name="property-example">
  7410. <property name="debug" value="true" overwrite="false" />
  7411. <echo message="debug: ${debug}" />
  7412. </project>
  7413. ]]>
  7414. </code>
  7415. <para>
  7416. Executing this build file with the command line option <c>-D:debug=false</c>,
  7417. would cause the value specified on the command line to remain unaltered.
  7418. </para>
  7419. <code>
  7420. <![CDATA[
  7421. [echo] debug: false
  7422. ]]>
  7423. </code>
  7424. </example>
  7425. </member>
  7426. <member name="P:NAnt.Core.Tasks.PropertyTask.PropertyName">
  7427. <summary>
  7428. The name of the NAnt property to set.
  7429. </summary>
  7430. </member>
  7431. <member name="P:NAnt.Core.Tasks.PropertyTask.Value">
  7432. <summary>
  7433. The value to assign to the NAnt property.
  7434. </summary>
  7435. </member>
  7436. <member name="P:NAnt.Core.Tasks.PropertyTask.ReadOnly">
  7437. <summary>
  7438. Specifies whether the property is read-only or not.
  7439. The default is <see langword="false" />.
  7440. </summary>
  7441. </member>
  7442. <member name="P:NAnt.Core.Tasks.PropertyTask.Dynamic">
  7443. <summary>
  7444. Specifies whether references to other properties should not be
  7445. expanded when the value of the property is set, but expanded when
  7446. the property is actually used. By default, properties will be
  7447. expanded when set.
  7448. </summary>
  7449. </member>
  7450. <member name="P:NAnt.Core.Tasks.PropertyTask.Overwrite">
  7451. <summary>
  7452. Specifies whether the value of a property should be overwritten if
  7453. the property already exists (unless the property is read-only).
  7454. The default is <see langword="true" />.
  7455. </summary>
  7456. </member>
  7457. <member name="T:NAnt.Core.Tasks.RegexTask">
  7458. <summary>
  7459. Sets project properties based on the evaluatuion of a regular expression.
  7460. </summary>
  7461. <remarks>
  7462. <para>
  7463. The <see cref="P:NAnt.Core.Tasks.RegexTask.Pattern"/> attribute must contain one or more
  7464. <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpcongroupingconstructs.asp">
  7465. named grouping constructs</see>, which represents the names of the
  7466. properties to be set. These named grouping constructs can be enclosed
  7467. by angle brackets (?&lt;name&gt;) or single quotes (?'name').
  7468. </para>
  7469. <note>
  7470. In the build file, use the XML element <![CDATA[&lt;]]> to specify &lt;,
  7471. and <![CDATA[&gt;]]> to specify &gt;.
  7472. </note>
  7473. <note>
  7474. The named grouping construct must not contain any punctuation and it
  7475. cannot begin with a number.
  7476. </note>
  7477. </remarks>
  7478. <example>
  7479. <para>
  7480. Find the last word in the given string and stores it in the property
  7481. <c>lastword</c>.
  7482. </para>
  7483. <code>
  7484. <![CDATA[
  7485. <regex pattern="(?'lastword'\w+)$" input="This is a test sentence" />
  7486. <echo message="${lastword}" />
  7487. ]]>
  7488. </code>
  7489. </example>
  7490. <example>
  7491. <para>
  7492. Split the full filename and extension of a filename.
  7493. </para>
  7494. <code>
  7495. <![CDATA[
  7496. <regex pattern="^(?'filename'.*)\.(?'extension'\w+)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" />
  7497. ]]>
  7498. </code>
  7499. </example>
  7500. <example>
  7501. <para>
  7502. Split the path and the filename. (This checks for <c>/</c> or <c>\</c>
  7503. as the path separator).
  7504. </para>
  7505. <code>
  7506. <![CDATA[
  7507. <regex pattern="^(?'path'.*(\\|/)|(/|\\))(?'file'.*)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" />
  7508. ]]>
  7509. </code>
  7510. <para>
  7511. Results in path=<c>d:\Temp\SomeDir\SomeDir\</c> and file=<c>bla.xml</c>.
  7512. </para>
  7513. </example>
  7514. </member>
  7515. <member name="M:NAnt.Core.Tasks.RegexTask.ExecuteTask">
  7516. <summary>
  7517. Executes the task.
  7518. </summary>
  7519. </member>
  7520. <member name="P:NAnt.Core.Tasks.RegexTask.Pattern">
  7521. <summary>
  7522. Represents the regular expression to be evalued.
  7523. </summary>
  7524. <value>
  7525. The regular expression to be evalued.
  7526. </value>
  7527. <remarks>
  7528. The pattern must contain one or more named constructs, which may
  7529. not contain any punctuation and cannot begin with a number.
  7530. </remarks>
  7531. </member>
  7532. <member name="P:NAnt.Core.Tasks.RegexTask.Options">
  7533. <summary>
  7534. A comma separated list of options to pass to the regex engine. The
  7535. default is <see cref="F:System.Text.RegularExpressions.RegexOptions.None"/>.
  7536. </summary>
  7537. </member>
  7538. <member name="P:NAnt.Core.Tasks.RegexTask.Input">
  7539. <summary>
  7540. Represents the input for the regular expression.
  7541. </summary>
  7542. <value>
  7543. The input for the regular expression.
  7544. </value>
  7545. </member>
  7546. <member name="T:NAnt.Core.Tasks.SetEnvTask">
  7547. <summary>
  7548. Sets an environment variable or a whole collection of them. Use an empty
  7549. <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute to clear a variable.
  7550. </summary>
  7551. <remarks>
  7552. <note>
  7553. Variables will be set for the current NAnt process and all child
  7554. processes that NAnt spawns (compilers, shell tools, etc). If the
  7555. intention is to only set a variable for a single child process, then
  7556. using the <see cref="T:NAnt.Core.Tasks.ExecTask"/> and its nested <see cref="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet"/>
  7557. element might be a better option.
  7558. </note>
  7559. <note>
  7560. Expansion of inline environment variables is performed using the syntax
  7561. of the current platform. So on Windows platforms using the string %PATH%
  7562. in the <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute will result in the value of
  7563. the PATH variable being expanded in place before the variable is set.
  7564. </note>
  7565. </remarks>
  7566. <example>
  7567. <para>Set the MONO_PATH environment variable on a *nix platform.</para>
  7568. <code>
  7569. <![CDATA[
  7570. <setenv name=="MONO_PATH" value="/home/jimbob/dev/foo:%MONO_PATH%"/>
  7571. ]]>
  7572. </code>
  7573. </example>
  7574. <example>
  7575. <para>Set a collection of environment variables. Note the nested variable used to set var3.</para>
  7576. <code>
  7577. <![CDATA[
  7578. <setenv>
  7579. <variable name="var1" value="value2" />
  7580. <variable name="var2" value="value2" />
  7581. <variable name="var3" value="value3:%var2%" />
  7582. </setenv>
  7583. ]]>
  7584. </code>
  7585. </example>
  7586. <example>
  7587. <para>Set environment variables using nested path elements.</para>
  7588. <code>
  7589. <![CDATA[
  7590. <path id="build.path">
  7591. <pathelement dir="c:/windows" />
  7592. <pathelement dir="c:/cygwin/usr/local/bin" />
  7593. </path>
  7594. <setenv>
  7595. <variable name="build_path" >
  7596. <path refid="build.path" />
  7597. </variable>
  7598. <variable name="path2">
  7599. <path>
  7600. <pathelement dir="c:/windows" />
  7601. <pathelement dir="c:/cygwin/usr/local/bin" />
  7602. </path>
  7603. </variable>
  7604. </setenv>
  7605. ]]>
  7606. </code>
  7607. </example>
  7608. </member>
  7609. <member name="M:NAnt.Core.Tasks.SetEnvTask.SetEnvironmentVariable(System.String,System.String)">
  7610. <summary>
  7611. Win32 DllImport for the SetEnvironmentVariable function.
  7612. </summary>
  7613. <param name="lpName"></param>
  7614. <param name="lpValue"></param>
  7615. <returns></returns>
  7616. </member>
  7617. <member name="M:NAnt.Core.Tasks.SetEnvTask.setenv(System.String,System.String,System.Int32)">
  7618. <summary>
  7619. *nix dllimport for the setenv function.
  7620. </summary>
  7621. <param name="name"></param>
  7622. <param name="value"></param>
  7623. <param name="overwrite"></param>
  7624. <returns>
  7625. <c>0</c> if the execution is successful; otherwise, <c>-1</c>.
  7626. </returns>
  7627. </member>
  7628. <member name="M:NAnt.Core.Tasks.SetEnvTask.unsetenv(System.String)">
  7629. <summary>
  7630. Deletes all instances of the variable name.
  7631. </summary>
  7632. <param name="name">The variable to unset.</param>
  7633. <returns>
  7634. <c>0</c> if the execution is successful; otherwise, <c>-1</c>.
  7635. </returns>
  7636. </member>
  7637. <member name="M:NAnt.Core.Tasks.SetEnvTask.Initialize">
  7638. <summary>
  7639. Checks whether the task is initialized with valid attributes.
  7640. </summary>
  7641. </member>
  7642. <member name="M:NAnt.Core.Tasks.SetEnvTask.ExecuteTask">
  7643. <summary>
  7644. Set the environment variables
  7645. </summary>
  7646. </member>
  7647. <member name="M:NAnt.Core.Tasks.SetEnvTask.SetSingleEnvironmentVariable(System.String,System.String)">
  7648. <summary>
  7649. Do the actual work here.
  7650. </summary>
  7651. <param name="name">The name of the environment variable.</param>
  7652. <param name="value">The value of the environment variable.</param>
  7653. </member>
  7654. <member name="P:NAnt.Core.Tasks.SetEnvTask.EnvName">
  7655. <summary>
  7656. The name of a single Environment variable to set
  7657. </summary>
  7658. </member>
  7659. <member name="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue">
  7660. <summary>
  7661. The literal value for the environment variable.
  7662. </summary>
  7663. </member>
  7664. <member name="P:NAnt.Core.Tasks.SetEnvTask.File">
  7665. <summary>
  7666. The value for a file-based environment variable. NAnt will convert
  7667. it to an absolute filename.
  7668. </summary>
  7669. </member>
  7670. <member name="P:NAnt.Core.Tasks.SetEnvTask.Directory">
  7671. <summary>
  7672. The value for a directory-based environment variable. NAnt will
  7673. convert it to an absolute path.
  7674. </summary>
  7675. </member>
  7676. <member name="P:NAnt.Core.Tasks.SetEnvTask.Path">
  7677. <summary>
  7678. The value for a PATH like environment variable. You can use
  7679. <c>:</c> or <c>;</c> as path separators and NAnt will convert it to
  7680. the platform's local conventions.
  7681. </summary>
  7682. </member>
  7683. <member name="T:NAnt.Core.Tasks.SleepTask">
  7684. <summary>
  7685. A task for sleeping a specified period of time, useful when a build or deployment process
  7686. requires an interval between tasks.
  7687. </summary>
  7688. <example>
  7689. <para>Sleep 1 hour, 2 minutes, 3 seconds and 4 milliseconds.</para>
  7690. <code>
  7691. <![CDATA[
  7692. <sleep hours="1" minutes="2" seconds="3" milliseconds="4" />
  7693. ]]>
  7694. </code>
  7695. </example>
  7696. <example>
  7697. <para>Sleep 123 milliseconds.</para>
  7698. <code>
  7699. <![CDATA[
  7700. <sleep milliseconds="123" />
  7701. ]]>
  7702. </code>
  7703. </example>
  7704. </member>
  7705. <member name="M:NAnt.Core.Tasks.SleepTask.Initialize">
  7706. <summary>
  7707. Verify parameters.
  7708. </summary>
  7709. </member>
  7710. <member name="M:NAnt.Core.Tasks.SleepTask.GetSleepTime">
  7711. <summary>
  7712. Return time to sleep.
  7713. </summary>
  7714. </member>
  7715. <member name="M:NAnt.Core.Tasks.SleepTask.DoSleep(System.Int32)">
  7716. <summary>
  7717. Sleeps for the specified number of milliseconds.
  7718. </summary>
  7719. <param name="millis">Number of milliseconds to sleep.</param>
  7720. </member>
  7721. <member name="P:NAnt.Core.Tasks.SleepTask.Hours">
  7722. <summary>
  7723. Hours to add to the sleep time.
  7724. </summary>
  7725. </member>
  7726. <member name="P:NAnt.Core.Tasks.SleepTask.Minutes">
  7727. <summary>
  7728. Minutes to add to the sleep time.
  7729. </summary>
  7730. </member>
  7731. <member name="P:NAnt.Core.Tasks.SleepTask.Seconds">
  7732. <summary>
  7733. Seconds to add to the sleep time.
  7734. </summary>
  7735. </member>
  7736. <member name="P:NAnt.Core.Tasks.SleepTask.Milliseconds">
  7737. <summary>
  7738. Milliseconds to add to the sleep time.
  7739. </summary>
  7740. </member>
  7741. <member name="T:NAnt.Core.Tasks.StyleTask">
  7742. <summary>
  7743. Processes a document via XSLT.
  7744. </summary>
  7745. <example>
  7746. <para>Create a report in HTML.</para>
  7747. <code>
  7748. <![CDATA[
  7749. <style style="report.xsl" in="data.xml" out="report.html" />
  7750. ]]>
  7751. </code>
  7752. </example>
  7753. <example>
  7754. <para>Create a report in HTML, with a param.</para>
  7755. <code>
  7756. <![CDATA[
  7757. <style style="report.xsl" in="data.xml" out="report.html">
  7758. <parameters>
  7759. <parameter name="reportType" namespaceuri="" value="Plain" />
  7760. </parameters>
  7761. </style>
  7762. ]]>
  7763. </code>
  7764. </example>
  7765. <example>
  7766. <para>Create a report in HTML, with a expanded param.</para>
  7767. <code>
  7768. <![CDATA[
  7769. <style style="report.xsl" in="data.xml" out="report.html">
  7770. <parameters>
  7771. <parameter name="reportType" namespaceuri="" value="${report.type}" />
  7772. </parameters>
  7773. </style>
  7774. ]]>
  7775. </code>
  7776. </example>
  7777. <example>
  7778. <para>Create some code based on a directory of templates.</para>
  7779. <code>
  7780. <![CDATA[
  7781. <style style="CodeGenerator.xsl" extension="java">
  7782. <infiles>
  7783. <include name="*.xml" />
  7784. </infiles>
  7785. <parameters>
  7786. <parameter name="reportType" namespaceuri="" value="Plain" if="${report.plain}" />
  7787. </parameters>
  7788. <style>
  7789. ]]>
  7790. </code>
  7791. </example>
  7792. <example>
  7793. <para>Create a report in HTML, with an extension object.</para>
  7794. <code>
  7795. <![CDATA[
  7796. <style style="report.xsl" in="data.xml" out="report.html">
  7797. <extensionobjects>
  7798. <extensionobject namespaceuri="urn:Formatter" typename="XsltExtensionObjects.Formatter" assembly="XsltExtensionObjects.dll" />
  7799. </extensionobjects>
  7800. </style>
  7801. ]]>
  7802. </code>
  7803. </example>
  7804. </member>
  7805. <member name="P:NAnt.Core.Tasks.StyleTask.DestDir">
  7806. <summary>
  7807. Directory in which to store the results. The default is the project
  7808. base directory.
  7809. </summary>
  7810. </member>
  7811. <member name="P:NAnt.Core.Tasks.StyleTask.Extension">
  7812. <summary>
  7813. Desired file extension to be used for the targets. The default is
  7814. <c>html</c>.
  7815. </summary>
  7816. </member>
  7817. <member name="P:NAnt.Core.Tasks.StyleTask.XsltFile">
  7818. <summary>
  7819. URI or path that points to the stylesheet to use. If given as path, it can
  7820. be relative to the project's basedir or absolute.
  7821. </summary>
  7822. </member>
  7823. <member name="P:NAnt.Core.Tasks.StyleTask.SrcFile">
  7824. <summary>
  7825. Specifies a single XML document to be styled. Should be used with
  7826. the <see cref="P:NAnt.Core.Tasks.StyleTask.OutputFile"/> attribute.
  7827. </summary>
  7828. </member>
  7829. <member name="P:NAnt.Core.Tasks.StyleTask.OutputFile">
  7830. <summary>
  7831. Specifies the output name for the styled result from the <see cref="P:NAnt.Core.Tasks.StyleTask.SrcFile"/>
  7832. attribute.
  7833. </summary>
  7834. </member>
  7835. <member name="P:NAnt.Core.Tasks.StyleTask.InFiles">
  7836. <summary>
  7837. Specifies a group of input files to which to apply the stylesheet.
  7838. </summary>
  7839. </member>
  7840. <member name="P:NAnt.Core.Tasks.StyleTask.Parameters">
  7841. <summary>
  7842. XSLT parameters to be passed to the XSLT transformation.
  7843. </summary>
  7844. </member>
  7845. <member name="P:NAnt.Core.Tasks.StyleTask.ExtensionObjects">
  7846. <summary>
  7847. XSLT extension objects to be passed to the XSLT transformation.
  7848. </summary>
  7849. </member>
  7850. <member name="P:NAnt.Core.Tasks.StyleTask.Proxy">
  7851. <summary>
  7852. The network proxy to use to access the Internet resource.
  7853. </summary>
  7854. </member>
  7855. <member name="T:NAnt.Core.Tasks.SysInfoTask">
  7856. <summary>
  7857. Sets properties with system information.
  7858. </summary>
  7859. <remarks>
  7860. <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>
  7861. <list type="table">
  7862. <listheader>
  7863. <term>Property</term>
  7864. <description>Value</description>
  7865. </listheader>
  7866. <item>
  7867. <term>&lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.clr.version</term>
  7868. <description>Common Language Runtime version number.</description>
  7869. </item>
  7870. <item>
  7871. <term>&lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.env.*</term>
  7872. <description>Environment variables (e.g., &lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.env.PATH).</description>
  7873. </item>
  7874. <item>
  7875. <term>&lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.os.platform</term>
  7876. <description>Operating system platform ID.</description>
  7877. </item>
  7878. <item>
  7879. <term>&lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.os.version</term>
  7880. <description>Operating system version.</description>
  7881. </item>
  7882. <item>
  7883. <term>&lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.os</term>
  7884. <description>Operating system version string.</description>
  7885. </item>
  7886. <item>
  7887. <term>&lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.os.folder.applicationdata</term>
  7888. <description>The directory that serves as a common repository for application-specific data for the current roaming user.</description>
  7889. </item>
  7890. <item>
  7891. <term>&lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.os.folder.commonapplicationdata</term>
  7892. <description>The directory that serves as a common repository for application-specific data that is used by all users.</description>
  7893. </item>
  7894. <item>
  7895. <term>&lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.os.folder.commonprogramfiles</term>
  7896. <description>The directory for components that are shared across applications.</description>
  7897. </item>
  7898. <item>
  7899. <term>&lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.os.folder.desktopdirectory</term>
  7900. <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>
  7901. </item>
  7902. <item>
  7903. <term>&lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.os.folder.programfiles</term>
  7904. <description>The Program Files directory.</description>
  7905. </item>
  7906. <item>
  7907. <term>&lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.os.folder.system</term>
  7908. <description>The System directory.</description>
  7909. </item>
  7910. <item>
  7911. <term>&lt;<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>&gt;.os.folder.temp</term>
  7912. <description>The temporary directory.</description>
  7913. </item>
  7914. </list>
  7915. <para>
  7916. When the name of an environment variable is not a valid property name,
  7917. the task will fail. In that case, set <see cref="P:NAnt.Core.Task.FailOnError"/> to
  7918. <see langword="true"/> to allow that environment variable to be
  7919. skipped.
  7920. </para>
  7921. <note>
  7922. we advise you to use the following functions instead:
  7923. </note>
  7924. <list type="table">
  7925. <listheader>
  7926. <term>Function</term>
  7927. <description>Description</description>
  7928. </listheader>
  7929. <item>
  7930. <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/></term>
  7931. <description>Gets a <see cref="T:System.OperatingSystem"/> object that identifies this operating system.</description>
  7932. </item>
  7933. <item>
  7934. <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)"/></term>
  7935. <description>Gets the path to a system special folder.</description>
  7936. </item>
  7937. <item>
  7938. <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)"/></term>
  7939. <description>Returns the value of a environment variable.</description>
  7940. </item>
  7941. <item>
  7942. <term><see cref="M:NAnt.Core.Functions.PathFunctions.GetTempPath"/></term>
  7943. <description>Gets the path to the temporary directory.</description>
  7944. </item>
  7945. <item>
  7946. <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/></term>
  7947. <description>Gets the Common Language Runtime version.</description>
  7948. </item>
  7949. </list>
  7950. </remarks>
  7951. <example>
  7952. <para>Register the properties with the default property prefix.</para>
  7953. <code>
  7954. <![CDATA[
  7955. <sysinfo />
  7956. ]]>
  7957. </code>
  7958. </example>
  7959. <example>
  7960. <para>Register the properties without a prefix.</para>
  7961. <code>
  7962. <![CDATA[
  7963. <sysinfo prefix="" />
  7964. ]]>
  7965. </code>
  7966. </example>
  7967. <example>
  7968. <para>Register properties and display a summary.</para>
  7969. <code>
  7970. <![CDATA[
  7971. <sysinfo verbose="true" />
  7972. ]]>
  7973. </code>
  7974. </example>
  7975. </member>
  7976. <member name="P:NAnt.Core.Tasks.SysInfoTask.Prefix">
  7977. <summary>
  7978. The string to prefix the property names with. The default is "sys.".
  7979. </summary>
  7980. </member>
  7981. <member name="T:NAnt.Core.Tasks.TouchTask">
  7982. <summary>
  7983. Touches a file or set of files -- corresponds to the Unix touch command.
  7984. </summary>
  7985. <remarks>
  7986. <para>
  7987. If the file specified does not exist, the task will create it.
  7988. </para>
  7989. </remarks>
  7990. <example>
  7991. <para>Touch the <c>Main.cs</c> file. The current time is used.</para>
  7992. <code>
  7993. <![CDATA[
  7994. <touch file="Main.cs" />
  7995. ]]>
  7996. </code>
  7997. </example>
  7998. <example>
  7999. <para>
  8000. Touch all executable files in the project base directory and its
  8001. subdirectories.
  8002. </para>
  8003. <code>
  8004. <![CDATA[
  8005. <touch>
  8006. <fileset>
  8007. <include name="**/*.exe" />
  8008. <include name="**/*.dll" />
  8009. </fileset>
  8010. </touch>
  8011. ]]>
  8012. </code>
  8013. </example>
  8014. </member>
  8015. <member name="M:NAnt.Core.Tasks.TouchTask.Initialize">
  8016. <summary>
  8017. Ensures the supplied attributes are valid.
  8018. </summary>
  8019. </member>
  8020. <member name="P:NAnt.Core.Tasks.TouchTask.File">
  8021. <summary>
  8022. The file to touch.
  8023. </summary>
  8024. </member>
  8025. <member name="P:NAnt.Core.Tasks.TouchTask.Millis">
  8026. <summary>
  8027. Specifies the new modification time of the file(s) in milliseconds
  8028. since midnight Jan 1 1970.
  8029. </summary>
  8030. </member>
  8031. <member name="P:NAnt.Core.Tasks.TouchTask.Datetime">
  8032. <summary>
  8033. Specifies the new modification time of the file in the format
  8034. MM/DD/YYYY HH:MM:SS.
  8035. </summary>
  8036. </member>
  8037. <member name="P:NAnt.Core.Tasks.TouchTask.TouchFileSet">
  8038. <summary>
  8039. Used to select files that should be touched.
  8040. </summary>
  8041. </member>
  8042. <member name="T:NAnt.Core.Tasks.TStampTask">
  8043. <summary>
  8044. Sets properties with the current date and time.
  8045. </summary>
  8046. <remarks>
  8047. <para>
  8048. By default the <see cref="T:NAnt.Core.Tasks.TStampTask"/> displays the current date
  8049. and time and sets the following properties:
  8050. </para>
  8051. <list type="bullet">
  8052. <item><description>tstamp.date to yyyyMMdd</description></item>
  8053. <item><description>tstamp.time to HHmm</description></item>
  8054. <item><description>tstamp.now using the default DateTime.ToString() method</description></item>
  8055. </list>
  8056. <para>
  8057. To set an additional property with a custom date/time use the
  8058. <see cref="P:NAnt.Core.Tasks.TStampTask.Property"/> and <see cref="P:NAnt.Core.Tasks.TStampTask.Pattern"/> attributes.
  8059. To set a number of additional properties with the exact same date and
  8060. time use the <see cref="P:NAnt.Core.Tasks.TStampTask.Formatters"/> nested element (see example).
  8061. </para>
  8062. <para>
  8063. The date and time string displayed by the <see cref="T:NAnt.Core.Tasks.TStampTask"/>
  8064. uses the computer's default long date and time string format. You
  8065. might consider setting these to the
  8066. <see href="http://www.cl.cam.ac.uk/~mgk25/iso-time.html">ISO 8601 standard
  8067. for date and time notation</see>.
  8068. </para>
  8069. </remarks>
  8070. <example>
  8071. <para>Set the <c>build.date</c> property.</para>
  8072. <code>
  8073. <![CDATA[
  8074. <tstamp property="build.date" pattern="yyyyMMdd" verbose="true" />
  8075. ]]>
  8076. </code>
  8077. </example>
  8078. <example>
  8079. <para>Set a number of properties for Ant like compatibility.</para>
  8080. <code>
  8081. <![CDATA[
  8082. <tstamp verbose="true">
  8083. <formatter property="TODAY" pattern="dd MMM yyyy"/>
  8084. <formatter property="DSTAMP" pattern="yyyyMMdd" unless="${date.not.needed}" />
  8085. <formatter property="TSTAMP" pattern="HHmm" if="${need.hours}" />
  8086. </tstamp>
  8087. ]]>
  8088. </code>
  8089. </example>
  8090. </member>
  8091. <member name="P:NAnt.Core.Tasks.TStampTask.Property">
  8092. <summary>
  8093. The property to receive the date/time string in the given pattern.
  8094. </summary>
  8095. </member>
  8096. <member name="P:NAnt.Core.Tasks.TStampTask.Pattern">
  8097. <summary>The date/time pattern to be used.</summary>
  8098. <remarks>
  8099. <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>
  8100. <list type="table">
  8101. <listheader>
  8102. <description>Format Character</description>
  8103. <description>Description Example Format Pattern (en-US)</description>
  8104. </listheader>
  8105. <item><description>d</description><description>MM/dd/yyyy</description></item>
  8106. <item><description>D</description><description>dddd, dd MMMM yyyy</description></item>
  8107. <item><description>f</description><description>dddd, dd MMMM yyyy HH:mm</description></item>
  8108. <item><description>F</description><description>dddd, dd MMMM yyyy HH:mm:ss</description></item>
  8109. <item><description>g</description><description>MM/dd/yyyy HH:mm</description></item>
  8110. <item><description>G</description><description>MM/dd/yyyy HH:mm:ss</description></item>
  8111. <item><description>m, M</description><description>MMMM dd</description></item>
  8112. <item><description>r, R</description><description>ddd, dd MMM yyyy HH':'mm':'ss 'GMT'</description></item>
  8113. <item><description>s</description><description>yyyy'-'MM'-'dd'T'HH':'mm':'ss</description></item>
  8114. <item><description>t</description><description>HH:mm</description></item>
  8115. <item><description>T</description><description>HH:mm:ss</description></item>
  8116. <item><description>u</description><description>yyyy'-'MM'-'dd HH':'mm':'ss'Z'</description></item>
  8117. <item><description>U</description><description>dddd, dd MMMM yyyy HH:mm:ss</description></item>
  8118. <item><description>y, Y</description><description>yyyy MMMM</description></item>
  8119. </list>
  8120. <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>
  8121. <list type="table">
  8122. <listheader>
  8123. <description>Format</description>
  8124. <description>Pattern Description</description>
  8125. </listheader>
  8126. <item><description>d</description><description>The day of the month. Single-digit days will not have a leading zero.</description></item>
  8127. <item><description>dd</description><description>The day of the month. Single-digit days will have a leading zero.</description></item>
  8128. <item><description>ddd</description><description>The abbreviated name of the day of the week.</description></item>
  8129. <item><description>dddd</description><description>The full name of the day of the week.</description></item>
  8130. <item><description>M</description><description>The numeric month. Single-digit months will not have a leading zero.</description></item>
  8131. <item><description>MM</description><description>The numeric month. Single-digit months will have a leading zero.</description></item>
  8132. <item><description>MMM</description><description>The abbreviated name of the month.</description></item>
  8133. <item><description>MMMM</description><description>The full name of the month.</description></item>
  8134. <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>
  8135. <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>
  8136. <item><description>yyyy</description><description>The year in four digits, including the century.</description></item>
  8137. <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>
  8138. <item><description>h</description><description>The hour in a 12-hour clock. Single-digit hours will not have a leading zero.</description></item>
  8139. <item><description>hh</description><description>The hour in a 12-hour clock. Single-digit hours will have a leading zero.</description></item>
  8140. <item><description>H</description><description>The hour in a 24-hour clock. Single-digit hours will not have a leading zero.</description></item>
  8141. <item><description>HH</description><description>The hour in a 24-hour clock. Single-digit hours will have a leading zero.</description></item>
  8142. <item><description>m</description><description>The minute. Single-digit minutes will not have a leading zero.</description></item>
  8143. <item><description>mm</description><description>The minute. Single-digit minutes will have a leading zero.</description></item>
  8144. <item><description>s</description><description>The second. Single-digit seconds will not have a leading zero.</description></item>
  8145. <item><description>ss</description><description>The second. Single-digit seconds will have a leading zero.</description></item>
  8146. <item><description>f</description><description>The fraction of a second in single-digit precision. The remaining digits are truncated.</description></item>
  8147. <item><description>ff</description><description>The fraction of a second in double-digit precision. The remaining digits are truncated.</description></item>
  8148. <item><description>fff</description><description>The fraction of a second in three-digit precision. The remaining digits are truncated.</description></item>
  8149. <item><description>ffff</description><description>The fraction of a second in four-digit precision. The remaining digits are truncated.</description></item>
  8150. <item><description>fffff</description><description>The fraction of a second in five-digit precision. The remaining digits are truncated. </description></item>
  8151. <item><description>ffffff</description><description>The fraction of a second in six-digit precision. The remaining digits are truncated. </description></item>
  8152. <item><description>fffffff</description><description>The fraction of a second in seven-digit precision. The remaining digits are truncated. </description></item>
  8153. <item><description>t</description><description>The first character in the AM/PM designator.</description></item>
  8154. <item><description>tt</description><description>The AM/PM designator. </description></item>
  8155. <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>
  8156. <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>
  8157. <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>
  8158. <item><description>:</description><description>The default time separator.</description></item>
  8159. <item><description>/</description><description>The default date separator.</description></item>
  8160. <item><description>\ c</description><description>Pattern Where c is any character. Displays the character literally. To display the backslash character, use "\\". </description></item>
  8161. </list>
  8162. </remarks>
  8163. </member>
  8164. <member name="T:NAnt.Core.Tasks.UpToDateTask">
  8165. <summary>
  8166. Check modification dates on groups of files.
  8167. </summary>
  8168. <remarks>
  8169. 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
  8170. is set to <see langword="false"/>.
  8171. </remarks>
  8172. <example>
  8173. <para>
  8174. 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
  8175. to either <see langword="true"/> or <see langword="false"/>.
  8176. </para>
  8177. <code>
  8178. <![CDATA[
  8179. <uptodate property="myfile.dll.uptodate">
  8180. <sourcefiles>
  8181. <include name="myfile.cs" />
  8182. </sourcefiles>
  8183. <targetfiles>
  8184. <include name="myfile.dll" />
  8185. </targetfiles>
  8186. </uptodate>
  8187. ]]>
  8188. </code>
  8189. </example>
  8190. </member>
  8191. <member name="P:NAnt.Core.Tasks.UpToDateTask.PropertyName">
  8192. <summary>
  8193. Property that will be set to <see langword="true" /> or <see langword="false" /> depending on the
  8194. result of the date check.
  8195. </summary>
  8196. </member>
  8197. <member name="P:NAnt.Core.Tasks.UpToDateTask.SourceFiles">
  8198. <summary>
  8199. The <see cref="T:NAnt.Core.Types.FileSet"/> that contains list of source files.
  8200. </summary>
  8201. </member>
  8202. <member name="P:NAnt.Core.Tasks.UpToDateTask.TargetFiles">
  8203. <summary>
  8204. The <see cref="T:NAnt.Core.Types.FileSet"/> that contains list of target files.
  8205. </summary>
  8206. </member>
  8207. <member name="T:NAnt.Core.Tasks.XmlPeekTask">
  8208. <summary>
  8209. Extracts text from an XML file at the location specified by an XPath
  8210. expression.
  8211. </summary>
  8212. <remarks>
  8213. <para>
  8214. If the XPath expression specifies multiple nodes the node index is used
  8215. to determine which of the nodes' text is returned.
  8216. </para>
  8217. </remarks>
  8218. <example>
  8219. <para>
  8220. The example provided assumes that the following XML file (App.config)
  8221. exists in the current build directory.
  8222. </para>
  8223. <code>
  8224. <![CDATA[
  8225. <?xml version="1.0" encoding="utf-8" ?>
  8226. <configuration xmlns="http://www.gordic.cz/shared/project-config/v_1.0.0.0">
  8227. <appSettings>
  8228. <add key="server" value="testhost.somecompany.com" />
  8229. </appSettings>
  8230. </configuration>
  8231. ]]>
  8232. </code>
  8233. </example>
  8234. <example>
  8235. <para>
  8236. The example will read the server value from the above
  8237. configuration file.
  8238. </para>
  8239. <code>
  8240. <![CDATA[
  8241. <xmlpeek
  8242. file="App.config"
  8243. xpath="/x:configuration/x:appSettings/x:add[@key = 'server']/@value"
  8244. property="configuration.server">
  8245. <namespaces>
  8246. <namespace prefix="x" uri="http://www.gordic.cz/shared/project-config/v_1.0.0.0" />
  8247. </namespaces>
  8248. </xmlpeek>
  8249. ]]>
  8250. </code>
  8251. </example>
  8252. </member>
  8253. <member name="M:NAnt.Core.Tasks.XmlPeekTask.ExecuteTask">
  8254. <summary>
  8255. Executes the XML peek task.
  8256. </summary>
  8257. </member>
  8258. <member name="M:NAnt.Core.Tasks.XmlPeekTask.LoadDocument(System.String)">
  8259. <summary>
  8260. Loads an XML document from a file on disk.
  8261. </summary>
  8262. <param name="fileName">The file name of the file to load the XML document from.</param>
  8263. <returns>
  8264. A <see cref="T:System.Xml.XmlDocument">document</see> containing
  8265. the document object representing the file.
  8266. </returns>
  8267. </member>
  8268. <member name="M:NAnt.Core.Tasks.XmlPeekTask.GetNodeContents(System.String,System.Xml.XmlDocument,System.Int32)">
  8269. <summary>
  8270. Gets the contents of the node specified by the XPath expression.
  8271. </summary>
  8272. <param name="xpath">The XPath expression used to determine which nodes to choose from.</param>
  8273. <param name="document">The XML document to select the nodes from.</param>
  8274. <param name="nodeIndex">The node index in the case where multiple nodes satisfy the expression.</param>
  8275. <returns>
  8276. The contents of the node specified by the XPath expression.
  8277. </returns>
  8278. </member>
  8279. <member name="P:NAnt.Core.Tasks.XmlPeekTask.XmlFile">
  8280. <summary>
  8281. The name of the file that contains the XML document
  8282. that is going to be peeked at.
  8283. </summary>
  8284. </member>
  8285. <member name="P:NAnt.Core.Tasks.XmlPeekTask.NodeIndex">
  8286. <summary>
  8287. The index of the node that gets its text returned when the query
  8288. returns multiple nodes.
  8289. </summary>
  8290. </member>
  8291. <member name="P:NAnt.Core.Tasks.XmlPeekTask.Property">
  8292. <summary>
  8293. The property that receives the text representation of the XML inside
  8294. the node returned from the XPath expression.
  8295. </summary>
  8296. </member>
  8297. <member name="P:NAnt.Core.Tasks.XmlPeekTask.XPath">
  8298. <summary>
  8299. The XPath expression used to select which node to read.
  8300. </summary>
  8301. </member>
  8302. <member name="P:NAnt.Core.Tasks.XmlPeekTask.Namespaces">
  8303. <summary>
  8304. Namespace definitions to resolve prefixes in the XPath expression.
  8305. </summary>
  8306. </member>
  8307. <member name="T:NAnt.Core.Tasks.XmlPokeTask">
  8308. <summary>
  8309. Replaces text in an XML file at the location specified by an XPath
  8310. expression.
  8311. </summary>
  8312. <remarks>
  8313. <para>
  8314. The location specified by the XPath expression must exist, it will
  8315. not create the parent elements for you. However, provided you have
  8316. a root element you could use a series of the tasks to build the
  8317. XML file up if necessary.
  8318. </para>
  8319. </remarks>
  8320. <example>
  8321. <para>
  8322. Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
  8323. to <c>productionhost.somecompany.com</c>.
  8324. </para>
  8325. <para>XML file:</para>
  8326. <code>
  8327. <![CDATA[
  8328. <?xml version="1.0" encoding="utf-8" ?>
  8329. <configuration>
  8330. <appSettings>
  8331. <add key="server" value="testhost.somecompany.com" />
  8332. </appSettings>
  8333. </configuration>
  8334. ]]>
  8335. </code>
  8336. <para>Build fragment:</para>
  8337. <code>
  8338. <![CDATA[
  8339. <xmlpoke
  8340. file="App.config"
  8341. xpath="/configuration/appSettings/add[@key = 'server']/@value"
  8342. value="productionhost.somecompany.com" />
  8343. ]]>
  8344. </code>
  8345. </example>
  8346. <example>
  8347. <para>
  8348. Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
  8349. </para>
  8350. <para>XML file:</para>
  8351. <code>
  8352. <![CDATA[
  8353. <?xml version="1.0" encoding="utf-8" ?>
  8354. <Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
  8355. </Commands>
  8356. ]]>
  8357. </code>
  8358. <para>Build fragment:</para>
  8359. <code>
  8360. <![CDATA[
  8361. <xmlpoke file="test.xml" xpath="/Commands/@xsi:noNamespaceSchemaLocation" value="d:\Commands.xsd">
  8362. <namespaces>
  8363. <namespace prefix="xsi" uri="http://www.w3.org/2001/XMLSchema-instance" />
  8364. </namespaces>
  8365. </xmlpoke>
  8366. ]]>
  8367. </code>
  8368. </example>
  8369. </member>
  8370. <member name="M:NAnt.Core.Tasks.XmlPokeTask.ExecuteTask">
  8371. <summary>
  8372. Executes the XML poke task.
  8373. </summary>
  8374. </member>
  8375. <member name="M:NAnt.Core.Tasks.XmlPokeTask.LoadDocument(System.String,System.Boolean)">
  8376. <summary>
  8377. Loads an XML document from a file on disk.
  8378. </summary>
  8379. <param name="fileName">
  8380. The file name of the file to load the XML document from.
  8381. </param>
  8382. <param name="preserveWhitespace">
  8383. Value for XmlDocument.PreserveWhitespace that is set before the xml is loaded.
  8384. </param>
  8385. <returns>
  8386. An <see cref="T:System.Xml.XmlDocument"/> containing
  8387. the document object model representing the file.
  8388. </returns>
  8389. </member>
  8390. <member name="M:NAnt.Core.Tasks.XmlPokeTask.SelectNodes(System.String,System.Xml.XmlDocument,System.Xml.XmlNamespaceManager)">
  8391. <summary>
  8392. Given an XML document and an expression, returns a list of nodes
  8393. which match the expression criteria.
  8394. </summary>
  8395. <param name="xpath">
  8396. The XPath expression used to select the nodes.
  8397. </param>
  8398. <param name="document">
  8399. The XML document that is searched.
  8400. </param>
  8401. <param name="nsMgr">
  8402. An <see cref="T:System.Xml.XmlNamespaceManager"/> to use for resolving namespaces
  8403. for prefixes in the XPath expression.
  8404. </param>
  8405. <returns>
  8406. An <see cref="T:System.Xml.XmlNodeList"/> containing references to the nodes
  8407. that matched the XPath expression.
  8408. </returns>
  8409. </member>
  8410. <member name="M:NAnt.Core.Tasks.XmlPokeTask.UpdateNodes(System.Xml.XmlNodeList,System.String)">
  8411. <summary>
  8412. Given a node list, replaces the XML within those nodes.
  8413. </summary>
  8414. <param name="nodes">
  8415. The list of nodes to replace the contents of.
  8416. </param>
  8417. <param name="value">
  8418. The text to replace the contents with.
  8419. </param>
  8420. </member>
  8421. <member name="M:NAnt.Core.Tasks.XmlPokeTask.SaveDocument(System.Xml.XmlDocument,System.String)">
  8422. <summary>
  8423. Saves the XML document to a file.
  8424. </summary>
  8425. <param name="document">The XML document to be saved.</param>
  8426. <param name="fileName">The file name to save the XML document under.</param>
  8427. </member>
  8428. <member name="P:NAnt.Core.Tasks.XmlPokeTask.XmlFile">
  8429. <summary>
  8430. The name of the file that contains the XML document that is going
  8431. to be poked.
  8432. </summary>
  8433. </member>
  8434. <member name="P:NAnt.Core.Tasks.XmlPokeTask.XPath">
  8435. <summary>
  8436. The XPath expression used to select which nodes are to be modified.
  8437. </summary>
  8438. </member>
  8439. <member name="P:NAnt.Core.Tasks.XmlPokeTask.Value">
  8440. <summary>
  8441. The value that replaces the contents of the selected nodes.
  8442. </summary>
  8443. </member>
  8444. <member name="P:NAnt.Core.Tasks.XmlPokeTask.Namespaces">
  8445. <summary>
  8446. Namespace definitions to resolve prefixes in the XPath expression.
  8447. </summary>
  8448. </member>
  8449. <member name="P:NAnt.Core.Tasks.XmlPokeTask.PreserveWhitespace">
  8450. <summary>
  8451. Namespace definitions to resolve prefixes in the XPath expression.
  8452. </summary>
  8453. </member>
  8454. <member name="T:NAnt.Core.Types.Argument">
  8455. <summary>
  8456. Represents a command-line argument.
  8457. </summary>
  8458. <remarks>
  8459. <para>
  8460. When passed to an external application, the argument will be quoted
  8461. when appropriate. This does not apply to the <see cref="P:NAnt.Core.Types.Argument.Line"/>
  8462. parameter, which is always passed as is.
  8463. </para>
  8464. </remarks>
  8465. <example>
  8466. <para>
  8467. A single command-line argument containing a space character.
  8468. </para>
  8469. <code>
  8470. <![CDATA[
  8471. <arg value="-l -a" />
  8472. ]]>
  8473. </code>
  8474. </example>
  8475. <example>
  8476. <para>
  8477. Two separate command-line arguments.
  8478. </para>
  8479. <code>
  8480. <![CDATA[
  8481. <arg line="-l -a" />
  8482. ]]>
  8483. </code>
  8484. </example>
  8485. <example>
  8486. <para>
  8487. A single command-line argument with the value <c>\dir;\dir2;\dir3</c>
  8488. on DOS-based systems and <c>/dir:/dir2:/dir3</c> on Unix-like systems.
  8489. </para>
  8490. <code>
  8491. <![CDATA[
  8492. <arg path="/dir;/dir2:\dir3" />
  8493. ]]>
  8494. </code>
  8495. </example>
  8496. </member>
  8497. <member name="M:NAnt.Core.Types.Argument.#ctor">
  8498. <summary>
  8499. Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class.
  8500. </summary>
  8501. </member>
  8502. <member name="M:NAnt.Core.Types.Argument.#ctor(System.String)">
  8503. <summary>
  8504. Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
  8505. with the specified command-line argument.
  8506. </summary>
  8507. </member>
  8508. <member name="M:NAnt.Core.Types.Argument.#ctor(System.IO.FileInfo)">
  8509. <summary>
  8510. Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
  8511. with the given file.
  8512. </summary>
  8513. </member>
  8514. <member name="M:NAnt.Core.Types.Argument.#ctor(NAnt.Core.Types.PathSet)">
  8515. <summary>
  8516. Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
  8517. with the given path.
  8518. </summary>
  8519. </member>
  8520. <member name="M:NAnt.Core.Types.Argument.ToString">
  8521. <summary>
  8522. Returns the argument as a <see cref="T:System.String"/>.
  8523. </summary>
  8524. <returns>
  8525. The argument as a <see cref="T:System.String"/>.
  8526. </returns>
  8527. <remarks>
  8528. File and individual path elements will be quoted if necessary.
  8529. </remarks>
  8530. </member>
  8531. <member name="M:NAnt.Core.Types.Argument.QuoteArgument(System.String)">
  8532. <summary>
  8533. Quotes a command line argument if it contains a single quote or a
  8534. space.
  8535. </summary>
  8536. <param name="argument">The command line argument.</param>
  8537. <returns>
  8538. A quoted command line argument if <paramref name="argument" />
  8539. contains a single quote or a space; otherwise,
  8540. <paramref name="argument" />.
  8541. </returns>
  8542. </member>
  8543. <member name="P:NAnt.Core.Types.Argument.Value">
  8544. <summary>
  8545. A single command-line argument; can contain space characters.
  8546. </summary>
  8547. </member>
  8548. <member name="P:NAnt.Core.Types.Argument.File">
  8549. <summary>
  8550. The name of a file as a single command-line argument; will be
  8551. replaced with the absolute filename of the file.
  8552. </summary>
  8553. </member>
  8554. <member name="P:NAnt.Core.Types.Argument.Directory">
  8555. <summary>
  8556. The value for a directory-based command-line argument; will be
  8557. replaced with the absolute path of the directory.
  8558. </summary>
  8559. </member>
  8560. <member name="P:NAnt.Core.Types.Argument.Path">
  8561. <summary>
  8562. The value for a PATH-like command-line argument; you can use
  8563. <c>:</c> or <c>;</c> as path separators and NAnt will convert it
  8564. to the platform's local conventions, while resolving references to
  8565. environment variables.
  8566. </summary>
  8567. <remarks>
  8568. Individual parts will be replaced with the absolute path, resolved
  8569. relative to the project base directory.
  8570. </remarks>
  8571. </member>
  8572. <member name="P:NAnt.Core.Types.Argument.PathSet">
  8573. <summary>
  8574. Sets a single command-line argument and treats it like a PATH - ensures
  8575. the right separator for the local platform is used.
  8576. </summary>
  8577. </member>
  8578. <member name="P:NAnt.Core.Types.Argument.Line">
  8579. <summary>
  8580. List of command-line arguments; will be passed to the executable
  8581. as is.
  8582. </summary>
  8583. </member>
  8584. <member name="P:NAnt.Core.Types.Argument.IfDefined">
  8585. <summary>
  8586. Indicates if the argument should be passed to the external program.
  8587. If <see langword="true" /> then the argument will be passed;
  8588. otherwise, skipped. The default is <see langword="true" />.
  8589. </summary>
  8590. </member>
  8591. <member name="P:NAnt.Core.Types.Argument.UnlessDefined">
  8592. <summary>
  8593. Indicates if the argument should not be passed to the external
  8594. program. If <see langword="false" /> then the argument will be
  8595. passed; otherwise, skipped. The default is <see langword="false" />.
  8596. </summary>
  8597. </member>
  8598. <member name="P:NAnt.Core.Types.Argument.StringValue">
  8599. <summary>
  8600. Gets string value corresponding with the argument.
  8601. </summary>
  8602. </member>
  8603. <member name="T:NAnt.Core.Types.ArgumentCollection">
  8604. <summary>
  8605. Contains a collection of <see cref="T:NAnt.Core.Types.Argument"/> elements.
  8606. </summary>
  8607. </member>
  8608. <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor">
  8609. <summary>
  8610. Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class.
  8611. </summary>
  8612. </member>
  8613. <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor(NAnt.Core.Types.ArgumentCollection)">
  8614. <summary>
  8615. Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class
  8616. with the specified <see cref="T:NAnt.Core.Types.ArgumentCollection"/> instance.
  8617. </summary>
  8618. </member>
  8619. <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor(NAnt.Core.Types.Argument[])">
  8620. <summary>
  8621. Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class
  8622. with the specified array of <see cref="T:NAnt.Core.Types.Argument"/> instances.
  8623. </summary>
  8624. </member>
  8625. <member name="M:NAnt.Core.Types.ArgumentCollection.Add(NAnt.Core.Types.Argument)">
  8626. <summary>
  8627. Adds a <see cref="T:NAnt.Core.Types.Argument"/> to the end of the collection.
  8628. </summary>
  8629. <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to be added to the end of the collection.</param>
  8630. <returns>The position into which the new element was inserted.</returns>
  8631. </member>
  8632. <member name="M:NAnt.Core.Types.ArgumentCollection.AddRange(NAnt.Core.Types.Argument[])">
  8633. <summary>
  8634. Adds the elements of a <see cref="T:NAnt.Core.Types.Argument"/> array to the end of the collection.
  8635. </summary>
  8636. <param name="items">The array of <see cref="T:NAnt.Core.Types.Argument"/> elements to be added to the end of the collection.</param>
  8637. </member>
  8638. <member name="M:NAnt.Core.Types.ArgumentCollection.AddRange(NAnt.Core.Types.ArgumentCollection)">
  8639. <summary>
  8640. Adds the elements of a <see cref="T:NAnt.Core.Types.ArgumentCollection"/> to the end of the collection.
  8641. </summary>
  8642. <param name="items">The <see cref="T:NAnt.Core.Types.ArgumentCollection"/> to be added to the end of the collection.</param>
  8643. </member>
  8644. <member name="M:NAnt.Core.Types.ArgumentCollection.Contains(NAnt.Core.Types.Argument)">
  8645. <summary>
  8646. Determines whether a <see cref="T:NAnt.Core.Types.Argument"/> is in the collection.
  8647. </summary>
  8648. <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to locate in the collection.</param>
  8649. <returns>
  8650. <see langword="true"/> if <paramref name="item"/> is found in the
  8651. collection; otherwise, <see langword="false"/>.
  8652. </returns>
  8653. </member>
  8654. <member name="M:NAnt.Core.Types.ArgumentCollection.Contains(System.String)">
  8655. <summary>
  8656. Determines whether a <see cref="T:NAnt.Core.Types.Argument"/> with the specified
  8657. value is in the collection.
  8658. </summary>
  8659. <param name="value">The argument value to locate in the collection.</param>
  8660. <returns>
  8661. <see langword="true"/> if a <see cref="T:NAnt.Core.Types.Argument"/> with value
  8662. <paramref name="value"/> is found in the collection; otherwise,
  8663. <see langword="false"/>.
  8664. </returns>
  8665. </member>
  8666. <member name="M:NAnt.Core.Types.ArgumentCollection.CopyTo(NAnt.Core.Types.Argument[],System.Int32)">
  8667. <summary>
  8668. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  8669. </summary>
  8670. <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>
  8671. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  8672. </member>
  8673. <member name="M:NAnt.Core.Types.ArgumentCollection.IndexOf(NAnt.Core.Types.Argument)">
  8674. <summary>
  8675. Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Argument"/> object in the collection.
  8676. </summary>
  8677. <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> object for which the index is returned.</param>
  8678. <returns>
  8679. 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.
  8680. </returns>
  8681. </member>
  8682. <member name="M:NAnt.Core.Types.ArgumentCollection.Insert(System.Int32,NAnt.Core.Types.Argument)">
  8683. <summary>
  8684. Inserts a <see cref="T:NAnt.Core.Types.Argument"/> into the collection at the specified index.
  8685. </summary>
  8686. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  8687. <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to insert.</param>
  8688. </member>
  8689. <member name="M:NAnt.Core.Types.ArgumentCollection.GetEnumerator">
  8690. <summary>
  8691. Returns an enumerator that can iterate through the collection.
  8692. </summary>
  8693. <returns>
  8694. A <see cref="T:NAnt.Core.Types.ArgumentEnumerator"/> for the entire collection.
  8695. </returns>
  8696. </member>
  8697. <member name="M:NAnt.Core.Types.ArgumentCollection.Remove(NAnt.Core.Types.Argument)">
  8698. <summary>
  8699. Removes a member from the collection.
  8700. </summary>
  8701. <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to remove from the collection.</param>
  8702. </member>
  8703. <member name="P:NAnt.Core.Types.ArgumentCollection.Item(System.Int32)">
  8704. <summary>
  8705. Gets or sets the element at the specified index.
  8706. </summary>
  8707. <param name="index">The zero-based index of the element to get or set.</param>
  8708. </member>
  8709. <member name="P:NAnt.Core.Types.ArgumentCollection.Item(System.String)">
  8710. <summary>
  8711. Gets the <see cref="T:NAnt.Core.Types.Argument"/> with the specified value.
  8712. </summary>
  8713. <param name="value">The value of the <see cref="T:NAnt.Core.Types.Argument"/> to get.</param>
  8714. </member>
  8715. <member name="T:NAnt.Core.Types.ArgumentEnumerator">
  8716. <summary>
  8717. Enumerates the <see cref="T:NAnt.Core.Types.Argument"/> elements of a <see cref="T:NAnt.Core.Types.ArgumentCollection"/>.
  8718. </summary>
  8719. </member>
  8720. <member name="M:NAnt.Core.Types.ArgumentEnumerator.#ctor(NAnt.Core.Types.ArgumentCollection)">
  8721. <summary>
  8722. Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentEnumerator"/> class
  8723. with the specified <see cref="T:NAnt.Core.Types.ArgumentCollection"/>.
  8724. </summary>
  8725. <param name="arguments">The collection that should be enumerated.</param>
  8726. </member>
  8727. <member name="M:NAnt.Core.Types.ArgumentEnumerator.MoveNext">
  8728. <summary>
  8729. Advances the enumerator to the next element of the collection.
  8730. </summary>
  8731. <returns>
  8732. <see langword="true" /> if the enumerator was successfully advanced
  8733. to the next element; <see langword="false" /> if the enumerator has
  8734. passed the end of the collection.
  8735. </returns>
  8736. </member>
  8737. <member name="M:NAnt.Core.Types.ArgumentEnumerator.Reset">
  8738. <summary>
  8739. Sets the enumerator to its initial position, which is before the
  8740. first element in the collection.
  8741. </summary>
  8742. </member>
  8743. <member name="P:NAnt.Core.Types.ArgumentEnumerator.Current">
  8744. <summary>
  8745. Gets the current element in the collection.
  8746. </summary>
  8747. <returns>
  8748. The current element in the collection.
  8749. </returns>
  8750. </member>
  8751. <member name="T:NAnt.Core.Types.Credential">
  8752. <summary>
  8753. Provides credentials for password-based authentication schemes.
  8754. </summary>
  8755. </member>
  8756. <member name="M:NAnt.Core.Types.Credential.#ctor">
  8757. <summary>
  8758. Initializes a new instance of the <see cref="T:NAnt.Core.Types.Credential"/> class.
  8759. </summary>
  8760. </member>
  8761. <member name="M:NAnt.Core.Types.Credential.GetCredential">
  8762. <summary>
  8763. Returns a <see cref="T:System.Net.NetworkCredential"/> instance representing
  8764. the current <see cref="T:NAnt.Core.Types.Credential"/>.
  8765. </summary>
  8766. <returns>
  8767. A <see cref="T:System.Net.NetworkCredential"/> instance representing the current
  8768. <see cref="T:NAnt.Core.Types.Credential"/>, or <see langword="null"/> if the
  8769. credentials should not be used to provide authentication information
  8770. to the external resource.
  8771. </returns>
  8772. </member>
  8773. <member name="P:NAnt.Core.Types.Credential.Domain">
  8774. <summary>
  8775. The domain or computer name that verifies the credentials.
  8776. </summary>
  8777. </member>
  8778. <member name="P:NAnt.Core.Types.Credential.Password">
  8779. <summary>
  8780. The password for the user name associated with the credentials.
  8781. </summary>
  8782. </member>
  8783. <member name="P:NAnt.Core.Types.Credential.UserName">
  8784. <summary>
  8785. The user name associated with the credentials.
  8786. </summary>
  8787. </member>
  8788. <member name="P:NAnt.Core.Types.Credential.IfDefined">
  8789. <summary>
  8790. Indicates if the credentials should be used to provide authentication
  8791. information to the external resource. If <see langword="true" /> then
  8792. the credentials will be passed; otherwise, not. The default is
  8793. <see langword="true" />.
  8794. </summary>
  8795. </member>
  8796. <member name="P:NAnt.Core.Types.Credential.UnlessDefined">
  8797. <summary>
  8798. Indicates if the credentials should not be used to provide authentication
  8799. information to the external resource. If <see langword="false" /> then the
  8800. credentials will be passed; otherwise, not. The default is
  8801. <see langword="false" />.
  8802. </summary>
  8803. </member>
  8804. <member name="T:NAnt.Core.Types.DirSet">
  8805. <summary>
  8806. A specialized <see cref="T:NAnt.Core.Types.FileSet"/> used for specifying a set of
  8807. directories.
  8808. </summary>
  8809. <remarks>
  8810. Hint for supporting tasks that the included directories instead of
  8811. files should be used.
  8812. </remarks>
  8813. </member>
  8814. <member name="T:NAnt.Core.Types.FileSet">
  8815. <summary>
  8816. Filesets are groups of files. These files can be found in a directory
  8817. tree starting in a base directory and are matched by patterns taken
  8818. from a number of patterns. Filesets can appear inside tasks that support
  8819. this feature or at the project level, i.e., as children of <c>&lt;project&gt;</c>.
  8820. </summary>
  8821. <remarks>
  8822. <h3>Patterns</h3>
  8823. <para>
  8824. As described earlier, patterns are used for the inclusion and exclusion.
  8825. These patterns look very much like the patterns used in DOS and UNIX:
  8826. </para>
  8827. <list type="bullet">
  8828. <item>
  8829. <description>
  8830. <para>'<c>*</c>' matches zero or more characters</para>
  8831. <para>For example:</para>
  8832. <para>
  8833. <c>*.cs</c> matches <c>.cs</c>, <c>x.cs</c> and <c>FooBar.cs</c>,
  8834. but not <c>FooBar.xml</c> (does not end with <c>.cs</c>).
  8835. </para>
  8836. </description>
  8837. </item>
  8838. <item>
  8839. <description>
  8840. <para>'<c>?</c>' matches one character</para>
  8841. <para>For example:</para>
  8842. <para>
  8843. <c>?.cs</c> matches <c>x.cs</c>, <c>A.cs</c>, but not
  8844. <c>.cs</c> or <c>xyz.cs</c> (both don't have one character
  8845. before <c>.cs</c>).
  8846. </para>
  8847. </description>
  8848. </item>
  8849. </list>
  8850. <para>
  8851. Combinations of <c>*</c>'s and <c>?</c>'s are allowed.
  8852. </para>
  8853. <para>
  8854. Matching is done per-directory. This means that first the first directory
  8855. in the pattern is matched against the first directory in the path to match.
  8856. Then the second directory is matched, and so on. For example, when we have
  8857. the pattern <c>/?abc/*/*.cs</c> and the path <c>/xabc/foobar/test.cs</c>,
  8858. the first <c>?abc</c> is matched with <c>xabc</c>, then <c>*</c> is matched
  8859. with <c>foobar</c>, and finally <c>*.cs</c> is matched with <c>test.cs</c>.
  8860. They all match, so the path matches the pattern.
  8861. </para>
  8862. <para>
  8863. To make things a bit more flexible, we added one extra feature, which makes
  8864. it possible to match multiple directory levels. This can be used to match a
  8865. complete directory tree, or a file anywhere in the directory tree. To do this,
  8866. <c>**</c> must be used as the name of a directory. When <c>**</c> is used as
  8867. the name of a directory in the pattern, it matches zero or more directories.
  8868. For example: <c>/test/**</c> matches all files/directories under <c>/test/</c>,
  8869. such as <c>/test/x.cs</c>, or <c>/test/foo/bar/xyz.html</c>, but not <c>/xyz.xml</c>.
  8870. </para>
  8871. <para>
  8872. There is one "shorthand" - if a pattern ends with <c>/</c> or <c>\</c>, then
  8873. <c>**</c> is appended. For example, <c>mypackage/test/</c> is interpreted as
  8874. if it were <c>mypackage/test/**</c>.
  8875. </para>
  8876. <h3>Case-Sensitivity</h3>
  8877. <para>
  8878. By default, pattern matching is case-sensitive on Unix and case-insensitive
  8879. on other platforms. The <see cref="P:NAnt.Core.Types.FileSet.CaseSensitive"/> parameter can be used
  8880. to override this.
  8881. </para>
  8882. <h3>Default Excludes</h3>
  8883. <para>
  8884. There are a set of definitions that are excluded by default from all
  8885. tasks that use filesets. They are:
  8886. </para>
  8887. <list type="bullet">
  8888. <item>
  8889. <description>
  8890. **/*~
  8891. </description>
  8892. </item>
  8893. <item>
  8894. <description>
  8895. **/#*#
  8896. </description>
  8897. </item>
  8898. <item>
  8899. <description>
  8900. **/.#*
  8901. </description>
  8902. </item>
  8903. <item>
  8904. <description>
  8905. **/%*%
  8906. </description>
  8907. </item>
  8908. <item>
  8909. <description>
  8910. **/CVS
  8911. </description>
  8912. </item>
  8913. <item>
  8914. <description>
  8915. **/CVS/**
  8916. </description>
  8917. </item>
  8918. <item>
  8919. <description>
  8920. **/.cvsignore
  8921. </description>
  8922. </item>
  8923. <item>
  8924. <description>
  8925. **/.svn
  8926. </description>
  8927. </item>
  8928. <item>
  8929. <description>
  8930. **/.svn/**
  8931. </description>
  8932. </item>
  8933. <item>
  8934. <description>
  8935. **/_svn
  8936. </description>
  8937. </item>
  8938. <item>
  8939. <description>
  8940. **/_svn/**
  8941. </description>
  8942. </item>
  8943. <item>
  8944. <description>
  8945. **/SCCS
  8946. </description>
  8947. </item>
  8948. <item>
  8949. <description>
  8950. **/SCCS/**
  8951. </description>
  8952. </item>
  8953. <item>
  8954. <description>
  8955. **/vssver.scc
  8956. </description>
  8957. </item>
  8958. <item>
  8959. <description>
  8960. **/vssver2.scc
  8961. </description>
  8962. </item>
  8963. <item>
  8964. <description>
  8965. **/_vti_cnf/**
  8966. </description>
  8967. </item>
  8968. </list>
  8969. <para>
  8970. If you do not want these default excludes applied, you may disable them
  8971. by setting <see cref="P:NAnt.Core.Types.FileSet.DefaultExcludes"/> to <see langword="false"/>.
  8972. </para>
  8973. </remarks>
  8974. <example>
  8975. <list type="table">
  8976. <listheader>
  8977. <term>Pattern</term>
  8978. <description>Match</description>
  8979. </listheader>
  8980. <item>
  8981. <term><c>**/CVS/*</c></term>
  8982. <description>
  8983. <para>
  8984. Matches all files in <c>CVS</c> directories that can be
  8985. located anywhere in the directory tree.
  8986. </para>
  8987. <para>Matches:</para>
  8988. <list type="bullet">
  8989. <item>
  8990. <description>CVS/Repository</description>
  8991. </item>
  8992. <item>
  8993. <description>org/apache/CVS/Entries</description>
  8994. </item>
  8995. <item>
  8996. <description>org/apache/jakarta/tools/ant/CVS/Entries</description>
  8997. </item>
  8998. </list>
  8999. <para>But not:</para>
  9000. <list type="bullet">
  9001. <item>
  9002. <description>org/apache/CVS/foo/bar/Entries (<c>foo/bar/</c> part does not match)</description>
  9003. </item>
  9004. </list>
  9005. </description>
  9006. </item>
  9007. <item>
  9008. <term><c>org/apache/jakarta/**</c></term>
  9009. <description>
  9010. <para>
  9011. Matches all files in the <c>org/apache/jakarta</c> directory
  9012. tree.
  9013. </para>
  9014. <para>Matches:</para>
  9015. <list type="bullet">
  9016. <item>
  9017. <description>org/apache/jakarta/tools/ant/docs/index.html</description>
  9018. </item>
  9019. <item>
  9020. <description>org/apache/jakarta/test.xml</description>
  9021. </item>
  9022. </list>
  9023. <para>But not:</para>
  9024. <list type="bullet">
  9025. <item>
  9026. <description>org/apache/xyz.java (<c>jakarta/</c> part is missing)</description>
  9027. </item>
  9028. </list>
  9029. </description>
  9030. </item>
  9031. <item>
  9032. <term><c>org/apache/**/CVS/*</c></term>
  9033. <description>
  9034. <para>
  9035. Matches all files in <c>CVS</c> directories that are located
  9036. anywhere in the directory tree under <c>org/apache</c>.
  9037. </para>
  9038. <para>Matches:</para>
  9039. <list type="bullet">
  9040. <item>
  9041. <description>org/apache/CVS/Entries</description>
  9042. </item>
  9043. <item>
  9044. <description>org/apache/jakarta/tools/ant/CVS/Entries</description>
  9045. </item>
  9046. </list>
  9047. <para>But not:</para>
  9048. <list type="bullet">
  9049. <item>
  9050. <description>org/apache/CVS/foo/bar/Entries (<c>foo/bar/</c> part does not match)</description>
  9051. </item>
  9052. </list>
  9053. </description>
  9054. </item>
  9055. <item>
  9056. <term><c>**/test/**</c></term>
  9057. <description>
  9058. <para>
  9059. Matches all files that have a <c>test</c> element in their
  9060. path, including <c>test</c> as a filename.
  9061. </para>
  9062. </description>
  9063. </item>
  9064. </list>
  9065. </example>
  9066. <seealso cref="T:NAnt.Core.Types.PatternSet"/>
  9067. </member>
  9068. <member name="M:NAnt.Core.Types.FileSet.#ctor">
  9069. <summary>
  9070. Initializes a new instance of the <see cref="T:NAnt.Core.Types.FileSet"/> class.
  9071. </summary>
  9072. </member>
  9073. <member name="M:NAnt.Core.Types.FileSet.#ctor(NAnt.Core.Types.FileSet)">
  9074. <summary>
  9075. copy constructor
  9076. </summary>
  9077. <param name="fs"></param>
  9078. </member>
  9079. <member name="M:NAnt.Core.Types.FileSet.Clone">
  9080. <summary>
  9081. Creates a shallow copy of the <see cref="T:NAnt.Core.Types.FileSet"/>.
  9082. </summary>
  9083. <returns>
  9084. A shallow copy of the <see cref="T:NAnt.Core.Types.FileSet"/>.
  9085. </returns>
  9086. </member>
  9087. <member name="M:NAnt.Core.Types.FileSet.AddPatternSet(NAnt.Core.Types.PatternSet)">
  9088. <summary>
  9089. Adds a nested set of patterns, or references a standalone patternset.
  9090. </summary>
  9091. </member>
  9092. <member name="M:NAnt.Core.Types.FileSet.CopyTo(NAnt.Core.Types.FileSet)">
  9093. <summary>
  9094. Copies all instance data of the <see cref="T:NAnt.Core.Types.FileSet"/> to a given
  9095. <see cref="T:NAnt.Core.Types.FileSet"/>.
  9096. </summary>
  9097. </member>
  9098. <member name="M:NAnt.Core.Types.FileSet.FindMoreRecentLastWriteTime(System.String,System.DateTime)">
  9099. <summary>
  9100. Determines if a file has a more recent last write time than the
  9101. given time, or no longer exists.
  9102. </summary>
  9103. <param name="fileName">A file to check the last write time against.</param>
  9104. <param name="targetLastWriteTime">The datetime to compare against.</param>
  9105. <returns>
  9106. The name of the file that has a last write time greater than
  9107. <paramref name="targetLastWriteTime" /> or that no longer exists;
  9108. otherwise, <see langword="null" />.
  9109. </returns>
  9110. </member>
  9111. <member name="M:NAnt.Core.Types.FileSet.FindMoreRecentLastWriteTime(System.Collections.Specialized.StringCollection,System.DateTime)">
  9112. <summary>
  9113. Determines if one of the given files has a more recent last write
  9114. time than the given time. If one of the given files no longer exists,
  9115. the target will be considered out-of-date.
  9116. </summary>
  9117. <param name="fileNames">A collection of filenames to check the last write time against.</param>
  9118. <param name="targetLastWriteTime">The datetime to compare against.</param>
  9119. <returns>
  9120. The name of the first file that has a last write time greater than
  9121. <paramref name="targetLastWriteTime" />; otherwise, null.
  9122. </returns>
  9123. </member>
  9124. <member name="P:NAnt.Core.Types.FileSet.CaseSensitive">
  9125. <summary>
  9126. Indicates whether include and exclude patterns must be treated in a
  9127. case-sensitive way. The default is <see langword="true" /> on Unix;
  9128. otherwise, <see langword="false" />.
  9129. </summary>
  9130. </member>
  9131. <member name="P:NAnt.Core.Types.FileSet.FailOnEmpty">
  9132. <summary>
  9133. When set to <see langword="true"/>, causes the fileset element to
  9134. throw a <see cref="T:NAnt.Core.ValidationException"/> when no files match the
  9135. includes and excludes criteria. The default is <see langword="false"/>.
  9136. </summary>
  9137. </member>
  9138. <member name="P:NAnt.Core.Types.FileSet.DefaultExcludes">
  9139. <summary>
  9140. Indicates whether default excludes should be used or not.
  9141. The default is <see langword="true" />.
  9142. </summary>
  9143. </member>
  9144. <member name="P:NAnt.Core.Types.FileSet.BaseDirectory">
  9145. <summary>
  9146. The base of the directory of this fileset. The default is the project
  9147. base directory.
  9148. </summary>
  9149. </member>
  9150. <member name="P:NAnt.Core.Types.FileSet.Includes">
  9151. <summary>
  9152. Gets the collection of include patterns.
  9153. </summary>
  9154. </member>
  9155. <member name="P:NAnt.Core.Types.FileSet.Excludes">
  9156. <summary>
  9157. Gets the collection of exclude patterns.
  9158. </summary>
  9159. </member>
  9160. <member name="P:NAnt.Core.Types.FileSet.AsIs">
  9161. <summary>
  9162. Gets the collection of files that will be added to the
  9163. <see cref="T:NAnt.Core.Types.FileSet"/> without pattern matching or checking if the
  9164. file exists.
  9165. </summary>
  9166. </member>
  9167. <member name="P:NAnt.Core.Types.FileSet.FileNames">
  9168. <summary>
  9169. Gets the collection of file names that match the fileset.
  9170. </summary>
  9171. <value>
  9172. A collection that contains the file names that match the
  9173. <see cref="T:NAnt.Core.Types.FileSet"/>.
  9174. </value>
  9175. </member>
  9176. <member name="P:NAnt.Core.Types.FileSet.DirectoryNames">
  9177. <summary>
  9178. Gets the collection of directory names that match the fileset.
  9179. </summary>
  9180. <value>
  9181. A collection that contains the directory names that match the
  9182. <see cref="T:NAnt.Core.Types.FileSet"/>.
  9183. </value>
  9184. </member>
  9185. <member name="P:NAnt.Core.Types.FileSet.ScannedDirectories">
  9186. <summary>
  9187. Gets the collection of directory names that were scanned for files.
  9188. </summary>
  9189. <value>
  9190. A collection that contains the directory names that were scanned for
  9191. files.
  9192. </value>
  9193. </member>
  9194. <member name="P:NAnt.Core.Types.FileSet.SetIncludes">
  9195. <summary>
  9196. The items to include in the fileset.
  9197. </summary>
  9198. </member>
  9199. <member name="P:NAnt.Core.Types.FileSet.IncludeElements">
  9200. <summary>
  9201. The items to include in the fileset.
  9202. </summary>
  9203. </member>
  9204. <member name="P:NAnt.Core.Types.FileSet.SetExcludes">
  9205. <summary>
  9206. The items to exclude from the fileset.
  9207. </summary>
  9208. </member>
  9209. <member name="P:NAnt.Core.Types.FileSet.ExcludeElements">
  9210. <summary>
  9211. The items to exclude from the fileset.
  9212. </summary>
  9213. </member>
  9214. <member name="P:NAnt.Core.Types.FileSet.SetIncludesList">
  9215. <summary>
  9216. The files from which a list of patterns or files to include should
  9217. be obtained.
  9218. </summary>
  9219. </member>
  9220. <member name="P:NAnt.Core.Types.FileSet.IncludesFiles">
  9221. <summary>
  9222. The files from which a list of patterns or files to include should
  9223. be obtained.
  9224. </summary>
  9225. </member>
  9226. <member name="P:NAnt.Core.Types.FileSet.ExcludesFiles">
  9227. <summary>
  9228. The files from which a list of patterns or files to exclude should
  9229. be obtained.
  9230. </summary>
  9231. </member>
  9232. <member name="P:NAnt.Core.Types.FileSet.MostRecentLastWriteTimeFile">
  9233. <summary>
  9234. Determines the most recently modified file in the fileset (by LastWriteTime of the <see cref="T:System.IO.FileInfo"/>).
  9235. </summary>
  9236. <returns>
  9237. The <see cref="T:System.IO.FileInfo"/> of the file that has the newest (closest to present) last write time.
  9238. </returns>
  9239. </member>
  9240. <member name="P:NAnt.Core.Types.FileSet.Exclude.Pattern">
  9241. <summary>
  9242. The pattern or file name to exclude.
  9243. </summary>
  9244. </member>
  9245. <member name="P:NAnt.Core.Types.FileSet.Exclude.IfDefined">
  9246. <summary>
  9247. If <see langword="true" /> then the pattern will be excluded;
  9248. otherwise, skipped. The default is <see langword="true" />.
  9249. </summary>
  9250. </member>
  9251. <member name="P:NAnt.Core.Types.FileSet.Exclude.UnlessDefined">
  9252. <summary>
  9253. Opposite of <see cref="P:NAnt.Core.Types.FileSet.Exclude.IfDefined"/>. If <see langword="false"/>
  9254. then the pattern will be excluded; otherwise, skipped. The default
  9255. is <see langword="false"/>.
  9256. </summary>
  9257. </member>
  9258. <member name="P:NAnt.Core.Types.FileSet.Include.AsIs">
  9259. <summary>
  9260. If <see langword="true"/> then the file name will be added to
  9261. the <see cref="T:NAnt.Core.Types.FileSet"/> without pattern matching or checking
  9262. if the file exists. The default is <see langword="false"/>.
  9263. </summary>
  9264. </member>
  9265. <member name="P:NAnt.Core.Types.FileSet.Include.FromPath">
  9266. <summary>
  9267. If <see langword="true" /> then the file will be searched for
  9268. on the path. The default is <see langword="false" />.
  9269. </summary>
  9270. </member>
  9271. <member name="P:NAnt.Core.Types.FileSet.Include.Pattern">
  9272. <summary>
  9273. The pattern or file name to include.
  9274. </summary>
  9275. </member>
  9276. <member name="P:NAnt.Core.Types.FileSet.Include.IfDefined">
  9277. <summary>
  9278. If <see langword="true" /> then the pattern will be included;
  9279. otherwise, skipped. The default is <see langword="true" />.
  9280. </summary>
  9281. </member>
  9282. <member name="P:NAnt.Core.Types.FileSet.Include.UnlessDefined">
  9283. <summary>
  9284. Opposite of <see cref="P:NAnt.Core.Types.FileSet.Include.IfDefined"/>. If <see langword="false"/>
  9285. then the pattern will be included; otherwise, skipped. The default
  9286. is <see langword="false"/>.
  9287. </summary>
  9288. </member>
  9289. <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.Patterns">
  9290. <summary>
  9291. Gets the list of patterns in <see cref="P:NAnt.Core.Types.FileSet.ExcludesFile.PatternFile"/>.
  9292. </summary>
  9293. </member>
  9294. <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.IfDefined">
  9295. <summary>
  9296. If <see langword="true" /> then the patterns will be excluded;
  9297. otherwise, skipped. The default is <see langword="true" />.
  9298. </summary>
  9299. </member>
  9300. <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.UnlessDefined">
  9301. <summary>
  9302. Opposite of <see cref="P:NAnt.Core.Types.FileSet.ExcludesFile.IfDefined"/>. If <see langword="false"/>
  9303. then the patterns will be excluded; otherwise, skipped. The default
  9304. is <see langword="false"/>.
  9305. </summary>
  9306. </member>
  9307. <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.PatternFile">
  9308. <summary>
  9309. The name of a file; each line of this file is taken to be a
  9310. pattern.
  9311. </summary>
  9312. </member>
  9313. <member name="P:NAnt.Core.Types.FileSet.IncludesFile.AsIs">
  9314. <summary>
  9315. If <see langword="true"/> then the patterns in the include file
  9316. will be added to the <see cref="T:NAnt.Core.Types.FileSet"/> without pattern
  9317. matching or checking if the file exists. The default is
  9318. <see langword="false"/>.
  9319. </summary>
  9320. </member>
  9321. <member name="P:NAnt.Core.Types.FileSet.IncludesFile.FromPath">
  9322. <summary>
  9323. If <see langword="true" /> then the patterns in the include file
  9324. will be searched for on the path. The default is <see langword="false" />.
  9325. </summary>
  9326. </member>
  9327. <member name="P:NAnt.Core.Types.FileSet.IncludesFile.IfDefined">
  9328. <summary>
  9329. If <see langword="true" /> then the patterns will be included;
  9330. otherwise, skipped. The default is <see langword="true" />.
  9331. </summary>
  9332. </member>
  9333. <member name="P:NAnt.Core.Types.FileSet.IncludesFile.UnlessDefined">
  9334. <summary>
  9335. Opposite of <see cref="P:NAnt.Core.Types.FileSet.IncludesFile.IfDefined"/>. If <see langword="false"/>
  9336. then the patterns will be included; otherwise, skipped. The default
  9337. is <see langword="false"/>.
  9338. </summary>
  9339. </member>
  9340. <member name="M:NAnt.Core.Types.DirSet.#ctor">
  9341. <summary>
  9342. Initializes a new instance of the <see cref="T:NAnt.Core.Types.DirSet"/> class.
  9343. </summary>
  9344. </member>
  9345. <member name="M:NAnt.Core.Types.DirSet.#ctor(NAnt.Core.Types.FileSet)">
  9346. <summary>
  9347. Copy constructor for <see cref="T:NAnt.Core.Types.FileSet"/>. Required in order to
  9348. assign references of <see cref="T:NAnt.Core.Types.FileSet"/> type where
  9349. <see cref="T:NAnt.Core.Types.DirSet"/> is used.
  9350. </summary>
  9351. <param name="fs">A <see cref="T:NAnt.Core.Types.FileSet"/> instance to create a <see cref="T:NAnt.Core.Types.DirSet"/> from.</param>
  9352. </member>
  9353. <member name="T:NAnt.Core.Types.EnvironmentVariable">
  9354. <summary>
  9355. Represents an environment variable.
  9356. </summary>
  9357. </member>
  9358. <member name="M:NAnt.Core.Types.EnvironmentVariable.#ctor(System.String,System.String)">
  9359. <summary>
  9360. Initializes a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instance with the
  9361. specified name and value.
  9362. </summary>
  9363. <param name="name">The name of the environment variable.</param>
  9364. <param name="value">The value of the environment variable.</param>
  9365. </member>
  9366. <member name="M:NAnt.Core.Types.EnvironmentVariable.#ctor">
  9367. <summary>
  9368. Initializes a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instance.
  9369. </summary>
  9370. </member>
  9371. <member name="P:NAnt.Core.Types.EnvironmentVariable.VariableName">
  9372. <summary>
  9373. The name of the environment variable.
  9374. </summary>
  9375. </member>
  9376. <member name="P:NAnt.Core.Types.EnvironmentVariable.LiteralValue">
  9377. <summary>
  9378. The literal value for the environment variable.
  9379. </summary>
  9380. </member>
  9381. <member name="P:NAnt.Core.Types.EnvironmentVariable.File">
  9382. <summary>
  9383. The value for a file-based environment variable. NAnt will convert
  9384. it to an absolute filename.
  9385. </summary>
  9386. </member>
  9387. <member name="P:NAnt.Core.Types.EnvironmentVariable.Directory">
  9388. <summary>
  9389. The value for a directory-based environment variable. NAnt will
  9390. convert it to an absolute path.
  9391. </summary>
  9392. </member>
  9393. <member name="P:NAnt.Core.Types.EnvironmentVariable.Path">
  9394. <summary>
  9395. The value for a PATH like environment variable. You can use
  9396. <c>:</c> or <c>;</c> as path separators and NAnt will convert it to
  9397. the platform's local conventions.
  9398. </summary>
  9399. </member>
  9400. <member name="P:NAnt.Core.Types.EnvironmentVariable.PathSet">
  9401. <summary>
  9402. Sets a single environment variable and treats it like a PATH -
  9403. ensures the right separator for the local platform is used.
  9404. </summary>
  9405. </member>
  9406. <member name="P:NAnt.Core.Types.EnvironmentVariable.Value">
  9407. <summary>
  9408. Gets the value of the environment variable.
  9409. </summary>
  9410. </member>
  9411. <member name="P:NAnt.Core.Types.EnvironmentVariable.IfDefined">
  9412. <summary>
  9413. Indicates if the environment variable should be passed to the
  9414. external program. If <see langword="true" /> then the environment
  9415. variable will be passed; otherwise, skipped. The default is
  9416. <see langword="true" />.
  9417. </summary>
  9418. </member>
  9419. <member name="P:NAnt.Core.Types.EnvironmentVariable.UnlessDefined">
  9420. <summary>
  9421. Indicates if the environment variable should not be passed to the
  9422. external program. If <see langword="false" /> then the environment
  9423. variable will be passed; otherwise, skipped. The default is
  9424. <see langword="false" />.
  9425. </summary>
  9426. </member>
  9427. <member name="T:NAnt.Core.Types.EnvironmentSet">
  9428. <summary>
  9429. A set of environment variables.
  9430. </summary>
  9431. </member>
  9432. <member name="P:NAnt.Core.Types.EnvironmentSet.Options">
  9433. <summary>
  9434. Environment variable to pass to a program.
  9435. </summary>
  9436. </member>
  9437. <member name="P:NAnt.Core.Types.EnvironmentSet.EnvironmentVariables">
  9438. <summary>
  9439. Environment variable to pass to a program.
  9440. </summary>
  9441. </member>
  9442. <member name="T:NAnt.Core.Types.EnvironmentVariableCollection">
  9443. <summary>
  9444. Contains a collection of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements.
  9445. </summary>
  9446. </member>
  9447. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor">
  9448. <summary>
  9449. Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class.
  9450. </summary>
  9451. </member>
  9452. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor(NAnt.Core.Types.EnvironmentVariableCollection)">
  9453. <summary>
  9454. Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class
  9455. with the specified <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> instance.
  9456. </summary>
  9457. </member>
  9458. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor(NAnt.Core.Types.EnvironmentVariable[])">
  9459. <summary>
  9460. Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class
  9461. with the specified array of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instances.
  9462. </summary>
  9463. </member>
  9464. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Add(NAnt.Core.Types.EnvironmentVariable)">
  9465. <summary>
  9466. Adds a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to the end of the collection.
  9467. </summary>
  9468. <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to be added to the end of the collection.</param>
  9469. <returns>The position into which the new element was inserted.</returns>
  9470. </member>
  9471. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.AddRange(NAnt.Core.Types.EnvironmentVariable[])">
  9472. <summary>
  9473. Adds the elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> array to the end of the collection.
  9474. </summary>
  9475. <param name="items">The array of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements to be added to the end of the collection.</param>
  9476. </member>
  9477. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.AddRange(NAnt.Core.Types.EnvironmentVariableCollection)">
  9478. <summary>
  9479. Adds the elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> to the end of the collection.
  9480. </summary>
  9481. <param name="items">The <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> to be added to the end of the collection.</param>
  9482. </member>
  9483. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Contains(NAnt.Core.Types.EnvironmentVariable)">
  9484. <summary>
  9485. Determines whether a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> is in the collection.
  9486. </summary>
  9487. <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to locate in the collection.</param>
  9488. <returns>
  9489. <see langword="true"/> if <paramref name="item"/> is found in the
  9490. collection; otherwise, <see langword="false"/>.
  9491. </returns>
  9492. </member>
  9493. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Contains(System.String)">
  9494. <summary>
  9495. Determines whether a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with the specified
  9496. value is in the collection.
  9497. </summary>
  9498. <param name="value">The argument value to locate in the collection.</param>
  9499. <returns>
  9500. <see langword="true"/> if a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with value
  9501. <paramref name="value"/> is found in the collection; otherwise,
  9502. <see langword="false"/>.
  9503. </returns>
  9504. </member>
  9505. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.CopyTo(NAnt.Core.Types.EnvironmentVariable[],System.Int32)">
  9506. <summary>
  9507. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  9508. </summary>
  9509. <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>
  9510. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  9511. </member>
  9512. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.IndexOf(NAnt.Core.Types.EnvironmentVariable)">
  9513. <summary>
  9514. Retrieves the index of a specified <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> object in the collection.
  9515. </summary>
  9516. <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> object for which the index is returned.</param>
  9517. <returns>
  9518. 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.
  9519. </returns>
  9520. </member>
  9521. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Insert(System.Int32,NAnt.Core.Types.EnvironmentVariable)">
  9522. <summary>
  9523. Inserts a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> into the collection at the specified index.
  9524. </summary>
  9525. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  9526. <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to insert.</param>
  9527. </member>
  9528. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.GetEnumerator">
  9529. <summary>
  9530. Returns an enumerator that can iterate through the collection.
  9531. </summary>
  9532. <returns>
  9533. A <see cref="T:NAnt.Core.Types.EnvironmentVariableEnumerator"/> for the entire collection.
  9534. </returns>
  9535. </member>
  9536. <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Remove(NAnt.Core.Types.EnvironmentVariable)">
  9537. <summary>
  9538. Removes a member from the collection.
  9539. </summary>
  9540. <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to remove from the collection.</param>
  9541. </member>
  9542. <member name="P:NAnt.Core.Types.EnvironmentVariableCollection.Item(System.Int32)">
  9543. <summary>
  9544. Gets or sets the element at the specified index.
  9545. </summary>
  9546. <param name="index">The zero-based index of the element to get or set.</param>
  9547. </member>
  9548. <member name="P:NAnt.Core.Types.EnvironmentVariableCollection.Item(System.String)">
  9549. <summary>
  9550. Gets the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with the specified name.
  9551. </summary>
  9552. <param name="name">The name of the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to get.</param>
  9553. </member>
  9554. <member name="T:NAnt.Core.Types.EnvironmentVariableEnumerator">
  9555. <summary>
  9556. Enumerates the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/>.
  9557. </summary>
  9558. </member>
  9559. <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.#ctor(NAnt.Core.Types.EnvironmentVariableCollection)">
  9560. <summary>
  9561. Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableEnumerator"/> class
  9562. with the specified <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/>.
  9563. </summary>
  9564. <param name="arguments">The collection that should be enumerated.</param>
  9565. </member>
  9566. <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.MoveNext">
  9567. <summary>
  9568. Advances the enumerator to the next element of the collection.
  9569. </summary>
  9570. <returns>
  9571. <see langword="true" /> if the enumerator was successfully advanced
  9572. to the next element; <see langword="false" /> if the enumerator has
  9573. passed the end of the collection.
  9574. </returns>
  9575. </member>
  9576. <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.Reset">
  9577. <summary>
  9578. Sets the enumerator to its initial position, which is before the
  9579. first element in the collection.
  9580. </summary>
  9581. </member>
  9582. <member name="P:NAnt.Core.Types.EnvironmentVariableEnumerator.Current">
  9583. <summary>
  9584. Gets the current element in the collection.
  9585. </summary>
  9586. <returns>
  9587. The current element in the collection.
  9588. </returns>
  9589. </member>
  9590. <member name="P:NAnt.Core.Types.Formatter.Property">
  9591. <summary>
  9592. The name of the NAnt property to set.
  9593. </summary>
  9594. </member>
  9595. <member name="P:NAnt.Core.Types.Formatter.Pattern">
  9596. <summary>
  9597. The string pattern to use to format the property.
  9598. </summary>
  9599. </member>
  9600. <member name="P:NAnt.Core.Types.Formatter.IfDefined">
  9601. <summary>
  9602. Indicates if the formatter should be used to format the timestamp.
  9603. If <see langword="true" /> then the formatter will be used;
  9604. otherwise, skipped. The default is <see langword="true" />.
  9605. </summary>
  9606. </member>
  9607. <member name="P:NAnt.Core.Types.Formatter.UnlessDefined">
  9608. <summary>
  9609. Indicates if the formatter should be not used to format the
  9610. timestamp. If <see langword="false" /> then the formatter will be
  9611. used; otherwise, skipped. The default is <see langword="false" />.
  9612. </summary>
  9613. </member>
  9614. <member name="T:NAnt.Core.Types.FormatterCollection">
  9615. <summary>
  9616. Contains a collection of <see cref="T:NAnt.Core.Types.Formatter"/> elements.
  9617. </summary>
  9618. </member>
  9619. <member name="M:NAnt.Core.Types.FormatterCollection.#ctor">
  9620. <summary>
  9621. Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class.
  9622. </summary>
  9623. </member>
  9624. <member name="M:NAnt.Core.Types.FormatterCollection.#ctor(NAnt.Core.Types.FormatterCollection)">
  9625. <summary>
  9626. Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class
  9627. with the specified <see cref="T:NAnt.Core.Types.FormatterCollection"/> instance.
  9628. </summary>
  9629. </member>
  9630. <member name="M:NAnt.Core.Types.FormatterCollection.#ctor(NAnt.Core.Types.Formatter[])">
  9631. <summary>
  9632. Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class
  9633. with the specified array of <see cref="T:NAnt.Core.Types.Formatter"/> instances.
  9634. </summary>
  9635. </member>
  9636. <member name="M:NAnt.Core.Types.FormatterCollection.Add(NAnt.Core.Types.Formatter)">
  9637. <summary>
  9638. Adds a <see cref="T:NAnt.Core.Types.Formatter"/> to the end of the collection.
  9639. </summary>
  9640. <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to be added to the end of the collection.</param>
  9641. <returns>The position into which the new element was inserted.</returns>
  9642. </member>
  9643. <member name="M:NAnt.Core.Types.FormatterCollection.AddRange(NAnt.Core.Types.Formatter[])">
  9644. <summary>
  9645. Adds the elements of a <see cref="T:NAnt.Core.Types.Formatter"/> array to the end of the collection.
  9646. </summary>
  9647. <param name="items">The array of <see cref="T:NAnt.Core.Types.Formatter"/> elements to be added to the end of the collection.</param>
  9648. </member>
  9649. <member name="M:NAnt.Core.Types.FormatterCollection.AddRange(NAnt.Core.Types.FormatterCollection)">
  9650. <summary>
  9651. Adds the elements of a <see cref="T:NAnt.Core.Types.FormatterCollection"/> to the end of the collection.
  9652. </summary>
  9653. <param name="items">The <see cref="T:NAnt.Core.Types.FormatterCollection"/> to be added to the end of the collection.</param>
  9654. </member>
  9655. <member name="M:NAnt.Core.Types.FormatterCollection.Contains(NAnt.Core.Types.Formatter)">
  9656. <summary>
  9657. Determines whether a <see cref="T:NAnt.Core.Types.Formatter"/> is in the collection.
  9658. </summary>
  9659. <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to locate in the collection.</param>
  9660. <returns>
  9661. <see langword="true"/> if <paramref name="item"/> is found in the
  9662. collection; otherwise, <see langword="false"/>.
  9663. </returns>
  9664. </member>
  9665. <member name="M:NAnt.Core.Types.FormatterCollection.CopyTo(NAnt.Core.Types.Formatter[],System.Int32)">
  9666. <summary>
  9667. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  9668. </summary>
  9669. <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>
  9670. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  9671. </member>
  9672. <member name="M:NAnt.Core.Types.FormatterCollection.IndexOf(NAnt.Core.Types.Formatter)">
  9673. <summary>
  9674. Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Formatter"/> object in the collection.
  9675. </summary>
  9676. <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> object for which the index is returned.</param>
  9677. <returns>
  9678. 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.
  9679. </returns>
  9680. </member>
  9681. <member name="M:NAnt.Core.Types.FormatterCollection.Insert(System.Int32,NAnt.Core.Types.Formatter)">
  9682. <summary>
  9683. Inserts a <see cref="T:NAnt.Core.Types.Formatter"/> into the collection at the specified index.
  9684. </summary>
  9685. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  9686. <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to insert.</param>
  9687. </member>
  9688. <member name="M:NAnt.Core.Types.FormatterCollection.GetEnumerator">
  9689. <summary>
  9690. Returns an enumerator that can iterate through the collection.
  9691. </summary>
  9692. <returns>
  9693. A <see cref="T:NAnt.Core.Types.FormatterEnumerator"/> for the entire collection.
  9694. </returns>
  9695. </member>
  9696. <member name="M:NAnt.Core.Types.FormatterCollection.Remove(NAnt.Core.Types.Formatter)">
  9697. <summary>
  9698. Removes a member from the collection.
  9699. </summary>
  9700. <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to remove from the collection.</param>
  9701. </member>
  9702. <member name="P:NAnt.Core.Types.FormatterCollection.Item(System.Int32)">
  9703. <summary>
  9704. Gets or sets the element at the specified index.
  9705. </summary>
  9706. <param name="index">The zero-based index of the element to get or set.</param>
  9707. </member>
  9708. <member name="T:NAnt.Core.Types.FormatterEnumerator">
  9709. <summary>
  9710. Enumerates the <see cref="T:NAnt.Core.Types.Formatter"/> elements of a <see cref="T:NAnt.Core.Types.FormatterCollection"/>.
  9711. </summary>
  9712. </member>
  9713. <member name="M:NAnt.Core.Types.FormatterEnumerator.#ctor(NAnt.Core.Types.FormatterCollection)">
  9714. <summary>
  9715. Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterEnumerator"/> class
  9716. with the specified <see cref="T:NAnt.Core.Types.FormatterCollection"/>.
  9717. </summary>
  9718. <param name="arguments">The collection that should be enumerated.</param>
  9719. </member>
  9720. <member name="M:NAnt.Core.Types.FormatterEnumerator.MoveNext">
  9721. <summary>
  9722. Advances the enumerator to the next element of the collection.
  9723. </summary>
  9724. <returns>
  9725. <see langword="true" /> if the enumerator was successfully advanced
  9726. to the next element; <see langword="false" /> if the enumerator has
  9727. passed the end of the collection.
  9728. </returns>
  9729. </member>
  9730. <member name="M:NAnt.Core.Types.FormatterEnumerator.Reset">
  9731. <summary>
  9732. Sets the enumerator to its initial position, which is before the
  9733. first element in the collection.
  9734. </summary>
  9735. </member>
  9736. <member name="P:NAnt.Core.Types.FormatterEnumerator.Current">
  9737. <summary>
  9738. Gets the current element in the collection.
  9739. </summary>
  9740. <returns>
  9741. The current element in the collection.
  9742. </returns>
  9743. </member>
  9744. <member name="T:NAnt.Core.Types.ManagedExecution">
  9745. <summary>
  9746. Specifies the execution mode for managed applications.
  9747. </summary>
  9748. <remarks>
  9749. <para>
  9750. For backward compatibility, the following string values can also be
  9751. used in build files:
  9752. </para>
  9753. <list type="table">
  9754. <listheader>
  9755. <term>Value</term>
  9756. <description>Corresponding field</description>
  9757. </listheader>
  9758. <item>
  9759. <term>"true"</term>
  9760. <description><see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/></description>
  9761. </item>
  9762. <item>
  9763. <term>"false"</term>
  9764. <description><see cref="F:NAnt.Core.Types.ManagedExecution.Default"/></description>
  9765. </item>
  9766. </list>
  9767. <para>
  9768. Even if set to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>, the operating system can still
  9769. run the program as a managed application.
  9770. </para>
  9771. <para>On Linux this can be done through <b>binfmt_misc</b>, while on
  9772. Windows installing the .NET Framework redistributable caused managed
  9773. applications to run on the MS CLR by default.
  9774. </para>
  9775. </remarks>
  9776. </member>
  9777. <member name="F:NAnt.Core.Types.ManagedExecution.Default">
  9778. <summary>
  9779. Do not threat the program as a managed application.
  9780. </summary>
  9781. </member>
  9782. <member name="F:NAnt.Core.Types.ManagedExecution.Auto">
  9783. <summary>
  9784. Leave it up to the CLR to determine which specific version of
  9785. the CLR will be used to run the application.
  9786. </summary>
  9787. </member>
  9788. <member name="F:NAnt.Core.Types.ManagedExecution.Strict">
  9789. <summary>
  9790. Forces an application to run against the currently targeted
  9791. version of a given CLR.
  9792. </summary>
  9793. </member>
  9794. <member name="T:NAnt.Core.Types.ManagedExecutionConverter">
  9795. <summary>
  9796. Specialized <see cref="T:System.ComponentModel.EnumConverter"/> that also supports
  9797. case-insensitive conversion of "true" to
  9798. <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/> and "false" to
  9799. <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>.
  9800. </summary>
  9801. </member>
  9802. <member name="M:NAnt.Core.Types.ManagedExecutionConverter.#ctor">
  9803. <summary>
  9804. Initializes a new instance of the <see cref="T:NAnt.Core.Types.ManagedExecutionConverter"/>
  9805. class.
  9806. </summary>
  9807. </member>
  9808. <member name="M:NAnt.Core.Types.ManagedExecutionConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
  9809. <summary>
  9810. Converts the given object to the type of this converter, using the
  9811. specified context and culture information.
  9812. </summary>
  9813. <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
  9814. <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
  9815. <param name="value">The <see cref="T:System.Object"/> to convert.</param>
  9816. <returns>
  9817. An <see cref="T:System.Object"/> that represents the converted value.
  9818. </returns>
  9819. </member>
  9820. <member name="T:NAnt.Core.Types.Option">
  9821. <summary>
  9822. Represents an option.
  9823. </summary>
  9824. </member>
  9825. <member name="M:NAnt.Core.Types.Option.#ctor(System.String,System.String)">
  9826. <summary>
  9827. name, value constructor
  9828. </summary>
  9829. <param name="name"></param>
  9830. <param name="value"></param>
  9831. </member>
  9832. <member name="M:NAnt.Core.Types.Option.#ctor">
  9833. <summary>
  9834. Default constructor
  9835. </summary>
  9836. </member>
  9837. <member name="P:NAnt.Core.Types.Option.OptionName">
  9838. <summary>
  9839. Name of the option.
  9840. </summary>
  9841. </member>
  9842. <member name="P:NAnt.Core.Types.Option.Value">
  9843. <summary>
  9844. Value of the option. The default is <see langword="null" />.
  9845. </summary>
  9846. </member>
  9847. <member name="P:NAnt.Core.Types.Option.IfDefined">
  9848. <summary>
  9849. Indicates if the option should be passed to the task.
  9850. If <see langword="true" /> then the option will be passed;
  9851. otherwise, skipped. The default is <see langword="true" />.
  9852. </summary>
  9853. </member>
  9854. <member name="P:NAnt.Core.Types.Option.UnlessDefined">
  9855. <summary>
  9856. Indicates if the option should not be passed to the task.
  9857. If <see langword="false" /> then the option will be passed;
  9858. otherwise, skipped. The default is <see langword="false" />.
  9859. </summary>
  9860. </member>
  9861. <member name="T:NAnt.Core.Types.OptionCollection">
  9862. <summary>
  9863. Contains a collection of <see cref="T:NAnt.Core.Types.Option"/> elements.
  9864. </summary>
  9865. </member>
  9866. <member name="M:NAnt.Core.Types.OptionCollection.#ctor">
  9867. <summary>
  9868. Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class.
  9869. </summary>
  9870. </member>
  9871. <member name="M:NAnt.Core.Types.OptionCollection.#ctor(NAnt.Core.Types.OptionCollection)">
  9872. <summary>
  9873. Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class
  9874. with the specified <see cref="T:NAnt.Core.Types.OptionCollection"/> instance.
  9875. </summary>
  9876. </member>
  9877. <member name="M:NAnt.Core.Types.OptionCollection.#ctor(NAnt.Core.Types.Option[])">
  9878. <summary>
  9879. Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class
  9880. with the specified array of <see cref="T:NAnt.Core.Types.Option"/> instances.
  9881. </summary>
  9882. </member>
  9883. <member name="M:NAnt.Core.Types.OptionCollection.Add(NAnt.Core.Types.Option)">
  9884. <summary>
  9885. Adds a <see cref="T:NAnt.Core.Types.Option"/> to the end of the collection.
  9886. </summary>
  9887. <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to be added to the end of the collection.</param>
  9888. <returns>The position into which the new element was inserted.</returns>
  9889. </member>
  9890. <member name="M:NAnt.Core.Types.OptionCollection.AddRange(NAnt.Core.Types.Option[])">
  9891. <summary>
  9892. Adds the elements of a <see cref="T:NAnt.Core.Types.Option"/> array to the end of the collection.
  9893. </summary>
  9894. <param name="items">The array of <see cref="T:NAnt.Core.Types.Option"/> elements to be added to the end of the collection.</param>
  9895. </member>
  9896. <member name="M:NAnt.Core.Types.OptionCollection.AddRange(NAnt.Core.Types.OptionCollection)">
  9897. <summary>
  9898. Adds the elements of a <see cref="T:NAnt.Core.Types.OptionCollection"/> to the end of the collection.
  9899. </summary>
  9900. <param name="items">The <see cref="T:NAnt.Core.Types.OptionCollection"/> to be added to the end of the collection.</param>
  9901. </member>
  9902. <member name="M:NAnt.Core.Types.OptionCollection.Contains(NAnt.Core.Types.Option)">
  9903. <summary>
  9904. Determines whether a <see cref="T:NAnt.Core.Types.Option"/> is in the collection.
  9905. </summary>
  9906. <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to locate in the collection.</param>
  9907. <returns>
  9908. <see langword="true"/> if <paramref name="item"/> is found in the
  9909. collection; otherwise, <see langword="false"/>.
  9910. </returns>
  9911. </member>
  9912. <member name="M:NAnt.Core.Types.OptionCollection.Contains(System.String)">
  9913. <summary>
  9914. Determines whether a <see cref="T:NAnt.Core.Types.Option"/> for the specified
  9915. task is in the collection.
  9916. </summary>
  9917. <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Types.Option"/> should be located in the collection.</param>
  9918. <returns>
  9919. <see langword="true"/> if a <see cref="T:NAnt.Core.Types.Option"/> for the specified
  9920. task is found in the collection; otherwise, <see langword="false"/>.
  9921. </returns>
  9922. </member>
  9923. <member name="M:NAnt.Core.Types.OptionCollection.CopyTo(NAnt.Core.Types.Option[],System.Int32)">
  9924. <summary>
  9925. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
  9926. </summary>
  9927. <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>
  9928. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  9929. </member>
  9930. <member name="M:NAnt.Core.Types.OptionCollection.IndexOf(NAnt.Core.Types.Option)">
  9931. <summary>
  9932. Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Option"/> object in the collection.
  9933. </summary>
  9934. <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> object for which the index is returned.</param>
  9935. <returns>
  9936. 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.
  9937. </returns>
  9938. </member>
  9939. <member name="M:NAnt.Core.Types.OptionCollection.Insert(System.Int32,NAnt.Core.Types.Option)">
  9940. <summary>
  9941. Inserts a <see cref="T:NAnt.Core.Types.Option"/> into the collection at the specified index.
  9942. </summary>
  9943. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  9944. <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to insert.</param>
  9945. </member>
  9946. <member name="M:NAnt.Core.Types.OptionCollection.GetEnumerator">
  9947. <summary>
  9948. Returns an enumerator that can iterate through the collection.
  9949. </summary>
  9950. <returns>
  9951. A <see cref="T:NAnt.Core.Types.OptionEnumerator"/> for the entire collection.
  9952. </returns>
  9953. </member>
  9954. <member name="M:NAnt.Core.Types.OptionCollection.Remove(NAnt.Core.Types.Option)">
  9955. <summary>
  9956. Removes a member from the collection.
  9957. </summary>
  9958. <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to remove from the collection.</param>
  9959. </member>
  9960. <member name="P:NAnt.Core.Types.OptionCollection.Item(System.Int32)">
  9961. <summary>
  9962. Gets or sets the element at the specified index.
  9963. </summary>
  9964. <param name="index">The zero-based index of the element to get or set.</param>
  9965. </member>
  9966. <member name="P:NAnt.Core.Types.OptionCollection.Item(System.String)">
  9967. <summary>
  9968. Gets the <see cref="T:NAnt.Core.Types.Option"/> with the specified name.
  9969. </summary>
  9970. <param name="name">The name of the option that should be located in the collection.</param>
  9971. </member>
  9972. <member name="T:NAnt.Core.Types.OptionEnumerator">
  9973. <summary>
  9974. Enumerates the <see cref="T:NAnt.Core.Types.Option"/> elements of a <see cref="T:NAnt.Core.Types.OptionCollection"/>.
  9975. </summary>
  9976. </member>
  9977. <member name="M:NAnt.Core.Types.OptionEnumerator.#ctor(NAnt.Core.Types.OptionCollection)">
  9978. <summary>
  9979. Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionEnumerator"/> class
  9980. with the specified <see cref="T:NAnt.Core.Types.OptionCollection"/>.
  9981. </summary>
  9982. <param name="arguments">The collection that should be enumerated.</param>
  9983. </member>
  9984. <member name="M:NAnt.Core.Types.OptionEnumerator.MoveNext">
  9985. <summary>
  9986. Advances the enumerator to the next element of the collection.
  9987. </summary>
  9988. <returns>
  9989. <see langword="true" /> if the enumerator was successfully advanced
  9990. to the next element; <see langword="false" /> if the enumerator has
  9991. passed the end of the collection.
  9992. </returns>
  9993. </member>
  9994. <member name="M:NAnt.Core.Types.OptionEnumerator.Reset">
  9995. <summary>
  9996. Sets the enumerator to its initial position, which is before the
  9997. first element in the collection.
  9998. </summary>
  9999. </member>
  10000. <member name="P:NAnt.Core.Types.OptionEnumerator.Current">
  10001. <summary>
  10002. Gets the current element in the collection.
  10003. </summary>
  10004. <returns>
  10005. The current element in the collection.
  10006. </returns>
  10007. </member>
  10008. <member name="T:NAnt.Core.Types.PathElement">
  10009. <summary>
  10010. Represents a nested path element.
  10011. </summary>
  10012. </member>
  10013. <member name="P:NAnt.Core.Types.PathElement.File">
  10014. <summary>
  10015. The name of a file to add to the path. Will be replaced with
  10016. the absolute path of the file.
  10017. </summary>
  10018. </member>
  10019. <member name="P:NAnt.Core.Types.PathElement.Directory">
  10020. <summary>
  10021. The name of a directory to add to the path. Will be replaced with
  10022. the absolute path of the directory.
  10023. </summary>
  10024. </member>
  10025. <member name="P:NAnt.Core.Types.PathElement.Path">
  10026. <summary>
  10027. A string that will be treated as a path-like string. You can use
  10028. <c>:</c> or <c>;</c> as path separators and NAnt will convert it
  10029. to the platform's local conventions, while resolving references
  10030. to environment variables.
  10031. </summary>
  10032. </member>
  10033. <member name="P:NAnt.Core.Types.PathElement.IfDefined">
  10034. <summary>
  10035. If <see langword="true" /> then the entry will be added to the
  10036. path; otherwise, skipped. The default is <see langword="true" />.
  10037. </summary>
  10038. </member>
  10039. <member name="P:NAnt.Core.Types.PathElement.UnlessDefined">
  10040. <summary>
  10041. Opposite of <see cref="P:NAnt.Core.Types.PathElement.IfDefined"/>. If <see langword="false"/>
  10042. then the entry will be added to the path; otherwise, skipped.
  10043. The default is <see langword="false"/>.
  10044. </summary>
  10045. </member>
  10046. <member name="P:NAnt.Core.Types.PathElement.Parts">
  10047. <summary>
  10048. Gets the parts of a path represented by this element.
  10049. </summary>
  10050. <value>
  10051. A <see cref="T:System.Collections.Specialized.StringCollection"/> containing the parts of a path
  10052. represented by this element.
  10053. </value>
  10054. </member>
  10055. <member name="T:NAnt.Core.Types.PathSet">
  10056. <summary>
  10057. <para>
  10058. Paths are groups of files and/or directories that need to be passed as a single
  10059. unit. The order in which parts of the path are specified in the build file is
  10060. retained, and duplicate parts are automatically suppressed.
  10061. </para>
  10062. </summary>
  10063. <example>
  10064. <para>
  10065. Define a global <c>&lt;path&gt;</c> that can be referenced by other
  10066. tasks or types.
  10067. </para>
  10068. <code>
  10069. <![CDATA[
  10070. <path id="includes-path">
  10071. <pathelement path="%INCLUDE%" />
  10072. <pathelement dir="${build.dir}/include" />
  10073. </path>
  10074. ]]>
  10075. </code>
  10076. </example>
  10077. </member>
  10078. <member name="M:NAnt.Core.Types.PathSet.#ctor">
  10079. <summary>
  10080. Initializes a new instance of the <see cref="T:NAnt.Core.Types.PathSet"/> class.
  10081. </summary>
  10082. </member>
  10083. <member name="M:NAnt.Core.Types.PathSet.#ctor(NAnt.Core.Project,System.String)">
  10084. <summary>
  10085. Invoked by <see cref="T:NAnt.Core.Element.AttributeConfigurator"/> for build
  10086. attributes with an underlying <see cref="T:NAnt.Core.Types.PathSet"/> type.
  10087. </summary>
  10088. <param name="project">The <see cref="T:NAnt.Core.Project"/> to be used to resolve relative paths.</param>
  10089. <param name="path">The string representing a path.</param>
  10090. </member>
  10091. <member name="M:NAnt.Core.Types.PathSet.ToString">
  10092. <summary>
  10093. Returns a textual representation of the path, which can be used as
  10094. PATH environment variable definition.
  10095. </summary>
  10096. <returns>
  10097. A textual representation of the path.
  10098. </returns>
  10099. </member>
  10100. <member name="M:NAnt.Core.Types.PathSet.AddPath(NAnt.Core.Types.PathSet)">
  10101. <summary>
  10102. Defines a set of path elements to add to the current path.
  10103. </summary>
  10104. <param name="path">The <see cref="T:NAnt.Core.Types.PathSet"/> to add.</param>
  10105. </member>
  10106. <member name="M:NAnt.Core.Types.PathSet.AddPathElement(NAnt.Core.Types.PathElement)">
  10107. <summary>
  10108. Defines a path element to add to the current path.
  10109. </summary>
  10110. <param name="pathElement">The <see cref="T:NAnt.Core.Types.PathElement"/> to add.</param>
  10111. </member>
  10112. <member name="M:NAnt.Core.Types.PathSet.GetElements">
  10113. <summary>
  10114. Returns all path elements defined by this path object.
  10115. </summary>
  10116. <returns>
  10117. A list of path elements.
  10118. </returns>
  10119. </member>
  10120. <member name="M:NAnt.Core.Types.PathSet.TranslatePath(NAnt.Core.Project,System.String)">
  10121. <summary>
  10122. Splits a PATH (with ; or : as separators) into its parts, while
  10123. resolving references to environment variables.
  10124. </summary>
  10125. <param name="project">The <see cref="T:NAnt.Core.Project"/> to be used to resolve relative paths.</param>
  10126. <param name="source">The path to translate.</param>
  10127. <returns>
  10128. A PATH split up its parts, with references to environment variables
  10129. resolved and duplicate entries removed.
  10130. </returns>
  10131. </member>
  10132. <member name="M:NAnt.Core.Types.Pattern.#ctor">
  10133. <summary>
  10134. Initializes a new instance of the <see cref="T:NAnt.Core.Types.Pattern"/> class.
  10135. </summary>
  10136. </member>
  10137. <member name="P:NAnt.Core.Types.Pattern.PatternName">
  10138. <summary>
  10139. The name pattern to include/exclude.
  10140. </summary>
  10141. </member>
  10142. <member name="P:NAnt.Core.Types.Pattern.IfDefined">
  10143. <summary>
  10144. If <see langword="true" /> then the pattern will be used;
  10145. otherwise, skipped. The default is <see langword="true" />.
  10146. </summary>
  10147. </member>
  10148. <member name="P:NAnt.Core.Types.Pattern.UnlessDefined">
  10149. <summary>
  10150. If <see langword="false" /> then the pattern will be used;
  10151. otherwise, skipped. The default is <see langword="false" />.
  10152. </summary>
  10153. </member>
  10154. <member name="T:NAnt.Core.Types.PatternCollection">
  10155. <summary>
  10156. Contains a collection of <see cref="T:NAnt.Core.Types.Pattern"/> elements.
  10157. </summary>
  10158. </member>
  10159. <member name="M:NAnt.Core.Types.PatternCollection.#ctor">
  10160. <summary>
  10161. Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternCollection"/> class.
  10162. </summary>
  10163. </member>
  10164. <member name="M:NAnt.Core.Types.PatternCollection.Clear">
  10165. <summary>
  10166. Removes all items from the <see cref="T:NAnt.Core.Types.PatternCollection"/>.
  10167. </summary>
  10168. </member>
  10169. <member name="M:NAnt.Core.Types.PatternCollection.Add(NAnt.Core.Types.Pattern)">
  10170. <summary>
  10171. Adds a <see cref="T:NAnt.Core.Types.Pattern"/> to the end of the collection.
  10172. </summary>
  10173. <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to be added to the end of the collection.</param>
  10174. <returns>The position into which the new element was inserted.</returns>
  10175. </member>
  10176. <member name="M:NAnt.Core.Types.PatternCollection.AddRange(NAnt.Core.Types.Pattern[])">
  10177. <summary>
  10178. Adds the elements of a <see cref="T:NAnt.Core.Types.Pattern"/> array to the end of the collection.
  10179. </summary>
  10180. <param name="items">The array of <see cref="T:NAnt.Core.Types.Pattern"/> elements to be added to the end of the collection.</param>
  10181. </member>
  10182. <member name="M:NAnt.Core.Types.PatternCollection.AddRange(NAnt.Core.Types.PatternCollection)">
  10183. <summary>
  10184. Adds the elements of a <see cref="T:NAnt.Core.Types.PatternCollection"/> to the end of the collection.
  10185. </summary>
  10186. <param name="items">The <see cref="T:NAnt.Core.Types.PatternCollection"/> to be added to the end of the collection.</param>
  10187. </member>
  10188. <member name="M:NAnt.Core.Types.PatternCollection.Contains(NAnt.Core.Types.Pattern)">
  10189. <summary>
  10190. Determines whether a <see cref="T:NAnt.Core.Types.Pattern"/> is in the collection.
  10191. </summary>
  10192. <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to locate in the collection.</param>
  10193. <returns>
  10194. <see langword="true"/> if <paramref name="item"/> is found in the
  10195. collection; otherwise, <see langword="false"/>.
  10196. </returns>
  10197. </member>
  10198. <member name="M:NAnt.Core.Types.PatternCollection.CopyTo(NAnt.Core.Types.Pattern[],System.Int32)">
  10199. <summary>
  10200. Copies the entire collection to a compatible one-dimensional array,
  10201. starting at the specified index of the target array.
  10202. </summary>
  10203. <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>
  10204. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  10205. </member>
  10206. <member name="M:NAnt.Core.Types.PatternCollection.IndexOf(NAnt.Core.Types.Pattern)">
  10207. <summary>
  10208. Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Pattern"/> object in the collection.
  10209. </summary>
  10210. <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> object for which the index is returned.</param>
  10211. <returns>
  10212. 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.
  10213. </returns>
  10214. </member>
  10215. <member name="M:NAnt.Core.Types.PatternCollection.Insert(System.Int32,NAnt.Core.Types.Pattern)">
  10216. <summary>
  10217. Inserts a <see cref="T:NAnt.Core.Types.Pattern"/> into the collection at the specified index.
  10218. </summary>
  10219. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  10220. <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to insert.</param>
  10221. </member>
  10222. <member name="M:NAnt.Core.Types.PatternCollection.GetEnumerator">
  10223. <summary>
  10224. Returns an enumerator that can iterate through the collection.
  10225. </summary>
  10226. <returns>
  10227. A <see cref="T:NAnt.Core.Types.PatternEnumerator"/> for the entire collection.
  10228. </returns>
  10229. </member>
  10230. <member name="M:NAnt.Core.Types.PatternCollection.Remove(NAnt.Core.Types.Pattern)">
  10231. <summary>
  10232. Removes a member from the collection.
  10233. </summary>
  10234. <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to remove from the collection.</param>
  10235. </member>
  10236. <member name="P:NAnt.Core.Types.PatternCollection.Item(System.Int32)">
  10237. <summary>
  10238. Gets or sets the element at the specified index.
  10239. </summary>
  10240. <param name="index">The zero-based index of the element to get or set.</param>
  10241. </member>
  10242. <member name="T:NAnt.Core.Types.PatternEnumerator">
  10243. <summary>
  10244. Enumerates the <see cref="T:NAnt.Core.Types.Pattern"/> elements of a <see cref="T:NAnt.Core.Types.PatternCollection"/>.
  10245. </summary>
  10246. </member>
  10247. <member name="M:NAnt.Core.Types.PatternEnumerator.#ctor(NAnt.Core.Types.PatternCollection)">
  10248. <summary>
  10249. Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternEnumerator"/> class
  10250. with the specified <see cref="T:NAnt.Core.Types.PatternCollection"/>.
  10251. </summary>
  10252. <param name="arguments">The collection that should be enumerated.</param>
  10253. </member>
  10254. <member name="M:NAnt.Core.Types.PatternEnumerator.MoveNext">
  10255. <summary>
  10256. Advances the enumerator to the next element of the collection.
  10257. </summary>
  10258. <returns>
  10259. <see langword="true" /> if the enumerator was successfully advanced
  10260. to the next element; <see langword="false" /> if the enumerator has
  10261. passed the end of the collection.
  10262. </returns>
  10263. </member>
  10264. <member name="M:NAnt.Core.Types.PatternEnumerator.Reset">
  10265. <summary>
  10266. Sets the enumerator to its initial position, which is before the
  10267. first element in the collection.
  10268. </summary>
  10269. </member>
  10270. <member name="P:NAnt.Core.Types.PatternEnumerator.Current">
  10271. <summary>
  10272. Gets the current element in the collection.
  10273. </summary>
  10274. <returns>
  10275. The current element in the collection.
  10276. </returns>
  10277. </member>
  10278. <member name="P:NAnt.Core.Types.PatternEnumerator.System#Collections#IEnumerator#Current">
  10279. <summary>
  10280. Gets the current element in the collection.
  10281. </summary>
  10282. <returns>
  10283. The current element in the collection.
  10284. </returns>
  10285. </member>
  10286. <member name="T:NAnt.Core.Types.PatternSet">
  10287. <summary>
  10288. A set of patterns, mostly used to include or exclude certain files.
  10289. </summary>
  10290. <remarks>
  10291. <para>
  10292. The individual patterns support <c>if</c> and <c>unless</c> attributes
  10293. to specify that the element should only be used if or unless a given
  10294. condition is met.
  10295. </para>
  10296. <para>
  10297. The <see cref="P:NAnt.Core.Types.PatternSet.IncludesFile"/> and <see cref="P:NAnt.Core.Types.PatternSet.ExcludesFile"/>
  10298. elements load patterns from a file. When the file is a relative path,
  10299. it will be resolved relative to the project base directory in which
  10300. the patternset is defined. Each line of this file is taken to be a
  10301. pattern.
  10302. </para>
  10303. <para>
  10304. The number sign (#) as the first non-blank character in a line denotes
  10305. that all text following it is a comment:
  10306. </para>
  10307. <code>
  10308. <![CDATA[
  10309. EventLog.cs
  10310. # requires Mono.Posix
  10311. SysLogEventLogImpl.cs
  10312. # uses the win32 eventlog API
  10313. Win32EventLogImpl.cs
  10314. ]]>
  10315. </code>
  10316. <para>
  10317. Patterns can be grouped to sets, and later be referenced by their
  10318. <see cref="P:NAnt.Core.DataTypeBase.ID"/>.
  10319. </para>
  10320. <para>
  10321. When used as a standalone element (global type), any properties that
  10322. are referenced will be resolved when the definition is processed, not
  10323. when it actually used. Passing a reference to a nested build file
  10324. will not cause the properties to be re-evaluated.
  10325. </para>
  10326. <para>
  10327. To improve reuse of globally defined patternsets, avoid referencing
  10328. any properties altogether.
  10329. </para>
  10330. </remarks>
  10331. <example>
  10332. <para>
  10333. Define a set of patterns that matches all .cs files that do not contain
  10334. the text <c>Test</c> in their name.
  10335. </para>
  10336. <code>
  10337. <![CDATA[
  10338. <patternset id="non.test.sources">
  10339. <include name="**/*.cs" />
  10340. <exclude name="**/*Test*" />
  10341. </patternset>
  10342. ]]>
  10343. </code>
  10344. </example>
  10345. <example>
  10346. <para>
  10347. Define two sets. One holding C# sources, and one holding VB sources.
  10348. Both sets only include test sources when the <c>test</c> property is
  10349. set. A third set combines both C# and VB sources.
  10350. </para>
  10351. <code>
  10352. <![CDATA[
  10353. <patternset id="cs.sources">
  10354. <include name="src/**/*.cs" />
  10355. <include name="test/**/*.cs" if=${property::exist('test')}" />
  10356. </patternset>
  10357. <patternset id="vb.sources">
  10358. <include name="src/**/*.vb" />
  10359. <include name="test/**/*.vb" if=${property::exist('test')}" />
  10360. </patternset>
  10361. <patternset id="all.sources">
  10362. <patternset refid="cs.sources" />
  10363. <patternset refid="vb.sources" />
  10364. </patternset>
  10365. ]]>
  10366. </code>
  10367. </example>
  10368. <example>
  10369. <para>
  10370. Define a set from patterns in a file.
  10371. </para>
  10372. <code>
  10373. <![CDATA[
  10374. <patternset id="sources">
  10375. <includesfile name="test.sources" />
  10376. <includesfile name="non.test.sources" />
  10377. </patternset>
  10378. ]]>
  10379. </code>
  10380. </example>
  10381. <example>
  10382. <para>
  10383. Defines a patternset with patterns that are loaded from an external
  10384. file, and shows the behavior when that patternset is passed as a
  10385. reference to a nested build script.
  10386. </para>
  10387. <para>
  10388. External file "c:\foo\build\service.lst" holding patterns
  10389. of source files to include for the Foo.Service assembly:
  10390. </para>
  10391. <code>
  10392. <![CDATA[
  10393. AssemblyInfo.cs
  10394. *Channel.cs
  10395. ServiceFactory.cs]]></code>
  10396. <para>
  10397. Main build script located in "c:\foo\default.build":
  10398. </para>
  10399. <code>
  10400. <![CDATA[
  10401. <project name="main" default="build">
  10402. <property name="build.debug" value="true" />
  10403. <patternset id="service.sources">
  10404. <include name="TraceListener.cs" if="${build.debug}" />
  10405. <includesfile name="build/service.lst" />
  10406. </patternset>
  10407. <property name="build.debug" value="false" />
  10408. <target name="build">
  10409. <nant buildfile="service/default.build" inheritrefs="true" />
  10410. </target>
  10411. </project>]]></code>
  10412. <para>
  10413. Nested build script located in "c:\foo\services\default.build"
  10414. which uses the patternset to feed sources files to the C# compiler:
  10415. </para>
  10416. <code>
  10417. <![CDATA[
  10418. <project name="service" default="build">
  10419. <target name="build">
  10420. <csc output="../bin/Foo.Service.dll" target="library">
  10421. <fileset basedir="src">
  10422. <patternset refid="service.sources" />
  10423. </fileset>
  10424. </csc>
  10425. </target>
  10426. </project>]]></code>
  10427. <para>
  10428. At the time when the patternset is used in the "service"
  10429. build script, the following source files in "c:\foo\services\src"
  10430. match the defined patterns:
  10431. </para>
  10432. <code>
  10433. <![CDATA[
  10434. AssemblyInfo.cs
  10435. MsmqChannel.cs
  10436. SmtpChannel.cs
  10437. ServiceFactory.cs
  10438. TraceListener.cs]]></code>
  10439. <para>
  10440. You should have observed that:
  10441. </para>
  10442. <list type="bullet">
  10443. <item>
  10444. <description>
  10445. although the patternset is used from the "service"
  10446. build script, the path to the external file is resolved relative
  10447. to the base directory of the "main" build script in
  10448. which the patternset is defined.
  10449. </description>
  10450. </item>
  10451. <item>
  10452. <description>
  10453. the "TraceListener.cs" file is included, even though
  10454. the "build.debug" property was changed to <b>false</b>
  10455. after the patternset was defined (but before it was passed to
  10456. the nested build, and used).
  10457. </description>
  10458. </item>
  10459. </list>
  10460. </example>
  10461. <seealso cref="T:NAnt.Core.Types.FileSet"/>
  10462. </member>
  10463. <member name="M:NAnt.Core.Types.PatternSet.#ctor">
  10464. <summary>
  10465. Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternSet"/> class.
  10466. </summary>
  10467. </member>
  10468. <member name="M:NAnt.Core.Types.PatternSet.Append(NAnt.Core.Types.PatternSet)">
  10469. <summary>
  10470. Adds a nested set of patterns, or references other standalone
  10471. patternset.
  10472. </summary>
  10473. <param name="patternSet">The <see cref="T:NAnt.Core.Types.PatternSet"/> to add.</param>
  10474. </member>
  10475. <member name="P:NAnt.Core.Types.PatternSet.Include">
  10476. <summary>
  10477. Defines a single pattern for files to include.
  10478. </summary>
  10479. </member>
  10480. <member name="P:NAnt.Core.Types.PatternSet.IncludesFile">
  10481. <summary>
  10482. Loads multiple patterns of files to include from a given file, set
  10483. using the <see cref="P:NAnt.Core.Types.Pattern.PatternName"/> parameter.
  10484. </summary>
  10485. </member>
  10486. <member name="P:NAnt.Core.Ty