Skip to main content

BootstrapPopupControl Class

In This Article
Methods

#Declaration

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

#Methods

#adjustSize Method

#Declaration

TypeScript
adjustSize(): void

#bringToFront Method

#Declaration

TypeScript
bringToFront(): void

#bringWindowToFront(window) Method

#Declaration

TypeScript
bringWindowToFront(
    window: BootstrapPopupWindow
): void

#Parameters

Name Type
window BootstrapPopupWindow

#getCollapsed Method

#Declaration

TypeScript
getCollapsed(): boolean

#Returns

Type
boolean

#getContentHeight Method

#Declaration

TypeScript
getContentHeight(): number

#Returns

Type
number

#getContentHtml Method

#Declaration

TypeScript
getContentHtml(): string

#Returns

Type
string

#getContentIFrame Method

#Declaration

TypeScript
getContentIFrame(): any

#Returns

Type
any

#getContentIFrameWindow Method

#Declaration

TypeScript
getContentIFrameWindow(): any

#Returns

Type
any

#getContentUrl Method

#Declaration

TypeScript
getContentUrl(): string

#Returns

Type
string

#getContentWidth Method

#Declaration

TypeScript
getContentWidth(): number

#Returns

Type
number

#getCurrentPopupElement Method

#Declaration

TypeScript
getCurrentPopupElement(): any

#Returns

Type
any

#getCurrentPopupElementIndex Method

#Declaration

TypeScript
getCurrentPopupElementIndex(): number

#Returns

Type
number

#getFooterImageUrl Method

#Declaration

TypeScript
getFooterImageUrl(): string

#Returns

Type
string

#getFooterNavigateUrl Method

#Declaration

TypeScript
getFooterNavigateUrl(): string

#Returns

Type
string

#getFooterText Method

#Declaration

TypeScript
getFooterText(): string

#Returns

Type
string

#getHeaderImageUrl Method

#Declaration

TypeScript
getHeaderImageUrl(): string

#Returns

Type
string

#getHeaderNavigateUrl Method

#Declaration

TypeScript
getHeaderNavigateUrl(): string

#Returns

Type
string

#getHeaderText Method

#Declaration

TypeScript
getHeaderText(): string

#Returns

Type
string

#getMainElement Method

#Declaration

TypeScript
getMainElement(): any

#Returns

Type
any

#getMaximized Method

#Declaration

TypeScript
getMaximized(): boolean

#Returns

Type
boolean

#getPinned Method

#Declaration

TypeScript
getPinned(): boolean

#Returns

Type
boolean

#getPopUpReasonMouseEvent Method

#Declaration

TypeScript
getPopUpReasonMouseEvent(): any

#Returns

Type
any

#getWindow(index) Method

#Declaration

TypeScript
getWindow(
    index: number
): BootstrapPopupWindow | null

#Parameters

Name Type
index number

#Returns

Type
BootstrapPopupWindow
null

#getWindowByName(name) Method

#Declaration

TypeScript
getWindowByName(
    name: string
): BootstrapPopupWindow | null

#Parameters

Name Type
name string

#Returns

Type
BootstrapPopupWindow
null

#getWindowCollapsed(window) Method

#Declaration

TypeScript
getWindowCollapsed(
    window: BootstrapPopupWindow
): boolean

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
boolean

#getWindowContentHeight(window) Method

#Declaration

TypeScript
getWindowContentHeight(
    window: BootstrapPopupWindow
): number

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
number

#getWindowContentHtml(window) Method

#Declaration

TypeScript
getWindowContentHtml(
    window: BootstrapPopupWindow
): string

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
string

#getWindowContentIFrame(window) Method

#Declaration

TypeScript
getWindowContentIFrame(
    window: BootstrapPopupWindow
): any

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
any

#getWindowContentUrl(window) Method

#Declaration

TypeScript
getWindowContentUrl(
    window: BootstrapPopupWindow
): string

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
string

