ClassEvent
Represents the base implementation of a scheduler event, providing core functionality for calendar appointments including time management, recurrence patterns, exception handling, resource assignments, and reminder capabilities. Implements IEvent, INotifyPropertyChanged, and IRemindObject interfaces.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.Scheduler.dll
Syntax:
public class Event : IEvent, IDataBoundItem, IRemindObject, INotifyPropertyChanged
Inheritance: objectEvent
Derived Classes:
Implements:
Constructors
Event()
Declaration
public Event()
Fields
occurrenceEnumerator
Declaration
protected OccurrenceEnumerator occurrenceEnumerator
Field Value
Properties
AllDay
Gets or sets a value indicating whether this event spans entire days without specific start and end times.
Declaration
public virtual bool AllDay { get; set; }
Property Value
Implements
AllowDelete
Gets or sets a value indicating whether this event can be deleted by the user through the scheduler interface.
Declaration
public virtual bool AllowDelete { get; set; }
Property Value
Implements
AllowEdit
Gets or sets a value indicating whether this event can be edited by the user through the scheduler interface.
Declaration
public virtual bool AllowEdit { get; set; }
Property Value
Implements
BackgroundId
Gets or sets the background identifier that determines the visual appearance and styling of the event in scheduler views.
Declaration
public virtual int BackgroundId { get; set; }
Property Value
Implements
CultureInfoProvider
Gets or sets the culture information provider used for localization and date formatting of this event and its occurrences.
Declaration
public ICultureInfoProvider CultureInfoProvider { get; set; }
Property Value
Implements
DataItem
Gets the underlying data object that this event is bound to, when using data binding scenarios.
Description
Gets or sets the detailed description of the event, providing additional information beyond the summary.
Declaration
public virtual string Description { get; set; }
Property Value
Implements
Dismissed
Gets or sets a value indicating whether the reminder for this IRemindObject has been dismissed by the user.
Declaration
public virtual bool Dismissed { get; set; }
Property Value
Implements
DismissedAppointments
Gets a dictionary containing the dismissed state for individual recurring appointment instances, indexed by their reminder identifiers.
Duration
Gets or sets the duration of the event, automatically calculating the time span between start and end times with special handling for all-day events.
Declaration
public virtual TimeSpan Duration { get; set; }
Property Value
Implements
End
Gets or sets the end date and time of the event, automatically adjusting for all-day events by returning only the date portion.
Declaration
public virtual DateTime End { get; set; }
Property Value
Implements
Exceptions
Gets the collection of exception events that override specific occurrences in a recurring event series.
Declaration
public virtual ObservableCollection<IEvent> Exceptions { get; }
Property Value
Implements
IsSuspended
Gets a value indicating whether property change notifications are currently suspended through SuspendNotifications().
IsViewCalculated
Gets or sets a value indicating whether this event instance has been calculated and processed for display in scheduler views.
Declaration
public virtual bool IsViewCalculated { get; set; }
Property Value
Location
Gets or sets the location where the event takes place, such as a room, building, or address.
Declaration
public virtual string Location { get; set; }
Property Value
Implements
MasterEvent
Gets the master event instance that this occurrence belongs to, or null if this is not an occurrence of a recurring event.
Occurrences
Gets an enumerable collection of all occurrences generated by this event's recurrence rule, providing access to individual instances of recurring events.
Declaration
public virtual IEnumerable<IEvent> Occurrences { get; }
Property Value
IEnumerable<IEvent>
Implements
RecurrenceId
Gets or sets the recurrence identifier date used to distinguish this event occurrence within a recurring series.
Declaration
public virtual DateTime? RecurrenceId { get; set; }
Property Value
Implements
RecurrenceRule
Gets or sets the recurrence rule that defines the recurring pattern for this event, or null for non-recurring events.
Declaration
public virtual RecurrenceRule RecurrenceRule { get; set; }
Property Value
Implements
RemindId
Gets the unique reminder identifier used for tracking reminder state of this event instance, combining the event's unique ID with its start time.
Reminder
Gets or sets the time span before the event start when the reminder should be triggered, or null to disable reminders for this IRemindObject.
Declaration
public virtual TimeSpan? Reminder { get; set; }
Property Value
Implements
ReminderAppointments
Gets a dictionary containing the reminder settings for individual recurring appointment instances, indexed by their reminder identifiers.
ResourceId
Gets or sets the primary resource identifier associated with this event, representing the first resource in the ResourceIds collection.
Declaration
public virtual EventId ResourceId { get; set; }
Property Value
Implements
ResourceIds
Gets the collection of resource identifiers associated with this event, supporting multiple resource assignments for a single event.
Declaration
public virtual ObservableCollection<EventId> ResourceIds { get; }
Property Value
Implements
Snoozed
Gets or sets the time span indicating how long the reminder for this IRemindObject has been snoozed.
Declaration
public virtual TimeSpan Snoozed { get; set; }
Property Value
Implements
SnoozedAppointments
Gets a dictionary containing the snooze durations for individual recurring appointment instances, indexed by their reminder identifiers.
Start
Gets or sets the start date and time of the event, automatically adjusting for all-day events by returning only the date portion.
Declaration
public virtual DateTime Start { get; set; }
Property Value
Implements
StartDateTime
Gets the start date and time when this reminder object begins, implementing the IRemindObject interface.
Declaration
public virtual DateTime StartDateTime { get; }
Property Value
Implements
StatusId
Gets or sets the status identifier that represents the current state of the event such as busy, free, or tentative.
Declaration
public virtual int StatusId { get; set; }
Property Value
Implements
Subject
Gets the subject text of this reminder object, typically displayed in reminder notifications and implementing the IRemindObject interface.
Declaration
public virtual string Subject { get; }
Property Value
Implements
Summary
Gets or sets the summary text of the event, typically displayed as the primary title or subject in scheduler views.
Declaration
public virtual string Summary { get; set; }
Property Value
Implements
ToolTipText
Gets or sets the tooltip text that appears when hovering over the event in scheduler views.
Declaration
public virtual string ToolTipText { get; set; }
Property Value
Implements
UniqueId
Gets or sets the unique identifier for this event, used for distinguishing between different event instances across the scheduler system.
Declaration
public virtual EventId UniqueId { get; set; }
Property Value
Implements
Methods
AddOccurrenceException(IEvent, bool)
Adds an exception occurrence to this recurring event, allowing individual occurrences to have different properties or behavior.
Declaration
public virtual void AddOccurrenceException(IEvent occurrence, bool addExceptionDate)
Parameters
occurrence
The occurrence event to add as an exception to this recurring series.
addExceptionDate
true to add the occurrence date to the recurrence rule's exception dates; false to only add to the exceptions collection.
Implements
CreateOccurrence(DateTime)
Creates a new occurrence instance of this recurring event with the specified start date, copying all relevant properties from the master event.
CreateOccurrence(DateTime, bool)
Creates a new occurrence instance of this recurring event with the specified start date and exception behavior.
Declaration
public virtual IEvent CreateOccurrence(DateTime start, bool exception)
Parameters
start
The start date and time for the new occurrence.
exception
true to create an exception occurrence with independent resource collection; false for a standard occurrence.
Returns
A new IEvent instance representing an occurrence of this recurring event.
Implements
CreateOccurrenceInstance()
Creates a new instance of an Event to represent an occurrence of this recurring event. This method can be overridden in derived classes to create specific event types.
GetOccurrences(DateTime, DateTime)
Gets all occurrences of this recurring event within the specified time period, filtered by the given date range.
Declaration
public virtual IEnumerable<IEvent> GetOccurrences(DateTime from, DateTime to)
Parameters
from
The start date of the period to retrieve occurrences for.
to
The end date of the period to retrieve occurrences for.
Returns
IEnumerable<IEvent>
An enumerable collection of IEvent occurrences within the specified date range.
OnPropertyChanged(string)
Raises the PropertyChanged event for the specified property name, unless notifications are currently suspended.
Declaration
protected virtual void OnPropertyChanged(string propertyName)
Parameters
propertyName
The name of the property that changed.
ResumeNotifications()
Resumes property change notifications if they have been previously suspended using SuspendNotifications().
Declaration
public virtual void ResumeNotifications()
SuspendNotifications()
Suspends property change notifications to improve performance during batch property updates. Call ResumeNotifications() to restore normal notification behavior.
Declaration
public virtual void SuspendNotifications()
Events
PropertyChanged
Occurs when a property value changes, implementing the INotifyPropertyChanged interface for data binding support.
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Value
Implements