KaxScheduler Class

KaxScheduler Class

KaxScheduler control class.

Inheritance Hierarchy

SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      System.Web.UI.WebControlsBaseDataBoundControl
        System.Web.UI.WebControlsDataBoundControl
          KaxDataBoundControl
            Kettic.AspNet.ControlsKaxScheduler

Namespace: Kettic.AspNet.Controls
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)

Syntax

C++

Copy

public class KaxScheduler : KaxDataBoundControl, 
	IPostBackEventHandler, INamingContainer, ILocalizableControl, IScheduler, IAppointmentFactory, 
	ICallbackEventHandler, ICallbackCommandContext

Public Class KaxScheduler
	Inherits KaxDataBoundControl
	Implements IPostBackEventHandler, INamingContainer, ILocalizableControl, IScheduler, 
	IAppointmentFactory, ICallbackEventHandler, ICallbackCommandContext

public ref class KaxScheduler : public KaxDataBoundControl, 
	IPostBackEventHandler, INamingContainer, ILocalizableControl, IScheduler, IAppointmentFactory, 
	ICallbackEventHandler, ICallbackCommandContext

type KaxScheduler =  
    class
        inherit KaxDataBoundControl
        interface IPostBackEventHandler
        interface INamingContainer
        interface ILocalizableControl
        interface IScheduler
        interface IAppointmentFactory
        interface ICallbackEventHandler
        interface ICallbackCommandContext
    end

The KaxScheduler type exposes the following members.

Constructors

	Name	Description
	KaxScheduler

Top

Methods

	Name	Description
	CreateAppointment	Creates a new appointment instance. This method is used internally by KaxScheduler and can be used by custom appointment providers.
	DisplayToUtc	Converts a date time object from client date format to UTC using the TimeZoneOffset property.
	ExportToICalendar(Appointment)	Exports an appointment to iCalendar format.
	ExportToICalendar(IEnumerableAppointment)	Exports the specified appointments to iCalendar format.
	ExportToICalendar(AppointmentCollection)	Exports the specified appointments to iCalendar format.
	ExportToICalendar(Appointment, TimeSpan)	Exports an appointment to iCalendar format.
	ExportToICalendar(IEnumerableAppointment, TimeSpan)	Exports the specified appointments to iCalendar format.
	ExportToICalendar(AppointmentCollection, TimeSpan)	Exports the specified appointments to iCalendar format.
	GetCallbackResult
	GetTimeSlotFromIndex	Retrieves a TimeSlot object from its client-side index
	HideEditForm	Hides the active insert or edit form (if any).
	InsertAppointment	Inserts the specified appointment in the Appointments collection, expands the series (if it is recurring) and inserts persists it through the provider.
	PrepareToEdit	Prepares the specified appointment for editing.
	RaiseCallbackEvent
	Rebind
	RemoveAppointment	Deletes the appointment or the recurrence series it is part of.
	RemoveRecurrenceExceptions	Removes the associated recurrence exceptions through the provider.
	ShowAdvancedEditForm(Appointment)	Shows the advanced edit form.
	ShowAdvancedEditForm(Appointment, Boolean)	Shows the advanced edit form.
	ShowAdvancedInsertForm	Shows the advansed insert form.
	ShowAlldayInlineInsertForm	Shows the all-day inline insert form
	ShowInlineEditForm(Appointment)	Shows the inline edit form.
	ShowInlineEditForm(Appointment, Boolean)	Shows the inline edit form.
	ShowInlineInsertForm(DateTime)	Shows the inline insert form.
	ShowInlineInsertForm(ISchedulerTimeSlot)	Shows the inline insert form.
	UpdateAppointment(Appointment)	Updates the specified appointment and persists the changes through the provider.
	UpdateAppointment(Appointment, Appointment)	Updates the specified appointment and persists the changes through the provider. Use this overload when the underlying data source requires both original and modified data to perform an update operation. One such example is LinqDataSource.
	UtcDayStart	Returns the UTC date that corresponds to midnight on the client for the selected date.
	UtcToDisplay	Converts a date time object from UTC to client date format using the TimeZoneOffset property.

Top

