PropertyDef Object

See Also

When you define a class for a tool information model, you specify the interfaces that the class implements. For each of those interfaces, you specify the members (properties, methods, and collections) that are attached to the interface.

In order to attach a property to an interface, a property definition must exist for the property. The characteristics of the property (its name, dispatch identifier, data type, and various storage details) are stored in the property definition object. These characteristics are defined by the properties of the property definition object.

To create a new property definition:

  1. Use the CreatePropertyDef method of the InterfaceDef object.

  2. Define any non-default characteristics of your new property definition by manipulating the properties of the property definition object.

  3. Commit your changes to the Repository database.

A PropertyDef object is also a RepositoryObject. In addition to the members described here, PropertyDef objects also provide the members that are defined for Repository objects.

When to Use

Use the PropertyDef object to retrieve or modify the characteristics of a property definition, or to determine which interface exposes a particular property.

Properties

Property Description
APIType The C data type of the property.
ColumnName The name of the column in the SQL table for this property.
DispatchID The dispatch identifier to use when accessing an instance of this type of property.
Flags Flags that specify details about this property definition.
SQLScale The number of digits to the right of the decimal point for a numeric property.
SQLSize The size in bytes of the property.
SQLType The SQL data type of the property.

Collections

Collection Description
Interface The interface to which this property definition is attached.
Properties The collection of all persistent properties that are attached to the PropertyDef object.