Try our conversational search powered by Generative AI!

Ravindra S. Rathore
Sep 28, 2019
  4196
(6 votes)

Improve editor experience for DateTime property

Hi All,

As you all know that the default DateTime widget in Episerver provides the DateTime picker.

And if you want to select the date only, it still selects the time so if you want a separate field for date and time then you can use the "EditorDescriptor" to achieve this.

Here is the things you need to do -

1. Create a Constants class to store all the static constant value.

namespace TestProject
{
    public static class Constants
    {
        public const string DateOnly = "dateonly";
        public const string TimeOnly = "timeonly";
    }
}

2. Create a EditorDescriptors class to extend the default functionality

using EPiServer.Shell.ObjectEditing;
using EPiServer.Shell.ObjectEditing.EditorDescriptors;
using System;
using System.Collections.Generic;

namespace TestProject.EditorDescriptors
{
    [EditorDescriptorRegistration(TargetType = typeof(DateTime),
        UIHint = Constants.DateOnly)]
    [EditorDescriptorRegistration(TargetType = typeof(DateTime?),
        UIHint = Constants.DateOnly)]
    public class DateOnlyEditorDescriptor : EditorDescriptor
    {
        public override void ModifyMetadata(ExtendedMetadata metadata,
            IEnumerable<Attribute> attributes)
        {
            ClientEditingClass = "dijit/form/DateTextBox";
            base.ModifyMetadata(metadata, attributes);
        }
    }

    [EditorDescriptorRegistration(TargetType = typeof(DateTime),
        UIHint = Constants.TimeOnly)]
    [EditorDescriptorRegistration(TargetType = typeof(DateTime?),
        UIHint = Constants.TimeOnly)]
    public class TimeOnlyEditorDescriptor : EditorDescriptor
    {
        public override void ModifyMetadata(ExtendedMetadata metadata,
            IEnumerable<Attribute> attributes)
        {
            ClientEditingClass = "dijit/form/TimeTextBox";
            base.ModifyMetadata(metadata, attributes);
        }
    }
}

I am using "ClientEditingClass" property to achieve this-

For Date  -

ClientEditingClass = "dijit/form/DateTextBox";

For Time  -

ClientEditingClass = "dijit/form/TimeTextBox";

3. Now add the "DateTime" property to Page where you want these properties.

        [Display(
            Name = "Event Date",
            GroupName = SystemTabNames.Content,
            Order = 10)]
        [UIHint(Constants.DateOnly)]
        public virtual System.DateTime EventDate { get; set; }


        [Display(
            Name = "Event Start Time",
            GroupName = SystemTabNames.Content,
            Order = 20)]
        [UIHint(Constants.TimeOnly)]
        public virtual DateTime EventStartTime { get; set; }

        [Display(
            Name = "Event End Time",
            GroupName = SystemTabNames.Content,
            Order = 30)]
        [UIHint(Constants.TimeOnly)]
        public virtual DateTime EventEndTime { get; set; }

As you see all the above property is of DateTime but I have used [UIHint(Constants.DateOnly)] and [UIHint(Constants.TimeOnly)] to differentiate these.

Once this is done, Login into CMS and now you can see the improved version DateTime.

4. Now just render this on your index.cshtml

To make it editable in On-Page-Editing you can use "EditAttributes" helper so it can be edited in the CMS.

<p>@Html.PropertyFor(x => x.CurrentPage.EventDate)</p>
<p @Html.EditAttributes(x => x.CurrentPage.EventStartTime)>@Model.CurrentPage.EventStartTime.ToString("hh:mm tt")</p>
<p @Html.EditAttributes(x => x.CurrentPage.EventEndTime)>@Model.CurrentPage.EventEndTime.ToString("hh:mm tt")</p>

Thanks

Ravindra S. Rathore

Sep 28, 2019

Comments

Jeroen Stemerdink
Jeroen Stemerdink Sep 30, 2019 07:32 AM

There's not really a need to make your own editordescriptor though. Instead of the custom UiHint you can just put [ClientEditor(ClientEditingClass = "dijit/form/TimeTextBox")] or [ClientEditor(ClientEditingClass = "dijit/form/DateTextBox")], which would save you some coding ;)

Please login to comment.
Latest blogs
Build a headless blog with Astro and Optimizely SaaS CMS

I’m a big fan of using the right tool for the right job. I’m also a big fan of Astro , for the right use case. Let's explore Astro to see what it's...

Jacob Pretorius | May 28, 2024

Microsoft announces Natural language to SQL

Finally, Microsoft launches "Natural language to SQL," after it has been available for several months in Optimizely CMS!

Tomas Hensrud Gulla | May 23, 2024 | Syndicated blog

Five easy ways to start personalizing your content right now

If you clicked on this article, you already know that getting the right message to the right person at the right time helps drive conversions and...

Kara Andersen | May 23, 2024

ExtendedCms.TinyMceEnhancements – serwer side webp support

Today I will introduce another small feature of TinyMceEnhancements plugin. The functionality is used to automatically detect whether a browser...

Grzegorz Wiecheć | May 22, 2024 | Syndicated blog