Class RadScheduler

Inheritance
System.Object
RadControl
RadScheduler
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.Scheduler.dll

Syntax

[TelerikToolboxCategory("Scheduler")]
public class RadScheduler : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider, ICultureInfoProvider, ISchedulerData, IPrintable

Constructors

RadScheduler()

Initializes a new instance of the RadScheduler class.

Declaration
public RadScheduler()

Fields

CreateNewAppointmentCommand

Declaration
public static readonly CreateNewAppointmentCommand CreateNewAppointmentCommand
Field Value
CreateNewAppointmentCommand

ICalendarDataFormat

Declaration
public const string ICalendarDataFormat = "ICal"
Field Value
System.String

NavigateBackwardCommand

Declaration
public static readonly NavigateBackwardCommand NavigateBackwardCommand
Field Value
NavigateBackwardCommand

NavigateForwardCommand

Declaration
public static readonly NavigateForwardCommand NavigateForwardCommand
Field Value
NavigateForwardCommand

NavigateToNextAppointmentsCommand

Declaration
public static readonly NavigateToNextAppointmentsCommand NavigateToNextAppointmentsCommand
Field Value
NavigateToNextAppointmentsCommand

NavigateToNextViewCommand

Declaration
public static readonly NavigateToNextViewCommand NavigateToNextViewCommand
Field Value
NavigateToNextViewCommand

NavigateToPreviousAppointmentsCommand

Declaration
public static readonly NavigateToPreviousAppointmentsCommand NavigateToPreviousAppointmentsCommand
Field Value
NavigateToPreviousAppointmentsCommand

NavigateToPreviousViewCommand

Declaration
public static readonly NavigateToPreviousViewCommand NavigateToPreviousViewCommand
Field Value
NavigateToPreviousViewCommand

Properties

AccessibleInterval

Gets or sets the interval which is accessible to the user.

Declaration
public virtual DateTimeInterval AccessibleInterval { get; set; }
Property Value
DateTimeInterval

The accessible interval. Default value is DateTimeInterval.Empty.

ActiveView

Gets or sets the active view.

Declaration
public virtual SchedulerView ActiveView { get; set; }
Property Value
SchedulerView

The active view.

ActiveViewType

Gets or sets the type of the active view.

Declaration
public virtual SchedulerViewType ActiveViewType { get; set; }
Property Value
SchedulerViewType

The type of the active view.

AllowAppointmentCreateInline

Enables or disables creating appointments when typing in a cell.

Declaration
public virtual bool AllowAppointmentCreateInline { get; set; }
Property Value
System.Boolean

AllowAppointmentMove

Enables or disables appointment moving.

Declaration
public virtual bool AllowAppointmentMove { get; set; }
Property Value
System.Boolean

AllowAppointmentResize

Enables or disables appointment resizing

Declaration
public virtual bool AllowAppointmentResize { get; set; }
Property Value
System.Boolean

AllowAppointmentsMultiSelect

Gets or sets a value indicating whether selecting multiple appointments is possible.

Declaration
public bool AllowAppointmentsMultiSelect { get; set; }
Property Value
System.Boolean

AllowCopyPaste

Allows or disallows the end user to copy, cut and paste appointments using the default combinations Ctrl+X, Ctrl+C and Ctrl+V.

Declaration
public CopyPasteMode AllowCopyPaste { get; set; }
Property Value
CopyPasteMode

AllowMouseWheelSupport

Enables or disables mouse wheel support.

Declaration
public virtual bool AllowMouseWheelSupport { get; set; }
Property Value
System.Boolean

AllowToolTips

Gets or sets a value indicating whether tool tips are shown.

Declaration
public bool AllowToolTips { get; set; }
Property Value
System.Boolean

true if tool tips are shown; otherwise, false.

AllowViewNavigationOnDrag

Enables automatic navigation to previous/next view when dragging an appointment outside the boundaries of the control.

Declaration
public bool AllowViewNavigationOnDrag { get; set; }
Property Value
System.Boolean

AppointmentElementFactory

Gets or sets a factory class that is used when creating appointment elements.

Declaration
public IAppointmentElementFactory AppointmentElementFactory { get; set; }
Property Value
IAppointmentElementFactory

AppointmentExceptionOfRecurrenceIcon

Gets or sets the appointment exception of recurrence icon.

Declaration
public Image AppointmentExceptionOfRecurrenceIcon { get; set; }
Property Value
System.Drawing.Image

The appointment exception of recurrence icon.

AppointmentFactory

Gets or sets an IAppointmentFactory which used to create IEvent objects which represent the appointments in RadScheduler.

Declaration
public IAppointmentFactory AppointmentFactory { get; set; }
Property Value
IAppointmentFactory

AppointmentRecurrenceIcon

Gets or sets the appointment recurrence icon.

Declaration
public Image AppointmentRecurrenceIcon { get; set; }
Property Value
System.Drawing.Image

The appointment recurrence icon.

Appointments

Gets the appointments.

Declaration
public virtual SchedulerAppointmentCollection Appointments { get; }
Property Value
SchedulerAppointmentCollection

The appointments.

AppointmentsComparer

Gets or sets a comparer which will be used to determine the order of the appointments when they have the same Start and End dates.

Declaration
public IComparer<AppointmentElement> AppointmentsComparer { get; set; }
Property Value
System.Collections.Generic.IComparer<AppointmentElement>

AppointmentTitleFormat

Gets or sets the appointment title format.

Declaration
public string AppointmentTitleFormat { get; set; }
Property Value
System.String

The appointment title format.

AutoSize

AutoSize is not supported by RadScheduler. Setting it will have no effect.

Declaration
public override bool AutoSize { get; set; }
Property Value
System.Boolean

Overrides

AutoSizeAppointments

Gets or sets a value indicating whether the appointments elements should be sized to fit their content.

Declaration
public bool AutoSizeAppointments { get; set; }
Property Value
System.Boolean

BackColor

RadScheduler consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

Backgrounds

Gets the backgrounds.

Declaration
public virtual SchedulerBackgroundCollection Backgrounds { get; }
Property Value
SchedulerBackgroundCollection

The backgrounds.

Culture

Gets or sets the CultureInfo supported by this RadScheduler object.

Describes the names of the culture, the writing system, and the calendar used, as well as access to culture-specific objects that provide methods for common operations, such as formatting dates and sorting strings.

Declaration
public CultureInfo Culture { get; set; }
Property Value
System.Globalization.CultureInfo

Implements
Remarks

The culture names follow the RFC 1766 standard in the format "<languagecode2>-<country/regioncode2>", where <languagecode2> is a lowercase two-letter code derived from ISO 639-1 and <country/regioncode2> is an uppercase two-letter code derived from ISO 3166. For example, U.S. English is "en-US". In cases where a two-letter language code is not available, the three-letter code derived from ISO 639-2 is used; for example, the three-letter code "div" is used for cultures that use the Dhivehi language. Some culture names have suffixes that specify the script; for example, "-Cyrl" specifies the Cyrillic script, "-Latn" specifies the Latin script.

The following predefined CultureInfo names and identifiers are accepted and used by this class and other classes in the System.Globalization namespace.

