xBase and Clipper language compatible compiler
PrevChapter 12. CLIP ClassesNext

12.21. Class UIDOCUMENT

12.21.1. About

Class for document window. It inherits properties and methods of class <ulink linkend="classuichildwindow">UIChildWindow</link>.

12.21.2. Description

 UIDocument([<caption>],<parent>,[<name>])	--> UIDocument object

12.21.2.1. Attributes

<className> - Class name. Value should be "UIDocument".
<actions> - Button bar. Type is <ulink linkend="classuibuttonbar">UIButtonBar</link>.
<userSpace> - Scrolled region for widget placement. Type is <ulink linkend="classuivbox">UIVBox</link>.

12.21.2.2. Methods

UIDOCUMENT Constructor. Create child window with button bar at bottom and scrolled region for widget placement.

12.21.2.3. Example

 /* Create main window and document window */
 win := UIMainWindow("Main window")
 win:setMDI()
 docWindow := UIDocument("Document", win, "doc")
 
 /* Add edit field and button for close document window */
 docWindow:userSpace:add(UIEdit())
 docWindow:actions:add(UIButton(, "&Close", {|| docWindow:close() } )))
 
 /* Show these windows */
 docWindow:show()
 win:show()

12.21.2.4. See also

12.21.2.5. Author of documentation

Andrey Cherepanov <>

12.21.2.6. Platforms

No dependies of platform.

12.21.2.7. Method UIDOCUMENT:UIDOCUMENT()

Constructor. Create child window with button bar at bottom and scrolled region for widget placement.

 UIDocument([<caption>],<parent>,[<name>])	--> UIDocument object

12.21.2.7.1. Arguments

<caption> - String. Caption of child window.
<parent> - Window object. Parent window which should be contains child window. Before create first child window for this parent window must be called method setMDI().
<name> - String. Window name.

12.21.2.7.2. Returns

Returns NIL.

12.21.2.7.3. Description

PrevHomeNext
Class UICOMBOBOXUpClass UIDRIVER