BootstrapPopupControl Class

Declaration

export class BootstrapPopupControl extends Control

Inheritance

Control
BootstrapPopupControl

Properties

name Property

Declaration

readonly name: string

Property Value

Type Description
string

Methods

adjustControl Method

Declaration

adjustControl(): void

adjustSize Method

Declaration

adjustSize(): void

bringToFront Method

Declaration

bringToFront(): void

bringWindowToFront Method

Declaration

bringWindowToFront(window: BootstrapPopupWindow): void

Parameters

Type Name Description
BootstrapPopupWindow window

getCollapsed Method

Declaration

getCollapsed(): boolean

Returns

Type Description
boolean

getContentHeight Method

Declaration

getContentHeight(): number

Returns

Type Description
number

getContentHtml Method

Declaration

getContentHtml(): string

Returns

Type Description
string

getContentIFrame Method

Declaration

getContentIFrame(): any

Returns

Type Description
any

getContentIFrameWindow Method

Declaration

getContentIFrameWindow(): any

Returns

Type Description
any

getContentUrl Method

Declaration

getContentUrl(): string

Returns

Type Description
string

getContentWidth Method

Declaration

getContentWidth(): number

Returns

Type Description
number

getCurrentPopupElement Method

Declaration

getCurrentPopupElement(): any

Returns

Type Description
any

getCurrentPopupElementIndex Method

Declaration

getCurrentPopupElementIndex(): number

Returns

Type Description
number

getFooterImageUrl Method

Declaration

getFooterImageUrl(): string

Returns

Type Description
string

getFooterNavigateUrl Method

Declaration

getFooterNavigateUrl(): string

Returns

Type Description
string

getFooterText Method

Declaration

getFooterText(): string

Returns

Type Description
string

getHeaderImageUrl Method

Declaration

getHeaderImageUrl(): string

Returns

Type Description
string

getHeaderNavigateUrl Method

Declaration

getHeaderNavigateUrl(): string

Returns

Type Description
string

getHeaderText Method

Declaration

getHeaderText(): string

Returns

Type Description
string

getHeight Method

Declaration

getHeight(): number

Returns

Type Description
number

getMainElement Method

Declaration

getMainElement(): any

Returns

Type Description
any

getMaximized Method

Declaration

getMaximized(): boolean

Returns

Type Description
boolean

getParentControl Method

Declaration

getParentControl(): any

Returns

Type Description
any

getPinned Method

Declaration

getPinned(): boolean

Returns

Type Description
boolean

getPopUpReasonMouseEvent Method

Declaration

getPopUpReasonMouseEvent(): any

Returns

Type Description
any

getVisible Method

Declaration

getVisible(): boolean

Returns

Type Description
boolean

getWidth Method

Declaration

getWidth(): number

Returns

Type Description
number

getWindow Method

Declaration

getWindow(index: number): BootstrapPopupWindow | null

Parameters

Type Name Description
number index

Returns

Type Description
BootstrapPopupWindow
null

getWindowByName Method

Declaration

getWindowByName(name: string): BootstrapPopupWindow | null

Parameters

Type Name Description
string name

Returns

Type Description
BootstrapPopupWindow
null

getWindowCollapsed Method

Declaration

getWindowCollapsed(window: BootstrapPopupWindow): boolean

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
boolean

getWindowContentHeight Method

Declaration

getWindowContentHeight(window: BootstrapPopupWindow): number

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
number

getWindowContentHtml Method

Declaration

getWindowContentHtml(window: BootstrapPopupWindow): string

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
string

getWindowContentIFrame Method

Declaration

getWindowContentIFrame(window: BootstrapPopupWindow): any

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
any

getWindowContentUrl Method

Declaration

getWindowContentUrl(window: BootstrapPopupWindow): string

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
string

getWindowContentWidth Method

Declaration

getWindowContentWidth(window: BootstrapPopupWindow): number

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
number

getWindowCount Method

Declaration

getWindowCount(): number

Returns

Type Description
number

getWindowCurrentPopupElement Method

Declaration

getWindowCurrentPopupElement(window: BootstrapPopupWindow): any

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
any

getWindowCurrentPopupElementIndex Method

Declaration

getWindowCurrentPopupElementIndex(window: BootstrapPopupWindow): number

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
number

getWindowHeight Method

Declaration

getWindowHeight(window: BootstrapPopupWindow): number

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
number

getWindowMaximized Method

Declaration

getWindowMaximized(window: BootstrapPopupWindow): boolean

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
boolean

getWindowPinned Method

Declaration

getWindowPinned(window: BootstrapPopupWindow): boolean

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
boolean

getWindowPopUpReasonMouseEvent Method

Declaration

getWindowPopUpReasonMouseEvent(window: BootstrapPopupWindow): any

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
any

getWindowWidth Method

Declaration

getWindowWidth(window: BootstrapPopupWindow): number

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
number

hide Method

Declaration

hide(): void

hideWindow Method

Declaration

hideWindow(window: BootstrapPopupWindow): void

Parameters

Type Name Description
BootstrapPopupWindow window

inCallback Method

Declaration

inCallback(): boolean

Returns

Type Description
boolean

isVisible Method

Declaration

isVisible(): boolean

Returns

Type Description
boolean

isWindowVisible Method

Declaration

isWindowVisible(window: BootstrapPopupWindow): boolean

Parameters

Type Name Description
BootstrapPopupWindow window

Returns

Type Description
boolean

off Method

Declaration

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

Parameters

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

Returns

Type Description
this

on Method

Declaration

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

Parameters

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

Returns

Type Description
this

once Method

Declaration

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

Parameters

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

Returns

Type Description
this

performCallback Method

Declaration

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

Parameters

Type Name Description
any data
() => void onSuccess

