DataItem.DateTimeFormat Property

Provides access to the format settings for date-time values.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v21.2.Core.dll

Declaration

public DataItemDateTimeFormat DateTimeFormat { get; }

Property Value

Type Description
DataItemDateTimeFormat

A DataItemDateTimeFormat object that contains format settings for date-time values.

Remarks

The DateTimeFormat property allows you to select format types for dimension date-time values displayed for different group intervals (like Year, Month, Year-Quarter, etc.). The returned DataItemDateTimeFormat object exposes a number of properties, each defining a format type that corresponds to a particular group interval. Use the Dimension.DateTimeGroupInterval property to specify the actual group interval.

Note that date-time fields can originate measures as well. If such a measure calculates a maximum or minimum summary, the resulting values are of the date-time type. These values are formatted using the DataItemDateTimeFormat.DateFormat setting. All other settings provided by the DateTimeFormat property are ignored for measures.

Actual formatting patterns are defined by the current system locale (or the client’s locale, when a dashboard is shown on the web).

If the DataItem does not correspond to a date-time data member, the DateTimeFormat options are not in effect.

The following code snippets (auto-collected from DevExpress Examples) contain references to the DateTimeFormat property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also