Lescasse Consulting
 Home    Company    News    Prices    Download    Buy    Forums   
Read Me
Buy
Forums
Resume
AntiSpam 1.2
wBackup 1.11
NetAccess 2.0
Visual APL 1.0 
APL+Win 8.0 
APL+Win Products 
APL+Win Objects™ 
APL+Win Training 
APL+Web Services
APL+Web Component 
APL+ History
Dyalog.Net Tutorial
Conferences 
Powerpoint
White Papers
Web Hosting
References
Links
 
APL+Win Objects™ 6.0

TADO5
TADO5 Tutorial
TAPLDraw5
TAPLEdit5
TAPLSession5
TAbale5
TAboutBox5
TAccess5
TAgent5
TBlatMail5
TButton5
TCDO5
TCRC5
TCancelButton5
TCheck5
TCheckGroup5
TChildForm5
TChooseColor5
TChooseFont5
TClipBoard5
TClock5
TCodeStats5
TColors5
TCombo5
TComboDrive5
TComboFilter5
TComboList5
TComboTree5
TCommandBar5
TCommandButton5
TControlClass5
TCueCard5
TDHTML5
TDHTMLEditor5
TDateTime5
TDateTimeFr5
TDates5
TDemoHandlers5
TDisplay5
TDOS5
TDualSelect5
TEdit5
TEditAmount5
TEditDir5
TEditEnter5
TEditFile5
TEditGrid5
TEditList5
TEditListview5
TEditMenu5
TEditNum5
TEditSelect5
TEditSpin5
TEmail5
TError5
TExampleForm5
TExcel5
TExcel5 Tutorial
TFindReplace5
TFOne5
TFTP5
TFTP5 Tutorial
TFileCompare5
TFileMenu5
TFileMenuDef5
TFlatButton5
TForm5
TFormClass5
TFormEditor5
TFrame5
TGetDir5
TGif5
TGifForm5
TGifWb5
TGoMenu5
TGraphX5
TGrid5
TGridDisplay5
TGridPrint5
TGUID5
THLine5
THTML5
THTML5 Tutorial
THTTP5
THelp5
THelpMenu5
TImagelist5
TInfo5
TIniFile5
TInstall5
TInternet5
TJpg5
TJpgWb5
TLabel5
TList5
TListview5
TLock5
TLogs5
TMAPI5
TMath5
TMDIForm5
TMSOutlook5
TMaskEdit5
TMedia5
TMenu5
TMessage5
TModalCall5
TMsgBox5
TNavigator5
TNetwork5
TNonVisualClass5
TODBC5
TOKButton5
TObject5
TOpenFile5
TOption5
TOptionGroup5
TOutlook5
TOutlookMail5
TOWCSpread5
TPDF5
TPFKeys5
TPage5
TPassword5
TPicture5
TPing5
TPopupMenu5
TPowerpoint5
TPowerpoint5 Tutorial
TPrinter5
TProgress5
TProgressDlg5
TQuestion5
TRegistry5
TRegistryKey5
TResource5
TRichEdit5
TSPX5
TSQLDMO5
TScheduler5
TScroll5
TSelector5
TSpinner5
TSplitter5
TStatus5
TStopWatch5
TTest5
TTestError5
TTextFile5
TTimer5
TTip5
TTipForm5
TTLI5
TToolBar5
TToolbox5
TToolsMenu5
TTrackbar5
TTranslate5
TTree5
TVLine5
TViewMenu5
TWebBrowser5
TWebServer5
TWebSite5
TWebSiteNet5
TWinMenu5
TWord5
TYesNo5
    Visits:  5055 (27 on line) Last Update: Dec 5, 2003  
    TObject5    Printer Friendly  
 
Description   Inheritance   Example   Properties   Methods
 
 Description

The non visual TObject5 object is the parent of all other APL+Win Objects which inherit from him. Therefore you may call any TObject5 property or method from any other APL+Win Objects. TObject5 contains a lot of properties and methods of general interest. TObject5 is instanciated when you run the Classes5 function and its instance is named 'oo5'

Description   Inheritance   Example   Properties   Methods
 
 Inheritance

Inherits from:  

