C1Schedule Class

The C1Schedule control is a fully functional Outlook-style schedule that allows users to add, edit, and manage their appointments by loading all of the appointment data either from a bound DataSource or the built-in DataSource, which saves and loads data from binary, XML or iCal file formats. By default, the C1Schedule control will display the appointment data in the DayView mode, and the current day is the first date displayed.

Inheritance

object

MarshalByRefObject

C1Schedule

Implements

Namespace: C1.Win.Schedule

Assembly: C1.Win.Schedule.10.dll

Syntax

[ToolboxBitmap(typeof(C1Schedule), "C1Schedule.png")]
[C1Description("C1Schedule", "Represents a fully-functional Outlook-style schedule.")]
[Docking(DockingBehavior.Ask)]
public class C1Schedule : UserControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, ISite, IServiceProvider, ISupportInitialize

<ToolboxBitmap(GetType(C1Schedule), "C1Schedule.png")>
<C1Description("C1Schedule", "Represents a fully-functional Outlook-style schedule.")>
<Docking(DockingBehavior.Ask)>
Public Class C1Schedule
    Inherits UserControl
    Implements IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, ISite, IServiceProvider, ISupportInitialize

Constructors

Name	Description
C1Schedule()	Initializes a new instance of the C1Schedule component.

Properties

Name	Description
AllowDrop	Gets or sets a value indicating whether the control can accept data that the user drags onto it.
AppointmentComparison	Gets or sets the Comparison<T> delegate which is used by the C1Schedule control to sort appointments.
AppointmentHeight	Gets or sets the int value determining the height of appointment elements in Month, TimeLine and Office 2003 Week View modes. Default value is -1. If this property is set to default value, appointment height will be determined automatically according to the current view font size.
BackColor
BackgroundImage
BackgroundImageLayout
BoldedDates	Gets the C1.Schedule.DateList object that determines which dates contain appointments.
BorderStyle	Gets or sets the type of border around the control.
CalendarInfo	Gets the CalendarInfo object for the C1Schedule control.
ContextMenuStrip	Gets or sets the ContextMenuStrip associated with this control.
CurrentDate	Gets the DateTime value that determines currently selected date in the C1Schedule control.
Cursor	Gets or sets the Cursor that appears when the mouse moves over the control.
DataStorage	Gets the C1.Win.Schedule.C1ScheduleStorage object for the C1Schedule control.
EditOptions	Gets or sets a EditOptions value, determining which actions are allowed to the end-user.
EmptyGroupName	Gets or sets a string value used as default value for the Name property. The default value is "Calendar".
Font
ForeColor
GroupBy	Gets or sets the string value determining the type of grouping.
GroupItems	Gets a collection of all available ScheduleGroupItem objects for the currently set type of grouping.
GroupPageSize	Gets or sets the int value determining the maximum number of the ScheduleGroupItem objects displayed in UI at the same time. Increasing this value might affect performance.
IsGrouped	Gets a bool value determining whether grouping has been set for the C1Schedule control.
LargeButtons	Gets or sets the bool value determining whether the control and its dialogs should use large icons and buttons.
Locations	Gets the List<T> list containing string descriptions of available locations.
MinAppointmentWidth	Gets or sets the int value determining the minimal width of appointment elements in TimeLine view. Default value is -1. If this property is set to default value, appointment width is determined automatically according to current view settings and style options.
MinDaySlotWidth	Gets or sets the int value determining the minimal width of day slots in TimeLine view when TimeLineStyle is Days. Default value is -1. If this property is set to default value, slot width is determined automatically according to current view settings and style options.
MinSlotWidth	Gets or sets the int value determining the minimal width of slots in TimeLine view. Default value is -1. If this property is set to default value, slot width is determined automatically according to current view settings and style options.
PrintInfo	Gets the PrintInfo object responsible for printing support.
ScrollPosition	Gets or sets the Point value determining the current scroll position.
ScrollSize	Gets the size of the document.
ScrollableRectangle	This property is used to get the scroll page size.
SelectedAppointments	Gets the C1.Schedule.AppointmentList object containing the list of currently selected C1.Schedule.Appointment objects.
SelectedDates	Gets the C1.Schedule.DateList object that determines currently selected dates in the C1Schedule control.
SelectedGroupItem	Gets the selected ScheduleGroupItem object or returns null if the selection is empty.
SelectedInterval	Gets the TimeInterval object representing currently selected time interval.
Settings	Gets the C1ScheduleSettings object for the C1Schedule control.
ShowAllDayArea	Gets or sets the bool value indicating whether the control should show All-Day area in a Day View. The default value is True.
ShowAppointmentStatus	Gets or sets the bool value indicating whether the control should show appointment status in Day, WorkingWeek, Week and TimeLine views.
ShowAppointmentToolTip	Gets or sets the bool value indicating whether the control should show tooltip when mouse is over an appointment.
ShowContextMenu	Gets or sets the bool value indicating whether the control should show context menu.
ShowEmptyGroupItem	Gets or sets the bool value determining whether the C1Schedule control should display an empty group item.
ShowGroupNavigation	Gets or sets the bool value determining whether the C1Schedule control should display group navigation buttons.
ShowReminderForm	Gets or sets the bool value indicating whether the control should show the reminder form when a reminder alerts.
ShowTitle	Gets or sets the bool value determining whether the control shows the title panel.
ShowWeekends	Gets or sets the bool value indicating whether the control should show weekends in a Month View. The default value is True.
ShowWorkTimeOnly	Gets or sets the bool value indicating whether the control should show only working hours in Day and TimeLine views.
Theme	Gets the Theme object determining the control appearance.
TimeLineStyle	Gets or sets the TimeLineStyleEnum value determining the Time Line style.
ViewType	Gets or sets the ScheduleViewEnum value determining currently displayed view.
VisibleGroupItems	Gets a collection of currently visible ScheduleGroupItem objects. This collection can be used in xaml in the C1Schedule control templates.
WeekTabFormat	Determines the content of week tabs in the month view mode. The default value is Floating.
WeekViewStyle	Gets or sets the WeekViewStyleEnum value determining Week View style.