Properties

	Name	Description
	AdvancedEditTemplate
	AdvancedForm
	AdvancedInsertTemplate
	AllowDelete	Gets or sets a value indicating whether appointments deleting is allowed.
	AllowEdit	Gets or sets a value indicating whether appointments editing is allowed.
	AllowInsert	Gets or sets a value indicating whether appointments inserting is allowed.
	AppointmentComparer	Gets or sets the comparer instance used to determine the appointment ordering within the same slot. By default, appointments are ordered by start time and duration.
	AppointmentContextMenus	Gets a collection of KaxSchedulerContextMenu objects that represent the Appointment context menus of the KaxScheduler control.
	AppointmentContextMenuSettings
	AppointmentFactory	A factory for appointment instances.
	Appointments	Gets a collection of Appointment objects that represent individual appointments in the KaxScheduler control.
	AppointmentStyleMode	Defines the styling mode for appointments.
	AppointmentTemplate
	ColumnWidth	Gets or sets the width of each content column.
	Culture
	CustomAttributeNames	Specifies the database fields (column names) which should be loaded as appointment attributes.
	DataDescriptionField	Gets or sets the description field for appointments in the data source specified by the DataSourceID property.
	DataEndField	Gets or sets the end field for appointments in the data source specified by the DataSourceID property.
	DataKeyField	Gets or sets the key field for appointments in the data source specified by the DataSourceID property.
	DataRecurrenceField	Gets or sets the recurrence rule field for appointments in the data source specified by the DataSourceID property.
	DataRecurrenceParentKeyField	Gets or sets the recurrence parent key field for appointments in the data source specified by the DataSourceID property.
	DataReminderField	Gets or sets the reminder field for appointments in the data source specified by the DataSourceID property.
	DataSourceID	Overridden. Gets or sets the ID property of the data source control that the KaxScheduler should use to retrieve its data source. (Overrides KaxDataBoundControl.DataSourceID.)
	DataStartField	Gets or sets the start field for appointments in the data source specified by the DataSourceID property.
	DataSubjectField	Gets or sets the subject field for appointments in the data source specified by the DataSourceID property.
	DayEndTime	Gets or sets the time used to denote the end of the day.
	DayStartTime	Gets or sets the time used to denote the start of the day.
	DayView
	DisplayRecurrenceActionDialogOnMove	Gets or sets a value indicating whether a confirmation dialog should be displayed when the user moves a recurring appointment.
	EditFormDateFormat	Obsolete. Gets or sets the edit form date format string.
	EditFormTimeFormat	Obsolete. Gets or sets the edit form time format string.
	EditingRecurringSeries	Gets a value indicating whether the recurring series are being edited at the moment, as opposed to a single appointment of the series.
	EnableAdvancedForm	Obsolete. Gets or sets a value indicating whether the user can use the advanced insert/edit form.
	EnableCustomAttributeEditing	Obsolete. Gets or sets a value that indicates whether the attribute editing in the advanced form is enabled.
	EnableDatePicker	Gets or sets a value indicating whether to enable the date picker for quick navigation.
	EnableDescriptionField	Gets or sets a value indicating whether the user can view and edit the description field of appointments.
	EnableRecurrenceSupport	Gets or sets a value indicating whether the user can create and edit recurring appointments.
	EnableResourceEditing	Obsolete. Gets or sets a value that indicates whether the resource editing in the advanced form is enabled.
	FirstDayOfWeek	Gets or sets the first day of the week.
	GroupBy	Gets the name of the resource to group by. Can also be in the format "Date,[Resource Name]" when grouping by date.
	GroupingDirection	Gets or sets the resource grouping direction of the KaxScheduler.
	Height	(Overrides KaxDataBoundControl.Height.)
	HoursPanelTimeFormat	Gets or sets the hours panel time format string.
	InlineEditTemplate
	InlineInsertTemplate
	LastDayOfWeek	Gets or sets the last day of the week.
	Localization
	MaximumRecurrenceCandidates	Gets or sets the maximum recurrence candidates limit.
	MinimumInlineFormHeight	Gets or sets the minimum height of the inline insert/edit template.
	MinimumInlineFormWidth	Gets or sets the minimum width of the inline insert/edit template.
	MinutesPerRow	Gets or sets the number of minuties which a single row represents
	MonthView
	MultiDayView
	NumberOfHoveredRows	Gets or sets the number of rows that are hovered when the mouse is over the appointment area.
	OnClientAppointmentClick
	OnClientAppointmentContextMenu	Gets or sets a value indicating the client-side event handler that is called when an appointment has been right-clicked.
	OnClientAppointmentContextMenuItemClicked	Gets or sets a value indicating the client-side event handler that is called when an apointment context menu item is clicked, after KaxScheduler has processed the event.
	OnClientAppointmentContextMenuItemClicking	Gets or sets a value indicating the client-side event handler that is called when an apointment context menu item is clicked, before KaxScheduler processes the click event.
	OnClientAppointmentCreated	Gets or sets a value indicating the client-side event handler that is called when an appointment is received from the Web Service and hase been rendered.
	OnClientAppointmentDataBound	Gets or sets a value indicating the client-side event handler that is called when an appointment is received from the Web Service and is about to be rendered.
	OnClientAppointmentDeleting
	OnClientAppointmentDoubleClick
	OnClientAppointmentEditing
	OnClientAppointmentInserting
	OnClientAppointmentMoveEnd	Gets or sets a value indicating the client-side event handler that is called when an appointment has been moved.
	OnClientAppointmentMoveStart	Gets or sets a value indicating the client-side event handler that is called when an appointment is about to be moved.
	OnClientAppointmentMoving	Gets or sets a value indicating the client-side event handler that is called when an appointment is being moved.
	OnClientAppointmentResizeEnd
	OnClientAppointmentResizeStart
	OnClientAppointmentResizing
	OnClientAppointmentSerialized	Gets or sets a value indicating the client-side event handler that is called when an appointment has been serialized to a data object and is about to be sent to the Web Service.
	OnClientAppointmentsPopulated	Gets or sets a value indicating the client-side event handler that is called when the scheduler has received appointments from the Web Service.
	OnClientAppointmentsPopulating	Gets or sets a value indicating the client-side event handler that is called when the scheduler is about to request appointments from the Web Service.
	OnClientAppointmentWebServiceDeleting	Gets or sets a value indicating the client-side event handler that is called when an appointment is about to be deleted via Web Service call.
	OnClientAppointmentWebServiceInserting	Gets or sets a value indicating the client-side event handler that is called when an appointment is about to be stored via Web Service call.
	OnClientAppointmentWebServiceUpdating	Gets or sets a value indicating the client-side event handler that is called when an appointment is about to be updated via Web Service call.
	OnClientDataBound	Gets or sets a value indicating the client-side event handler that is called when the scheduler has been populated with data.
	OnClientFormCreated	Gets or sets a value indicating the client-side event handler that is called when an edit/insert form has been created.
	OnClientNavigationCommand	Gets or sets a value indicating the client-side event handler that is called when the scheduler is about to execute a navigation command.
	OnClientNavigationComplete	Gets or sets a value indicating the client-side event handler that is called when a navigation command has been completed.
	OnClientRecurrenceActionDialogClosed	Gets or sets a value indicating the client-side event handler that is called when the recurrence action confirmation dialog has been closed.
	OnClientRecurrenceActionDialogShowing	Gets or sets a value indicating the client-side event handler that is called when the recurrence action confirmation dialog is about to be shown.
	OnClientRecurrenceExceptionCreating	Gets or sets a value indicating the client-side event handler that is called when a recurrence exception is about to be created via Web Service call.
	OnClientRecurrenceExceptionsRemoving	Gets or sets a value indicating the client-side event handler that is called when recurrence exceptions are about to be removed via Web Service call.
	OnClientReminderDismissing	Gets or sets a value indicating the client-side event handler that is called when an appointment reminder is about to be dismissed.
	OnClientReminderSnoozing	Gets or sets a value indicating the client-side event handler that is called when an appointment reminder is about to be snoozed.
	OnClientReminderTriggering	Gets or sets a value indicating the client-side event handler that is called when an appointment reminder is due and is about to be triggered.
	OnClientRequestFailed	Gets or sets a value indicating the client-side event handler that is called when a request to the Web Service has failed.
	OnClientRequestSuccess	Gets or sets a value indicating the client-side event handler that is called when a request to the Web Service has succeeded.
	OnClientResourcesPopulated	Gets or sets a value indicating the client-side event handler that is called when the scheduler has received resources from the Web Service.
	OnClientResourcesPopulating	Gets or sets a value indicating the client-side event handler that is called when the scheduler is about to request resources from the Web Service.
	OnClientTimeSlotClick
	OnClientTimeSlotContextMenu	Gets or sets a value indicating the client-side event handler that is called when an empty time slot has been right-clicked.
	OnClientTimeSlotContextMenuItemClicked	Gets or sets a value indicating the client-side event handler that is called when a time slot context menu item is clicked, after KaxScheduler has processed the event.
	OnClientTimeSlotContextMenuItemClicking	Gets or sets a value indicating the client-side event handler that is called when a time slot context menu item is clicked, before KaxScheduler processes the click event.
	OverflowBehavior	Gets or sets a value specifying the way KaxScheduler should behave when its content overflows its dimensions.
	Provider	Gets or sets the provider instance to be used by KaxScheduler. Use this property with providers that are created at runtime. For ASP.NET providers defined in web.config use the ProviderName property.
	ProviderContext	Gets the current provider context. The context object contains additional information about the currently performed operation, that can be used to improve and optimize provider implementations.
	ProviderName	Gets or sets the name of the current appointment provider used by KaxScheduler. The provider must be defined in the KaxScheduler section of web.config.
	ReadOnly	Gets or sets a value indicating whether KaxScheduler is in read-only mode.
	RecurrenceSupport	Gets a boolean value that indicates if recurrence support has been configured for this instance of KaxScheduler.
	Reminders
	RemindersSupport	Gets a boolean value that indicates if reminders support has been configured for this instance of KaxScheduler.
	ResourceHeaderTemplate
	Resources	A collection of all resources loaded by KaxScheduler.
	ResourceStyles	Gets a collection of ResourceStyleMapping objects can be used to associate resources with particular cascading style sheet (CSS) classes.
	ResourceTypes	Gets a collection of ResourceType objects that represent the resource types used by KaxScheduler.
	RowHeaderWidth	Gets or sets the width of each row header.
	RowHeight	Gets or sets the height of KaxScheduler rows.
	SelectedDate	The meaning of this property is different depending on the current view type. In day view mode SelectedDate gets or sets the currently displayed date. In week and month view modes SelectedDate gets or sets the highlighted date in the current week or month.
	SelectedView	Gets or sets the current view type.
	ShowAllDayRow	Gets or sets a value indicating whether to render the all day pane.
	ShowDateHeaders	Gets or sets a value indicating whether to render date headers for the current view.
	ShowDeleteConfirmation	Gets or sets a value indicating whether a delete confirmation dialog should be displayed when the user clicks the "delete" button of an appointment.
	ShowFooter	Gets or sets a value indicating whether to render the footer.
	ShowFullTime	Gets or sets a value indicating whether to display the complete day (24-hour view) or the range between DayStartTime and DayEndTime.
	ShowHeader	Gets or sets a value indicating whether to render the header.
	ShowHoursColumn	Gets or sets a value indicating whether to render the hours column in day and week view.
	ShowNavigationPane	Gets or sets a value indicating whether to render the navigation links..
	ShowResourceHeaders	Gets or sets a value indicating whether to render resource headers for the current view.
	ShowViewTabs	Gets or sets a value indicating whether to render the tabs for switching between the view types.
	StartEditingInAdvancedForm	Gets or sets a value indicating whether "advanced" mode is the default edit mode.
	StartInsertingInAdvancedForm	Gets or sets a value indicating whether "advanced" mode is the default insert mode.
	TimeLabelRowSpan	Gets or sets the number of rows each time label spans.
	TimelineView
	TimeSlotContextMenus	Gets a collection of KaxSchedulerContextMenu objects that represent the time slot context menus of the KaxScheduler control.
	TimeSlotContextMenuSettings
	TimeZoneOffset	Gets or sets the time zone offset to use when displaying appointments.
	UniqueID	(Overrides ControlUniqueID.)
	ValidationGroup	Gets or sets the name of the validation group to be used for the integrated validation controls.
	VisibleRangeEnd	Returns visible end date of the current view.
	VisibleRangeStart	Returns visible start date of the current view.
	VisualTimeZoneOffset	Gets or sets the time zone offset to use when determining todays date.
	WebServiceSettings
	WeekView
	WorkDayEndTime	Gets or sets the time used to denote the end of the work day.
	WorkDayStartTime	Gets or sets the time used to denote the start of the work day.