#getWindowContentWidth(window) Method

#Declaration

TypeScript
getWindowContentWidth(
    window: BootstrapPopupWindow
): number

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
number

#getWindowCount Method

#Declaration

TypeScript
getWindowCount(): number

#Returns

Type
number

#getWindowCurrentPopupElement(window) Method

#Declaration

TypeScript
getWindowCurrentPopupElement(
    window: BootstrapPopupWindow
): any

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
any

#getWindowCurrentPopupElementIndex(window) Method

#Declaration

TypeScript
getWindowCurrentPopupElementIndex(
    window: BootstrapPopupWindow
): number

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
number

#getWindowHeight(window) Method

#Declaration

TypeScript
getWindowHeight(
    window: BootstrapPopupWindow
): number

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
number

#getWindowMaximized(window) Method

#Declaration

TypeScript
getWindowMaximized(
    window: BootstrapPopupWindow
): boolean

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
boolean

#getWindowPinned(window) Method

#Declaration

TypeScript
getWindowPinned(
    window: BootstrapPopupWindow
): boolean

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
boolean

#getWindowPopUpReasonMouseEvent(window) Method

#Declaration

TypeScript
getWindowPopUpReasonMouseEvent(
    window: BootstrapPopupWindow
): any

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
any

#getWindowWidth(window) Method

#Declaration

TypeScript
getWindowWidth(
    window: BootstrapPopupWindow
): number

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
number

#hide Method

#Declaration

TypeScript
hide(): void

#hideWindow(window) Method

#Declaration

TypeScript
hideWindow(
    window: BootstrapPopupWindow
): void

#Parameters

Name Type
window BootstrapPopupWindow

#isVisible Method

#Declaration

TypeScript
isVisible(): boolean

#Returns

Type
boolean

#isWindowVisible(window) Method

#Declaration

TypeScript
isWindowVisible(
    window: BootstrapPopupWindow
): boolean

#Parameters

Name Type
window BootstrapPopupWindow

#Returns

Type
boolean

#off<K> Method

#Declaration

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

#Parameters

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

#Type Parameters

Name Type
K keyof

#Returns

Type
this

#on<K>(eventName, callback) Method

#Declaration

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

#Parameters

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

#Type Parameters

Name Type
K keyof

#Returns

Type
this

#once<K>(eventName, callback) Method

#Declaration

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

#Parameters

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

#Type Parameters

Name Type
K keyof

#Returns

Type
this

#performCallback(data) Method

#Declaration

TypeScript
performCallback(
    data: any
): Promise<void>

#Parameters

Name Type
data any

#Returns

Type
Promise<void>

#performCallback(data, onSuccess) Method

#Declaration

TypeScript
performCallback(
    data: any,
    onSuccess: () => void
): void

#Parameters

Name Type
data any
onSuccess () => void

#refreshContentUrl Method

#Declaration

TypeScript
refreshContentUrl(): void

#refreshPopupElementConnection Method

#Declaration

TypeScript
refreshPopupElementConnection(): void

#refreshWindowContentUrl(window) Method

#Declaration

TypeScript
refreshWindowContentUrl(
    window: BootstrapPopupWindow
): void

#Parameters

Name Type
window BootstrapPopupWindow

#setAdaptiveMaxHeight(maxHeight) Method

#Declaration

TypeScript
setAdaptiveMaxHeight(
    maxHeight: number
): void

#Parameters

Name Type
maxHeight number

#setAdaptiveMaxWidth(maxWidth) Method

#Declaration

TypeScript
setAdaptiveMaxWidth(
    maxWidth: number
): void

#Parameters

Name Type
maxWidth number

#setAdaptiveMinHeight(minHeight) Method

#Declaration

TypeScript
setAdaptiveMinHeight(
    minHeight: number
): void

#Parameters

Name Type
minHeight number

#setAdaptiveMinWidth(minWidth) Method

