Version

DateEditorModel Class Members

The following tables list the members exposed by DateEditorModel.

Public Constructors
 NameDescription
Public ConstructorDateEditorModel Constructor  
Public Properties
 NameDescription
Public PropertyAllowNullValueSets gets ability to prevent null value. If that option is false, and editor has no value, then value is set to an empty string. (Inherited from Infragistics.Web.Mvc.BaseEditorModel)
Public PropertyButtonTypeSets option to show drop-down or spin buttons. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyCenturyThresholdSets year for auto detection of 20th and 21st centuries. That option is used to automatically fill century when the user entered only 1 or 2 digits into the year field or when the date pattern contains only 1 or 2 year positions, e.g. "yy" or "y". If user entered value larger than value of this option, then 20th century is used, otherwise the 21st.  
Public PropertyClientEventsSet implementations of client events raised by a widget.

Event handler assumes 2 parameters: 1st parameter has name "evt" and 2nd parameter has name "ui". To get information about member variables available for "ui" parameter, please consult documentation of a widget and its events.

Examples:

1. Full implementation:

new Dictionary<string, string> { { "dropDownOpening", "function(evt,ui){alert('drop:'+ui.owner);}" } }

2. Content of inline function:

new Dictionary<string, string> { { "dropDownOpening", "alert('drop:'+ui.owner);" } }

3. Name of global function:

new Dictionary<string, string> { { "dropDownOpening", "nameOfGlobalFunction" } } Note:

Instead of explicit key-strings, which represent name of event exposed by a widget, the event-constants defined by a particular control can be used.

Example:

