Index...
Centrallix Documentation
|
widget/execmethod
execmethod :: A nonvisual widget which can call ObjectSystem methods on server objects.
Metadata:
type: | widget/execmethod |
visual: | no |
container: | no |
form element: | no |
Overview:
The execmethod widget is a nonvisual widget which is used to call ObjectSystem methods on objects on the server.This widget may become deprecated in the future when more advanced OSML API widgets become available.
These widgets are used via the activation of their "ExecuteMethod" action.
Usage:
The execmethod widget, since it is nonvisual, can be placed almost anywhere but is typically placed at the top-level (within an object of type "widget/page") for clarity's sake. It has no effect on its container.These widgets cannot contain visual widgets, and since they have no Events, normally contain no connector widgets either.
Properties:
Property | Type | Description |
method |
string |
The name of the method to invoke. |
object |
string |
The ObjectSystem pathname of the object on which the method is to be run. |
parameter |
string |
A string parameter to pass to the method being invoked. |
Actions:
Action | Description |
ExecuteMethod |
action causes the widget to execute the method on the server. It can take three parameters, which default to those provided in this widget's properties: "Objname", the object path, "Method", the method to invoke, and "Parameter", the parameter to pass to the method being invoked. |
Sample Code:
$Version=2$
// This execmethod widget is set up to play a sound file (on the server).
mySoundPlayer "widget/execmethod"
{
object = "/sys/ossdsp.aud";
method = "Play";
parameter = "/data/Welcome.wav";
}
Comments...
(none yet)
Add a Comment...
|