Skip to main content

BootstrapProgressBar Class

#Declaration

TypeScript
class BootstrapProgressBar 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
BootstrapProgressBar

#Methods

#getCaption Method

#Declaration

TypeScript
getCaption(): string

#Returns

Type
string

#getDisplayText Method

#Declaration

TypeScript
getDisplayText(): string

#Returns

Type
string

#getEnabled Method

#Declaration

TypeScript
getEnabled(): boolean

#Returns

Type
boolean

#getMaximum Method

#Declaration

TypeScript
getMaximum(): number

#Returns

Type
number

#getMinimum Method

#Declaration

TypeScript
getMinimum(): number

#Returns

Type
number

#getPercent Method

#Declaration

TypeScript
getPercent(): number

#Returns

Type
number

#getPosition Method

#Declaration

TypeScript
getPosition(): number

#Returns

Type
number

#getValue Method

#Declaration

TypeScript
getValue(): any

#Returns

Type
any

#off<K> Method

#Declaration

TypeScript
off<K extends keyof BootstrapProgressBarEventMap>(
    eventName?: K,
    callback?: (this: BootstrapProgressBar,
    args?: BootstrapProgressBarEventMap[K]) => void
): this

#Parameters

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

#Type Parameters

Name Type
K keyof

#Returns

Type
this

#on<K>(eventName, callback) Method

#Declaration

TypeScript
on<K extends keyof BootstrapProgressBarEventMap>(
    eventName: K,
    callback: (this: BootstrapProgressBar,
    args?: BootstrapProgressBarEventMap[K]) => void
): this

#Parameters

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

#Type Parameters

Name Type
K keyof

#Returns

Type
this

#once<K>(eventName, callback) Method

#Declaration

TypeScript
once<K extends keyof BootstrapProgressBarEventMap>(
    eventName: K,
    callback: (this: BootstrapProgressBar,
    args?: BootstrapProgressBarEventMap[K]) => void
): this

#Parameters

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

#Type Parameters

Name Type
K keyof

#Returns

Type
this

#setCaption(caption) Method

#Declaration

TypeScript
setCaption(
    caption: string
): void

#Parameters

Name Type
caption string

#setCustomDisplayFormat(text) Method

#Declaration

TypeScript
setCustomDisplayFormat(
    text: string
): void

#Parameters

Name Type
text string

#setEnabled(value) Method

#Declaration

TypeScript
setEnabled(
    value: boolean
): void

#Parameters

Name Type
value boolean

#setMaximum(max) Method

#Declaration

TypeScript
setMaximum(
    max: number
): void

#Parameters

Name Type
max number

#setMinimum(min) Method

#Declaration

TypeScript
setMinimum(
    min: number
): void

#Parameters

Name Type
min number

#setMinMaxValues(minValue, maxValue) Method

#Declaration

TypeScript
setMinMaxValues(
    minValue: number,
    maxValue: number
): void

#Parameters

Name Type
minValue number
maxValue number

#setPosition(position) Method

#Declaration

TypeScript
setPosition(
    position: number
): void

#Parameters

Name Type
position number

#setValue(value) Method

#Declaration

TypeScript
setValue(
    value: any
): void

#Parameters

Name Type
value any