Method XbpDialog():setFrameState() Foundation

Sets the display state of the XbpDialog window.

:setFrameState( <nStatus> ) --> lSuccess
The value passed as the parameter <nStatus> must be a #define constant from the XBP.CH file. The available constants are shown in the following table:
Constants for the display status of a dialog window
Constant Description
XBPDLG_FRAMESTAT_MINIMIZED Window is displayed as an icon
XBPDLG_FRAMESTAT_MAXIMIZED Window is displayed in the maximum size
XBPDLG_FRAMESTAT_NORMALIZED Window is displayed in the normal size
XBPDLG_FRAMESTAT_FULLSCREEN Window is displayed full-screen *)
XBPDLG_FRAMESTAT_KIOSK Window is displayed full-screen and interaction is restricted *)
  1. Not supported for MDI child windows

This method returns the value .T. (true) if the display status of the dialog window could be changed, otherwise .F. (false) is returned.


The method :setFrameState() explicitly sets the current display state of the dialog window. The available states are: minimized, normal, maximized, full-screen and kiosk. With the exception of the full-screen and kiosk states, the current display state is generally the result of the user clicking the minimize, normal, or maximize pushbutton in the title bar of the dialog window.

Full-screen and kiosk-style dialog windows

When the full-screen frame state is set, the dialog window switches into a special full-screen mode. In this mode, the dialog covers the whole physical screen including the task bar and has no title bar or visible frame controls. Consequently, the window cannot be moved, sized or closed with the mouse. Dialog windows in full-screen mode are typically used for providing a content-centric view on the data, for example, for showing only the video feed in a media player application.

Dialog windows in kiosk mode also share these properties. In addtion, certain system shortcuts are disabled in this mode in order to prevent the user from switching away from the application, from closing it via Task Manager or from interacting with the underlying operating system. An application using a dialog window in kiosk mode hence is well suited for running on computers in store or show rooms. The following table lists the keys and key combinations which are automatically disabled when a dialog is switched into kiosk mode using the method :setFrameState().

Keys and shortcuts disabled in kiosk mode
Key/shortcut Purpose
Win key Opens the Start menu, and is used in various key combinations, eg. for switching between applications, to the desktop or for opening the Run... dialog
Ctrl+Esc Opens the Start menu
Shift+Ctrl+Esc Starts Task Manager
Alt+Tab (+Shift) Switches to next (previous) application
Alt+F4 Closes the application

The current display state can be determined using the method :getFrameState().


If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.