Invoke
Use the
Invoke
command with graphic objects to call a method, to set a property of an object to a tag value or constant, or to set a tag to the value of a property of an object. A value returned by a call to a method can be assigned to a tag, as well.Syntax
Invoke <
parameters
>
There are four valid syntax variations for this command:
- <display_name.object.method(parameter1, parameter2, ...)>:Calls a method of an object, where
- display_nameis the name of the graphic display containing the object.
- Mecan be used instead of display_name. At runtime it resolves to the graphic display that currently has focus.
- objectis the name of the object
- methodis the name of a function or subroutine in the object. The method is initiated by an external event such as using the Invoke command.
- parameteris a relative or absolute reference to a tag or constant that the method will use
- <tag_name= display_name.object.method(parameter1, parameter2, ...)>: Assigns the value returned by a method to the specified tag.tag_nameis relative or absolute reference to a tag to which the value returned by the method, will be assigned.
- <tag_name=display_name.object.property>: Sets an object property to the value of a tag.
- <display_name.object.property(tag_name or constant)>: Sets a tag or constant to the value of an object property.
Remarks
When using the
Invoke
command, you must provide all parameters for the method that is being invoked, even those parameters that are optional for the method.You can use a variation of the syntax (file.object.property.(tag_name or constant) without specifying
file
, to affect the visibility of only those objects, or group of objects, that are on the display from which the command is run. This syntax is Invoke ObjectName.Visible(0)
. This would make ObjectName invisible.To change the name of an object, use the Property Panel to change the Name property.
This command is run on the
FactoryTalk View SE
Client or FactoryTalk View Studio
that issued it. It is ignored when it is issued from an HMI Server.Provide Feedback