System Manual: Siemens SIMATIC HMI (WinCCv7.0: Scripting VBS, ANSI-C, VBA)
Подождите немного. Документ загружается.
Parameters
VARIANT
Parameters Description
vIndex Index or name of value column of
OnlineTableControl.
Example
Use of the "Getxxx" methods in the controls is illustrated on the basis of an example relating
to a toolbar button function.
'VBS201
Dim ctrl
Set ctrl = ScreenItems.Item("Control1")
Dim toolbu
Set toolbu = ctrl.GetToolbarButton ("ShowHelp")
HMIRuntime.Trace "Name: " & toolbu.Name & vbCrLf
HMIRuntime.Trace "Index: " & toolbu.Index & vbCrLf
HMIRuntime.Trace "Hotkey: " & toolbu.HotKey & vbCrLf
End Sub
Note
If you use the "Get..." methods to access properties of a control, you must use the latter part
of the property name. For example, if the index of a toolbar button function is not addressed
via ".ToolbarButtonIndex" but via ".Index".
GetValueColumnCollection method
Function
Returns the collection of all value column objects of the OnlineTableControl as type
"ICCAxCollection".
Syntax
Ausdruck.GetValueColulmnCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
681
Parameters
- -
Features and functions of the ICCAxCollection
The following properties are available for the ICCAxCollection:
● Count
● Item
The following functions are available for the ICCAxCollection:
● AddItem(vName) As Object
● RemoveItem(vIndex)
Example
Use of the "GetxxxCollection" methods in the controls is illustrated on the basis of an example
relating to the toolbar button functions.
'VBS202
Dim ctrl
Set ctrl = ScreenItems.Item("Control1")
Dim coll
Set coll = ctrl.GetToolbarButtonCollection
HMIRuntime.Trace "Number of toolbar buttons:" & coll.Count & vbCrLf
Dim toolbu
For Each toolbu In coll
HMIRuntime.Trace toolbu.Name & vbCrLf
Next
End Sub
GetXAxis method
Function
Returns the name or index designated X axis object of the FunctionTrendControl as type
"ICCAxValueAxis".
Syntax
Ausdruck.GetXAxis(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
682
System Manual, 11/2008,
Parameters
VARIANT
Parameters Description
vIndex Index or name of X axis.
Example
Use of the "Getxxx" methods in the controls is illustrated on the basis of an example relating
to a toolbar button function.
'VBS201
Dim ctrl
Set ctrl = ScreenItems.Item("Control1")
Dim toolbu
Set toolbu = ctrl.GetToolbarButton ("ShowHelp")
HMIRuntime.Trace "Name: " & toolbu.Name & vbCrLf
HMIRuntime.Trace "Index: " & toolbu.Index & vbCrLf
HMIRuntime.Trace "Hotkey: " & toolbu.HotKey & vbCrLf
End Sub
Note
If you use the "Get..." methods to access properties of a control, you must use the latter part
of the property name. For example, if the index of a toolbar button function is not addressed
via ".ToolbarButtonIndex" but via ".Index".
GetXAxisCollection method
Function
Returns the collection of all X axis objects of the FunctionTrendControl as type
"ICCAxCollection".
Syntax
Ausdruck.GetXAxisCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
- -
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
683
Features and functions of the ICCAxCollection
The following properties are available for the ICCAxCollection:
● Count
● Item
The following functions are available for the ICCAxCollection:
● AddItem(vName) As Object
● RemoveItem(vIndex)
Example
Use of the "GetxxxCollection" methods in the controls is illustrated on the basis of an example
relating to the toolbar button functions.
'VBS202
Dim ctrl
Set ctrl = ScreenItems.Item("Control1")
Dim coll
Set coll = ctrl.GetToolbarButtonCollection
HMIRuntime.Trace "Number of toolbar buttons:" & coll.Count & vbCrLf
Dim toolbu
For Each toolbu In coll
HMIRuntime.Trace toolbu.Name & vbCrLf
Next
End Sub
GetYAxis method
Function
Returns the name or index designated Y axis object of the FunctionTrendControl as type
"ICCAxValueAxis".
Syntax
Ausdruck.GetYAxis(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
684
System Manual, 11/2008,
Parameters
VARIANT
Parameters Description
vIndex Index or name of Y axis.
Example
Use of the "Getxxx" methods in the controls is illustrated on the basis of an example relating
to a toolbar button function.
'VBS201
Dim ctrl
Set ctrl = ScreenItems.Item("Control1")
Dim toolbu
Set toolbu = ctrl.GetToolbarButton ("ShowHelp")
HMIRuntime.Trace "Name: " & toolbu.Name & vbCrLf
HMIRuntime.Trace "Index: " & toolbu.Index & vbCrLf
HMIRuntime.Trace "Hotkey: " & toolbu.HotKey & vbCrLf
End Sub
Note
If you use the "Get..." methods to access properties of a control, you must use the latter part
of the property name. For example, if the index of a toolbar button function is not addressed
via ".ToolbarButtonIndex" but via ".Index".
GetYAxisCollection method
Function
Returns the collection of all Y axis objects of the FunctionTrendControl of type
"ICCAxCollection".
Syntax
Ausdruck.GetYAxisCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
- -
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
685
Features and functions of the ICCAxCollection
The following properties are available for the ICCAxCollection:
● Count
● Item
The following functions are available for the ICCAxCollection:
● AddItem(vName) As Object
● RemoveItem(vIndex)
Example
Use of the "GetxxxCollection" methods in the controls is illustrated on the basis of an example
relating to the toolbar button functions.
'VBS202
Dim ctrl
Set ctrl = ScreenItems.Item("Control1")
Dim coll
Set coll = ctrl.GetToolbarButtonCollection
HMIRuntime.Trace "Number of toolbar buttons:" & coll.Count & vbCrLf
Dim toolbu
For Each toolbu In coll
HMIRuntime.Trace toolbu.Name & vbCrLf
Next
End Sub
1.14.5.4 Methods H to M
HideAlarm method
Function
Executes the "Hide messages" key function of the AlarmControl.
Syntax
Expression.HideAlarm()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
- -
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
686
System Manual, 11/2008,
Item Method
Function
Retrieves an object from a collection and enables access to it via Index.
Description of DataItem Object
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.
syntax
Expression.Item()
Expression
Necessary. An expression which returns an object of the type "Screens", "Layers" (or "Tags").
NOTICE
In the case of "Tags", restricted functional scope! The standard methods get_Count and
get_NewEnum are missing so that access via Index nor the counting of all tags is possible.
Parameters
VARIANT
Example:
The following example issues the names of all objects contained in the picture "NewPDL1":
'VBS99
Dim objScreen
Dim objScrItem
Dim lngIndex
Dim lngAnswer
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
'
'The objects will be indicate by Item()
strName = objScreen.ScreenItems.Item(lngIndex).ObjectName
Set objScrItem = objScreen.ScreenItems(strName)
lngAnswer = MsgBox(objScrItem.ObjectName, vbOKCancel)
If vbCancel = lngAnswer Then Exit For
Next
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
687
See also
ScreenItems Object (List) (Page 138)
ScreenItem Object (Page 134)
Tags Object (List) (Page 149)
Alarms object (list) (Page 116)
ProcessValues Object (List) (Page 132)
LockAlarm method
Function
Executes the "Lock Alarm" key function of the AlarmControl.
Syntax
Expression.LockAlarm()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
- -
LoopInAlarm method
Function
Executes the "Loop in Alarm" key function of the AlarmControl.
Syntax
Expression.LoopInAlarm()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
- -
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
688
System Manual, 11/2008,
MoveAxis method
Function
Executes the "Move axis" key function of the OnlineTrendControl and FunctionTrendControl.
Syntax
Expression.MoveAxis()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
- -
MoveToFirst method
Function
Executes the "First line" key function of the control.
Syntax
Expression.MoveToFirst()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
- -
MoveToFirstLine method
Function
Executes the "First message" key function of the AlarmControl.
Syntax
Ausdruck.MoveToFirstLine()
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
689
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
- -
MoveToFirstPage method
Function
Executes the "First page" key function of the AlarmControl.
Syntax
Ausdruck.MoveToFirstPage()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
- -
MoveToLast method
Function
Executes the "Last data record" key function of the control.
Syntax
Ausdruck.MoveToLast()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
- -
VBS for Creating Procedures and Actions
1.14 VBS Reference
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
690
System Manual, 11/2008,