BootstrapScheduler Class

Represents the client-side equivalent of the BootstrapScheduler control.

Declaration

class BootstrapScheduler extends Control

Remarks

IMPORTANT

Bootstrap Controls for ASP.NET Core are in maintenance mode. We don’t add new controls or develop new functionality for this product line. Our recommendation is to use the ASP.NET Core Controls suite.

NOTE

See Online Demos: Refer to the https://demos.devexpress.com/aspnetcore-bootstrap/Scheduler-ClientSideAPI online demo for detailed information on the Scheduler control's client-side API.

Inheritance

Control
BootstrapScheduler

Methods

appointmentFormCancel Method

Declaration

appointmentFormCancel(): void

appointmentFormDelete Method

Declaration

appointmentFormDelete(): void

appointmentFormSave Method

Declaration

appointmentFormSave(): void

changeFormContainer(container) Method

Declaration

changeFormContainer(container: any): void

Parameters

Name Type
container any

changePopupMenuContainer(container) Method

Declaration

changePopupMenuContainer(container: any): void

Parameters

Name Type
container any

changeTimeZoneId(timeZoneId) Method

Declaration

changeTimeZoneId(timeZoneId: string): void

Parameters

Name Type
timeZoneId string

changeToolTipContainer(container) Method

Declaration

changeToolTipContainer(container: any): void

Parameters

Name Type
container any

deleteAppointment(apt) Method

Declaration

deleteAppointment(apt: BootstrapSchedulerAppointment): void

Parameters

Name Type
apt BootstrapSchedulerAppointment

deselectAppointmentById(aptId) Method

Declaration

deselectAppointmentById(aptId: any): void

Parameters

Name Type
aptId any

getActiveViewType Method

Declaration

getActiveViewType(): BootstrapSchedulerViewType

Returns

Type
BootstrapSchedulerViewType

getAllDayAreaHeight Method

Declaration

getAllDayAreaHeight(): number

Returns

Type
number

getAppointmentById(id) Method

Declaration

getAppointmentById(id: any): BootstrapSchedulerAppointment | null

Parameters

Name Type
id any

Returns

Type
BootstrapSchedulerAppointment
null

getAppointmentProperties(aptId, propertyNames, onCallBack) Method

Declaration

getAppointmentProperties(aptId: number, propertyNames: string[], onCallBack: any): string[]

Parameters

Name Type
aptId number
propertyNames string[]
onCallBack any

Returns

Type
string[]

getGroupType Method

Declaration

getGroupType(): BootstrapSchedulerGroupType

Returns

Type
BootstrapSchedulerGroupType

getResourceNavigatorVisible Method

Declaration

getResourceNavigatorVisible(): boolean

Returns

Type
boolean

getScrollAreaHeight Method

Declaration

getScrollAreaHeight(): number

Returns

Type
number

getSelectedAppointmentIds Method

Declaration

getSelectedAppointmentIds(): string[]

Returns

Type
string[]

getSelectedInterval Method

Declaration

getSelectedInterval(): BootstrapTimeInterval | null

Returns

Type
BootstrapTimeInterval
null

getSelectedResource Method

Declaration

getSelectedResource(): string

Returns

Type
string

getToolbarVisible Method

Declaration

getToolbarVisible(): boolean

Returns

Type
boolean

getTopRowTime(viewType) Method

Declaration

getTopRowTime(viewType: BootstrapSchedulerViewType): number

Parameters

Name Type
viewType BootstrapSchedulerViewType

Returns

Type
number

getVisibleAppointments Method

Declaration

getVisibleAppointments(): BootstrapSchedulerAppointment[]

Returns

Type
BootstrapSchedulerAppointment[]

getVisibleIntervals Method

Declaration

getVisibleIntervals(): BootstrapTimeInterval[]

Returns

Type
BootstrapTimeInterval[]

gotoDate(date) Method

Declaration

gotoDate(date: Date): void

Parameters

Name Type
date Date

goToDateFormApply Method

Declaration

goToDateFormApply(): void

goToDateFormCancel Method

Declaration

goToDateFormCancel(): void

gotoToday Method

Declaration

gotoToday(): void

hideLoadingPanel Method

Declaration

hideLoadingPanel(): void

inplaceEditFormCancel Method

Declaration

inplaceEditFormCancel(): void

inplaceEditFormSave Method

Declaration

inplaceEditFormSave(): void

inplaceEditFormShowMore Method

Declaration

inplaceEditFormShowMore(): void

insertAppointment(apt) Method

Declaration

insertAppointment(apt: BootstrapSchedulerAppointment): void

Parameters

Name Type
apt BootstrapSchedulerAppointment

navigateBackward Method

Declaration

navigateBackward(): void

navigateForward Method

Declaration

navigateForward(): void

off<K> Method

Declaration

off<K extends keyof BootstrapSchedulerEventMap>(eventName?: K, callback?: (this: BootstrapScheduler, args?: BootstrapSchedulerEventMap[K]) => void): this

Parameters

Name Type
eventName K
callback (this: BootstrapScheduler, args?: BootstrapSchedulerEventMap[K]) => void

Type Parameters

