Back to Devexpress

ASPxScheduler Properties

aspnet-devexpress-dot-web-dot-aspxscheduler-dot-aspxscheduler-dot-underscore-properties.md

latest38.3 KB
Original Source

ASPxScheduler Properties

A scheduler control.

NameDescription
AccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl.
ActiveViewGets the View currently used by the Scheduler to show its data.
ActiveViewTypeGets or sets the type of the View which is currently used by the Scheduler to show its data.
Adapter protectedGets the browser-specific adapter for the control. Inherited from Control.
AgendaViewGets an object that defines the settings of the scheduler’s Agenda View.
AppointmentDataSourceGets or sets the object used as the data source to store appointments. Inherited from ASPxSchedulerDataWebControlBase.
AppointmentDataSourceIDSpecifies an appointment data source ID. Inherited from ASPxSchedulerDataWebControlBase.
AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
BackColorGets or sets the background color of the Web server control. Inherited from WebControl.
BackgroundImageGets the web control’s background image. Inherited from ASPxWebControl.
BackwardCompatibility staticProvides access to the control’s backward compatibility settings. Inherited from ASPxWebControl.
BorderGets the web control’s border settings. Inherited from ASPxWebControl.
BorderBottomGets the settings of the web control’s bottom border. Inherited from ASPxWebControl.
BorderLeftGets the settings of the web control’s left border. Inherited from ASPxWebControl.
BorderRightGets the settings of the web control’s right border. Inherited from ASPxWebControl.
BorderTopGets the settings of the web control’s top border. Inherited from ASPxWebControl.
BoundGets a value that specifies whether the control is data bound. Inherited from ASPxDataWebControlBase.
ChildControlsCreated protectedGets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
ClientIDGets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase.
ClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control.
ClientIDSeparator protectedGets a character value representing the separator character used in the ClientID property. Inherited from Control.
ClientInstanceNameGets or sets the ASPxScheduler’s client programmatic identifier.
ClientSideEventsGets an object that lists the client-side events specific to the ASPxScheduler.
ClientVisibleGets or sets whether the ASPxScheduler client control is displayed.
Context protectedGets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
ControlsGets the web control’s collection of child controls. Inherited from ASPxWebControlBase.
ControlStyleGets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl.
ControlStyleCreatedGets 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.
CssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl.
CssFilePathOverrides the ASPxWebControl.CssFilePath property to hide it.
CssPostfixOverrides the ASPxWebControl.CssPostfix property to hide it.
CursorGets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl.
CustomShortcutsProvides access to a collection of custom keyboard shortcuts.
DataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control.
DataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control.
DayViewGets an object that defines the settings of the scheduler’s Day View.
DisabledCssClass staticGets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
EmptyImage staticObsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
EnableCallbackAnimationGets or sets whether animation effects are applied to scheduler content when it is updated using a callback.
EnableCallbackCompressionGets or sets whether the callback result data compression is enabled.
EnableCallBacksGets or sets a value that specifies whether the callback or postback technology is used to manage round trips to the server.
EnableChangeVisibleIntervalCallbackAnimationGets or sets whether animation effects are applied to scheduler content when the visible interval is changed and the scheduler is updated using a callback.
EnableChangeVisibleIntervalGesturesGets or sets a value specifying whether an end-user can change the visible interval with a swipe gesture.
EnableClientRenderGets or sets a value that specifies whether or not to use client-side rendering of ASPxScheduler’s appointments and view elements.
EnableDefaultAppearanceObsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnablePagingGesturesGets or sets a value specifying whether an end-user can navigate views with a swipe gesture.
EnableThemingGets or sets a value indicating whether themes apply to this control. Inherited from WebControl.
EnableViewStateGets 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.
Events protectedGets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
FirstDayOfWeekGets the day which the ASPXScheduler ‘s week starts from.
FloatingActionButtonProvides access to the floating action button’s properties.
FontGets the font properties associated with the Web server control. Inherited from WebControl.
ForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. Inherited from WebControl.
FullWeekViewGets an object that specifies the settings of the scheduler’s Full Week View.
GlobalAccessibilityCompliant staticGets 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 staticGets or sets whether links to external client scripts (such as jQuery, Knockout, and others), which are used by some DevExpress web components, are checked for presence and correctness. Inherited from ASPxWebControl.
GlobalEmbedRequiredClientLibraries staticObsolete. 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 staticGets 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 staticGets 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 staticGets 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 staticGets 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 staticGets 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.
GroupTypeGets or sets a value that specifies the type of grouping for the appointments of the ASPxScheduler control.
HasAttributesGets a value indicating whether the control has attributes set. Inherited from WebControl.
HasChildViewState protectedGets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control.
IDGets or sets the programmatic identifier assigned to the server control. Inherited from Control.
IdSeparator protectedGets the character used to separate control identifiers. Inherited from Control.
ImagesGives access to the images settings.
InitializedGets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
IsCallbackGets a value indicating whether the request is the result of a callback sent by the control. Inherited from ASPxWebControl.
IsChildControlStateCleared protectedGets a value indicating whether controls contained within this control have control state. Inherited from Control.
IsTrackingViewState protectedGets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsUpdateLockedGets whether the ASPxScheduler control has been locked for updating.
IsViewStateEnabled protectedGets a value indicating whether view state is enabled for this control. Inherited from Control.
JSPropertiesGets a collection of temporary client properties and its values.
LimitIntervalGets or sets the time interval available for end-users.
LoadedIndicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadViewStateByID protectedGets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control.
MonthViewGets an object that defines the settings of the scheduler’s Month (Multi-Week) View.
NamingContainerGets 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.
OptionsAdaptivityProvides access to the scheduler’s adaptivity settings.
OptionsBehaviorProvides access to options which regulate the general appearance and behavior of the scheduler and its satellite controls.
OptionsCookiesProvides access to view state information.
OptionsCustomizationProvides access to the options that regulate the functionality available to end-users.
OptionsFormsProvides access to the options used to customize the forms shown to end-users.
OptionsLoadingPanelProvides access to the settings for the informational panel, which is displayed when the control is loading.
OptionsMenuProvides access to menu options.
OptionsToolTipsProvides access to options which specify tooltip appearance and visibility.
OptionsViewProvides access to the Scheduler’s view options.
PageGets a reference to the Page instance that contains the server control. Inherited from Control.
ParentGets a reference to the server control’s parent control in the page control hierarchy. Inherited from Control.
ParentImagesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
ParentStylesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
RenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
ResourceColorSchemasGets the color schemas used to paint resource columns in a grouped view.
ResourceDataSourceGets or sets the object from which the scheduler control retrieves the resources’ list. Inherited from ASPxSchedulerDataWebControlBase.
ResourceDataSourceIDGets or sets the ID of the control from which the ASPxScheduler retrieves the resources. Inherited from ASPxSchedulerDataWebControlBase.
ResourceNavigatorGets the Resource Navigator control used to navigate through resources by end-users.
SelectedAppointmentsProvides access to the collection of selected appointments.
SelectedResourceGets the resource which contains the time interval currently selected in the scheduler’s active view.
ServicesProvides access to services of the ASPxScheduler control.
ShadowImage staticObsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
SiteGets information about the container that hosts the current control when rendered on a design surface. Inherited from Control.
SkinIDGets or sets the skin to apply to the control. Inherited from WebControl.
StartGets or sets the start date of the scheduler.
StorageProvides access to the storage object of the scheduler control. Inherited from ASPxSchedulerDataWebControlBase.
StyleGets 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.
StylesProvides access to style settings that control the appearance of the ASPxScheduler elements.
SupportsDisabledAttributeGets 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.ControlBuilderFor a description of this member, see ControlBuilder. Inherited from Control.
IControlDesignerAccessor.UserDataFor a description of this member, see UserData. Inherited from Control.
IDataBindingsAccessor.DataBindingsFor a description of this member, see DataBindings. Inherited from Control.
IDataBindingsAccessor.HasDataBindingsFor a description of this member, see HasDataBindings. Inherited from Control.
IExpressionsAccessor.ExpressionsFor a description of this member, see Expressions. Inherited from Control.
IExpressionsAccessor.HasExpressionsFor a description of this member, see HasExpressions. Inherited from Control.
TabIndexGets or sets the tab index of the Web server control. Inherited from WebControl.
TagKey protectedGets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl.
TagName protectedGets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl.
TemplateControlGets or sets a reference to the template that contains this control. Inherited from Control.
TemplatesProvides access to a SchedulerTemplates object containing templates for visual elements of the ASPxScheduler.
TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control.
ThemeGets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
TimelineViewGets an object that defines the settings of the scheduler’s TimelineView.
TimeZoneHelperProvides access to an object used for converting time between time zones.
UniqueIDGets the unique, hierarchically qualified identifier for the server control. Inherited from Control.
ValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control.
ViewNavigatorProvides access to the View Navigator’s properties.
ViewsContains the settings of the Views that are used to represent information within the ASPxScheduler control.
ViewState protectedGets 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 protectedGets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control.
ViewStateModeGets or sets the view-state mode of this control. Inherited from Control.
ViewVisibleIntervalProvides access to the View Visible Interval’s properties.
VisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. Inherited from Control.
WeekViewGets an object that defines the settings of the scheduler’s Week View.
WidthGets or sets the width of the web server control. Inherited from ASPxWebControl.
WorkDaysProvides access to the collection which identifies which days are assigned to a workweek.
WorkWeekViewGets an object that defines the settings of the scheduler’s Work-Week View.

See Also

ASPxScheduler Class

ASPxScheduler Members

DevExpress.Web.ASPxScheduler Namespace