Methods

Name	Description
BeginInit()
BeginUpdate()	Prevents the control from drawing until the EndUpdate() method is called.
Compare(Appointment, Appointment)	Performs a comparison of two C1.Schedule.Appointment objects based on their start time and subject.
CreateAllDayEvent()	Creates a new all-day C1.Schedule.Appointment object, shows it in the Edit Appointment dialog, and then adds it to the C1.Schedule.AppointmentStorage.Appointments collection.
CreateAppointment()	Creates a new C1.Schedule.Appointment object with default settings, shows it in the Edit Appointment dialog, and then adds it to the C1.Schedule.AppointmentStorage.Appointments collection.
CreateReccuringAllDayEvent()	Creates a new recurring all-day C1.Schedule.Appointment object, shows it in the Edit Appointment dialog, and then adds it to the C1.Schedule.AppointmentStorage.Appointments collection.
CreateReccuringAppointment()	Creates a new recurring C1.Schedule.Appointment object, shows it in the Edit Appointment dialog, and then adds it to the C1.Schedule.AppointmentStorage.Appointments collection.
Dispose(bool)	Clean up any resources being used.
EditAppointment(Appointment)	Shows specified C1.Schedule.Appointment object in the Edit Appointment dialog.
EditRecurrence(Appointment)	Opens RecurrenceForm dialog for editing existent or newly created C1.Schedule.RecurrencePattern object for the specified C1.Schedule.Appointment.
EndInit()
EndUpdate()	Resumes drawing of the control after drawing is suspended by the BeginUpdate() method.
EnsureVisibleTime(TimeSpan)	Ensures that the specified time is visible within the control, scrolling the contents if necessary. This method doesn't make sense for MonthView and Office 2003 WeekView modes.
Export(object, string)	Shows the SaveFileDialog and exports specified data to the selected file.
GetAppointmentAtPoint(Point)	Returns the C1.Schedule.Appointment object which is located in the Schedule at the given screen point.
GetDateTimeAtPoint(Point)	Returns the DateTime value which is located in the Schedule at the given screen point.
GoToDate(DateTime)	Sets the specified date as the start date of the scheduler, meaning that on this date the scheduler will show its data. This operation doesn't change the type of view.
Import(string)	Shows the OpenFileDialog and tries to export data from the selected file.
NavigateToScheduleGroup(int)	Navigates the C1Schedule control back or forth to another ScheduleGroupItem object by the specified increment.
OnFontChanged(EventArgs)
OnHandleCreated(EventArgs)	Overrides the default behavior.
Refresh()	Refreshes the control.
RemoveAppointment(Appointment)	Removes specified C1.Schedule.Appointment object from the C1.Schedule.AppointmentStorage.
ResetTheme()	Resets the value of the Theme property.
ResetVisualStyle()	Resets the value of the C1.Win.Schedule.C1Schedule.VisualStyle property.
SelectAppointment(Appointment, bool)	Selects specified C1.Schedule.Appointment object in the user interface.
ShouldSerializeTheme()
ShowDates(DateTime[])	Shows specified dates in the scheduler choosing appropriate type of view.
ShowDates(DateTime[], ScheduleViewEnum?)	Shows specified dates in the scheduler with the specified view type.

