Class

RadScheduler

Initializes a new instance of the RadScheduler class.

Declaration

public RadScheduler()

Declaration

public static readonly CreateNewAppointmentCommand CreateNewAppointmentCommand

Field Value

Declaration

public const string ICalendarDataFormat = "ICal"

Field Value

Declaration

public static readonly NavigateBackwardCommand NavigateBackwardCommand

Field Value

Declaration

public static readonly NavigateForwardCommand NavigateForwardCommand

Field Value

Declaration

public static readonly NavigateToNextAppointmentsCommand NavigateToNextAppointmentsCommand

Field Value

Declaration

public static readonly NavigateToNextViewCommand NavigateToNextViewCommand

Field Value

Declaration

public static readonly NavigateToPreviousAppointmentsCommand NavigateToPreviousAppointmentsCommand

Field Value

Declaration

public static readonly NavigateToPreviousViewCommand NavigateToPreviousViewCommand

Field Value

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

Declaration

[Browsable(true)]
public virtual DateTimeInterval AccessibleInterval { get; set; }

Property Value

Gets or sets the active view.

Declaration

[Browsable(false)]
public virtual SchedulerView ActiveView { get; set; }

Property Value

Gets or sets the type of the active view.

Declaration

public virtual SchedulerViewType ActiveViewType { get; set; }

Property Value

Enables or disables creating appointments when typing in a cell.

Declaration

public virtual bool AllowAppointmentCreateInline { get; set; }

Property Value

Enables or disables appointment moving.

Declaration

public virtual bool AllowAppointmentMove { get; set; }

Property Value

Enables or disables appointment resizing

Declaration

public virtual bool AllowAppointmentResize { get; set; }

Property Value

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

Declaration

public bool AllowAppointmentsMultiSelect { get; set; }

Property Value

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

Enables or disables mouse wheel support.

Declaration

public virtual bool AllowMouseWheelSupport { get; set; }

Property Value

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

Declaration

public bool AllowToolTips { get; set; }

Property Value

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

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

Declaration

[Browsable(false)]
public IAppointmentElementFactory AppointmentElementFactory { get; set; }

Property Value

Gets or sets the appointment exception of recurrence icon.

Declaration

