BootstrapPopupControl Class

Declaration

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

adjustSize(): void

bringToFront Method

Declaration

bringToFront(): void

bringWindowToFront(window) Method

Declaration

bringWindowToFront(window: BootstrapPopupWindow): void

Parameters

Name Type
window BootstrapPopupWindow

getCollapsed Method

Declaration

getCollapsed(): boolean

Returns

Type
boolean

getContentHeight Method

Declaration

getContentHeight(): number

Returns

Type
number

getContentHtml Method

Declaration

getContentHtml(): string

Returns

Type
string

getContentIFrame Method

Declaration

getContentIFrame(): any

Returns

Type
any

getContentIFrameWindow Method

Declaration

getContentIFrameWindow(): any

Returns

Type
any

getContentUrl Method

Declaration

getContentUrl(): string

Returns

Type
string

getContentWidth Method

Declaration

getContentWidth(): number

Returns

Type
number

getCurrentPopupElement Method

Declaration

getCurrentPopupElement(): any

Returns

Type
any

getCurrentPopupElementIndex Method

Declaration

getCurrentPopupElementIndex(): number

Returns

Type
number

getFooterImageUrl Method

Declaration

getFooterImageUrl(): string

Returns

Type
string

getFooterNavigateUrl Method

Declaration

getFooterNavigateUrl(): string

Returns

Type
string

getFooterText Method

Declaration

getFooterText(): string

Returns

Type
string

getHeaderImageUrl Method

Declaration

getHeaderImageUrl(): string

Returns

Type
string

getHeaderNavigateUrl Method

Declaration

getHeaderNavigateUrl(): string

Returns

Type
string

getHeaderText Method

Declaration

getHeaderText(): string

Returns

Type
string

getMainElement Method

Declaration

getMainElement(): any

Returns

Type
any

getMaximized Method

Declaration

getMaximized(): boolean

Returns

Type
boolean

getPinned Method

Declaration

getPinned(): boolean

Returns

Type
boolean

getPopUpReasonMouseEvent Method

Declaration

getPopUpReasonMouseEvent(): any

Returns

Type
any

getWindow(index) Method

Declaration

getWindow(index: number): BootstrapPopupWindow | null

Parameters

Name Type
index number

Returns

Type
BootstrapPopupWindow
null

getWindowByName(name) Method

Declaration

getWindowByName(name: string): BootstrapPopupWindow | null

Parameters

Name Type
name string

Returns

Type
BootstrapPopupWindow
null

getWindowCollapsed(window) Method

Declaration

getWindowCollapsed(window: BootstrapPopupWindow): boolean

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
boolean

getWindowContentHeight(window) Method

Declaration

getWindowContentHeight(window: BootstrapPopupWindow): number

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
number

getWindowContentHtml(window) Method

Declaration

getWindowContentHtml(window: BootstrapPopupWindow): string

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
string

getWindowContentIFrame(window) Method

Declaration

getWindowContentIFrame(window: BootstrapPopupWindow): any

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
any

getWindowContentUrl(window) Method

Declaration

getWindowContentUrl(window: BootstrapPopupWindow): string

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
string

getWindowContentWidth(window) Method

Declaration

getWindowContentWidth(window: BootstrapPopupWindow): number

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
number

getWindowCount Method

Declaration

getWindowCount(): number

Returns

Type
number

getWindowCurrentPopupElement(window) Method

Declaration

getWindowCurrentPopupElement(window: BootstrapPopupWindow): any

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
any

getWindowCurrentPopupElementIndex(window) Method

Declaration

getWindowCurrentPopupElementIndex(window: BootstrapPopupWindow): number

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
number

getWindowHeight(window) Method

Declaration

getWindowHeight(window: BootstrapPopupWindow): number

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
number

getWindowMaximized(window) Method

Declaration

getWindowMaximized(window: BootstrapPopupWindow): boolean

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
boolean

getWindowPinned(window) Method

Declaration

getWindowPinned(window: BootstrapPopupWindow): boolean

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
boolean

getWindowPopUpReasonMouseEvent(window) Method

Declaration

getWindowPopUpReasonMouseEvent(window: BootstrapPopupWindow): any

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
any

getWindowWidth(window) Method

Declaration

getWindowWidth(window: BootstrapPopupWindow): number

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
number

hide Method

Declaration

hide(): void

hideWindow(window) Method

Declaration

hideWindow(window: BootstrapPopupWindow): void

Parameters

Name Type
window BootstrapPopupWindow

isVisible Method

Declaration

isVisible(): boolean

Returns

Type
boolean

isWindowVisible(window) Method

Declaration

isWindowVisible(window: BootstrapPopupWindow): boolean

Parameters

Name Type
window BootstrapPopupWindow

Returns

Type
boolean

off<K> Method

Declaration

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

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

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

performCallback(data: any): Promise<void>

Parameters

Name Type
data any

Returns

Type
Promise<void>

performCallback(data, onSuccess) Method

