3.46 FieldDefinition

Defines a field for an Account, AddressBook, or DocumentLibrary.

3.46.1 Properties

The following table lists properties along with their access and descriptions.

Property

Access

Description

Application

R/O

Application. The Application object.

FieldID

R/O

Long. Field identifier.

FieldType

R/O

Enum (FieldTypeConstants). The type of field this FieldDefinition object defines. The only valid FieldType for a Field object in an AddressBook is String.

HasLookupTable

R/O

Boolean. TRUE if the field has a lookup table associated with it.

Hidden

R/O

Boolean. TRUE if the field is hidden. If the field is hidden, it will not show up in any User Interface (UI).

MaximumLength

R/O

Long. The maximum string length of the field.

MaximumValue

R/O

Long. The maximum numerical value the field can have.

MinimumValue

R/O

Long. The minimum numerical value the field can have.

Name

R/O

DEFAULT. String. The name of the field being defined. This property is case-sensitive and must match an existing Name property in the Field object.

Parent

R/O

FieldDefinitions collection. The FieldDefinitions collection that owns this object.

ReadOnly

R/O

Boolean. TRUE if the field is read-only (i.e. the field’s Value property cannot be changed).

RelatedFieldDefinition

R/O

FieldDefinition. A FieldDefinition object related to this one which constrains the values this field definition can have.

Required

R/O

Boolean. TRUE if the field is a required field (i.e. a value must be assigned to the field’s Value property).

StringCase

R/O

Enum (FieldDefinitionCase). The string case of the field.

3.46.2 Methods

Delete()

Deletes this field definition from the parent collection or deletes a field definition that is associated with the Account or DocumentLibrary objects. It will not delete a field definition that is associated with the AddressBook object.

LookupTableEntries GetLookupTable([VARIANT Value])

Returns the lookup table entries associated with this field definition and restricted by the given Value. Value can be either a string or a Field object. If Value is a string, returns the lookup table entries, restricted by Value. If Value is a Field object, returns the lookup table entries, restricted by the field’s Value property.

3.46.3 Remarks

A FieldDefinition object is refreshed when its parent is refreshed.