Introduction
Knowledge Base
API Reference / Server-side / Telerik.Web.UI / RecurrenceEditor
New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RecurrenceEditor

Class

The RadSchedulerRecurrenceEditor is a lightweight control that encapsulates all of the User Interface elements needed to display and edit RadScheduler recurrence rules.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:
C#
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(SchedulerDateTime))]
[ToolboxBitmap(typeof(RadScheduler), "Toolbox.Icons.SchedulerRecurrenceEditor.png")]
[ClientScriptResource("Telerik.Web.UI.RecurrenceEditor", "Telerik.Web.UI.Scheduler.Helpers.DateTime.js")]
[ClientScriptResource("Telerik.Web.UI.RecurrenceEditor", "Telerik.Web.UI.Scheduler.RecurrenceRule.RecurrenceRule.js")]
[ClientScriptResource("Telerik.Web.UI.RecurrenceEditor", "Telerik.Web.UI.Scheduler.RecurrenceEditor.RecurrenceEditor.js")]
[EmbeddedSkin("SchedulerRecurrenceEditor", typeof(RecurrenceEditor))]
[EmbeddedSkin("SchedulerRecurrenceEditor", "Default", typeof(RecurrenceEditor))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Classic, typeof(RecurrenceEditor))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RecurrenceEditor))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Mobile, typeof(RecurrenceEditor))]
public abstract class RecurrenceEditor : RadWebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IPostBackEventHandler

Inheritance: objectControlWebControlRadWebControlRecurrenceEditor

Derived Classes: RadSchedulerRecurrenceEditor

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIPostBackDataHandlerIPostBackEventHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members WebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.LoadViewState(object)WebControl.TrackViewState()WebControl.MergeStyle(Style)WebControl.Render(HtmlTextWriter)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.SaveViewState()WebControl.AccessKeyWebControl.AttributesWebControl.BackColorWebControl.BorderColorWebControl.BorderWidthWebControl.BorderStyleWebControl.ControlStyleWebControl.ControlStyleCreatedWebControl.CssClassWebControl.DisabledCssClassWebControl.StyleWebControl.EnabledWebControl.EnableThemingWebControl.FontWebControl.ForeColorWebControl.HasAttributesWebControl.HeightWebControl.IsEnabledWebControl.SupportsDisabledAttributeWebControl.SkinIDWebControl.TabIndexWebControl.TagNameWebControl.ToolTipWebControl.WidthControl.ResolveAdapter()Control.HasEvents()Control.GetRouteUrl(object)Control.GetRouteUrl(string, object)Control.GetRouteUrl(RouteValueDictionary)Control.GetRouteUrl(string, RouteValueDictionary)Control.GetUniqueIDRelativeTo(Control)Control.ApplyStyleSheetSkin(Page)Control.OnDataBinding(EventArgs)Control.DataBind()Control.DataBind(bool)Control.DataBindChildren()Control.AddParsedSubObject(object)Control.EnsureID()Control.OnInit(EventArgs)Control.ClearChildState()Control.ClearChildControlState()Control.ClearChildViewState()Control.ClearEffectiveClientIDMode()Control.ClearCachedClientID()Control.Focus()Control.LoadControlState(object)Control.MapPathSecure(string)Control.OpenFile(string)Control.OnLoad(EventArgs)Control.BuildProfileTree(string, bool)Control.SaveControlState()Control.RenderChildren(HtmlTextWriter)Control.RenderControl(HtmlTextWriter)Control.RenderControl(HtmlTextWriter, ControlAdapter)Control.OnUnload(EventArgs)Control.Dispose()Control.RaiseBubbleEvent(object, EventArgs)Control.OnBubbleEvent(object, EventArgs)Control.AddedControl(Control, int)Control.CreateControlCollection()Control.ResolveUrl(string)Control.ResolveClientUrl(string)Control.FindControl(string)Control.FindControl(string, int)Control.GetDesignModeState()Control.HasControls()Control.IsLiteralContent()Control.EnsureChildControls()Control.RemovedControl(Control)Control.SetDesignModeState(IDictionary)Control.SetRenderMethodDelegate(RenderMethod)Control.ClientIDModeControl.ClientIDControl.ClientIDSeparatorControl.ContextControl.AdapterControl.DesignModeControl.EventsControl.IDControl.IsChildControlStateClearedControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.VisibleControl.UniqueIDControl.HasChildViewStateControl.ControlsControl.ValidateRequestModeControl.ViewStateControl.ViewStateIgnoresCaseControl.ChildControlsCreatedControl.IsTrackingViewStateControl.DisposedControl.DataBindingControl.InitControl.LoadControl.PreRenderControl.Unloadobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

RecurrenceEditor()

C#
public RecurrenceEditor()

Properties

CssClassFormatString

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

C#
protected override string CssClassFormatString { get; }

Overrides: RadWebControl.CssClassFormatString

Example:
C#
protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

Culture

Gets or sets the selected culture. Localization strings will be loaded based on this value.

C#
public CultureInfo Culture { get; set; }
Property Value:

