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_KIOSK Window is displayed full-screen *)
  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 and kiosk. With the exception of the kiosk state, 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. When the kiosk frame state is set, the dialog window switches into a special full-screen mode suitable for kiosk applications. In this mode, the dialog covers the whole screen, displays no title bar and has no system menu. Consequently, the window cannot be moved, resized or closed by the user. 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.