BootstrapButton Class

Declaration

class BootstrapButton 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.

Inheritance

Control
BootstrapButton

Methods

doClick Method

Simulates a mouse click action on the button control.

Declaration

doClick(): void

focus Method

Sets input focus to the button.

Declaration

focus(): void

getBadgeIconCssClass Method

Declaration

getBadgeIconCssClass(): string

Returns

Type
string

getBadgeText Method

Declaration

getBadgeText(): string

Returns

Type
string

getChecked Method

Returns a value indicating whether the button is checked.

Declaration

getChecked(): boolean

Returns

Type
boolean

getEnabled Method

Returns a value indicating whether the button is enabled.

Declaration

getEnabled(): boolean

Returns

Type
boolean

getImageUrl Method

Declaration

getImageUrl(): string

Returns

Type
string

getText Method

Returns the text displayed within the button.

Declaration

getText(): string

Returns

Type
string

off<K> Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

on<K>(eventName, callback) Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

once<K>(eventName, callback) Method

Declaration

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

Parameters

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

Type Parameters

Name Type
K keyof

Returns

Type
this

setBadgeIconCssClass(cssClass) Method

Declaration

setBadgeIconCssClass(cssClass: string): void

Parameters

Name Type
cssClass string

setBadgeText(text) Method

Declaration

setBadgeText(text: string): void

Parameters

Name Type
text string

setChecked(value) Method

Sets a value that specifies the button's checked status.

Declaration

setChecked(value: boolean): void

Parameters

Name Type
value boolean

setEnabled(value) Method

Sets a value specifying whether the button is enabled.

Declaration

setEnabled(value: boolean): void

Parameters

Name Type
value boolean

setImageUrl(value) Method

Declaration

setImageUrl(value: string): void

Parameters

Name Type
value string

setText(value) Method

Sets the text to be displayed within the button.

Declaration

setText(value: string): void

Parameters

Name Type
value string