ASPxScheduler Properties

A scheduler control.

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 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.

AppRelativeTemplateSourceDirectory Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control)
AppointmentDataMember

Gets or sets the data source member which supplies appointment data to the scheduler.

AppointmentDataSource

Gets or sets the object used as the data source to store appointments.

AppointmentDataSourceID

Gets or sets the ID of the control from which the scheduler retrieves the appointments.

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)
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 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 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 Gets the HttpContext object associated with the server control for the current Web request.
(Inherited from Control)
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)
Controls

Gets the web control's collection of child controls.

(Inherited from ASPxWebControlBase)
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.

DataSource

This property is not in effect for the ASPxSchedulerDataWebControlBase class.

DataSourceID

This property is not in effect for the ASPxSchedulerDataWebControlBase class.

DayView

Gets an object that defines the settings of the scheduler's Day View.

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)
EnableCallBacks

Gets or sets a value that specifies whether the callback or postback technology is used to manage round trips to the server.

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.

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.

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)
Enabled

Overrides the ASPxWebControl.Enabled property.

EncodeHtml

This property is not in effect for the ASPxScheduler class.

Events 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 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.

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)
ID Gets or sets the programmatic identifier assigned to the server control.
(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)
IdSeparator 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 Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control)
IsTrackingViewState 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 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.

LoadViewStateByID Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control)
Loaded

Indicates whether a web control has been loaded into the Page object.

(Inherited from ASPxWebControlBase)
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)
ParentStyles

This property is not in effect for the ASPxWebControl class.

(Inherited from ASPxWebControl)
RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from Control)
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.

ResourceDataSource

Gets or sets the object from which the scheduler control retrieves the resources' list.

ResourceDataSourceID

Gets or sets the ID of the control from which the ASPxScheduler retrieves the resources.

ResourceNavigator

Gets the Resource Navigator control used to navigate through resources by end-users.

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.

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)
TabIndex Gets or sets the tab index of the Web server control.
(Inherited from WebControl)
TagKey Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
(Inherited from WebControl)
TagName 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)
TemplateSourceDirectory Gets the virtual directory of the Page or UserControl that contains the current server control.
(Inherited from Control)
Templates

Provides access to a SchedulerTemplates object containing templates for visual elements of the ASPxScheduler.

Theme

Gets or sets the name of the Theme to be applied to the control.

(Inherited from ASPxWebControl)
TimeZoneHelper

Provides access to an object used for converting time between time zones.

TimelineView

Gets an object that defines the settings of the scheduler's TimelineView.

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.

ViewState 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 Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control)
ViewStateMode Gets or sets the view-state mode of this control.
(Inherited from Control)
ViewVisibleInterval

Provides access to the View Visible Interval's properties.

Views

Contains the settings of the Views that are used to represent information within the ASPxScheduler control.

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.

See Also