Search results

RecurrenceEditor

Represents the RecurrenceEditor component.

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

Properties

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

Allows recurrence editor to render in RTL mode.

Defaults to false

firstDayOfWeek

number

Sets the first day of the week.

Defaults to 0

frequencies

string[]

Sets the recurrence pattern on the editor.

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

locale

string

Sets the locale to be applied on recurrence editor.

Defaults to true

maxDate

Date

Sets the maximum date on recurrence editor.

Defaults to new Date(2099, 12, 31)

minDate

Date

Sets the minimum date on recurrence editor.

Defaults to new Date(1900, 1, 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.

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

dataBind

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

Returns void

destroy

Destroys the widget.

Returns void

getPersistData

Get the properties to be maintained in the persisted state.

Returns string

refresh

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

Returns void

removeEventListener

Removes the handler from the given event listener.

Returns void

Inject

Dynamically injects the required modules to the component.

Returns void

Events

change

EmitType<RecurrenceEditorChangeEventArgs>

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