Events

Name	Description
AppointmentAdded	Occurs when an C1.Schedule.Appointment object is added.
AppointmentChanged	Occurs when an C1.Schedule.Appointment object is changed.
AppointmentCustomAction	Occurs immediately before a custom action of an C1.Schedule.Appointment object executes.
AppointmentDeleted	Occurs when an C1.Schedule.Appointment object is deleted.
AppointmentLinkClicked	Event that fires when the user clicks a hyperlink within the appointment element.
AppointmentRecurrenceStateChanged	Occurs when the C1.Schedule.Appointment.RecurrenceState property of an C1.Schedule.Appointment object is changed.
AppointmentsLoaded	Occurs when C1.Schedule.AppointmentCollection has been loaded by the C1ScheduleStorage.Import method.
BeforeAppointmentCreate	Occurs immediately before the new C1.Schedule.Appointment object is created.
BeforeAppointmentDelete	Occurs before an C1.Schedule.Appointment object is deleted by end-user by pressing 'Delete' button.
BeforeAppointmentDrop	Occurs before an C1.Schedule.Appointment object is dropped by end-user.
BeforeAppointmentEdit	Occurs before the C1.Schedule.Appointment object is edited in-place.
BeforeAppointmentFormat	Occurs before the appointment content is formatted.
BeforeAppointmentResize	Occurs before an C1.Schedule.Appointment object is resized by end-user.
BeforeAppointmentSave	Occurs before the C1.Schedule.Appointment object is saved by end-user.
BeforeAppointmentShow	Occurs immediately before the Appointment dialog box is displayed.
BeforeAppointmentTooltipShow	Occurs before the appointment tooltip is shown.
BeforeContextMenuShow	Occurs before the context menu is shown. This event gets fired even if ShowContextMenu property is false.
BeforeExport	Occurs before export operation performed by the Export(object, string) method.
BeforeGroupHeaderFormat	Occurs before the group header is formatted.
BeforeOptionsFormShow	Occurs before showing print options form.
BeforePrint	Occurs before printing.
BeforePrintPreview	Occurs before print preview.
BeforeReminderShow	Occurs immediately before the Reminder dialog box is displayed.
BeforeTimeFormat	Occurs before the time interval is formatted.
BeforeViewChange	Fired before the ViewType property change.
PrintDocumentStarting	Occurs when the print document building is started.
ReminderAdd	Occurs after a C1.Schedule.Reminder object is added.
ReminderChange	Occurs after a C1.Schedule.Reminder object has been modified.
ReminderFire	Occurs before the C1.Schedule.Reminder object is executed.
ReminderRemove	Occurs when a C1.Schedule.Reminder object has been removed from the collection.
ReminderSnooze	Occurs when a C1.Schedule.Reminder object is dismissed using the Snooze button.
SelectedAppointmentsChanged	Occurs when the list of selected appointments is changed.
SelectedDaysChanged	Occurs when the range of available days is changed.
SelectedIntervalChanged	Occurs when selected time interval is changed.
SelectionChanged	Occurs when the range of visible days is changed.