Click or drag to resize

ObjectPropertyInfo Class

This class aggregates information about a single property that is exposed from ObjectProxy
Inheritance Hierarchy
SystemObject
  Articy.ApiObjectPropertyInfo

Namespace:  Articy.Api
Assembly:  QueryLayer (in QueryLayer.dll) Version: 1.0.0
Syntax
C#
public class ObjectPropertyInfo

The ObjectPropertyInfo type exposes the following members.

Properties
  NameDescription
Public propertyDataSubType
The data type of the object
Public propertyDataType
The data type of the object
Public propertyDisplayName
the display name of the property
Public propertyEnumDisplayNames
if the property is an enum, this member is not null and contains an dictionary to look up display names of enum technical names.
Public propertyEnumValues
if the property is an enum, this member is not null and contains an dictionary to look up technical/symbol names for given enum values
Public propertyIsCalculated
Denotes if the property is calculated from other properties.
Public propertyIsCustomProperty
Denotes if the property was introduced by an feature (true) or is a property that is exposed by the object itself (false)
Public propertyName
the name of the property
Public propertyReadOnly
Denotes if the property can be changed. This member is fixed for a property an never changes. The ReadOnly member of ObjectProxy can change its state when the object is claimed. All calculated or synthetic properties are always readonly, some other properties might be readonly to preserve data consistency.
Public propertySupportsExpressoScript
Denotes if the property can be parsed as expresso-script (only used by text properties)
Top
Methods
  NameDescription
Public methodGetDisplayNameOfEnumValue
Convenience method to convert a value from an enum property (as returned from the get indexer) to its display name of the enumeration.
Public methodGetNameOfEnumValue
Convenience method to convert a value from an enum property (as returned from the get indexer) to its technical name of the enumeration.
Top
See Also