The requested page is not available for the requested platform. You are viewing the content for Default platform.

BootstrapScheduler Class

Represents the client-side equivalent of the BootstrapScheduler control.

Declaration

export 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 Method

Declaration

changeFormContainer(container: any): void

Parameters

Name Type Description
container

changePopupMenuContainer Method

Declaration

changePopupMenuContainer(container: any): void

Parameters

Name Type Description
container

changeTimeZoneId Method

Declaration

changeTimeZoneId(timeZoneId: string): void

Parameters

Name Type Description
timeZoneId

changeToolTipContainer Method

Declaration

changeToolTipContainer(container: any): void

Parameters

Name Type Description
container

deleteAppointment Method

Declaration

deleteAppointment(apt: BootstrapSchedulerAppointment): void

Parameters

Name Type Description
apt

deselectAppointmentById Method

Declaration

deselectAppointmentById(aptId: any): void

Parameters

Name Type Description
aptId

getActiveViewType Method

Declaration

getActiveViewType(): BootstrapSchedulerViewType

Returns

Type Description
BootstrapSchedulerViewType

getAllDayAreaHeight Method

Declaration

getAllDayAreaHeight(): number

Returns

Type Description
number

getAppointmentById Method

Declaration

getAppointmentById(id: any): BootstrapSchedulerAppointment | null

Parameters

Name Type Description
id

Returns

Type Description
BootstrapSchedulerAppointment
null

getAppointmentProperties Method

Declaration

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

Parameters

Name Type Description
aptId
propertyNames
onCallBack

Returns

Type Description
array[string]

getGroupType Method

Declaration

getGroupType(): BootstrapSchedulerGroupType

Returns

Type Description
BootstrapSchedulerGroupType

getResourceNavigatorVisible Method

Declaration

getResourceNavigatorVisible(): boolean

Returns

Type Description
boolean

getScrollAreaHeight Method

Declaration

getScrollAreaHeight(): number

Returns

Type Description
number

getSelectedAppointmentIds Method

Declaration

getSelectedAppointmentIds(): array[string]

Returns

Type Description
array[string]

getSelectedInterval Method

Declaration

getSelectedInterval(): BootstrapTimeInterval | null

Returns

Type Description
BootstrapTimeInterval
null

getSelectedResource Method

Declaration

getSelectedResource(): string

Returns

Type Description
string

getToolbarVisible Method

Declaration

getToolbarVisible(): boolean

Returns

Type Description
boolean

getTopRowTime Method

Declaration

getTopRowTime(viewType: BootstrapSchedulerViewType): number

Parameters

Name Type Description
viewType

Returns

Type Description
number

getVisibleAppointments Method

Declaration

getVisibleAppointments(): array[BootstrapSchedulerAppointment]

Returns

Type Description
array[BootstrapSchedulerAppointment]

getVisibleIntervals Method

Declaration

getVisibleIntervals(): array[BootstrapTimeInterval]

Returns

Type Description
array[BootstrapTimeInterval]

goToDateFormApply Method

Declaration

goToDateFormApply(): void

goToDateFormCancel Method

Declaration

goToDateFormCancel(): void

gotoDate Method

Declaration

gotoDate(date: Date): void

Parameters

Name Type Description
date

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 Method

Declaration

insertAppointment(apt: BootstrapSchedulerAppointment): void

Parameters

Name Type Description
apt

navigateBackward Method

navigateBackward(): void

navigateForward Method

navigateForward(): void

off Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

on Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

once Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

performCallback Method

Declaration

performCallback(parameter: string): void

Parameters

Name Type Description
parameter

refresh Method

Declaration

refresh(): void

refreshClientAppointmentProperties Method

Declaration

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

Parameters

Name Type Description
clientAppointment
propertyNames
onCallBack

reminderFormCancel Method

Declaration

reminderFormCancel(): void

reminderFormDismiss Method

Declaration

reminderFormDismiss(): void

reminderFormDismissAll Method

Declaration

reminderFormDismissAll(): void

reminderFormSnooze Method

Declaration

reminderFormSnooze(): void

selectAppointmentById Method

Declaration

selectAppointmentById(aptId: any): void

Parameters

Name Type Description
aptId

setActiveViewType Method

Declaration

setActiveViewType(value: BootstrapSchedulerViewType): void

Parameters

Name Type Description
value

setAllDayAreaHeight Method

Declaration

setAllDayAreaHeight(height: number): void

Parameters

Name Type Description
height

setGroupType Method

Declaration

setGroupType(value: BootstrapSchedulerGroupType): void

Parameters

Name Type Description
value

setHeight Method

Declaration

setHeight(height: number): void

Parameters

Name Type Description
height

setResourceNavigatorVisible Method

Declaration

setResourceNavigatorVisible(visible: boolean): void

Parameters

Name Type Description
visible

setSelection Method

Declaration

setSelection(interval: BootstrapTimeInterval): void

Parameters

Name Type Description
interval

setToolbarVisible Method

Declaration

setToolbarVisible(visible: boolean): void

Parameters

Name Type Description
visible

setTopRowTime Method

Declaration

setTopRowTime(duration: number): void

Parameters

Name Type Description
duration

setVisibleResources Method

Declaration

setVisibleResources(resourceIds: array[string]): void

Parameters

Name Type Description
resourceIds

showAppointmentFormByClientId Method

Declaration

showAppointmentFormByClientId(aptClientId: string): void

Parameters

Name Type Description
aptClientId

showAppointmentFormByServerId Method

Declaration

showAppointmentFormByServerId(aptServerId: string): void

Parameters

Name Type Description
aptServerId

showInplaceEditor Method

Declaration

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

Parameters

Name Type Description
start
end

showLoadingPanel Method

Declaration

showLoadingPanel(): void

showSelectionToolTip Method

Declaration

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

Parameters

Name Type Description
x
y

updateAppointment Method

Declaration

updateAppointment(apt: BootstrapSchedulerAppointment): void

Parameters

Name Type Description
apt