performCallback Method

Declaration

performCallback(data: any): Promise<void>

Parameters

Type Name Description
any data

Returns

Type Description
Promise<void>

refreshContentUrl Method

Declaration

refreshContentUrl(): void

refreshPopupElementConnection Method

Declaration

refreshPopupElementConnection(): void

refreshWindowContentUrl Method

Declaration

refreshWindowContentUrl(window: BootstrapPopupWindow): void

Parameters

Type Name Description
BootstrapPopupWindow window

sendMessageToAssistiveTechnology Method

Declaration

sendMessageToAssistiveTechnology(message: string): void

Parameters

Type Name Description
string message

setAdaptiveMaxHeight Method

Declaration

setAdaptiveMaxHeight(maxHeight: number): void

Parameters

Type Name Description
number maxHeight

setAdaptiveMaxHeight Method

Declaration

setAdaptiveMaxHeight(maxHeight: number): void

Parameters

Type Name Description
number maxHeight

setAdaptiveMaxWidth Method

Declaration

setAdaptiveMaxWidth(maxWidth: number): void

Parameters

Type Name Description
number maxWidth

setAdaptiveMaxWidth Method

Declaration

setAdaptiveMaxWidth(maxWidth: number): void

Parameters

Type Name Description
number maxWidth

setAdaptiveMinHeight Method

Declaration

setAdaptiveMinHeight(minHeight: number): void

Parameters

Type Name Description
number minHeight

setAdaptiveMinHeight Method

Declaration

setAdaptiveMinHeight(minHeight: number): void

Parameters

Type Name Description
number minHeight

setAdaptiveMinWidth Method

Declaration

setAdaptiveMinWidth(minWidth: number): void

Parameters

Type Name Description
number minWidth

setAdaptiveMinWidth Method

Declaration

setAdaptiveMinWidth(minWidth: number): void

Parameters

Type Name Description
number minWidth

setCollapsed Method

Declaration

setCollapsed(value: boolean): void

Parameters

Type Name Description
boolean value

setContentHtml Method

Declaration

setContentHtml(html: string): void

Parameters

Type Name Description
string html

setContentUrl Method

Declaration

setContentUrl(url: string): void

Parameters

Type Name Description
string url

setFooterImageUrl Method

Declaration

setFooterImageUrl(value: string): void

Parameters

Type Name Description
string value

setFooterNavigateUrl Method

Declaration

setFooterNavigateUrl(value: string): void

Parameters

Type Name Description
string value

setFooterText Method

Declaration

setFooterText(value: string): void

Parameters

Type Name Description
string value

setHeaderImageUrl Method

Declaration

setHeaderImageUrl(value: string): void

Parameters

Type Name Description
string value

setHeaderNavigateUrl Method

Declaration

setHeaderNavigateUrl(value: string): void

Parameters

Type Name Description
string value

setHeaderText Method

Declaration

setHeaderText(value: string): void

Parameters

Type Name Description
string value

setHeight Method

Declaration

setHeight(height: number): void

Parameters

Type Name Description
number height

setMaximized Method

Declaration

setMaximized(value: boolean): void

Parameters

Type Name Description
boolean value

setPinned Method

Declaration

setPinned(value: boolean): void

Parameters

Type Name Description
boolean value

setPopupElementCssSelector Method

Declaration

setPopupElementCssSelector(selector: string): void

Parameters

Type Name Description
string selector

setPopupElementID Method

Declaration

setPopupElementID(popupElementId: string): void

Parameters

Type Name Description
string popupElementId

setSize Method

Declaration

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

Parameters

Type Name Description
number width
number height

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

setWindowAdaptiveMaxHeight Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
number maxHeight

setWindowAdaptiveMaxHeight Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
number maxHeight

setWindowAdaptiveMaxWidth Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
number maxWidth

setWindowAdaptiveMaxWidth Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
number maxWidth

setWindowAdaptiveMinHeight Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
number minHeight

setWindowAdaptiveMinHeight Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
number minHeight

setWindowAdaptiveMinWidth Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
number minWidth

setWindowAdaptiveMinWidth Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
number minWidth

setWindowCollapsed Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
boolean value

setWindowContentHtml Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
string html

setWindowContentUrl Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
string url

setWindowMaximized Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
boolean value

setWindowPinned Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
boolean value

setWindowPopupElementID Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
string popupElementId

setWindowSize Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
number width
number height

show Method

Declaration

show(): void

showAtElement Method

Declaration

showAtElement(htmlElement: any): void

Parameters

Type Name Description
any htmlElement

showAtElementByID Method

Declaration

showAtElementByID(id: string): void

Parameters

Type Name Description
string id

showAtPos Method

Declaration

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

Parameters

Type Name Description
number x
number y

showWindow Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
number popupElementIndex

showWindow Method

Declaration

showWindow(window: BootstrapPopupWindow): void

Parameters

Type Name Description
BootstrapPopupWindow window

showWindowAtElement Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
any htmlElement

showWindowAtElementByID Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
string id

showWindowAtPos Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
number x
number y

stretchVertically Method

Declaration

stretchVertically(): void

updatePosition Method

Declaration

updatePosition(): void

updatePositionAtElement Method

Declaration

updatePositionAtElement(htmlElement: any): void

Parameters

Type Name Description
any htmlElement

updateWindowPosition Method

Declaration

updateWindowPosition(window: BootstrapPopupWindow): void

Parameters

Type Name Description
BootstrapPopupWindow window

updateWindowPositionAtElement Method

Declaration

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

Parameters

Type Name Description
BootstrapPopupWindow window
any htmlElement

windowStretchVertically Method

Declaration

windowStretchVertically(window: BootstrapPopupWindow): void

Parameters

Type Name Description
BootstrapPopupWindow window