View Source

Class DateTimeWithTimeZonePropertyEditor

Represents a property editor for editing a date/time value with timezone.

Inheritance

object

DataEditor

DateTimePropertyEditorBase

Namespace: Umbraco.Cms.Core.PropertyEditors

Assembly: Umbraco.Infrastructure.dll

Syntax

[DataEditor("Umbraco.DateTimeWithTimeZone", ValueType = "JSON", ValueEditorIsReusable = true)]
public class DateTimeWithTimeZonePropertyEditor : DateTimePropertyEditorBase, IDataEditor, IDiscoverable, IValueSchemaProvider

Remarks

This is one of four property editors derived from DateTimePropertyEditorBase and storing their value as JSON with timezone information.

Constructors

DateTimeWithTimeZonePropertyEditor(IDataValueEditorFactory, IIOHelper, IDateTimeWithTimeZonePropertyIndexValueFactory)

Initializes a new instance of the DateTimeWithTimeZonePropertyEditor class.

Declaration

public DateTimeWithTimeZonePropertyEditor(IDataValueEditorFactory dataValueEditorFactory, IIOHelper ioHelper, IDateTimeWithTimeZonePropertyIndexValueFactory propertyIndexValueFactory)

Parameters

Type	Name	Description
IDataValueEditorFactory	dataValueEditorFactory	Factory used to create data value editors for property values.
IIOHelper	ioHelper	Helper for IO operations, such as path resolution.
IDateTimeWithTimeZonePropertyIndexValueFactory	propertyIndexValueFactory	Factory for creating index values for date and time properties with time zone support.

Methods

MapDateToEditorFormat(DateTimeDto)

Converts the specified date and time value to a string formatted for use in the property editor.

Declaration

protected override string MapDateToEditorFormat(DateTimeValueConverterBase.DateTimeDto dateTimeDto)

Parameters

Type	Name	Description
DateTimeValueConverterBase.DateTimeDto	dateTimeDto	An object containing the date and time components to be formatted.

Returns

Type	Description
string	A string representation of the date and time, formatted for use in the property editor.