Microsoft KB Archive/185697

= How To Use the AddObject Method of the Script Control =

Article ID: 185697

Article Last Modified on 8/27/2007

-

APPLIES TO


 * Microsoft Visual Basic 5.0 Learning Edition
 * Microsoft Visual Basic 6.0 Learning Edition
 * Microsoft Visual Basic 5.0 Professional Edition
 * Microsoft Visual Basic 6.0 Professional Edition
 * Microsoft Visual Basic 5.0 Enterprise Edition
 * Microsoft Visual Basic 6.0 Enterprise Edition
 * Microsoft Visual Basic 4.0 Standard Edition
 * Microsoft Visual Basic 4.0 Professional Edition
 * Microsoft Visual Basic 4.0 32-Bit Enterprise Edition
 * Microsoft Visual Basic for Applications 5.0

-



This article was previously published under Q185697



SUMMARY
This article describes the AddObject method of the Microsoft Script control and discusses object visibility.



MORE INFORMATION
The Microsoft Scripting control provides the AddObject method to allow the host application to expose an object model to the script code. Objects added this way are implicitly assumed to be safe for scripting and are not affected by the UseSafeSubset property.

The AddObject method has the following arguments:

  Name:        The name the script code can use to access the object.

Object:     The object to be made available (late bound) to the script.

AddMembers: This is an optional argument. Default value is False.

If True, the methods and properties are available as               global functions and variables.

If False, the methods and properties are only available via fully qualified object.member syntax.

Microsoft provides programming examples for illustration only, without warranty either expressed or implied, including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose. This article assumes that you are familiar with the programming language being demonstrated and the tools used to create and debug procedures.

Example
 In Visual Basic or Microsoft Access, create a new project and add the following component:

Microsoft Script Control 1.0 Add the Script control (ScriptControl1), a text box (Text1), and a command button (Command1) to a form. In Visual Basic, set the MultiLine property of the text box to TRUE. For ease of use change the size of Text1 so that it accommodates five (5) 60 character lines.  Add a Class module (clsLog) with the following code: Public Sub Prt (S) Debug.Print S     End Sub

  Add the following code to Form1: Private Sub Command1_Click Dim L as clsLog Set L = New clsLog With ScriptControl1 .Language = "VBScript" .AllowUI = True .AddObject "LoadLog", L, True ' True = expose Prt as global Sub ' "Loadlog" is executed immediately when Addcode loads the code. Debug.Print "Adding the code" .AddCode Text1.Text Debug.Print "Finished adding the code" .AddObject "RunLog", L         .Run "Test" End With End Sub

 Run the form and open the Debug window.  Type the following script into the text box: Sub Test RunLog.Prt "RunLog is available after Load" Prt "LoadLog exposes Prt as a global method" End Sub LoadLog.Prt "LoadLog is available during Load"

</li> Click the command button. You will get the following output:

Adding the code

LoadLog is available during Load

Finished adding the code

RunLog is available after Load

LoadLog exposes Prt as a global method</li></ol>

<div class="references_section">