new Dictionary<string, string> { { ComboClientEvents.DropDownOpening, "nameOfGlobalFunction" } } (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public PropertyDataModeGets/Sets the value type returned by the get of value() method and option. Also affects how the value is stored for form submit.  
Public PropertyDateDisplayFormatSets custom date format used for display mode (no focus state).  
Public PropertyDateInputFormatSets custom date format used for input/edit mode (focus state).  
Public PropertyDisabledSets the disabled attribute.Does not allow editing. Disables all the buttons and iteracitons applied.

On submit the current value is not sent into the request.

(Inherited from Infragistics.Web.Mvc.BaseEditorModel)
Public PropertyDisplayTimeOffsetSets time zone offset from UTC, in minutes. The client Date value is displayed with this offset instead of the local one.

Note:

This option is best used when the actual value is UTC so the outcome is consistent. Values with ambiguous time zone could map to unpredictable times depending on the user agent local zone.  
Public PropertyDropDownAnimationDurationGets sets show/hide drop-down list animation duration in milliseconds. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyDropDownAttachedToBodySets gets location of drop-down list. Value false will create html element for list as a child of main html element. Value true creates list as a child of body. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyDropDownOnReadOnlySets the ability to limit the editor to be used only as a dropdown list. When set to true the editor input is not editable. Note: In case there are no list items - the editor will remain readonly (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyDropDownOrientationSets opening orientation for the drop down list. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyEmptyCharacterSets the character which is used as replacement of not-filled required position in mask when application calls get for the "value" or for the "text" methods. Default is the '*' char. (Inherited from Infragistics.Web.Mvc.MaskEditorModel)
Public PropertyEnableUTCDatesEnables/Disables serializing client date as UTC ISO 8061 string instead of using the local time and zone values. The option is only applied in "Date" DataMode.  
Public PropertyExcludeKeysSets gets ability to prevent entering specific characters from keyboard or on paste.

Notes: If a character is specified in "includeKeys" option also, then "excludeKeys" has priority Letters should be set in upper case. Making difference between upper and lower case is not supported.

(Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyHeightSets initial height of editor.

Number and valid html size-units can be used.

(Inherited from Infragistics.Web.Mvc.BaseEditorModel)
Public PropertyHideMaskOnFocusHides or shows input mask when editor gets focus. True: hide input mask, false: show all input mask with prompts when editor gets focus.  
Public PropertyHtmlAttributesSets custom attributes for main html element used by control

Dictionary of attributes passed to TagBuilder.MergeAttributes(value).

(Inherited from Infragistics.Web.Mvc.BaseEditorModel)
Public PropertyIDSets the ID of the editor. (Inherited from Infragistics.Web.Mvc.BaseEditorModel)
Public PropertyIncludeKeysSets gets ability to enter only specific characters in input-field from keyboard and on paste.

Notes: If "excludeKeys" option contains same characters as this option, then "excludeKeys" has priority. Letters should be set in upper case. Making difference between upper and lower case is not supported.

(Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyInputMaskSets gets input mask. Mask may include filter-flags and literal characters. (Inherited from Infragistics.Web.Mvc.MaskEditorModel)
Public PropertyInputNameSets the name of the HTML input used to store and submit the editor value. Optional.

Will override the existing name attribute if intialized on an input.

(Inherited from Infragistics.Web.Mvc.BaseEditorModel)
Public PropertyIsLimitedToListValuesSets the ability to allow values only set into the list items. This validation is done only when the editor is blurred, or enter key is pressed (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyLanguageGets/sets Language the control (Inherited from Infragistics.Web.Mvc.Framework.LocalizationBaseModel)
Public PropertyLimitSpinToCurrentFieldSets ability to modify only 1 date field on spin events. Value false enables changes of other date fields when incremented or decremented date-field reaches its limits. Value true modifies only value of one field.  
Public PropertyListItemHoverDuration (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyListItemsSets list of items used for drop-down list and for filtering keyboard entries. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyListWidthSets gets custom width of drop-down list in pixels. If value is equal to 0 or negative, then the width of editor is used. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyLocaleSets strings used for button titles. Note: Locale properties take priority over those defined in $.ig.Editor.locale in localization script files. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyMaxLengthSets gets maximum length of text which can be entered by user. Negative values or 0 disables that behavior. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyMaxValueSets maximum date which can be entered by user. Can be a DateTime, DateTimeOffset or a valid client date string/number representation.  
Public PropertyMinValueSets minimum date which can be entered by user. Can be a DateTime, DateTimeOffset or a valid client date string/number representation.  
Public PropertyNullValueSets gets the representation of null value. Can be either string or numeric. Default is null. (Inherited from Infragistics.Web.Mvc.BaseEditorModel)
Public PropertyPadCharacterSets the character which is used as replacement of not-filled required position in mask when editor is in display mode (not focused). Default is the '^' char. (Inherited from Infragistics.Web.Mvc.MaskEditorModel)
Public PropertyPlaceHolderSets gets text which appears in editor when editor has no focus and "value" in editor is null or empty string. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyPreventSubmitOnEnterSets the ability of the editor to prevent form submission on enter key pressed. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyReadOnlySets the readonly attribute. Does not allow editing. Disables all the buttons and iteracitons applied.

On submit the current value is sent into the request.

(Inherited from Infragistics.Web.Mvc.BaseEditorModel)
Public PropertyRegionalSets gets custom regional settings for editor. Note: If it is string, then $.ig.regional[stringValue] is assumed and should be availble on the client. (Inherited from Infragistics.Web.Mvc.MaskEditorModel)
Public PropertyRevertIfNotValidSets the editor to revert value to previous value in case of not valid value on blur, or enter key. If set to false clear is called. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertySelectionOnFocusSets type of selection when editor gets focus. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertySpinDeltaSets delta-value which is used to increment or decrement value in editor on spin events. If value is set to negative value an exception is thrown. Non integer values are parsed to integer.  
Public PropertySpinDeltaObjectSets delta-values for each time period, which are used to increment or decrement the corresponding value in editor on spin events. If value is set to negative value an exception is thrown. Non integer values are parsed to integer.  
Public PropertySpinWrapAroundEnables circular spin: after the last item is list, the first item in list is used as next item. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertySuppressKeyboardGets/Sets whether the onscreen keyboard (if available on device) should be shown when the dropdown button is clicked/tapped. This option prevents initial focus or removes it when the drop button is clicked/tapped. Note: The option does not perform device detection so its behavior is always active if enabled. Note: When drop down is opened the only way to close it will be using the drop down button (this is not valid for the DatePicker). (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertySuppressNotificationsDisables default notifications for basic validation scenarios built in the editors such as required list selection, value wrapping around or spin limits. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyTabIndexGets sets value in tabIndex for editor. (Inherited from Infragistics.Web.Mvc.BaseEditorModel)
Public PropertyTextAlignSets text alignment in editor. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyTextModeSets gets text mode of editor such as: single-line text editor, password editor or multiline editor. If based element (selector) is TEXTAREA, then it is used as input-field. If based element is INPUT, then it is used as input-field. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyToLowerSets gets ability to convert input characters to lower case (true) or keeps characters as they are (false). That option has effect only while keyboard entries and paste. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyToUpperSets gets ability to convert input characters to upper case (true) or keeps characters as they are (false). That option has effect only while keyboard entries and paste. (Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyUnfilledCharsPromptSets the character which is used as prompt in edit mode for available entry position. Default is the '_' char. (Inherited from Infragistics.Web.Mvc.MaskEditorModel)
Public PropertyUseLastGoodDateSet ability to use last valid date when user entered invalid value. Value of true allows automatically use last valid date, when editor loses focus and user failed to enter a valid date. In case of value false, the entered date is considered invalid and null is used.  
Public PropertyValidatorOptionsSets options supported by the igValidator widget. (Inherited from Infragistics.Web.Mvc.BaseEditorModel)
Public PropertyValueGets sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options. That can be string, number or Date depending on type of editor. (Inherited from Infragistics.Web.Mvc.BaseEditorModel)
Public PropertyVisibleItemsCountGets sets how many items should be shown at once.

Notes: That option is overwritten if the number of list items is less than the value. In that case the height of the dropdown is adjusted to the number of items.

(Inherited from Infragistics.Web.Mvc.TextEditorModel)
Public PropertyWidgetIdBaseOverridden. The base string that will be used to auto-generate ID of the widget if the ID option is not set.  
Public PropertyWidgetNameOverridden. The name of the widget this model will instantiate.  
Public PropertyWidthSets initial width of editor.

Number and valid html size-units can be used.

(Inherited from Infragistics.Web.Mvc.BaseEditorModel)
Public PropertyYearShiftSets difference between year in Gregorian calendar and displayed year.  
Protected Properties
 NameDescription
Protected PropertyStoreReturn the store with all of the options (Inherited from Infragistics.Web.Mvc.ModelBase)
Public Methods
 NameDescription
Public MethodAddClientEventAdds javascript function to process client event of widget. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Public Methodstatic (Shared in Visual Basic)GetClientValueOverloaded. Get value from client  
Public MethodToJsonOverridden. Serializes the object to JSON.  
Protected Methods
 NameDescription
Protected MethodCamelizeConverts the provided string to camel case. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodEnsureClientEventsAdds client events to Serializes the internal model store into json. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Protected MethodGetBoolGets the value of a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetCharSets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDateTimeGets the value of a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetDoubleGets the value of a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIEnumerable<T>Gets the value of an IEnumerable property of the model. If the value is null a new IEnumerable of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetIntGets the value of an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetJSLiteralSets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetLongGets the value of a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetModel<T>Gets the value of an IModel property of the model. If the value is null a new model of type T will be created. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringGets the value of a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetStringEnum<T>Gets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValue<T>Gets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodGetValueModel<T>Gets the value of an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromBoolSerializes a bool object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromDateTimeOverridden. Serializes a DateTime object into UTC ISO 8601 string.  
Protected MethodJsonFromDoubleSerializes a double object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromFloatSerializes a float object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIDictionarySerializes an IDictionary of objects into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIEnumerableSerializes an IEnumerable object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromIntSerializes an int object into json. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodJsonFromModelStoreSerializes the internal model store into json. (Inherited from Infragistics.Web.Mvc.ModelWidgetBase)
Protected MethodJsonFromObjectOverridden. Serializes an arbitrary object in json using the typed serialization methods.  
Protected MethodJsonFromStringSerializes a string object into json string, escaping all single quotes. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBoolSets a value to a bool property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetBrush (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCamelizedStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetCharGets the value of a char property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDateTimeSets a value to a DateTime property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetDoubleSets a value to a double property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIEnumerable<T>Sets a value to an IEnumerable property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetIntSets a value to an int property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetJSLiteralGets the value of a literal property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetLongSets a value to a long property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetModel<T>Sets a value to an IModel property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringSets a value to a string property of the model. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetStringEnum<T>Sets the value of a string property whose values are the lowercase values of an Enum. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodSetTimeOffsetOptionally sets DisplayTimeOffset before serialization.

DisplayTimeOffset is only set if none is already provided. The offset value is extracted from the value or current time.

 
Protected MethodSetValue<T>Sets a property value of arbitrary type. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodTransformDataTransforms the data. (Inherited from Infragistics.Web.Mvc.ModelBase)
Protected MethodValidValueType<T>Checks type for value of existing property. Returns false as well if non existing property. (Inherited from Infragistics.Web.Mvc.ModelBase)
See Also

View on GitHub