Top

Events

	Name	Description
	AppointmentCancelingEdit	Occurs when the Cancel button of an edit form is clicked, but before KaxScheduler exits edit mode.
	AppointmentClick	Occurs when an appointment has been clicked.
	AppointmentCommand	Occurs when a button is clicked within the appointment template.
	AppointmentContextMenuItemClicked	Occurs after an appointment context menu item is clicked.
	AppointmentContextMenuItemClicking	Occurs when an appointment context menu item is clicked, before processing default commands.
	AppointmentCreated	Occurs when an appointment template has been instantiated.
	AppointmentDataBound	Occurs when an appointment has been added to the Appointments collection from the data source.
	AppointmentDelete	Occurs when an appointment is about to be deleted from the database through the provider.
	AppointmentInsert	Occurs when an appointment is about to be inserted in the database through the provider.
	AppointmentUpdate	Occurs when an appointment is about to be updated through the provider.
	FormCreated	Occurs when an insert/edit form has been created.
	FormCreating	Occurs when an insert/edit form is being created.
	NavigationCommand	Occurs when the KaxScheduler is about to execute a navigation command.
	NavigationComplete	Occurs when a navigation command has been executed.
	OccurrenceDelete	Occurs when an occurrence is about to be removed.
	RecurrenceExceptionCreated	Occurs when an appointment that represents a recurrence exception is about to be created.
	ReminderDismiss	Occurs when a reminder has been dismissed.
	ReminderSnooze	Occurs when a reminder has been snoozed.
	ResourceHeaderCreated	Occurs when a resource header has been created.
	ResourcesPopulating	Occurs when the scheduler is about to request resources from the Web Service.
	TimeSlotContextMenuItemClicked	Occurs after a time slot context menu item is clicked.
	TimeSlotContextMenuItemClicking	Occurs when a time slot context menu item is clicked, before processing default commands.
	TimeSlotCreated	Occurs when a time slot has been created.

Top

Reference

Kettic.AspNet.Controls Namespace