DescriptiveProperty

All Superinterfaces:

Property<T>, java.io.Serializable

All Known Subinterfaces:

AlarmProperty<T>, ConfigurationProperty<T>, NotificationProfileProperty<T>

All Known Implementing Classes:

AlarmModeProperties, AssociatedData, BasicAlarmProperty, BasicConfigurationProperty, BasicDescriptiveProperty, BasicNotificationProfileProperty, CommonAlarmProperties, CommonAlarmProperties.CalculatedAlarmProperty, WellKnownAlarmProperties, ZoneTraitDescriptor
```
public interface DescriptiveProperty<T>
extends Property<T>
```
Extends Property with a few additional fields that can be used to make display nicer.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`LocalizedString`	`getCategory()`	The category under which this property will be placed when editing.
`LocalizedString`	`getDescription()`	Optional description/documentation for the property.
`LocalizedString`	`getDisplayName()`	A friendly display name for the property.

Methods inherited from interface com.inductiveautomation.ignition.common.config.Property
getDefaultValue, getName, getType

- Method Detail
  - getDisplayName
```
LocalizedString getDisplayName()
```
    A friendly display name for the property. If not set, will return a raw LocalizedString that contains the property name.
  - getCategory
```
LocalizedString getCategory()
```
    The category under which this property will be placed when editing.
  - getDescription
```
LocalizedString getDescription()
```
    Optional description/documentation for the property. May return null if no information is available.