Introduction

Overview

Installation

Components

TawScriptControl

TawScriptEditor

TawScriptErrorDlg

Other Classes

TawScriptError

TawAutoObjects

TawAutoObject

• TawScriptControl
• TawScriptEditor
• TawScriptErrorDlg

1. Run Delphi and choose File|Close All.
2. Choose File|Open and open the awScript.dpk file for the appropriate version of Delphi you are running. This file will be located in either the d3/, d4/, d5/, or d6/ directory wherever you installed the Script Components files.
3. Push the compile button. This will compile the components and install them in the Delphi IDE under a tab called "AW Controls".
4. Close awScript.dpk and save changes.

TawScriptControlErrorEvent = procedure (Sender: TObject;
  Error: TawScriptError) of object;
TawScriptControl = class(TComponent)
public
  constructor Create(AOwner: TComponent); override;
  destructor Destroy; override;
  function CallFunction(const FunctionName: string;
    const Params: array of Variant): OleVariant;
  procedure Clear;
  property ActiveXScriptControl: TScriptControl;
published
  property AllowUI: boolean;
  property AutoObjects: TawAutoObjects;
  property Code: TStrings;
  property Language: string;
  property Timeout: integer;
  property OnError: TawScriptControlErrorEvent;
  property OnTimeout: TNotifyEvent;
  property OnCallFunction: TawScriptControlCallEvent;
end;

function CallFunction(const FunctionName: string;
    const Params: array of Variant): string;

CallFunction will run the procedure in the script with the name specified by FunctionName. Any values in the Params array will be passed to this procedure as it's parameters.

function Clear;

Clears the Code and AutoObjects properties.

property ActiveXScriptControl: TScriptControl;

This property gives direct access to the underlying ActiveX Script Control. For advanced users.

property AllowUI: boolean;

Corresponds to the AllowUI property of the Microsoft Script Control. It specifies whether a script, or the Script Control, is allowed to display user-interface elements, such as dialog boxes.

property AutoObjects: TawAutoObjects;

AutoObjects is used to specify a collection of OLE Automation objects that are accessible from the scripting engine. When adding or changing the contents of AutoObjects, it's BeginUpdate and EndUpdate methods should be used. Call BeginUpdate before making changes and EndUpdate once the changes are finished.

property Code: TStrings;

Code contains the actual script code. A procedure must be specified in the code before using the CallFunction method.

property Language: string;

Language specifies what language the script code is written in.

property Timeout: integer;

Corresponds to the Timeout property of the Microsoft Script Control. It specifies the time, in milliseconds, after which a user is presented with the option to discontinue scripting code execution.

property OnError: TawScriptControlErrorEvent;

This event is triggered whenever an error occurs during execution of a script. A TawScriptError object is passed to this event giving details of the error.

property OnTimeout: TNotifyEvent;

This event is triggered when the time specified in the Timeout property has elapsed and a user has selected End in the resulting dialog box.

property OnCallFunction: TawScriptControlCallEvent;

This event is triggered whenever the CallFunction method is run. The paramters to CallFunction are passed to the event.

With the Language set to 'JScript' and the code set to:

function main(msg)
{
  return msg;
}

The following code will then run this function:

var
  l_res: string;
.
.
.
l_res := ScriptControl.CallFunction('main', ['Hello world!']);
ShowMessage(l_res);

TawScriptEditor = class(TComponent)
public
  constructor Create(AOwner: TComponent); override;
  destructor Destroy; override;
  procedure Show;
  function ShowModal: integer; 
  property IsOpen: boolean;
published
  property Caption: string;
  property Code: TStrings;
  property EditorFont: TFont;
  property Font: TFont;
  property Height: integer;
  property Language: string;
  property Width: integer;
  property OnChange: TNotifyEvent;
end;

procedure Show;

Show will display the editor, but it will not be modal. When the editor is closed, the OnChange event will trigger if any changes have been made. The IsOpen property is also useful when the editor is not modal.

function ShowModal: integer;