Name Type
K keyof

Returns

Type
this

on<K>(eventName, callback) Method

Declaration

on<K extends keyof BootstrapSchedulerEventMap>(eventName: K, callback: (this: BootstrapScheduler, args?: BootstrapSchedulerEventMap[K]) => void): this

Parameters

Name Type
eventName K
callback (this: BootstrapScheduler, args?: BootstrapSchedulerEventMap[K]) => void

Type Parameters

Name Type
K keyof

Returns

Type
this

once<K>(eventName, callback) Method

Declaration

once<K extends keyof BootstrapSchedulerEventMap>(eventName: K, callback: (this: BootstrapScheduler, args?: BootstrapSchedulerEventMap[K]) => void): this

Parameters

Name Type
eventName K
callback (this: BootstrapScheduler, args?: BootstrapSchedulerEventMap[K]) => void

Type Parameters

Name Type
K keyof

Returns

Type
this

performCallback(parameter) Method

Declaration

performCallback(parameter: string): void

Parameters

Name Type
parameter string

refresh Method

Declaration

refresh(): void

refreshClientAppointmentProperties(clientAppointment, propertyNames, onCallBack) Method

Declaration

refreshClientAppointmentProperties(clientAppointment: BootstrapSchedulerAppointment, propertyNames: string[], onCallBack: any): void

Parameters

Name Type
clientAppointment BootstrapSchedulerAppointment
propertyNames string[]
onCallBack any

reminderFormCancel Method

Declaration

reminderFormCancel(): void

reminderFormDismiss Method

Declaration

reminderFormDismiss(): void

reminderFormDismissAll Method

Declaration

reminderFormDismissAll(): void

reminderFormSnooze Method

Declaration

reminderFormSnooze(): void

selectAppointmentById(aptId) Method

Declaration

selectAppointmentById(aptId: any): void

Parameters

Name Type
aptId any

selectAppointmentById(aptId, scrollToSelection) Method

Declaration

selectAppointmentById(aptId: any, scrollToSelection: boolean): void

Parameters

Name Type
aptId any
scrollToSelection boolean

setActiveViewType(value) Method

Declaration

setActiveViewType(value: BootstrapSchedulerViewType): void

Parameters

Name Type
value BootstrapSchedulerViewType

setAllDayAreaHeight(height) Method

Declaration

setAllDayAreaHeight(height: number): void

Parameters

Name Type
height number

setGroupType(value) Method

Declaration

setGroupType(value: BootstrapSchedulerGroupType): void

Parameters

Name Type
value BootstrapSchedulerGroupType

setHeight(height) Method

Declaration

setHeight(height: number): void

Parameters

Name Type
height number

setResourceNavigatorVisible(visible) Method

Declaration

setResourceNavigatorVisible(visible: boolean): void

Parameters

Name Type
visible boolean

setSelection(interval) Method

Declaration

setSelection(interval: BootstrapTimeInterval): void

Parameters

Name Type
interval BootstrapTimeInterval

setSelection(interval, resourceId) Method

Declaration

setSelection(interval: BootstrapTimeInterval, resourceId: string): void

Parameters

Name Type
interval BootstrapTimeInterval
resourceId string

setSelection(interval, resourceId, scrollToSelection) Method

Declaration

setSelection(interval: BootstrapTimeInterval, resourceId: string, scrollToSelection: boolean): void

Parameters

Name Type
interval BootstrapTimeInterval
resourceId string
scrollToSelection boolean

setToolbarVisible(visible) Method

Declaration

setToolbarVisible(visible: boolean): void

Parameters

Name Type
visible boolean

setTopRowTime(duration) Method

Declaration

setTopRowTime(duration: number): void

Parameters

Name Type
duration number

setTopRowTime(duration, viewType) Method

Declaration

setTopRowTime(duration: number, viewType: BootstrapSchedulerViewType): void

Parameters

Name Type
duration number
viewType BootstrapSchedulerViewType

setVisibleResources(resourceIds) Method

Declaration

setVisibleResources(resourceIds: string[]): void

Parameters

Name Type
resourceIds string[]

showAppointmentFormByClientId(aptClientId) Method

Declaration

showAppointmentFormByClientId(aptClientId: string): void

Parameters

Name Type
aptClientId string

showAppointmentFormByServerId(aptServerId) Method

Declaration

showAppointmentFormByServerId(aptServerId: string): void

Parameters

Name Type
aptServerId string

showInplaceEditor(start, end) Method

Declaration

showInplaceEditor(start: Date, end: Date): void

Parameters

Name Type
start Date
end Date

showInplaceEditor(start, end, resourceId) Method

Declaration

showInplaceEditor(start: Date, end: Date, resourceId: String): void

Parameters

Name Type
start Date
end Date
resourceId String

showLoadingPanel Method

Declaration

showLoadingPanel(): void

showSelectionToolTip(x, y) Method

Declaration

showSelectionToolTip(x: number, y: number): void

Parameters

Name Type
x number
y number

updateAppointment(apt) Method

Declaration

updateAppointment(apt: BootstrapSchedulerAppointment): void

Parameters

Name Type
apt BootstrapSchedulerAppointment