[Browsable(false)]
public Image AppointmentExceptionOfRecurrenceIcon { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public IAppointmentFactory AppointmentFactory { get; set; }

Property Value

Gets or sets the appointment recurrence icon.

Declaration

[Browsable(false)]
public Image AppointmentRecurrenceIcon { get; set; }

Property Value

Gets or sets the appointment title format.

Declaration

public string AppointmentTitleFormat { get; set; }

Property Value

Gets the appointments.

Declaration

[Browsable(false)]
public virtual SchedulerAppointmentCollection Appointments { get; }

Property Value

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

[Browsable(false)]
public IComparer<AppointmentElement> AppointmentsComparer { get; set; }

Property Value

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

Gets the backgrounds.

Declaration

[Browsable(false)]
public virtual SchedulerBackgroundCollection Backgrounds { get; }

Property Value

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

[TypeConverter(typeof(CultureInfoConverter))]
public CultureInfo Culture { get; set; }

Property Value

Implements ICultureInfoProvider.Culture

Remarks

Gets or sets the data source.

Declaration

public virtual SchedulerDataSource DataSource { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public DateTimeFormatInfo DateTimeFormat { get; }

Property Value

Remarks

Gets the default size of the control.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets or sets which edge of the parent container a control is docked to.

Declaration

public DockStyle Dock { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public AppointmentDraggingBehavior DragDropBehavior { get; }

Property Value

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

Declaration

[Browsable(false)]
public SchedulerElementProvider ElementProvider { get; set; }

Property Value

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

Declaration

public bool EnableCustomCellDrawing { get; set; }

Property Value

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

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

Declaration

public DateTime FocusedDate { get; set; }

Property Value

Remarks

Gets or sets the type of grouping.

Declaration

[Browsable(false)]
public GroupType GroupType { get; set; }

Property Value

Implements ISchedulerData.GroupType

Gets or sets the header format.

Declaration

public string HeaderFormat { get; set; }

Property Value

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

Declaration

public bool HighlightToday { get; set; }

Property Value

Represents the collection with Holidays object

Declaration

public SchedulerHolidays Holidays { get; set; }

Property Value

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Gets or sets the padding within the control.

Declaration

[Browsable(false)]
public Padding Padding { get; set; }

Property Value

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

Gets or sets the factory used to create print settings dialogs. If not explicitly set, it defaults to a new instance of SchedulerPrintSettingsDialogFactory.

Declaration

[Browsable(false)]
public IPrintSettingsDialogFactory PrintSettingsDialogFactory { get; set; }

Property Value

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

Declaration

public SchedulerPrintStyle PrintStyle { get; set; }

Property Value

Gets or sets the shortcut menu associated with the control.

Declaration

public virtual RadContextMenu RadContextMenu { get; set; }

Property Value

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

Declaration

public virtual bool ReadOnly { get; set; }

Property Value

Gets the predefined reminder time intervals.

Declaration

[Browsable(false)]
public virtual SchedulerReminderCollection Reminders { get; }

Property Value

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

Declaration

[Browsable(false)]
public AppointmentResizingBehavior ResizeBehavior { get; }

Property Value

Gets the resources.

Declaration

[Browsable(false)]
public virtual SchedulerResourceCollection Resources { get; }

Property Value

Gets or sets the behavior responsible for saving and loading appointment reminders. This behavior handles persistence of reminders between application sessions.

Declaration

public SchedulerSaveLoadRemindersBehavior SaveLoadRemindersBehavior { get; set; }

Property Value

Gets the scheduler element.

Declaration

[Browsable(false)]
public RadSchedulerElement SchedulerElement { get; }

Property Value

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

[Browsable(false)]
public SchedulerInputBehavior SchedulerInputBehavior { get; set; }

Property Value

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

Declaration

[Browsable(false)]
public SchedulerSelectionBehavior SelectionBehavior { get; set; }

Property Value

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

Declaration

public virtual bool ShowAllDayAppointmentStatus { get; set; }

Property Value

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

Declaration

public virtual bool ShowAppointmentStatus { get; set; }

Property Value

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

Declaration

public bool ShowNavigationElements { get; set; }

Property Value

Gets the statuses.

Declaration

[Browsable(false)]
public virtual SchedulerStatusCollection Statuses { get; }

Property Value

Gets or sets the selected time zone.

Declaration

[Browsable(false)]
public SchedulerTimeZone SystemTimeZone { get; set; }

Property Value

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

Declaration

public bool UseModernAppointmentStyles { get; set; }

Property Value

Gets the view element.

Declaration

[Browsable(false)]
public SchedulerViewElement ViewElement { get; }

Property Value

Shows the appointment edit dialog to add a new appointment.

Declaration

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

Parameters

Shows the appointment edit dialog to add a new appointment.

Declaration

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

Parameters

Declaration

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

Parameters

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

Declaration

public void ClearReminders()

Determines whether this control defines the theme for the specified element.

Declaration

public override bool ControlDefinesThemeForElement(RadElement element)

Parameters

Returns

Overrides RadControl.ControlDefinesThemeForElement(RadElement)

Copies the currently selected appointments to the clipboard.

Declaration

public void Copy()

Creates the accessibility instance for the RadScheduler control.

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Overrides Control.CreateAccessibilityInstance()

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

Declaration

protected virtual IEditAppointmentDialog CreateAppointmentEditDialog()

Returns

Declaration

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

Parameters

Returns

Declaration

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

Parameters

Returns

Creates the child items for the RadScheduler control.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Creates the RadSchedulerElement for this scheduler.

Declaration

protected virtual RadSchedulerElement CreateRadSchedulerElement()

Returns

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

Declaration

public void Cut()

Binds the scheduler to its data source and populates appointments and resources collections.

Declaration

public void DataBind()

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

Declaration

protected override void Dispose(bool disposing)