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

ASPxScheduler Members

A scheduler control.

Constructors

Name Description
ASPxScheduler() Initializes a new instance of the ASPxScheduler class with default settings.

Fields

Name Description
FormNames static Returns the names of the forms that are used by the ASPxScheduler control.
ToolTipsFormNames static Returns the names of the tootltip forms that are used by the ASPxScheduler control.

Properties

Name Description
AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl.
ActiveView Gets the View currently used by the Scheduler to show its data.
ActiveViewType Gets or sets the type of the View which is currently used by the Scheduler to show its data.
Adapter protected Gets the browser-specific adapter for the control. Inherited from Control.
AgendaView Gets an object that defines the settings of the scheduler’s Agenda View.
AppointmentDataMember Gets or sets the data source member which supplies appointment data to the scheduler. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentDataSource Gets or sets the object used as the data source to store appointments. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentDataSourceID Gets or sets the ID of the control from which the scheduler retrieves the appointments. Inherited from ASPxSchedulerDataWebControlBase.
AppRelativeTemplateSourceDirectory Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control.
Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
BackColor Gets or sets the background color of the Web server control. Inherited from WebControl.
BackgroundImage Gets the web control’s background image. Inherited from ASPxWebControl.
BackwardCompatibility static Provides access to the control’s backward compatibility settings. Inherited from ASPxWebControl.
BindingContainer For internal use only. Inherited from ASPxWebControl.
Border Gets the web control’s border settings. Inherited from ASPxWebControl.
BorderBottom Gets the settings of the web control’s bottom border. Inherited from ASPxWebControl.
BorderColor Gets or sets the border color of the web control. Use the BorderWrapper.BorderColor property instead. Inherited from ASPxWebControl.
BorderLeft Gets the settings of the web control’s left border. Inherited from ASPxWebControl.
BorderRight Gets the settings of the web control’s right border. Inherited from ASPxWebControl.
BorderStyle Gets or sets the border style of the web control. Use the BorderWrapper.BorderStyle property instead. Inherited from ASPxWebControl.
BorderTop Gets the settings of the web control’s top border. Inherited from ASPxWebControl.
BorderWidth Gets or sets the border width of the web control. Use the BorderWrapper.BorderWidth property instead. Inherited from ASPxWebControl.
Bound Gets a value that specifies whether the control is data bound. Inherited from ASPxDataWebControlBase.
ChildControlsCreated protected Gets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
ClientID Gets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase.
ClientIDMode Gets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control.
ClientIDSeparator protected Gets a character value representing the separator character used in the ClientID property. Inherited from Control.
ClientInstanceName Gets or sets the ASPxScheduler’s client programmatic identifier.
ClientSideEvents Gets an object that lists the client-side events specific to the ASPxScheduler.
ClientVisible Gets or sets whether the ASPxScheduler client control is displayed.
Context protected Gets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
Controls Gets the web control’s collection of child controls. Inherited from ASPxWebControlBase.
ControlStyle Gets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl.
ControlStyleCreated Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. Inherited from WebControl.
CssClass Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl.
CssFilePath Overrides the ASPxWebControl.CssFilePath property to hide it.
CssPostfix Overrides the ASPxWebControl.CssPostfix property to hide it.
Cursor Gets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl.
CustomShortcuts Provides access to a collection of custom keyboard shortcuts.
DataItemContainer Gets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control.
DataKeysContainer Gets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control.
DataMember This property is not in effect for the ASPxSchedulerDataWebControlBase class. Inherited from ASPxSchedulerDataWebControlBase.
DataSource This property is not in effect for the ASPxSchedulerDataWebControlBase class. Inherited from ASPxSchedulerDataWebControlBase.
DataSourceID This property is not in effect for the ASPxSchedulerDataWebControlBase class. Inherited from ASPxSchedulerDataWebControlBase.
DayView Gets an object that defines the settings of the scheduler’s Day View.
DesignMode For internal use only. Inherited from ASPxWebControl.
DisabledCssClass static Gets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
DisabledStyle Overrides the ASPxWebControl.DisabledStyle property.
EmptyImage static Obsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
EnableCallbackAnimation Gets or sets whether animation effects are applied to scheduler content when it is updated using a callback.
EnableCallbackCompression Gets or sets whether the callback result data compression is enabled.
EnableCallBacks Gets or sets a value that specifies whether the callback or postback technology is used to manage round trips to the server.
EnableChangeVisibleIntervalCallbackAnimation Gets or sets whether animation effects are applied to scheduler content when the visible interval is changed and the scheduler is updated using a callback.
EnableChangeVisibleIntervalGestures Gets or sets a value specifying whether an end-user can change the visible interval with a swipe gesture.
EnableClientRender Gets or sets a value that specifies whether or not to use client-side rendering of ASPxScheduler’s appointments and view elements.
Enabled Overrides the ASPxWebControl.Enabled property.
EnableDefaultAppearance Obsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnablePagingGestures Gets or sets a value specifying whether an end-user can navigate views with a swipe gesture.
EnableTheming Gets or sets a value indicating whether themes apply to this control. Inherited from WebControl.
EnableViewState Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. Inherited from Control.
EncodeHtml This property is not in effect for the ASPxScheduler class.
Events protected Gets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
FirstDayOfWeek Gets the day which the ASPXScheduler‘s week starts from.
FloatingActionButton Provides access to the floating action button’s properties.
Font Gets the font properties associated with the Web server control. Inherited from WebControl.
ForeColor Gets or sets the foreground color (typically the color of the text) of the Web server control. Inherited from WebControl.
FullWeekView Gets an object that specifies the settings of the scheduler’s Full Week View.
GlobalAccessibilityCompliant static Gets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalCheckReferencesToExternalScripts static Gets or sets whether the availability and correctness of references to external client scripts (such as jQuery, jQuery UI, Knockout, etc.), which are used by certain DevExpress web controls, are checked. Inherited from ASPxWebControl.
GlobalEmbedRequiredClientLibraries static Obsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources. Inherited from ASPxWebControl.
GlobalRightToLeft static Gets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalStyleSheetTheme static Gets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalTheme static Gets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalThemeBaseColor static Gets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
GlobalThemeFont static Gets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
GroupType Gets or sets a value that specifies the type of grouping for the appointments of the ASPxScheduler control.
HasAttributes Gets a value indicating whether the control has attributes set. Inherited from WebControl.
HasChildViewState protected Gets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control.
Height Overrides the ASPxWebControl.Height property to hide it.
ID Gets or sets the programmatic identifier assigned to the server control. Inherited from Control.
IdSeparator protected Gets the character used to separate control identifiers. Inherited from Control.
Images Provides access to the settings that define images displayed within the ASPxScheduler’s visual elements .
Initialized Gets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
IsCallback Gets a value indicating whether the request is the result of a callback sent by the control. Inherited from ASPxWebControl.
IsChildControlStateCleared protected Gets a value indicating whether controls contained within this control have control state. Inherited from Control.
IsRendering For internal use only. Inherited from ASPxWebControlBase.
IsTrackingViewState protected Gets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsUpdateLocked Gets whether the ASPxScheduler control has been locked for updating.
IsViewStateEnabled protected Gets a value indicating whether view state is enabled for this control. Inherited from Control.
JSProperties Gets a collection of temporary client properties and its values.
LimitInterval Gets or sets the time interval available for end-users.
Loaded Indicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadViewStateByID protected Gets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control.
MonthView Gets an object that defines the settings of the scheduler’s Month (Multi-Week) View.
NamingContainer Gets a reference to the server control’s naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. Inherited from Control.
OptionsAdaptivity Provides access to the scheduler’s adaptivity settings.
OptionsBehavior Provides access to options which regulate the general appearance and behavior of the scheduler and its satellite controls.
OptionsCookies Provides access to an object used to maintain view state information.
OptionsCustomization Provides access to the options that regulate the functionality available to end-users.
OptionsForms Provides access to the options used to customize the forms shown to end-users.
OptionsLoadingPanel Provides access to the settings for the informational panel, which is displayed when the control is loading.
OptionsMenu Provides access to menu options.
OptionsToolTips Provides access to options which specify tooltip appearance and visibility.
OptionsView Provides access to the Scheduler’s view options.
Page Gets a reference to the Page instance that contains the server control. Inherited from Control.
Parent Gets a reference to the server control’s parent control in the page control hierarchy. Inherited from Control.
ParentImages This property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
ParentSkinOwner For internal use only. Inherited from ASPxWebControl.
ParentStyles This property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
PostDataLoading For internal use only. Inherited from ASPxWebControl.
PreRendered For internal use only. Inherited from ASPxWebControlBase.
RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
Request For internal use only. Inherited from ASPxWebControl.
ResourceColorSchemas Gets the color schemas used to paint resource columns in a grouped view.
ResourceDataMember Gets or sets the name of the list of resource data that the scheduler binds to, in instances where the data source contains more than one distinct list of data items. Inherited from ASPxSchedulerDataWebControlBase.
ResourceDataSource Gets or sets the object from which the scheduler control retrieves the resources’ list. Inherited from ASPxSchedulerDataWebControlBase.
ResourceDataSourceID Gets or sets the ID of the control from which the ASPxScheduler retrieves the resources. Inherited from ASPxSchedulerDataWebControlBase.
ResourceNavigator Gets the Resource Navigator control used to navigate through resources by end-users.
Response For internal use only. Inherited from ASPxWebControl.
SelectedAppointments Provides access to the collection of selected appointments.
SelectedInterval Gets the time interval currently selected in the scheduler’s active View by an end-user.
SelectedResource Gets the resource which contains the time interval currently selected in the scheduler’s active view.
Services Provides access to services of the ASPxScheduler control.
ShadowImage static Obsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
Site Gets information about the container that hosts the current control when rendered on a design surface. Inherited from Control.
SkinID Gets or sets the skin to apply to the control. Inherited from WebControl.
Start Gets or sets the start date of the scheduler.
Storage Provides access to the storage object of the scheduler control. Inherited from ASPxSchedulerDataWebControlBase.
Style Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. Inherited from WebControl.
Styles Provides access to style settings that control the appearance of the ASPxScheduler elements.
SupportsDisabledAttribute Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to “disabled” when the control’s IsEnabled property is false. Inherited from WebControl.
IControlBuilderAccessor.ControlBuilder For a description of this member, see ControlBuilder. Inherited from Control.
IControlDesignerAccessor.UserData For a description of this member, see UserData. Inherited from Control.
IDataBindingsAccessor.DataBindings For a description of this member, see DataBindings. Inherited from Control.
IDataBindingsAccessor.HasDataBindings For a description of this member, see HasDataBindings. Inherited from Control.
IExpressionsAccessor.Expressions For a description of this member, see Expressions. Inherited from Control.
IExpressionsAccessor.HasExpressions For a description of this member, see HasExpressions. Inherited from Control.
TabIndex Gets or sets the tab index of the Web server control. Inherited from WebControl.
TagKey protected Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl.
TagName protected Gets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl.
TemplateControl Gets or sets a reference to the template that contains this control. Inherited from Control.
Templates Provides access to a SchedulerTemplates object containing templates for visual elements of the ASPxScheduler.
TemplateSourceDirectory Gets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control.
Theme Gets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
TimelineView Gets an object that defines the settings of the scheduler’s TimelineView.
TimeZoneHelper Provides access to an object used for converting time between time zones.
ToolTip Gets or sets the control’s tooltip text.
UniqueID Gets the unique, hierarchically qualified identifier for the server control. Inherited from Control.
ValidateRequestMode Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control.
ViewNavigator Provides access to the View Navigator’s properties.
Views Contains the settings of the Views that are used to represent information within the ASPxScheduler control.
ViewState protected Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. Inherited from Control.
ViewStateIgnoresCase protected Gets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control.
ViewStateLoading For internal use only. Inherited from ASPxWebControl.
ViewStateMode Gets or sets the view-state mode of this control. Inherited from Control.
ViewVisibleInterval Provides access to the View Visible Interval’s properties.
Visible Gets or sets a value that indicates whether a server control is rendered as UI on the page. Inherited from Control.
WeekView Gets an object that defines the settings of the scheduler’s Week View.
Width Gets or sets the width of the web server control. Inherited from ASPxWebControl.
WorkDays Provides access to the collection which identifies which days are assigned to a workweek.
WorkWeekView Gets an object that defines the settings of the scheduler’s Work-Week View.