Culture Name Culture Identifier Language-Country/Region
"" (empty string) 0x007F invariant culture
af 0x0036 Afrikaans
af-ZA 0x0436 Afrikaans - South Africa
sq 0x001C Albanian
sq-AL 0x041C Albanian - Albania
ar 0x0001 Arabic
ar-DZ 0x1401 Arabic - Algeria
ar-BH 0x3C01 Arabic - Bahrain
ar-EG 0x0C01 Arabic - Egypt
ar-IQ 0x0801 Arabic - Iraq
ar-JO 0x2C01 Arabic - Jordan
ar-KW 0x3401 Arabic - Kuwait
ar-LB 0x3001 Arabic - Lebanon
ar-LY 0x1001 Arabic - Libya
ar-MA 0x1801 Arabic - Morocco
ar-OM 0x2001 Arabic - Oman
ar-QA 0x4001 Arabic - Qatar
ar-SA 0x0401 Arabic - Saudi Arabia
ar-SY 0x2801 Arabic - Syria
ar-TN 0x1C01 Arabic - Tunisia
ar-AE 0x3801 Arabic - United Arab Emirates
ar-YE 0x2401 Arabic - Yemen
hy 0x002B Armenian
hy-AM 0x042B Armenian - Armenia
az 0x002C Azeri
az-AZ-Cyrl 0x082C Azeri (Cyrillic) - Azerbaijan
az-AZ-Latn 0x042C Azeri (Latin) - Azerbaijan
eu 0x002D Basque
eu-ES 0x042D Basque - Basque
be 0x0023 Belarusian
be-BY 0x0423 Belarusian - Belarus
bg 0x0002 Bulgarian
bg-BG 0x0402 Bulgarian - Bulgaria
ca 0x0003 Catalan
ca-ES 0x0403 Catalan - Catalan
zh-HK 0x0C04 Chinese - Hong Kong SAR
zh-MO 0x1404 Chinese - Macau SAR
zh-CN 0x0804 Chinese - China
zh-CHS 0x0004 Chinese (Simplified)
zh-SG 0x1004 Chinese - Singapore
zh-TW 0x0404 Chinese - Taiwan
zh-CHT 0x7C04 Chinese (Traditional)
hr 0x001A Croatian
hr-HR 0x041A Croatian - Croatia
cs 0x0005 Czech
cs-CZ 0x0405 Czech - Czech Republic
da 0x0006 Danish
da-DK 0x0406 Danish - Denmark
div 0x0065 Dhivehi
div-MV 0x0465 Dhivehi - Maldives
nl 0x0013 Dutch
nl-BE 0x0813 Dutch - Belgium
nl-NL 0x0413 Dutch - The Netherlands
en 0x0009 English
en-AU 0x0C09 English - Australia
en-BZ 0x2809 English - Belize
en-CA 0x1009 English - Canada
en-CB 0x2409 English - Caribbean
en-IE 0x1809 English - Ireland
en-JM 0x2009 English - Jamaica
en-NZ 0x1409 English - New Zealand
en-PH 0x3409 English - Philippines
en-ZA 0x1C09 English - South Africa
en-TT 0x2C09 English - Trinidad and Tobago
en-GB 0x0809 English - United Kingdom
en-US 0x0409 English - United States
en-ZW 0x3009 English - Zimbabwe
et 0x0025 Estonian
et-EE 0x0425 Estonian - Estonia
fo 0x0038 Faroese
fo-FO 0x0438 Faroese - Faroe Islands
fa 0x0029 Farsi
fa-IR 0x0429 Farsi - Iran
fi 0x000B Finnish
fi-FI 0x040B Finnish - Finland
fr 0x000C French
fr-BE 0x080C French - Belgium
fr-CA 0x0C0C French - Canada
fr-FR 0x040C French - France
fr-LU 0x140C French - Luxembourg
fr-MC 0x180C French - Monaco
fr-CH 0x100C French - Switzerland
gl 0x0056 Galician
gl-ES 0x0456 Galician - Galician
ka 0x0037 Georgian
ka-GE 0x0437 Georgian - Georgia
de 0x0007 German
de-AT 0x0C07 German - Austria
de-DE 0x0407 German - Germany
de-LI 0x1407 German - Liechtenstein
de-LU 0x1007 German - Luxembourg
de-CH 0x0807 German - Switzerland
el 0x0008 Greek
el-GR 0x0408 Greek - Greece
gu 0x0047 Gujarati
gu-IN 0x0447 Gujarati - India
he 0x000D Hebrew
he-IL 0x040D Hebrew - Israel
hi 0x0039 Hindi
hi-IN 0x0439 Hindi - India
hu 0x000E Hungarian
hu-HU 0x040E Hungarian - Hungary
is 0x000F Icelandic
is-IS 0x040F Icelandic - Iceland
id 0x0021 Indonesian
id-ID 0x0421 Indonesian - Indonesia
it 0x0010 Italian
it-IT 0x0410 Italian - Italy
it-CH 0x0810 Italian - Switzerland
ja 0x0011 Japanese
ja-JP 0x0411 Japanese - Japan
kn 0x004B Kannada
kn-IN 0x044B Kannada - India
kk 0x003F Kazakh
kk-KZ 0x043F Kazakh - Kazakhstan
kok 0x0057 Konkani
kok-IN 0x0457 Konkani - India
ko 0x0012 Korean
ko-KR 0x0412 Korean - Korea
ky 0x0040 Kyrgyz
ky-KZ 0x0440 Kyrgyz - Kazakhstan
lv 0x0026 Latvian
lv-LV 0x0426 Latvian - Latvia
lt 0x0027 Lithuanian
lt-LT 0x0427 Lithuanian - Lithuania
mk 0x002F Macedonian
mk-MK 0x042F Macedonian - FYROM
ms 0x003E Malay
ms-BN 0x083E Malay - Brunei
ms-MY 0x043E Malay - Malaysia
mr 0x004E Marathi
mr-IN 0x044E Marathi - India
mn 0x0050 Mongolian
mn-MN 0x0450 Mongolian - Mongolia
no 0x0014 Norwegian
nb-NO 0x0414 Norwegian (Bokmål) - Norway
nn-NO 0x0814 Norwegian (Nynorsk) - Norway
pl 0x0015 Polish
pl-PL 0x0415 Polish - Poland
pt 0x0016 Portuguese
pt-BR 0x0416 Portuguese - Brazil
pt-PT 0x0816 Portuguese - Portugal
pa 0x0046 Punjabi
pa-IN 0x0446 Punjabi - India
ro 0x0018 Romanian
ro-RO 0x0418 Romanian - Romania
ru 0x0019 Russian
ru-RU 0x0419 Russian - Russia
sa 0x004F Sanskrit
sa-IN 0x044F Sanskrit - India
sr-SP-Cyrl 0x0C1A Serbian (Cyrillic) - Serbia
sr-SP-Latn 0x081A Serbian (Latin) - Serbia
sk 0x001B Slovak
sk-SK 0x041B Slovak - Slovakia
sl 0x0024 Slovenian
sl-SI 0x0424 Slovenian - Slovenia
es 0x000A Spanish
es-AR 0x2C0A Spanish - Argentina
es-BO 0x400A Spanish - Bolivia
es-CL 0x340A Spanish - Chile
es-CO 0x240A Spanish - Colombia
es-CR 0x140A Spanish - Costa Rica
es-DO 0x1C0A Spanish - Dominican Republic
es-EC 0x300A Spanish - Ecuador
es-SV 0x440A Spanish - El Salvador
es-GT 0x100A Spanish - Guatemala
es-HN 0x480A Spanish - Honduras
es-MX 0x080A Spanish - Mexico
es-NI 0x4C0A Spanish - Nicaragua
es-PA 0x180A Spanish - Panama
es-PY 0x3C0A Spanish - Paraguay
es-PE 0x280A Spanish - Peru
es-PR 0x500A Spanish - Puerto Rico
es-ES 0x0C0A Spanish - Spain
es-UY 0x380A Spanish - Uruguay
es-VE 0x200A Spanish - Venezuela
sw 0x0041 Swahili
sw-KE 0x0441 Swahili - Kenya
sv 0x001D Swedish
sv-FI 0x081D Swedish - Finland
sv-SE 0x041D Swedish - Sweden
syr 0x005A Syriac
syr-SY 0x045A Syriac - Syria
ta 0x0049 Tamil
ta-IN 0x0449 Tamil - India
tt 0x0044 Tatar
tt-RU 0x0444 Tatar - Russia
te 0x004A Telugu
te-IN 0x044A Telugu - India
th 0x001E Thai
th-TH 0x041E Thai - Thailand
tr 0x001F Turkish
tr-TR 0x041F Turkish - Turkey
uk 0x0022 Ukrainian
uk-UA 0x0422 Ukrainian - Ukraine
ur 0x0020 Urdu
ur-PK 0x0420 Urdu - Pakistan
uz 0x0043 Uzbek
uz-UZ-Cyrl 0x0843 Uzbek (Cyrillic) - Uzbekistan
uz-UZ-Latn 0x0443 Uzbek (Latin) - Uzbekistan
vi 0x002A Vietnamese
vi-VN 0x042A Vietnamese - Vietnam

DataSource

Gets or sets the data source.

Declaration
public virtual SchedulerDataSource DataSource { get; set; }
Property Value
SchedulerDataSource

The data source.

DateTimeFormat

Gets or sets a DateTimeFormatInfo instance that defines the culturally appropriate format of displaying dates and times as specified by the default culture.

Declaration
public DateTimeFormatInfo DateTimeFormat { get; }
Property Value
System.Globalization.DateTimeFormatInfo

Remarks

A DateTimeFormatInfo can be created only for the invariant culture or for specific cultures, not for neutral cultures.

The cultures are generally grouped into three sets: the invariant culture, the neutral cultures, and the specific cultures.

