| apldir |
Description: Read-only property returning the directory from which APL+Win was launched
Syntax: 'obj' Świ 'apldir'
Example:
'oo5' Świ 'apldir' |
| apptitle |
Description: Get or Set the Application Title
Syntax: {apptitle}„'obj' Świ 'apptitle' {apptitle}
apptitle: character string: the Application title
Note: this property is used by various APL+Win Objects functions
Example:
'oo5' Świ 'apptitle' 'My APL Application' |
 |
| appversion |
Description: Get or Set the Application Version number
Syntax: {appversion}„'obj' Świ 'appversion' {appversion}
appversion: character string: the Application version number
Note: this property is used by various APL+Win Objects functions
Example:
'oo5' Świ 'appversion' '1.01.002' |
| attach |
Description: Specified how an object is attached to its parent
Syntax: {parentsides}„'obj' Świ 'attach' {parentsides}
parentsides: numeric vector of object parent sides to which
the left, top, right and bottom object sides
(always in this order: left,top,right,bottom) are attached
Notes: parent sides are numbered as follows:
1=left 2=top 3=right 4=bottom
Thus: 1 2 3 2 means:
left object side is attached to left parent side (1)
top object side is attached to top parent side (2)
right object side is attached to right parent side (3)
bottom object side is attached to top parent side (2)
3 2 3 4 means:
left object side is attached to right parent side (3)
top object side is attached to top parent side (2)
right object side is attached to right parent side (3)
bottom object side is attached to bottom parent side (4)
Note: ‘‘‘attach property needed by TEditGrid5, ... to avoid recursion
Note: the processing of the <attach> property is done by the TObject5 <‘‘‘Attach> method
Example:
'ff' Świ '*Create' 'TForm5' ('*caption' 'attach demo')
'ff.ed1' Świ '*Create' 'TEdit5' ('wherelc'Đ(100 Ż90'Name')Đ 200) ('attach'1 2 3 2)
'ff.ed2' Świ '*Create' 'TEdit5' ('wherelc' '>' ('=' Ż90'Comment')Đ 200) ('attach'1 2 3 4)
'ff' Świ 'Redim' Ş 'ff' Świ 'Show' |
| caption |
Description: Get or Set the associated Label caption
Syntax: {caption„'} 'obj' Świ 'caption' {caption}{fontname fontsize fontbold charset}
caption: a character string
fontname: optional font |
| check |
Description: Get or set the check property on the TQuestion5 Edit control
Syntax: 'obj' Świ 'check' {expr errormsg}{expr errormsg}...{expr errormsg}
expr: APL expression involving the ‘control function and returning boolean
errormsg: error message displayed if expr return 1
Note: checks are performed by the object onExit handler (see onExit in this function)
Example:
0 0˝'ff' Świ '*Create' 'TForm5' ('*size'200 350) 'DemoShow' 'SessionFocus'
0 0˝'ff' Świ '*.edAge.Create' 'TEdit5' ('wherelc'Đ (100'>' 'Your age')Đ 200) ('type' 'integer') ('check' '~‘edAgeąĽ100' 'Enter an integer between 1 and 100!')
0 0˝'ff' Świ '*.bnOK.Create' 'TOKButton5' ('wherelc' '>' '='Đ Đ) |
| class |
Description: Return current object class
Syntax: class„'obj' Świ 'class' |
| clipsiblings |
Description: Get or set the window WS_CLIPSIBLINGS style bit
Syntax: {boolean„'} 'obj' Świ 'clipsiblings' {boolean}
Example:
'ff.ed' Świ 'clipsiblings'1 |
| connected |
Description: Return 1 if there currently is an active connection to Internet (read-only property)
Syntax: boolean„'obj' Świ 'connected'
boolean: 0=no active Internet connection 1=active Internet connection
Example:
'oo5' Świ 'connected' |
| countries |
Description: Get the list of supported country codes (read-only property)
Note: To add a country code:
1. append a country code to the list of countries set in TObject5 New method
2. change all programs depending on 'countries' |
| country |
Description: Get or set the country phone code
Syntax: {countrycode„'} 'obj' Świ 'country' {countrycode}
countrycode: a telephone country code |
| cpuspeed |
Description: Returns the current CPU speed in MHz (read-only property)
Syntax: 'obj' Świ 'CpuSpeed'
Note: used CPUSpeed ActiveX Freeware:
'cpu' Świ '*xAbout'
Version 1.0, Copyright (c) 2000 WINSOFT, http://www.cybermagic.co.nz/winsoft
Example:
'oo5' Świ 'cpuspeed' |
 |
| doc |
Description: Read-only property returning a short documentation for a given object
Syntax: doc„'obj' Świ 'doc'
doc: list of objects available Properties and Methods
Example:
0 0˝'ff' Świ '*Create' 'TForm5'
'ff' Świ 'doc' |
| help |
Example:
'oo5' Świ 'class'
80 TELPRINT ś'oo5' Świ 'Properties'
80 TELPRINT ś'oo5' Świ 'Methods'
0 0˝'ff' Świ '*Create' 'TForm5' ('*caption' 'TObject5 Example') ('ontop'1) ('*size'200 300) 'DemoShow' 'SessionFocus'
0 0˝'ff' Świ '*.ed.Create' 'TEdit5' ('wherelc'Đ 100 Đ Đ) ('caption' 'Sample Edit Control')
'ff' Świ '?TextSize'
'ff' Świ 'TextSize' 'This is a rather long text'
'ff' Świ '.ed.TextSize' 'This is a rather long text' ('Arial'32 1)
6†[1]'ff' Świ 'EnumFonts'
6†[1]'oo5' Świ 'EnumFonts' |
| history |
Description: Return the history of changes made to an object
Syntax: history„'obj' Świ 'history' {class}
class: name of an another optional object
history: a character string showing the history of changes made to the current object
or the history of the object specifed in <class>
Example:
'oo5' Świ 'history'
'oo5' Świ 'history' 'TExcel5' |
| iever |
Description: Return Internet Explorer version (read-only)
Syntax: iever„'obj' Świ 'iever'
iever: Internet Explorer major and minor version (char string)
Example:
'oo5' Świ 'iever'
6.0.2800.1106 |
| imethods |
Description: Return the list of all inherited methods for an object (read-only)
Syntax: nestedarray„'obj' Świ 'imethods'
Example:
'ff' Świ 'imethods' |
| inifile |
Description: Return name of .INI file used with this APL session (read-only)
Syntax: inifile„'oo5' Świ 'inifile'
inifile: name of APL+Win .INI file used with this session
Example:
'oo5' Świ 'inifile' |
| installdir |
Description: Return directory of the current workspace (read-only)
(most probably the application installation directory)
Syntax: installdir„'obj' Świ 'installdir'
Note: result ends with a \
Example:
'oo5' Świ 'installdir'
C:\APLWIN\OBJECTS\ |
 |
| ipaddress |
Description: Return the current local host IP address (read-only)
Syntax: ipaddress„'obj' Świ 'ipaddress'
ipaddress[1]: local host IP address
ipaddress[2]: local host name
ipaddress[3]: local host name & domain
Example:
'oo5' Świ 'ipaddress' |
| iproperties |
Description: Return the list of all inherited properties for an object (read-only)
Syntax: nestedarray„'obj' Świ 'iproperties'
Example:
'ff' Świ 'iproperties' |
| just |
Description: Get or Set the object (TEdit,TCombo,...) label justification
Syntax: 'obj' Świ 'just' {justification {position}}
justification: 'left' 'center' or 'right' (default)
width: if >0, means distance in pixels from left form edge
if <0, means distance in pixels from left edit control edge
if '=control', means vertically align label with specified control
if omitted means start label at left form margin
Example:
'ff.ed1' Świ 'just' 'left' 5" |
| methods |
Description: Returns all User Defined Object methods
Syntax: methods„'obj' Świ 'Methods' {substring}
substring: substring to be contained in method names
methods: nested vector of method names
Example:
'oo5' Świ 'Methods' |
| no3d |
Description: Allows to display controls with no 3D effect
Syntax: {boolean„'} 'oo5' Świ 'no3d' {boolean}
boolean: 1=no 3D effect, 0=(default) use 3D effect
Example:
'oo5' Świ 'no3d'1 |
| noattach |
Description: Allows to activate or disactivate the attach properties
Syntax: {boolean„'} 'obj' Świ 'noattach' {boolean}
boolean: 0=(default) attach property is activated; 1= attach property is disactivated
Note: you generally need to set noattach to 1 while building the interface
and to set it to 1 when you start showing the interface
Example:
'ff' Świ '*Create' 'TForm5' ('*caption' 'attach') ('*size'200 400) ('noattach'1)
'ff' Świ '*.ed1.Create' 'TEdit5' ('wherelc'10 60 21 240) ('*text' 'ed1') ('caption' 'Name') ('attach'1 2 3 2)
'ff' Świ '*.ed2.Create' 'TEdit5' ('wherelc' '>' '=' '=' '=') ('*text' 'ed2') ('caption' 'First Name') ('attach'1 2 3 2)
'ff' Świ '*.gd1.Create' 'TGrid5' ('wherelc' '>' '=' '>' '>') ('*xRows'10) ('*xCols'10) ('caption' 'Children') ('attach'1 2 3 4)
'ff' Świ '*.ed3.Create' 'TEdit5' ('wherelc' '>' '=' Đ '>') ('*text' 'ed3') ('caption' 'Comment') ('attach'1 4 3 4)
'ff' Świ '*.bnOK.Create' 'TOKButton5' ('wherelc' '=..ed1' '<<..gd1' Đ 70) ('attach'3 2 3 2)
'ff' Świ '*.bnCancel.Create' 'TCancelButton5' ('wherelc' '>' '=' '=' '=') ('attach'3 2 3 2)
'ff' Świ 'noattach'0
'ff' Świ 'Show' |
| objects |
Description: Return the complete list of APL+Win Objects™ 6.0 (read-only property)
Syntax: objects„'obj' Świ 'objects'
objects: a nested vector of APL+Win Objects™ 6.0 objects names
Example:
'oo5' Świ 'objects' |
 |
| objectsver |
Description: Return a nested array showing all APL+Win Objects™ 6 objects and their version number
Syntax: objectsver„'obj' Świ 'objectsver'
objectsver: a nested array of all existing objects and of their version number
Example:
'oo5' Świ 'objectsver' |
| objtitle |
Description: Return the product name (Read-only property)
Syntax: productname„'obj' Świ 'objname'
productname: a character string containing the name of the product
Example:
'oo5' Świ 'objname' |
| objver |
Description: Return the version number of this APL+Win Objects Release as a character string (Read-only property)
Syntax: version„'obj' Świ 'objver' {class}
class: name of an another optional object
version: a character string repesenting the current object version number
or the version number of the object specifed in <class>
Example:
'oo5' Świ 'objver'
5.00.024
'oo5' Świ 'objver' 'TExcel5'
5.00.013 |
| objverno |
Description: Return the version number of this APL+Win Objects Release as a number (Read-only property)
Syntax: version„'obj' Świ 'objverno' {class}
class: name of an another optional object
version: a floating point scalar repesenting the current object version number
or the floating point version number of the object specifed in <class>
Example:
'oo5' Świ 'objverno'
5.00024
'oo5' Świ 'objverno' 'TExcel5'
5.00013 |
| ontop |
Description: Get or Set the ability for a window to stay "ontop"
Syntax: {boolean„'} 'obj' Świ 'ontop'boolean
boolean: a boolean scalar (1=make window topmost; 0=don't)
Note: use SetWindowPos rather than 'style'16 for a form
since the latter is slower and resets the form
handle (i.e. rebuilds form system menu, etc.)
Example:
'ff' Świ '*Create' 'TForm5' ('ontop'1) ('*size'300 400) 'Show' |
| properties |
Description: Returns all User Defined Object properties
Syntax: properties„'obj' Świ 'Properties' {substring}
substring: substring to be contained in property names
properties: a nested vector of property names |
| resources |
Description: Get or set the directory used for resources (bitmaps, etc...)
Syntax: 'obj' Świ 'resources' {pathname}
pathname: complete DOS path name
Example:
'oo5' Świ 'resources' 'c:\aplwin\objects5' |
| spy |
Description: Indicates if form must is being spied or not
Syntax: 'obj' Świ 'spy'value
value: 0=dont spy 1=spy 2=spy eliminating some mouse events 3=also eliminate Paint and Timer events
Example:
'ff' Świ 'spy'2 |
| styles |
Description: Return the styles of the current object as an integer vector (read-only property)
Syntax: styles„'obj' Świ 'styles'
Example:
'ff.cbDrive' Świ 'styles' |
| suffix |
Description: Get or Set the control suffix text
The suffix is a label automatically placed to the right of the control
Syntax: 'obj' Świ 'suffix' {suffix}
suffix: a character string
Example:
'ff.edAmount' Świ 'suffix' 'USD' |
| sysdir |
Description: Return the Windows System directory (read-only)
Syntax: sysdir„'obj' Świ 'sysdir'
sysdir: character string containing the Windows System directory path
Example:
'oo5' Świ 'sysdir'
C:\WINDOWS\SYSTEM32\ |
| sysmenu |
Description: Completes the form System menu with additional options
Syntax: {boolean„'} 'obj' Świ 'sysmenu' {boolean} |
 |
| version |
Description: Return the current APL+Win Objects version
Syntax: version„'obj' Świ 'version'
version: an integer representing the current APL+Win Objects version
Example:
'oo5' Świ 'version'
5 |
 |
| visible |
Description: Get or Set the visible property of an APL+Win Objects control
Syntax: {boolean„'} 'obj' Świ 'visible' {boolean}
boolean: a boolean value
Example:
'ff.ed' Świ 'visible'0 |
| wherelc |
Description: Generalized <where> property allowing to set control position relatively to other controls
Syntax: {where„'} 'obj' Świ 'where' {where}
1śwhere „…
value absolute vertical position in pixels
Đ for a control: at gap from top of form
for a form: at gap from top of screen
> below "current" control+gap
>control below "control"+gap
>> below "current" control with no gap
>>control below "control" with no gap
= same vertical position as "current" control
=control same vertical position as "control"
<> for a control: vertically centered in parent
for a form: vertically center within screen
<>control vertically centered compared to control
#< vertically center control between top of form and previous control
># vertically center control between previous control and bottom of form
< for a control: at "gap" from bottom of parent
for a form: at gap from bottom of screen
<< for a control: at bottom of parent
for a form: at bottom of screen
<control bottom aligned with "control"-gap
<<control bottom aligned with "control"
<<<control above control with margin
° leave vertical position unchanged
2śB „…
value absolute horizontal position in pixels
Đ for a control: at gap from left of form
for a form: at gap from left of screen
> right of current control with gap
>control right of specified control with gap
>> right of current control with no gap
>>control right of control with no gap
= same horizontal position as current control
=control same horizontal position as "control"
<> horizontally centered in parent
for a form, horizontally center within screen
<>control horizontally centered compared to control
#< horizontally center control between left of form and previous control
># horizontally center control between previous control and right of form
< at "gap" from right parent edge
for a form, at gap from right of screen
<< at right of parent
for a form, at right of screen
<control right aligned with "control"-gap
<<control right aligned with "control"
<<<control before control with margin
° leave horizontal position unchanged
(hpos captionpos 'caption')
hpos: horizontal position (same as 2śB)
captionpos: positive number „… absolute horizontal position in pixels
negative number „… relative position from left of TEdit5
'>' „… right justified to left of TEdit5
'=' „… use same position as previous label
'ź' „… same horizontal position as TEdit5, but above it
(moves TEdit5 down except if TEdit5 bottom aligned or
centered in form)
caption: the TEdit5 associated label
3śB „…
= same height as current control
° leave height unchanged
Đ default height for this class of control
> extend to bottom of container with margin
>control extend to bottom of <control> with margin
>> extend to bottom of container with no margin
>>control extend to bottom of <control> with no margin
<<control extend to top of <control> with no margin
<control extend to top of <control> with margin
4śB „…
= same width as current control
° leave width unchanged
Đ default width for this class of control
> extend to right of container with margin
>control extend to right of <control> with margin
>> extend to right of container with no margin
>>control extend to right of <control> with no margin
<<control extend to left of <control> with no margin
<control extend to left of <control> with margin
„… same width as object caption (useful for Option Buttons and Check Boxes)
„…NN NN+same width as object caption
5śB „… vertical position adjustment in pixels
6śB „… horizontal position adjustment in pixels
'=label' means adjust horizontal position by width of Label
'=NN+label' means adjust horizontal position by width of Label + NN pixels
7śB „… height adjustment in pixels
8śB „… width adjustment in pixels
'=label' means adjust control width by width of Label
'=NN+label' means adjust control width by width of Label + NN pixels
Example:
'ff.ed1' Świ 'wherelc' '=' '>..ed2' Đ 0 0 0 0 '=as long as this text'
('wherelc'5(100 95'Test')Đ 200)
('wherelc'5(100 Ż95'Test')Đ 200)
('wherelc'5(100 '>' 'Test')Đ 200)
('wherelc'5(100 '=' 'Test')Đ 200)
('wherelc'5(100 'ź' 'Test')Đ 200) |
| windir |
Description: Return the Windows directory (read-only)
Syntax: windir„'obj' Świ 'windir'
windir: character string containing the Windows directory path
Example:
'oo5' Świ 'windir'
C:\WINNT\ |
| winver |
Description: Returns Windows version (read-only)
Syntax: winver„'obj' Świ 'winver'
winver: 5-element numeric vector
[1]=major version
[2]=minor version
[3]=build number
[4]=platform(0=Win32s, 1=Win95/98/Me, 2=WinNT/2000/XP)
[5]=platform(string containing platform and additional information)
Example:
]display 'oo5' Świ 'winver'
.…---------------------------------------------------------------------.
| .…----------------------------------------------------.|
| 5 0 2195 2 |Windows 2000 Professional Service Pack 3 (Build 2195)||
| '-----------------------------------------------------'|
'ą---------------------------------------------------------------------' |
| winversion |
Description: Returns Windows version (read-only)
Syntax: winversion„'obj' Świ 'winversion'
winversion: string containing platform and additional information
Example:
'oo5' Świ 'winversion'
Windows 2000 Professional Service Pack 3 (Build 2195) |