Label Mappings

  • 2 minutes to read

The table below lists mappings for Labels.

Name

Type

Required?

Description

LabelMappingInfo.Id

Object (any type)

Yes

The unique Label ID. Specifies the UserInterfaceObject.Id property value.

LabelMappingInfo.Color

See description

No

The Label's background color. Specifies the AppointmentLabel.Color property value. The SchedulerDataStorage.Labels.ColorSaving property value should correspond to the Color field's value type.

  • ColorSaving equals Auto: A data field mapped to the LabelMappingInfo.Color property can store values of any supported type. A correct value type is determined automatically.
  • ColorSaving equals ColorInstance: A data field mapped to the LabelMappingInfo.Color property must store System.Drawing.Color type values.
  • ColorSaving equals ColorString: A data field mapped to the LabelMappingInfo.Color property must store string values that specify colors in the hexadecimal format (e.g., "0xFFFF0000" for red).
  • ColorSaving equals OleColor: A data field mapped to the LabelMappingInfo.Color property must store OLE_Color values.
  • ColorSaving equals ArgbColor: A data field mapped to the LabelMappingInfo.Color property must store 32-bit ARGB values (integer values in the "AARRGGBB" format, e.g. "-65536" for red). You can retrieve integer ARGB values using the Color.ToArgb method.

LabelMappingInfo.DisplayName

String

No

The primary Label name. Specifies the UserInterfaceObject.DisplayName property value. Displayed in the Edit Appointment dialog.

Scheduler - Label Name

LabelMappingInfo.MenuCaption

String

No

The secondary Label name. Specifies the UserInterfaceObject.MenuCaption property value. Displayed in the "Label As" appointment context menu item.

Scheduler - Label Menu Name

If this property is not mapped, the "Label As" menu shows no item captions.

Scheduler - Label Menu Name No Mapping

You can map the MenuCaption and DisplayName properties to the same data source field.