Methods

Name Description
AddAttributesToRender(HtmlTextWriter) protected Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. Inherited from WebControl.
AddedControl(Control, Int32) protected Called after a child control is added to the Controls collection of the Control object. Inherited from Control.
AddParsedSubObject(Object) protected Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control’s ControlCollection object. Inherited from Control.
AddService(Type, ServiceCreatorCallback, Boolean) Adds the specified service to the service container.
AddService(Type, ServiceCreatorCallback) Adds the specified service to the service container.
AddService(Type, Object, Boolean) Adds the specified service to the service container.
AddService(Type, Object) Adds the specified service to the service container.
ApplyChanges(ASPxSchedulerChangeAction) Forces the Scheduler control to apply changes as specified by the actions parameter.
ApplyStyle(Style) Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. Inherited from WebControl.
ApplyStyleSheetSkin(Page) Applies the style properties defined in the page style sheet to the control, then starts the ASPxScheduler control’s initialization.
ApplyStyleSheetThemeInternal() For internal use only. Inherited from ASPxWebControl.
ApplyThemeInternal() For internal use only. Inherited from ASPxWebControl.
BeginInit() Starts the ASPXScheduler control’s initialization. Initialization occurs at runtime.
BeginRenderTracing(TextWriter, Object) protected Begins design-time tracing of rendering data. Inherited from Control.
BeginUpdate() Prevents the control from being updated until the ASPxScheduler.EndUpdate method is called.
BuildProfileTree(String, Boolean) protected Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. Inherited from Control.
CancelUpdate() Unlocks the Scheduler Control after a call to the ASPxScheduler.BeginUpdate method and causes an immediate update without raising any notification events.
ClearCachedClientID() protected Sets the cached ClientID value to null. Inherited from Control.
ClearChildControlState() protected Deletes the control-state information for the server control’s child controls. Inherited from Control.
ClearChildState() protected Deletes the view-state and control-state information for all the server control’s child controls. Inherited from Control.
ClearChildViewState() protected Deletes the view-state information for all the server control’s child controls. Inherited from Control.
ClearEffectiveClientIDMode() protected Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. Inherited from Control.
CopyBaseAttributes(WebControl) Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. Inherited from WebControl.
CreateAppointment() Executes a callback command that creates a new appointment.
CreateControlCollection() protected Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. Inherited from Control.
DataBind() Binds the data source to the invoked server control. Inherited from ASPxWebControl.
DataBind(Boolean) protected Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. Inherited from Control.
DataBindChildren() protected Binds a data source to the server control’s child controls. Inherited from Control.
Dispose() Enables a server control to perform final clean up before it is released from memory.
EndInit() Ends the ASPXScheduler control’s initialization.
EndRenderTracing(TextWriter, Object) protected Ends design-time tracing of rendering data. Inherited from Control.
EndUpdate() Unlocks the control after a call to the ASPxScheduler.BeginUpdate method and causes an immediate update.
EnsureID() protected Creates an identifier for controls that do not have an identifier assigned. Inherited from Control.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
FindControl(String, Int32) protected Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. Inherited from Control.
FindControl(String) Searches the current naming container for a server control with the specified id parameter. Inherited from Control.
Focus() Sets input focus to the web control. Inherited from ASPxWebControl.
GenerateDefaultLayout(Boolean) For internal use only.
GetAppointmentClientId(Appointment) Gets the unique client-side identifier of the specified appointment. Inherited from ASPxSchedulerDataWebControlBase.
GetCallbackErrorMessage() static Obtains the error info while processing the redirection page. Inherited from ASPxWebControl.
GetClientSideEventHandler(String) Returns the specified client event’s handler. Inherited from ASPxWebControl.
GetControlStyle() For internal use only. Inherited from ASPxWebControl.
GetCssClassNamePrefix() For internal use only. Inherited from ASPxWebControl.
GetCssClassNamePrefix(String) For internal use only. Inherited from ASPxWebControl.
GetDefaultBooleanProperty(String, DefaultBoolean) For internal use only. Inherited from ASPxWebControl.
GetDesignModeState() protected Gets design-time data for a control. Inherited from Control.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetPaddings() For internal use only. Inherited from ASPxWebControl.
GetResourceUrl(Page, String) static Returns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl.
GetResourceUrl(Page, Type, String) static Returns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl.
GetRouteUrl(Object) Gets the URL that corresponds to a set of route parameters. Inherited from Control.
GetRouteUrl(String, Object) Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control.
GetRouteUrl(String, RouteValueDictionary) Gets the URL that corresponds to a set of route parameters and a route name. Inherited from Control.
GetRouteUrl(RouteValueDictionary) Gets the URL that corresponds to a set of route parameters. Inherited from Control.
GetService(Type) Gets the service object of the specified type.
GetType() Gets the Type of the current instance. Inherited from Object.
GetUniqueIDRelativeTo(Control) Returns the prefixed portion of the UniqueID property of the specified control. Inherited from Control.
GoToDate(DateTime, SchedulerViewType) Sets the specified date as the start date of the scheduler, and forces the scheduler to display data using the specified view.
GoToDate(DateTime) Sets the specified date as the start date of the scheduler.
GoToToday() Sets the start date of the scheduler to the current date on the local machine.
HasControls() Determines if the server control contains any child controls. Inherited from Control.
HasEvents() protected Returns a value indicating whether events are registered for the control or any child controls. Inherited from Control.
HtmlEncode(String, Boolean) For internal use only. Inherited from ASPxWebControl.
HtmlEncode(String) For internal use only. Inherited from ASPxWebControl.
IsAccessibilityCompliantRender() Returns a value that indicates whether the control’s accessible html code is rendered. Inherited from ASPxWebControl.
IsAccessibilityCompliantRender(Boolean) Returns a value that indicates whether the control’s accessible html code is rendered. Inherited from ASPxWebControl.
IsClientSideAPIEnabled() Returns a value that indicates whether a specific programmatic interface (in particular, specific JavaScript objects and methods) are available to the control on the client side. Inherited from ASPxWebControl.
IsClientSideEventsAssigned() For internal use only. Inherited from ASPxWebControl.
IsClientVisible() For internal use only. Inherited from ASPxWebControl.
IsEnabled() Returns a value that specifies whether a web control is enabled. Inherited from ASPxWebControlBase.
IsLiteralContent() protected Determines if the server control holds only literal content. Inherited from Control.
IsLoading() This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from ASPxWebControl.
IsNativeRender() For internal use only. Inherited from ASPxWebControl.
IsViewStateStoring() For internal use only. Inherited from ASPxWebControlBase.
IsVisible() Returns a value that specifies whether the current web control is displayed. Inherited from ASPxWebControlBase.
LoadControlState(Object) protected Restores control-state information from a previous page request that was saved by the SaveControlState() method. Inherited from Control.
LookupAppointmentByIdString(String) Returns an appointment specified by its client identifier.
MakeResponseCompressed() static Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client. Inherited from ASPxWebControl.
MakeResponseCompressed(Boolean) static Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client, and accepts a parameter specifying whether to apply compression to IE6. Inherited from ASPxWebControl.
MapPathSecure(String) protected Retrieves the physical path that a virtual path, either absolute or relative, maps to. Inherited from Control.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MergeStyle(Style) Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. Inherited from WebControl.
OnUnload(EventArgs) protected Raises the Unload event. Inherited from Control.
OpenFile(String) protected Gets a Stream used to read a file. Inherited from Control.
RaiseBubbleEvent(Object, EventArgs) protected Assigns any sources of the event and its information to the control’s parent. Inherited from Control.
RedirectOnCallback(String) static Redirects a client to a new URL while processing a callback. Inherited from ASPxWebControl.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RegisterBaseScript(Page, Boolean) static Registers base scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RegisterBaseScript(Page) static Registers base scripts, required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RegisterClientIncludeScripts() For internal use only. Inherited from ASPxWebControl.
RegisterClientScriptBlocks() For internal use only. Inherited from ASPxWebControl.
RegisterClientScripts() For internal use only. Inherited from ASPxWebControl.
RegisterStyleSheets() For internal use only. Inherited from ASPxWebControl.
RegisterUtilsScript(Page) static Obsolete. Registers utils scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RemovedControl(Control) protected Called after a child control is removed from the Controls collection of the Control object. Inherited from Control.
RemoveService(Type, Boolean) Removes the service of the specified type from the service container.
RemoveService(Type) Removes the service of the specified type from the service container.
RenderBeginTag(HtmlTextWriter) Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl.
RenderChildren(HtmlTextWriter) protected Outputs the content of a server control’s children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. Inherited from Control.
RenderContents(HtmlTextWriter) protected Renders the contents of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl.
RenderControl(HtmlTextWriter, ControlAdapter) protected Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. Inherited from Control.
RenderControl(HtmlTextWriter) Delivers the content of the control to a specified HtmlTextWriter object. This method is intended for internal use.
RenderEndTag(HtmlTextWriter) Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. Inherited from WebControl.
RequireClientLibrariesRegistering() static Specifies whether client library registration is required. Inherited from ASPxWebControl.
ResetViewStateStoringFlag() For internal use only. Inherited from ASPxWebControlBase.
ResolveAdapter() protected Gets the control adapter responsible for rendering the specified control. Inherited from Control.
ResolveClientUrl(String) Gets a URL that can be used by the browser. Inherited from ASPxWebControlBase.
ResolveUrl(String) Converts a URL into one that is usable on the requesting client. Inherited from Control.
SaveControlState() protected Saves any server control state changes that have occurred since the time the page was posted back to the server. Inherited from Control.
SetCallbackErrorMessage(String) static Specifies the message text to be displayed for remote clients when a DevExpress control callback error has occurred. Inherited from ASPxWebControl.
SetClientSideEventHandler(String, String) Defines a handler for the specified client event. Inherited from ASPxWebControl.
SetDefaultBooleanProperty(String, DefaultBoolean, DefaultBoolean) For internal use only. Inherited from ASPxWebControl.
SetDesignModeState(IDictionary) protected Sets design-time data for a control. Inherited from Control.
SetIECompatibilityMode(Int32, Control) static Obsolete. Switches all DevExpress controls on the specified page to use the specified IE version. Inherited from ASPxWebControl.
SetIECompatibilityMode(Int32) static Switches all DevExpress controls on a page to use the specified IE version. Inherited from ASPxWebControl.
SetIECompatibilityModeEdge() static Switches all DevExpress controls on a page to use the latest IE version. Inherited from ASPxWebControl.
SetIECompatibilityModeEdge(Control) static Obsolete. Switches all DevExpress controls on the specified page to use the latest IE version. Inherited from ASPxWebControl.
SetRenderMethodDelegate(RenderMethod) Assigns an event handler delegate to render the server control and its content into its parent control. Inherited from Control.
SetTraceData(Object, Object, Object) Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. Inherited from Control.
SetTraceData(Object, Object) Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. Inherited from Control.
SetViewStateStoringFlag() For internal use only. Inherited from ASPxWebControlBase.
SetVisibleResources(IEnumerable<Object>) Sets whether the resources with specified IDs are visible.
IAttributeAccessor.GetAttribute(String) Gets an attribute of the Web control with the specified name. Inherited from WebControl.
IAttributeAccessor.SetAttribute(String, String) Sets an attribute of the Web control to the specified name and value. Inherited from WebControl.
IControlDesignerAccessor.GetDesignModeState() For a description of this member, see GetDesignModeState(). Inherited from Control.
IControlDesignerAccessor.SetDesignModeState(IDictionary) For a description of this member, see SetDesignModeState(IDictionary). Inherited from Control.
IControlDesignerAccessor.SetOwnerControl(Control) For a description of this member, see SetOwnerControl(Control). Inherited from Control.
IParserAccessor.AddParsedSubObject(Object) For a description of this member, see AddParsedSubObject(Object). Inherited from Control.
ToString() Returns a string that represents the current object. Inherited from Object.
UseCachedObjects() For internal use ony. Inherited from ASPxWebControl.

