All user defined fields for a single appointment.

Version Introduced: 4.1

Usage

Set_Property(OLECtrlEntID, "OLE.ApptFields[ID]", Array)

Values

Array has the following structure:

Pos

Name

Type

Description

<0, 1>FieldNameTextUnique name of a custom field
<0, 2>ValueTextThe field's value


Indices

IndexDescription
IDUnique ID of an existing appointment

Remarks

Every appointment can have custom fields associated with them. Think of it like the User Defined Property feature of OpenInsight. Instead of attaching custom data to a control, you can attach it to an individual appointment. This can make your code a lot cleaner by not having to maintain external lookup structures.

Use this property to set or get all an individual appointment's custom fields. When setting this property, pass an @FM delimited array. Each field will an @VM delimited key/value pair. The only limitation on naming your fields is that you cannot use . or ; characters. Getting this property returns an @FM delimited array in the same format.

Setting custom fields doesn't do anything visibly within the Schedule control. It's simply a convenient way to store additional data.

If you want to set only one field for an appointment, use the ApptField property.

Example

// Set several fields for an appointment
Fields = ""
Fields<1> = "CustomerId":@VM:"0012"
Fields<2> = "JobNum"    :@VM:"A20001"
Fields<2> = "EditForm"  :@VM:"WIN_CONSTRUCTION_JOB"
Set_Property(@Window:".OLE_SCHEDULE", "OLE.ApptFlags[Appt0001]", Fields)

See Also

ApptField

  • No labels