Boolean Parameter

This will prompt the user to enter a boolean 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

<booleanParameter>
  <name>Target</name>
  <true>Yes</true>
  <false>No</false>
</booleanParameter>

Full example

<booleanParameter>
  <name>Target</name>
  <true name="PROD">Yes</true>
  <false name="DEV">No</false>
  <display>Production Build</display>
  <description>Do you want to generate a production build?</description>
  <default>DEV</default>
  <required>false</required>
</booleanParameter>

Example in Context

<project name="Test Project">
  <sourcecontrol type="svn">
    <!-- Omitted for brevity -->
  </sourcecontrol>
  <triggers>
    <intervalTrigger />
  </triggers>
  <tasks>
    <!-- Omitted for brevity -->
  </tasks>
  <publishers>
    <!-- Omitted for brevity -->
  </publishers>
  <parameters>
    <booleanParameter>
      <name>Target</name>
      <true name="PROD">Yes</true>
      <false name="DEV">No</false>
      <display>Production Build</display>
      <description>Do you want to generate a production build?</description>
      <default>DEV</default>
      <required>false</required>
    </booleanParameter>
  </parameters>
</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
false	The value to use when the parameter is false. If the name attribute is set, then the user will see that as the selection value. Otherwise the actual value will be displayed.	Named Value	Yes	n/a	1.5
required	Is the parameter required?	Boolean	No	false	1.5
name	The name of the parameter.	String	Yes	n/a	1.5
true	The value to use when the parameter is true. If the name attribute is set, then the user will see that as the selection value. Otherwise the actual value will be displayed.	Named Value	Yes	n/a	1.5

Automatically Generated

Documentation generated on Sunday, 28 Mar 2010 at 7:44:29 PM
Using assembly version 1.6.7025.1

Document generated by Confluence on Jan 23, 2011 08:52