System Manual: Siemens SIMATIC HMI (WinCCv7.0: Scripting VBS, ANSI-C, VBA)
Подождите немного. Документ загружается.
Example
Declare application.
Dim WithEvents objGDApplication As grafexe.Application
Set event tag.
Private Sub Document_Opened(CancelForwarding As Boolean)
Set objGDApplication = Me.Application
End Sub
Query "Started" event and output message.
Private Sub objGDApplication_Started()
'VBA107
'This event is raised before objGDApplication_Started()
MsgBox "The Graphics Designer is started!"
End Sub
See also
VBA Reference (Page 1664)
ToolbarItemClicked Event
Description
Occurs when an icon in a user-defined toolbar has been clicked
Note
This event is both application-specific and document-specific.
To ensure that the application-specific event is available in the project, the application must
be made known to Graphics Designer. This is done by means of the following statement:
Dim WithEvents <Name> As grafexe.Application
syntax
Document_ToolbarItemClicked(ByVal ToolbarItem As IHMIToolbarItem)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1701
Parameters
Parameter (Data Type) Description
ToolbarItem (IHMIToolbarItem) Identifies the symbol.
Example:
Carry out the following procedure so that the example shown below will work:
Private Sub SetApplication()
'This procedure have to execute with "F5" first
Set objGDApplication = grafexe.Application
End Sub
In the following example a message is output when the first user-defined icon is clicked:
Private Sub Document_ToolbarItemClicked(ByVal ToolbarItem As IHMIToolbarItem)
'VBA108
Dim objToolbarItem As HMIToolbarItem
Dim varToolbarItemKey As Variant
Set objToolbarItem = ToolbarItem
'
'"varToolbarItemKey" contains the value of parameter "Key"
'from the clicked userdefined toolbar-item
varToolbarItemKey = objToolbarItem.Key
'
Select Case varToolbarItemKey
Case "tItem1_1"
MsgBox "The first Toolbar-Icon was clicked!"
End Select
End Sub
See also
How to Assign VBA Macros to Menus and Toolbars (Page 1589)
VBA Reference (Page 1664)
ViewCreated Event
Description
Occurs when a copy of a picture has been created.
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1702
System Manual, 11/2008,
Note
This event is both application-specific and document-specific.
To ensure that the application-specific event is available in the project, the application must
be made known to Graphics Designer. This is done by means of the following statement:
Dim WithEvents <Name> As grafexe.Application
syntax
Document_ViewCreated(ByVal pView As IHMIView, CancelForwarding As
Boolean)
Parameters
Parameter (Data Type) Description
pView (IHMIView) Identifies the copy of the picture.
CancelForwarding (Boolean) TRUE if the event is not intended to be forwarded.
Default setting is "False".
Example:
Carry out the following procedure so that the example shown below will work:
Private Sub SetApplication()
'This procedure have to execute with "F5" first
Set objGDApplication = grafexe.Application
End Sub
In the following example the number of copy pictures is output when a new copy of the picture
has been created.
Private Sub Document_ViewCreated(ByVal pView As IHMIView, CancelForwarding As Boolean)
'VBA109
Dim iViewCount As Integer
'
'To read out the number of views
iViewCount = pView.Application.ActiveDocument.Views.Count
MsgBox "A new copy of the picture (number " & iViewCount & ") was created."
End Sub
See also
VBA Reference (Page 1664)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1703
WindowStateChange Event
Description
Occurs when the window size is changed (e.g. from "Minimized" to "Maximized").
syntax
objGDApplication_WindowStateChanged()
Parameter (Optional)
--
Example:
In the following example a message is output when the window size is changed:
Private Sub objGDApplication_WindowStateChanged()
'VBA110
MsgBox "The state of the application-window is changed!"
End Sub
See also
VBA Reference (Page 1664)
4.4.6 Methods
4.4.6.1 A-C
Activate Method
Description
Activates the specified object.
syntax
Expression.
Activate()
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1704
System Manual, 11/2008,
Expression
Necessary. An expression or element which returns an object of the "Application" or "View"
type.
Parameters
--
Example:
In the following example a copy of the active picture is created and then activated:
Sub CreateAndActivateView()
'VBA111
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
objView.Activate
End Sub
See also
View Object (Page 1991)
Application Object (Page 1814)
VBA Reference (Page 1664)
Add Method
Description
Adds another element to a listing.
The following table shows you the listings to which the Add method can be applied. The
parameters and syntax for the respective Add methods can be found under "Methods".
Listing Application for the Add Method
AnalogResultInfos Listing Adds a new, analog value range in the Dynamic
dialog.
Documents Listing Creates a new picture in the Graphics Designer
GroupedObjects Listing Adds a new object to a group object.
Toolbars Listing Creates a new, user-defined toolbar.
Tag Triggers Listing Creates a new tag trigger.
Views Listing Creates a copy of the specified picture.
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1705
See also
Add Method (Views Listing) (Page 1713)
Add Method (TagTriggers Listing) (Page 1712)
Add Method (CustomToolbars Listing) (Page 1708)
Add Method (GroupedObjects Listing) (Page 1710)
Add Method (Documents Listing) (Page 1709)
Add Method (AnalogResultInfos Listing) (Page 1706)
Add Method (AnalogResultInfos Listing)
Description
Adds a new, analog value range in the Dynamic dialog.
syntax
Expression.
Add(RangeTo, ResultValue)
Expression
Necessary. An expression or element which returns an object of the "AnalogResultInfos" type.
Parameters
Parameter (Data Type) Description
RangeTo (Variant) The value range to which the change of property
gives rise.
ResultValue (Variant) The value to which the object property is assigned
when the value range is reached.
Example:
In the following example the radius of a circle is given dynamics with the In the following
example a tag name is assigned and three analog value ranges are created:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA112
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_A", "HMICircle")
Set objDynDialog = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'NewDynamic1'")
With objDynDialog
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1706
System Manual, 11/2008,
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.Add 50, 40
.AnalogResultInfos.Add 100, 80
.AnalogResultInfos.ElseCase = 100
End With
End Sub
The diagram shows the Dynamic dialog after the procedure has been carried out:
See also
DynamicDialog Object (Page 1851)
AnalogResultInfos Object (Listing) (Page 1813)
CreateDynamic Method (Page 1742)
How to Dynamize a Property with Dynamic Dialog (Page 1636)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1707
Add Method (CustomToolbars Listing)
Description
Creates a new, user-defined toolbar. There is a difference between application-specific and
picture-specific user-defined toolbars:
● Application-specific toolbar: This is linked to the Graphics Designer and is also only visible
when all the pictures in the Graphics Designer are closed. "Place the VBA code in the
document called "GlobalTemplateDocument" or "ProjectTemplateDocument" and use the
Application property.
● Picture-specific toolbar: Is linked with a specific picture and remains visible as long as the
picture
is visible. Place the VBA code in the document called "ThisDocument" for the desired
picture and use the ActiveDocument property.
syntax
Expression.
Add(Key)
Expression
Necessary. An expression or element which returns an object of the "CustomToolbars" type.
Parameters
Parameter (Data Type) Description
Key (Variant) Identifies the user-defined toolbar. Use unique
names for "Key" (e.g. "DocToolbar1")
Example:
In the following example a user-defined toolbar with two icons is created in the active picture.
These icons are separated by a dividing line:
Sub AddDocumentSpecificCustomToolbar()
'VBA115
Dim objToolbar As HMIToolbar
Dim objToolbarItem As HMIToolbarItem
Set objToolbar = ActiveDocument.CustomToolbars.Add("DocToolbar")
'Add toolbar-items to the userdefined toolbar
Set objToolbarItem = objToolbar.ToolbarItems.InsertToolbarItem(1, "tItem1_1", "My first
Symbol-Icon")
Set objToolbarItem = objToolbar.ToolbarItems.InsertToolbarItem(3, "tItem1_3", "My second
Symbol-Icon")
'
'Insert seperatorline between the two tollbaritems
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1708
System Manual, 11/2008,
Set objToolbarItem = objToolbar.ToolbarItems.InsertSeparator(2, "tSeparator1_2")
End Sub
See also
Toolbars Object (Listing) (Page 1968)
InsertToolbarItem Method (Page 1769)
InsertSeparator Method (Page 1766)
InsertFromMenuItem Method (Page 1762)
VBA Reference (Page 1664)
Creating Customized Menus and Toolbars (Page 1573)
Add Method (Documents Listing)
Description
Creates a new picture in the Graphics Designer
syntax
Expression.
Add [HMIOpenDocumentType]
Expression
Necessary. An expression or element which returns an object of the "Documents" type.
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1709
Parameters
Parameter (Data Type) Description
HMIOpenDocumentType (HMIDocumentType) Defines how the picture will be opened:
● HMIDocumentTypeVisible: Opens the picture
for
direct processing. This is the default setting
if you do not specify the parameter.
● HMIDocumentTypeInvisible: Opens the
picture in invisible mode, i.e. it is not displayed
in the Graphics Designer. You can only
address the picture via the Documents listing,
and make it visible again by means of the Hide
property.
Example:
In the following example a new picture is created in the Graphics Designer:
Sub AddNewDocument()
'VBA113
Application.Documents.Add hmiOpenDocumentTypeVisible
End Sub
See also
Hide Property (Page 2140)
Documents Object (Listing) (Page 1850)
VBA Reference (Page 1664)
Add Method (GroupedObjects Listing)
Description
Adds an existing object to the specified group object.
syntax
Expression.
Add(Index)
Expression
Necessary. An expression or element which returns an object of the "GroupedObjects" type.
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1710
System Manual, 11/2008,