DateTimeCellType Class

Represents a date-time cell.

Inheritance

object

BaseCellType

EditBaseCellType

DateTimeCellType

Namespace: FarPoint.Win.Spread.CellType

Assembly: FarPoint.Win.Spread.dll

Syntax

public class DateTimeCellType : EditBaseCellType, ICellType, IEditor, ICloneable, IPropertyAllowedSupport, INotifyEditorValueChanged, IEnhancedPdfRenderer, IPdfSupport, IAllowArrowKeysMoveActiveCell, IErrorIconSupport, IEditorVerticaAlignSupport, ICellType, ICloneable<ICellType>, INumFmtSupportCellType, ISerializeSupport, IEditFormula, IRenderAlignment, IReadOnlySupport, IStaticSupport, IWordWrapSupport, IDisposable, IFormulaEditingSupport, IAutoCompleteSupport, IShrinkToFitSupport, IFormatter, IStringTrimmingSupport, ITextOrientationSupport2, ITextOrientationSupport, IEnhancedRenderer, IRenderer, IDisplayFormulaSupport, ISerializable, IDateTimeCellType, IReuseEditorControl2, IReuseEditorControl

Public Class DateTimeCellType
    Inherits EditBaseCellType
    Implements ICellType, IEditor, ICloneable, IPropertyAllowedSupport, INotifyEditorValueChanged, IEnhancedPdfRenderer, IPdfSupport, IAllowArrowKeysMoveActiveCell, IErrorIconSupport, IEditorVerticaAlignSupport, ICellType, ICloneable(Of ICellType), INumFmtSupportCellType, ISerializeSupport, IEditFormula, IRenderAlignment, IReadOnlySupport, IStaticSupport, IWordWrapSupport, IDisposable, IFormulaEditingSupport, IAutoCompleteSupport, IShrinkToFitSupport, IFormatter, IStringTrimmingSupport, ITextOrientationSupport2, ITextOrientationSupport, IEnhancedRenderer, IRenderer, IDisplayFormulaSupport, ISerializable, IDateTimeCellType, IReuseEditorControl2, IReuseEditorControl

Constructors

Name	Description
DateTimeCellType()	Creates a new date-time cell with default settings.
DateTimeCellType(DateTimeCellType)	Creates a new copy from the specified cell type ("Copy constructor").
DateTimeCellType(SerializationInfo, StreamingContext)	Creates a new date-time cell from serialization.

Fields

Name	Description
IncompleteValue	Gets the value returned from the editor if the editing value is partial and not empty.

Properties

Name	Description
AMString	Gets or sets the string to indicate morning for 12-hour time format.
Calendar	Gets or sets the calendar for formatting date values.
CalendarDayBackColor	Gets or sets the background color of the pop-up calendar in the date-time cell.
CalendarDayFont	Gets or sets the text font of the pop-up calendar in the date-time cell.
CalendarDayForeColor	Gets or sets the text color of the pop-up calendar in the date-time cell.
CalendarMonthBackColor	Gets or sets the background color of the month part of the pop-up calendar in the date-time cell.
CalendarMonthFont	Gets or sets the text font of the month part of the pop-up calendar in the date-time cell.
CalendarMonthForeColor	Gets or sets the text color of the month part of the pop-up calendar in the date-time cell.
CalendarMonthHeaderDock	Gets or sets how to dock the month header of the pop-up calendar in the date-time cell.
CalendarMonthHeaderHeight	Gets or sets the height of the month header of the pop-up calendar in the date-time cell.
CalendarMonthHeaderStyle	Gets or sets the style of the month header of the pop-up calendar in the date-time cell.
CalendarShowSurroundingDays	Gets or sets whether to show the surrounding days in the pop-up calendar in the date-time cell.
CalendarSingleLineHeader	Gets or sets the single line header of the pop-up calendar in the date-time cell.
CalendarSurroundingDaysColor	Gets or sets the color of the surrounding days of the pop-up calendar in the date-time cell.
CalendarWeekdayBackColor	Gets or sets the background color of the weekday part of the pop-up calendar in the date-time cell.
CalendarWeekdayFont	Gets or sets the text font of the weekday part of the pop-up calendar in the date-time cell.
CalendarWeekdayForeColor	Gets or sets the text color of the weekday part of the pop-up calendar in the date-time cell.
CalendarWeekdayHeaderDock	Gets or sets how to dock the weekday header of the pop-up calendar in the date-time cell.
CalendarWeekdayHeaderHeight	Gets or sets the height of the weekday header of the pop-up calendar in the date-time cell.
CalendarYearBackColor	Gets or sets the background color of the year part of the pop-up calendar in the date-time cell.
CalendarYearFont	Gets or sets the text font of the year part of the pop-up calendar in the date-time cell.
CalendarYearForeColor	Gets or sets the text color of the year part of the pop-up calendar in the date-time cell.
CalendarYearHeaderDock	Gets or sets how to dock the year header of the pop-up calendar in the date-time cell.
CalendarYearHeaderHeight	Gets or sets the height of the year header of the pop-up calendar in the date-time cell.
CalendarYearHeaderStyle	Gets or sets the style of the year header of the pop-up calendar in the date-time cell.
DateDefault	Gets or sets the default date for the control.
DateSeparator	Gets or sets the string that separates the portions of a date value.
DateTimeFormat	Gets or sets the format for displaying dates and times.
DayNames	Gets or sets alternate day names for the control (use with UserDefinedFormat).
EditorValue	Gets or sets what value is written to the underlying data model.
MaximumDate	Gets or sets the maximum date value allowed for user entry.
MaximumTime	Gets or sets the maximum time value allowed for user entry.
MinimumDate	Gets or sets the minimum date value allowed for user entry.
MinimumTime	Gets or sets the minimum time value allowed for user entry.
MonthNames	Gets or sets alternate month names for the control (use with UserDefinedFormat).
PMString	Gets or sets the string to indicate afternoon and evening for 12-hour time format.
ShortDayNames	Gets or sets alternate short day names for the control (use with UserDefinedFormat).
ShortMonthNames	Gets or sets alternate short month names for the control (use with UserDefinedFormat).
SimpleEdit	Gets or sets whether the celltype ignores invalid character input while editing.
SpinButton	Gets or sets whether a spin button is displayed while editing.
TimeDefault	Gets or sets the default time used in the control.
TimeSeparator	Gets or sets the string that separates the portions of a time value.
TwoDigitYearMax	Gets or sets the last year of a 100-year range that can be represented by a 2-digit year.
UserDefinedFormat	Gets or sets the format used when the date-time format is user-defined.

