The textual language contains a number of predefined methods that are available for certain objects.
Returns the object's height.
Returns the object's width.
Returns the x coordinate of the object's location.
Returns the y coordinate of the object's location.
Sets the object's height.
void setLocation(int x, int y)
Sets the object's location.
Changes the visiblity of the object.
Sets the object's width.
Returns the current RGB value of the fill color.
Not meaningful for lines and splines.
Returns the current RGB value of the pen color.
Returns the current pen style. See setPenStyle for details.
Returns the current pen width.
void setFillColor(int RGBColor)
Sets the fill color.
Not meaningful for lines and splines.
void setPenColor(int RGBColor)
Sets the pen color.
void setPenStyle(int RGBColor)
Sets the pen style. Legal values are 0 - No Pen, 65535 - Solid Pen, 1 - Dashed Pen, 2 - Dotted Pen, 3 - Dash Dot Pen, and 4 - Dash Dot Dot Pen.
Sets the pen width.
Adds a message at the end of the browser.
void addItem(int index, string message)
Inserts a message at the given index.
Deletes all messages.
Returns the current fill color.
Returns the current font face name.
Returns the message at the given index.
Returns the number of messages.
Returns the index of the currently selected item. Returns -1 if no item is selected.
Returns the selected message. Returns the empty string if no item is selected.
Returns the current text color.
Returns the current font size.
Returns true if the bold property is set.
Removes the item at the given index.
Sets the bold property.
Sets the fill color.
Sets the font face name.
void setItem(int index, string newMessage)
Replaces the message at the given index.
Sets the text color.
Sets the font size.
Writes all messages to the file path in reversed order.
Returns the x coordinate of the indexth point.
Returns the y coordinate of the indexth point.
void setPoint(int index, int x-coord, int y-coord)
Moves the indexth point to a new position.
Writes the text string to the terminal.
Returns the current RGB value of the background color.
Returns the current font size.
Returns the text string.
Returns the current RGB value of the text color.
Changes the background color.
Changes the font size.
Changes the text string.
void setTextColor(int RGBColor)
Changes the text color.
listtype below is the type of the values in the list, e.g. for a Boolean List it is bool.
Adds an element at the end of the list.
void add(int position, listtype val)
Adds an element at the specified position in the list. The first element in the list corresponds to position 0.
Adds an element at the beginning of the list.
Append other at the end of the list.
Empties the list.
Returns true if the list contains an element equal to value, false otherwise.
Returns the value at the given position.
Returns the index of the first occurrence of value in the list. Returns -1 if the value is not found.
Returns true if the list is empty, false otherwise.
Removes the value at the given position from the list.
void set(int position, listtype value)
Sets a new value for the element at the given position.
Returns the number of elements in the list.
Returns true if Automatic Update is enabled.
Turns Automatic Update on or off.
Returns the color of the workspace.
Hides the workspace.
void setWorkspaceColor(int color)
Set the color of the workspace.
Shows the workspace.
void showWorkspace(int x, int y)
Shows the workspace at a specific location.
Returns the scan cycle time of the workspace in milliseconds. Works on top-level workspaces and workspace objects. See also the function getTickTime() which works on all workspaces.
Trigger a sampling of all digital and analog inputs in the application that are not cyclically updated. Only works for top-level workspaces.
For XML Message In the values are those of the most recently received message. For XML Message Out it is the currently configured values.
Returns the handle.
Returns the MustReply attribute.
Returns the origin (the sender).
Returns the CCOM type.
XML Message In: Returns the XML string of the most recently received message including the CCOM envelope.
XML Message Out: Generates a new XML message string excluding the CCOM envelope and returns it.
Returns the value of the topic/destination attribute. The same as getTopic.
Returns the value publish/send attribute. True means publish.
Returns the handle assigned to the most recent message being sent.
Returns the value of the topic/destination attribute. The same as getDestination().
Equivalent either to sendMessage or publishMessage depending on the value of the publish attribute.
Publishes the message under the topic given by the topic/destination attribute.
Sends the message to the destination given by the topic/destination attribute.
void setDestination(string value)
Sets the value of the topic/destination attribute. The same as setTopic().
Sets the value of the Handle attribute.
void setMustReply(string value)
Sets the value of the MustReply attribute.
Sets the value of the Origin attribute.
Sets the value of the publish/send attribute. True means publish.
Sets the value of the topic/destination attribute. The same as setDestination().
Sets the value of the Type attribute.
Triggers sampling of an input. The read value is returned. Digital inputs return 1.0 if true and 0.0 if false. Available for inputs.
Sets the enabled flag for a workspace object. Available for Workspace Objects.
Deletes the object. Available for Rectangle and Ellipse.
Calls a procedure in the same way as a Process Step. Call parameters are specified in parameters using the usual syntax. The caller's context is used for parameter evaluation. Available for Procedure.