Skip to main content

BootstrapScheduler Class

In This Article
Methods

Represents the client-side equivalent of the BootstrapScheduler control.

#Declaration

TypeScript
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

TypeScript
appointmentFormCancel(): void

#appointmentFormDelete Method

#Declaration

TypeScript
appointmentFormDelete(): void

#appointmentFormSave Method

#Declaration

TypeScript
appointmentFormSave(): void

#changeFormContainer(container) Method

#Declaration

TypeScript
changeFormContainer(
    container: any
): void

#Parameters

Name Type
container any

#changePopupMenuContainer(container) Method

#Declaration

TypeScript
changePopupMenuContainer(
    container: any
): void

#Parameters

Name Type
container any

#changeTimeZoneId(timeZoneId) Method

#Declaration

TypeScript
changeTimeZoneId(
    timeZoneId: string
): void

#Parameters

Name Type
timeZoneId string

#changeToolTipContainer(container) Method

#Declaration

TypeScript
changeToolTipContainer(
    container: any
): void

#Parameters

Name Type
container any

#deleteAppointment(apt) Method

#Declaration

TypeScript
deleteAppointment(
    apt: BootstrapSchedulerAppointment
): void

#Parameters

Name Type
apt BootstrapSchedulerAppointment

#deselectAppointmentById(aptId) Method

#Declaration

TypeScript
deselectAppointmentById(
    aptId: any
): void

#Parameters

Name Type
aptId any

#getActiveViewType Method

#Declaration

TypeScript
getActiveViewType(): BootstrapSchedulerViewType

#Returns

Type
BootstrapSchedulerViewType

#getAllDayAreaHeight Method

#Declaration

TypeScript
getAllDayAreaHeight(): number

#Returns

Type
number

#getAppointmentById(id) Method

#Declaration

TypeScript
getAppointmentById(
    id: any
): BootstrapSchedulerAppointment | null

#Parameters

Name Type
id any

#Returns

Type
BootstrapSchedulerAppointment
null

#getAppointmentProperties(aptId, propertyNames, onCallBack) Method

#Declaration

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

#Parameters

Name Type
aptId number
propertyNames string[]
onCallBack any

#Returns

Type
string[]

#getGroupType Method

#Declaration

TypeScript

#Returns

Type
BootstrapSchedulerGroupType

#getResourceNavigatorVisible Method

#Declaration

TypeScript
getResourceNavigatorVisible(): boolean

#Returns

Type
boolean

#getScrollAreaHeight Method

#Declaration

TypeScript
getScrollAreaHeight(): number

#Returns

Type
number

#getSelectedAppointmentIds Method

#Declaration

TypeScript
getSelectedAppointmentIds(): string[]

#Returns

Type
string[]

#getSelectedInterval Method

#Declaration

TypeScript
getSelectedInterval(): BootstrapTimeInterval | null

#Returns

Type
BootstrapTimeInterval
null

#getSelectedResource Method

#Declaration

TypeScript
getSelectedResource(): string

#Returns

Type
string

#getToolbarVisible Method

#Declaration

TypeScript
getToolbarVisible(): boolean

#Returns

Type
boolean

#getTopRowTime(viewType) Method

#Declaration

TypeScript
getTopRowTime(
    viewType: BootstrapSchedulerViewType
): number

#Parameters

Name Type
viewType BootstrapSchedulerViewType

#Returns

Type
number

#getVisibleAppointments Method

#Declaration

TypeScript
getVisibleAppointments(): BootstrapSchedulerAppointment[]

#Returns

Type
BootstrapSchedulerAppointment[]

#getVisibleIntervals Method

#Declaration

TypeScript
getVisibleIntervals(): BootstrapTimeInterval[]

#Returns

Type
BootstrapTimeInterval[]

#gotoDate(date) Method

#Declaration

TypeScript
gotoDate(
    date: Date
): void

#Parameters

Name Type
date Date

#goToDateFormApply Method

#Declaration

TypeScript
goToDateFormApply(): void

#goToDateFormCancel Method

#Declaration

TypeScript
goToDateFormCancel(): void

#gotoToday Method

#Declaration

TypeScript
gotoToday(): void

#hideLoadingPanel Method

#Declaration

TypeScript
hideLoadingPanel(): void

#inplaceEditFormCancel Method

#Declaration

TypeScript
inplaceEditFormCancel(): void

#inplaceEditFormSave Method

#Declaration

TypeScript
inplaceEditFormSave(): void

#inplaceEditFormShowMore Method

#Declaration

TypeScript
inplaceEditFormShowMore(): void

#insertAppointment(apt) Method

#Declaration

