public Scheduler()

Initializes a new instance of the Scheduler class.

public IReadOnlyList<SchedulerAppointment> CurrentAppointments

The appointments currently shown.

public SchedulerView CurrentView

The view currently shown.

public DateTime CurrentDate

The date the current range is built around.

public IReadOnlyList<SchedulerAppointment> SelectedAppointments

The selected appointments, in the order they were selected.

public Scheduler View(SchedulerView view)

Switches to view.

public Scheduler Views(params SchedulerView[] views)

Sets which views the toolbar offers, in order. Defaults to all five.

public Scheduler GoTo(DateTime date)

Moves the range to the one holding date.

public Scheduler Previous()

Moves to the previous range, as the toolbar's left arrow does.

public Scheduler Next()

Moves to the next range, as the toolbar's right arrow does.

public Scheduler GoToToday()

Moves to the range holding today.

public Scheduler Now(DateTime now)

Overrides what the scheduler treats as now: where the Today button goes, which day is highlighted and where the now line is drawn. Defaults to the clock, read on every rebuild.

public Scheduler FirstDayOfWeek(DayOfWeek day)

Sets the day a week starts on, for the Week, Month and Timeline views. Defaults to Sunday.

public Scheduler VisibleDays(int days)

Sets how many consecutive days the Day view shows. Defaults to 1.

public Scheduler AgendaDays(int days)

Sets how many days the Agenda lists, from the current date. Defaults to 7.

public Scheduler TimelineDays(int days)

Sets how many days the Timeline covers. Seven (the default) starts on the first day of the week; any other count starts on the current date.

public Scheduler VisibleHours(int startHour, int endHour)

Limits the hours the time grid and the Timeline draw, from startHour up to endHour (0 to 24). Appointments outside are clipped to the edge. Defaults to the whole day.

public Scheduler WorkHours(TimeSpan start, TimeSpan end)

Sets the working hours, shaded lighter in the time grid and the Timeline. Defaults to 08:00 to 17:00.

public Scheduler NoWorkHours()

Turns the working-hours shading off.

public Scheduler SlotMinutes(int minutes)

Sets the length of a slot, in minutes: the time grid's minor lines and the step every drag snaps to (hold Alt while dragging to snap to the minute). Defaults to 30.

public Scheduler HourHeight(double pixels)

Sets the height of one hour in the Day and Week views, in pixels. Defaults to 48.

public Scheduler TimelineHourWidth(double pixels)

Sets the width of one hour in the Timeline, in pixels. Defaults to 24.

public Scheduler ColumnMinWidth(double pixels)

Sets the narrowest a Day or Week column gets, in pixels. Below it the grid scrolls sideways. Defaults to 90.

public Scheduler MonthMaxAppointments(int count)

Sets how many appointments a Month cell lists before it shows "+N more". Defaults to 3.

public Scheduler Grouping(SchedulerGrouping grouping)

Sets how the Day and Week views split their columns by resource. Defaults to ByResource.

public Scheduler TwelveHourClock(bool value = true)

Writes times as 9:30 AM instead of 09:30.

public Scheduler ReadOnly(bool value = true)

Stops every gesture that would change data: move, resize, create, external drop and Delete. Selection, edit requests, the context menu and tooltips keep working.

public Scheduler SingleClickCreates(bool value = true)

Makes a single click on an empty slot request a new appointment, instead of a double-click.

public Scheduler HideToolbar(bool hide = true)

Hides the toolbar, for an application that drives View and GoTo itself.

public Scheduler Commands(params IComponent[] commands)

Adds components to the right of the toolbar, before the view switcher.

public Scheduler Labels(SchedulerLabels labels)

Replaces the text the scheduler draws on its own, for translation.

public Scheduler AppointmentTemplate(Func<SchedulerAppointment, IComponent> template)

Replaces what is drawn inside each appointment's block, chip, bar and agenda row. The block keeps its colour, selection outline and resize edges.

public Scheduler AppointmentTooltip(Func<SchedulerAppointment, IComponent> tooltip)

Replaces the tooltip shown over an appointment. Return null for none.

public Scheduler NoTooltips()

Turns the appointment tooltips off.

public Scheduler OnMove(Action<SchedulerMoveRequest> onMove)

Raised when an appointment is dragged to a new time or resource. Nothing has changed yet.

public Scheduler OnResize(Action<SchedulerResizeRequest> onResize)

Raised when an appointment's start or end edge is dragged. Nothing has changed yet.

public Scheduler OnCreate(Action<SchedulerSlot> onCreate)

Raised when the user asks for a new appointment: by dragging across empty time, by double-clicking an empty slot (a one-hour slot in the time grid and Timeline, the whole day in the all-day row and Month cells), or with a single click when SingleClickCreates is on.

public Scheduler OnSlotClick(Action<SchedulerSlot> onSlotClick)

Raised on every click on an empty slot, before any create.

public Scheduler OnEdit(Action<SchedulerAppointment> onEdit)

Raised when an appointment is double-clicked, or Enter is pressed on it. Locked appointments raise nothing.

public Scheduler OnContextMenu(Action<SchedulerAppointment, MouseEvent> onContextMenu)

Raised on a right-click on an appointment, with the pointer event to anchor a menu at (for example ContextMenu().ShowAt(...)). Setting a handler stops the browser's own menu there.

public Scheduler OnSelectionChanged(Action<IReadOnlyList<SchedulerAppointment>> onSelectionChanged)

Raised whenever the selection changes.

public Scheduler OnDelete(Action<IReadOnlyList<SchedulerAppointment>> onDelete)

Raised when Delete or Backspace is pressed with appointments selected (locked ones are left out).