Description   Inheritance   Example   Properties   Methods
 
 Example
 

      'oo5'Świ'class'
TObject5

      80 TELPRINT ś'oo5'Świ'Properties'
apldir                  history                 ontop                 
apptitle                iever                   properties            
appversion              imethods                resources             
attach                  inifile                 spy                   
caption                 installdir              styles                
check                   ipaddress               suffix                
class                   iproperties             sysdir                
clipsiblings            just                    sysmenu               
connected               listseparator           version               
countries               methods                 visible               
country                 no3d                    wherelc               
cpuspeed                noattach                windir                
decimalseparator        objects                 windowsdir            
doc                     objectsver              winver                
handler                 objtitle                winversion            
handlersLES5dec03added  objver                                        
help                    objverno                                      

      80 TELPRINT ś'oo5'Świ'Methods'
A2R                 Files               NewObjects          ShowRedim         
APLCode             FindObjects         NewProperties       ShowTaskBar       
AddLF               FindWindow          Objects             SmgrHandles       
Ansi2Av             FixSystem           PaintDesktop        SsColumns         
ApplyStyleSheet     FlagRT              PrintForm           StyleSheet        
Av2Ansi             Flush               PrintPic            TempFile          
Bitmaps             FormToPic           Properties          TextSize          
Bitmaps2            FullName            Protect             TimeStamp         
C2W                 GetBitmapSize       Prtsc               Tutorial          
CaptureToPic        GetCommandLine      R2A                 Tutorials         
Center              GetComputerName     ReadToEnd           UnRegister        
CenterOn            GetDOSHandle        RecurseDirs         Undo              
ChStyle             GetDOSOutput        RecurseFiles        UseClientArea     
CheckSystem         GetFileData         Redim               UsedClasses       
Children            GetFileSize         RedimDemoShow       UsedClassesByObj  
ClipSiblings        GetFileTime         RedimShow           VT                
CountryIndex        GetHelp             RedimShowDemo       VTEach            
CreateDir           GetLastError        RedimWait           VT_Dispatch       
D2C                 GetUserName         Redo                VT_Variant        
DLLInfo             GridFile            Register            VV                
Dec2Hex             GridVersion         RegisterGrid        VVEach            
DecimalSeparator    Hash                RemoveComments      ValidId           
DemoShow            HelpFile            RemoveQuotes        W2C               
DemoShowFocus       Hex2Dec             Replace             W_CreateFilter    
DemoShowRedim       I2C                 ResetUndo           Wait              
Dir                 IsPrinterAvailable  ResetUndo           WaitRedim         
DirExist            IsProcessRunning    SaveUndo            WebBrowserClass   
Doc                 LastFns             ScreenCoord         WhwndOwner        
DocClass            ListSeparator       SearchPath          WsDir             
Dos2Ts              MailTo              SendKeys            XClass            
EditIni             MessagingProfile    SessionFocus        XClassLicense     
EnumChildWindows    Methods             SetFileTime         XInfoEx           
EnumFonts           MouseClick          ShellExecute        XLicense          
EnumWindows         MouseClickPos       Show                XMeth             
Events              MouseMove           ShowDemo            XMethods          
ExecuteSessionMenu  MoveLabel           ShowDemoFocus       XProp             
FOneClass           New                 ShowDemoRedim       XProperties       
FTimeRep            NewFeatures         ShowEvent                             
FileExist           NewFeaturesWeb      ShowFocus                             

      'ff'Świ'*Create' 'TForm5'('*caption' 'TObject5 Example')('ontop'1)('*size'200 300)'DemoShow' 'SessionFocus'
      'ff'Świ'*.ed.Create' 'TEdit5'('wherelc'Đ 100 Đ Đ)('caption' 'Sample Edit Control')
      'ff'Świ'?TextSize'
Compute size of one or more strings in pixels
Syntax:  sizes„'obj'Świ'TextSize'(texts){font}
texts: a character string or nested vector of character strings
font:  an optional font specified as:
      (fontname){(fontsize)(fontstyle)(fontcharset)}
