DHTMLX Docs & Samples Explorer

dhtmlXWindows Object

Init/Unload

Common

  • getId returns window's id
  • findByText returns array of window handlers found by header text
  • forEachWindow iterator - goes through all windows and calls a user handler
  • setSkin changes window's skin

Effects

Events

Window Object

Init

  • createWindow creates a new window and returns its handler
  • window returns the window handler (dhtmlXWindowSngl object) found by id
  • isWindow returns true if the window with specified id exists
  • close closes a window

Attaching objects/dhtmlx components

Move

Position

  • setPosition sets window's position (moves a window to the point set by user)
  • getPosition returns current window's position

Dimension

Min/Max

Resize

Park

  • park parks a window (next action is based on window's current state)
  • isParked returns true if the window is parked
  • allowPark allows a window to be parked
  • denyPark denies a window from parking
  • isParkable returns true if the window is parkable

Visibility

  • show shows a window
  • hide hides a window
  • isHidden returns true if the window is hidden

Z-Index

Sticking

Modality

  • setModal makes a window modal/modeless
  • isModal returns true if the window is modal

Header/Text

Centring

Icon

  • setImagePath sets path to the directory where used images are located
  • setIcon sets window's header icon
  • getIcon returns the current window's header icon
  • clearIcon clears window's header icon
  • restoreIcon restores default window's header icon (based on skin)

Progress

Button Object

Add/Remove

State

Visibility

Viewport

  • attachViewportTo attaches a viewport to an existing object on page (renders an object as a viewport)
  • enableAutoViewport if true - allows an object to adjust the viewport automatically to document.body
  • setViewport sets user-defined viewport if enableAutoViewport(false)
  • keepInViewport keeps a window within the viewport