System Manual: Siemens SIMATIC HMI (WinCCv7.0: Scripting VBS, ANSI-C, VBA)
Подождите немного. Документ загружается.
Object
Property provided by an object
The VBS object model in a faceplate type
The VBS object model is not valid for WinCC in a Faceplate type. It is replaced by a completely
new model.
The VBS object model of the Faceplate type provides you with access to the graphic objects
and Faceplate tags of the Faceplate type in Runtime.
Objects
Objects and lists are provided for access to all the objects in the graphic Runtime systems:
Graphic objects, pictures, layers and tags.
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
111
Properties
The properties of the individual objects can be used to modify specific graphic objects and
tags in Runtime , e.g. activating an operating element per mouse click or triggering a color
change by modifying a tag value.
Methods
Methods, which are applied to individual objects, can be used to read tag values for further
processing or display diagnostics messages in Runtime.
See also
ActiveScreen Property (Page 278)
Object Types of the ScreenItem Object (Page 152)
Methods (Page 638)
Properties (Page 276)
Objects and Lists (Page 113)
AlarmLogs Object (Page 118)
DataItem Object (Page 119)
DataLogs Object (Page 121)
DataSet-Objekt (List) (Page 122)
HMIRuntime Object (Page 125)
Layer Object (Page 127)
Layers Object (Listing) (Page 129)
ScreenItem Object (Page 134)
ScreenItems Object (List) (Page 138)
Screen Object (Page 140)
Screens Object (List) (Page 143)
Tag Object (Page 146)
Tags Object (List) (Page 149)
TagSet Object (List) (Page 151)
ActiveProject Property (Page 278)
ActiveScreenItem Property (Page 279)
Logging Object (Page 130)
Alarm object (Page 115)
Alarms object (list) (Page 116)
ProcessValue Object (Page 131)
ProcessValues Object (List) (Page 132)
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
112
System Manual, 11/2008,
1.14.2 Objects and Lists
1.14.2.1 Objects and Lists
Overview
The objects and lists provided in WinCC object models enables access to graphic objects and
tags in Runtime.
Navigation in Object Models
Access is made to objects in the VBS object model in hierarchical sequence. If, for example,
a picture element is accessed within a picture, access is made to the picture element in the
picture via its parent object (the surrounding picture).
Example:
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
113
Only the basic picture name is issued in this example.
Access to Graphic Objects
In WinCC, access is made to pictures, layers and graphic objects in Runtime using the
superordinate "HMIRuntime" object. Access to objects and layers is always made via the
picture (screen) in which they are contained.
Access to Tags
In WinCC, tags are accessed directly in Runtime using the superordinate "HMIRuntime" object.
Tag values can be read out or set anew.
Lists
Lists of WinCC object models behave in the same way as standard collections of VBS.
Exception: The "Tags" list has no Enum function.
Available Objects
● Alarm
● Alarms
● AlarmLogs
● DataItem
● DataLogs
● DataSet
● HMIRuntime
● Item
● Layer
● Layers
● Logging
● ProcessValues
● ProcessValue
● Project
● ScreenItem
● ScreenItems
● Screen
● Screens
● Tag
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
114
System Manual, 11/2008,
● Tags
● TagSet
See also
ScreenItems Object (List) (Page 138)
TagSet Object (List) (Page 151)
Tags Object (List) (Page 149)
Tag Object (Page 146)
Screens Object (List) (Page 143)
Screen Object (Page 140)
ScreenItem Object (Page 134)
Layers Object (Listing) (Page 129)
Layer Object (Page 127)
Item Object (Page 126)
HMIRuntime Object (Page 125)
1.14.2.2 Alarm object
Description
The alarm object is used to access the Alarms object list.
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
115
Note
The properties of the alarm object are not automatically updated when the values of the
properties change.
See also
Alarms object (list) (Page 116)
1.14.2.3 Alarms object (list)
Description
With the alarm object you can configure messages.
Usage
Using the "Alarms" list you can:
● Access a message in the list (Item method)
● Create a new alarm object (Create method)
● Read the alarm ID of the message (AlarmID attribute)
● Read the status of a message (State property)
● Read the time stamp of the message (Timestamp property)
● Generate an instance of the alarm object (Instance property)
● Read the name of the computer on which the message came (ComputerName property)
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
116
System Manual, 11/2008,
● Read or set the name of the user who triggered the message (UserName property)
● Read or set the name of the process value blocks (ProcessValues property)
● Read or set the message commentary (Comment property)
● Read or set the message server prefix (Context property)
Example
In the following example, a message is created and configured:
'VBS200
Dim MyAlarm
Set MyAlarm = HMIRuntime.Alarms(1)
MyAlarm.State = 5 'hmiAlarmStateCome + hmiAlarmStateComment
MyAlarm.Comment = "MyComment"
MyAlarm.UserName = "Hans-Peter"
MyAlarm.ProcessValues(1) = "Process Value 1"
MyAlarm.ProcessValues(4) = "Process Value 4"
MyAlarm.Create "MyApplication"
See also
TimeStamp Property (Page 556)
ComputerName property (Page 345)
Context property (Page 345)
State property (Page 524)
AlarmID property (Page 282)
Instance property (Page 402)
Comment property (Page 344)
UserName property (Page 606)
ProcessValue property (Page 485)
Alarm object (Page 115)
ProcessValues Object (List) (Page 132)
Create method (Page 644)
Item Method (Page 687)
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
117
1.14.2.4 AlarmLogs Object
Description
Using the object, swapped archive segments of Alarm Logging may be reconnected to
Runtime, or previously swapped archive segments of Alarm Logging may be deleted again.
Therein
● Archive segments to be swapped are copied to the common archiving directory of the
WinCC project, or
● previously swapped archive segments are deleted in the common archiving directory.
Using parameters you may control from where archive segments are to be swapped. You may
also
specify the time period over which archive segments are to be swapped or deleted. Archive
segments are copied to the common archiving directory of the project.
If an error occurred during the operation with archiving segments, the method used returns an
error message. Additional information may be found under the subject heading "Error
Messages from Database Area".
Usage
Previously swapped archive segments of Alarm Logging may be connected with Runtime
("Restore" method).
Previously swapped archive segments of Alarm Logging may be deleted from the Runtime
project ("Remove" method).
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
118
System Manual, 11/2008,
Example:
In the following example, archive segments from Alarm Logging are swapped and the return
value is output as Trace.
'VBS187
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.AlarmLogs.Restore("D:
\Folder","2004-09-14","2004-09-20",-1) & vbNewLine
See also
Error Messages from Database Area (Page 732)
Restore Method (Page 708)
Remove Method (Page 703)
DataLogs Object (Page 121)
Logging Object (Page 130)
1.14.2.5 DataItem Object
Description
The DataItem object is used to access the contents of the DataSet list. Values or object
references are stored in the list as DataItem.
Access uses the name under which the value was added to the list. Single access using an
index is not recommended since the index changes during adding or deleting of values. The
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
119
index may be used to output the complete contents of the list. The output is in alphabetical
order.
Note
For object references it must be ascertained that objects are multiread-enabled.
Example:
The example shows how the value of 'Motor1' is output as Trace.
'VBS163
HMIRuntime.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine
The following example enumerates all DataItem objects of the DataSet list. Name and value
are output as Trace.
'VBS164
Dim data
For Each data In HMIRuntime.DataSet
HMIRuntime.Trace data.Name & ": " & data.Value & vbNewLine
Next
Note
For objects, value may possibly not be output directly
See also
Screen Object (Page 140)
HMIRuntime Object (Page 125)
DataSet-Objekt (List) (Page 122)
Value Property (Page 610)
Name Property (Page 452)
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
120
System Manual, 11/2008,