sizes: a nested vector of (height width) sizes
Note: the API GetTextExtentPoint32 is defined as:
GetTextExtentPoint32=(HW,*C,L,>POINT) ALIAS GetTextExtentPoint32A

      'ff'Świ'TextSize'  'This is a rather long text'
 13 112 

      'ff'Świ'.ed.TextSize'  'This is a rather long text'('Arial'32 1)
 32 321 

      6†[1]'ff'Świ'EnumFonts'
      16 7 0 0 700 0 0 0 0 1 2 1 34 System   16 13 3 3 0 7 14 700 0 96 96 32 255 128 32 0 0 0 33 0  1 0 
  12 8 0 0 400 0 0 0 255 1 2 1 49 Terminal    12 10 2 0 0 8 8 400 0 72 96 1 254 32 32 0 0 0 48 255  1 0 
    15 8 0 0 400 0 0 0 0 1 2 1 49 Fixedsys    15 12 3 3 0 8 8 400 0 96 96 32 255 128 32 0 0 0 48 0  1 0 
    37 22 0 0 400 0 0 0 255 3 2 1 18 Roman   37 29 8 5 2 22 38 400 0 2 3 32 255 46 32 0 0 0 19 255  0 0 
   36 16 0 0 400 0 0 0 255 3 2 1 66 Script  36 24 12 4 2 17 32 400 0 2 3 32 255 46 32 0 0 0 67 255  0 0 
   37 19 0 0 400 0 0 0 255 3 2 1 50 Modern   37 29 8 5 2 20 35 400 0 2 3 32 255 46 32 0 0 0 51 255  0 0 

      6†[1]'oo5'Świ'EnumFonts'
      16 7 0 0 700 0 0 0 0 1 2 1 34 System   16 13 3 3 0 7 14 700 0 96 96 32 255 128 32 0 0 0 33 0  1 0 
  12 8 0 0 400 0 0 0 255 1 2 1 49 Terminal    12 10 2 0 0 8 8 400 0 72 96 1 254 32 32 0 0 0 48 255  1 0 
    15 8 0 0 400 0 0 0 0 1 2 1 49 Fixedsys    15 12 3 3 0 8 8 400 0 96 96 32 255 128 32 0 0 0 48 0  1 0 
    37 22 0 0 400 0 0 0 255 3 2 1 18 Roman   37 29 8 5 2 22 38 400 0 2 3 32 255 46 32 0 0 0 19 255  0 0 
   36 16 0 0 400 0 0 0 255 3 2 1 66 Script  36 24 12 4 2 17 32 400 0 2 3 32 255 46 32 0 0 0 67 255  0 0 
   37 19 0 0 400 0 0 0 255 3 2 1 50 Modern   37 29 8 5 2 20 35 400 0 2 3 32 255 46 32 0 0 0 51 255  0 0 
 
Description   Inheritance   Example   Properties   Methods
 
 Properties
 
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) 
Description   Inheritance   Example   Properties   Methods
 
 Methods
 
A2R    
Description:  Convert ranges from "A1" Excel notation to RC notation 
Syntax:  result„'obj' Świ 'A2R'range 
range:  a valid Excel range 
Examples: 
      'ff' Świ 'A2R' 'X44' 
44 24 
      'ff' Świ 'A2R' 'D16:IV12' 
16 4 12 256 
APLCode    
Description:  Retrieves property/method code for the specified property/method 
Syntax:  aplcode'obj' Świ 'APLCode'propertymethod 
    or:  aplcode'obj' Świ 'APLCode'object propertymethod  © LES11jun05 added 
object:  an object name                    © LES11jun05 added 
propertymethod: a property or method name 
aplcode:  APL code of the property or method 
Note: look for property or method code in object, then in object's parent, etc. 
Example: 
      'ff' Świ '*Create' 'TForm5' 
      'ff' Świ 'APLCode' 'ontop'             © this property is inherited from TObject5 
      'ff' Świ 'APLCode' 'Document'          © this is a TForm5 method 
      'oo5' Świ 'APLCode' 'TExcel5' 'Add'    © LES11jun05 added 
