System Manual: Siemens SIMATIC HMI (WinCCv7.0: Scripting VBS, ANSI-C, VBA)
Подождите немного. Документ загружается.
4.4.4 VBA Reference: Languages
VBA Object Model: Languages
When you click an object name, you are shown a detailed description.
See also
VBA Reference (Page 1664)
LanguageFont Object (Page 1889)
LanguageFonts Object (Listing) (Page 1890)
LanguageText Object (Page 1892)
LanguageTexts Object (Listing) (Page 1893)
4.4.5 Events
4.4.5.1 A-D
Activated event
Description
Occurs when a picture is activated in the Graphics Designer. This happens when you switch
between two pictures, for example.
syntax
Document_Activated(CancelForwarding As Boolean)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1671
Parameters
Parameter (Data Type) Description
CancelForwarding (Boolean) TRUE if the event is not intended to be forwarded.
Default setting is "False".
Example:
In the following example a message is output when the picture is activated:
Private Sub Document_Activated(CancelForwarding As Boolean)
'VBA76
MsgBox "The document got the focus." & vbCrLf &_
"This event (Document_Activated) is raised by the document itself"
End Sub
See also
VBA Reference (Page 1664)
Event Handling (Page 1655)
BeforeClose Events
Description
Occurs immediately before a picture is closed.
syntax
Document_BeforeClose(Cancel As Boolean, CancelForwarding As Boolean)
Parameters
Parameter (Data Type) Description
Cancel (Boolean) TRUE if command processing is to be canceled.
CancelForwarding (Boolean) TRUE if the event is not intended to be forwarded.
Default setting is "False".
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1672
System Manual, 11/2008,
Example:
In the following example a message is output before the picture is closed:
Private Sub Document_BeforeClose(Cancel As Boolean, CancelForwarding As Boolean)
'VBA77
MsgBox "Event Document_BeforeClose is raised"
End Sub
See also
VBA Reference (Page 1664)
BeforeDocumentClose Event
Description
Occurs immediately before the picture is closed.
syntax
Note
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
In the following example, the name "objGDApplication" is substituted for <Name>.
objGDApplication_BeforeDocumentClose(Document As HMIDocument, Cancel
As Boolean)
Parameters
Parameter (Data Type) Description
Document (HMIDocument) The picture that is going to be closed.
Cancel (Boolean) TRUE if command processing is to be canceled.
Example:
Carry out the following procedure so that the example shown below will work:
Private Sub SetApplication()
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1673
'This procedure have to execute with "F5" first
Set objGDApplication = grafexe.Application
End Sub
In the following example a message is output before the picture is closed:
Private Sub objGDApplication_BeforeDocumentClose(ByVal Document As IHMIDocument, Cancel As
Boolean)
'VBA78
MsgBox "The document " & Document.Name & " will be closed after press ok"
End Sub
See also
VBA Reference (Page 1664)
BeforeDocumentSave event
Description
Occurs immediately before the picture is saved.
syntax
Note
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
In the following example, the name "objGDApplication" is substituted for <Name>.
objGDApplication_BeforeDocumentSave(Document As HMIDocument, Cancel
As Boolean)
Parameters
Parameter (Data Type) Description
Document (HMIDocument) The picture that is going to be closed.
Cancel (Boolean) TRUE if command processing is to be canceled.
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1674
System Manual, 11/2008,
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 before the picture is closed:
Private Sub objGDApplication_BeforeDocumentSave(ByVal Document As IHMIDocument, Cancel As
Boolean)
'VBA79
MsgBox Document.Name & "-saving will start after press ok."
End Sub
See also
VBA Reference (Page 1664)
BeforeHMIObjectDelete-Ereignis
Description
Occurs immediately before an object in a picture is deleted.
syntax
BeforeHMIObjectDelete(ByVal HMIObject As IHMIObject, Cancel As
Boolean, CancelForwarding As Boolean)
Parameters
Parameter (Data Type) Description
HMIObject (IHMIObject) Identifies the object to be deleted.
Cancel (Boolean) TRUE if command processing is to be canceled.
CancelForwarding (Boolean) TRUE if the event is not intended to be forwarded.
Default setting is "False".
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1675
Example:
In the following example a message is output identifying the object to be deleted:
Private Sub Document_BeforeHMIObjectDelete(ByVal HMIObject As IHMIObject, Cancel As
Boolean, CancelForwarding As Boolean)
'VBA80
Dim strObjName As String
Dim strAnswer As String
'
'"strObjName" contains the name of the deleted object
strObjName = HMIObject.ObjectName
strAnswer = MsgBox("Are you sure to delete " & strObjName & "?", vbYesNo)
If strAnswer = vbNo Then
'if pressed "No" -> set Cancel to true for prevent delete
Cancel = True
End If
End Sub
See also
VBA Reference (Page 1664)
BeforeLibraryFolderDelete event
Description
Occurs immediately before a folder in the components library is deleted.
syntax
Note
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
In the following example, the name "objGDApplication" is substituted for <Name>.
objGDApplication_BeforeLibraryFolderDelete(LibObject As
HMIFolderItem, Cancel As Boolean)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1676
System Manual, 11/2008,
Parameter (Optional)
Parameter (Data Type) Description
LibObject (HMIFolderItem) The folder that is going to be deleted.
Cancel (Boolean) TRUE if command processing is to be canceled.
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 before a folder in the components library is
deleted:
Private Sub objGDApplication_BeforeLibraryFolderDelete(ByVal LibObject As HMIFolderItem,
Cancel As Boolean)
'VBA81
MsgBox "The library-folder " & LibObject.Name & " will be delete..."
End Sub
See also
VBA Reference (Page 1664)
BeforeLibraryObjectDelete event
Description
Occurs immediately before an object in the components library is deleted.
syntax
Note
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
In the following example, the name "objGDApplication" is substituted for <Name>.
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1677
objGDApplication_BeforeLibraryObjectDelete(LibObject As
HMIFolderItem, Cancel As Boolean)
Parameter (Optional)
Parameter (Data Type) Description
LibObject (HMIFolderItem) The object that is going to be deleted.
Cancel (Boolean) TRUE if command processing is to be canceled.
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 before a folder in the components library is
deleted:
Private Sub objGDApplication_BeforeLibraryObjectDelete(ByVal LibObject As HMIFolderItem,
Cancel As Boolean)
'VBA82
MsgBox "The object " & LibObject.Name & " will be delete..."
End Sub
See also
VBA Reference (Page 1664)
BeforeQuit Event
Description
Occurs immediately before the Graphics Designer is closed.
syntax
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1678
System Manual, 11/2008,
Note
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
In the following example, the name "objGDApplication" is substituted for <Name>.
objGDApplication_BeforeQuit(Cancel As Boolean)
Parameters
Parameter (Data Type) Description
Cancel (Boolean) TRUE if command processing is to be canceled.
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 this example a message is output shortly before the Graphics Designer is closed.
Private Sub objGDApplication_BeforeQuit(Cancel As Boolean)
'VBA83
MsgBox "The Graphics Designer will be shut down"
End Sub
See also
VBA Reference (Page 1664)
BeforeSave Event
Description
Occurs immediately before a picture is saved.
syntax
Document_BeforeSave(Cancel As Boolean, CancelForwarding As Boolean)
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 11/2008,
1679
Parameters
Parameter (Data Type) Description
Cancel (Boolean) TRUE if command processing is to be canceled.
CancelForwarding (Boolean) TRUE if the event is not intended to be forwarded.
Default setting is "False".
Example:
In the following example a message is output before the picture is saved:
Private Sub Document_BeforeSave(Cancel As Boolean, CancelForwarding As Boolean)
'VBA84
MsgBox "The document will be saved..."
End Sub
See also
VBA Reference (Page 1664)
BeforeVisibleFalse event
Description
Occurs immediately before the Graphics Designer application is set from Visible to Invisible.
syntax
Document_BeforeVisibleFalse(Cancel As Boolean, CancelForwarding As
Boolean)
Parameters
Parameter (Data Type) Description
Cancel (Boolean) TRUE if command processing is to be canceled.
CancelForwarding (Boolean) TRUE if the event is not intended to be forwarded.
Default setting is "False".
Example:
--
VBA for Automated Configuration
4.4 The object model of the Graphics Designer
MDM - WinCC: Scripting (VBS, ANSI-C, VBA)
1680
System Manual, 11/2008,