Ext.NET  5.3.0
.NET Component Framework for Enterprise Level Apps
Ext.Net.TimeField.Builder< TTimeField, TBuilder > Class Template Reference

More...

Inheritance diagram for Ext.Net.TimeField.Builder< TTimeField, TBuilder >:
Ext.Net.PickerField.Builder< TTimeField, TBuilder >

Public Member Functions

 Builder (TTimeField component)
 
virtual TBuilder EmptyTime (TimeSpan emptyTime)
 The fields null value. More...
 
virtual TBuilder SelectedTime (TimeSpan selectedTime)
 
virtual TBuilder SelectedValue (object selectedValue)
 
virtual TBuilder AutoSelect (bool autoSelect)
 true to automatically highlight the first result gathered by the data store in the dropdown list when it is opened. (Defaults to true). A false value would cause nothing in the list to be highlighted automatically, so the user would have to manually highlight an item before pressing the enter or tab key to select it (unless the value of (typeAhead) were true), or use the mouse to select a value. More...
 
virtual TBuilder ForceSelection (bool forceSelection)
 true to restrict the selected value to one of the values in the list, false to allow the user to set arbitrary text into the field (defaults to false) More...
 
virtual TBuilder GrowToLongestValue (bool growToLongestValue)
 false to not allow the component to resize itself when its data changes (and its grow property is true). Defaults to: true More...
 
virtual TBuilder FireSelectOnLoad (bool fireSelectOnLoad)
 True to fire select event after setValue on page load More...
 
virtual TBuilder MinChars (int minChars)
 The minimum number of characters the user must type before autocomplete and typeAhead activate (defaults to 4 if queryMode = 'remote' or 0 if queryMode = 'local', does not apply if editable = false). More...
 
virtual TBuilder TypeAhead (bool typeAhead)
 True to populate and autoselect the remainder of the text being typed after a configurable delay (typeAheadDelay) if it matches a known value (defaults to false). More...
 
virtual TBuilder TypeAheadDelay (int typeAheadDelay)
 The length of time in milliseconds to wait until the typeahead text is displayed if TypeAhead = true (defaults to 250). More...
 
virtual TBuilder ValueNotFoundText (string valueNotFoundText)
 When using a name/value combo, if the value passed to setValue is not found in the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined). If this default text is used, it means there is no value set and no validation will occur on this field. More...
 
virtual TBuilder AltFormats (string altFormats)
 Multiple date formats separated by " | " to try when parsing a user input value and it doesn't match the defined format (defaults to 'g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H|gi a|hi a|giA|hiA|gi A|hi A'). More...
 
virtual TBuilder Format (string format)
 The default time format string which can be overriden for localization support. The format must be valid according to Ext.Date.parse (defaults to 'g:i A', e.g., '3:15 PM'). For 24-hour time format try 'H:i' instead. More...
 
virtual TBuilder Increment (int increment)
 The number of minutes between each time value in the list (defaults to 15). More...
 
virtual TBuilder MaxText (string maxText)
 The error text to display when the entered time is after maxValue (defaults to 'The time in this field must be equal to or before {0}'). More...
 
virtual TBuilder MaxTime (TimeSpan maxTime)
 The maximum allowed time. Can be either a Javascript date object with a valid time value or a string time in a valid format – see format and altFormats (defaults to undefined). More...
 
virtual TBuilder MinTime (TimeSpan minTime)
 The minimum allowed time. Can be either a Javascript date object with a valid time value or a string time in a valid format – see format and altFormats (defaults to undefined). More...
 
virtual TBuilder MinText (string minText)
 The error text to display when the entered time is before minValue (defaults to 'The time in this field must be equal to or after {0}'). More...
 
virtual TBuilder PickerMaxHeight (int pickerMaxHeight)
 The maximum height of the Ext.picker.Time dropdown. Defaults to 300. More...
 
virtual TBuilder SelectOnTab (bool selectOnTab)
 Whether the Tab key should select the currently highlighted item. Defaults to true. More...
 
virtual TBuilder SnapToIncrement (bool snapToIncrement)
 Specify as true to enforce that only values on the increment boundary are accepted. Defaults to: false More...
 
virtual TBuilder SubmitFormat (string submitFormat)
 The date format string which will be submitted to the server. The format must be valid according to Ext.Date.parse (defaults to format). More...
 
virtual TBuilder ListConfig (BoundList listConfig)
 
virtual TBuilder PageSize (int pageSize)
 If greater than 0, a Ext.toolbar.Paging is displayed in the footer of the dropdown list and the filter queries will execute with page start and limit parameters. Only applies when queryMode = 'remote' (defaults to 0). More...
 
virtual TBuilder QueryCaching (bool queryCaching)
 When true, this prevents the combo from re-querying (either locally or remotely) when the current query is the same as the previous query. Defaults to: true More...
 
virtual TBuilder QueryDelay (int queryDelay)
 The length of time in milliseconds to delay between the start of typing and sending the query to filter the dropdown list (defaults to 500 if queryMode = 'remote' or 10 if queryMode = 'local') More...
 
