System Manual: Siemens SIMATIC HMI (WinCCv7.0: Scripting VBS, ANSI-C, VBA)
Подождите немного. Документ загружается.
Parameters
Parameter (Data Type) Description
Index (Variant) The object that is intended to be added. You can
either use the index number or the object name.
Example:
In this example the group object "My Group" is created from a number of objects. An ellipse
segment is then added to the group object:
Sub CreateGroup()
'VBA114
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objEllipseSegment As HMIEllipseSegment
Dim objGroup As HMIGroup
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
With objCircle
.Top = 40
.Left = 40
.Selected = True
End With
With objRectangle
.Top = 80
.Left = 80
.Selected = True
End With
MsgBox "Objects selected!"
Set objGroup = ActiveDocument.Selection.CreateGroup
'Set name for new group-object
'The name identifies the group-object
objGroup.ObjectName = "My Group"
'Add new object to active document...
Set objEllipseSegment = ActiveDocument.HMIObjects.AddHMIObject("EllipseSegment",
"HMIEllipseSegment")
Set objGroup = ActiveDocument.HMIObjects("My Group")
'...and add it to the group:
objGroup.GroupedHMIObjects.Add ("EllipseSegment")
End Sub
See also
GroupedObjects Object (Listing) (Page 1877)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1711
Add Method (TagTriggers Listing)
Description
Creates a new tag trigger.
syntax
Expression.
Add(VarName, Type)
Expression
Necessary. An expression or element which returns an object of the "TagTriggers" type.
Parameters
Parameter (Data Type) Description
VarName (String) The name of the tag that is intended to be used as
a trigger. Please note that you have to create the
tag in the Tag Selection dialog.
Type (CycleType) This is the cycle type. Select the cycle type from a
list in the VBA Editor when you use this method.
Example:
In the following example the radius of a circle is made dynamic using a trigger tag:
Sub DynamicWithVariableTriggerCycle()
'VBA69
Dim objVBScript As HMIScriptInfo
Dim objVarTrigger As HMIVariableTrigger
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_VariableTrigger",
"HMICircle")
Set objVBScript = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeVBScript)
With objVBScript
Set objVarTrigger = .Trigger.VariableTriggers.Add("VarTrigger", hmiVariableCycleType_10s)
.SourceCode = ""
End With
End Sub
See also
VariableTriggers Object (Listing) (Page 1990)
VBA Reference (Page 1664)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1712
System Manual, 11/2008,
Add Method (Views Listing)
Description
Creates a copy of the specified picture.
syntax
Expression.
Add()
Expression
Necessary. An expression or element which returns an object of the "Views" type.
Parameters
--
Example:
In the following example a copy of the active picture is created and then activated:
Sub CreateViewAndActivateView()
'VBA117
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
objView.Activate
End Sub
See also
Views Object (Listing) (Page 1993)
VBA Reference (Page 1664)
AddAction Method
Description
Configures an action on an object or property. This action is triggered when a defined event
occurs.
syntax
Expression.
Method(HMIActionCreationType)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1713
Expression
Necessary. An expression or element which returns an object of the "Actions" type.
Parameters
Parameter (Data Type) Description
HMIActionCreationType (Variant) Defines the action:
● hmiActionCreationTypeCScript: Configures a
C action
● hmiActionCreationTypeVBScript: Configures
a VBS action
● hmiActionCreationTypeDirectConnection:
Configures a direct connection
Example:
In the following example a VBS action for changing the radius of a circle is configured:
Sub AddActionToPropertyTypeVBScript()
'VBA118
Dim objEvent As HMIEvent
Dim objVBScript As HMIScriptInfo
Dim objCircle As HMICircle
'Create circle in picture. By changing of property "Radius"
'a VBS-action will be started:
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_AB", "HMICircle")
Set objEvent = objCircle.Radius.Events(1)
Set objVBScript = objEvent.Actions.AddAction(hmiActionCreationTypeVBScript)
End Sub
See also
Event Object (Page 1862)
Actions Object (Listing) (Page 1810)
AddActiveXControl Method
Description
Adds a new ActiveXControl object to the "HMIObjects" listing. The object is inserted in the
upper left corner of the specified picture.
Syntax
Expression.
AddActiveXControl("ObjectName", "ProgID")
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1714
System Manual, 11/2008,
Expression
Required. An expression or element which returns an object of the "HMIObjects" type.
Parameter
Parameter (data type) Description
ObjectName (String) The name of the object. You can address the object by its name in a
listing.
ProgID (String) The ActiveX Control that is to be inserted.
Determining the ProgID
To determine the ProgID for an ActiveX control, go to the "Object Palette" in the Graphics
Designer
and in the Default tab under "Smart Objects" insert the control object into the picture.
The "Insert a Control" dialog displays the path and ProgID for the selected control:
The following table shows a list of ProgIDs of WinCC controls that are installed by WinCC:
Name of the WinCC control ProgID
Siemens HMI Symbol Library SiemensHMI.SymbolLibrary.1
WinCC AlarmControl CCAxAlarmControl.AxAlarmControl.1
WinCC digital/analog clock control DACLOCK.DaclockCtrl.1
WinCC FunctionTrendControl CCAxFunctionTrendControl.AxFunctionTrendControl.1
WinCC gauge control XGAUGE.XGaugeCtrl.1
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1715
Name of the WinCC control ProgID
WinCC media control CCMediaControl.CCMediaControl.1
WinCC OnlineTableControl CCAxOnlineTableControl.AxOnlineTableControl.1
WinCC OnlineTrendControl CCAxOnlineTrendControl.AxOnlineTrendControl.1
WinCC push button control PBUTTON.PbuttonCtrl.1
WinCC slider control SLIDER.SliderCtrl.1
WinCC RulerControl CCAxTrendRulerControl.AxRulerControl.1
WinCC UserArchiveControl CCAxUserArchiveControl.AxUserArchiveControl.1
Example
In the following example, the ActiveX Control "WinCC Gauge Control" is inserted in the active
picture.
Sub AddActiveXControl()
'VBA119
Dim objActiveXControl As HMIActiveXControl
Set objActiveXControl =
ActiveDocument.HMIObjects.AddActiveXControl("WinCC_Gauge",
"XGAUGE.XGaugeCtrl.1")
With ActiveDocument
.HMIObjects("WinCC_Gauge").Top = 40
.HMIObjects("WinCC_Gauge").Left = 40
End With
End Sub
See also
ActiveX controls (Page 1617)
HMIObjects Object (Listing) (Page 1884)
ActiveXControl Object (Page 1811)
VBA Reference (Page 1664)
AddFolder Method
Description
Creates a new folder in the components library. The FolderItem object of the "Folder" type is
added to the FolderItems listing.
The new folder created in this way receives the internal name "FolderX", where "X" stands for
a consecutive number, starting with 1. Use the internal name to address the folder in the
FolderItems listing.
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1716
System Manual, 11/2008,
syntax
Expression.
AddFolder(DefaultName)
Expression
Necessary. An expression or element which returns an object of the "FolderItems" type.
Parameters
Parameter (Data Type) Description
DefaultName (String) The name of the folder that is to be created.
Example:
In the following example the folder "My Folder" will be created in the "Project Library":
Sub AddNewFolderToProjectLibrary()
'VBA120
Dim objProjectLib As HMISymbolLibrary
Set objProjectLib = Application.SymbolLibraries(2)
objProjectLib.FolderItems.AddFolder ("My Folder")
End Sub
See also
SymbolLibrary Object (Page 1962)
FolderItems Object (Listing) (Page 1868)
VBA Reference (Page 1664)
Accessing the component library with VBA (Page 1593)
AddFromClipboard Method
Description
Copies an object from the clipboard into a folder in the Components Library. The FolderItem
object of the "Item" type is added to the FolderItems listing.
Note
The clipboard must contain objects from the Graphics Designer. Other contents (such as
ASCII text) will not be pasted.
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1717
syntax
Expression.
AddFromClipboard(DefaultName)
Expression
Necessary. An expression or element which returns an object of the "FolderItems" type.
Parameters
Parameter (Data Type) Description
DefaultName (String) The name to be given to the object pasted into the
components library.
Example:
In the following example the object "PC" from the "Global Library" will be copied into the folder
"Folder 3" in the "Project Library":
Sub CopyObjectFromGlobalLibraryToProjectLibrary()
'VBA121
Dim objGlobalLib As HMISymbolLibrary
Dim objProjectLib As HMISymbolLibrary
Set objGlobalLib = Application.SymbolLibraries(1)
Set objProjectLib = Application.SymbolLibraries(2)
objProjectLib.FolderItems.AddFolder ("My Folder3")
'
'copy object from "Global Library" to clipboard
With objGlobalLib
.FolderItems(2).Folder.Item(2).Folder.Item(1).CopyToClipboard
End With
'
'paste object from clipboard into "Project Library"
objProjectLib.FolderItems(objProjectLib.FindByDisplayName("My
Folder3").Name).Folder.AddFromClipBoard ("Copy of PC/PLC")
End Sub
See also
FolderItems Object (Listing) (Page 1868)
SymbolLibrary Object (Page 1962)
VBA Reference (Page 1664)
Accessing the component library with VBA (Page 1593)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1718
System Manual, 11/2008,
AddHMIObject Method
Description
Adds a new standard, smart or Windows object to the "HMIObjects" listing. The object is
inserted in the upper left corner of the specified picture.
Note
Use the AddActiveXControl method to insert an ActiveXControl.
Use the AddOLEObject method to insert an OLE Element.
syntax
Expression.
AddHMIObject("ObjectName", "ProgID")
Expression
Necessary. An expression or element which returns an object of the "HMIObjects" type.
Parameters
Parameter (Data Type) Description
ObjectName (String) The name of the object. You can address the
object by its name in a listing.
ProgID (String) The object type that is to be inserted. "Obtain the
"ProgID" by prefixing the VBA object name with
"HMI" "(e.g. HMICircle or HMIRectangle)
Example:
In the following example a circle will be inserted into the active picture and its background color
set to "Red":
Sub AddCircleToActiveDocument()
'VBA122
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("VBA_Circle", "HMICircle")
objCircle.BackColor = RGB(255, 0, 0)
End Sub
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1719
See also
PieSegment Object (Page 1922)
TextList Object (Page 1964)
StatusDisplay Object (Page 1959)
StaticText Object (Page 1956)
Slider object (Page 1952)
RoundRectangle Object (Page 1945)
RoundButton Object (Page 1942)
Rectangle Object (Page 1939)
PolyLine Object (Page 1928)
PictureWindow Object (Page 1919)
OptionGroup Object (Page 1916)
HMIObjects Object (Listing) (Page 1884)
Line Object (Page 1897)
IOField Object (Page 1886)
GraphicObject Object (Page 1870)
EllipseArc Object (Page 1856)
EllipseSegment Object (Page 1859)
Ellipse Object (Page 1853)
CircularArc Object (Page 1831)
Circle Object (Page 1828)
CheckBox Object (Page 1827)
Button Object (Page 1824)
BarGraph Object (Page 1819)
ApplicationWindow Object (Page 1817)
AddOLEObject Method (Page 1722)
AddActiveXControl Method (Page 1714)
VBA Reference (Page 1664)
AddItem Method
Description
Copies an object from the specified picture into a folder in the Components Library. The
FolderItem object of the "Item" type is added to the FolderItems listing.
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1720
System Manual, 11/2008,