AddLF    
Description:  Add ŚTCLF after every ŚTCNL in text 
Syntax:  'obj' Świ 'AddLF'text 
text:  any character vector 
Ansi2Av    
Description:  Convert APL text from ANSI order to ŚAV order 
Syntax: avtext„'obj' Świ 'Ansi2Av'ansitext 
ansitext:  a character vector or nested vector of char vectors 
avtext:  a character vector or nested vector of char vectors 
Example: 
      'oo5' Świ 'Ansi2Av' "Int´rŠt port´ ¸ l'offre Haut D´bit" 
Intéręt porté ŕ l'offre Haut Débit 
      ˝Ś„'oo5' Świ 'Ansi2Av' 'Int´rŠt' 'Haut D´bit' 
Intéręt Haut Débit 
2 
ApplyStyleSheet    
Description:  Applies style sheet as defined at the form level 
Syntax:  'obj' Świ 'ApplyStyleSheet' 
Av2Ansi    
Description:  Convert APL text from ŚAV order to ANSI order 
Syntax: ansitext„'obj' Świ 'Av2Ansi'avtext 
avtext:  a character vector or nested vector of char vectors 
ansitext:  a character vector or nested vector of char vectors 
Example: 
      'oo5' Świ 'Av2Ansi' "Intéręt porté ŕ l'offre Haut Débit" 
Int´rŠt port´ ¸ l'offre Haut D´bit 
      ˝Ś„'oo5' Świ 'Av2Ansi' 'Intéręt' 'Haut Débit' 
Int´rŠt Haut D´bit 
2 
Bitmaps    
Description:  Displays a form showing all available bitmap images contained in BUTTONS.BMP (or variable buttons_bmp) 
Syntax:  'obj' Świ 'Bitmaps' {serie}          © ELE1apr05 {serie} added 
serie:  an integer (0 to 3)                © ELE1apr05 added 
Requires: (V) buttons_bmp 
Example: 
      'oo5' Świ 'Bitmaps' 
Bitmaps2    
Description:  Displays a form showing all available bitmap images contained in BUTTONS.BMP (or variable buttons_bmp) 
Syntax:  'obj' Świ 'Bitmaps2' {serie} 
serie:  an integer (0 to 3) 
Requires: (V) buttons2_bmp 
Example: 
      'oo5' Świ 'Bitmaps2' 
C2W    
Description:  Converts pairs of characters to words 
Syntax:  words„'obj' Świ 'C2W'charvaluepairs 
Example: 
      'oo5' Świ 'C2W' 'lescasse' 
25964 25459 29537 25971 
CaptureToPic    
Description:  Captures a visible form to a Picture object (example: 'CAPTURE.PIC') 
Syntax:  'obj' Świ 'CaptureToPic'formname{clipvalues} 
formname:  the name of an APL+Win form 
clipvalues: R,C,H,W (clipping coordinates in pixels relative to the form)[optional] 
            R and C are the row and column of the upper left corner of the clipping area 
            H and W are the height and width of the clipping area 
