SchedulerResourceHeaderOptions.ResourceHeaderHtmlTemplate Property
Returns the template applied to the resource header area.
Namespace: DevExpress.XtraScheduler
Assembly: DevExpress.XtraScheduler.v24.1.dll
NuGet Package: DevExpress.Win.Scheduler
Declaration
[XtraSerializableProperty(XtraSerializationVisibility.Content, XtraSerializationFlags.DefaultValue)]
public SchedulerHtmlTemplateItem ResourceHeaderHtmlTemplate { get; }
Property Value
Type | Description |
---|---|
DevExpress.XtraScheduler.SchedulerHtmlTemplateItem | The template applied to the resource header area. |
Property Paths
You can access this nested property as listed below:
Object Type | Path to ResourceHeaderHtmlTemplate |
---|---|
SchedulerOptionsView |
|
Remarks
The Scheduler Control displays resource headers when appointments are grouped by resources (the View.GroupType property equals “Resource”).
Note that the template does not occupy the entire header client area. If you wish to stretch a template across the entire client region, draw it on the CustomDrawResourceHeader event.
void OnCustomDrawResourceHeader(object sender, CustomDrawObjectEventArgs e) {
e.Handled = true;
e.DrawHtml(htmlTemplateCollection[0]);
}
Templates are not applied when resources are displayed as tabs (when the Scheduler.OptionsView.ResourceCategories.ResourceDisplayStyle property is set to “Tabs”).
Utilize the Assign
method to set a template in code.
schedulerControl1.OptionsView.ResourceHeaders.ResourceHeaderHtmlTemplate.Assign(tCollection[0]);
Template-related events:
- QueryResourceHeaderTemplate – Allows you to assign unique templates for individual resources.
- CustomizeResourceHeaderTemplate – Allows you to modify resource header templates at runtime.
- CustomResourceHeaderTemplateValue – Handle this template to assign values to HTML elements bound to custom data fields.