DHTMLX Docs & Samples Explorer
Index
dhtmlxwindows
dhtmlxWindows API Methods
dhtmlxWindows API Methods
addUserButton
adds a user button
allowMove
allows a window to be moved
allowPark
allows a window to be parked
allowResize
allows a window to be resized
bringToBottom
brings/sends a window to the bottom (z-positioning)
bringToTop
brings/sends a window on the top (z-positioning)
button
returns the button handler (dhtmlXWindowsBtn object) found by id
center
centers a window in the viewport
centerOnScreen
centers a window on the screen
clearIcon
clears window's header icon
close
closes a window
denyMove
denies a window from moving
denyPark
denies a window from parking
denyResize
denies a window from resizing
getDimension
returns the current window's dimension
getIcon
returns the current window's header icon
getId
returns window's id
getMaxDimension
returns the current max window's dimension
getMinDimension
returns the current min window's dimension
getPosition
returns the current window's position
getText
returns window's header text
hide
hides a window
hideHeader
hides window's header
isHidden
returns true if the window is hidden
isMaximized
returns true if the window is maximized
isModal
returns true if the window is modal
isMovable
returns true if the window is movable
isOnBottom
returns true if the window is on the bottom
isOnTop
returns true if the window is on the top
isParkable
returns true if the window is parkable
isParked
returns true if the window is parked
isResizable
returns true if the window is resizable
isSticked
returns true if the window is sticked
keepInViewport
keeps a window within the viewport
maximize
maximizes a window
minimize
minimizes a window
park
parks a window (the next action is based on the window's current state)
progressOff
hides a progress indicator
progressOn
shows a progress indicator
removeUserButton
removes a user button
restoreIcon
restores default window's header icon (based on skin)
setDimension
sets window's dimension
setIcon
sets window's header icon
setMaxDimension
sets max window's dimension
setMinDimension
sets min window's dimension
setModal
makes a window modal/modeless
setPosition
sets window's position (moves a window to the point set by user)
setText
sets window's header text
setToFullScreen
sets a window to the fullscreen mode
show
shows a window
showHeader
shows window's header
stick
sticks a window
unstick
unsticks a window
dhtmlXWindowsBtn Object
disable
disables a button
enable
enables a button
hide
hides a button
isEnabled
checks if a button is enabled
isHidden
checks if a button is hidden
show
shows a button
dhtmlXWindows Object
attachEvent
attaches an event handler
attachViewportTo
attaches a viewport to an existing object on the page (renders an object as a viewport)
checkEvent
returns true if the event exists
createWindow
creates a new window and returns its handler
detachEvent
removes an event handler
enableAutoViewport
if true - allows an object to adjust the viewport automatically to document.body
findByText
returns array of window handlers found by header text
forEachWindow
iterator - goes through all windows and calls a user handler
getBottommostWindow
returns the bottommost window
getEffect
returns true if the effect is enabled
getTopmostWindow
returns the topmost window
isWindow
returns true if the window with specified id exists
setEffect
sets a visual effect
setImagePath
sets path to the directory where used images are located
setSkin
changes window's skin
setViewport
sets user-defined viewport if enableAutoViewport(false)
unload
unloads an object and clears memory
window
returns the window handler (dhtmlXWindowSngl object) found by id