TypeScript
insertAppointment(
    apt: BootstrapSchedulerAppointment
): void

#Parameters

Name Type
apt BootstrapSchedulerAppointment

#navigateBackward Method

#Declaration

TypeScript
navigateBackward(): void

#navigateForward Method

#Declaration

TypeScript
navigateForward(): void

#off<K> Method

#Declaration

TypeScript
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

TypeScript
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

TypeScript
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

TypeScript
performCallback(
    parameter: string
): void

#Parameters

Name Type
parameter string

#refresh Method

#Declaration

TypeScript
refresh(): void

#refreshClientAppointmentProperties(clientAppointment, propertyNames, onCallBack) Method

#Declaration

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

#Parameters

Name Type
clientAppointment BootstrapSchedulerAppointment
propertyNames string[]
onCallBack any

#reminderFormCancel Method

#Declaration

TypeScript
reminderFormCancel(): void

#reminderFormDismiss Method

#Declaration

TypeScript
reminderFormDismiss(): void

#reminderFormDismissAll Method

#Declaration

TypeScript
reminderFormDismissAll(): void

#reminderFormSnooze Method

#Declaration

TypeScript
reminderFormSnooze(): void

#selectAppointmentById(aptId) Method

#Declaration

TypeScript
selectAppointmentById(
    aptId: any
): void

#Parameters

Name Type
aptId any

#selectAppointmentById(aptId, scrollToSelection) Method

#Declaration

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

#Parameters

Name Type
aptId any
scrollToSelection boolean

#setActiveViewType(value) Method

#Declaration

TypeScript
setActiveViewType(
    value: BootstrapSchedulerViewType
): void

#Parameters

Name Type
value BootstrapSchedulerViewType

#setAllDayAreaHeight(height) Method

#Declaration

TypeScript
setAllDayAreaHeight(
    height: number
): void

#Parameters

Name Type
height number

#setGroupType(value) Method

#Declaration

TypeScript
setGroupType(
    value: BootstrapSchedulerGroupType
): void

#Parameters

Name Type
value BootstrapSchedulerGroupType

#setHeight(height) Method

#Declaration

TypeScript
setHeight(
    height: number
): void

#Parameters

Name Type
height number

#setResourceNavigatorVisible(visible) Method

#Declaration

TypeScript
setResourceNavigatorVisible(
    visible: boolean
): void

#Parameters

Name Type
visible boolean

#setSelection(interval) Method

#Declaration

TypeScript
setSelection(
    interval: BootstrapTimeInterval
): void

#Parameters

Name Type
interval BootstrapTimeInterval

#setSelection(interval, resourceId) Method

#Declaration

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

#Parameters

Name Type
interval BootstrapTimeInterval
resourceId string

#setSelection(interval, resourceId, scrollToSelection) Method

#Declaration

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

#Parameters

Name Type
interval BootstrapTimeInterval
resourceId string
scrollToSelection boolean

#setToolbarVisible(visible) Method

#Declaration

TypeScript
setToolbarVisible(
    visible: boolean
): void

#Parameters

Name Type
visible boolean

#setTopRowTime(duration) Method

#Declaration

TypeScript
setTopRowTime(
    duration: number
): void

#Parameters

Name Type
duration number

#setTopRowTime(duration, viewType) Method

#Declaration

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

#Parameters

Name Type
duration number
viewType BootstrapSchedulerViewType

#setVisibleResources(resourceIds) Method

#Declaration

TypeScript
setVisibleResources(
    resourceIds: string[]
): void

#Parameters

Name Type
resourceIds string[]

#showAppointmentFormByClientId(aptClientId) Method

#Declaration

TypeScript
showAppointmentFormByClientId(
    aptClientId: string
): void

#Parameters

Name Type
aptClientId string

#showAppointmentFormByServerId(aptServerId) Method

#Declaration

TypeScript
showAppointmentFormByServerId(
    aptServerId: string
): void

#Parameters

Name Type
aptServerId string

#showInplaceEditor(start, end) Method

#Declaration

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

#Parameters

Name Type
start Date
end Date

#showInplaceEditor(start, end, resourceId) Method

#Declaration

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

#Parameters

Name Type
start Date
end Date
resourceId String

#showLoadingPanel Method

#Declaration

TypeScript
showLoadingPanel(): void

#showSelectionToolTip(x, y) Method

#Declaration

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

#Parameters

Name Type
x number
y number

#updateAppointment(apt) Method

#Declaration

TypeScript
updateAppointment(
    apt: BootstrapSchedulerAppointment
): void

#Parameters

Name Type
apt BootstrapSchedulerAppointment