RecurrenceEditor

23 Sep 20253 minutes to read

Represents the RecurrenceEditor component.

<div id="recurrence"></div>

<script>
  var recObj = new RecurrenceEditor();
  recObj.appendTo("#recurrence");
</script>

Properties

calendarMode CalendarType

Sets the specific calendar type to be applied on recurrence editor.

Defaults to ‘Gregorian’

cssClass string

Allows styling with custom class names.

Defaults to null

dateFormat string

Sets the user specific date format on recurrence editor.

Defaults to null

enablePersistence boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl boolean

Enable or disable rendering component in right to left direction.

Defaults to false

endTypes EndType[]

Sets the type of recurrence end for the recurrence pattern on the editor.

Defaults to [‘never’, ‘until’, ‘count’]

firstDayOfWeek number

Sets the first day of the week.

Defaults to 0

frequencies RepeatType[]

Sets the recurrence pattern on the editor.

Defaults to [‘none’, ‘daily’, ‘weekly’, ‘monthly’, ‘yearly’]

locale string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to ’’

maxDate Date

Sets the maximum date on recurrence editor.

Defaults to new Date(2099, 11, 31)

minDate Date

Sets the minimum date on recurrence editor.

Defaults to new Date(1900, 0, 1)

selectedType number

Sets the current repeat type to be set on the recurrence editor.

Defaults to 0

startDate Date

Sets the start date on recurrence editor.

Defaults to new Date()

value string

Sets the recurrence rule as its output values.

Defaults to null

Methods

addEventListener

Adds the handler to the given event listener.

Parameter	Type	Description
eventName	string	A String that specifies the name of the event
handler	Function	Specifies the call to run when the event occurs.

Returns void

appendTo

Appends the control within the given HTML element

Parameter	Type	Description
selector (optional)	string | HTMLElement	Target element where control needs to be appended

Returns void

attachUnloadEvent

Adding unload event to persist data when enable persistence true

Returns void

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

destroy

Destroys the widget.

Returns void

detachUnloadEvent

Removing unload event to persist data when enable persistence true

Returns void

getLocalData

Returns the persistence data for component

Returns any

getPersistData

Get the properties to be maintained in the persisted state.

Returns string

getRootElement

Returns the route element of the component

Returns HTMLElement

handleUnload

Handling unload event to persist data when enable persistence true

Returns void

refresh

Applies all the pending property changes and render the component again.

Returns void

removeEventListener

Removes the handler from the given event listener.

Parameter	Type	Description
eventName	string	A String that specifies the name of the event to remove
handler	Function	Specifies the function to remove

Returns void

Inject

Dynamically injects the required modules to the component.

Parameter	Type	Description
moduleList	Function[]	?

Returns void

Events

change EmitType<RecurrenceEditorChangeEventArgs>

Triggers for value changes on every sub-controls rendered within the recurrence editor.

created EmitType<Object>

Triggers when the component is created.

destroyed EmitType<Object>

Triggers when the component is destroyed.