SIMPOL Documentation

ppcstype1field

Description

Objects of type ppcstype1field represent a field in a database file in a PPCS database file, and provide information that may be needed about the field.

Type Tags

db1field

Object Value

Objects of type ppcstype1field have no value, and it is an error to try to get or set this value.

Properties

PropertyTypeDescription
SBLdisplayformatstring For a non-text field this contains the format string for the field. If the field is a text (string) field, then the boolean value is .nul.
_type(*) This property is provided for use by the user to attach any object of any type to the type in which this property is provided.
__type(*) This property is provided for use by the user to attach any object of any type to the type in which this property is provided. It has the additional feature of being marked with the resolve keyword, so that object resolution can continue down this property.
allowreturnsboolean Contains a boolean indicator showing whether or not the field is intended to contain carriage returns in its contents. If the field is not a text (string) field, then the boolean value is .nul.
commentstring Contains the comment for the field.
datatypetype Contains a reference to the type object that describes the type of data that the field contains.
fileppcstype1file Contains a reference to the ppcstype1file object for the file that contains this field. This is the same as the table property.
helpstring Contains the custom help for the field.
indexppcstype1index If this field is indexed then this property contains a reference to the ppcstype1index object for that index, otherwise it contains .nul.
logicalboolean Contains a boolean indicator showing whether or not the field is intended to contain a logical flag. If the field is not a text (string) field, then the boolean value is .nul.
maxlengthinteger Contains the maximum length of text that the field can contain. If the field is not a text (string) field, then the value is .nul.
namestring Contains the name of the field.
nextppcstype1field Contains a reference to the next ppcstype1field object for the file. The ppcstype1field objects for a table form a closed loop that is linked by this property.
readonlyboolean Contains a boolean indicator showing whether or not the field is read only. A field that is read only can have values assigned to it but is not intended to allow input by the user.
requiredboolean Contains a boolean indicator showing whether or not the field has to contain a value before the record can be saved.
tableppcstype1file Contains a reference to the ppcstype1file object for the file that contains this field. This is the same as the file property.
typetype Specifies the ppcstype1field type object.