home *** CD-ROM | disk | FTP | other *** search
/ PC World 2001 February / PCWorld_2001-02_cd.bin / Software / Vyzkuste / visirc / axscript.txt next >
Text File  |  1997-09-01  |  3KB  |  98 lines
  1. ActiveX Scripting Documentation (for Visual IRC '97 1.00 and above) - Revision 2
  2. ================================================================================
  3.  
  4. ViRC '97 1.00rc2 and above support ActiveX scripting, which means that you can
  5. mix VBScript and JavaScript code within your ViRCScript code. This is an
  6. extremely powerful feature seen in no other IRC client which allows you to use
  7. multiple scripting languages at once to achieve the best result.
  8.  
  9. 1.00rc3 and above allow additional Active Scripting language DLLs to be
  10. installed via the Client setup/Active scripting page. This effectively allows
  11. any language to be used, not just VBScript and JavaScript.
  12.  
  13. This document is not intended as an introduction to the VBScript or JavaScript
  14. scripting languages. Books intended for this purpose can be purchased from your
  15. favourite computer bookshop.
  16.  
  17. ActiveX scripting is controlled by the new LANGUAGE statement.
  18.  
  19. LANGUAGE statement
  20. ------------------
  21.  
  22. Usage:  Language VBScript
  23.           ...
  24.         EndLanguage
  25.  
  26.         Language JavaScript
  27.           ...
  28.         EndLanguage
  29.  
  30. In the ... code block, VBScript or JavaScript code can be inserted as desired.
  31.  
  32. There is, of course, a mechanism provided for VBScript and JavaScript code to
  33. examine ViRCScript variables, execute ViRCScript statements, and so forth. This
  34. is accomplished through the special ViRCScript object which is available to
  35. VBScript and JavaScript code. The methods it supports are detailed below.
  36.  
  37. ViRCScript.GetVar method
  38. ------------------------
  39.  
  40. Usage (VBScript):       x = ViRCScript.GetVar("$variable")
  41. Usage (JavaScript):     x = ViRCScript.GetVar("$variable");
  42.  
  43. Returns the contents of the ViRCScript variable $variable.
  44.  
  45. ViRCScript.SetVar method
  46. ------------------------
  47.  
  48. Usage (VBScript):       ViRCScript.SetVar "$variable", "value"
  49. Usage (JavaScript):     ViRCScript.SetVar("$variable", "value");
  50.  
  51. Sets the value of the ViRCScript variable $variable to value.
  52.  
  53. ViRCScript.Parse method
  54. -----------------------
  55.  
  56. Usage (VBScript):       x = ViRCScript.Parse("expression")
  57. Usage (JavaScript):     x = ViRCScript.Parse("expression");
  58.  
  59. Fully evaluates expression, which can contain ViRCScript variables and
  60. functions, and returns the evaluated expression.
  61.  
  62. ViRCScript.Execute method
  63. -------------------------
  64.  
  65. Usage (VBScript):       ViRCScript.Execute "command"
  66. Usage (JavaScript):     ViRCScript.Execute("command");
  67.  
  68. Executes the ViRCScript command command. This allows VBScript and JavaScript
  69. code to execute regular ViRCScript statements. For example, this code will
  70. sum all the numbers from 1 to 1000 and display the result in a standard
  71. ViRCScript message box:
  72.  
  73. Language JavaScript
  74.   var j = 0;
  75.   for (i = 1; i <= 1000; i++)
  76.     j += i;
  77.   ViRCScript.Execute("MessageBox " + j);
  78. EndLanguage
  79.  
  80. The same code could be expressed in VBScript as:
  81.  
  82. Language VBScript
  83.   j = 0
  84.   For i = 1 To 1000
  85.     j = j + i
  86.   Next
  87.   ViRCScript.Execute "MessageBox " & j
  88. EndLanguage
  89.  
  90. It could be coded in ViRCScript as the following (note the similarily to the
  91. JavaScript code):
  92.  
  93. @ $j = 0
  94. for (@ $i = 1; $i <= 1000; $i++)
  95.   $j += $i
  96. endfor
  97. MessageBox $j
  98.