The culture.

DateFormat

Gets or sets the date format string.

C#
public string DateFormat { get; set; }
Property Value:

The date format string.

The default value of this property is inferred from the Thread.CurrentThread.CurrentCulture.DateTimeFormat.ShortDatePattern property.

EndDate

The end date of the first occurrence.

C#
public DateTime EndDate { get; set; }

The StartDate and EndDate must be set in order to obtain the recurrence rule.

FirstDayOfWeek

Gets or sets the first day of the week.

C#
[ClientControlProperty]
public DayOfWeek FirstDayOfWeek { get; set; }

This property is used when building Monthly and Yearly recurrence rules.

IsRecurring

C#
protected bool IsRecurring { get; }

Localization

Gets the localization.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public abstract IRecurrenceEditorStrings Localization { get; }
Property Value:

The localization.

RecurrenceRule

The currently selected recurrence rule.

C#
public RecurrenceRule RecurrenceRule { get; set; }

RecurrenceRuleText

The currently selected recurrence rule (as text).

C#
public string RecurrenceRuleText { get; set; }

SharedCalendar

Gets or sets the reference to the calendar that will be used for picking dates. This property allows you to use an existing RadCalendar instance for the RecurrenceEditor date picker.

C#
[Browsable(false)]
public RadCalendar SharedCalendar { get; set; }
Property Value:

The instance of the RadCalendar control if set; otherwise null.

SharedCalendarID

Gets or sets the ID of the calendar that will be used for picking dates. This property allows you to use an existing RadCalendar instance for the RecurrenceEditor date picker.

C#
public string SharedCalendarID { get; set; }
Property Value:

The string ID of the RadCalendar control if set; otherwise String.Empty.

The RecurrenceEditor will look for the RadCalendar instance in a way similar to how ASP.NET validators work. It will not go beyond the current naming container which means that you will not be able to configure a calendar that is inside a control in another naming container. You can still share a calendar, but you will have to pass a direct object reference via the SharedCalendar property.

StartDate

The start date of the first occurrence.

C#
public DateTime StartDate { get; set; }

The StartDate and EndDate must be set in order to obtain the recurrence rule.

SupportsRenderingMode

C#
protected override bool SupportsRenderingMode { get; }

Overrides: RadWebControl.SupportsRenderingMode

TagKey

C#
protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

ZIndex

Gets or sets a value indicating the base z-index of the recurrence editor.

C#
public int ZIndex { get; set; }
Property Value:

An integer value that specifies the desired base z-index. The default value is 2500.

The z-index value is used to position any detachable elements (like RadCalendar pop-ups) over other elements in the form.

Methods

CreateChildControls()

C#
protected override void CreateChildControls()

Overrides: Control.CreateChildControls()

CreateControls()

C#
protected virtual void CreateControls()

DescribeComponent(IScriptDescriptor)

C#
protected override void DescribeComponent(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeComponent(IScriptDescriptor)

LoadPostData(string, NameValueCollection)

Executed when post data is loaded from the request

C#
protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)
Parameters:postDataKeystringpostCollectionNameValueCollectionReturns:

bool

Overrides: RadWebControl.LoadPostData(string, NameValueCollection)

OnPreRender(EventArgs)

C#
protected override void OnPreRender(EventArgs e)
Parameters:eEventArgs

Overrides: RadWebControl.OnPreRender(EventArgs)

PopulateDropDownDescriptions()

C#
protected void PopulateDropDownDescriptions()

RaisePostBackEvent(string)

When implemented by a class, enables a server control to process an event raised when a form is posted to the server.

C#
public void RaisePostBackEvent(string eventArgument)
Parameters:eventArgumentstring

A string that represents an optional event argument to be passed to the event handler.

Implements: IPostBackEventHandler.RaisePostBackEvent(string)

RenderContents(HtmlTextWriter)

C#
protected override void RenderContents(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadWebControl.RenderContents(HtmlTextWriter)

SetRecurrenceFrequency(RecurrenceFrequency)

C#
protected void SetRecurrenceFrequency(RecurrenceFrequency frequency)
Parameters:frequencyRecurrenceFrequency

SetRecurrenceToggle(bool)

C#
protected virtual void SetRecurrenceToggle(bool value)
Parameters:valuebool
In this article
DefinitionConstructorsRecurrenceEditor()PropertiesCssClassFormatStringCultureDateFormatEndDateFirstDayOfWeekIsRecurringLocalizationRecurrenceRuleRecurrenceRuleTextSharedCalendarSharedCalendarIDStartDateSupportsRenderingModeTagKeyZIndexMethodsCreateChildControls()CreateControls()DescribeComponent(IScriptDescriptor)LoadPostData(string, NameValueCollection)OnPreRender(EventArgs)PopulateDropDownDescriptions()RaisePostBackEvent(string)RenderContents(HtmlTextWriter)SetRecurrenceFrequency(RecurrenceFrequency)SetRecurrenceToggle(bool)
Not finding the help you need?
Contact Support