BootstrapButton Class

Declaration

export class BootstrapButton extends Control

Inheritance

Control
BootstrapButton

Properties

name Property

Declaration

readonly name: string

Property Value

Type Description
string

Methods

adjustControl Method

Declaration

adjustControl(): void

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 Description
string

getBadgeText Method

Declaration

getBadgeText(): string

Returns

Type Description
string

getChecked Method

Returns a value indicating whether the button is checked.

Declaration

getChecked(): boolean

Returns

Type Description
boolean

getEnabled Method

Returns a value indicating whether the button is enabled.

Declaration

getEnabled(): boolean

Returns

Type Description
boolean

getHeight Method

Declaration

getHeight(): number

Returns

Type Description
number

getImageUrl Method

Declaration

getImageUrl(): string

Returns

Type Description
string

getMainElement Method

Declaration

getMainElement(): any

Returns

Type Description
any

getParentControl Method

Declaration

getParentControl(): any

Returns

Type Description
any

getText Method

Returns the text displayed within the button.

Declaration

getText(): string

Returns

Type Description
string

getVisible Method

Declaration

getVisible(): boolean

Returns

Type Description
boolean

getWidth Method

Declaration

getWidth(): number

Returns

Type Description
number

inCallback Method

Declaration

inCallback(): boolean

Returns

Type Description
boolean

off Method

Declaration

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

Parameters

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

Returns

Type Description
this

on Method

Declaration

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

Parameters

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

Returns

Type Description
this

once Method

Declaration

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

Parameters

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

Returns

Type Description
this

sendMessageToAssistiveTechnology Method

Declaration

sendMessageToAssistiveTechnology(message: string): void

Parameters

Type Name Description
string message

setBadgeIconCssClass Method

Declaration

setBadgeIconCssClass(cssClass: string): void

Parameters

Type Name Description
string cssClass

setBadgeText Method

Declaration

setBadgeText(text: string): void

Parameters

Type Name Description
string text

setChecked Method

Declaration

setChecked(value: boolean): void

Parameters

Type Name Description
boolean value

setEnabled Method

Declaration

setEnabled(value: boolean): void

Parameters

Type Name Description
boolean value

setHeight Method

Declaration

setHeight(height: number): void

Parameters

Type Name Description
number height

setImageUrl Method

Declaration

setImageUrl(value: string): void

Parameters

Type Name Description
string value

setText Method

Declaration

setText(value: string): void

Parameters

Type Name Description
string value

setVisible Method

Declaration

setVisible(visible: boolean): void

Parameters

Type Name Description
boolean visible

setWidth Method

Declaration

setWidth(width: number): void

Parameters

Type Name Description
number width