The invariant culture is culture-insensitive. You can specify the invariant culture by name using an empty string ("") or by its culture identifier 0x007F. InvariantCulture retrieves an instance of the invariant culture. It is associated with the English language but not with any country/region. It can be used in almost any method in the Globalization namespace that requires a culture. If a security decision depends on a string comparison or a case-change operation, use the InvariantCulture to ensure that the behavior will be consistent regardless of the culture settings of the system. However, the invariant culture must be used only by processes that require culture-independent results, such as system services; otherwise, it produces results that might be linguistically incorrect or culturally inappropriate.

A neutral culture is a culture that is associated with a language but not with a country/region. A specific culture is a culture that is associated with a language and a country/region. For example, "fr" is a neutral culture and "fr-FR" is a specific culture. Note that "zh-CHS" (Simplified Chinese) and "zh-CHT" (Traditional Chinese) are neutral cultures.

The user might choose to override some of the values associated with the current culture of Windows through Regional and Language Options (or Regional Options or Regional Settings) in Control Panel. For example, the user might choose to display the date in a different format or to use a currency other than the default for the culture.

If UseUserOverride is true and the specified culture matches the current culture of Windows, the CultureInfo uses those overrides, including user settings for the properties of the DateTimeFormatInfo instance returned by the DateTimeFormat property, the properties of the NumberFormatInfo instance returned by the NumberFormat property, and the properties of the CompareInfo instance returned by the CompareInfo property. If the user settings are incompatible with the culture associated with the CultureInfo (for example, if the selected calendar is not one of the OptionalCalendars ), the results of the methods and the values of the properties are undefined.

Note: In this version of RadCalendar the NumberFormatInfo instance returned by the NumberFormat property is not taken into account.

DefaultSize

Gets the default size of the control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

Dock

Declaration
public DockStyle Dock { get; set; }
Property Value
System.Windows.Forms.DockStyle

DragDropBehavior

Gets or sets the AppointmentDraggingBehavior which is responsible for performing the drag and drop of appointments in RadScheduler.

Declaration
public AppointmentDraggingBehavior DragDropBehavior { get; }
Property Value
AppointmentDraggingBehavior

ElementProvider

Gets or sets the SchedulerElementProvider which is responsible for creating and recycling of most of RadScheduler's visual elements.

Declaration
public SchedulerElementProvider ElementProvider { get; set; }
Property Value
SchedulerElementProvider

EnableCustomCellDrawing

Gets or sets a value indicating whether the CellPaint event will be fired.

Declaration
public bool EnableCustomCellDrawing { get; set; }
Property Value
System.Boolean

EnableExactTimeRendering

Gets or sets whether appointments are rendered according to their start and end time or are aligned to the scheduler grid lines.

Declaration
public bool EnableExactTimeRendering { get; set; }
Property Value
System.Boolean

FocusedDate

Gets or sets the value that is used by RadScheduler to determine the viewable area displayed .

Declaration
public DateTime FocusedDate { get; set; }
Property Value
System.DateTime

Remarks

By default, the FocusedDate property returns the current system date when in runtime, and in design mode defaults to System.DateTime.MinValue. When the FocusedDate is set, from that point, the value returned by the FocusedDate property is the one the user sets.

ForeColor

RadScheduler consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

GroupType

Gets or sets the type of grouping.

Declaration
public GroupType GroupType { get; set; }
Property Value
GroupType

Implements

HeaderFormat

Gets or sets the header format.

Declaration
public string HeaderFormat { get; set; }
Property Value
System.String

The header format.

HighlightToday

Gets or sets value whether to show the today visual state of scheduler cells

Declaration
public bool HighlightToday { get; set; }
Property Value
System.Boolean

Holidays

Represents the collection with Holidays object

Declaration
public SchedulerHolidays Holidays { get; set; }
Property Value
SchedulerHolidays

ModernAppointmentBackColor

