DateTimeHelper Class

Methods to work with the DateTime.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Helpers.DateTimeHelper

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 8.2.23

Syntax

public class DateTimeHelper : CoreMethods

The DateTimeHelper type exposes the following members.

Constructors

	Name	Description
Public method	DateTimeHelper

Methods

	Name	Description
Public method Static member	DateTimeToString	Converts the given DateTime to string value.
Public method Static member	GetDayStart	Gets start of the day of specific date.
Public method Static member	GetFirstDayOfWeek()	Gets the first day of the week.
Public method Static member	GetFirstDayOfWeek(String)	Gets the first day of the week.
Public method Static member	GetFormattedValidity	Returns validity as formatted string.
Public method Static member	GetHourStart	Gets current date without minutes and seconds.
Public method Static member	GetMinuteStart	Gets current date without seconds.
Public method Static member	GetMonthStart	Gets the first day of the month from specific date.
Public method Static member	GetValidityEnum	Returns validity enumeration.
Public method Static member	GetValidityString	Returns validity enumeration as string.
Public method Static member	GetValidTo	Calculate valid to date and time according to given parameters.
Public method Static member	GetWeekOfYear(DateTime)	Gets the week of year number.
Public method Static member	GetWeekOfYear(DateTime, String)	Gets the week of year number.
Public method Static member	GetWeekStart(DateTime)	Gets the date from the beginning of week.
Public method Static member	GetWeekStart(DateTime, String)	Gets the date from the beginning of week.
Public method Static member	GetYearStart	Gets the first day of the year from specific date.
Public method Static member	IsNowOrToday	Returns true, if the given value is ##NOW## or ##TODAY## macro
Public method Static member	IsValidFromTo	Returns true if DateTime "from" is lower than or equal to DateTime "to" or one of them is equal to ZeroTime.
Public method Static member	NumberOfWeeks(DateTime, DateTime)	Gets number of weeks in specified time interval.
Public method Static member	NumberOfWeeks(DateTime, DateTime, String)	Gets number of weeks in specified time interval.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	MACRO_DATE_TODAY	Macro representing current date.
Public field Static member	MACRO_TIME_NOW	Macro representing current date and time.
Public field Static member	UNIX_TIME_START	Start date/time for the Unix time stamp
Public field Static member	ZERO_TIME	Zero time constant.

Properties

	Name	Description
Public property Static member	DefaultIFormatProvider	Gets the default (en-us) IFormatProvider.