virtual TBuilder QueryMode (DataLoadMode queryMode)
 Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server). More...
 
virtual TBuilder QueryParam (string queryParam)
 Name of the parameter used by the Store to pass the typed string when the ComboBox is configured with queryMode: 'remote' (defaults to 'query'). If explicitly set to a falsy value it will not be sent. More...
 
virtual TBuilder TriggerAction (TriggerAction triggerAction)
 The action to execute when the trigger is clicked. More...
 
virtual TBuilder Listeners (Action< ComboBoxListeners > action)
 Client-side JavaScript Event Handlers More...
 
virtual TBuilder DirectEvents (Action< ComboBoxDirectEvents > action)
 Server-side Ajax Event Handlers More...
 
 Builder ()
 
 Builder (TimeField component)
 
 Builder (TimeField.Config config)
 
- Public Member Functions inherited from Ext.Net.PickerField.Builder< TTimeField, TBuilder >
 Builder (TPickerField component)
 
virtual TBuilder MatchFieldWidth (bool matchFieldWidth)
 Whether the picker dropdown's width should be explicitly set to match the width of the field. Defaults to true. More...
 
virtual TBuilder OpenCls (string openCls)
 A class to be added to the field's bodyEl element when the picker is opened. Defaults to 'x-pickerfield-open'. More...
 
virtual TBuilder PickerAlign (string pickerAlign)
 The alignment position with which to align the picker. Defaults to "tl-bl?" More...
 
virtual TBuilder PickerOffset (int[] pickerOffset)
 An offset [x,y] to use in addition to the pickerAlign when positioning the picker. Defaults to undefined. More...
 
virtual TBuilder AutoPostBackEvent (PickerAutoPostBackEvent autoPostBackEvent)
 
virtual TBuilder TriggerCls (string triggerCls)
 An additional CSS class used to style the trigger button. The trigger will always get the class 'x-form-trigger' and triggerCls will be appended if specified. More...
 
virtual TBuilder TriggerIcon (TriggerIcon triggerIcon)
 The icon to use in the trigger. More...
 
virtual TBuilder HideBaseTrigger (bool hideBaseTrigger)
 true to hide base trigger More...
 
virtual TBuilder Expand ()
 
virtual TBuilder Collapse ()
 
virtual TBuilder SetHideBaseTrigger (bool hideTrigger)
 Sets the value of hideBaseTrigger. More...
 

Static Public Member Functions

static implicit operator Builder (TimeField component)
 

Detailed Description

Type Constraints
TTimeField :TimeField 
TBuilder :Builder 
TBuilder :TTimeField 
TBuilder :TBuilder 

Constructor & Destructor Documentation

◆ Builder() [1/4]

Ext.Net.TimeField.Builder< TTimeField, TBuilder >.Builder ( TTimeField  component)
inline

◆ Builder() [2/4]

Ext.Net.TimeField.Builder< TTimeField, TBuilder >.Builder ( )
inline

◆ Builder() [3/4]

Ext.Net.TimeField.Builder< TTimeField, TBuilder >.Builder ( TimeField  component)
inline

◆ Builder() [4/4]

Ext.Net.TimeField.Builder< TTimeField, TBuilder >.Builder ( TimeField.Config  config)
inline

Member Function Documentation

◆ AltFormats()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.AltFormats ( string  altFormats)
inlinevirtual

Multiple date formats separated by " | " to try when parsing a user input value and it doesn't match the defined format (defaults to 'g:ia|g:iA|g:i a|g:i A|h:i|g:i|H:i|ga|ha|gA|h a|g a|g A|gi|hi|gia|hia|g|H|gi a|hi a|giA|hiA|gi A|hi A').

◆ AutoSelect()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.AutoSelect ( bool  autoSelect)
inlinevirtual

true to automatically highlight the first result gathered by the data store in the dropdown list when it is opened. (Defaults to true). A false value would cause nothing in the list to be highlighted automatically, so the user would have to manually highlight an item before pressing the enter or tab key to select it (unless the value of (typeAhead) were true), or use the mouse to select a value.

◆ DirectEvents()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.DirectEvents ( Action< ComboBoxDirectEvents action)
inlinevirtual

Server-side Ajax Event Handlers

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ EmptyTime()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.EmptyTime ( TimeSpan  emptyTime)
inlinevirtual

The fields null value.

◆ FireSelectOnLoad()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.FireSelectOnLoad ( bool  fireSelectOnLoad)
inlinevirtual

True to fire select event after setValue on page load

◆ ForceSelection()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.ForceSelection ( bool  forceSelection)
inlinevirtual

true to restrict the selected value to one of the values in the list, false to allow the user to set arbitrary text into the field (defaults to false)

◆ Format()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.Format ( string  format)
inlinevirtual

The default time format string which can be overriden for localization support. The format must be valid according to Ext.Date.parse (defaults to 'g:i A', e.g., '3:15 PM'). For 24-hour time format try 'H:i' instead.

