|
Property Name
|
Applicable attribute data types
|
Description
|
Preference
(The configuration applies to all attributes, in all clients)
|
Type and Attribute Management utility Attribute Definition
|
Type and Attribute Management utility Attribute Panel Layout Definition
|
|
Default Value Display Mode
|
All data types
|
Configures how to populate the default value, if any, in the input field for the attribute.
Defaults to “Pre-populate”.
Possible values:
• None – the default value will not be used to populate the input field
• Pre-Populate – the default value, if one is set, will be set in the input field
• Button – A button will be displayed after the input field, the user can click the button to add the default value to the input field.
|
Available as a Site level preference in the Attribute Handling category.
|
If not specified, the value of the preference “Default Value Display Mode” will be used.
|
If not specified, the value of this property from the Attribute Definition will be used, if one has been specified. Otherwise, the value of the preference will be used.
OR
setDefaultValueDisplayMode()
|
|
Selection List UI Style
|
All attributes that have a Legal Value List constraint or an Enumerated Value List constraint defined.
|
Specifies whether the legal values (selection list) for the attribute should be displayed as a drop-down list or as a set of radio-buttons, when the attribute is presented for data entry.
Defaults to “Drop Down List”.
Possible values:
• Drop Down List – the values will be rendered in a drop down list, where the user can select one option
• Radio Buttons – the values will be rendered as a set of radio buttons, where the user can select one option
|
Available as a Site level preference.
Note: Applies to all attributes, except Boolean attributes. AT this level, the style for Boolean attributes is controlled by the preference Boolean Style.
|
If not specified, the value of the preference “Selection List Style” will be used.
|
If not specified, the value of this property from the Attribute Definition will be used, if one has been specified. Otherwise, the value of the preference will be used.
OR
setSelectionListStyle()
|
|
Boolean Style
|
Boolean
|
Controls how Boolean attributes are displayed for input, either as radio buttons or as a dropdown list.
Defaults to “Radio Buttons”.
Possible values:
• Drop Down List – the values will be rendered in a drop down list, where the user can select one option
• Radio Buttons – the values will be rendered as a set of radio buttons, where the user can select one option
|
Available as a Site level preference.
|
Use the property “Selection List Style” to override the value of this preference for a specific attribute.
If not specified, the value of the preference “Boolean Style” will be used.
|
If not specified, the value of the property “Selection List Style” from the Attribute Definition will be used, if one has been specified. Otherwise, the value of the preference will be used.
OR
setSelectionListStyle()
|
|
String Length Threshhold For Multiline Input
|
String
|
Specifies the threshold for rendering a multi-line input field for a String attribute. The value can be any positive number. If the maximum length of the attribute in characters exceeds this value, a multiline input field will be displayed for data entry.
Defaults to 60.
|
Available as a Site level preference.
|
If not specified, the value of the preference “String Length Threshold for Multiline Input” will be used.
|
If not specified, the value of this property from the Attribute Definition will be used, if one has been specified. Otherwise, the value of the preference will be used.
setStringLengthThreshholdForMultilineInput()
|
|
Input Field Type
|
String
|
Specifies whether the input field for the attribute should be single-line or multi-line. This directive will override that of the stringLengthThresholdForMultilineInput.
Possible values:
• Single Line – a textbox will be rendered for this attribute
• Multiple Lines – a text area will be rendered for this attribute
|
Not available at this level
|
If not specified, this property is not assigned a default value.
|
If not specified, the value of this property from the Attribute Definition will be used, if one has been specified.
OR
setInputFieldType()
|
|
Date Input Field Type
|
Date
|
Specifies whether the input field for a Timestamp attribute is of type date-only or date & time, so that the UI components can be created accordingly.
The default is “Date Only”.
Possible values:
• Date Only – Allow the user to only set the date portion.
• Date and Time – Allow the user to set both the date and time portion.
|
Not available at this level.
|
If not specified, the default will be used.
|
If not specified, the value of this property from the Attribute Definition will be used, if that has been specified. Otherwise the default will be used.
OR
setDateInputFieldType()
|
|
Date Display Format
|
Date
|
A date format string (i.e. yyyy-mm-dd) to use when displaying the value of this attribute in View mode. This does not affect the format used to set the value in input mode.
Please refer to the Java class java.text.SimpleDateFormat for the full set of valid characters.
If not set, one of the following formats will be used from the rbInfo file componentRB:
• STANDARD_DATE_DISPLAY_FORMAT – if the value of the property “Date Input Field Type” is set to “Date Only”, this format will be used.
• STANDARD_DATE_TIME_ZONE_DISPLAY_FORMAT – if the value of the property “Date Input Field Type” is not set or is set to “Date and Time”, this format will be used.
|
Not available at this level.
|
If not specified, the default will be used.
|
If not specified, the value of this property from the Attribute Definition will be used, if that has been specified. Otherwise the default will be used.
OR
setDateDisplayFormat()
|
|
Local Time Zone
|
Date
|
Specifies the time zone to use for Date attributes that display both the Date and Time portions (i.e. yyyy-MM-dd hh:mm zzz). This is only used in view mode; it is not used for input mode.
|
Available as a User level preference
|
Not available at this level.
|
Not available at this level.
|
|
Measurement system
|
Real Number with Units
|
Specifies the measurement system to use for Real Numbers with Units.
|
Available as a User level preference
|
Not available at this level.
|
Not available at this level.
|
|
Create Hyperlinks
(in 9.x this was called Ignore URL values in strings)
|
String
|
Specifies whether URL style text embedded in the value of a String attribute should be displayed as a hyperlink in the view mode (example: http://www.ptc.com).
Defaults to ‘true’.
|
Available as a Site level preference
|
Note: When upgrading from 9.x to 10.0, if this property were customized using the file AllClient.xml, manual migration is needed.
If not specified, the value of the preference “Create Hyperlinks” will be used.
|
Not available at this level.
|
|
Percent
|
Numeric
|
Specifies if a numeric value is to be displayed as a percentage or not. This property is only used in view mode. When specified, the notation used will be locale-specific.
Defaults to false.
|
Not available at this level.
|
If not specified, the default will be used.
|
If not specified, the value of this property from the Attribute Definition will be used, if that has been specified. Otherwise the default will be used.
OR
setPercent()
|
|
Currency
|
Numeric
|
Specifies if a numeric value is to be displayed as currency value or not. This property is only used in view mode. When specified, the notation used will be locale-specific.
Defaults to false.
|
Not available at this level.
|
If not specified, the default will be used.
|
If not specified, the value of this property from the Attribute Definition will be used, if that has been specified. Otherwise the default will be used.
OR
setCurrency()
|
|
Input Required
|
All
|
Used to mark attributes as ‘Required fields’ even though they may not have a ‘Required’ constraint. This property is used purely for the UI rendering.
Unlike the “Required constraint”, this will not trigger any server-side validation.
Note: If an attribute that has a ‘Required constraint’ is marked as “not required” using this property, a server-side exception will be thrown, unless the server-side code takes care of setting the value for the attribute by some other means.
The most common usage of this property is to force the user to provide a value for an attribute that does not have a “required constraint” defined on it.
|
Not available at this level.
|
Not available
|
If not specified, the default will be used.
OR
setInputRequired()
|
|
Is Info Page Link
|
‘Name’,
‘Number’ and Principal attributes only
|
Specifies if the attribute is to be displayed as a hyperlink to the Information Page. In the case of Principal attributes, this will be displayed as a link to the principal’s info page.
When not specified, the following defaults are used:
• ‘true’ for Number and Container name
• ‘false’ for all other attributes
|
Not available at this level.
|
Not available at this level.
|
If not specified, the default will be used.
OR
setInfoPageLink()
|
|
Delimiter for multivalued attributes
|
Specifies the character(s) to use as a separator when displaying the values of an attribute that contain multiple values. This applies only to Global Attributes since they are the only type of attributes that can have multiple values assigned to an attribute. Defaults to a comma followed by a space.
|
Available as a Site level preference
|
Not available at this level.
|
Not available
|
|
|
Text Input Columns
|
An integer value that specifies the width to render the Text Area in create or edit mode. This only applies to String attributes and is only used when the property “Input Field Type” is set to “Multiple Lines”
|
Not available at this level.
|
Not available at this level.
|
If not specified, the width defaults to the value specified by Windchill UI standards and the attribute’s String Length Constraint.
|
|
|
Text Input Rows
|
An integer value that specifies the height to render the Text Area in create or edit mode. This only applies to String attributes and is only used when a multi-line input field is required based on the properties String Length Threshhold For Multiline Input and Input Field Type.
|
Not available at this level.
|
Not available at this level.
|
If not specified, the number of rows is based on the String Length Constraint and the width of the column. The max number of rows is limited to 3. A scroll bar is added when the input exceeds 3 rows.
OR
setTextInputRows()
|
|
|
Include Blank Option
|
Specifies whether a blank option should be added as the first entry of a dropdown list that displays the legal value list of an attribute.
When the legal values are displayed as a set of radio-buttons, a button with the label “Undefined” will be added as the first button in the list.
Default to true.
|
Not available at this level.
|
Not available at this level.
|
If not specified, the value defaults to true.
OR
setIncludeBlankOption()
|
|
|
isRenderAllStates
|
Lifecycle state attributes only
|
Specifies whether to render all the lifecycle states instead of just the current state.
NOTE: This attribute is applicable to components with component type of SIMPLE or TABLE only.
Default to false.
|
Not available at this level.
|
Not available at this level.
|
If not specified, the value defaults to false.
OR
setRenderAllStates()
|
|
Distinguish WIP Versions
|
Revision attribute only
|
Specifies whether to distinguish between the checked-out original and the working copy.
|
Not available at this level.
|
Not available at this level.
|
If not specified, the value defaults to false.
OR
setDistinguishWIPVersions()
|
|
Character Entry Limit
|
Species the maximum number of characters that can be entered in the UI for a String attribute.
|
Not available at this level.
|
Not available at this level.
|
setCharacterEntryLimit()
|
|
|
Data Utility ID
|
The id to use for data utility lookup. When unspecified, the descriptor id is used for the lookup.
|
Not available at this level.
|
Not available at this level.
|
setDataUtilityId()
|
|
|
Need
|
The logical name of an object attribute needed to create the display value for a column cell.
Used by data utilities for retrieving the cell value when the property/column id is not an attribute name defined by introspection or logical attributes. Use a comma-separated list if multiple attributes are needed.
|
Not available at this level.
|
Not available at this level.
|
setNeed()
|
|
|
Target Object
|
The target object to use for this column when it is processed by the Windchill Client Architecture infrastructure. By configuring the targetObject property, the developer tells the infrastructure to use an alternate row object that is derived from the backing row object returned by the underlying api.
|
Not available at this level.
|
Not available at this level.
|
ComponentConfig.setTargetObject()
|
|
|
Label
|
Used to set the label of an attribute
|
Not available at this level.
|
Use the display name on the attribute definition.
|
setLabel()
|
|
|
Mode
|
The mode in which the attribute will be displayed. There are 3 modes available: Create, Edit and View
|
Not available at this level.
|
Not available at this level.
|
setMode()
|