Gets or sets the back color of the appointment when it has the default None category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentBackColor { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentBackColor2

Gets or sets the second back color of the appointment when it has a linear gradient in the default None category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentBackColor2 { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentBlueColor

Gets or sets the back color of the appointment when it has the Blue category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentBlueColor { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentBorderColor

Gets or sets the border color of the appointment when it has the default None category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentBorderColor { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentForeColor

Gets or sets the fore color of the appointment. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentForeColor { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentGrayColor

Gets or sets the back color of the appointment when it has the Gray category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentGrayColor { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentGreenColor

Gets or sets the back color of the appointment when it has the Green category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentGreenColor { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentLavenderColor

Gets or sets the back color of the appointment when it has the Lavender category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentLavenderColor { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentOliveColor

Gets or sets the back color of the appointment when it has the Olive category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentOliveColor { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentOrangeColor

Gets or sets the back color of the appointment when it has the Orange category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentOrangeColor { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentPinkColor

Gets or sets the back color of the appointment when it has the Pink category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentPinkColor { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentPurpleColor

Gets or sets the back color of the appointment when it has the Purple category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentPurpleColor { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentRaspberryColor

Gets or sets the back color of the appointment when it has the Raspberry category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentRaspberryColor { get; set; }
Property Value
System.Drawing.Color

ModernAppointmentYellowColor

Gets or sets the back color of the appointment when it has the Yellow category. This color is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public Color ModernAppointmentYellowColor { get; set; }
Property Value
System.Drawing.Color

Padding

Declaration
public Padding Padding { get; set; }
Property Value
System.Windows.Forms.Padding

PaintModernApppointmentsBorders

Gets or sets whether the borders of the appointment element will be painted. This color is set via the ModernAppointmentBorderColor property and is applied only for appointments with modern styles. Check the UseModernAppointmentStyles property for more details.

Declaration
public bool PaintModernApppointmentsBorders { get; set; }
Property Value
System.Boolean

PrintSettingsDialogFactory

Declaration
public IPrintSettingsDialogFactory PrintSettingsDialogFactory { get; set; }
Property Value
IPrintSettingsDialogFactory

PrintStyle

Gets or sets a value indicating how the RadScheduler is printed.

Declaration
public SchedulerPrintStyle PrintStyle { get; set; }
Property Value
SchedulerPrintStyle

RadContextMenu

Gets or sets the shortcut menu associated with the control.

Declaration
public virtual RadContextMenu RadContextMenu { get; set; }
Property Value
RadContextMenu

ReadOnly

Gets or sets a value indicating whether appointments can be changed.

Declaration
public virtual bool ReadOnly { get; set; }
Property Value
System.Boolean

true if the scheduler is read-only; otherwise, false.

Reminders

Gets the predefined reminder time intervals.

Declaration
public virtual SchedulerReminderCollection Reminders { get; }
Property Value
SchedulerReminderCollection

The reminder intervals.

ResizeBehavior

Gets or sets the AppointmentResizingBehavior which is responsible for performing the resizing of appointments in RadScheduler.

Declaration
public AppointmentResizingBehavior ResizeBehavior { get; }
Property Value
AppointmentResizingBehavior

Resources

Gets the resources.

Declaration
public virtual SchedulerResourceCollection Resources { get; }
Property Value
SchedulerResourceCollection

The resources.

SaveLoadRemindersBehavior

Gets or sets the behavior responsible for saving and loading appointment reminders.

Declaration
public SchedulerSaveLoadRemindersBehavior SaveLoadRemindersBehavior { get; set; }
Property Value
SchedulerSaveLoadRemindersBehavior

SchedulerElement

Gets the scheduler element.

Declaration
public RadSchedulerElement SchedulerElement { get; }
Property Value
RadSchedulerElement

The scheduler element.

SchedulerInputBehavior

Gets or sets the SchedulerInputBehavior which is responsible for handling the mouse and keyboard input. Be sure to dispose the old instance when replacing it with a new one.

Declaration
public SchedulerInputBehavior SchedulerInputBehavior { get; set; }
Property Value
SchedulerInputBehavior

SelectionBehavior

Gets or sets the SchedulerSelectionBehavior which is responsible for handling the selection of cells and appointments in RadScheduler.

Declaration
public SchedulerSelectionBehavior SelectionBehavior { get; set; }
Property Value
SchedulerSelectionBehavior

ShowAllDayAppointmentStatus

Gets or sets a value indicating whether to display all day appointment status.

Declaration
public virtual bool ShowAllDayAppointmentStatus { get; set; }
Property Value
System.Boolean

true if all day appointment status is displayed; otherwise, false.

ShowAppointmentStatus

Gets or sets a value indicating whether the appointment status should be displayed.

Declaration
public virtual bool ShowAppointmentStatus { get; set; }
Property Value
System.Boolean

true if appointment status is displayed otherwise, false.

ShowNavigationElements

Gets or sets a value whether to show the "Previous/Next Appointment" navigation elements.

Declaration
public bool ShowNavigationElements { get; set; }
Property Value
System.Boolean

Statuses

Gets the statuses.

Declaration
public virtual SchedulerStatusCollection Statuses { get; }
Property Value
SchedulerStatusCollection

The statuses.

SystemTimeZone

Gets or sets the selected time zone.

Declaration
public SchedulerTimeZone SystemTimeZone { get; set; }
Property Value
SchedulerTimeZone

The selected time zone.

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

UseCompatibleTextRendering

Declaration
public bool UseCompatibleTextRendering { get; set; }
Property Value
System.Boolean

UseModernAppointmentStyles

Determines whether the appointments are painted with modern colors and borders. The default value is true.

Declaration
public bool UseModernAppointmentStyles { get; set; }
Property Value
System.Boolean

ViewElement

Gets the view element.

Declaration
public SchedulerViewElement ViewElement { get; }
Property Value
SchedulerViewElement

The view element.

Methods

AddNewAppointmentWithDialog(DateTimeInterval, Boolean, Boolean, SchedulerResourceCollection)

Shows the appointment edit dialog to add a new appointment.

Declaration
public void AddNewAppointmentWithDialog(DateTimeInterval interval, bool allDay, bool recurringAppointment, SchedulerResourceCollection resources)
Parameters
DateTimeInterval interval

The interval to pass to the ShowAppointmentEditDialog method.
System.Boolean allDay

Indicates whether the appointment should be an AllDay appointment.
System.Boolean recurringAppointment

Indicates whether the appointment should be a recurring one.
SchedulerResourceCollection resources

The resources of the new appointment.

AddNewAppointmentWithDialog(DateTimeInterval, Boolean, SchedulerResourceCollection)

Shows the appointment edit dialog to add a new appointment.

Declaration
public void AddNewAppointmentWithDialog(DateTimeInterval interval, bool recurringAppointment, SchedulerResourceCollection resources)
Parameters
DateTimeInterval interval

The interval to pass to the ShowAppointmentEditDialog method.
System.Boolean recurringAppointment

Indicates whether the appointment should be a recurring one.
SchedulerResourceCollection resources

The resources of the new appointment.

AddNewAppointmentWithDialog(IEvent, DateTimeInterval, Boolean, SchedulerResourceCollection)

Declaration
public virtual void AddNewAppointmentWithDialog(IEvent appointment, DateTimeInterval interval, bool recurringAppointment, SchedulerResourceCollection resources)
Parameters
IEvent appointment

DateTimeInterval interval

System.Boolean recurringAppointment

SchedulerResourceCollection resources

ClearReminders()

Clears the reminders of all appointments. Usually this method is used before LoadReminders is called.

Declaration
public void ClearReminders()

ControlDefinesThemeForElement(RadElement)

Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
RadElement element

Returns
System.Boolean

Overrides

Copy()

Copies the currently selected appointments to the clipboard.

Declaration
public void Copy()

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

CreateAppointmentEditDialog()

Creates the appointment edit dialog. Overwrite in an inheriting class to replace the dialog used to edit appointments.

Declaration
protected virtual IEditAppointmentDialog CreateAppointmentEditDialog()
Returns
IEditAppointmentDialog

CreateBackgroundInfo(AppointmentBackground, String, Color, Color)

Declaration
protected virtual AppointmentBackgroundInfo CreateBackgroundInfo(AppointmentBackground category, string stringId, Color backColor, Color backColor2)
Parameters
AppointmentBackground category

System.String stringId

System.Drawing.Color backColor

System.Drawing.Color backColor2

Returns
AppointmentBackgroundInfo

CreateBackgroundInfo(AppointmentBackground, String, Color, Color, Color, Color)

Declaration
protected virtual AppointmentBackgroundInfo CreateBackgroundInfo(AppointmentBackground category, string stringId, Color backColor, Color backColor2, Color foreColor, Color borderColor)
Parameters
AppointmentBackground category

System.String stringId

System.Drawing.Color backColor

System.Drawing.Color backColor2

System.Drawing.Color foreColor

System.Drawing.Color borderColor

Returns
AppointmentBackgroundInfo

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

CreateRadSchedulerElement()

Declaration
protected virtual RadSchedulerElement CreateRadSchedulerElement()
Returns
RadSchedulerElement

Cut()

Deletes the currently selected appointments and saves them to the clipboard.

Declaration
public void Cut()

DataBind()

Declaration
public void DataBind()

Dispose(Boolean)

Releases the unmanaged resources used by the System.ComponentModel.Component and optionally releases the managed resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

Export(Stream, ISchedulerExporter)

Exports the data in this RadScheduler instance to the specified stream, using the specified ISchedulerExporter instance.

Declaration
public virtual void Export(Stream stream, ISchedulerExporter exporter)
Parameters
System.IO.Stream stream

ISchedulerExporter exporter

Export(ISchedulerExporter)

Exports the data in this RadScheduler instance in a string, using the specified ISchedulerExporter instance.

Declaration
public virtual string Export(ISchedulerExporter exporter)
Parameters
ISchedulerExporter exporter

Returns
System.String

FillDefaultBackgrounds(SchedulerBackgroundCollection)

Fills the default backgrounds.

Declaration
protected virtual void FillDefaultBackgrounds(SchedulerBackgroundCollection backgrounds)
Parameters
SchedulerBackgroundCollection backgrounds

The background collection in which to add the background objects.

FillDefaultReminders(SchedulerReminderCollection)

Fills the default reminder intervals.

Declaration
protected virtual void FillDefaultReminders(SchedulerReminderCollection reminders)
Parameters
SchedulerReminderCollection reminders

The reminder collection in which to add the reminder objects.

FillDefaultStatuses(SchedulerStatusCollection)

Fills the default statuses.

Declaration
protected virtual void FillDefaultStatuses(SchedulerStatusCollection statuses)
Parameters
SchedulerStatusCollection statuses

The status collection in which to add the status objects.

GetAgendaView()

Gets the agenda view.

Declaration
public SchedulerAgendaView GetAgendaView()
Returns
SchedulerAgendaView

GetBackgroundStorage()

Gets the background storage.

Declaration
public virtual ISchedulerStorage<IAppointmentBackgroundInfo> GetBackgroundStorage()
Returns
ISchedulerStorage<IAppointmentBackgroundInfo>

Implements

GetDayView()

Gets the day view.

Declaration
public SchedulerDayView GetDayView()
Returns
SchedulerDayView

GetEventStorage()

Gets the event storage.

Declaration
public virtual ISchedulerStorage<IEvent> GetEventStorage()
Returns
ISchedulerStorage<IEvent>

Implements

GetImageElement(RadElement, Color)

Declaration
protected LightVisualElement GetImageElement(RadElement element, Color backColor)
Parameters
RadElement element

System.Drawing.Color backColor

Returns
LightVisualElement

GetMonthView()

Gets the month view.

Declaration
public SchedulerMonthView GetMonthView()
Returns
SchedulerMonthView

GetMultiDayView()

Gets the multi day view.

Declaration
public SchedulerMultiDayView GetMultiDayView()
Returns
SchedulerMultiDayView

GetReminderStorage()

Gets the reminder storage.

Declaration
public virtual ISchedulerStorage<IAppointmentReminderInfo> GetReminderStorage()
Returns
ISchedulerStorage<IAppointmentReminderInfo>

Implements

GetResourceStorage()

Gets the resource storage.

Declaration
public virtual ISchedulerStorage<IResource> GetResourceStorage()
Returns
ISchedulerStorage<IResource>

Implements

GetStatusStorage()

Gets the status storage.

Declaration
public virtual ISchedulerStorage<IAppointmentStatusInfo> GetStatusStorage()
Returns
ISchedulerStorage<IAppointmentStatusInfo>

Implements

GetTimelineView()

Gets the timeline view.

Declaration
public SchedulerTimelineView GetTimelineView()
Returns
SchedulerTimelineView

GetValuesByViewElement(SchedulerVisualElement)

Declaration
protected virtual ViewData GetValuesByViewElement(SchedulerVisualElement viewElement)
Parameters
SchedulerVisualElement viewElement

Returns
ViewData

GetWeekView()

Gets the week view.

Declaration
public SchedulerWeekView GetWeekView()
Returns
SchedulerWeekView

HandleDayViewPan(PanGestureEventArgs, SchedulerDayView)

Declaration
protected virtual void HandleDayViewPan(PanGestureEventArgs args, SchedulerDayView view)
Parameters
PanGestureEventArgs args

SchedulerDayView view

HandleMonthViewPan(PanGestureEventArgs, SchedulerMonthView)

Declaration
protected virtual void HandleMonthViewPan(PanGestureEventArgs args, SchedulerMonthView monthView)
Parameters
PanGestureEventArgs args

SchedulerMonthView monthView

HandleTimelineViewPan(PanGestureEventArgs, SchedulerTimelineView)

Declaration
protected virtual void HandleTimelineViewPan(PanGestureEventArgs args, SchedulerTimelineView timeLine)
Parameters
PanGestureEventArgs args

SchedulerTimelineView timeLine

HandleWeekViewPan(PanGestureEventArgs, SchedulerWeekView)

Declaration
protected virtual void HandleWeekViewPan(PanGestureEventArgs args, SchedulerWeekView weekView)
Parameters
PanGestureEventArgs args

SchedulerWeekView weekView

Import(Stream, ISchedulerImporter)

Imports the data from the specified stream into this RadScheduler instance, using the specified ISchedulerImporter instance.

Declaration
public virtual void Import(Stream stream, ISchedulerImporter importer)
Parameters
System.IO.Stream stream

ISchedulerImporter importer

Import(String, ISchedulerImporter)

Imports the data from the specified string into this RadScheduler instance, using the specified ISchedulerImporter instance.

Declaration
public virtual void Import(string stringData, ISchedulerImporter importer)
Parameters
System.String stringData

ISchedulerImporter importer

LoadReminders(Stream)

Loads the reminders from the specified stream.

Declaration
public void LoadReminders(Stream stream)
Parameters
System.IO.Stream stream

The steam to load reminders from.

LoadReminders(String)

Loads the reminders from the specified file path.

Declaration
public void LoadReminders(string filePath)
Parameters
System.String filePath

The path to the file to load reminders from.

OnActiveViewChanged(SchedulerView, SchedulerView)

Declaration
protected virtual void OnActiveViewChanged(SchedulerView oldView, SchedulerView newView)
Parameters
SchedulerView oldView

SchedulerView newView

OnActiveViewChanging(SchedulerView, SchedulerView)

Declaration
protected virtual bool OnActiveViewChanging(SchedulerView oldView, SchedulerView newView)
Parameters
SchedulerView oldView

SchedulerView newView

Returns
System.Boolean

OnAddAppointments(IList)

Called when appointments have been added.

Declaration
protected virtual void OnAddAppointments(IList list)
Parameters
System.Collections.IList list

The list of added appointments.

OnAppointmentAdded(AppointmentAddedEventArgs)

Declaration
protected virtual void OnAppointmentAdded(AppointmentAddedEventArgs args)
Parameters
AppointmentAddedEventArgs args

OnAppointmentChanged(IEvent, String)

Declaration
protected virtual void OnAppointmentChanged(IEvent appointment, string propertyName)
Parameters
IEvent appointment

System.String propertyName

OnAppointmentChanged(IEvent, String[])

Declaration
protected virtual void OnAppointmentChanged(IEvent appointment, params string[] propertyNames)
Parameters
IEvent appointment

System.String[] propertyNames

OnAppointmentDeleted(SchedulerAppointmentEventArgs)

Declaration
protected virtual void OnAppointmentDeleted(SchedulerAppointmentEventArgs args)
Parameters
SchedulerAppointmentEventArgs args

OnAppointmentDeleting(SchedulerAppointmentCancelEventArgs)

Declaration
protected virtual void OnAppointmentDeleting(SchedulerAppointmentCancelEventArgs args)
Parameters
SchedulerAppointmentCancelEventArgs args

OnAppointmentDropped(AppointmentMovedEventArgs)

Declaration
protected virtual void OnAppointmentDropped(AppointmentMovedEventArgs args)
Parameters
AppointmentMovedEventArgs args

OnAppointmentDropping(AppointmentMovingEventArgs)

Declaration
protected virtual void OnAppointmentDropping(AppointmentMovingEventArgs args)
Parameters
AppointmentMovingEventArgs args

OnAppointmentEditDialogShowing(IEvent, IEditAppointmentDialog)

Declaration
protected virtual IEditAppointmentDialog OnAppointmentEditDialogShowing(IEvent appointment, IEditAppointmentDialog dialog)
Parameters
IEvent appointment

IEditAppointmentDialog dialog

Returns
IEditAppointmentDialog

OnAppointmentElementDoubleClick(Object, EventArgs)

Declaration
protected virtual void OnAppointmentElementDoubleClick(object sender, EventArgs args)
Parameters
System.Object sender

System.EventArgs args

OnAppointmentElementMouseDown(Object, MouseEventArgs)

Declaration
protected virtual void OnAppointmentElementMouseDown(object sender, MouseEventArgs args)
Parameters
System.Object sender

System.Windows.Forms.MouseEventArgs args

OnAppointmentElementMouseMove(Object, MouseEventArgs)

Declaration
protected virtual void OnAppointmentElementMouseMove(object sender, MouseEventArgs args)
Parameters
System.Object sender

System.Windows.Forms.MouseEventArgs args

OnAppointmentElementMouseUp(Object, MouseEventArgs)

Declaration
protected virtual void OnAppointmentElementMouseUp(object sender, MouseEventArgs args)
Parameters
System.Object sender

System.Windows.Forms.MouseEventArgs args

OnAppointmentFormatting(SchedulerAppointmentEventArgs)

Declaration
protected virtual void OnAppointmentFormatting(SchedulerAppointmentEventArgs args)
Parameters
SchedulerAppointmentEventArgs args

OnAppointmentMouseDown(SchedulerAppointmentMouseEventArgs)

Declaration
protected virtual void OnAppointmentMouseDown(SchedulerAppointmentMouseEventArgs args)
Parameters
SchedulerAppointmentMouseEventArgs args

OnAppointmentMouseUp(SchedulerAppointmentMouseEventArgs)

Declaration
protected virtual void OnAppointmentMouseUp(SchedulerAppointmentMouseEventArgs args)
Parameters
SchedulerAppointmentMouseEventArgs args

OnAppointmentMoved(AppointmentMovedEventArgs)

Declaration
protected virtual void OnAppointmentMoved(AppointmentMovedEventArgs args)
Parameters
AppointmentMovedEventArgs args

OnAppointmentMoving(AppointmentMovingEventArgs)

Declaration
protected virtual void OnAppointmentMoving(AppointmentMovingEventArgs args)
Parameters
AppointmentMovingEventArgs args

OnAppointmentRender(AppointmentRenderEventArgs)

Raises the AppointmentRender event.

Declaration
protected virtual void OnAppointmentRender(AppointmentRenderEventArgs args)
Parameters
AppointmentRenderEventArgs args

The AppointmentRenderEventArgs instance containing the event data.

OnAppointmentResized(AppointmentResizedEventArgs)

Declaration
protected virtual void OnAppointmentResized(AppointmentResizedEventArgs args)
Parameters
AppointmentResizedEventArgs args

OnAppointmentResizeEnd(IEvent)

Declaration
protected virtual void OnAppointmentResizeEnd(IEvent appointment)
Parameters
IEvent appointment

OnAppointmentResizeStart(SchedulerAppointmentCancelEventArgs)

Declaration
protected virtual void OnAppointmentResizeStart(SchedulerAppointmentCancelEventArgs args)
Parameters
SchedulerAppointmentCancelEventArgs args

OnAppointmentResizing(AppointmentResizingEventArgs)

Declaration
protected virtual void OnAppointmentResizing(AppointmentResizingEventArgs args)
Parameters
AppointmentResizingEventArgs args

OnAppointmentsChanged(IList, String)

Called when one or more appointments have changed.

Declaration
protected virtual void OnAppointmentsChanged(IList list, string propertyName)
Parameters
System.Collections.IList list

The list of changed appointments.
System.String propertyName

Name of the property.

OnAppointmentsCopying(SchedulerClipboardEventArgs)

Declaration
protected virtual void OnAppointmentsCopying(SchedulerClipboardEventArgs args)
Parameters
SchedulerClipboardEventArgs args

OnAppointmentSelected(SchedulerAppointmentSelectedEventArgs)

Declaration
protected virtual void OnAppointmentSelected(SchedulerAppointmentSelectedEventArgs args)
Parameters
SchedulerAppointmentSelectedEventArgs args

OnAppointmentSelecting(SchedulerAppointmentCancelEventArgs)

Declaration
protected virtual void OnAppointmentSelecting(SchedulerAppointmentCancelEventArgs args)
Parameters
SchedulerAppointmentCancelEventArgs args

OnAppointmentsPasting(SchedulerClipboardEventArgs)

Declaration
protected virtual void OnAppointmentsPasting(SchedulerClipboardEventArgs args)
Parameters
SchedulerClipboardEventArgs args

OnCellClick(SchedulerCellEventArgs)

Declaration
protected virtual void OnCellClick(SchedulerCellEventArgs args)
Parameters
SchedulerCellEventArgs args

OnCellElementDoubleClick(Object, EventArgs)

Declaration
protected virtual void OnCellElementDoubleClick(object sender, EventArgs args)
Parameters
System.Object sender

System.EventArgs args

OnCellElementKeyDown(Object, KeyEventArgs)

Declaration
protected virtual void OnCellElementKeyDown(object sender, KeyEventArgs args)
Parameters
System.Object sender

System.Windows.Forms.KeyEventArgs args

OnCellElementKeyPress(Object, KeyPressEventArgs)

Declaration
protected virtual void OnCellElementKeyPress(object sender, KeyPressEventArgs args)
Parameters
System.Object sender

System.Windows.Forms.KeyPressEventArgs args

OnCellElementKeyUp(Object, KeyEventArgs)

Declaration
protected virtual void OnCellElementKeyUp(object sender, KeyEventArgs args)
Parameters
System.Object sender

System.Windows.Forms.KeyEventArgs args

OnCellElementMouseDown(Object, MouseEventArgs)

Declaration
protected virtual void OnCellElementMouseDown(object sender, MouseEventArgs args)
Parameters
System.Object sender

System.Windows.Forms.MouseEventArgs args

OnCellElementMouseMove(Object, MouseEventArgs)

Declaration
protected virtual void OnCellElementMouseMove(object sender, MouseEventArgs args)
Parameters
System.Object sender

System.Windows.Forms.MouseEventArgs args

OnCellElementMouseUp(Object, MouseEventArgs)

Declaration
protected virtual void OnCellElementMouseUp(object sender, MouseEventArgs args)
Parameters
System.Object sender

System.Windows.Forms.MouseEventArgs args

OnCellFormatting(SchedulerCellEventArgs)

Declaration
protected virtual void OnCellFormatting(SchedulerCellEventArgs args)
Parameters
SchedulerCellEventArgs args

OnCellOverflowButtonClicked(SchedulerCellEventArgs)

Declaration
protected virtual bool OnCellOverflowButtonClicked(SchedulerCellEventArgs args)
Parameters
SchedulerCellEventArgs args

Returns
System.Boolean

OnCellPaint(SchedulerCellPaintEventArgs)

Raises the CellPaint event.

Declaration
protected virtual void OnCellPaint(SchedulerCellPaintEventArgs args)
Parameters
SchedulerCellPaintEventArgs args

The SchedulerCellPaintEventArgs instance containing the event data.

OnCellSelectionChanged(EventArgs)

Declaration
protected virtual void OnCellSelectionChanged(EventArgs args)
Parameters
System.EventArgs args

OnCellSelectionChanging(SchedulerCellSelectingEventArgs)

Declaration
protected virtual void OnCellSelectionChanging(SchedulerCellSelectingEventArgs args)
Parameters
SchedulerCellSelectingEventArgs args

OnContextMenuOpening(SchedulerContextMenuOpeningEventArgs)

Raises the ContextMenuOpening event.

Declaration
protected virtual void OnContextMenuOpening(SchedulerContextMenuOpeningEventArgs e)
Parameters
SchedulerContextMenuOpeningEventArgs e

The SchedulerContextMenuOpeningEventArgs instance containing the event data.

OnCultureChanged()

Fires the CultureChanged event.

Declaration
protected virtual void OnCultureChanged()

OnDataBindingComplete(Object, EventArgs)

Declaration
protected virtual void OnDataBindingComplete(object sender, EventArgs args)
Parameters
System.Object sender

System.EventArgs args

OnEditorRequired(SchedulerEditorRequiredArgs)

Fired when the editor should be opened

Declaration
protected virtual void OnEditorRequired(SchedulerEditorRequiredArgs args)
Parameters
SchedulerEditorRequiredArgs args

OnGotFocus(EventArgs)

Declaration
protected override void OnGotFocus(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

Overrides

OnLoad(Size)

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

Overrides

OnMouseDown(MouseEventArgs)

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseEnter(EventArgs)

Declaration
protected override void OnMouseEnter(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseLeave(EventArgs)

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseUp(MouseEventArgs)

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseWheel(MouseEventArgs)

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnPanGesture(PanGestureEventArgs)

Declaration
protected override void OnPanGesture(PanGestureEventArgs args)
Parameters
PanGestureEventArgs args

Overrides

OnRecurrenceDeleteDialogShowing(IEvent, IDeleteRecurringAppointmentDialog)

Declaration
protected virtual IDeleteRecurringAppointmentDialog OnRecurrenceDeleteDialogShowing(IEvent appointment, IDeleteRecurringAppointmentDialog dialog)
Parameters
IEvent appointment

IDeleteRecurringAppointmentDialog dialog

Returns
IDeleteRecurringAppointmentDialog

OnRecurrenceEditDialogShowing(IEvent, IEditRecurrenceDialog)

Declaration
protected virtual IEditRecurrenceDialog OnRecurrenceEditDialogShowing(IEvent appointment, IEditRecurrenceDialog dialog)
Parameters
IEvent appointment

IEditRecurrenceDialog dialog

Returns
IEditRecurrenceDialog

OnRemoveAppointments(IList)

Called when appointments have been removed.

Declaration
protected virtual void OnRemoveAppointments(IList list)
Parameters
System.Collections.IList list

The list of removed appointments.

OnReplaceAppointments(IList, IList)

Called when appointments have been replaced.

Declaration
protected virtual void OnReplaceAppointments(IList oldItems, IList newItems)
Parameters
System.Collections.IList oldItems

The old items.
System.Collections.IList newItems

The new items.

OnResourceStartIndexChanged()

Declaration
protected virtual void OnResourceStartIndexChanged()

OnResourceStartIndexChanging(ResourceIndexChangingEventArgs)

Declaration
protected virtual void OnResourceStartIndexChanging(ResourceIndexChangingEventArgs args)
Parameters
ResourceIndexChangingEventArgs args

OnRulerTextFormatting(RulerTextFormattingEventArgs)

Raises the RulerTextFormatting event.

Declaration
protected virtual void OnRulerTextFormatting(RulerTextFormattingEventArgs args)
Parameters
RulerTextFormattingEventArgs args

The event arguments.

OnThemeChanged()

Declaration
protected override void OnThemeChanged()
Overrides

OnUpdateAppointments()

Called when appointments have to be refreshed.

Declaration
protected virtual void OnUpdateAppointments()

OnValidated(EventArgs)

Declaration
protected override void OnValidated(EventArgs e)
Parameters
System.EventArgs e

OnViewNavigated(SchedulerViewNavigatedEventArgs)

Declaration
protected virtual void OnViewNavigated(SchedulerViewNavigatedEventArgs args)
Parameters
SchedulerViewNavigatedEventArgs args

OnViewNavigating(SchedulerViewNavigatingEventArgs)

Declaration
protected virtual void OnViewNavigating(SchedulerViewNavigatingEventArgs args)
Parameters
SchedulerViewNavigatingEventArgs args

OnZoomGesture(ZoomGestureEventArgs)

Declaration
protected override void OnZoomGesture(ZoomGestureEventArgs args)
Parameters
ZoomGestureEventArgs args

Overrides

Paste()

Pastes the content from the clipboard to the scheduler.

Declaration
public void Paste()

Print()

Directly prints the RadScheduler to the default printer.

Declaration
public virtual void Print()

Print(Boolean)

Directly prints the RadScheduler to the default printer or shows printer settitngs and then prints the RadGridView.

Declaration
public virtual void Print(bool showPrinterSettings)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.

Print(Boolean, RadPrintDocument)

Directly prints the RadScheduler to the default printer or shows printer settitngs and then prints the RadGridView.

Declaration
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

PrintPreview()

Shows a RadPrintPreviewDialog for editing the RadScheduler print settings.

Declaration
public virtual void PrintPreview()

PrintPreview(RadPrintDocument)

Shows a RadPrintPreviewDialog for editing the RadScheduler print settings.

Declaration
public virtual void PrintPreview(RadPrintDocument document)
Parameters
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

ProcessCmdKey(ref Message, Keys)

Declaration
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
Parameters
System.Windows.Forms.Message msg

System.Windows.Forms.Keys keyData

Returns
System.Boolean

SaveReminders(Stream)

Saves all appointment reminders to the provided stream.

Declaration
public void SaveReminders(Stream stream)
Parameters
System.IO.Stream stream

The stream to save the reminders to.

SaveReminders(String)

Saves all appointment reminders to the provided file. If the file does not exist it is created otherwise it is overwritten.

Declaration
public void SaveReminders(string filePath)
Parameters
System.String filePath

The path to the file to save the reminders to.

SetValuesToViewElement(SchedulerVisualElement, ViewData)

Declaration
protected virtual void SetValuesToViewElement(SchedulerVisualElement viewElement, ViewData viewData)
Parameters
SchedulerVisualElement viewElement

ViewData viewData

ShowAppointmentEditDialog(IEvent, Boolean)

Shows the appointment edit dialog.

Declaration
public virtual DialogResult ShowAppointmentEditDialog(IEvent appointment, bool recurringAppointment)
Parameters
IEvent appointment

The appointment.
System.Boolean recurringAppointment

if set to true shows the recurrence rule edit dialog just after the appointment edit dialog.
Returns
System.Windows.Forms.DialogResult

ShowContextMenu(Point)

Displays the context menu associated with this control on the provided location.

Declaration
public void ShowContextMenu(Point location)
Parameters
System.Drawing.Point location

The location where the context menu should open.

SynchronizeStartDate(SchedulerView, SchedulerView)

Declaration
protected virtual void SynchronizeStartDate(SchedulerView oldView, SchedulerView newView)
Parameters
SchedulerView oldView

SchedulerView newView

SynchronizeViewsSettings(SchedulerView, SchedulerView, ViewData)

Declaration
protected virtual void SynchronizeViewsSettings(SchedulerView oldView, SchedulerView newView, ViewData viewData)
Parameters
SchedulerView oldView

SchedulerView newView

ViewData viewData

WndProc(ref Message)

Declaration
protected override void WndProc(ref Message m)
Parameters
System.Windows.Forms.Message m

Overrides

Events

ActiveViewChanged

Occurs when the ActiveView has changed.

Declaration
public event EventHandler<SchedulerViewChangedEventArgs> ActiveViewChanged
Event Type
System.EventHandler<SchedulerViewChangedEventArgs>

ActiveViewChanging

Occurs when the ActiveView is about to change.

Declaration
public event EventHandler<SchedulerViewChangingEventArgs> ActiveViewChanging
Event Type
System.EventHandler<SchedulerViewChangingEventArgs>

AppointmentAdded

Occurs when the end user adds an appointment either with the EditAppointmentDialog or inline.

Declaration
public event EventHandler<AppointmentAddedEventArgs> AppointmentAdded
Event Type
System.EventHandler<AppointmentAddedEventArgs>

AppointmentChanged

Occurs when an appointment's property has changed.

Declaration
public event EventHandler<AppointmentChangedEventArgs> AppointmentChanged
Event Type
System.EventHandler<AppointmentChangedEventArgs>

AppointmentDeleted

Occurs when the scheduler has deleted the selected appointment.

Declaration
public event EventHandler<SchedulerAppointmentEventArgs> AppointmentDeleted
Event Type
System.EventHandler<SchedulerAppointmentEventArgs>

AppointmentDeleting

Occurs when the scheduler is deleting the selected appointment.

Declaration
public event EventHandler<SchedulerAppointmentCancelEventArgs> AppointmentDeleting
Event Type
System.EventHandler<SchedulerAppointmentCancelEventArgs>

AppointmentDropped

Occurs when the an appointment has been dropped.

Declaration
public event EventHandler<AppointmentMovedEventArgs> AppointmentDropped
Event Type
System.EventHandler<AppointmentMovedEventArgs>

AppointmentDropping

Occurs when the an appointment is about to be dropped.

Declaration
public event EventHandler<AppointmentMovingEventArgs> AppointmentDropping
Event Type
System.EventHandler<AppointmentMovingEventArgs>

AppointmentEditDialogShowing

Occurs when the EditAppointmentDialog is showing.

Declaration
public event EventHandler<AppointmentEditDialogShowingEventArgs> AppointmentEditDialogShowing
Event Type
System.EventHandler<AppointmentEditDialogShowingEventArgs>

AppointmentElementDoubleClick

Occurs when the DoubleClick event of an appointment element is fired.

Declaration
public event EventHandler AppointmentElementDoubleClick
Event Type
System.EventHandler

AppointmentElementMouseDown

Occurs when the MouseDown event of an appointment element is fired.

Declaration
public event MouseEventHandler AppointmentElementMouseDown
Event Type
System.Windows.Forms.MouseEventHandler

AppointmentElementMouseMove

Occurs when the MouseMove event of an appointment element is fired.

Declaration
public event MouseEventHandler AppointmentElementMouseMove
Event Type
System.Windows.Forms.MouseEventHandler

AppointmentElementMouseUp

Occurs when the MouseUp event of an appointment element is fired.

Declaration
public event MouseEventHandler AppointmentElementMouseUp
Event Type
System.Windows.Forms.MouseEventHandler

AppointmentFormatting

Occurs when an appointment element is prepared to be displayed. Use this event to modify visual properties of the AppointmentElement. Modifying data properties on the formatting events can result in exceptions.

Declaration
public event EventHandler<SchedulerAppointmentEventArgs> AppointmentFormatting
Event Type
System.EventHandler<SchedulerAppointmentEventArgs>

AppointmentMouseDown

Occurs when the MouseDown event of an appointment is fired.

Declaration
public event EventHandler<SchedulerAppointmentMouseEventArgs> AppointmentMouseDown
Event Type
System.EventHandler<SchedulerAppointmentMouseEventArgs>

AppointmentMouseUp

Occurs when the MouseUp event of an appointment is fired.

Declaration
public event EventHandler<SchedulerAppointmentMouseEventArgs> AppointmentMouseUp
Event Type
System.EventHandler<SchedulerAppointmentMouseEventArgs>

AppointmentMoved

Occurs when the an appointment has been moved.

Declaration
public event EventHandler<AppointmentMovedEventArgs> AppointmentMoved
Event Type
System.EventHandler<AppointmentMovedEventArgs>

AppointmentMoving

Occurs when the an appointment is about to be moved.

Declaration
public event EventHandler<AppointmentMovingEventArgs> AppointmentMoving
Event Type
System.EventHandler<AppointmentMovingEventArgs>

AppointmentPrintElementFormatting

Fires when an appointment print element is being formatted before it is printed.

Declaration
public event PrintAppointmentEventHandler AppointmentPrintElementFormatting
Event Type
PrintAppointmentEventHandler

AppointmentPrintElementPaint

Fires when an appointment print element is printed.

Declaration
public event PrintAppointmentPaintEventHandler AppointmentPrintElementPaint
Event Type
PrintAppointmentPaintEventHandler

AppointmentRender

Occurs when appointment element is rendered.

Declaration
public event AppointmentRenderHandler AppointmentRender
Event Type
AppointmentRenderHandler

AppointmentResized

Occurs when the an appointment has been resized.

Declaration
public event EventHandler<AppointmentResizedEventArgs> AppointmentResized
Event Type
System.EventHandler<AppointmentResizedEventArgs>

AppointmentResizeEnd

Occurs when the a resize operation has ended.

Declaration
public event EventHandler<SchedulerAppointmentEventArgs> AppointmentResizeEnd
Event Type
System.EventHandler<SchedulerAppointmentEventArgs>

AppointmentResizeStart

Occurs when the a rezie operation is starting. Cancelable.

Declaration
public event EventHandler<SchedulerAppointmentCancelEventArgs> AppointmentResizeStart
Event Type
System.EventHandler<SchedulerAppointmentCancelEventArgs>

AppointmentResizing

Occurs when the an appointment is about to be resized.

Declaration
public event EventHandler<AppointmentResizingEventArgs> AppointmentResizing
Event Type
System.EventHandler<AppointmentResizingEventArgs>

AppointmentsCopying

Fired by the Copy operation when the scheduler is about to prepare the clipboard data. This event allows you to cancel the default action and implement a custom one.

Declaration
public event EventHandler<SchedulerClipboardEventArgs> AppointmentsCopying
Event Type
System.EventHandler<SchedulerClipboardEventArgs>

AppointmentSelected

Occurs when an appointment is selected.

Declaration
public event EventHandler<SchedulerAppointmentSelectedEventArgs> AppointmentSelected
Event Type
System.EventHandler<SchedulerAppointmentSelectedEventArgs>

AppointmentSelecting

Occurs when an appointment will be selected.

Declaration
public event EventHandler<SchedulerAppointmentCancelEventArgs> AppointmentSelecting
Event Type
System.EventHandler<SchedulerAppointmentCancelEventArgs>

AppointmentsPasting

Fired by the Paste operation when the scheduler is about to read the clipboard data. This event allows you to cancel the default action and implement a custom one.

Declaration
public event EventHandler<SchedulerClipboardEventArgs> AppointmentsPasting
Event Type
System.EventHandler<SchedulerClipboardEventArgs>

CellClick

Occurs when a cell is clicked.

Declaration
public event EventHandler<SchedulerCellEventArgs> CellClick
Event Type
System.EventHandler<SchedulerCellEventArgs>

CellElementDoubleClick

Occurs when the DoubleClick event of the cell is fired.

Declaration
public event EventHandler CellElementDoubleClick
Event Type
System.EventHandler

CellElementKeyDown

Occurs when the KeyDown event of the cell is fired.

Declaration
public event KeyEventHandler CellElementKeyDown
Event Type
System.Windows.Forms.KeyEventHandler

CellElementKeyPress

Occurs when the KeyPressed event of the cell is fired.

Declaration
public event KeyPressEventHandler CellElementKeyPress
Event Type
System.Windows.Forms.KeyPressEventHandler

CellElementKeyUp

Occurs when the KeyUp event of the cell is fired.

Declaration
public event KeyEventHandler CellElementKeyUp
Event Type
System.Windows.Forms.KeyEventHandler

CellElementMouseDown

Occurs when the MouseDown event of the cell is fired.

Declaration
public event MouseEventHandler CellElementMouseDown
Event Type
System.Windows.Forms.MouseEventHandler

CellElementMouseMove

Occurs when the MouseMove event of the cell is fired.

Declaration
public event MouseEventHandler CellElementMouseMove
Event Type
System.Windows.Forms.MouseEventHandler

CellElementMouseUp

Occurs when the MouseUp event of the cell is fired.

Declaration
public event MouseEventHandler CellElementMouseUp
Event Type
System.Windows.Forms.MouseEventHandler

CellFormatting

Fired when a cell element is being prepared for displaying. Use this event to modify visual properties of the SchedulerCellElement. Modifying data properties on the formatting events can result in exceptions.

Declaration
public event EventHandler<SchedulerCellEventArgs> CellFormatting
Event Type
System.EventHandler<SchedulerCellEventArgs>

CellOverflowButtonClicked

Occurs when the overflow arrow of a cell in MonthView is clicked. When this event is handled, the default action of the overflow arrow is not executed.

Declaration
public event EventHandler<SchedulerCellEventArgs> CellOverflowButtonClicked
Event Type
System.EventHandler<SchedulerCellEventArgs>

CellPaint

Occurs after a cell is drawn. Allows custom painting over the cell element. EnableCustomCellDrawing must be set to true for this event to be fired.

Declaration
public event EventHandler<SchedulerCellPaintEventArgs> CellPaint
Event Type
System.EventHandler<SchedulerCellPaintEventArgs>

CellPrintElementFormatting

Fires when a cell print element is being formatted before it is printed.

Declaration
public event PrintSchedulerCellEventHandler CellPrintElementFormatting
Event Type
PrintSchedulerCellEventHandler

CellPrintElementPaint

Fires when a cell print element is printed.

Declaration
public event PrintSchedulerCellPaintEventHandler CellPrintElementPaint
Event Type
PrintSchedulerCellPaintEventHandler

CellSelectionChanged

Occurs when the cell selection has changed.

Declaration
public event EventHandler CellSelectionChanged
Event Type
System.EventHandler

CellSelectionChanging

Occurs when the cell selection is about to change. Cancelable.

Declaration
public event EventHandler<SchedulerCellSelectingEventArgs> CellSelectionChanging
Event Type
System.EventHandler<SchedulerCellSelectingEventArgs>

ContextMenuOpening

Occurs before the context menu is opened.

Declaration
public event SchedulerContextMenuOpeningEventHandler ContextMenuOpening
Event Type
SchedulerContextMenuOpeningEventHandler

CultureChanged

Occurs when culture has changed

Declaration
public event EventHandler CultureChanged
Event Type
System.EventHandler

Implements

DataBindingComplete

Occurs when the Data is loaded from the data source.

Declaration
public event EventHandler DataBindingComplete
Event Type
System.EventHandler

EditorRequired

Occurs when an inline appointment editor is required.

Declaration
public event EventHandler<SchedulerEditorRequiredArgs> EditorRequired
Event Type
System.EventHandler<SchedulerEditorRequiredArgs>

PrintElementFormatting

Fires when a print element is being formatted before it is printed.

Declaration
public event PrintElementEventHandler PrintElementFormatting
Event Type
PrintElementEventHandler

PrintElementPaint

Fires when a print element is printed.

Declaration
public event PrintElementPaintEventHandler PrintElementPaint
Event Type
PrintElementPaintEventHandler

RecurrenceDeleteDialogShowing

Occurs when the DeleteRecurrenceDialog is showing.

Declaration
public event EventHandler<RecurrenceDeleteDialogShowingEventArgs> RecurrenceDeleteDialogShowing
Event Type
System.EventHandler<RecurrenceDeleteDialogShowingEventArgs>

RecurrenceEditDialogShowing

Occurs when the EditReccurenceDialog is showing.

Declaration
public event EventHandler<RecurrenceEditDialogShowingEventArgs> RecurrenceEditDialogShowing
Event Type
System.EventHandler<RecurrenceEditDialogShowingEventArgs>

ResourceStartIndexChanged

Occurs when the ResourceStartIndex has changed. Fired only when grouping by resource.

Declaration
public event EventHandler ResourceStartIndexChanged
Event Type
System.EventHandler

ResourceStartIndexChanging

Occurs when the ResourceStartIndex is about to change. Cancelable. Fired only when grouping by resource.

Declaration
public event EventHandler<ResourceIndexChangingEventArgs> ResourceStartIndexChanging
Event Type
System.EventHandler<ResourceIndexChangingEventArgs>

RulerTextFormatting

Occurs when the text of a ruler is drawn.

Declaration
public event EventHandler<RulerTextFormattingEventArgs> RulerTextFormatting
Event Type
System.EventHandler<RulerTextFormattingEventArgs>

ViewNavigated

Occurs when the view has changed and this is caused by a click on the ViewNavigationElement.

Declaration
public event EventHandler<SchedulerViewNavigatedEventArgs> ViewNavigated
Event Type
System.EventHandler<SchedulerViewNavigatedEventArgs>

ViewNavigating

Occurs when the view is about to change and this is caused by a click on the ViewNavigationElement.

Declaration
public event EventHandler<SchedulerViewNavigatingEventArgs> ViewNavigating
Event Type
System.EventHandler<SchedulerViewNavigatingEventArgs>

Explicit Interface Implementations

IPrintable.BeginPrint(RadPrintDocument, PrintEventArgs)

Declaration
int IPrintable.BeginPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

System.Drawing.Printing.PrintEventArgs args

Returns
System.Int32

Implements

IPrintable.EndPrint(RadPrintDocument, PrintEventArgs)

Declaration
bool IPrintable.EndPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

System.Drawing.Printing.PrintEventArgs args

Returns
System.Boolean

Implements

IPrintable.GetSettingsDialog(RadPrintDocument)

Declaration
Form IPrintable.GetSettingsDialog(RadPrintDocument document)
Parameters
RadPrintDocument document

Returns
System.Windows.Forms.Form

Implements

IPrintable.PrintPage(Int32, RadPrintDocument, PrintPageEventArgs)

Declaration
bool IPrintable.PrintPage(int pageNumber, RadPrintDocument sender, PrintPageEventArgs args)
Parameters
System.Int32 pageNumber

RadPrintDocument sender

System.Drawing.Printing.PrintPageEventArgs args

Returns
System.Boolean

Implements

Extension Methods