public Scheduler OnExternalDrop(Action<SchedulerDropRequest> onExternalDrop)

Raised when something made draggable with MakeDraggable is dropped on a slot.

public Scheduler OnNavigate(Action<SchedulerView, DateTime> onNavigate)

Raised when the toolbar changes the view or the date.

public Scheduler Select(params SchedulerAppointment[] appointments)

Replaces the selection.

public Scheduler ClearSelection()

Clears the selection.

public Scheduler DeleteSelected()

Raises OnDelete for the selected appointments, as the Delete key does.

public static T MakeDraggable<T>(T component, object payload, string title, TimeSpan duration) where T : IComponent

Makes component a drag source the scheduler accepts: dropping it on a time slot, a Timeline lane or a Month cell raises OnExternalDrop with payload and a slot of duration. A ghost of that length follows the pointer over the scheduler.

public override HTMLElement Render()

Renders the component's root HTML element.

Day

A time grid of one or more consecutive days (see VisibleDays).

Week

A time grid of the seven days of the week the date falls in.

Month

The month the date falls in, as a grid of day cells with one chip per appointment.

Agenda

A list of the appointments of the coming days, grouped by date.

Timeline

One horizontal lane per resource over a week, time running left to right.

None

One column per day, every resource's appointments sharing it.

ByResource

One group per resource, each with a column per day.

ByDate

One group per day, each with a column per resource.

public object Id { get; set; }

The appointment's identity, compared with Equals. Selection is kept by it across updates.

public string Title { get; set; }

The text on the appointment's block.

public string Description { get; set; }

A longer text, shown in the default tooltip and the agenda.

public DateTime Start { get; set; }

Where the appointment begins, as wall-clock time.

public DateTime End { get; set; }

Where the appointment ends, as wall-clock time. Must not be before Start.

public bool IsAllDay { get; set; }

Draws the appointment in the all-day row instead of the time grid. An all-day appointment covers every day from Start's date up to, and not including, End — or Start's day alone when End is on the same date.

public List<object> ResourceIds { get; set; }

The resources the appointment belongs to. One block is drawn per resource column or lane.

public string Color { get; set; }

A CSS colour for the block. Defaults to the first resource's colour, then the theme's primary colour.

public bool IsLocked { get; set; }

Shows a lock mark and refuses every edit: no move, resize, delete or edit request.

public bool IsRecurring { get; set; }

Shows a recurrence mark. The scheduler does not expand occurrences: hand each one in.

public object Tag { get; set; }

Any value the application wants to keep with the appointment. Never read by the scheduler.

public TimeSpan Duration

The time between Start and End.

public SchedulerAppointment Clone()

Returns a copy of the appointment, with its own resource list.

public object Id { get; set; }

Matched against ResourceIds with Equals.

public string Name { get; set; }

The column or lane header.

public string Color { get; set; }

A CSS colour for the header chip and the resource's appointments.

public SchedulerAppointment Appointment { get; internal set; }

The application's own appointment instance.

public DateTime NewStart { get; internal set; }

The proposed start.

public DateTime NewEnd { get; internal set; }

The proposed end; the duration is kept.

public object FromResourceId { get; internal set; }

The resource of the column or lane the drag started in, or null without resources.

public object ToResourceId { get; internal set; }

The resource of the column or lane it was dropped in, or null without resources.

public bool IsCopy { get; internal set; }

Ctrl (or Cmd) was held on release: the user asked for a copy rather than a move.

public bool ChangesResource

Whether the drop lands on another resource.

public SchedulerAppointment Appointment { get; internal set; }

The application's own appointment instance.

public DateTime NewStart { get; internal set; }

The proposed start.

public DateTime NewEnd { get; internal set; }

The proposed end.

public DateTime Start { get; internal set; }

Where the slot begins.

public DateTime End { get; internal set; }

Where the slot ends.

public object ResourceId { get; internal set; }

The resource of the column or lane, or null.

public bool IsAllDay { get; internal set; }

Whether the slot is a whole day (the all-day row or a month cell): End is the next midnight.

public MouseEvent Event { get; internal set; }

The pointer event behind it, for anchoring a popup.

public object Payload { get; internal set; }

The payload handed to MakeDraggable.

public string Title { get; internal set; }

The title handed to MakeDraggable.

public DateTime Start { get; internal set; }

Where it was dropped.

public DateTime End { get; internal set; }

Start plus the duration handed to MakeDraggable.

public object ResourceId { get; internal set; }

The resource of the column or lane, or null.

public bool IsAllDay { get; internal set; }

Whether it landed on a whole day (a month cell).

public string Today { get; set; }

The toolbar's button back to today.

public string Previous { get; set; }

The toolbar's previous-range button.

public string Next { get; set; }

The toolbar's next-range button.

public string Day { get; set; }

The Day view's name.

public string Week { get; set; }

The Week view's name.

public string Month { get; set; }

The Month view's name.

public string Agenda { get; set; }

The Agenda view's name.

public string Timeline { get; set; }

The Timeline view's name.

public string AllDay { get; set; }

The caption of the all-day row, and the agenda's time for an all-day appointment.

public string More { get; set; }

A month cell's overflow link; {0} is the number of appointments not shown.

public string NoAppointments { get; set; }

The agenda's text when there is nothing in its range.

public string Unassigned { get; set; }

The column or lane of appointments that name no resource.

public string Resources { get; set; }

The caption above the timeline's resource names.

public string[] MonthNames { get; set; }

The month names, January first.

public string[] ShortMonthNames { get; set; }

The short month names, January first.

public string[] DayNames { get; set; }

The weekday names, Sunday first.

public string[] ShortDayNames { get; set; }

The short weekday names, Sunday first.