Notes: 
1. The form must be fully visible on the desktop and does not need to have the focus 
2. The point (0,0) is at the top left of the form including its borders 
This method: Copyright(c) 2002 Pierre Gilbert (Canada) published with his agreement 
Center    
Description:  Centers a TForm5 or TMDIForm5 on the screen 
Syntax:  'obj' Świ 'Center' {boolhorz{boolvert} 
    or:  'obj' Świ 'Center'formname 
boolhorz:  1=center horizontally, 0=dont 
boolvert:  1=center vertically, 0=dont 
formname:  a form name 
Example: 
      'ff' Świ '*Create' 'TForm5' ('*size'300 400) 'Center' '*Show' 
CenterOn    
Description:  Centers form specified in left argument upon form specified in right argument 
Syntax: 'obj' Świ 'CenterOn'object{vert horz} 
object: name of an object upon which Śwself must be centered 
vert:   vertical adjustment in pixels 
horz:   horizontal adjustment in pixels 
Example: 
      'ff' Świ '*Create' 'TForm' 'DemoShow' 
      'gg' Świ '*Create' 'TForm' ('*size'100 200) 
      'gg' Świ 'Show' 
      'gg' Świ 'ontop'1 
      'gg' Świ 'CenterOn' 'ff' 
ChStyle    
Description:  Changes the style for ŚWSELF by adding styles C 
Syntax:  {styles„'} 'obj' Świ 'ChStyle' {additionalstyles} 
additionalstyles:  a vector of style numbers (positive or negative) 
styles:  the current styles or previous styles if styles are replaced 
Positive styles are added to existing styles, negative ones are withdrawn 
Example: 
      'ff' Świ '*Create' 'TForm5' ('*size'300 400) 'DemoShow' 'SessionFocus' 
      'ff.ed1' Świ '*Create' 'TEdit5' ('*style'2 16 128) ('wherelc'Đ Đ '>' '>') 
      'ff.ed1' Świ 'ChStyle' 
2 16 128 
      'ff.ed1' Świ 'ChStyle'4 Ż16 64 4096 
      'ff.ed1' Świ 'ChStyle' 
2 4 64 128 4096 
CheckSystem    
Description:  Checks the current workspace 
Syntax:  'oo5' Świ 'CheckSystem' 
Note:  Requires APL+Win 5.x!               © ELE2nov05 0x 
Example: 
      'oo5' Świ 'CheckSystem' 
Children    
Description:  Returns all {specified} object children 
Syntax:  children„'obj' Świ 'Children' {instance} 
instance:  existing instance of an object 
children:  nested vector of object instance names 
Note:  result includes <instance> itself 
Examples: 
      'ff' Świ 'Children' 
      'oo5' Świ 'Children' '#' 
ClipSiblings    
Description:  Get or set the window WS_CLIPSIBLINGS style bit for a given list of Windows 
Syntax:  'obj' Świ 'ClipSiblings'boolean handles 
boolean: 0 or 1 
handles: one or more valid Window handles 
CountryIndex    
Description:  Return the index of the currently selected country 
Syntax:  countryindex„'obj' Świ 'CountryIndex' 
countryindex:  index of country within the list of available countries 
               for which translation is supported in APL+Win Objects 
CreateDir    
Description:  Creates a directory and all of its subdirectories (if necessary)  © ELE29aug05 added 
Syntax:  'obj' Świ 'CreateDir'dir 
dir:  full path name of directory to create 
Note: does not complain about already existing directories 
Example: 
      'oo5' Świ 'CreateDir' 'c:\temp\test\temp\test' 
      'oo5' Świ 'CreateDir' '\\tpprdsfi5\simpa06dev\aplwin52\fonts' 
D2C    
Description:  Convert double words to characters 
Syntax:  chars„'obj' Świ 'D2C'numeric 
numeric:  a integer array 
Example: 
      'oo5' Świ 'D2C' (1000) 
DLLInfo    
Description:  Return information on the specified file 
Syntax:  (version size date time)„'obj' Świ 'DLLInfo'filename 
filename:  a complete DOS file name 
version:  an integer vector 
size:  the file size in bytes 
date:  the file date in YYYYMMDD format 
time:  the file time in HHMMSS format 
Example: 
      'oo5' Świ 'DLLInfo' '\\tpprdsfi5\simpa04dev\aplwin40\aplgrid.dll' 
Inspired from APL2000 DllInfo utility (Copyright 1996-1999 APL2000) 
Dec2Hex    
Description:  Converts base 10 numbers to hexadecimal numbers 
Syntax:  hexa„'obj' Świ 'Dec2Hex'decimal 
decimal:  an array of integer numbers 
Example: 
      'oo5' Świ 'Dec2Hex' (Ľ10) 
DecimalSeparator    
Description:  Return the current default WIndows Decimal Separator 
Syntax:  'obj' Świ 'DecimalSeparator' 
Example: 
      'oo5' Świ 'DecimalSeparator' 
DemoShow    
Description:  Displays the APL Window ontop in the top rightcorner of the screen 
Syntax:  'obj' Świ 'DemoShow' 
DemoShowFocus    
Description:  Displays the APL Window ontop in the top rightcorner of the screen 
and returns focusto the APL session 
Syntax:  'obj' Świ 'DemoShowFocus' 
DemoShowRedim    
Description:  Displays the APL Window ontop in the top rightcorner of the screen 
Syntax:  'obj' Świ 'DemoShowRedim' {boolean} 
boolean:  1(default)=leave a right and bottom margin  0=no right and bottom margins 
Example: 
      'ff' Świ 'RedimDemoShow' 
Dir    
Description:  Similar to the DOS dir command 
Syntax:  files'obj' Świ 'Dir'filespec{dir} 
filespec: a character string representing file specifications 
          wildcards * and ? may be used 
          may include sort information (optionnally followed by <desc>): 
          /n=sort by name 
          /d=sort by date 
          /t=sort by time 
          /s=sort by size 
dir:  1=get information about the directory or file specified, 0(default)=information about its content 
files:  a 5-column nested array containing 
        [;1]  filename.ext 
        [;2]  filedates (YYYYMMDD) 
        [;3]  filetimes (HHMMSS) 
        [;4]  filesizes (in bytes) 
        [;5]  1=directory 0=file 
Example: 
      'oo5' Świ 'Dir' 'c:\aplwin50' 
      'oo5' Świ 'Dir' 'c:\aplwin50'1 
      'oo5' Świ 'Dir' 'c:\aplwin50\*.*' 
      'oo5' Świ 'Dir' 'c:\aplwin40 /d desc /s' 
DirExist    
Description:  Checks if a DOS directory exists 
Syntax:  'obj' Świ 'DirExist'dir 
dir:  directory path 
Example: 
      'oo5' Świ 'DirExist' 'C:\temp' 
Doc    
Description:  Returns documentation for all properties and methods for the specified object 
Syntax:  'obj' Świ 'Doc'type 
type: one of: 
      'properties'  (return documentation for properties only) 
      'methods'     (return documentation for methods only) 
Example: 
      'ff' Świ '*Create' 'TForm5' 
      'ff' Świ 'Doc' 
DocClass    
Description:  Document all properties and methods for specified user defined class 
Syntax:  'obj' Świ 'DocClass' classname' 
classname:  a member of '#' Świ 'newclasses' 
Example: 
      'oo5' Świ 'DocClass' 'TCheck5' 
Dos2Ts    
Description:  Converts DOS-directory-style file timestamps to ŚTS format 
Syntax:  ts„'obj' Świ 'Dos2Ts'dosdates 
dosdates: a 2-column numeric matrix of dates, times 
ts:  a matrix of timestamps in ŚTS format 
Notes: 
The argument may have any shape preceding a last dimension of length 2. 
The two levels of the last dimension are 1=date, 2=time. 
The result has shape (Ż1˝A),6, with each vector along the last 
coordinate being a ŚTS-style date and time stamp. 
Internal sub-method used by method <Dir> 
EditIni    
Description:  Allows to edit the application .INI file from the APL Session 
Syntax:  'obj' Świ 'EditIni' 
Note: if UltraEdit is installed on this computer, UltraEdit is used 
to edit the .INI file, otherwise Notepad is used 
Example: 
      'oo5' Świ 'EditIni' 
EnumChildWindows    
Description:  Enumerate the children of a given window 
Syntax:  result„'obj' Świ 'EnumChildWindows' {window}" 
window:  a window handle (if numeric) or a window name (if character)" 
result:  a 4-column matrix of (child handle) (child id) (child class) (child text)" 
Example: 
      'ff' Świ '*Create' 'TForm5' ('*size'300 400) 'DemoShow' 'SessionFocus' 
      'ff.ed1' Świ '*Create' 'TEdit5' ('wherelc'Đ(100'>' 'Name')Đ 200) 
      'ff.ed2' Świ '*Create' 'TEdit5' ('wherelc' '>' ('=' '>' 'First Name') '=' '=') 
      'ff.ed3' Świ '*Create' 'TEdit5' ('wherelc' '>' ('=' '>' 'Address') '=' '=') 
      ]display 'ff' Świ 'EnumChildWindows' 'ff' 
.…--------------------------------. 
‡             .…---.  .´.         | 
| 4654304  18 |Edit|  | |         | 
|             '----'  '-'         | 
|             .…-----..…---.      | 
| 6096170  19 |Static||Name|      | 
|             '------''----'      | 
|             .…---.  .´.         | 
| 5375310  20 |Edit|  | |         | 
|             '----'  '-'         | 
|             .…-----..…---------.| 
| 3212590  21 |Static||First Name|| 
|             '------''----------'| 
|             .…---.  .´.         | 
| 1443376  22 |Edit|  | |         | 
|             '----'  '-'         | 
|             .…-----..…------.   | 
| 1312126  23 |Static||Address|   | 
|             '------''-------'   | 
'ą--------------------------------' 
EnumFonts    
Description:  Enumerate fonts or fonts containing <facename> 
Syntax:  fonts„'obj' Świ 'EnumFonts' {facename} 
facename:  (optional) font name 
fonts:  a 4-column matrix (as produced by the Windows EnumFontsProc function): 
        a LOGFONT structure, a TEXTMETRIC structure, font type, 0 
Note: Use a specific facename (from among list returned by 
'obj' Świ 'EnumFonts') to find all sizes in a particular family. 
Example: 
      'oo5' Świ 'EnumFonts' 'Arial' 
*:Śerror (^\Śdm¬Śtcnl)/Śdm} 
*:Śerror (^\Śdm¬Śtcnl)/Śdm} 
EnumWindows    
Description:  Enumerate all top level Windows 
Syntax:  matrix'obj' Świ 'EnumWindows' 
matrix:  a nested matrix with: 
         matrix[;1]  window handles 
         matrix[;2]  window captions 
