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

BootstrapCalendar Class

Declaration

export class BootstrapCalendar extends BootstrapClientEdit

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.

Inheritance

BootstrapClientEdit
BootstrapCalendar

Methods

clearSelection Method

Deselects all the selected dates within the calendar.

Declaration

clearSelection(): void

deselectDate Method

Deselects the specified date within the calendar.

Declaration

deselectDate(date: Date): void

Parameters

Name Type Description
date

deselectRange Method

Deselects the specified range of dates within the calendar.

Declaration

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

Parameters

Name Type Description
start
end

getEnabled Method

Declaration

getEnabled(): boolean

Returns

Type Description
boolean

getMaxDate Method

Gets the maximum date on the calendar.

Declaration

getMaxDate(): Date

Returns

Type Description
Date

getMinDate Method

Gets the minimum date on the calendar.

Declaration

getMinDate(): Date

Returns

Type Description
Date

getSelectedDate Method

Returns the calendar's selected date.

Declaration

getSelectedDate(): Date

Returns

Type Description
Date

getSelectedDates Method

Returns a list of dates which are selected within the calendar.

Declaration

getSelectedDates(): array[Date]

Returns

Type Description
array[Date]

getVisibleDate Method

Gets the date that determines the month and year that are currently displayed in the calendar.

Declaration

getVisibleDate(): Date

Returns

Type Description
Date

isDateSelected Method

Tests whether the specified date is selected.

Declaration

isDateSelected(date: Date): boolean

Parameters

Name Type Description
date

Returns

Type Description
boolean

off Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

on Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

once Method

Declaration

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

Parameters

Name Type Description
eventName
callback

Returns

Type Description
this

selectDate Method

Selects the specified date within the calendar.

Declaration

selectDate(date: Date): void

Parameters

Name Type Description
date

selectRange Method

Selects the specified range of dates within the calendar.

Declaration

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

Parameters

Name Type Description
start
end

setEnabled Method

Declaration

setEnabled(enabled: boolean): void

Parameters

Name Type Description
enabled

setMaxDate Method

Sets the maximum date of the calendar.

Declaration

setMaxDate(date: Date): void

Parameters

Name Type Description
date

setMinDate Method

Sets the minimum date of the calendar.

Declaration

setMinDate(date: Date): void

Parameters

Name Type Description
date

setSelectedDate Method

Sets the calendar's selected date.

Declaration

setSelectedDate(date: Date): void

Parameters

Name Type Description
date

setVisibleDate Method

Sets the date that specifies the month and year to be displayed in the calendar.

Declaration

setVisibleDate(date: Date): void

Parameters

Name Type Description
date