SchedulerControl.HtmlImages Property

Gets or sets the collection of images that can be embedded in the text in appointments using HTML tags.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v24.2.dll

Declaration

C#

[DefaultValue(null)]
[DXCategory("Appearance")]
public object HtmlImages { get; set; }

VB.NET

<DefaultValue(Nothing)>
<DXCategory("Appearance")>
Public Property HtmlImages As Object

Property Value

Type	Default	Description
Object	null	An object that represents an image collection.

Remarks

You can use HTML tags to format the text displayed in appointments. For example, you can display a bold or italic text. To enable HTML tags, use the following properties:

• for a Day View — AllowHtmlText
• for a Week View — AllowHtmlText
• for a Month View — AllowHtmlText
• for a Gantt View — DevExpress.XtraScheduler.GanttViewAppointmentDisplayOptionsEx.AllowHtmlText
• for a Timeline View — AllowHtmlText

To embed an image into a string, assign an image collection to the HtmlImages property. You can use the following objects as image collections:

• ImageList — manages a collection of Image objects.
• ImageCollection — provides additional functionality compared to the ImageList class.
• SharedImageCollection — shares images between multiple controls and forms.
• SvgImageCollection — stores vector images.

Then, use the image tag to refer to an image by its name in the collection. The image will be displayed in the string.

C#

schedulerControl.Views.DayView.AppointmentDisplayOptions.AllowHtmlText = true;
schedulerControl.HtmlImages = svgImageCollection1;
apt2.Description = "Rent this car <image=shipment>";

VB.NET

schedulerControl.Views.DayView.AppointmentDisplayOptions.AllowHtmlText = True
schedulerControl.HtmlImages = svgImageCollection1
apt2.Description = "Rent this car <image=shipment>";