Text Parameter

This will prompt the user to enter a text value when a force build is requested.

This parameter can then be used by a dynamic value in a task.

Version

Available from version 1.5

Examples

Minimalist example

1<textParameter>
2  <name>Target</name>
3</textParameter>

Full example

 1<textParameter>
 2  <name>Target</name>
 3  <display>Target to Build</display>
 4  <description>Which target do you want to build?</description>
 5  <default>DEV</default>
 6  <minimum>3</minimum>
 7  <maximum>10</maximum>
 8  <required>false</required>
 9</textParameter>

Example in Context

 1<project name="Test Project">
 2  <sourcecontrol type="svn">
 3    <!-- Omitted for brevity -->
 4  </sourcecontrol>
 5  <triggers>
 6    <intervalTrigger />
 7  </triggers>
 8  <tasks>
 9    <!-- Omitted for brevity -->
10  </tasks>
11  <publishers>
12    <!-- Omitted for brevity -->
13  </publishers>
14  <parameters>
15    <textParameter>
16      <name>Target</name>
17      <display>Target to Build</display>
18      <description>Which target do you want to build?</description>
19      <default>DEV</default>
20      <minimum>3</minimum>
21      <maximum>10</maximum>
22      <required>false</required>
23    </textParameter>
24  </parameters>
25</project>

Configuration Elements

Element Description Type Required Default Version
default The default value to use. String No None 1.5
description The description of the parameter. String No None 1.5
display The display name of the parameter. String No None 1.5
required Is the parameter required? Boolean No false 1.5
maximum The maximum allowed length of the parameter. Int32 No 2147483647 1.5
minimum The minimum allowed length. Int32 No 0 1.5
name The name of the parameter. String Yes n/a 1.5

Automatically Generated

Documentation generated on Monday, 26 May 2014 at 7:17:59 AM