Click or drag to resize

BasicNoUIObjAddExtensionObjectWithEvents Method

Extends the WWB.NET language using any .NET object. The events fired by this object can be handled by the appropriate module.

Namespace: WinWrap.Basic.Server
Assembly: WinWrap.Basic.Server (in WinWrap.Basic.Server.dll)
Syntax
Copy
public bool AddExtensionObjectWithEvents(
	string name,
	Object extObj
)

Parameters

name  String
This string value defines the name of the object added to the macro language. The name string consists of two parts, one of which is optional:

[modulepath|]name (see table below).

extObj  Object
Extend the WWB.NET Language with this object.

Return Value

Boolean
True if AddExtensionObjectWithEvents is successful.

Implements

IBasicNoUIAddExtensionObjectWithEvents(String, Object)
Remarks
Important: Language extensions must be added before executing or loading the code that will depend on the extensions.

Use AddSafeReference, AddScriptabeReference or AddReference to add the extension object's type before making this call.

name parameter:
Part Description
modulepath Extensions are specific to modulepath only. If modulepath is a null string, FileName is used. (The string "|..." is the same as prefixing the string with FileName.)
name extObj is accessible as a language extension with this name. All of its methods and properties are accessible via name.method or name.property. The events are defined as name_event. If name is "" then all of the methods and properties are accessible directly as method or property.

Macro/Module Paths

Macro/module paths are typically file paths. However, it is sometimes useful to work with macros/modules that are not stored as files. A macro/module path is of the form:

C#
Copy
[*[*]]path[*]
Part Description
'*' Paths that being with '*' are non-file system macro/modules. The application provides the methods for reading and writing these files. Paths that begin and end with '*' are hidden from the IDE. User's can't step into or otherwise inspect the contents.
'**' Paths that begin with '**' are non-file system modules. The application provides the methods for reading and writing these files. Running an event-driven module loads it using LoadModule.
path This is the identity of the macro/module.

Example
Sample extensions:
See Also