#Declaration

TypeScript
setAdaptiveMinWidth(
    minWidth: number
): void

#Parameters

Name Type
minWidth number

#setCollapsed(value) Method

#Declaration

TypeScript
setCollapsed(
    value: boolean
): void

#Parameters

Name Type
value boolean

#setContentHtml(html) Method

#Declaration

TypeScript
setContentHtml(
    html: string
): void

#Parameters

Name Type
html string

#setContentUrl(url) Method

#Declaration

TypeScript
setContentUrl(
    url: string
): void

#Parameters

Name Type
url string

#setFooterImageUrl(value) Method

#Declaration

TypeScript
setFooterImageUrl(
    value: string
): void

#Parameters

Name Type
value string

#setFooterNavigateUrl(value) Method

#Declaration

TypeScript
setFooterNavigateUrl(
    value: string
): void

#Parameters

Name Type
value string

#setFooterText(value) Method

#Declaration

TypeScript
setFooterText(
    value: string
): void

#Parameters

Name Type
value string

#setHeaderImageUrl(value) Method

#Declaration

TypeScript
setHeaderImageUrl(
    value: string
): void

#Parameters

Name Type
value string

#setHeaderNavigateUrl(value) Method

#Declaration

TypeScript
setHeaderNavigateUrl(
    value: string
): void

#Parameters

Name Type
value string

#setHeaderText(value) Method

#Declaration

TypeScript
setHeaderText(
    value: string
): void

#Parameters

Name Type
value string

#setMaximized(value) Method

#Declaration

TypeScript
setMaximized(
    value: boolean
): void

#Parameters

Name Type
value boolean

#setPinned(value) Method

#Declaration

TypeScript
setPinned(
    value: boolean
): void

#Parameters

Name Type
value boolean

#setPopupElementCssSelector(selector) Method

#Declaration

TypeScript
setPopupElementCssSelector(
    selector: string
): void

#Parameters

Name Type
selector string

#setPopupElementID(popupElementId) Method

#Declaration

TypeScript
setPopupElementID(
    popupElementId: string
): void

#Parameters

Name Type
popupElementId string

#setSize(width, height) Method

#Declaration

TypeScript
setSize(
    width: number,
    height: number
): void

#Parameters

Name Type
width number
height number

#setWindowAdaptiveMaxHeight(window, maxHeight) Method

#Declaration

TypeScript
setWindowAdaptiveMaxHeight(
    window: BootstrapPopupWindow,
    maxHeight: number
): void

#Parameters

Name Type
window BootstrapPopupWindow
maxHeight number

#setWindowAdaptiveMaxWidth(window, maxWidth) Method

#Declaration

TypeScript
setWindowAdaptiveMaxWidth(
    window: BootstrapPopupWindow,
    maxWidth: number
): void

#Parameters

Name Type
window BootstrapPopupWindow
maxWidth number

#setWindowAdaptiveMinHeight(window, minHeight) Method

#Declaration

TypeScript
setWindowAdaptiveMinHeight(
    window: BootstrapPopupWindow,
    minHeight: number
): void

#Parameters

Name Type
window BootstrapPopupWindow
minHeight number

#setWindowAdaptiveMinWidth(window, minWidth) Method

#Declaration

TypeScript
setWindowAdaptiveMinWidth(
    window: BootstrapPopupWindow,
    minWidth: number
): void

#Parameters

Name Type
window BootstrapPopupWindow
minWidth number

#setWindowCollapsed(window, value) Method

#Declaration

TypeScript
setWindowCollapsed(
    window: BootstrapPopupWindow,
    value: boolean
): void

#Parameters

Name Type
window BootstrapPopupWindow
value boolean

#setWindowContentHtml(window, html) Method

#Declaration

TypeScript
setWindowContentHtml(
    window: BootstrapPopupWindow,
    html: string
): void

#Parameters

Name Type
window BootstrapPopupWindow
html string

