Page Comparison

...

Name

Required

Description

Value

type

yes

Used to specify what kind of field you want to place.

Any valid field type

variable

yes, if input field

The variable that should be substituted with the user input.

A variable name.

conditionid

no

The ID of a condition in install.xml which must evaluate to true in order to display the field.

A valid condition id in install.xml.

tooltip no The ID of a string to be displayed as the tooltip for the GUI components in this field. The id of a string from langpacks.

omitFromAuto

no

Whether to omit the field variable's value from being written to the auto-install.xml record initiated from the FinishPanel (if used). Needs to be set on the 'spec' tag.

<field type="password" variable="sql.password">
   <spec omitFromAuto="false">
      <pwd txt="Password:" size="20" />
   </spec>
</field>

true, false

default: true for "password" fields, otherwise falsereadonly

no

The readonly attribute reverses the displayHidden logic described below - readonly="true" means to display a field read-only in general in case it is not disabled by a general field condition.

Code Block

language	xml
title	Example of the readonly field attribute
collapse	true

<panel id="panel.dbsettings">
  <field ... readonly="true">
  </field>
...
</panel>

true, false

default: false

readonlyCondition

no

The readonlyCondition attribute enhances and replaces the readonly condition and makes the related behavior dependent on another condition. Thus, the related field gets displayed read-only only if it is not disabled by a general field condition and the condition defined by readonlyCondition gets true.

Code Block

language	xml
title	Example of the readonlyCondition field attribute
collapse	true

<panel id="panel.dbsettings" >
  <field ... readonlyCondition="isReadOnlyField">
  </field>
...
</panel>

true, false

default: false

displayHidden

no

Enables to "grey out" the field not matching its specific condition. Makes just sense if a conditionid has been defined.

Setting displayHidden attribute in the that specific field within the panel be shown regardless of what the field's conditionid evaluates to. But if the conditionid evaluates to false, display the field as disabled instead of hiding it.

Code Block

language	xml
title	Example of the displayHidden field attribute
collapse	true

<panel id="a.panel">
	<field type="check" variable="b" conditionid="b.cond" displayHidden="true">
    	<spec id="b.id" true="true" false="false"/>
	</field>
	<field type="check" variable="c" conditionid="c.cond">
	    <spec id="c.id" true="true" false="false"/>
	</field>
<panel>

true, false

default: false

displayHiddenCondition

no

The displayHiddenCondition attribute enhances and is an alternative to the displayHidden condition and makes the related behavior dependent on another condition. Thus, the related field gets displayed read-only only if a general condition on that field disables it for displaying and the condition defined by displayHiddenCondition gets true.

Code Block

language	xml
title	Example of the displayHiddenCondition field attribute
collapse	true

<panel id="b.panel">
	<field type="check" variable="b" conditionid="b.cond" displayHiddenCondition="isDisplayHiddenField">
    	<spec id="b.id" true="true" false="false"/>
	</field>
	<field type="check" variable="c" conditionid="c.cond">
	    <spec id="c.id" true="true" false="false"/>
	</field>
<panel>

true, false

default: false

summaryKey no Id of a string that represents what name to display in the SummaryPanel of the UserInputPanel for this field. This attribute must be defined if you would like to summarize information about the user input made in this field in the SummaryPanel. Note that you will have to add the summaryKey attribute to the panel element itself also if you would like those to show up the field information in the SummaryPanel as well.

...

Attributes of the <spec> element:

Attribute	Description	Required	Possible Values	Default Value
id	Unique identifier, used for finding field label translations.	yes (if `txt` not defined)	any string	-
txt	Default label text, overridden by existing translations.	yes (if `id` not defined)	any string	-
`size`	Field size in characters for all text edit fields.	no	positive integer	-
`set`	The set attribute forces the contents of the field whenever the panel is reached during navigating, even if the user has chosen a different value when the panel already appeared before. Variable references in the attribute's value are dynamically resolved during an installation.	no	true \| false	(the current variable value is used if defined)
`default`	The default attribute is the default for the contents of the field whenever the panel is reached during navigating, in case the underlying field variable is not defined during an installation at this state. Variable references in the attribute's value are dynamically resolved during an installation.	no	true \| false	(the current variable value is used if defined)
omitFromAuto	Whether to omit the field variable's value from being written to the auto-install.xml record initiated from the FinishPanel (if used). Needs to be set on the 'spec' tag. `<field type="password" variable="sql.password">` `<spec omitFromAuto="false">` `<pwd txt="Password:" size="20" /> </spec> </field>`	no	true \| false	true for "password" fields, otherwise false

Example

In the following example, the variables: name1, name2, name3 will be substituted.

...

Versions Compared

Old Version 26

New Version 27

Key