User Guide

Metadata tags 59
The following table describes the properties of the [Inspectable] metadata tag:
Property Type Description
category
String Groups the property into a specific subcategory in the Property
inspector of the Flex Builder user interface. The default category is
"Other".
defaultValue
String or
Number
Sets the initial value in the editor that appears in the Property
Inspector when you modify the attribute. The default value is
determined from the property definition.
enumeration
String Specifies a comma-delimited list of legal values for the property.
Only these values are allowed; for example,
item1, item2, item3.
This information appear as code hints and in the Property Inspector.
If you define a Boolean variable, Flex Builder automatically shows
true and false without you having to specifying them using
enumeration.
environment
String Specifies which inspectable properties should not be allowed (none),
which are used only for Flex Builder (
Flash), and which are used only
by Flex and not Flex Builder (
MXML).
format
String Determines the type of editor that appears in the Property Inspector
when you modify the attribute. You can use this property when the
data type of the attribute is not specific to its function. For example,
for a property of type Number, you can specify
format="Color" to
cause Flex Builder to open a color editor when you modify the
attribute. Common values for the
format property include "Length",
"Color", "Time", "EmbeddedFile", and "File".
listOffset
Number Specifies the default index into a List value.
name
String Specifies the display name for the property; for example, Font Width.
If not specified, use the property’s name, such as
_fontWidth.
type
String Specifies the type specifier. If omitted, use the property’s type. The
following values are valid:
•
Array
•
Boolean
•
Color
• Font Name
•
List
•
Number
•
Object
•
String
If the property is an Array, you must list the valid values for the Array.