#setWindowContentUrl(window, url) Method

#Declaration

TypeScript
setWindowContentUrl(
    window: BootstrapPopupWindow,
    url: string
): void

#Parameters

Name Type
window BootstrapPopupWindow
url string

#setWindowMaximized(window, value) Method

#Declaration

TypeScript
setWindowMaximized(
    window: BootstrapPopupWindow,
    value: boolean
): void

#Parameters

Name Type
window BootstrapPopupWindow
value boolean

#setWindowPinned(window, value) Method

#Declaration

TypeScript
setWindowPinned(
    window: BootstrapPopupWindow,
    value: boolean
): void

#Parameters

Name Type
window BootstrapPopupWindow
value boolean

#setWindowPopupElementID(window, popupElementId) Method

#Declaration

TypeScript
setWindowPopupElementID(
    window: BootstrapPopupWindow,
    popupElementId: string
): void

#Parameters

Name Type
window BootstrapPopupWindow
popupElementId string

#setWindowSize(window, width, height) Method

#Declaration

TypeScript
setWindowSize(
    window: BootstrapPopupWindow,
    width: number,
    height: number
): void

#Parameters

Name Type
window BootstrapPopupWindow
width number
height number

#show Method

#Declaration

TypeScript
show(): void

#showAtElement(htmlElement) Method

#Declaration

TypeScript
showAtElement(
    htmlElement: any
): void

#Parameters

Name Type
htmlElement any

#showAtElementByID(id) Method

#Declaration

TypeScript
showAtElementByID(
    id: string
): void

#Parameters

Name Type
id string

#showAtPos(x, y) Method

#Declaration

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

#Parameters

Name Type
x number
y number

#showWindow(window) Method

#Declaration

TypeScript
showWindow(
    window: BootstrapPopupWindow
): void

#Parameters

Name Type
window BootstrapPopupWindow

#showWindow(window, popupElementIndex) Method

#Declaration

TypeScript
showWindow(
    window: BootstrapPopupWindow,
    popupElementIndex: number
): void

#Parameters

Name Type
window BootstrapPopupWindow
popupElementIndex number

#showWindowAtElement(window, htmlElement) Method

#Declaration

TypeScript
showWindowAtElement(
    window: BootstrapPopupWindow,
    htmlElement: any
): void

#Parameters

Name Type
window BootstrapPopupWindow
htmlElement any

#showWindowAtElementByID(window, id) Method

#Declaration

TypeScript
showWindowAtElementByID(
    window: BootstrapPopupWindow,
    id: string
): void

#Parameters

Name Type
window BootstrapPopupWindow
id string

#showWindowAtPos(window, x, y) Method

#Declaration

TypeScript
showWindowAtPos(
    window: BootstrapPopupWindow,
    x: number,
    y: number
): void

#Parameters

Name Type
window BootstrapPopupWindow
x number
y number

#stretchVertically Method

#Declaration

TypeScript
stretchVertically(): void

#updatePosition Method

#Declaration

TypeScript
updatePosition(): void

#updatePositionAtElement(htmlElement) Method

#Declaration

TypeScript
updatePositionAtElement(
    htmlElement: any
): void

#Parameters

Name Type
htmlElement any

#updateWindowPosition(window) Method

#Declaration

TypeScript
updateWindowPosition(
    window: BootstrapPopupWindow
): void

#Parameters

Name Type
window BootstrapPopupWindow

#updateWindowPositionAtElement(window, htmlElement) Method

#Declaration

TypeScript
updateWindowPositionAtElement(
    window: BootstrapPopupWindow,
    htmlElement: any
): void

#Parameters

Name Type
window BootstrapPopupWindow
htmlElement any

#windowStretchVertically(window) Method

#Declaration

TypeScript
windowStretchVertically(
    window: BootstrapPopupWindow
): void

#Parameters

Name Type
window BootstrapPopupWindow