ShowModal displays the editor as a modal form. When the editor is closed, this function returns with a ModalResult. If changes have been made, it returns mrOK, otherwise mrCancel. The OnChange event will also be triggered if changes have been made.

property IsOpen: boolean;

If the editor window is open, IsOpen will be True, otherwise it is False.

property Caption: string;

Caption determines the caption that appears in the title bar of the editor.

property Code: TStrings;

Code contains the actual script code for the editor. Set this before opening to default the code. Read it after the editor has closed to retrieve the new value.

property EditorFont: TFont;

This specifies the font to be used for the editing area of the editor.

property Font: TFont;

This specifies the font to be used for the whole editor window, except the actual editing area.

property Height: integer;

The height in pixels of the editor window.

property Language: string;

This contains the language that the script is written in. Set this before opening to default the language. Read it after the editor has closed to retrieve the new language.

property Width: integer;

The width in pixels of the editor window.

property OnChange: TNotifyEvent;

This event is triggered whenever the editor window is closed and the code or language have been changed.

// a button click which opens the script editor
procedure TForm1.EditButtonClick(Sender: TObject);
begin
  ScriptEditor.Code := ScriptControl.Code;
  ScriptEditor.Language := ScriptControl.Language;
  if ScriptEditor.ShowModal = mrOK then
  begin
    ScriptControl.Code := ScriptEditor.Code;
    ScriptControl.Language := ScriptEditor.Language;
  end;
end;

TawScriptErrorIcon = (eiInfo, eiError);
TawScriptErrorDlg = class(TComponent)
public
  constructor Create(AOwner: TComponent); override;
  destructor Destroy; override;
  procedure ShowModalMsg(Msg: string; Icon: TawScriptErrorIcon);
  procedure ShowModalError(Error: TawScriptError);
published
  property Caption: string;
  property ErrorFont: TFont;
  property Font: TFont;
  property Height: integer;
  property Width: integer;
end;

procedure ShowModalMsg(Msg: string; Icon: TawScriptErrorIcon);

ShowModalMsg will display the dialog as a modal form. The Msg parameter will be displayed in the message area of the dialog and the Icon parameter determines which icon is displayed in the top left corner.

procedure ShowModalError(Error: TawScriptError);

ShowModalError is displays the dialog as a modal form. The message are will contain a formatted error message based on the Error parameter passed to it. It will also display the eiError icon.

property Caption: string;

Caption determines the caption that appears in the title bar of the dialog box.

property ErrorFont: TFont;

ErrorForm determines what font is used in the message area of the dialog box.

property Font: TFont;

This specifies the font to be used for the whole dialog box, except the message area.

property Height: integer;

The height in pixels of the dialog box.

property Width: integer;

The width in pixels of the dialog box.

// OnError handler for a ScriptControl
procedure TForm1.ScriptControlError(Error: TawScriptError);
begin
  ScriptErrorDlg.ShowModalError(Error);
end;

// example of using ShowModalMsg
ScriptErrorDlg.ShowModalMsg('This is a sample message', eiInfo);

TawScriptError = class(TObject)
public
  property Column: Integer;
  property Description: WideString;
  property HelpContext: Integer;
  property HelpFile: WideString;
  property Line: Integer;
  property Number: Integer;
  property Source: WideString;
  property Text: WideString;
end;

TawAutoObjects = class(TCollection)
public
  function Add: TawAutoObject;
  property Items[Index: Integer]: TawAutoObject; default;
end;

var
  AutoObjectItem: TawAutoObject;
  SampleAutoObj: TSampleScriptableObj;
.
.
.
// create the auto object
SampleAutoObj := TSampleScriptableObj.Create;

// update the AutoObjects collection
ScriptControl.AutoObjects.BeginUpdate;
AutoObjectItem := ScriptControl.AutoObjects.Add;
AutoObjectItem.AutoObjectName := 'sobj';          // setup the new item
AutoObjectItem.AutoObject := SampleAutoObj;       //
ScriptControl.AutoObjects.EndUpdate;

TawAutoObject = class(TCollectionItem)
public
  property AutoObject: IDispatch;
published
  property AutoObjectName: string;
end;