RadScheduler
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.Scheduler.dll
Syntax:
[TelerikToolboxCategory("Scheduler")]
public class RadScheduler : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider, ICultureInfoProvider, ISchedulerData, IPrintableInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadScheduler...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadScheduler class.
public RadScheduler()Fields
public static readonly CreateNewAppointmentCommand CreateNewAppointmentCommandpublic const string ICalendarDataFormat = "ICal"public static readonly NavigateBackwardCommand NavigateBackwardCommandpublic static readonly NavigateForwardCommand NavigateForwardCommandpublic static readonly NavigateToNextAppointmentsCommand NavigateToNextAppointmentsCommandpublic static readonly NavigateToNextViewCommand NavigateToNextViewCommandpublic static readonly NavigateToPreviousAppointmentsCommand NavigateToPreviousAppointmentsCommandpublic static readonly NavigateToPreviousViewCommand NavigateToPreviousViewCommandProperties
Gets or sets the interval which is accessible to the user.
[Browsable(true)]
public virtual DateTimeInterval AccessibleInterval { get; set; }The accessible interval. Default value is DateTimeInterval.Empty.
Gets or sets the active view.
[Browsable(false)]
public virtual SchedulerView ActiveView { get; set; }The active view.
Gets or sets the type of the active view.
public virtual SchedulerViewType ActiveViewType { get; set; }The type of the active view.
Enables or disables creating appointments when typing in a cell.
public virtual bool AllowAppointmentCreateInline { get; set; }Enables or disables appointment moving.
public virtual bool AllowAppointmentMove { get; set; }Enables or disables appointment resizing
public virtual bool AllowAppointmentResize { get; set; }Gets or sets a value indicating whether selecting multiple appointments is possible.
public bool AllowAppointmentsMultiSelect { get; set; }Allows or disallows the end user to copy, cut and paste appointments using the default combinations Ctrl+X, Ctrl+C and Ctrl+V.
public CopyPasteMode AllowCopyPaste { get; set; }Enables or disables mouse wheel support.
public virtual bool AllowMouseWheelSupport { get; set; }Gets or sets a value indicating whether tool tips are shown.
public bool AllowToolTips { get; set; }true if tool tips are shown; otherwise, false.
Enables automatic navigation to previous/next view when dragging an appointment outside the boundaries of the control.
public bool AllowViewNavigationOnDrag { get; set; }Gets or sets a factory class that is used when creating appointment elements.
[Browsable(false)]
public IAppointmentElementFactory AppointmentElementFactory { get; set; }Gets or sets the appointment exception of recurrence icon.
[Browsable(false)]
public Image AppointmentExceptionOfRecurrenceIcon { get; set; }The appointment exception of recurrence icon.
Gets or sets an IAppointmentFactory which used to create IEvent objects which represent the appointments in RadScheduler.
[Browsable(false)]
public IAppointmentFactory AppointmentFactory { get; set; }Gets or sets the appointment recurrence icon.
[Browsable(false)]
public Image AppointmentRecurrenceIcon { get; set; }The appointment recurrence icon.
Gets the appointments.
[Browsable(false)]
public virtual SchedulerAppointmentCollection Appointments { get; }The appointments.
AppointmentsComparer
IComparer<AppointmentElement>
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.
[Browsable(false)]
public IComparer<AppointmentElement> AppointmentsComparer { get; set; }Gets or sets the appointment title format.
public string AppointmentTitleFormat { get; set; }The appointment title format.
Gets or sets a value indicating whether the appointments elements should be sized to fit their content.
public bool AutoSizeAppointments { get; set; }Gets the backgrounds.
[Browsable(false)]
public virtual SchedulerBackgroundCollection Backgrounds { get; }The backgrounds.
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.
[TypeConverter(typeof(CultureInfoConverter))]
public CultureInfo Culture { get; set; }Implements:
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 |
Gets or sets the data source.
public virtual SchedulerDataSource DataSource { get; set; }The data source.
Gets or sets a DateTimeFormatInfo instance that defines the culturally appropriate format of displaying dates and times as specified by the default culture.
[Browsable(false)]
public DateTimeFormatInfo DateTimeFormat { get; }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.
Gets the default size of the control.
protected override Size DefaultSize { get; }Overrides:
Gets or sets which edge of the parent container a control is docked to.
public DockStyle Dock { get; set; }Gets or sets the AppointmentDraggingBehavior which is responsible for performing the drag and drop of appointments in RadScheduler.
[Browsable(false)]
public AppointmentDraggingBehavior DragDropBehavior { get; }Gets or sets the SchedulerElementProvider which is responsible for creating and recycling of most of RadScheduler's visual elements.
[Browsable(false)]
public SchedulerElementProvider ElementProvider { get; set; }Gets or sets a value indicating whether the CellPaint event will be fired.
public bool EnableCustomCellDrawing { get; set; }Gets or sets whether appointments are rendered according to their start and end time or are aligned to the scheduler grid lines.
public bool EnableExactTimeRendering { get; set; }Gets or sets the value that is used by RadScheduler to determine the viewable area displayed .
public DateTime FocusedDate { get; set; }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.
Gets or sets the type of grouping.
[Browsable(false)]
public GroupType GroupType { get; set; }Implements:
Gets or sets the header format.
public string HeaderFormat { get; set; }The header format.
Gets or sets value whether to show the today visual state of scheduler cells
public bool HighlightToday { get; set; }Represents the collection with Holidays object
public SchedulerHolidays Holidays { get; set; }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.
public Color ModernAppointmentBackColor { get; set; }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.
public Color ModernAppointmentBackColor2 { get; set; }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.
public Color ModernAppointmentBlueColor { get; set; }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.
public Color ModernAppointmentBorderColor { get; set; }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.
public Color ModernAppointmentForeColor { get; set; }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.
public Color ModernAppointmentGrayColor { get; set; }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.
public Color ModernAppointmentGreenColor { get; set; }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.
public Color ModernAppointmentLavenderColor { get; set; }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.
public Color ModernAppointmentOliveColor { get; set; }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.
public Color ModernAppointmentOrangeColor { get; set; }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.
public Color ModernAppointmentPinkColor { get; set; }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.
public Color ModernAppointmentPurpleColor { get; set; }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.
public Color ModernAppointmentRaspberryColor { get; set; }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.
public Color ModernAppointmentYellowColor { get; set; }Gets or sets the padding within the control.
[Browsable(false)]
public Padding Padding { get; set; }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.
public bool PaintModernApppointmentsBorders { get; set; }Gets or sets the factory used to create print settings dialogs. If not explicitly set, it defaults to a new instance of SchedulerPrintSettingsDialogFactory.
[Browsable(false)]
public IPrintSettingsDialogFactory PrintSettingsDialogFactory { get; set; }Gets or sets a value indicating how the RadScheduler is printed.
public SchedulerPrintStyle PrintStyle { get; set; }Gets or sets the shortcut menu associated with the control.
public virtual RadContextMenu RadContextMenu { get; set; }Gets or sets a value indicating whether appointments can be changed.
public virtual bool ReadOnly { get; set; }true if the scheduler is read-only; otherwise, false.
Gets the predefined reminder time intervals.
[Browsable(false)]
public virtual SchedulerReminderCollection Reminders { get; }The reminder intervals.
Gets or sets the AppointmentResizingBehavior which is responsible for performing the resizing of appointments in RadScheduler.
[Browsable(false)]
public AppointmentResizingBehavior ResizeBehavior { get; }Gets the resources.
[Browsable(false)]
public virtual SchedulerResourceCollection Resources { get; }The resources.
Gets or sets the behavior responsible for saving and loading appointment reminders. This behavior handles persistence of reminders between application sessions.
public SchedulerSaveLoadRemindersBehavior SaveLoadRemindersBehavior { get; set; }Gets the scheduler element.
[Browsable(false)]
public RadSchedulerElement SchedulerElement { get; }The scheduler element.
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.
[Browsable(false)]
public SchedulerInputBehavior SchedulerInputBehavior { get; set; }Gets or sets the SchedulerSelectionBehavior which is responsible for handling the selection of cells and appointments in RadScheduler.
[Browsable(false)]
public SchedulerSelectionBehavior SelectionBehavior { get; set; }Gets or sets a value indicating whether to display all day appointment status.
public virtual bool ShowAllDayAppointmentStatus { get; set; }true if all day appointment status is displayed; otherwise, false.
Gets or sets a value indicating whether the appointment status should be displayed.
public virtual bool ShowAppointmentStatus { get; set; }true if appointment status is displayed otherwise, false.
Gets or sets a value whether to show the "Previous/Next Appointment" navigation elements.
public bool ShowNavigationElements { get; set; }Gets the statuses.
[Browsable(false)]
public virtual SchedulerStatusCollection Statuses { get; }The statuses.
Gets or sets the selected time zone.
[Browsable(false)]
public SchedulerTimeZone SystemTimeZone { get; set; }The selected time zone.
Determines whether the appointments are painted with modern colors and borders. The default value is true.
public bool UseModernAppointmentStyles { get; set; }Gets the view element.
[Browsable(false)]
public SchedulerViewElement ViewElement { get; }The view element.
Methods
Shows the appointment edit dialog to add a new appointment.
public void AddNewAppointmentWithDialog(DateTimeInterval interval, bool allDay, bool recurringAppointment, SchedulerResourceCollection resources)The interval to pass to the ShowAppointmentEditDialog method.
allDayboolIndicates whether the appointment should be an AllDay appointment.
recurringAppointmentboolIndicates whether the appointment should be a recurring one.
resourcesSchedulerResourceCollectionThe resources of the new appointment.
Shows the appointment edit dialog to add a new appointment.
public void AddNewAppointmentWithDialog(DateTimeInterval interval, bool recurringAppointment, SchedulerResourceCollection resources)The interval to pass to the ShowAppointmentEditDialog method.
recurringAppointmentboolIndicates whether the appointment should be a recurring one.
resourcesSchedulerResourceCollectionThe resources of the new appointment.
public virtual void AddNewAppointmentWithDialog(IEvent appointment, DateTimeInterval interval, bool recurringAppointment, SchedulerResourceCollection resources)Clears the reminders of all appointments. Usually this method is used before LoadReminders is called.
public void ClearReminders()Determines whether this control defines the theme for the specified element.
public override bool ControlDefinesThemeForElement(RadElement element)The element to check.
Returns:true if this control defines the theme for the element; otherwise, false.
Overrides:
Copies the currently selected appointments to the clipboard.
public void Copy()Creates the accessibility instance for the RadScheduler control.
protected override AccessibleObject CreateAccessibilityInstance()An AccessibleObject instance that provides accessibility information for the control.
Overrides:
Creates the appointment edit dialog. Overwrite in an inheriting class to replace the dialog used to edit appointments.
protected virtual IEditAppointmentDialog CreateAppointmentEditDialog()IEditAppointmentDialog
protected virtual AppointmentBackgroundInfo CreateBackgroundInfo(AppointmentBackground category, string stringId, Color backColor, Color backColor2, Color foreColor, Color borderColor)protected virtual AppointmentBackgroundInfo CreateBackgroundInfo(AppointmentBackground category, string stringId, Color backColor, Color backColor2)Creates the child items for the RadScheduler control.
protected override void CreateChildItems(RadElement parent)The parent element to which the child items will be added.
Overrides:
Creates the RadSchedulerElement for this scheduler.
protected virtual RadSchedulerElement CreateRadSchedulerElement()A RadSchedulerElement instance that will be used as the main element for this scheduler.
Deletes the currently selected appointments and saves them to the clipboard.
public void Cut()Binds the scheduler to its data source and populates appointments and resources collections.
public void DataBind()Exports the data in this RadScheduler instance in a string, using the specified ISchedulerExporter instance.
public virtual string Export(ISchedulerExporter exporter)Exports the data in this RadScheduler instance to the specified stream, using the specified ISchedulerExporter instance.
public virtual void Export(Stream stream, ISchedulerExporter exporter)Fills the default backgrounds.
protected virtual void FillDefaultBackgrounds(SchedulerBackgroundCollection backgrounds)The background collection in which to add the background objects.
Fills the default reminder intervals.
protected virtual void FillDefaultReminders(SchedulerReminderCollection reminders)The reminder collection in which to add the reminder objects.
Fills the default statuses.
protected virtual void FillDefaultStatuses(SchedulerStatusCollection statuses)The status collection in which to add the status objects.
Gets the agenda view.
Gets the background storage.
public virtual ISchedulerStorage<IAppointmentBackgroundInfo> GetBackgroundStorage()Implements:
Gets the day view.
Gets the event storage.
public virtual ISchedulerStorage<IEvent> GetEventStorage()Implements:
Creates a light visual element with an image of the specified element.
protected virtual LightVisualElement GetImageElement(RadElement element, Color backColor)The element to create an image from.
backColorColorThe background color for the image.
Returns:A LightVisualElement containing the image of the specified element.
Gets the month view.
Gets the multi day view.
Gets the reminder storage.
public virtual ISchedulerStorage<IAppointmentReminderInfo> GetReminderStorage()Implements:
Gets the resource storage.
public virtual ISchedulerStorage<IResource> GetResourceStorage()Implements:
Gets the status storage.
public virtual ISchedulerStorage<IAppointmentStatusInfo> GetStatusStorage()Implements:
Gets the timeline view.
protected virtual ViewData GetValuesByViewElement(SchedulerVisualElement viewElement)Gets the week view.
protected virtual void HandleDayViewPan(PanGestureEventArgs args, SchedulerDayView view)Handles pan gestures in the month view.
protected virtual void HandleMonthViewPan(PanGestureEventArgs args, SchedulerMonthView monthView)The PanGestureEventArgs instance containing the event data.
monthViewSchedulerMonthViewThe month view instance.
protected virtual void HandleTimelineViewPan(PanGestureEventArgs args, SchedulerTimelineView timeLine)Handles pan gestures in the week view.
protected virtual void HandleWeekViewPan(PanGestureEventArgs args, SchedulerWeekView weekView)The PanGestureEventArgs instance containing the event data.
weekViewSchedulerWeekViewThe week view instance.
Imports the data from the specified stream into this RadScheduler instance, using the specified ISchedulerImporter instance.
public virtual void Import(Stream stream, ISchedulerImporter importer)Imports the data from the specified string into this RadScheduler instance, using the specified ISchedulerImporter instance.
public virtual void Import(string stringData, ISchedulerImporter importer)Loads the reminders from the specified stream.
public void LoadReminders(Stream stream)The steam to load reminders from.
Loads the reminders from the specified file path.
public void LoadReminders(string filePath)The path to the file to load reminders from.
Raises the ActiveViewChanged event.
protected virtual void OnActiveViewChanged(SchedulerView oldView, SchedulerView newView)The previous active view.
newViewSchedulerViewThe new active view.
protected virtual bool OnActiveViewChanging(SchedulerView oldView, SchedulerView newView)Called when appointments have been added.
protected virtual void OnAddAppointments(IList list)The list of added appointments.
protected virtual void OnAppointmentAdded(AppointmentAddedEventArgs args)protected virtual void OnAppointmentDeleted(SchedulerAppointmentEventArgs args)protected virtual void OnAppointmentDeleting(SchedulerAppointmentCancelEventArgs args)protected virtual void OnAppointmentDropped(AppointmentMovedEventArgs args)protected virtual void OnAppointmentDropping(AppointmentMovingEventArgs args)Raises the AppointmentEditDialogShowing event.
protected virtual IEditAppointmentDialog OnAppointmentEditDialogShowing(IEvent appointment, IEditAppointmentDialog dialog)The appointment being edited.
dialogIEditAppointmentDialogThe edit appointment dialog instance.
Returns:IEditAppointmentDialog
The dialog to be shown, or null if the operation was canceled.
Raises the AppointmentElementDoubleClick event.
Raises the AppointmentElementMouseDown event.
protected virtual void OnAppointmentElementMouseDown(object sender, MouseEventArgs args)The source of the event.
argsMouseEventArgsThe MouseEventArgs instance containing the event data.
Raises the AppointmentElementMouseMove event.
protected virtual void OnAppointmentElementMouseMove(object sender, MouseEventArgs args)The source of the event.
argsMouseEventArgsThe MouseEventArgs instance containing the event data.
Raises the AppointmentElementMouseUp event.
protected virtual void OnAppointmentElementMouseUp(object sender, MouseEventArgs args)The source of the event.
argsMouseEventArgsThe MouseEventArgs instance containing the event data.
Raises the AppointmentFormatting event.
protected virtual void OnAppointmentFormatting(SchedulerAppointmentEventArgs args)The SchedulerAppointmentEventArgs instance containing the event data.
protected virtual void OnAppointmentMouseDown(SchedulerAppointmentMouseEventArgs args)protected virtual void OnAppointmentMouseUp(SchedulerAppointmentMouseEventArgs args)protected virtual void OnAppointmentMoved(AppointmentMovedEventArgs args)protected virtual void OnAppointmentMoving(AppointmentMovingEventArgs args)Raises the event.
protected virtual void OnAppointmentRender(AppointmentRenderEventArgs args)The AppointmentRenderEventArgs instance containing the event data.
protected virtual void OnAppointmentResized(AppointmentResizedEventArgs args)protected virtual void OnAppointmentResizeStart(SchedulerAppointmentCancelEventArgs args)protected virtual void OnAppointmentResizing(AppointmentResizingEventArgs args)protected virtual void OnAppointmentsCopying(SchedulerClipboardEventArgs args)protected virtual void OnAppointmentSelected(SchedulerAppointmentSelectedEventArgs args)protected virtual void OnAppointmentSelecting(SchedulerAppointmentCancelEventArgs args)protected virtual void OnAppointmentsPasting(SchedulerClipboardEventArgs args)Raises the CellClick event.
protected virtual void OnCellClick(SchedulerCellEventArgs args)The SchedulerCellEventArgs instance containing the event data.
Raises the CellElementDoubleClick event.
Raises the CellElementKeyDown event.
protected virtual void OnCellElementKeyDown(object sender, KeyEventArgs args)The source of the event.
argsKeyEventArgsThe KeyEventArgs instance containing the event data.
Raises the CellElementKeyPress event.
protected virtual void OnCellElementKeyPress(object sender, KeyPressEventArgs args)The source of the event.
argsKeyPressEventArgsThe KeyPressEventArgs instance containing the event data.
Raises the CellElementKeyUp event.
protected virtual void OnCellElementKeyUp(object sender, KeyEventArgs args)The source of the event.
argsKeyEventArgsThe KeyEventArgs instance containing the event data.
Raises the CellElementMouseDown event.
protected virtual void OnCellElementMouseDown(object sender, MouseEventArgs args)The source of the event.
argsMouseEventArgsThe MouseEventArgs instance containing the event data.
Raises the CellElementMouseMove event.
protected virtual void OnCellElementMouseMove(object sender, MouseEventArgs args)The source of the event.
argsMouseEventArgsThe MouseEventArgs instance containing the event data.
Raises the CellElementMouseUp event.
protected virtual void OnCellElementMouseUp(object sender, MouseEventArgs args)The source of the event.
argsMouseEventArgsThe MouseEventArgs instance containing the event data.
Raises the CellFormatting event.
protected virtual void OnCellFormatting(SchedulerCellEventArgs args)The SchedulerCellEventArgs instance containing the event data.
Raises the CellOverflowButtonClicked event.
protected virtual bool OnCellOverflowButtonClicked(SchedulerCellEventArgs args)The SchedulerCellEventArgs instance containing the event data.
Returns:true if the event was handled; otherwise, false.
Raises the event.
protected virtual void OnCellPaint(SchedulerCellPaintEventArgs args)The SchedulerCellPaintEventArgs instance containing the event data.
protected virtual void OnCellSelectionChanging(SchedulerCellSelectingEventArgs args)Raises the event.
protected virtual void OnContextMenuOpening(SchedulerContextMenuOpeningEventArgs e)The SchedulerContextMenuOpeningEventArgs instance containing the event data.
Fires the CultureChanged event.
protected virtual void OnCultureChanged()Raises the DataBindingComplete event.
Fired when the editor should be opened
protected virtual void OnEditorRequired(SchedulerEditorRequiredArgs args)Notifies that the control is about to be visualized.
Handles pan gestures to enable touchscreen navigation and scrolling.
protected override void OnPanGesture(PanGestureEventArgs args)The PanGestureEventArgs instance containing the event data.
Overrides:
Raises the RecurrenceDeleteDialogShowing event.
protected virtual IDeleteRecurringAppointmentDialog OnRecurrenceDeleteDialogShowing(IEvent appointment, IDeleteRecurringAppointmentDialog dialog)The recurring appointment being deleted.
dialogIDeleteRecurringAppointmentDialogThe recurrence delete dialog instance.
Returns:IDeleteRecurringAppointmentDialog
The dialog to be shown, or null if the operation was canceled.
Raises the RecurrenceEditDialogShowing event.
protected virtual IEditRecurrenceDialog OnRecurrenceEditDialogShowing(IEvent appointment, IEditRecurrenceDialog dialog)The recurring appointment being edited.
dialogIEditRecurrenceDialogThe recurrence edit dialog instance.
Returns:IEditRecurrenceDialog
The dialog to be shown, or null if the operation was canceled.
Called when appointments have been removed.
protected virtual void OnRemoveAppointments(IList list)The list of removed appointments.
protected virtual void OnResourceStartIndexChanged()protected virtual void OnResourceStartIndexChanging(ResourceIndexChangingEventArgs args)Raises the event.
protected virtual void OnRulerTextFormatting(RulerTextFormattingEventArgs args)The event arguments.
protected override void OnThemeChanged()Overrides:
Called when appointments have to be refreshed.
protected virtual void OnUpdateAppointments()protected virtual void OnViewNavigated(SchedulerViewNavigatedEventArgs args)protected virtual void OnViewNavigating(SchedulerViewNavigatingEventArgs args)Handles zoom gestures to enable changing views and scaling through pinch-to-zoom functionality.
protected override void OnZoomGesture(ZoomGestureEventArgs args)The ZoomGestureEventArgs instance containing the event data.
Overrides:
Pastes the content from the clipboard to the scheduler.
public void Paste()Directly prints the RadScheduler to the default printer.
public virtual void Print()Directly prints the RadScheduler to the default printer or shows printer settitngs and then prints the RadGridView.
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)Indicates whether printer settings dialog should be shown.
documentRadPrintDocumentAs instance of RadPrintDocument used to control the print process.
Directly prints the RadScheduler to the default printer or shows printer settitngs and then prints the RadGridView.
public virtual void Print(bool showPrinterSettings)Indicates whether printer settings dialog should be shown.
Shows a RadPrintPreviewDialog for editing the RadScheduler print settings. This method creates a new instance of RadPrintDocument and passes it to the overloaded PrintPreview method.
public virtual void PrintPreview()Shows a RadPrintPreviewDialog for editing the RadScheduler print settings. This method temporarily changes the view type if needed and displays the print preview dialog.
public virtual void PrintPreview(RadPrintDocument document)An instance of RadPrintDocument used to control the print process.
Saves all appointment reminders to the provided stream.
public void SaveReminders(Stream stream)The stream to save the reminders to.
Saves all appointment reminders to the provided file. If the file does not exist it is created otherwise it is overwritten.
public void SaveReminders(string filePath)The path to the file to save the reminders to.
protected virtual void SetValuesToViewElement(SchedulerVisualElement viewElement, ViewData viewData)Shows the appointment edit dialog.
Displays the context menu associated with this control on the provided location.
public void ShowContextMenu(Point location)The location where the context menu should open.
protected virtual void SynchronizeStartDate(SchedulerView oldView, SchedulerView newView)protected virtual void SynchronizeViewsSettings(SchedulerView oldView, SchedulerView newView, ViewData viewData)Events
Occurs when the ActiveView has changed.
public event EventHandler<SchedulerViewChangedEventArgs> ActiveViewChangedOccurs when the ActiveView is about to change.
public event EventHandler<SchedulerViewChangingEventArgs> ActiveViewChangingOccurs when the end user adds an appointment either with the EditAppointmentDialog or inline.
public event EventHandler<AppointmentAddedEventArgs> AppointmentAddedOccurs when an appointment's property has changed.
public event EventHandler<AppointmentChangedEventArgs> AppointmentChangedOccurs when the scheduler has deleted the selected appointment.
public event EventHandler<SchedulerAppointmentEventArgs> AppointmentDeletedOccurs when the scheduler is deleting the selected appointment.
public event EventHandler<SchedulerAppointmentCancelEventArgs> AppointmentDeletingOccurs when the an appointment has been dropped.
public event EventHandler<AppointmentMovedEventArgs> AppointmentDroppedOccurs when the an appointment is about to be dropped.
public event EventHandler<AppointmentMovingEventArgs> AppointmentDroppingOccurs when the EditAppointmentDialog is showing.
public event EventHandler<AppointmentEditDialogShowingEventArgs> AppointmentEditDialogShowingOccurs when the DoubleClick event of an appointment element is fired.
public event EventHandler AppointmentElementDoubleClickOccurs when the MouseDown event of an appointment element is fired.
public event MouseEventHandler AppointmentElementMouseDownOccurs when the MouseMove event of an appointment element is fired.
public event MouseEventHandler AppointmentElementMouseMoveOccurs when the MouseUp event of an appointment element is fired.
public event MouseEventHandler AppointmentElementMouseUpOccurs 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.
public event EventHandler<SchedulerAppointmentEventArgs> AppointmentFormattingOccurs when the MouseDown event of an appointment is fired.
public event EventHandler<SchedulerAppointmentMouseEventArgs> AppointmentMouseDownOccurs when the MouseUp event of an appointment is fired.
public event EventHandler<SchedulerAppointmentMouseEventArgs> AppointmentMouseUpOccurs when the an appointment has been moved.
public event EventHandler<AppointmentMovedEventArgs> AppointmentMovedOccurs when the an appointment is about to be moved.
public event EventHandler<AppointmentMovingEventArgs> AppointmentMovingFires when an appointment print element is being formatted before it is printed.
public event PrintAppointmentEventHandler AppointmentPrintElementFormattingFires when an appointment print element is printed.
public event PrintAppointmentPaintEventHandler AppointmentPrintElementPaintOccurs when appointment element is rendered.
public event AppointmentRenderHandler AppointmentRenderOccurs when the an appointment has been resized.
public event EventHandler<AppointmentResizedEventArgs> AppointmentResizedOccurs when the a resize operation has ended.
public event EventHandler<SchedulerAppointmentEventArgs> AppointmentResizeEndOccurs when the a rezie operation is starting. Cancelable.
public event EventHandler<SchedulerAppointmentCancelEventArgs> AppointmentResizeStartOccurs when the an appointment is about to be resized.
public event EventHandler<AppointmentResizingEventArgs> AppointmentResizingFired 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.
public event EventHandler<SchedulerClipboardEventArgs> AppointmentsCopyingOccurs when an appointment is selected.
public event EventHandler<SchedulerAppointmentSelectedEventArgs> AppointmentSelectedOccurs when an appointment will be selected.
public event EventHandler<SchedulerAppointmentCancelEventArgs> AppointmentSelectingFired 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.
public event EventHandler<SchedulerClipboardEventArgs> AppointmentsPastingOccurs when a cell is clicked.
public event EventHandler<SchedulerCellEventArgs> CellClickOccurs when the DoubleClick event of the cell is fired.
public event EventHandler CellElementDoubleClickOccurs when the KeyDown event of the cell is fired.
public event KeyEventHandler CellElementKeyDownOccurs when the KeyPressed event of the cell is fired.
public event KeyPressEventHandler CellElementKeyPressOccurs when the KeyUp event of the cell is fired.
public event KeyEventHandler CellElementKeyUpOccurs when the MouseDown event of the cell is fired.
public event MouseEventHandler CellElementMouseDownOccurs when the MouseMove event of the cell is fired.
public event MouseEventHandler CellElementMouseMoveOccurs when the MouseUp event of the cell is fired.
public event MouseEventHandler CellElementMouseUpFired 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.
public event EventHandler<SchedulerCellEventArgs> CellFormattingOccurs 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.
public event EventHandler<SchedulerCellEventArgs> CellOverflowButtonClickedOccurs after a cell is drawn. Allows custom painting over the cell element. EnableCustomCellDrawing must be set to true for this event to be fired.
public event EventHandler<SchedulerCellPaintEventArgs> CellPaintFires when a cell print element is being formatted before it is printed.
public event PrintSchedulerCellEventHandler CellPrintElementFormattingFires when a cell print element is printed.
public event PrintSchedulerCellPaintEventHandler CellPrintElementPaintOccurs when the cell selection has changed.
public event EventHandler CellSelectionChangedOccurs when the cell selection is about to change. Cancelable.
public event EventHandler<SchedulerCellSelectingEventArgs> CellSelectionChangingOccurs before the context menu is opened.
public event SchedulerContextMenuOpeningEventHandler ContextMenuOpeningOccurs when culture has changed
public event EventHandler CultureChangedImplements:
Occurs when the Data is loaded from the data source.
public event EventHandler DataBindingCompleteOccurs when an inline appointment editor is required.
public event EventHandler<SchedulerEditorRequiredArgs> EditorRequiredFires when a print element is being formatted before it is printed.
public event PrintElementEventHandler PrintElementFormattingFires when a print element is printed.
public event PrintElementPaintEventHandler PrintElementPaintOccurs when the DeleteRecurrenceDialog is showing.
public event EventHandler<RecurrenceDeleteDialogShowingEventArgs> RecurrenceDeleteDialogShowingOccurs when the EditReccurenceDialog is showing.
public event EventHandler<RecurrenceEditDialogShowingEventArgs> RecurrenceEditDialogShowingOccurs when the ResourceStartIndex has changed. Fired only when grouping by resource.
public event EventHandler ResourceStartIndexChangedOccurs when the ResourceStartIndex is about to change. Cancelable. Fired only when grouping by resource.
public event EventHandler<ResourceIndexChangingEventArgs> ResourceStartIndexChangingOccurs when the text of a ruler is drawn.
public event EventHandler<RulerTextFormattingEventArgs> RulerTextFormattingOccurs when the view has changed and this is caused by a click on the ViewNavigationElement.
public event EventHandler<SchedulerViewNavigatedEventArgs> ViewNavigatedOccurs when the view is about to change and this is caused by a click on the ViewNavigationElement.
public event EventHandler<SchedulerViewNavigatingEventArgs> ViewNavigating