Declaration

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

Parameters

Name Type
data any
onSuccess () => void

refreshContentUrl Method

Declaration

refreshContentUrl(): void

refreshPopupElementConnection Method

Declaration

refreshPopupElementConnection(): void

refreshWindowContentUrl(window) Method

Declaration

refreshWindowContentUrl(window: BootstrapPopupWindow): void

Parameters

Name Type
window BootstrapPopupWindow

setAdaptiveMaxHeight(maxHeight) Method

Declaration

setAdaptiveMaxHeight(maxHeight: number): void

Parameters

Name Type
maxHeight number

setAdaptiveMaxWidth(maxWidth) Method

Declaration

setAdaptiveMaxWidth(maxWidth: number): void

Parameters

Name Type
maxWidth number

setAdaptiveMinHeight(minHeight) Method

Declaration

setAdaptiveMinHeight(minHeight: number): void

Parameters

Name Type
minHeight number

setAdaptiveMinWidth(minWidth) Method

Declaration

setAdaptiveMinWidth(minWidth: number): void

Parameters

Name Type
minWidth number

setCollapsed(value) Method

Declaration

setCollapsed(value: boolean): void

Parameters

Name Type
value boolean

setContentHtml(html) Method

Declaration

setContentHtml(html: string): void

Parameters

Name Type
html string

setContentUrl(url) Method

Declaration

setContentUrl(url: string): void

Parameters

Name Type
url string

setFooterImageUrl(value) Method

Declaration

setFooterImageUrl(value: string): void

Parameters

Name Type
value string

setFooterNavigateUrl(value) Method

Declaration

setFooterNavigateUrl(value: string): void

Parameters

Name Type
value string

setFooterText(value) Method

Declaration

setFooterText(value: string): void

Parameters

Name Type
value string

setHeaderImageUrl(value) Method

Declaration

setHeaderImageUrl(value: string): void

Parameters

Name Type
value string

setHeaderNavigateUrl(value) Method

Declaration

setHeaderNavigateUrl(value: string): void

Parameters

Name Type
value string

setHeaderText(value) Method

Declaration

setHeaderText(value: string): void

Parameters

Name Type
value string

setMaximized(value) Method

Declaration

setMaximized(value: boolean): void

Parameters

Name Type
value boolean

setPinned(value) Method

Declaration

setPinned(value: boolean): void

Parameters

Name Type
value boolean

setPopupElementCssSelector(selector) Method

Declaration

setPopupElementCssSelector(selector: string): void

Parameters

Name Type
selector string

setPopupElementID(popupElementId) Method

Declaration

setPopupElementID(popupElementId: string): void

Parameters

Name Type
popupElementId string

setSize(width, height) Method

Declaration

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

Parameters

Name Type
width number
height number

setWindowAdaptiveMaxHeight(window, maxHeight) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
maxHeight number

setWindowAdaptiveMaxWidth(window, maxWidth) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
maxWidth number

setWindowAdaptiveMinHeight(window, minHeight) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
minHeight number

setWindowAdaptiveMinWidth(window, minWidth) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
minWidth number

setWindowCollapsed(window, value) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
value boolean

setWindowContentHtml(window, html) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
html string

setWindowContentUrl(window, url) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
url string

setWindowMaximized(window, value) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
value boolean

setWindowPinned(window, value) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
value boolean

setWindowPopupElementID(window, popupElementId) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
popupElementId string

setWindowSize(window, width, height) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
width number
height number

show Method

Declaration

show(): void

showAtElement(htmlElement) Method

Declaration

showAtElement(htmlElement: any): void

Parameters

Name Type
htmlElement any

showAtElementByID(id) Method

Declaration

showAtElementByID(id: string): void

Parameters

Name Type
id string

showAtPos(x, y) Method

Declaration

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

Parameters

Name Type
x number
y number

showWindow(window) Method

Declaration

showWindow(window: BootstrapPopupWindow): void

Parameters

Name Type
window BootstrapPopupWindow

showWindow(window, popupElementIndex) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
popupElementIndex number

showWindowAtElement(window, htmlElement) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
htmlElement any

showWindowAtElementByID(window, id) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
id string

showWindowAtPos(window, x, y) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
x number
y number

stretchVertically Method

Declaration

stretchVertically(): void

updatePosition Method

Declaration

updatePosition(): void

updatePositionAtElement(htmlElement) Method

Declaration

updatePositionAtElement(htmlElement: any): void

Parameters

Name Type
htmlElement any

updateWindowPosition(window) Method

Declaration

updateWindowPosition(window: BootstrapPopupWindow): void

Parameters

Name Type
window BootstrapPopupWindow

updateWindowPositionAtElement(window, htmlElement) Method

Declaration

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

Parameters

Name Type
window BootstrapPopupWindow
htmlElement any

windowStretchVertically(window) Method

Declaration

windowStretchVertically(window: BootstrapPopupWindow): void

Parameters

Name Type
window BootstrapPopupWindow