Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

Property

Synopsis

struct Property {
    string propClass;
    string propName;
    string propText;
    PropertyType type;
    int width;
    int digits;
    int decDigits;
    boolean visible;
    boolean editable;
    boolean addValues;
    boolean choiceList;
    PropertyValue value;
    Interval[]      intervals;
    boolean multiLine
}

See also: PropertyType, PropertyValue, Interval

The Property structure contains all available information about a property, except for the choice list if there is one. It contains the following fields:

propClass

The property class is a symbolic name used to classify properties. Property class and property name uniquely identify the property with respect to the article. The property class names stored in this field correspond to the property class name stored in the name field of the PropertyClass structure (§PropertyClass).

propName

The property name is the symbolic name of the property. The property name is unique relative to the property class, but there is no guarantee that no two properties of an article have the same property name.

propText

The property text is a short human readable description of the property, suitable for use in a tabular property editor. The language of the text depends on the configuration of the current session and the languages available in the product data.

type

This is the fundamental type of the property. See PropertyType.

The value of this field will never change for a particular property.

width

This is the maximum number of characters for properties of type Character. For other property types the value of this field is undefined and should not be used.

The value of this field will never change for a particular property.

digits

This is the maximum number of significant decimal digits for properties of type Numeric and Length. For other property types the value of this field is undefined and should not be used.

The value of this field will never change for a particular property.

decDigits

For properties of type Number and Length, this is the number of decimal digits right of the decimal point (the precision). For other property types the value of this field is undefined and should not be used.

The value of this field will never change for a particular property.

visible

This field indicates whether the property should be displayed by a property editor1. The value of this field may change depending on the current configuration.

editable

This field indicates whether the property may be changed by the client2. It should be ignored for invisible properties. The value of this field may change depending on the current configuration.

The field editable is always true if field visible is false. The OFML API does not allow to differentiate between editable and read-only invisible properties, and EAIWS does not prevent the client from setting the value of an invisible property, so the value true is more appropriate.

addValues

This field indicates whether the property may assume values (and may be set by the client to a value) other then the values found in the choice list of the property. For numeric and length properties, the restrictions imposed by possible intervals are not affected by the value of this field.

choiceList

This field indicates whether a property has a choice list. Unless the field addValues is true a choice list restricts the allowed property values to the elements of the choice list. The value of this field may change depending on the current configuration.

value

This field contains information about the current value of the property. See PropertyValue.

intervals

This field contains a sequence of intervals. For numeric and length properties this sequence may contain one or more elements defining the allowed set of values for this property. For properties of other types this sequence is always empty.

The allowed set of values of a property, and thus the intervals, may change depending on the current configuration.

Footnotes

  1. The visible field is not used to mark properties that have been explicitly hidden by the relation knowledge as invisible, as such properties are not returned by the getArticleData operation. Instead, it is used to support properties that may affect the graphical representation of the article but are not to be displayed by a property editor. ↩

  2. The property may be marked editable even if the value of the property cannot really be changed, as may be the case if the current value is the only element of the properties choice list and the property does not allow additional values. ↩