◆ GrowToLongestValue()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.GrowToLongestValue ( bool  growToLongestValue)
inlinevirtual

false to not allow the component to resize itself when its data changes (and its grow property is true). Defaults to: true

◆ Increment()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.Increment ( int  increment)
inlinevirtual

The number of minutes between each time value in the list (defaults to 15).

◆ ListConfig()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.ListConfig ( BoundList  listConfig)
inlinevirtual

◆ Listeners()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.Listeners ( Action< ComboBoxListeners action)
inlinevirtual

Client-side JavaScript Event Handlers

Parameters
actionThe action delegate
Returns
An instance of TBuilder

◆ MaxText()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.MaxText ( string  maxText)
inlinevirtual

The error text to display when the entered time is after maxValue (defaults to 'The time in this field must be equal to or before {0}').

◆ MaxTime()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.MaxTime ( TimeSpan  maxTime)
inlinevirtual

The maximum allowed time. Can be either a Javascript date object with a valid time value or a string time in a valid format – see format and altFormats (defaults to undefined).

◆ MinChars()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.MinChars ( int  minChars)
inlinevirtual

The minimum number of characters the user must type before autocomplete and typeAhead activate (defaults to 4 if queryMode = 'remote' or 0 if queryMode = 'local', does not apply if editable = false).

◆ MinText()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.MinText ( string  minText)
inlinevirtual

The error text to display when the entered time is before minValue (defaults to 'The time in this field must be equal to or after {0}').

◆ MinTime()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.MinTime ( TimeSpan  minTime)
inlinevirtual

The minimum allowed time. Can be either a Javascript date object with a valid time value or a string time in a valid format – see format and altFormats (defaults to undefined).

◆ operator Builder()

static implicit Ext.Net.TimeField.Builder< TTimeField, TBuilder >.operator Builder ( TimeField  component)
inlinestatic

◆ PageSize()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.PageSize ( int  pageSize)
inlinevirtual

If greater than 0, a Ext.toolbar.Paging is displayed in the footer of the dropdown list and the filter queries will execute with page start and limit parameters. Only applies when queryMode = 'remote' (defaults to 0).

◆ PickerMaxHeight()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.PickerMaxHeight ( int  pickerMaxHeight)
inlinevirtual

The maximum height of the Ext.picker.Time dropdown. Defaults to 300.

◆ QueryCaching()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.QueryCaching ( bool  queryCaching)
inlinevirtual

When true, this prevents the combo from re-querying (either locally or remotely) when the current query is the same as the previous query. Defaults to: true

◆ QueryDelay()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.QueryDelay ( int  queryDelay)
inlinevirtual

The length of time in milliseconds to delay between the start of typing and sending the query to filter the dropdown list (defaults to 500 if queryMode = 'remote' or 10 if queryMode = 'local')

◆ QueryMode()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.QueryMode ( DataLoadMode  queryMode)
inlinevirtual

Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server).

◆ QueryParam()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.QueryParam ( string  queryParam)
inlinevirtual

Name of the parameter used by the Store to pass the typed string when the ComboBox is configured with queryMode: 'remote' (defaults to 'query'). If explicitly set to a falsy value it will not be sent.

◆ SelectedTime()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.SelectedTime ( TimeSpan  selectedTime)
inlinevirtual

◆ SelectedValue()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.SelectedValue ( object  selectedValue)
inlinevirtual

◆ SelectOnTab()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.SelectOnTab ( bool  selectOnTab)
inlinevirtual

Whether the Tab key should select the currently highlighted item. Defaults to true.

◆ SnapToIncrement()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.SnapToIncrement ( bool  snapToIncrement)
inlinevirtual

Specify as true to enforce that only values on the increment boundary are accepted. Defaults to: false

◆ SubmitFormat()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.SubmitFormat ( string  submitFormat)
inlinevirtual

The date format string which will be submitted to the server. The format must be valid according to Ext.Date.parse (defaults to format).

◆ TriggerAction()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.TriggerAction ( TriggerAction  triggerAction)
inlinevirtual

The action to execute when the trigger is clicked.

◆ TypeAhead()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.TypeAhead ( bool  typeAhead)
inlinevirtual

True to populate and autoselect the remainder of the text being typed after a configurable delay (typeAheadDelay) if it matches a known value (defaults to false).

◆ TypeAheadDelay()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.TypeAheadDelay ( int  typeAheadDelay)
inlinevirtual

The length of time in milliseconds to wait until the typeahead text is displayed if TypeAhead = true (defaults to 250).

◆ ValueNotFoundText()

virtual TBuilder Ext.Net.TimeField.Builder< TTimeField, TBuilder >.ValueNotFoundText ( string  valueNotFoundText)
inlinevirtual

When using a name/value combo, if the value passed to setValue is not found in the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined). If this default text is used, it means there is no value set and no validation will occur on this field.


The documentation for this class was generated from the following file: