| wxautomation1 | ||
|---|---|---|
 | Chapter 11. The wxWidgets-based (WXWN) Components |  |
wxautomation1
Description
A wxautomation1 object provides access to OLE2 automation for Windows™ applications. All automation code is sent as string data to the target program.
Type Tags
None
Object Value
wxautomation1.new()
Description
Creates a new wxstatusbar object.
Prototype
wxautomation1.new (
string createinstancegetinstanceerror
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| createinstance | .nul | string | This parameter must be named. Use it to create a new instance of the OLE2 out of process server, for use in the code. |
| getinstance | .nul | string | This parameter must be named. Use it to get access to an already existing instance of the OLE2 out of process server, for use in the code. |
| error | .nul | integer |
Specifies an object which is used to output any error code generated during
creation of the wxautomation1 object. If
error is not specified or is
.nul then any error which occurs during object
creation will halt the program. If an error object is specified and
an error occurs during object creation then the error code is
output into that object and the new methods
returns .nul.
|
Properties
| Property | Type | Description |
|---|---|---|
| _ | type(*) | This property is provided for use by the user to attach any object of any type to the type in which this property is provided. |
| __ | type(*) | This property is provided for use by the user to attach any object of any type to the type in which this property is provided. It has the additional feature of being marked with the resolve keyword, so that object resolution can continue down this property. |
| type | type | Specifies the wxautomation1 type object. |
Methods
callmethod()
Description
Calls the specified method of the associated automation object.
Prototype
wxautomation1var.callmethod (
string methoderror…
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| method | .nul | string | A string containing the name of the method to be called. |
| error | .nul | integer |
Specifies an object which is used to output any error code generated during
the execution of the function. If error is not
specified or is .nul then any error which
occurs during function execution will halt the program. If an
error object is specified and an error occurs during function
execution then the error code is output into that object and the
methods returns .nul.
|
| … | .nul | type(=) | This will be a parameter being passed to the method. Any number of these can be included as unnamed parameters. |
getobject()
Description
Retrieves a property of an automation object as a new automation object.
Prototype
wxautomation1var.getobject (
string propertyerror…
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| property | .nul | string | A string containing the name of the property from which a new automation object should be retrieved. |
| error | .nul | integer |
Specifies an object which is used to output any error code generated during
the execution of the function. If error is not
specified or is .nul then any error which
occurs during function execution will halt the program. If an
error object is specified and an error occurs during function
execution then the error code is output into that object and the
methods returns .nul.
|
| … | .nul | type(=) | This will be a parameter being passed to the help define the object that is being retrieved. Any number of these can be included as unnamed parameters. |
getproperty()
Description
Retrieves the named property value from the automation object.
Prototype
wxautomation1var.getproperty (
string propertyerror…
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| property | .nul | string | A string containing the name of the property to be retrieved. |
| error | .nul | integer |
Specifies an object which is used to output any error code generated during
the execution of the function. If error is not
specified or is .nul then any error which
occurs during function execution will halt the program. If an
error object is specified and an error occurs during function
execution then the error code is output into that object and the
methods returns .nul.
|
| … | .nul | type(=) | This will be a parameter being passed to help define from where to retrieve the value. Any number of these can be included as unnamed parameters. |
putproperty()
Description
Assigns the value passed into the target property of the associated automation object.
Prototype
wxautomation1var.putproperty (
string propertyerror…
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| property | .nul | string | A string containing the name of the property to be assigned. |
| error | .nul | integer |
Specifies an object which is used to output any error code generated during
the execution of the function. If error is not
specified or is .nul then any error which
occurs during function execution will halt the program. If an
error object is specified and an error occurs during function
execution then the error code is output into that object and the
methods returns .nul.
|
| … | .nul | type(=) | This will be a parameter being passed to help define where to assign the value. Any number of these can be included as unnamed parameters. |