User Property Field Types

A user property can be configured for display as one of the following field types:

Text Fields

Suitable for	Single- and multi-line free-form text.
For example	The descriptive text to be displayed when the associated image file is displayed in a slideshow.
Default value	None, i.e. the field is displayed empty.
Saved as	UTF-8 encoded text.
Removed when	The field is empty.

Checkboxes

Suitable for	Boolean values, with presence of the property indicating `TRUE` or `YES`.
For example	A boolean property indicating whether the associated file should be marked as writable when copied to the deployment environment.
Default value	Unchecked, indicating `FALSE` or `NO`.
Saved as	UTF-8 encoded text as specified in the preference pane’s Checked value field.
Removed when	Checkbox is unchecked.
Additional options	Checked value The value assigned to the property when the checkbox is checked. This defaults to “`*`”, which is the convention for boolean Subversion properties, although you can use any text value you want. You can even leave the value empty if appropriate.

Pop-Up Lists

Suitable for	Discrete sets of possible text choices.
For example	A pop-up list property might be used to control how the associated file or folder is deployed, with choices such as “`production`” (the default), “`stage`” and “`dev`”. A deployment script would inspect the value of the property and restrict deployment as appropriate.
Default value	The choice configured as the default in the preference pane’s Choices list.
Saved as	UTF-8 encoded text as specified in Value column for the selected choice in the preference pane’s Choices list.
Removed when	The default value is selected.
Additional options	Choices The possible choices for the property. One choice can be specified as the default. The property will be removed when the default choice is selected. An optional label can be specified for each choice. The choice’s value is displayed if a label is not specified.

Files

Suitable for	Binary data or larger volumes of text.
For example	A small thumbnail image might be stored for the associated large-format image file. A deployment script would extract the thumbnail contents from the properties before copying them to the deployment environment.
Default value	None, i.e. the field is displayed empty.
Saved as	Binary data or UTF-8 encoded text depending on the contents of the original file.
Removed when	The field is empty.
See also	File Properties