Status Mappings

Feb 20, 2024
2 minutes to read

The table below lists mappings for Statuses.

Name

Type

Required?

Description

| | --- | --- | --- | --- | |

StatusMappingInfo.Id

Object (any type)

Yes

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

| |

StatusMappingInfo.Brush

See description

A brush or color that specifies the Status appearance. Specifies the AppointmentStatus.Brush property value. The SchedulerDataStorage.Statuses.BrushSaving property value should correspond to the Brush field’s value type.

BrushSaving equals Auto : A data field mapped to the StatusMappingInfo.Brush property can store values of any supported type. A correct value type is determined automatically.
BrushSaving equals Brush : A data field mapped to the StatusMappingInfo.Brush property must store Brush values (Brushes, HatchBrushes, LinearGradientBrushes, etc.).
BrushSaving equals ColorInstance : A data field mapped to the StatusMappingInfo.Brush property must store System.Drawing.Color type values.
BrushSaving equals ColorString : A data field mapped to the StatusMappingInfo.Brush property must store values that specify colors in the hexadecimal format (e.g., “0xFFFF0000” for red).
BrushSaving equals ArgbColor : A data field mapped to the StatusMappingInfo.Brush 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.
BrushSaving equals Image : A data field mapped to the StatusMappingInfo.Brush property must store Image objects.
BrushSaving equals ImageBytes : A data field mapped to the StatusMappingInfo.Brush property must store byte arrays with images.
BrushSaving equals OleColor : A data field mapped to the StatusMappingInfo.Brush property must store OLE_Color values.

| |

StatusMappingInfo.DisplayName

String

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

| |

StatusMappingInfo.MenuCaption

String

The secondary Status name. Specifies the UserInterfaceObject.MenuCaption property value. Displayed in the “Show Time As” appointment context menu item.

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

Troubleshooting

Error in the Brush mapping (ActualMappingException)

The following error can occur if the SchedulerDataStorage.Statuses.BrushSaving property is set incorrectly:

Error

csharp

DevExpress.XtraScheduler.Internal.ActualMappingException
  HResult=0x80131500
  Message=Error in the Brush mapping

  ...

  Inner Exception 1:
  InvalidCastException: Unable to cast object of type 'System.Drawing.SolidBrush' to type 'System.IConvertible'.

Fix

Set the SchedulerDataStorage.Statuses.BrushSaving property to StatusMappingInfo.Brush.