Methods

Name	Description
Clone()	Creates and returns a date-time cell.
Deserialize(XmlNodeReader)	Loads the object from XML.
Format(object)	Formats the specified data into the format of the cell type and returns it as a string.
GetAMStringDesignator()	Gets the AM string for formatting time values.
GetDateSeparatorString()	Gets the date separator string for formatting date values.
GetDayNames()	Gets the long day names for formatting date values.
GetEditorControl(Appearance, float)	Gets the edit control for this cell type with the specified appearance and scaling.
GetEditorControl(Control, Appearance, float)	Gets the edit control for this cell type with the specified appearance and scaling.
GetEditorValue()	Gets the unformatted value in the editor control.
GetFormatString()	Gets the format string for formatting date values or time values or both.
GetLongDateFormat()	Gets the long date format for formatting date values.
GetMonthNames()	Gets the long month names for formatting date values.
GetNewFormat()	Gets the new format for formatting date values or time values or both.
GetObjectData(SerializationInfo, StreamingContext)	Serializes the cell type.
GetPMStringDesignator()	Gets the PM string for formatting time values.
GetPreferredSize(Graphics, Size, Appearance, object, float)	Gets the preferred (maximum required) size of the cell for the editor control.
GetShortDateFormat()	Gets the short date format for formatting date values.
GetShortDayNames()	Gets the short day names for formatting date values.
GetShortMonthNames()	Gets the short month names for formatting date values.
GetTimeFormat()	Gets the time format for formatting time values.
GetTimeSeparatorString()	Gets the time separator string for formatting time values.
InitializeEditorControl(Control, Appearance, float)	Initializes the editor control.
IsReusable(Control)	Checks if this celltype is reusable.
IsValid(object)	Determines whether the specified value can be converted to a date-time value and is between the minimum and maximum allowed values.
Parse(string)	Parses the specified string to the data type of the cell type and returns it as an object.
Serialize(XmlTextWriter)	Saves the object to XML.
SetCalendarFormat(string)	Sets the format to be used for the pop-up calendar header.
SetCalendarText(string, string)	Sets the various text elements for the pop-up calendar, namely the button text.
SetCalendarText(string[], string[], string[], string[], string, string)	Sets the various text elements for the pop-up calendar, including the day and month names and the button text.
SetCalendarText(string[], string[], string[], string[], string, string, string)	Sets the various text elements for the pop-up calendar, including the day and month names, the today text, and the button text.
SetEditorValue(object)	Sets the value of the editor control.
SetNewFormat()	Sets the new format (returned by GetNewFormat) into the internal cell formatter.