Note: any window with no caption is omitted 
Example: 
      'oo5' Świ 'EnumWindows' 
Events    
Description:  Returns all User Defined Object events 
Syntax:  events„'obj' Świ 'Events' {substring} 
substring:  substring to be contained in event names 
events:  nested vector of event names 
Note: result elements are event label names in Object functions 
Example: 
      'oo5' Świ 'Events' 
ExecuteSessionMenu    
Description:  Programmatically fires an APL Session menu item 
Syntax:  'obj' Świ 'ExecuteSessionMenu'menu menuitem 
menu:  menu number in origin 1 (starting with 1=File & ending with 9=File) 
menuitem:  menu item number in origin 1 
Example: 
      'oo5' Świ 'ExecuteSessionMenu'8 4      © programmatically does Window / Tile Horizontal 
FOneClass    
Description:  Returns the Formula One classId and license number 
Syntax:  clsidlic„'obj' Świ 'FOneClass' 
clsidlic:  the Formula One 6.1 (or 6.0 or 5.0) classId and License key 
       or  '' if Formula One not installed on this computer 
Example: 
     'oo5' Świ 'FOneClass' 
{B0475003-7740-11D1-BDC3-0020AF9F8E6E}B0475049-7740-11d1-BDC3-0020AF9F8E6E 
ŚWI CREATION: 'tempform' Świ 'Delete' Ş Śwres„'' Ş …0}  © try to create Formula One OCX instance 
FTimeRep    
Description:  Decodes dates such as Śwsts to Śts format 
Syntax:  'obj' Świ 'FTimeRep'date 
date:  a date expressed in number of microseconds since 00:00 on 1 January 1900 
ts:  a timestamp expressed in Śts format 
Example: 
      'oo5' Świ 'FTimeRep' Śwsts 
FileExist    
Description:  Check if a file exists (supports long file names and UNC names) 
Syntax:  boolean„'obj' Świ 'FileExist'dirfilename 
dirfilename: fully qualified directory or file name (with path) 
boolean:  1=dir/file exists, 0=it doesn't exist 
Example: 
      'oo5' Świ 'FileExist' 'c:\temp' 
      'oo5' Świ 'FileExist' 'c:\temp\aplw.exe' 
Copyright 1996 APL2000, Inc. 
Files    
Description:  Return list of files in current directory, matching specified string 
Syntax:  'obj' Świ 'Files' string {attr} {flag} 
attr: (optional) 
      FILE_ATTRIBUTE_READONLY1 
      FILE_ATTRIBUTE_HIDDEN2 
      FILE_ATTRIBUTE_SYSTEM4 
      FILE_ATTRIBUTE_DIRECTORY16 
      FILE_ATTRIBUTE_ARCHIVE32 
      FILE_ATTRIBUTE_NORMAL128 
      FILE_ATTRIBUTE_TEMPORARY256 
      FILE_ATTRIBUTE