Events

Name Description
ActiveViewChanged Occurs after the active view of the Scheduler has been changed.
ActiveViewChanging Occurs when the Scheduler control is about to change its active View.
AfterExecuteCallbackCommand Occurs after a callback command is executed.
AllowAppointmentConflicts Occurs when the scheduler finds appointments that are in conflict, and the SchedulerOptionsCustomization.AllowAppointmentConflicts property is set to AppointmentConflictsMode.Custom.
AllowAppointmentCopy Occurs when the scheduler initialize an appointment and the SchedulerOptionsCustomization.AllowAppointmentCopy property is set to Custom.
AllowAppointmentCreate Occurs when the scheduler initialize an appointment.
AllowAppointmentDelete Occurs when the scheduler initialize an appointment.
AllowAppointmentDrag Occurs when the scheduler initialize an appointment.
AllowAppointmentDragBetweenResources Occurs when the scheduler initialize an appointment and the SchedulerControl.AllowAppointmentDragBetweenResources property is set to Custom.
AllowAppointmentEdit Occurs when the scheduler initialize an appointment and the SchedulerOptionsCustomization.AllowAppointmentEdit property is set to Custom.
AllowAppointmentResize Occurs when the scheduler initialize an appointment and the SchedulerOptionsCustomization.AllowAppointmentResize property is set to Custom.
AllowInplaceEditor Occurs when the scheduler initialize an appointment.
AppointmentChanging Fires when an appointment’s property is about to be changed. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentCollectionAutoReloading Occurs when the data source which contains appointment records is modified and appointments are set to be automatically reloaded. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentCollectionCleared Fires after the appointment collection has been cleared. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentCollectionLoaded Fires after appointments have been loaded into the AppointmentBaseCollection collection. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentDeleting Occurs before an appointment is deleted and allows you to cancel the action. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentFormShowing Occurs before the appointment editing window is created.
AppointmentInplaceEditorShowing Occurs before an inplace appointment editor is invoked.
AppointmentInserting Occurs before an appointment is added to the AppointmentBaseCollection collection and allows you to cancel the operation. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentRowDeleted Fires after an appointment’s data row is deleted from the data source. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentRowDeleting Fires before an appointment data row is deleted from the data source. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentRowInserted Fires after a new record containing appointment information is inserted into the data source. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentRowInserting Fires before appointment data is posted to the data source for insertion. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentRowUpdated Fires after an appointment’s data record is updated. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentRowUpdating Fires before the appointment data is posted to the data source to update the record. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentsChanged Fires when the appointments’ properties have been changed. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentsDeleted Fires after you delete an appointment. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentsInserted Fires after one or several appointments have been added to the collection. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentViewInfoCustomizing Occurs every time an appointment is rendered, so its AppointmentViewInfoCustomizingEventArgs.ViewInfo is changed.
BeforeExecuteCallbackCommand Fires before a callback command is executed.
BeforeGetCallbackResult Occurs after a callback sent by the current control has been processed on the server, but prior to the time the respective callback result render is formed.
CallbackError static Allows you to handle any server exception that might occur during server-side processing of a callback sent by a DevExpress web control. Inherited from ASPxWebControl.
ClientLayout Enables you to save and restore the previously saved layout of the scheduler.
CustomCallback Fires when a round trip to the server has been initiated by a call to the client ASPxClientScheduler.PerformCallback method. Inherited from ASPxSchedulerDataWebControlBase.
CustomErrorText Enables you to provide custom error descriptions.
CustomizeElementStyle Fires before a scheduler’s visual element is rendered.
CustomJSProperties Enables you to supply any server data that can then be parsed on the client.
DataBinding Occurs when the server control binds to a data source. Inherited from Control.
DataBound Occurs after the server control binds to the data source. Inherited from ASPxDataWebControlBase.
DateNavigatorQueryActiveViewType Enables you to specify a view type to which the Scheduler switches after the end-user changes selected dates in the DateNavigator control.
Disposed Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. Inherited from Control.
FetchAppointments Occurs before the scheduler starts retrieving the appointments for the specified time interval. Inherited from ASPxSchedulerDataWebControlBase.
FilterAppointment Enables specific appointments to be hidden in the scheduler. Inherited from ASPxSchedulerDataWebControlBase.
FilterReminderAlert Enables you to fire alerts only for specific reminders. Inherited from ASPxSchedulerDataWebControlBase.
FilterResource Hides specific resources in the scheduler. Inherited from ASPxSchedulerDataWebControlBase.
GotoDateFormShowing Occurs before the Go To Date dialog window is invoked.
HtmlTimeCellPrepared Occurs when the HTML code representing the time cell is prepared for display.
Init Occurs when the server control is initialized, which is the first step in its lifecycle. Inherited from Control.
InitAppointmentDisplayText Enables custom text and a description to be displayed within appointments.
InitAppointmentImages Enables you to display custom images within appointments.
InitClientAppointment This event fires for each visible appointment before it is sent to the client for display and enables you to specify client appointment properties.
InitNewAppointment Occurs before a new appointment is created in the scheduler.
Load Occurs when the server control is loaded into the Page object. Inherited from Control.
MoreButtonClicked Server-side event. Occurs when the user clicks one of the More Buttons.ASPxScheduler.
PopupMenuShowing Occurs before a popup menu is created and allows menu customization.
PrepareAppointmentFormPopupContainer Occurs when the pop-up container for the Appointment Form is prepared for display.
PrepareAppointmentInplaceEditorPopupContainer Occurs when the pop-up container for the In-place Editor is prepared for display.
PrepareGotoDateFormPopupContainer Occurs when the pop-up container for the Go to Date Form is prepared for display.
PreparePopupMenu Obsolete. Occurs before a context menu is created for a scheduler.
PrepareRecurrenceAppointmentDeleteFormPopupContainer Occurs when the pop-up container for the Delete Recurrence Form is prepared for display.
PrepareRecurrenceAppointmentEditFormPopupContainer Occurs when the pop-up container for the Edit Recurrence Form is prepared for display.
PrepareRemindersFormPopupContainer Occurs when the pop-up container for the Reminders Form is prepared for display.
PreRender Occurs after the Control object is loaded but prior to rendering. Inherited from Control.
QueryWorkTime Occurs when the scheduler’s view calculates the work time interval for the specific resource.
RecurrentAppointmentDeleteFormShowing Occurs before the Confirm Delete dialog window is invoked.
RecurrentAppointmentEditFormShowing Occurs before the Open Recurring Item dialog window is invoked.
ReminderAlert Occurs when a reminder is invoked. Inherited from ASPxSchedulerDataWebControlBase.
RemindersFormDefaultAction Occurs when an end-user closes the Reminders Form without clicking the Dismiss or Snooze button. The SchedulerOptionsBehaviorBase.RemindersFormDefaultAction property should be set to RemindersFormDefaultAction.Custom.
RemindersFormShowing Occurs before the Reminders form is displayed.
ResourceChanging Fires when a resource’s property is about to be changed. Inherited from ASPxSchedulerDataWebControlBase.
ResourceCollectionAutoReloading Occurs when the data source which contains resources is modified, and the automatic reloading of resources is enabled. Inherited from ASPxSchedulerDataWebControlBase.
ResourceCollectionCleared Fires after the resources collection has been cleared. Inherited from ASPxSchedulerDataWebControlBase.
ResourceCollectionLoaded Fires after resources have been loaded into the ResourceBaseCollection collection. Inherited from ASPxSchedulerDataWebControlBase.
ResourceDeleting Allows the deletion of a resource to be cancelled. Inherited from ASPxSchedulerDataWebControlBase.
ResourceInserting Allows you to cancel the addition of a resource. Inherited from ASPxSchedulerDataWebControlBase.
ResourcesChanged Fires when the resources’ properties are changed. Inherited from ASPxSchedulerDataWebControlBase.
ResourcesDeleted Occurs when a scheduler’s resource is deleted from the collection. Inherited from ASPxSchedulerDataWebControlBase.
ResourcesInserted Occurs when new resources are inserted into the ResourceBaseCollection collection. Inherited from ASPxSchedulerDataWebControlBase.
UnhandledException Enables you to catch an unhandled exception in ASPxScheduler which occurs during a callback and stop its propagation beyond the control.
Unload Occurs when the server control is unloaded from memory. Inherited from Control.
VisibleIntervalChanged Fires when the time interval represented by the control’s scheduling area has been changed.
See Also