Skip to main content
A newer version of this page is available. .

ASPxScheduler Class

A control that represents scheduled data in a form of appointment objects on a web page.

Namespace: DevExpress.Web.ASPxScheduler

Assembly: DevExpress.Web.ASPxScheduler.v18.1.dll

Declaration

[ToolboxBitmap(typeof(ToolboxBitmapAccess), "Bitmaps256.ASPxScheduler.bmp")]
[DXClientDocumentationProvider("#AspNet/DevExpressWebASPxSchedulerScripts")]
[ToolboxTabName("DX.18.1: Scheduling")]
public class ASPxScheduler :
    ASPxSchedulerDataWebControlBase,
    IInnerSchedulerControlOwner,
    ICommandAwareControl<SchedulerCommandId>,
    IBatchUpdateable,
    IBatchUpdateHandler,
    ISupportInitialize,
    ISupportAppointmentEdit,
    ISupportAppointmentDependencyEdit,
    IScriptBlockOwner,
    IMasterControl,
    IXtraSupportShouldSerialize,
    IXtraSupportDeserializeCollectionItem,
    IRequiresLoadPostDataControl,
    IServiceContainer,
    IServiceProvider,
    ISchedulerCommandTarget,
    IInnerSchedulerCommandTarget,
    ISupportsSmartFetch

The following members accept/return ASPxScheduler objects:

Library Related API Members
eXpressApp Framework ASPxSchedulerListEditor.SchedulerControl
ASP.NET Web Forms Controls ASPxSchedulerControlPrintAdapter.SchedulerControl
SchedulerFormTemplateContainer.Control
SchedulerViewBase.Control

Remarks

The ASPxScheduler class is a visual control which allows Appointments to be scheduled and displayed. Appointments can be represented using one of the Views provided by the scheduler. A View is an object that defines the timeline, and how appointments are displayed along the timeline. For instance, the Day View represents appointments by day. When this View is active, the scheduler control displays a single day at a time with the appointments that are assigned to this day. All the scheduler Views are derived from the SchedulerViewBase class.

To select a specific View, use the ASPxScheduler.ActiveViewType property. View settings can be accessed via the ASPxScheduler.Views property.

The ASPxScheduler control doesn’t store the appointments and Resources for Appointments it displays. The control’s data is stored in a standalone object represented by the ASPxSchedulerStorage class. This storage should be assigned to the ASPxSchedulerDataWebControlBase.Storage property.

Note

The client-side equivalent of this scheduler control is represented by the ASPxClientScheduler object. The client-side API for this control is always enabled. Available client events can be accessed via the ASPxScheduler.ClientSideEvents property.

The following code snippets (auto-collected from DevExpress Examples) contain references to the ASPxScheduler class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

Implements

See Also